webmat-git_remote_branch 0.2.7 → 0.3.0

data/CHANGELOG

@@ -1,3 +1,18 @@
+* Release 0.3.0 *
+
+  Housekeeping
+  - Support for a bunch of platforms has been added (Windows, Ubuntu, Ruby 1.9)
+  - git_remote_branch now has actual online documentation: grb.rubyforge.org
+  - give useful error message if grb can't find the git executable
+  
+  Features
+  - track now works even if you already have a local branch of the same name
+    - it uses git config instead of branch --track in that case
+    - the difference can be seen by running
+      - grb explain track master
+      - grb explain track non_existent_branch
+  - Let you force the usage of a specific git executable by setting the environment variable GRB_GIT to point to it. It's pretty much undocumented for now, except for this mention :-) The tests for the useful error message use this feature. So it works.
+
 * Release 0.2.6 *
   Three new actual features
   - grb rename, contributed by Caio Chassot (caiochassot.com)

data/README.rdoc

@@ -1,28 +1,32 @@
 = Why git_remote_branch?
 
-The basic idea for git_remote_branch is to trivialize the interaction with
-remote branches in simple situations. 
+git_remote_branch is a simple command-line tool that makes it very easy to manipulate
+branches published in shared repositories.
 
-For now git_remote_branch assumes that the local and remote branches have the
-same name. Multiple origins are supported.
+git_remote_branch achieves this goal by sticking to a few principles:
+- keep grb's commands extremely regular (they all look alike)
+- support aliases for commands
+- print all commands it runs on your behalf in red, so you eventually learn them
 
-Another goal of git_remote_branch is to help teach the real underlying git
-commands. Each operation done on your behalf is displayed at the console.
+Another nice thing about git_remote_branch: it can simply explain a command 
+(print out all the corresponding git commands) instead of running them on your behalf.
 
+Note: git_remote_branch assumes that the local and remote branches have the
+same name. Multiple remote repositories (or origins) are supported.
 
 
 = Installation
 
-  sudo gem install git_remote_branch
+  sudo gem install git_remote_branch --include-dependencies
 
-If you have an older version of Rubygems (older than 1.2), you will have to manually install the "colored" gem.
+If you have an old version of Rubygems, you may have to manually install the "colored" gem.
   sudo gem install colored
 
-If you're on Windows, you must install "colored" and "win32console" manually (before or after installing git_remote_branch doesn't matter).
+If you're on Windows, you must also install "win32console" manually (before or after installing git_remote_branch doesn't matter).
   gem install win32console colored
 
 
-See the "Bleeding edge and development" section the end of this document for more details about fiddling with the source of git_remote_branch.
+See the "Bleeding edge and development" section the end of this document for more details about fiddling with the source of git_remote_branch or running it with Ruby 1.9 (yes, it works).
 
 = Usage
 
@@ -39,24 +43,22 @@ Available commands (with aliases):
 
 === create (alias: new)
 
-Create a new local branch as well as a corresponding remote branch from the
-branch you are currently on.
-Automatically track the new remote branch (useful for pulling and merging).
-Switch to the new branch.
+Create a new local branch as well as a corresponding remote branch based on the
+branch you currently have checked out. 
+Track the new remote branch. Checkout the new branch.
 
   $ grb create branch_name [origin_server]
 
 
-=== publish (aliases: remotize)
+=== publish (aliases: remotize, share)
 
 Publish an existing local branch to the remote server.
 Set up the local branch to track the new remote branch.
-Switch to the new branch.
 
   $ grb publish branch_name [origin_server]
 
 
-=== delete (aliases: destroy, kill, remove)
+=== delete (aliases: destroy, kill, remove, rm)
 
 Delete the remote branch then delete the local branch.
 The local branch is not deleted if there are pending changes.
@@ -66,18 +68,18 @@ The local branch is not deleted if there are pending changes.
 
 === track (aliases: follow grab fetch)
 
-Track an existing remote branch locally.
+Track an existing remote branch locally and checkout the branch.
 
   $ grb track branch_name [origin_server]
 
 
