git_remote_branch 0.2.6 → 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

@@ -0,0 +1,184 @@
+= Why git_remote_branch?
+
+git_remote_branch is a simple command-line tool that makes it very easy to manipulate
+branches published in shared repositories.
+
+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 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 --include-dependencies
+
+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 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 or running it with Ruby 1.9 (yes, it works).
+
+= Usage
+
+Notes: 
+- parts between brackets are optional
+- When 'origin_server' is not specified, the name 'origin' is assumed.
+
+Available commands (with aliases):
+
+
+=== Help
+
+  $ grb [-h|help]    #=> Displays help
+
+=== create (alias: new)
+
+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, share)
+
+Publish an existing local branch to the remote server.
+Set up the local branch to track the new remote branch.
+
+  $ grb publish branch_name [origin_server]
+
+
+=== 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.
+
+  $ grb delete branch_name [origin_server]
+
+
+=== track (aliases: follow grab fetch)
+
+Track an existing remote branch locally and checkout the branch.
+
+  $ grb track branch_name [origin_server]
+
+
+=== rename (aliases: rn mv move)
+
+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
+
+All commands can be prepended by the word 'explain'.  Instead of executing the
+command, git_remote_branch will simply output the list of commands you need to
+run to accomplish that goal.
+Examples: 
+
+  $ grb explain create
+  git_remote_branch version 0.3.0
+  
+  List of operations to do to create a new remote branch and track it locally:
+  
+  git push origin master:refs/heads/branch_to_create
+  git fetch origin
+  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.3.0
+  
+  List of operations to do to create a new remote branch and track it locally:
+  
+  git push github master:refs/heads/my_branch
+  git fetch github
+  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
+
+- Documentation: http://grb.rubyforge.org
+- News:          http://programblings.com/category/git/git_remote_branch/
+- Bug tracker:   http://git-remote-branch.lighthouseapp.com/projects/19198-git_remote_branch/overview
+- Code:          http://github.com/webmat/git_remote_branch
+- Mailing list:  http://groups.google.com/group/git_remote_branch
+
+
+== History
+
+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
+
+- Mathieu Martin  webmat@gmail.com
+- Caio Chassot    dev@caiochassot.com
+- Axelson         github.com/axelson
+- Carl Mercier    github.com/cmer
+
+
+== Legalese
+
+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. 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/Rakefile

@@ -2,11 +2,16 @@ require 'rubygems'
 
 require 'rake'
 
-HERE = File.dirname(__FILE__)
-windows = (RUBY_PLATFORM =~ /win32|cygwin/) rescue nil
-SUDO = windows ? "" : "sudo"
+GRB_ROOT = File.dirname(__FILE__)
+
+#So we can use GitRemoteBranch::NAME, VERSION and so on.
+require "#{GRB_ROOT}/lib/git_remote_branch"
+
+SUDO = WINDOWS ? "" : "sudo"
 
-require "#{HERE}/lib/git_remote_branch"
 Dir['tasks/**/*.rake'].each { |rake| load rake }
 
+desc 'Default: run all tests.'
 task :default => :test
+
+task :clean => [:clobber_package, :clobber_rdoc]

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

@@ -1,5 +1,18 @@
 require 'rubygems'
-require 'colored'
+
+if RUBY_VERSION =~ /1\.8/
+  gem 'colored', '>= 1.1'
+  require 'colored'
+else
+  class String
+    def red; self; end
+  end
+end
+
+begin
+  WINDOWS = !!(RUBY_PLATFORM =~ /win32|cygwin/)
+rescue Exception
+end
 
 grb_app_root = File.expand_path( File.dirname(__FILE__) + '/..' )
 
@@ -7,6 +20,9 @@ $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'
 require 'version'
 
@@ -19,22 +35,22 @@ 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}"'
       ]
     },
 
     :publish     => {
       :description => 'publish an exiting local branch',
-      :aliases  => %w{publish remotize},
+      :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}"'
       ]
     },
 
@@ -42,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}"',
       ]
     },
 
@@ -55,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}"'
       ]
     },
 
