Compare commits
17 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
02c3fda939 | ||
|
|
958ab3e09e | ||
|
|
c0797dd607 | ||
|
|
00b6f9b390 | ||
|
|
9a22513ba4 | ||
|
|
5ac2a0739a | ||
|
|
923c634377 | ||
|
|
0579f94430 | ||
|
|
c50464e366 | ||
|
|
c5f8563f71 | ||
|
|
34ef4a4659 | ||
|
|
4ccbd927fa | ||
|
|
595c53370e | ||
|
|
43facf1ec0 | ||
|
|
46b2cbfa3f | ||
|
|
cde7989e85 | ||
|
|
5db3048e71 |
@@ -1,4 +1,16 @@
|
||||
# 2.0.0
|
||||
# 0.4.0
|
||||
|
||||
* `homesick clone` can now take a path to a directory on the filesystem, which will be symlinked into place
|
||||
* `homesick clone` now tries to `git submodule init` and `git submodule update` if git submodules are defined for a cloned repo
|
||||
* Fixed missing dependency on thor and others
|
||||
* Use HOME environment variable for where to store files, instead of assuming ~
|
||||
|
||||
# 0.3.0
|
||||
|
||||
* Renamed 'link' to 'symlink'
|
||||
* Fixed conflict resolution when symlink destination exists and is a normal file
|
||||
|
||||
# 0.2.0
|
||||
|
||||
* Better support for recognizing git urls (thanks jacobat!)
|
||||
* if it looks like a github user/repo, do that
|
||||
@@ -12,6 +24,6 @@
|
||||
* Fixed linking, which tries to exclude . and .. from the list of files to
|
||||
link (thanks Martinos!)
|
||||
|
||||
# 0.1.0
|
||||
# 0.1.0
|
||||
|
||||
* Initial release
|
||||
|
||||
2
Gemfile
2
Gemfile
@@ -12,5 +12,5 @@ group :development do
|
||||
gem "bundler", ">= 0.9.5"
|
||||
gem "jeweler", ">= 1.4.0"
|
||||
gem "rcov", ">= 0"
|
||||
gem "devver-construct"
|
||||
gem "test-construct"
|
||||
end
|
||||
|
||||
@@ -1,14 +1,13 @@
|
||||
= homesick
|
||||
# homesick
|
||||
|
||||
A man's home (directory) is his castle, so don't leave home with out it.
|
||||
|
||||
Homesick is sorta like rip, but for dotfiles. It uses git to clone a repository containing dotfiles, and saves them in ~/.homesick. It then allows you to symlink all the dotfiles into place with a single command.
|
||||
Homesick is sorta like rip, but for dotfiles. It uses git to clone a repository containing dotfiles, and saves them in `~/.homesick`. It then allows you to symlink all the dotfiles into place with a single command.
|
||||
|
||||
We call a repository that is compatible with homesick to be a 'castle'. To act as a castle, a repository must be organized like so:
|
||||
|
||||
* Contains a 'home' directory
|
||||
* 'home' contains any number of files and directories that begin with '.'
|
||||
* Optionally has a README file
|
||||
|
||||
To get started, install homesick first:
|
||||
|
||||
@@ -24,13 +23,17 @@ Alternatively, if it's on github, there's a slightly shorter way:
|
||||
|
||||
With the castle cloned, you can now link its contents into your home dir:
|
||||
|
||||
homesick link pickled-vim
|
||||
homesick symlink pickled-vim
|
||||
|
||||
If you're not sure what castles you have around, you can easily list them:
|
||||
|
||||
homesick list
|
||||
|
||||
== Note on Patches/Pull Requests
|
||||
Not sure what else homesick has up its sleeve? There's always the built in help:
|
||||
|
||||
homesick help
|
||||
|
||||
## Note on Patches/Pull Requests
|
||||
|
||||
* Fork the project.
|
||||
* Make your feature addition or bug fix.
|
||||
@@ -38,6 +41,6 @@ If you're not sure what castles you have around, you can easily list them:
|
||||
* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
|
||||
* Send me a pull request. Bonus points for topic branches.
|
||||
|
||||
== Copyright
|
||||
## Copyright
|
||||
|
||||
Copyright (c) 2010 Joshua Nichols. See LICENSE for details.
|
||||
2
Rakefile
2
Rakefile
@@ -22,7 +22,7 @@ Jeweler::Tasks.new do |gem|
|
||||
gem.email = "josh@technicalpickles.com"
|
||||
gem.homepage = "http://github.com/technicalpickles/homesick"
|
||||
gem.authors = ["Joshua Nichols"]
|
||||
gem.version = "0.2.0"
|
||||
gem.version = "0.4.0"
|
||||
# Have dependencies? Add them to Gemfile
|
||||
|
||||
# gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
require 'pathname'
|
||||
lib = Pathname.new(__FILE__).dirname.join('..', 'lib').expand_path
|
||||
$LOAD_PATH.unshift.unshift lib.to_s unless $LOAD_PATH.include?(lib.to_s)
|
||||
$LOAD_PATH.unshift lib.to_s
|
||||
|
||||
require 'homesick'
|
||||
|
||||
|
||||
@@ -5,11 +5,11 @@
|
||||
|
||||
Gem::Specification.new do |s|
|
||||
s.name = %q{homesick}
|
||||
s.version = "0.2.0"
|
||||
s.version = "0.4.0"
|
||||
|
||||
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
|
||||
s.authors = ["Joshua Nichols"]
|
||||
s.date = %q{2010-03-19}
|
||||
s.date = %q{2010-04-01}
|
||||
s.default_executable = %q{homesick}
|
||||
s.description = %q{
|
||||
A man’s home (directory) is his castle, so don’t leave home with out it.
|
||||
@@ -21,25 +21,25 @@ Gem::Specification.new do |s|
|
||||
s.executables = ["homesick"]
|
||||
s.extra_rdoc_files = [
|
||||
"ChangeLog.markdown",
|
||||
"LICENSE",
|
||||
"README.rdoc"
|
||||
"LICENSE",
|
||||
"README.markdown"
|
||||
]
|
||||
s.files = [
|
||||
".document",
|
||||
".gitignore",
|
||||
"ChangeLog.markdown",
|
||||
"Gemfile",
|
||||
"LICENSE",
|
||||
"README.rdoc",
|
||||
"Rakefile",
|
||||
"bin/homesick",
|
||||
"homesick.gemspec",
|
||||
"lib/homesick.rb",
|
||||
"lib/homesick/actions.rb",
|
||||
"lib/homesick/shell.rb",
|
||||
"spec/homesick/homesick_spec.rb",
|
||||
"spec/spec.opts",
|
||||
"spec/spec_helper.rb"
|
||||
".gitignore",
|
||||
"ChangeLog.markdown",
|
||||
"Gemfile",
|
||||
"LICENSE",
|
||||
"README.markdown",
|
||||
"Rakefile",
|
||||
"bin/homesick",
|
||||
"homesick.gemspec",
|
||||
"lib/homesick.rb",
|
||||
"lib/homesick/actions.rb",
|
||||
"lib/homesick/shell.rb",
|
||||
"spec/homesick_spec.rb",
|
||||
"spec/spec.opts",
|
||||
"spec/spec_helper.rb"
|
||||
]
|
||||
s.homepage = %q{http://github.com/technicalpickles/homesick}
|
||||
s.rdoc_options = ["--charset=UTF-8"]
|
||||
@@ -47,8 +47,8 @@ Gem::Specification.new do |s|
|
||||
s.rubygems_version = %q{1.3.6}
|
||||
s.summary = %q{A man's home is his castle. Never leave your dotfiles behind.}
|
||||
s.test_files = [
|
||||
"spec/homesick/homesick_spec.rb",
|
||||
"spec/spec_helper.rb"
|
||||
"spec/homesick_spec.rb",
|
||||
"spec/spec_helper.rb"
|
||||
]
|
||||
|
||||
if s.respond_to? :specification_version then
|
||||
@@ -56,9 +56,30 @@ Gem::Specification.new do |s|
|
||||
s.specification_version = 3
|
||||
|
||||
if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
|
||||
s.add_runtime_dependency(%q<thor>, [">= 0"])
|
||||
s.add_development_dependency(%q<rake>, [">= 0"])
|
||||
s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
|
||||
s.add_development_dependency(%q<bundler>, [">= 0.9.5"])
|
||||
s.add_development_dependency(%q<jeweler>, [">= 1.4.0"])
|
||||
s.add_development_dependency(%q<rcov>, [">= 0"])
|
||||
s.add_development_dependency(%q<test-construct>, [">= 0"])
|
||||
else
|
||||
s.add_dependency(%q<thor>, [">= 0"])
|
||||
s.add_dependency(%q<rake>, [">= 0"])
|
||||
s.add_dependency(%q<rspec>, [">= 1.2.9"])
|
||||
s.add_dependency(%q<bundler>, [">= 0.9.5"])
|
||||
s.add_dependency(%q<jeweler>, [">= 1.4.0"])
|
||||
s.add_dependency(%q<rcov>, [">= 0"])
|
||||
s.add_dependency(%q<test-construct>, [">= 0"])
|
||||
end
|
||||
else
|
||||
s.add_dependency(%q<thor>, [">= 0"])
|
||||
s.add_dependency(%q<rake>, [">= 0"])
|
||||
s.add_dependency(%q<rspec>, [">= 1.2.9"])
|
||||
s.add_dependency(%q<bundler>, [">= 0.9.5"])
|
||||
s.add_dependency(%q<jeweler>, [">= 1.4.0"])
|
||||
s.add_dependency(%q<rcov>, [">= 0"])
|
||||
s.add_dependency(%q<test-construct>, [">= 0"])
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ class Homesick < Thor
|
||||
|
||||
add_runtime_options!
|
||||
|
||||
GITHUB_NAME_REPO_PATTERN = /\A([A-Za-z_-]+)\/([A-Za-z_-]+)\Z/
|
||||
GITHUB_NAME_REPO_PATTERN = /\A([A-Za-z_-]+\/[A-Za-z_-]+)\Z/
|
||||
|
||||
def initialize(args=[], options={}, config={})
|
||||
super
|
||||
@@ -18,18 +18,34 @@ class Homesick < Thor
|
||||
|
||||
desc "clone URI", "Clone +uri+ as a castle for homesick"
|
||||
def clone(uri)
|
||||
empty_directory repos_dir, :verbose => false
|
||||
inside repos_dir do
|
||||
if uri =~ GITHUB_NAME_REPO_PATTERN
|
||||
git_clone "git://github.com/#{$1}/#{$2}.git", :destination => "#{$1}_#{$2}"
|
||||
destination = nil
|
||||
if File.exist?(uri)
|
||||
destination = Pathname.new(uri).basename
|
||||
|
||||
ln_s uri, destination
|
||||
elsif uri =~ GITHUB_NAME_REPO_PATTERN
|
||||
destination = Pathname.new($1)
|
||||
git_clone "git://github.com/#{$1}.git", :destination => destination
|
||||
else
|
||||
if uri =~ /\/([^\/]*).git\Z/
|
||||
destination = Pathname.new($1)
|
||||
end
|
||||
|
||||
git_clone uri
|
||||
end
|
||||
|
||||
if destination.join('.gitmodules').exist?
|
||||
inside destination do
|
||||
git_submodule_init
|
||||
git_submodule_update
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "link NAME", "Symlinks all dotfiles from the specified castle"
|
||||
def link(home)
|
||||
desc "symlink NAME", "Symlinks all dotfiles from the specified castle"
|
||||
def symlink(home)
|
||||
unless castle_dir(home).exist?
|
||||
say_status :error, "Castle #{home} did not exist in #{repos_dir}", :red
|
||||
|
||||
@@ -41,10 +57,10 @@ class Homesick < Thor
|
||||
files.each do |path|
|
||||
absolute_path = path.expand_path
|
||||
|
||||
inside user_dir do
|
||||
adjusted_path = (user_dir + path).basename
|
||||
inside home_dir do
|
||||
adjusted_path = (home_dir + path).basename
|
||||
|
||||
symlink absolute_path, adjusted_path
|
||||
ln_s absolute_path, adjusted_path
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -54,37 +70,24 @@ class Homesick < Thor
|
||||
|
||||
desc "list", "List cloned castles"
|
||||
def list
|
||||
inside repos_dir do
|
||||
Pathname.glob('*') do |home|
|
||||
inside home do
|
||||
say_status home, `git config remote.origin.url`, :cyan
|
||||
end
|
||||
Pathname.glob(repos_dir + "*") do |castle|
|
||||
Dir.chdir castle do # so we can call git config from the right contxt
|
||||
say_status castle.basename.to_s, `git config remote.origin.url`.chomp, :cyan
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
no_tasks do
|
||||
# class method, so it's convenient to stub out during tests
|
||||
def self.user_dir
|
||||
@user_dir ||= Pathname.new('~').expand_path
|
||||
end
|
||||
|
||||
def self.repos_dir
|
||||
@repos_dir ||= Pathname.new('~/.homesick/repos').expand_path
|
||||
end
|
||||
|
||||
def repos_dir
|
||||
self.class.repos_dir
|
||||
end
|
||||
end
|
||||
|
||||
protected
|
||||
|
||||
def user_dir
|
||||
self.class.user_dir
|
||||
def home_dir
|
||||
@home_dir ||= Pathname.new(ENV['HOME'] || '~').expand_path
|
||||
end
|
||||
|
||||
def repos_dir
|
||||
@repos_dir ||= home_dir.join('.homesick', 'repos').expand_path
|
||||
end
|
||||
|
||||
|
||||
def castle_dir(name)
|
||||
repos_dir.join(name, 'home')
|
||||
end
|
||||
|
||||
@@ -5,10 +5,11 @@ class Homesick
|
||||
config ||= {}
|
||||
destination = config[:destination] || begin
|
||||
repo =~ /([^\/]+)\.git$/
|
||||
$1
|
||||
$1
|
||||
end
|
||||
|
||||
destination = Pathname.new(destination) unless destination.kind_of?(Pathname)
|
||||
FileUtils.mkdir_p destination.dirname
|
||||
|
||||
if ! destination.directory?
|
||||
say_status 'git clone', "#{repo} to #{destination.expand_path}", :green unless options[:quiet]
|
||||
@@ -18,7 +19,18 @@ class Homesick
|
||||
end
|
||||
end
|
||||
|
||||
def symlink(source, destination, config = {})
|
||||
def git_submodule_init(config = {})
|
||||
say_status 'git submodule', 'init', :green unless options[:quiet]
|
||||
system "git submodule --quiet init" unless options[:pretend]
|
||||
end
|
||||
|
||||
def git_submodule_update(config = {})
|
||||
say_status 'git submodule', 'update', :green unless options[:quiet]
|
||||
system "git submodule --quiet update >/dev/null 2>&1" unless options[:pretend]
|
||||
end
|
||||
|
||||
def ln_s(source, destination, config = {})
|
||||
source = Pathname.new(source)
|
||||
destination = Pathname.new(destination)
|
||||
|
||||
if destination.symlink?
|
||||
@@ -31,6 +43,12 @@ class Homesick
|
||||
system "ln -sf #{source} #{destination}" unless options[:pretend]
|
||||
end
|
||||
end
|
||||
elsif destination.exist?
|
||||
say_status :conflict, "#{destination} exists", :red unless options[:quiet]
|
||||
|
||||
if shell.file_collision(destination) { source }
|
||||
system "ln -sf #{source} #{destination}" unless options[:pretend]
|
||||
end
|
||||
else
|
||||
say_status :symlink, "#{source.expand_path} to #{destination.expand_path}", :green unless options[:quiet]
|
||||
system "ln -s #{source} #{destination}" unless options[:pretend]
|
||||
|
||||
@@ -1,19 +0,0 @@
|
||||
require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
|
||||
|
||||
describe "Homesick" do
|
||||
before do
|
||||
@homesick = Homesick.new
|
||||
end
|
||||
|
||||
it "should clone any git repo" do
|
||||
@homesick.should_receive(:git_clone).with('git://github.com/technicalpickles/pickled-vim.git')
|
||||
|
||||
@homesick.clone "git://github.com/technicalpickles/pickled-vim.git"
|
||||
end
|
||||
|
||||
it "should clone a github repo" do
|
||||
@homesick.should_receive(:git_clone).with('git://github.com/wfarr/dotfiles.git', 'wfarr_dotfiles')
|
||||
|
||||
@homesick.clone "wfarr/dotfiles"
|
||||
end
|
||||
end
|
||||
62
spec/homesick_spec.rb
Normal file
62
spec/homesick_spec.rb
Normal file
@@ -0,0 +1,62 @@
|
||||
require 'spec_helper'
|
||||
|
||||
describe Homesick do
|
||||
before do
|
||||
@homesick = Homesick.new
|
||||
end
|
||||
|
||||
describe "clone" do
|
||||
it "should symlink existing directories" do
|
||||
somewhere = create_construct
|
||||
somewhere.directory('wtf')
|
||||
wtf = somewhere + 'wtf'
|
||||
|
||||
@homesick.should_receive(:ln_s).with(wtf.to_s, wtf.basename.to_s)
|
||||
|
||||
@homesick.clone wtf.to_s
|
||||
end
|
||||
it "should clone git repo like git://host/path/to.git" do
|
||||
@homesick.should_receive(:git_clone).with('git://github.com/technicalpickles/pickled-vim.git')
|
||||
|
||||
@homesick.clone "git://github.com/technicalpickles/pickled-vim.git"
|
||||
end
|
||||
|
||||
it "should clone git repo like git@host:path/to.git" do
|
||||
@homesick.should_receive(:git_clone).with('git@github.com:technicalpickles/pickled-vim.git')
|
||||
|
||||
@homesick.clone 'git@github.com:technicalpickles/pickled-vim.git'
|
||||
end
|
||||
|
||||
it "should clone git repo like http://host/path/to.git" do
|
||||
@homesick.should_receive(:git_clone).with('http://github.com/technicalpickles/pickled-vim.git')
|
||||
|
||||
@homesick.clone 'http://github.com/technicalpickles/pickled-vim.git'
|
||||
end
|
||||
|
||||
it "should clone a github repo" do
|
||||
@homesick.should_receive(:git_clone).with('git://github.com/wfarr/dotfiles.git', :destination => 'wfarr/dotfiles')
|
||||
|
||||
@homesick.clone "wfarr/dotfiles"
|
||||
end
|
||||
end
|
||||
|
||||
describe "list" do
|
||||
|
||||
# FIXME only passes in isolation. need to setup data a bit better
|
||||
xit "should say each castle in the castle directory" do
|
||||
@user_dir.directory '.homesick/repos' do |repos_dir|
|
||||
repos_dir.directory 'zomg' do |zomg|
|
||||
Dir.chdir do
|
||||
system "git init >/dev/null 2>&1"
|
||||
system "git remote add origin git://github.com/technicalpickles/zomg.git >/dev/null 2>&1"
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@homesick.should_receive(:say_status).with("zomg", "git://github.com/technicalpickles/zomg.git", :cyan)
|
||||
|
||||
@homesick.list
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
@@ -10,7 +10,7 @@ Spec::Runner.configure do |config|
|
||||
|
||||
config.before do
|
||||
@user_dir = create_construct
|
||||
Homesick.stub!(:user_dir).and_return(@user_dir)
|
||||
ENV['HOME'] = @user_dir.to_s
|
||||
end
|
||||
|
||||
config.after do
|
||||
|
||||
Reference in New Issue
Block a user