-=== rename (aliases: rn, mv, move)
-To rename the branch you're currently on.
-Rename the remote branch by copying then deleting the old name.
-Checkout a new local tracking branch with the new name and delete the local
-branch with the old name.
+=== rename (aliases: rn mv move)
 
-  $ grb rename branch_name [origin_server]
+Rename a remote branch and its local tracking branch.
+The branch you want to rename must be checked out.
+
+  # On branch to be renamed
+  $ grb rename new_branch_name [origin_server]
 
 
 === explain
@@ -88,7 +90,7 @@ run to accomplish that goal.
 Examples: 
 
   $ grb explain create
-  git_remote_branch version 0.2.7
+  git_remote_branch version 0.3.0
   
   List of operations to do to create a new remote branch and track it locally:
   
@@ -97,9 +99,10 @@ Examples:
   git branch --track branch_to_create origin/branch_to_create
   git checkout branch_to_create
 
+Explain your specific case:
 
   $ grb explain create my_branch github
-  git_remote_branch version 0.2.7
+  git_remote_branch version 0.3.0
   
   List of operations to do to create a new remote branch and track it locally:
   
@@ -108,7 +111,7 @@ Examples:
   git branch --track my_branch github/my_branch
   git checkout my_branch
 
-
+This, of course, works for each of the grb commands.
 
 = More on git_remote_branch
 
@@ -121,10 +124,7 @@ Examples:
 
 == History
 