@@ -65,9 +81,14 @@ module GitRemoteBranch
       :description => 'track an existing remote branch',
       :aliases  => %w{track follow grab fetch},
       :commands => [
-        '"git fetch #{origin}"',
-        '"git checkout master" if current_branch == branch_name',
-        '"git branch --track #{branch_name} #{origin}/#{branch_name}"'
+        # This string programming thing is getting old. Not flexible enough anymore.
+        '"#{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}"
+        else
+          "#{GIT} branch --track #{branch_name} #{origin}/#{branch_name}"
+        end'
       ]
     }
   } unless defined?(COMMANDS)

data/lib/param_reader.rb

@@ -1,5 +1,4 @@
 module GitRemoteBranch
-  include ::CaptureFu
   
   private 
   HELP_PARAMS = {:action => :help}
@@ -61,24 +60,4 @@ module GitRemoteBranch
   def get_origin(origin)
     return origin || 'origin'
   end
-
-  private
-    BRANCH_LISTING_COMMAND = 'git branch -l'.freeze
-  
-  public
-    def get_current_branch
-      #This is sensitive to checkouts of branches specified with wrong case
-      
-      listing = capture_process_output("#{BRANCH_LISTING_COMMAND}")[1]
-      raise(NotOnGitRepositoryError, listing.chomp) if listing =~ /Not a git repository/i
-      
-      current_branch = listing.scan(/^\*\s+(.+)/).flatten.first
-      
-      if current_branch =~ /\(no branch\)/
-        raise InvalidBranchError, ["Couldn't identify the current local branch. The branch listing was:",
-          BRANCH_LISTING_COMMAND.red, 
-          listing].join("\n")
-      end
-      current_branch.strip
-    end
 end

data/lib/state.rb

@@ -0,0 +1,42 @@
+module GitRemoteBranch
+  include ::CaptureFu
+  
+  public
+    def get_current_branch
+      local_branch_information[0]
+    end
+    
+    def local_branches
+      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
+      #This is sensitive to checkouts of branches specified with wrong case
+      
+      listing = capture_process_output("#{LOCAL_BRANCH_LISTING_COMMAND}")[1]
+      
+      raise(NotOnGitRepositoryError, listing.chomp) if listing =~ /Not a git repository/i
+      if listing =~ /\(no branch\)/
+        raise InvalidBranchError, ["Couldn't identify the current local branch. The branch listing was:",
+          LOCAL_BRANCH_LISTING_COMMAND.red, 
+          listing].join("\n")
+      end
+      
+      current_branch = nil
+      branches = listing.split("\n").map do |line| 
+        current        = line.include? '*'
+        clean_line     = line.gsub('*','').strip
+        current_branch = clean_line if current
+        clean_line
+      end
+      
+      return current_branch, branches
+    end
+end

data/lib/string_ext.rb

@@ -0,0 +1,5 @@
+class String
+  def path_for_os
+    WINDOWS ? self.gsub('/', '\\') : self
+  end
+end

data/lib/version.rb

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

data/tasks/gem.rake

@@ -2,8 +2,6 @@ require 'yaml'
 
 require 'rake/gempackagetask'
 
-task :clean => :clobber_package
-
 spec = Gem::Specification.new do |s|
   s.name                  = GitRemoteBranch::NAME
   s.version               = GitRemoteBranch::VERSION::STRING
@@ -16,10 +14,12 @@ spec = Gem::Specification.new do |s|
   s.homepage              = "http://github.com/webmat/git_remote_branch"
   s.rubyforge_project     = 'grb'
 
-  s.has_rdoc              = false
+  s.has_rdoc              = true
+  s.extra_rdoc_files     << 'README.rdoc'
+  s.rdoc_options         << '--main' << 'README.rdoc' << '--exclude' << 'lib'
   
-  s.test_files            = Dir['test/**/*']
-  s.files                 = Dir['**/*'].reject{|f| f =~ /\Apkg|\Acoverage|\.gemspec\Z/}
+  s.test_files            = Dir['test/**/*'].reject{|f| f =~ /test_runs/}
+  s.files                 = Dir['**/*'].reject{|f| f =~ /\Apkg|\Acoverage|\Ardoc|test_runs|\.gemspec\Z/}
   
   s.executable            = 'grb'
   s.bindir                = "bin"
@@ -59,15 +59,30 @@ namespace :gem do
   desc 'Upload gem to rubyforge.org'
   task :rubyforge => :gem do
     sh 'rubyforge login'
