30 Commits

Author SHA1 Message Date
Joshua Nichols
e1901b3a83 Regenerated gemspec for version 0.4.1 2010-04-02 00:54:20 -04:00
Joshua Nichols
cc39d30f09 Version bump to 0.4.1. 2010-04-02 00:54:04 -04:00
Joshua Nichols
a798f3c562 Add a better error message when a repo's home doesn't exist. 2010-04-02 00:53:17 -04:00
Joshua Nichols
02c3fda939 Regenerated gemspec for version 0.4.0 2010-04-01 22:02:40 -04:00
Joshua Nichols
958ab3e09e Version bump to 0.4.0 2010-04-01 22:02:21 -04:00
Joshua Nichols
c0797dd607 Cloning will now try to init and update git submodules, if they exist. 2010-04-01 21:59:15 -04:00
Joshua Nichols
00b6f9b390 Regenerated gemspec. 2010-04-01 21:23:07 -04:00
Joshua Nichols
9a22513ba4 Allow symlinking existing directories into repos, instead of cloning. 2010-04-01 21:19:25 -04:00
Joshua Nichols
5ac2a0739a Clone github repos into username/repo instead of username_repo, for more consistent use with symlink. 2010-04-01 21:08:36 -04:00
Joshua Nichols
923c634377 Misc cleanup 2010-04-01 21:04:06 -04:00
Joshua Nichols
0579f94430 Moving towards testing list more. 2010-04-01 20:59:24 -04:00
Joshua Nichols
c50464e366 Added more clone specs. 2010-04-01 20:17:47 -04:00
Joshua Nichols
c5f8563f71 Shuffled specs around. 2010-04-01 20:14:29 -04:00
Joshua Nichols
34ef4a4659 Regenerated gemspec for version 0.3.0 2010-04-01 00:15:54 -04:00
Joshua Nichols
4ccbd927fa Bumped to 0.3.0 2010-04-01 00:15:14 -04:00
Joshua Nichols
595c53370e Converted README to markdown. 2010-04-01 00:13:06 -04:00
Joshua Nichols
43facf1ec0 Renamed 'link' command to 'symlink' 2010-03-31 23:59:05 -04:00
Joshua Nichols
46b2cbfa3f Renamed symlink action to ln_s. 2010-03-31 23:57:18 -04:00
Joshua Nichols
cde7989e85 Fix conflict resolution when destination is a plain file (not a symlink). 2010-03-31 23:18:38 -04:00
Joshua Nichols
5db3048e71 Fix header in changelog 2010-03-19 00:35:10 -04:00
Joshua Nichols
3b3a8f8533 Regenerated gemspec for version 0.2.0 2010-03-19 00:34:21 -04:00
Joshua Nichols
412558f9ad Version bump 2010-03-19 00:34:08 -04:00
Joshua Nichols
73d890652e Fix quiet support 2010-03-19 00:33:59 -04:00
Joshua Nichols
ba84df0137 Cyan list instead of green. 2010-03-19 00:28:08 -04:00
Joshua Nichols
8be582a4cb Fixed cloning from github. 2010-03-18 23:45:34 -04:00
Joshua Nichols
b80b132a7a Adding in pretend options. 2010-03-18 23:38:45 -04:00
Joshua Nichols
bf66d91b1f Shuffled some stuff out of main homesick.rb 2010-03-18 23:30:18 -04:00
Joshua Nichols
ce0d9b9d02 Hai, pretty output. 2010-03-18 23:22:29 -04:00
Jacob Atzen
78e952c2e4 Fixed github name regex so specs run 2010-03-18 23:17:10 -04:00
Jacob Atzen
de0b14bbd6 Don't try to recognize git uri's
There's a bunch of different way to specify git uri's. Instead of trying
to recognize uri's let's just accept that the user knows, what he's doing.
2010-03-18 23:17:01 -04:00
12 changed files with 262 additions and 139 deletions

View File

@@ -1,8 +1,32 @@
# 0.4.1
* Improved error message when a castle's home dir doesn't exist
# 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
* otherwise hand off to git clone
* Listing now displays in color, and show git remote
* Support pretend, force, and quiet modes
# 0.1.1
* Fixed trying to link against castles that don't exist
* Fixed linking, which tries to exclude . and .. from the list of files to
link (thanks Martinos)
link (thanks Martinos!)
# 0.1.0

View File

@@ -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

View File

@@ -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.

View File

@@ -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.1.1"
gem.version = "0.4.1"
# Have dependencies? Add them to Gemfile
# gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings

View File

@@ -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'

View File