-git_remote_branch in its current form was inspired by a script created by Carl Mercier and made public on his blog
-here:
-
-{No nonsense GIT, part 1: git-remote-branch}[http://blog.carlmercier.com/2008/01/25/no-nonsense-git-part-1-git-remote-branch/]
+git_remote_branch in its current form was inspired by a script created by Carl Mercier and made public on his blog: {No nonsense GIT, part 1: git-remote-branch}[http://blog.carlmercier.com/2008/01/25/no-nonsense-git-part-1-git-remote-branch/]
 
 
 == Contributors
@@ -137,22 +137,48 @@ here:
 
 == Legalese
 
-git_remote_branch is licensed under the MIT License. See the file COPYING for details.
+git_remote_branch is licensed under the MIT License. See the file LICENSE for details.
 
 == Bleeding edge and development
 
 (Notice the keyword "bleeding")
 
+=== Getting the bleeding edge
+
 Installing from GitHub
   sudo gem install webmat-git_remote_branch --source=http://gems.github.com
 
+Note that the only stable version of the gem you should trust is the one from Rubyforge. The GitHub gem is a development gem. The GitHub gem WILL be rebuilt with the same version number, and other horrible things like that. If you use the github version of the gem, children will die! You've been warned.
+
 Cloning the repo and installing from your copy
   git clone git://github.com/webmat/git_remote_branch.git
   rake install
 
+=== Testing dependencies
+
 Note that git_remote_branch uses a few more gems for tests. Running any rake task will try to load them due to the way Rake::TestTask works.
 
   sudo gem install thoughtbot-shoulda --source http://gems.github.com
   sudo gem install mocha
 
-An attempt is made to require 2 more optional gems: redgreen and ruby-debug
+An attempt is made to require 2 more optional gems: redgreen and ruby-debug. If they're not present, only a whiny message will be displayed.
+
+=== Supported platforms
+
+git_remote_branch has been tested with the following configurations:
+
+- OS X Leopard / Ruby 1.8.6 / Git 1.5.4.3 and 1.6.0.2
+- OS X Leopard / Ruby 1.9.1 / Git 1.5.4.3 and 1.6.0.2
+- Ubuntu Intrepid Ibex / Ruby 1.8.7 / Git 1.5.6.3
+- Windows XP / Ruby 1.8.6 / Git 1.6.0.2 (the msys version)
+
+Let me know if you have problems running git_remote_branch with your platform.
+
+To run the test suite using Ruby 1.9, simply set the RUBY environment variable to point to your 1.9 interpreter and then run the 1.9 version of Rake. In my case, everything 1.9 is suffixed with 1.9:
+
+  $ RUBY=ruby1.9 rake1.9 test
+
+Or on Windows (Ruby 1.9 not tested on Windows)
+
+  > set RUBY=ruby1.9
+  > rake1.9 test

data/bin/grb

@@ -7,11 +7,24 @@ require "#{File.dirname(THIS_FILE)}/../lib/git_remote_branch"
 
 include GitRemoteBranch
 
+def crap_out(message)
+  puts message
+  exit 1
+end
+
+unless git_found?
+  crap_out <<-MSG
+The git executable (#{GIT}) could not be found by git_remote_branch.
+Make sure your PATH variable contains the path for git's binary.
+Your PATH:
+#{ENV['PATH'].split(/[:;]/) * "\n"}
+MSG
+end
+
 begin
   p = read_params(ARGV)
 rescue InvalidBranchError => ex
-  puts ex.message
-  exit 1
+  crap_out ex.message
 end
 
 $SILENT = p[:silent]

data/lib/constants.rb

@@ -0,0 +1,5 @@
+module GitRemoteBranch
+  GIT = (ENV['GRB_GIT'] || 'git').freeze
+  
+  LOCAL_BRANCH_LISTING_COMMAND = "#{GIT} branch -l".freeze
+end

data/lib/git_remote_branch.rb

@@ -10,7 +10,7 @@ else
 end
 
 begin
-  WINDOWS = (RUBY_PLATFORM =~ /win32|cygwin/)
+  WINDOWS = !!(RUBY_PLATFORM =~ /win32|cygwin/)
 rescue Exception
 end
 
@@ -20,6 +20,7 @@ $LOAD_PATH.unshift( grb_app_root + '/vendor' )
 require 'capture_fu'
 
 $LOAD_PATH.unshift( grb_app_root + '/lib' )
+require 'constants'
 require 'string_ext'
 require 'state'
 require 'param_reader'
@@ -34,10 +35,10 @@ module GitRemoteBranch
       :description => 'create a new remote branch and track it locally',
       :aliases  => %w{create new},
       :commands => [
-        '"git push #{origin} #{current_branch}:refs/heads/#{branch_name}"',
-        '"git fetch #{origin}"',
-        '"git branch --track #{branch_name} #{origin}/#{branch_name}"',
-        '"git checkout #{branch_name}"'
+        '"#{GIT} push #{origin} #{current_branch}:refs/heads/#{branch_name}"',
+        '"#{GIT} fetch #{origin}"',
+        '"#{GIT} branch --track #{branch_name} #{origin}/#{branch_name}"',
+        '"#{GIT} checkout #{branch_name}"'
       ]
     },
 
@@ -45,11 +46,11 @@ module GitRemoteBranch
       :description => 'publish an exiting local branch',
       :aliases  => %w{publish remotize share},
       :commands => [
-        '"git push #{origin} #{branch_name}:refs/heads/#{branch_name}"',
-        '"git fetch #{origin}"',
-        '"git config branch.#{branch_name}.remote #{origin}"',
-        '"git config branch.#{branch_name}.merge refs/heads/#{branch_name}"',
-        '"git checkout #{branch_name}"'
+        '"#{GIT} push #{origin} #{branch_name}:refs/heads/#{branch_name}"',
+        '"#{GIT} fetch #{origin}"',
+        '"#{GIT} config branch.#{branch_name}.remote #{origin}"',
+        '"#{GIT} config branch.#{branch_name}.merge refs/heads/#{branch_name}"',
+        '"#{GIT} checkout #{branch_name}"'
       ]
     },
 
@@ -57,12 +58,12 @@ module GitRemoteBranch
       :description => 'rename a remote branch and its local tracking branch',
       :aliases  => %w{rename rn mv move},
       :commands => [
-        '"git push #{origin} #{current_branch}:refs/heads/#{branch_name}"',
-        '"git fetch #{origin}"',
-        '"git branch --track #{branch_name} #{origin}/#{branch_name}"',
-        '"git checkout #{branch_name}"',
-        '"git push #{origin} :refs/heads/#{current_branch}"',
-        '"git branch -d #{current_branch}"',
+        '"#{GIT} push #{origin} #{current_branch}:refs/heads/#{branch_name}"',
+        '"#{GIT} fetch #{origin}"',
+        '"#{GIT} branch --track #{branch_name} #{origin}/#{branch_name}"',
+        '"#{GIT} checkout #{branch_name}"',
+        '"#{GIT} push #{origin} :refs/heads/#{current_branch}"',
+        '"#{GIT} branch -d #{current_branch}"',
       ]
     },
 