-    sh "rubyforge add_release grb grb 'release #{GitRemoteBranch::VERSION::STRING}' pkg/#{spec.full_name}.gem"
+    sh "rubyforge add_release grb grb '#{GitRemoteBranch::VERSION::STRING}' pkg/#{spec.full_name}.gem"
     sh "rubyforge add_file grb grb #{GitRemoteBranch::VERSION::STRING} pkg/#{spec.full_name}.gem"
   end
-end
-
-task :install => [:clean, :gem] do
-  sh "#{SUDO} gem install pkg/#{spec.full_name}.gem"
-end
-
-task :uninstall do
-  sh "#{SUDO} gem uninstall -v #{GitRemoteBranch::VERSION::STRING} -x #{GitRemoteBranch::NAME}"
+  
+  desc 'Install the gem built locally'
+  task :install => [:clean, :gem] do
+    sh "#{SUDO} gem install pkg/#{spec.full_name}.gem"
+  end
+  
+  desc "Uninstall version #{GitRemoteBranch::VERSION::STRING} of the gem"
+  task :uninstall do
+    sh "#{SUDO} gem uninstall -v #{GitRemoteBranch::VERSION::STRING} -x #{GitRemoteBranch::NAME}"
+  end
+  
+  if WINDOWS
+    win_spec = spec.dup
+    win_spec.platform = Gem::Platform::CURRENT
+    win_spec.add_dependency( 'win32console', '~> 1.1' ) # Missing dependency in the 'colored' gem
+    
+    desc "Generate the Windows version of the gem"
+    namespace :windows do
+      Rake::GemPackageTask.new(win_spec) do |p|
+        p.gem_spec = win_spec
+      end
+    end
+  end
 end

data/tasks/rdoc.rake

@@ -0,0 +1,15 @@
+require 'rake/rdoctask'
+
+desc 'Generate rdoc documentation'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = GitRemoteBranch::NAME
+  rdoc.rdoc_files.include('README.rdoc')
+end
+
+namespace :rdoc do
+  desc 'Upload documentation to rubyforge'
+  task :upload => :rdoc do
+    sh "scp -r #{GRB_ROOT}/rdoc/* webmat@rubyforge.org:/var/www/gforge-projects/grb/"
+  end
+end

data/tasks/test.rake

@@ -1,10 +1,7 @@
 require 'rake/testtask'
 
 desc "Run all tests"
-Rake::TestTask.new(:test) do |t|
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
-end
+task :test => ["test:unit", "test:functional"]
 
 namespace :test do
   desc "Run functional tests"

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
@@ -20,13 +20,35 @@ class GRBTest < Test::Unit::TestCase
         should_have_branch 'new_branch', :local
       end
       
-      context "the other local clone, tracking the new branch" do
+      context "the other local clone" do
         setup do
           in_directory_for :local2
-          run_grb_with 'track new_branch'
         end
         
-        should_have_branch 'new_branch', :local, :remote
+        context "not already having a branch of the same name" do
+          setup do
+            @output = run_grb_with 'track new_branch'
+          end
+          
+          should_have_branch 'new_branch', :local, :remote
+          
+          should "use the branch --track command" do
+            assert_match %r{branch --track}, @output
+          end
+        end
+        
+        context "having a branch of the same name" do
+          setup do
+            execute "git branch new_branch"
+            @output = run_grb_with 'track new_branch'
+          end
+          
+          should_have_branch 'new_branch', :local, :remote
+          
+          should "use git config to connect the branches" do
+            assert_match %r{git\sconfig}, @output
+          end
+        end
       end
       
       context "then deleting the branch" do
@@ -106,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/constants.rb

@@ -0,0 +1,15 @@
+REGULAR_BRANCH_LISTING = <<-STR
+  other_user/master
+* stubbed_current_branch
+  rubyforge
+STR
+
+BRANCH_LISTING_WHEN_NOT_ON_BRANCH = <<-STR
+* (no branch)
+  other_user/master
+  master
+  rubyforge
+STR
+
+WHEN_NOT_ON_GIT_REPOSITORY = "fatal: Not a git repository\n"
+

data/test/helpers/git_helper.rb