@@ -5,11 +5,11 @@
Gem::Specification.new do |s|
s.name = %q{homesick}
s.version = "0.1.1"
s.version = "0.4.1"
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
s.authors = ["Joshua Nichols"]
s.date = %q{2010-03-17}
s.date = %q{2010-04-02}
s.default_executable = %q{homesick}
s.description = %q{
A mans home (directory) is his castle, so dont leave home with out it.
@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
s.extra_rdoc_files = [
"ChangeLog.markdown",
"LICENSE",
"README.rdoc"
"README.markdown"
]
s.files = [
".document",
@@ -30,12 +30,14 @@ Gem::Specification.new do |s|
"ChangeLog.markdown",
"Gemfile",
"LICENSE",
"README.rdoc",
"README.markdown",
"Rakefile",
"bin/homesick",
"homesick.gemspec",
"lib/homesick.rb",
"spec/homesick/homesick_spec.rb",
"lib/homesick/actions.rb",
"lib/homesick/shell.rb",
"spec/homesick_spec.rb",
"spec/spec.opts",
"spec/spec_helper.rb"
]
@@ -45,7 +47,7 @@ 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/homesick_spec.rb",
"spec/spec_helper.rb"
]
@@ -54,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

View File

@@ -1,135 +1,90 @@
require 'thor'
class Homesick < Thor
autoload :Shell, 'homesick/shell'
autoload :Actions, 'homesick/actions'
include Thor::Actions
include Homesick::Actions
# Hack in support for diffing symlinks
class Shell < Thor::Shell::Color
add_runtime_options!
def show_diff(destination, content)
destination = Pathname.new(destination)
if destination.symlink?
say "- #{destination.readlink}", :red, true
say "+ #{content.expand_path}", :green, true
else
super
end
end
end
GITHUB_NAME_REPO_PATTERN = /\A([A-Za-z_-]+\/[A-Za-z_-]+)\Z/
def initialize(args=[], options={}, config={})
super
self.shell = Homesick::Shell.new
end
GIT_URI_PATTERN = /^git:\/\//
GITHUB_NAME_REPO_PATTERN = /([A-Za-z_-]+)\/([A-Za-z_-]+)/
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 =~ GIT_URI_PATTERN
git_clone uri
destination = nil
if File.exist?(uri)
destination = Pathname.new(uri).basename
ln_s uri, destination
elsif uri =~ GITHUB_NAME_REPO_PATTERN
git_clone "git://github.com/#{$1}/#{$2}.git", "#{$1}_#{$2}"
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)
unless castle_dir(home).exist?
say_status :error, "Castle #{home} did not exist in #{repos_dir}", :red
desc "symlink NAME", "Symlinks all dotfiles from the specified castle"
def symlink(name)
unless castle_dir(name).exist?
say_status :error, "Could not symlink #{name}, expected #{castle_dir(name)} exist and contain dotfiles", :red
exit(1)
end
else
inside castle_dir(home) do
inside castle_dir(name) do
files = Pathname.glob('.*').reject{|a| [".",".."].include?(a.to_s)}
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
end
end
desc "list", "List cloned castles"
def list
inside repos_dir do
Pathname.glob('*') do |home|
puts home
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
# TODO move this to be more like thor's template, empty_directory, etc
def git_clone(repo, config = {})
config ||= {}
destination = config[:destination] || begin
repo =~ /([^\/]+)\.git$/
$1
def home_dir
@home_dir ||= Pathname.new(ENV['HOME'] || '~').expand_path
end
destination = Pathname.new(destination) unless destination.kind_of?(Pathname)
if ! destination.directory?
say_status 'git clone', "#{repo} to #{destination.expand_path}", :green if config.fetch(:verbose, true)
system "git clone #{repo} #{destination}" unless options[:pretend]
else
say_status :exist, destination.expand_path, :blue
end
def repos_dir
@repos_dir ||= home_dir.join('.homesick', 'repos').expand_path
end
def symlink(source, destination, config = {})
destination = Pathname.new(destination)
if destination.symlink?
if destination.readlink == source
say_status :identical, destination.expand_path, :blue
else
say_status :conflict, "#{destination} exists and points to #{destination.readlink}", :red
if shell.file_collision(destination) { source }
system "ln -sf #{source} #{destination}"
end
end
else
say_status :symlink, "#{source.expand_path} to #{destination.expand_path}", :green
system "ln -s #{source} #{destination}"
end
end
def user_dir
self.class.user_dir
end
def castle_dir(name)
repos_dir.join(name, 'home')

58
lib/homesick/actions.rb Normal file
View File

@@ -0,0 +1,58 @@
class Homesick
module Actions
# TODO move this to be more like thor's template, empty_directory, etc
def git_clone(repo, config = {})
config ||= {}
destination = config[:destination] || begin
repo =~ /([^\/]+)\.git$/
$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]
system "git clone -q #{repo} #{destination}" unless options[:pretend]
else
say_status :exist, destination.expand_path, :blue unless options[:quiet]
end
end
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?
if destination.readlink == source
say_status :identical, destination.expand_path, :blue unless options[:quiet]
else
say_status :conflict, "#{destination} exists and points to #{destination.readlink}", :red unless options[:quiet]
if shell.file_collision(destination) { source }
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]
end
end
end
end

17
lib/homesick/shell.rb Normal file
View File

@@ -0,0 +1,17 @@
class Homesick
# Hack in support for diffing symlinks
class Shell < Thor::Shell::Color
def show_diff(destination, content)
destination = Pathname.new(destination)
if destination.symlink?
say "- #{destination.readlink}", :red, true
say "+ #{content.expand_path}", :green, true
else
super
end
end
end
end

View File

@@ -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
View 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

View File

@@ -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