@@ -70,9 +71,9 @@ module GitRemoteBranch
       :description => 'delete a local and a remote branch',
       :aliases  => %w{delete destroy kill remove rm},
       :commands => [
-        '"git push #{origin} :refs/heads/#{branch_name}"',
-        '"git checkout master" if current_branch == branch_name',
-        '"git branch -d #{branch_name}"'
+        '"#{GIT} push #{origin} :refs/heads/#{branch_name}"',
+        '"#{GIT} checkout master" if current_branch == branch_name',
+        '"#{GIT} branch -d #{branch_name}"'
       ]
     },
 
@@ -81,12 +82,12 @@ module GitRemoteBranch
       :aliases  => %w{track follow grab fetch},
       :commands => [
         # This string programming thing is getting old. Not flexible enough anymore.
-        '"git fetch #{origin}"',
+        '"#{GIT} fetch #{origin}"',
         'if local_branches.include?(branch_name) 
-          "git config branch.#{branch_name}.remote #{origin}\n" +
-          "git config branch.#{branch_name}.merge refs/heads/#{branch_name}"
+          "#{GIT} config branch.#{branch_name}.remote #{origin}\n" +
+          "#{GIT} config branch.#{branch_name}.merge refs/heads/#{branch_name}"
         else
-          "git branch --track #{branch_name} #{origin}/#{branch_name}"
+          "#{GIT} branch --track #{branch_name} #{origin}/#{branch_name}"
         end'
       ]
     }

data/lib/state.rb

@@ -1,9 +1,6 @@
 module GitRemoteBranch
   include ::CaptureFu
   
-  private
-    LOCAL_BRANCH_LISTING_COMMAND = 'git branch -l'.freeze
-  
   public
     def get_current_branch
       local_branch_information[0]
@@ -13,6 +10,11 @@ module GitRemoteBranch
       local_branch_information[1]
     end
     
+    def git_found?
+      ret, msg = capture_process_output "#{GIT} --version"
+      ret == 0
+    end
+    
   private
     # Returns an array of 2 elements: [current_branch, [all local branches]]
     def local_branch_information

data/lib/version.rb

@@ -1,8 +1,8 @@
 module GitRemoteBranch  
   module VERSION #:nodoc:
     MAJOR    = 0
-    MINOR    = 2
-    TINY     = 7
+    MINOR    = 3
+    TINY     = 0
     
     STRING   = [MAJOR, MINOR, TINY].join('.').freeze
   end

data/test/functional/grb_test.rb

@@ -2,7 +2,7 @@ require File.join( File.dirname(__FILE__), '..', 'test_helper')
 
 class GRBTest < Test::Unit::TestCase
   include ShouldaFunctionalHelpers
-
+  
   on_a_repository do
     context "creating a branch in a local clone" do
       setup do
@@ -128,6 +128,18 @@ class GRBTest < Test::Unit::TestCase
   end
 
   in_a_non_git_directory do
+    with_env_var :GRB_GIT, 'unknown_git_executable_name' do
+      context "when git is not in the path" do
+        setup do
+          @text = run_grb_with ''
+        end
+        should "complain about git not being in the path" do
+          assert_match %r{unknown_git_executable_name}, @text
+          assert_match %r{PATH}, @text
+        end
+      end
+    end
+    
     context "displaying help" do
       setup do
         @text = run_grb_with 'help'

data/test/helpers/git_helper.rb

@@ -8,6 +8,7 @@ require File.dirname(__FILE__) + '/temp_dir_helper'
 # remote, local1 and local2.
 class GitHelper < TempDirHelper
   include InDir
