Added documentation for the new commands to the readme file.

Added cd and open commands and tests for commit and status

ChangeLog.markdown

@@ -1,3 +1,8 @@
+# 0.9.8
+ * Introduce new commands
+     * `homesick cd`
+     * `homesick open`
+
 # 0.9.4
  * Use https protocol instead of git protocol
  * Introduce new commands

Gemfile

@@ -8,10 +8,14 @@ gem "thor", ">= 0.14.0"
 group :development do
   gem "rake", ">= 0.8.7"
   gem "rspec", "~> 2.10"
+  gem "guard"
+  gem "guard-rspec"
+  gem "rb-readline", "~> 0.5.0"
   gem "jeweler", ">= 1.6.2"
   gem "rcov", :platforms => :mri_18
   gem "simplecov", :platforms => :mri_19
   gem "test-construct"
+  gem "capture-output", "~> 1.0.0"
   if RUBY_VERSION >= '1.9.2'
     gem "rubocop"
   end

Guardfile

@@ -0,0 +1,9 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/homesick/.*\.rb}) { "spec" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  notification :tmux, display_message: true
+end
+

README.markdown

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/technicalpickles/homesick.png?branch=master)](https://travis-ci.org/technicalpickles/homesick)
 
-A man's home (directory) is his castle, so don't leave home with out it.
+Your home directory is your castle. Don't leave your dotfiles behind.
 
 Homesick is sorta like [rip](http://github.com/defunkt/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.
 
@@ -27,9 +27,6 @@ With the castle cloned, you can now link its contents into your home dir:
 
     homesick symlink pickled-vim
 
-If you use the shorthand syntax for GitHub repositories in your clone, please note you will instead need to run:
-
-    homesick symlink technicalpickles/pickled-vim
 
 You can remove symlinks anytime when you don't need them anymore
 
@@ -51,6 +48,14 @@ To push your castle:
 
     homesick push CASTLE
 
+To open a terminal in the root of a castle:
+
+    homesick cd CASTLE
+
+To open your default editor in the root of a castle (the $EDITOR environment variable must be set):
+
+    homesick open CASTLE
+
 Not sure what else homesick has up its sleeve? There's always the built in help:
 
     homesick help

Rakefile

@@ -12,9 +12,10 @@ require 'rake'
 require 'jeweler'
 Jeweler::Tasks.new do |gem|
   gem.name = "homesick"
-  gem.summary = %Q{A man's home is his castle. Never leave your dotfiles behind.}
+  gem.summary = %Q{Your home directory is your castle. Don't leave your dotfiles behind.}
   gem.description = %Q{
-    A man's home (directory) is his castle, so don't leave home with out it.
+    Your home directory is your castle. Don't leave your dotfiles behind.
+    
 
     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. 
 
@@ -22,7 +23,7 @@ Jeweler::Tasks.new do |gem|
   gem.email = ["josh@technicalpickles.com", "info@muratayusuke.com"]
   gem.homepage = "http://github.com/technicalpickles/homesick"
   gem.authors = ["Joshua Nichols", "Yusuke Murata"]
-  gem.version = "0.9.5"
+  gem.version = "0.9.7"
   gem.license = "MIT"
   # Have dependencies? Add them to Gemfile
 

homesick.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "homesick"
-  s.version = "0.9.5"
+  s.version = "0.9.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joshua Nichols", "Yusuke Murata"]
-  s.date = "2013-09-18"
+  s.date = "2013-12-31"
   s.description = "\n    A man's home (directory) is his castle, so don't leave home with out it.\n\n    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. \n\n  "
   s.email = ["josh@technicalpickles.com", "info@muratayusuke.com"]
   s.executables = ["homesick"]

lib/homesick.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'thor'
 
 class Homesick < Thor
@@ -9,7 +10,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-z0-9_-]+\/[A-Za-z0-9_-]+)\Z/
   SUBDIR_FILENAME = '.homesick_subdir'
 
   DEFAULT_CASTLE_NAME = 'dotfiles'
@@ -33,7 +34,7 @@ class Homesick < Thor
 
         ln_s uri, destination
       elsif uri =~ GITHUB_NAME_REPO_PATTERN
-        destination = Pathname.new($1)
+        destination = Pathname.new(uri).basename
         git_clone "https://github.com/#{$1}.git", :destination => destination
       elsif uri =~ /%r([^%r]*?)(\.git)?\Z/
         destination = Pathname.new($1)
@@ -89,9 +90,9 @@ class Homesick < Thor
 
   end
 
-  desc 'commit CASTLE', "Commit the specified castle's changes"
-  def commit(name = DEFAULT_CASTLE_NAME)
-    commit_castle name
+  desc 'commit CASTLE MESSAGE', "Commit the specified castle's changes"
+  def commit(name = DEFAULT_CASTLE_NAME, message = nil)
+    commit_castle name, message
 
   end
 
@@ -227,6 +228,41 @@ class Homesick < Thor
     end
   end
 
+  desc "destroy CASTLE", "Delete all symlinks and remove the cloned repository"
+  def destroy(name)
+    check_castle_existance name, "destroy"
+
+    if shell.yes?("This will destroy your castle irreversible! Are you sure?")
+      unlink(name)
+      rm_rf repos_dir.join(name)
+    end
+
+  end
+
+  desc "cd CASTLE", "Open a new shell in the root of the given castle"
+  def cd(castle = DEFAULT_CASTLE_NAME)
+    check_castle_existance castle, "cd"
+    castle_dir = repos_dir.join(castle)
+    say_status "cd #{castle_dir.realpath}", "Opening a new shell in castle '#{castle}'. To return to the original one exit from the new shell.", :green
+    inside castle_dir do
+      system(ENV['SHELL'])
+    end
+  end
+
+  desc "open CASTLE", "Open your default editor in the root of the given castle"
+  def open(castle = DEFAULT_CASTLE_NAME)
+    if ! ENV['EDITOR']
+      say_status :error,"The $EDITOR environment variable must be set to use this command", :red
+
+      exit(1)
+    end
+    check_castle_existance castle, "open"
+    castle_dir = repos_dir.join(castle)
+    say_status "#{ENV['EDITOR']} #{castle_dir.realpath}", "Opening the root directory of castle '#{castle}' in editor '#{ENV['EDITOR']}'.", :green
+    inside castle_dir do
+      system(ENV['EDITOR'])
+    end
+  end
 
   protected
 
@@ -278,10 +314,10 @@ class Homesick < Thor
     end
   end
 
-  def commit_castle(castle)
+  def commit_castle(castle, message)
     check_castle_existance(castle, 'commit')
     inside repos_dir.join(castle) do
-      git_commit_all
+      git_commit_all :message => message
     end
   end
 
@@ -386,7 +422,7 @@ class Homesick < Thor
         home_path = home_dir.join(relative_dir).join(path)
 
         yield(absolute_path, home_path)
-      end
+     end
     end
   end
 

lib/homesick/actions.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 class Homesick
   module Actions
     # TODO move this to be more like thor's template, empty_directory, etc
@@ -10,7 +11,7 @@ class Homesick
 
       if ! destination.directory?
         say_status 'git clone', "#{repo} to #{destination.expand_path}", :green unless options[:quiet]
-        system "git clone -q --recursive #{repo} #{destination}" unless options[:pretend]
+        system "git clone -q --config push.default=upstream --recursive #{repo} #{destination}" unless options[:pretend]
       else
         say_status :exist, destination.expand_path, :blue unless options[:quiet]
       end
@@ -63,7 +64,11 @@ class Homesick
 
     def git_commit_all(config = {})
       say_status 'git commit all', '', :green unless options[:quiet]
-      system 'git commit -v -a' unless options[:pretend]
+      if config[:message]
+        system "git commit -a -m '#{config[:message]}'" unless options[:pretend]
+      else
+        system 'git commit -v -a' unless options[:pretend]
+      end
     end
 
     def git_add(file, config = {})
@@ -108,6 +113,37 @@ class Homesick
       end
     end
 
+    def rm(file)
+      say_status "rm #{file}", '', :green unless options[:quiet]
+      system "rm #{file}" if File.exists?(file)
+    end
+
+    def rm_rf(dir)
+      say_status "rm -rf #{dir}", '', :green unless options[:quiet]
+      system "rm -rf #{dir}"
+    end
+
+    def rm_link(target)
+      target = Pathname.new(target)
+
+      if target.symlink?
+        say_status :unlink, "#{target.expand_path}", :green unless options[:quiet]
+        FileUtils.rm_rf target
+      else
+        say_status :conflict, "#{target} is not a symlink", :red unless options[:quiet]
+      end
+    end
+
+    def rm(file)
+      say_status "rm #{file}", '', :green unless options[:quiet]
+      system "rm #{file}"
+    end
+
+    def rm_r(dir)
+      say_status "rm -r #{dir}", '', :green unless options[:quiet]
+      system "rm -r #{dir}"
+    end
+
     def ln_s(source, destination, config = {})
       source = Pathname.new(source)
       destination = Pathname.new(destination)

spec/homesick_spec.rb

@@ -1,4 +1,6 @@
+# -*- encoding : utf-8 -*-
 require 'spec_helper'
+require 'capture-output'
 
 describe 'homesick' do
   let(:home) { create_construct }
@@ -94,7 +96,7 @@ describe 'homesick' do
     end
 
     it 'should clone a github repo' do
-      homesick.should_receive(:git_clone).with('https://github.com/wfarr/dotfiles.git', :destination => Pathname.new('wfarr/dotfiles'))
+      homesick.should_receive(:git_clone).with('https://github.com/wfarr/dotfiles.git', :destination => Pathname.new('dotfiles'))
 
       homesick.clone 'wfarr/dotfiles'
     end
@@ -340,9 +342,19 @@ describe 'homesick' do
   end
 
   describe 'status' do
+    it 'should say "nothing to commit" when there are no changes' do
+      given_castle('castle_repo')
+      text = Capture.stdout { homesick.status('castle_repo') }
+      text.should =~ /nothing to commit \(create\/copy files and use "git add" to track\)$/
+    end
 
-    xit 'needs testing'
-
+    it 'should say "Changes to be committed" when there are changes' do
+      given_castle('castle_repo')
+      some_rc_file = home.file '.some_rc_file'
+      homesick.track(some_rc_file.to_s, 'castle_repo')
+      text = Capture.stdout { homesick.status('castle_repo') }
+      text.should =~ /Changes to be committed:.*new file:\s*home\/.some_rc_file/m
+    end
   end
 
   describe 'diff' do
@@ -371,12 +383,6 @@ describe 'homesick' do
 
   end
 
-  describe 'commit' do
-
-    xit 'needs testing'
-
-  end
-
   describe 'push' do
 
     xit 'needs testing'
@@ -447,6 +453,16 @@ describe 'homesick' do
       end
     end
 
+    describe 'commit' do
+      it 'should have a commit message when the commit succeeds' do
+        given_castle('castle_repo')
+        some_rc_file = home.file '.a_random_rc_file'
+        homesick.track(some_rc_file.to_s, 'castle_repo')
+        text = Capture.stdout { homesick.commit('castle_repo', 'Test message') }
+        text.should =~ /^\[master \(root-commit\) \w+\] Test message/
+      end
+    end
+
     describe 'subdir_file' do
 
       it 'should add the nested files parent to the subdir_file' do
@@ -490,4 +506,63 @@ describe 'homesick' do
       end
     end
   end
+
+  describe "destroy" do
+    it "removes the symlink files" do
+      expect_any_instance_of(Thor::Shell::Basic).to receive(:yes?).and_return('y')
+      given_castle("stronghold")
+      some_rc_file = home.file '.some_rc_file'
+      homesick.track(some_rc_file.to_s, "stronghold")
+      homesick.destroy('stronghold')
+
+      some_rc_file.should_not be_exist
+    end
+
+    it "deletes the cloned repository" do
+      expect_any_instance_of(Thor::Shell::Basic).to receive(:yes?).and_return('y')
+      castle = given_castle("stronghold")
+      some_rc_file = home.file '.some_rc_file'
+      homesick.track(some_rc_file.to_s, "stronghold")
+      homesick.destroy('stronghold')
+
+      castle.should_not be_exist
+    end
+  end
+
+  describe "cd" do
+    it "cd's to the root directory of the given castle" do
+      given_castle('castle_repo')
+      homesick.should_receive("inside").once.with(kind_of(Pathname)).and_yield
+      homesick.should_receive("system").once.with(ENV["SHELL"])
+      Capture.stdout { homesick.cd 'castle_repo' }
+    end
+
+    it "returns an error message when the given castle does not exist" do
+      homesick.should_receive("say_status").once.with(:error, /Could not cd castle_repo, expected \/tmp\/construct_container.* exist and contain dotfiles/, :red)
+      expect { homesick.cd "castle_repo" }.to raise_error(SystemExit)
+    end
+  end
+
+  describe "open" do
+    it "opens the system default editor in the root of the given castle" do
+      ENV.stub(:[]).and_call_original # Make sure calls to ENV use default values for most things...
+      ENV.stub(:[]).with('EDITOR').and_return('vim') # Set a default value for 'EDITOR' just in case none is set
+      given_castle 'castle_repo'
+      homesick.should_receive("inside").once.with(kind_of(Pathname)).and_yield
+      homesick.should_receive("system").once.with('vim')
+      Capture.stdout { homesick.open 'castle_repo' }
+    end
+
+    it "returns an error message when the $EDITOR environment variable is not set" do
+      ENV.stub(:[]).with('EDITOR').and_return(nil) # Set the default editor to make sure it fails.
+      homesick.should_receive("say_status").once.with(:error,"The $EDITOR environment variable must be set to use this command", :red)
+      expect { homesick.open "castle_repo" }.to raise_error(SystemExit)
+    end
+
+    it "returns an error message when the given castle does not exist" do
+      ENV.stub(:[]).with('EDITOR').and_return('vim') # Set a default just in case none is set
+      homesick.should_receive("say_status").once.with(:error, /Could not open castle_repo, expected \/tmp\/construct_container.* exist and contain dotfiles/, :red)
+      expect { homesick.open "castle_repo" }.to raise_error(SystemExit)
+    end
+  end
 end

spec/spec_helper.rb

@@ -4,6 +4,7 @@ require 'homesick'
 require 'rspec'
 require 'rspec/autorun'
 require 'construct'
+require 'tempfile'
 
 RSpec.configure do |config|
   config.include Construct::Helpers
@@ -21,6 +22,8 @@ RSpec.configure do |config|
     castles.directory(path) do |castle|
       Dir.chdir(castle) do
         system 'git init >/dev/null 2>&1'
+        system 'git config user.email "test@test.com"'
+        system 'git config user.name "Test Name"'
         system "git remote add origin git://github.com/technicalpickles/#{name}.git >/dev/null 2>&1"
         if subdirs
           subdir_file = castle.join(Homesick::SUBDIR_FILENAME)