@@ -1,5 +1,4 @@
-require 'fileutils'
-require 'tmpdir'
+require File.dirname(__FILE__) + '/in_dir'
 require File.dirname(__FILE__) + '/temp_dir_helper'
 
 # Instantiating a GitHelper object creates a temp directory containing 3 repos.
@@ -8,12 +7,13 @@ require File.dirname(__FILE__) + '/temp_dir_helper'
 # Once instantiated you can access the 3 full repo locations through attribute readers
 # remote, local1 and local2.
 class GitHelper < TempDirHelper
-
+  include InDir
+  GIT = GitRemoteBranch::GIT
+  
   attr_reader :remote, :local1, :local2
   
   def initialize
-    super('grb_test')
-    
+    super("#{TEST_DIR}/test_runs")
     @remote  = init_repo(directory, 'remote')
     @local1  = clone_repo(@remote, directory, 'local1')
     @local2  = clone_repo(@remote, directory, 'local2')
@@ -22,12 +22,19 @@ class GitHelper < TempDirHelper
   protected
     def init_repo(path, name)
       repo_dir = File.join(path, name)
-      `mkdir #{repo_dir}; cd $_; git init; touch file.txt; git add .; git commit -a -m "dummy file"`
+      mkdir_p repo_dir
+      
+      in_dir repo_dir do
+        `#{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
     end
     
     def clone_repo(origin_path, clone_path, name)
-      `cd #{clone_path}; git clone #{File.join(origin_path, '.git')} #{name}`
+      in_dir clone_path do
+        `#{GIT} clone #{File.join(origin_path, '.git').path_for_os} #{name}`
+      end
       return File.join(clone_path, name)
     end
 end

data/test/helpers/in_dir.rb

@@ -0,0 +1,10 @@
+module InDir
+  def in_dir(dir, &block)
+    prev_dir = Dir.pwd
+    Dir.chdir dir
+    
+    yield
+  ensure
+    Dir.chdir prev_dir
+  end
+end

data/test/helpers/shoulda_functional_helpers.rb

@@ -1,6 +1,23 @@
 module ShouldaFunctionalHelpers
   include CaptureFu
-  GRB_COMMAND = File.expand_path(File.dirname(__FILE__) + '/../../bin/grb') unless defined?(GRB_COMMAND)
+  include InDir
+  
+  GIT = GitRemoteBranch::GIT
+  
+  def self.ruby_prefix
+    if ENV['RUBY']
+      warn "  Forcing execution of grb with ruby interpreter #{ENV['RUBY']}"
+      ENV['RUBY'] + ' '
+    elsif WINDOWS
+      'ruby '
+    else
+      ''
+    end
+  end
+  
+  # Here we're only prepending with 'ruby'. 
+  # When run as a gem, RubyGems takes care of generating a batch file that does this stuff.
+  GRB_COMMAND = ruby_prefix + File.expand_path(File.dirname(__FILE__) + '/../../bin/grb') unless defined?(GRB_COMMAND)
   
   def self.included(base)
     base.extend  ClassMethods
@@ -29,7 +46,7 @@ module ShouldaFunctionalHelpers
     end
     
     def in_branch(branch)
-      execute "git checkout #{branch}"
+      execute "#{GIT} checkout #{branch}"
     end
     
     
@@ -38,8 +55,10 @@ module ShouldaFunctionalHelpers
     end
 
     def execute(command)
-      errno, returned_string = capture_process_output("cd #{current_dir} ; #{command}")
-      returned_string
+      in_dir current_dir do
+        errno, returned_string = capture_process_output(command)
+        returned_string
+      end
     end
     
     private
@@ -60,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
@@ -69,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
@@ -84,7 +103,9 @@ module ShouldaFunctionalHelpers
           @gh.cleanup
         end
 
-        yield
+        context '' do
+          yield
+        end
       end
     end
     
@@ -99,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

data/test/helpers/temp_dir_helper.rb

@@ -6,8 +6,8 @@ class TempDirHelper
   
   attr_reader :directory
 
-  def initialize(namespace='temp_dir_helper')
-    @directory = get_temp_dir!(namespace)
+  def initialize(force_temp_dir=nil)
+    @directory = get_temp_dir!(force_temp_dir)
   end
   
   def cleanup