+  GIT = GitRemoteBranch::GIT
   
   attr_reader :remote, :local1, :local2
   
@@ -24,7 +25,7 @@ class GitHelper < TempDirHelper
       mkdir_p repo_dir
       
       in_dir repo_dir do
-        `git init && echo "foo" > file.txt && git add . && git commit -a -m "dummy file"`
+        `#{GIT} init && echo "foo" > file.txt && #{GIT} add . && #{GIT} commit -a -m "dummy file"`
       end
       raise "Error setting up repository #{name}" unless $?.exitstatus == 0
       repo_dir
@@ -32,7 +33,7 @@ class GitHelper < TempDirHelper
     
     def clone_repo(origin_path, clone_path, name)
       in_dir clone_path do
-        `git clone #{File.join(origin_path, '.git').path_for_os} #{name}`
+        `#{GIT} clone #{File.join(origin_path, '.git').path_for_os} #{name}`
       end
       return File.join(clone_path, name)
     end

data/test/helpers/shoulda_functional_helpers.rb

@@ -2,6 +2,8 @@ module ShouldaFunctionalHelpers
   include CaptureFu
   include InDir
   
+  GIT = GitRemoteBranch::GIT
+  
   def self.ruby_prefix
     if ENV['RUBY']
       warn "  Forcing execution of grb with ruby interpreter #{ENV['RUBY']}"
@@ -44,7 +46,7 @@ module ShouldaFunctionalHelpers
     end
     
     def in_branch(branch)
-      execute "git checkout #{branch}"
+      execute "#{GIT} checkout #{branch}"
     end
     
     
@@ -77,7 +79,7 @@ module ShouldaFunctionalHelpers
       wheres.flatten.each do |where|
         should "have the branch '#{what_branch}' #{where == :local ? 'locally' : 'remotely'}" do
           args = get_branch_location(where)
-          assert_match(/#{what_branch}/, execute("git branch #{args}"))
+          assert_match(/#{what_branch}/, execute("#{GIT} branch #{args}"))
         end
       end
     end
@@ -86,7 +88,7 @@ module ShouldaFunctionalHelpers
       wheres.flatten.each do |where|
         should "not have the branch '#{what_branch}' #{where == :local ? 'locally' : 'remotely'}" do
           args = get_branch_location(where)
-          assert_no_match(/#{what_branch}/, execute("git branch #{args}"))
+          assert_no_match(/#{what_branch}/, execute("#{GIT} branch #{args}"))
         end
       end
     end
@@ -101,7 +103,9 @@ module ShouldaFunctionalHelpers
           @gh.cleanup
         end
 
-        yield
+        context '' do
+          yield
+        end
       end
     end
     
@@ -116,7 +120,32 @@ module ShouldaFunctionalHelpers
           @temp_dir.cleanup
         end
         
-        yield
+        context '' do
+          yield
+        end
+      end
+    end
+    
+    def with_env_var(name, value)
+      name = name.to_s
+      
+      context "with environment variable '#{name}' set to '#{value}'" do
+        setup do
+          @env_previous_value = ENV[name] if ENV.keys.include?(name)
+          ENV[name]           = value
+        end
+        
+        teardown do
+          if @env_previous_value
+            ENV[name] = @env_previous_value
+          else
+            ENV.delete(name)
+          end
+        end
+        
+        context '' do
+          yield
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: webmat-git_remote_branch
 version: !ruby/object:Gem::Version 
-  version: 0.2.7
+  version: 0.3.0
 platform: ruby
 authors: 
 - Mathieu Martin
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-11 21:00:00 -08:00
+date: 2008-11-13 21:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,13 +35,14 @@ files:
 - bin
 - bin/grb
 - CHANGELOG
-- COPYING
 - lib
+- lib/constants.rb
 - lib/git_remote_branch.rb
 - lib/param_reader.rb
 - lib/state.rb
 - lib/string_ext.rb
 - lib/version.rb
+- LICENSE
 - Rakefile
 - README.rdoc
 - tasks