@@ -19,14 +19,14 @@ class TempDirHelper
   end
   
   private
-    def get_temp_dir!(namespace='')
-      wd = File.expand_path( File.join( Dir::tmpdir, namespace) )
-      mkdir wd unless File.exists? wd
+    def get_temp_dir!(parent_dir=nil)
+      temp_root = File.expand_path( File.join( parent_dir || Dir::tmpdir) )
+      mkdir_p temp_root
       
       #Create new subdir with a random name
       new_dir=''
       begin
-        new_dir = File.join( wd, "#{rand(10000)}" )
+        new_dir = File.join( temp_root, "#{rand(10000)}" )
         mkdir new_dir
         
       rescue

data/test/test_helper.rb

@@ -1,22 +1,30 @@
 require 'rubygems'
 require 'test/unit'
 
-test_dir = File.dirname(__FILE__)
+TEST_DIR = File.dirname(__FILE__)
 
-# Install the non-Rails shoulda gem with 'gem install Shoulda'
-# Notice the capitalization in the name.
+# Install version 2 the shoulda gem with 
+#   gem install thoughtbot-shoulda --source http://gems.github.com
+# Shoulda depends on ActiveSupport 2.0, so if you don't have Rails 2.x installed, install ActiveSupport before Shoulda:
+#   gem install activesupport
+gem 'thoughtbot-shoulda', '~> 2.0'
 require 'shoulda'
+gem 'mocha', '~> 0.5'
 require 'mocha'
 
 # Just load redgreen if not running tests from TextMate
 IN_TM = !ENV['TM_DIRECTORY'].nil? unless defined?(IN_TM)
-require 'redgreen' unless IN_TM
-
-require 'ruby-debug'
+begin
+  require 'redgreen' unless IN_TM
+  require 'ruby-debug'
+rescue LoadError => ex
+  puts "Couldn't load optional test dependencies.\n  #{ex.inspect}"
+end
 
-require File.join( [test_dir] + %w{ .. lib git_remote_branch} )
+require File.join( [TEST_DIR] + %w{ .. lib git_remote_branch} )
 
-Dir[test_dir+'/helpers/**/*.rb'].each{|f| require f} 
+require "#{TEST_DIR}/helpers/in_dir"
+Dir[TEST_DIR+'/helpers/**/*.rb'].each{|f| require f} 
 
 class Test::Unit::TestCase
   include MoreAssertions

data/test/unit/param_reader_test.rb

@@ -1,19 +1,5 @@
 require File.join( File.dirname(__FILE__), '..', 'test_helper')
-
-REGULAR_BRANCH_LISTING = <<-STR
-  other_user/master
-* stubbed_current_branch
-  rubyforge
-STR
-
-BRANCH_LISTING_WHEN_NOT_ON_BRANCH = <<-STR
-* (no branch)
-  other_user/master
-  master
-  rubyforge
-STR
-
-WHEN_NOT_ON_GIT_REPOSITORY = "fatal: Not a git repository\n"
+require "#{TEST_DIR}/helpers/constants"
 
 class ParamReaderTest < Test::Unit::TestCase
   include ShouldaUnitHelpers
@@ -168,38 +154,6 @@ class ParamReaderTest < Test::Unit::TestCase
     end
   end
   
-  context 'get_current_branch' do
-    context "when not on a git repository" do
-      setup do
-        grb.stubs(:capture_process_output).returns([128, WHEN_NOT_ON_GIT_REPOSITORY])
-      end
-      
-      should "raise an exception" do
-        assert_raise(GitRemoteBranch::NotOnGitRepositoryError) { grb.get_current_branch }
-      end
-    end
-
-    context "when on an invalid branch" do
-      setup do
-        grb.stubs(:capture_process_output).returns([0, BRANCH_LISTING_WHEN_NOT_ON_BRANCH])
-      end
-      
-      should "raise an exception" do
-        assert_raise(GitRemoteBranch::InvalidBranchError) { grb.get_current_branch }
-      end
-    end
-
-    context "when on a valid branch" do
-      setup do
-        grb.stubs(:capture_process_output).returns([0, REGULAR_BRANCH_LISTING])
-      end
-      
-      should "return the current branch name" do
-        assert_equal 'stubbed_current_branch', grb.get_current_branch
-      end
-    end
-  end
-  
   context 'explain_mode!' do
     context "when it receives an array beginning with 'explain'" do
       setup do

data/test/unit/state_test.rb

@@ -0,0 +1,56 @@
+require File.join( File.dirname(__FILE__), '..', 'test_helper')
+require "#{TEST_DIR}/helpers/constants"
+
+class ParamReaderTest < Test::Unit::TestCase
+  include ShouldaUnitHelpers
+  
+  def self.craps_out_in_invalid_situations
+    context "when not on a git repository" do
+      setup do
+        grb.stubs(:capture_process_output).returns([128, WHEN_NOT_ON_GIT_REPOSITORY])
+      end
+      
+      should "raise an exception" do
+        assert_raise(GitRemoteBranch::NotOnGitRepositoryError) { grb.get_current_branch }
+      end
+    end
+    
+    context "when on an invalid branch" do
+      setup do
+        grb.stubs(:capture_process_output).returns([0, BRANCH_LISTING_WHEN_NOT_ON_BRANCH])
+      end
+      
+      should "raise an exception" do
+        assert_raise(GitRemoteBranch::InvalidBranchError) { grb.get_current_branch }
+      end
+    end
+  end
+  
+  context 'get_current_branch' do
+    craps_out_in_invalid_situations
+    
+    context "when on a valid branch" do
+      setup do
+        grb.stubs(:capture_process_output).returns([0, REGULAR_BRANCH_LISTING])
+      end
+      
+      should "return the current branch name" do
+        assert_equal 'stubbed_current_branch', grb.get_current_branch
+      end
+    end
+  end
+  
+  context 'local_branches' do
+    craps_out_in_invalid_situations
+    
+    context "when on a valid branch" do
+      setup do
+        grb.stubs(:capture_process_output).returns([0, REGULAR_BRANCH_LISTING])
+      end
+      
+      should "return all the local branch names" do
+        assert_array_content %w{stubbed_current_branch other_user/master rubyforge}, grb.local_branches
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: git_remote_branch
 version: !ruby/object:Gem::Version 
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors: 
 - Mathieu Martin
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-06 00:00:00 -04:00
+date: 2008-11-14 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -29,30 +29,35 @@ executables:
 - grb
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.rdoc
 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
+- README.rdoc
 - tasks
 - tasks/gem.rake
+- tasks/rdoc.rake
 - tasks/test.rake
 - test
 - test/functional
 - test/functional/grb_test.rb
 - test/helpers
 - test/helpers/array_extensions.rb
-- test/helpers/dir_stack.rb
+- test/helpers/constants.rb
 - test/helpers/extractable.rb
 - test/helpers/git_helper.rb
+- test/helpers/in_dir.rb
 - test/helpers/more_assertions.rb
 - test/helpers/shoulda_functional_helpers.rb
 - test/helpers/shoulda_unit_helpers.rb
@@ -62,14 +67,17 @@ files:
 - test/unit/git_helper_test.rb
 - test/unit/git_remote_branch_test.rb
 - test/unit/param_reader_test.rb
-- TODO
+- test/unit/state_test.rb
 - vendor
 - vendor/capture_fu.rb
-has_rdoc: false
+has_rdoc: true
 homepage: http://github.com/webmat/git_remote_branch
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --main
+- README.rdoc
+- --exclude
+- lib
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -87,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: grb
-rubygems_version: 1.2.0
+rubygems_version: 1.3.0
 signing_key: 
 specification_version: 2
 summary: git_remote_branch eases the interaction with remote branches
@@ -96,9 +104,10 @@ test_files:
 - test/functional/grb_test.rb
 - test/helpers
 - test/helpers/array_extensions.rb
-- test/helpers/dir_stack.rb
+- test/helpers/constants.rb
 - test/helpers/extractable.rb
 - test/helpers/git_helper.rb
+- test/helpers/in_dir.rb
 - test/helpers/more_assertions.rb
 - test/helpers/shoulda_functional_helpers.rb
 - test/helpers/shoulda_unit_helpers.rb
@@ -108,3 +117,4 @@ test_files:
 - test/unit/git_helper_test.rb
 - test/unit/git_remote_branch_test.rb
 - test/unit/param_reader_test.rb
+- test/unit/state_test.rb

data/README

@@ -1,140 +0,0 @@
-==== Why git_remote_branch? ====
-
-The basic idea for git_remote_branch is to trivialize the interaction with
-remote branches in simple situations. 
-
-For now git_remote_branch assumes that the local and remote branches have the
-same name. Multiple origins are supported.
-
-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.
-
-
-
-==== Installation ====
-
-  sudo gem install grb
-
-
-Or if you want the bleeding edge from GitHub
-You may try
-  sudo gem install webmat-git_remote_branch --source=http://gems.github.com
-
-But you're probably better off with
-  git clone git://github.com/webmat/git_remote_branch.git
-  rake install
-
-
-
-==== Usage ====
-
-Notes: 
-- parts between brackets are optional
-- When 'origin_server' is not specified, the name 'origin' is assumed.
-
-Available commands (with aliases):
-
-
-== Help ==
-
-$ grb [-h|help]    #=> Displays help
-
-== 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.
-
-$ grb create branch_name [origin_server]
-
-
-== publish (aliases: remotize) ==
-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 the remote branch then delete the local branch.
-The local branch is not deleted if there are pending changes.
-
-$ grb delete branch_name [origin_server]
-
-
-== track (aliases: follow grab fetch) ==
-Track an existing remote branch locally.
-
-$ 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.
-
-$ grb rename branch_name [origin_server]
-
-
-== explain ==
-
-All commands can be prepended by the word 'explain'.  Instead of executing the
-command, git_remote_branch will simply output the list of commands you need to
-run to accomplish that goal.
-Examples: 
-
-$ grb explain create
-git_remote_branch version 0.2.6
-
-List of operations to do to create a new remote branch and track it locally:
-
-git push origin master:refs/heads/branch_to_create
-git fetch origin
-git branch --track branch_to_create origin/branch_to_create
-git checkout branch_to_create
-
-
-$ grb explain create my_branch github
-git_remote_branch version 0.2.6
-
-List of operations to do to create a new remote branch and track it locally:
-
-git push github master:refs/heads/my_branch
-git fetch github
-git branch --track my_branch github/my_branch
-git checkout my_branch
-
-
-
-==== More on git_remote_branch ====
-
-Site:         http://github.com/webmat/git_remote_branch
-Mailing list: http://groups.google.com/group/git_remote_branch
-
-
-
-==== History ====
-
-This script was originally 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/
-
-
-I'm using it as a starting point to make it even easier to interact with remote
-repositories.
-
-
-== Contributors ==
-
-- Mathieu Martin  webmat@gmail.com
-- Carl Mercier    (Carl: want your email here?)
-- Caio Chassot    dev@caiochassot.com
-
-
-== Legalese ==
-
-git_remote_branch is licensed under the MIT License. See the file COPYING for details.

data/TODO

@@ -1,16 +0,0 @@
-- tests :-)
-- offer help when branch -d fails
-- connect (new remote repo)
-- Make remotize work when not specifying the local branch (and use this one by default)
-- avoid deleting local branches when tracking with the help of git-config ?
-
-- drop assumption that master can be treated differently than other branches (e.g. considered as a safe checkout)
-- reliance on current_branch
-  - is it even necessary to be on a branch per se? I think not...
-  - survive checkouts with wrong case 
-    e.g.: branch "Bob" checked out branch 'bob'. git branch -l won't correctly flag branch Bob as current.
-
-- better exit status behavior
-- Add verification if remote delete didn't work
-- add support for different remote name (--remote-name)
-

data/test/helpers/dir_stack.rb

@@ -1,25 +0,0 @@
-class DirStack
-  attr_reader :dir_stack
-  
-  def current_dir
-    dir_stack.size == 0 ? Dir.pwd : dir_stack.last
-  end
-  
-  def pushd(dirname)
-    dir_stack.push(File.expand_path(dirname))
-  end
-  
-  def popd
-    return [] if dir_stack.size==0
-    dir_stack.pop
-    dir_stack
-  end
-  
-  def to_s
-    dir_stack.inspect
-  end
-  
-  def initialize
-    @dir_stack = []
-  end
-end