kch-git_remote_branch 0.3.0

data/lib/param_reader.rb

@@ -0,0 +1,63 @@
+module GitRemoteBranch
+  
+  private 
+  HELP_PARAMS = {:action => :help}
+
+  public
+  def read_params(argv)
+    #TODO Some validation on the params
+    
+    p={}
+    p[:silent]  = silent!(argv)
+    p[:explain] = explain_mode!(argv)
+    
+    p[:action]  = get_action(argv[0]) or return HELP_PARAMS
+
+    return HELP_PARAMS if p[:action] == :help
+
+    p[:branch]  = get_branch(argv[1])
+    p[:origin]  = get_origin(argv[2])
+    
+    # If in explain mode, the user doesn't have to specify a branch or be on in
+    # actual repo to get the explanation. 
+    # Of course if he is, the explanation will be made better by using contextual info.
+    if p[:explain]
+      p[:branch] ||= "branch_to_#{p[:action]}"
+      p[:current_branch] = begin
+        get_current_branch
+      rescue NotOnGitRepositoryError, InvalidBranchError
+        'current_branch'
+      end
+
+    else
+      return HELP_PARAMS unless p[:branch]
+      p[:current_branch] = get_current_branch
+    end
+    return p
+  end
+
+  def explain_mode!(argv)
+    if argv[0].to_s.downcase == 'explain'
+      argv.shift
+      true
+    else
+      false
+    end
+  end
+  
+  def silent!(argv)
+    !!argv.delete('--silent')
+  end
+
+  def get_action(action)
+    ALIAS_REVERSE_MAP[action.to_s.downcase]
+  end
+
+  def get_branch(branch)
+    branch
+  end
+  
+  def get_origin(origin)
+    return origin || 'origin'
+  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/version.rb

@@ -0,0 +1,14 @@
+module GitRemoteBranch  
+  module VERSION #:nodoc:
+    MAJOR    = 0
+    MINOR    = 3
+    TINY     = 0
+    
+    STRING   = [MAJOR, MINOR, TINY].join('.').freeze
+  end
+  
+  NAME          = 'git_remote_branch'.freeze
+  COMPLETE_NAME = "#{NAME} #{VERSION::STRING}".freeze  
+  COMMAND_NAME  = 'grb'.freeze
+  SHORT_NAME    = COMMAND_NAME
+end

data/tasks/gem.rake

@@ -0,0 +1,89 @@
+require 'yaml'
+
+require 'rake/gempackagetask'
+
+spec = Gem::Specification.new do |s|
+  s.name                  = GitRemoteBranch::NAME
+  s.version               = GitRemoteBranch::VERSION::STRING
+  s.summary               = "git_remote_branch eases the interaction with remote branches"
+  s.description           = "git_remote_branch is a learning tool to ease the interaction with " +
+                            "remote branches in simple situations."
+
+  s.authors               = ['Mathieu Martin', 'Carl Mercier']
+  s.email                 = "webmat@gmail.com"
+  s.homepage              = "http://github.com/webmat/git_remote_branch"
+  s.rubyforge_project     = 'grb'
+
+  s.has_rdoc              = true
+  s.extra_rdoc_files     << 'README.rdoc'
+  s.rdoc_options         << '--main' << 'README.rdoc' << '--exclude' << 'lib'
+  
+  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"
+  s.require_path          = "lib"
+  
+  s.add_dependency( 'colored', '>= 1.1' )
+end
+
+#Creates clobber_package, gem, package and repackage tasks
+#Note on clobber_package: fortunately, this will clobber the CODE package
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+end
+
+TAG_COMMAND = "git tag -m 'Tagging version #{GitRemoteBranch::VERSION::STRING}' -a v#{GitRemoteBranch::VERSION::STRING}"
+task :tag_warn do
+  puts  "*" * 40,
+        "Don't forget to tag the release:",
+        '',
+        "  " + TAG_COMMAND,
+        '',
+        "or run rake tag",
+        "*" * 40
+end
+task :tag do
+  sh TAG_COMMAND
+  puts "Upload tags to repo with 'git push --tags'"
+end
+task :gem => :tag_warn
+
+namespace :gem do
+  desc "Update the gemspec for GitHub's gem server"
+  task :github do
+    File.open("#{GitRemoteBranch::NAME}.gemspec", 'w'){|f| f.puts YAML::dump(spec) }
+    puts "gemspec generated here: #{GitRemoteBranch::NAME}.gemspec"
+  end
+  
+  desc 'Upload gem to rubyforge.org'
+  task :rubyforge => :gem do
+    sh 'rubyforge login'
+    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
+  
+  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

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

data/test/functional/grb_test.rb

@@ -0,0 +1,188 @@
+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
+        in_directory_for :local1
+        run_grb_with 'create new_branch'
+      end
+      
+      should_have_branch 'new_branch', :local, :remote
+      
+      context "the remote repository" do
+        setup do
+          in_directory_for :remote
+        end
+        
+        should_have_branch 'new_branch', :local
+      end
+      
+      context "the other local clone" do
+        setup do
+          in_directory_for :local2
+        end
+        
+        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
+        setup do
+          run_grb_with 'delete new_branch'
+        end
+        
+        should_not_have_branch 'new_branch', :local, :remote
+        
+        context "the remote repository" do
+          setup do
+            in_directory_for :remote
+          end
+
+          should_not_have_branch 'new_branch', :local
+        end
+      end
+      
+      context "renaming the branch" do
+        setup do
+          in_directory_for :local1
+          in_branch :new_branch
+          run_grb_with 'rename renamed_branch'
+        end
+
+        should_not_have_branch 'new_branch', :local, :remote
+        should_have_branch 'renamed_branch', :local, :remote
+
+        context "the remote repository" do
+          setup do
+            in_directory_for :remote
+          end
+
+          should_not_have_branch 'new_branch', :local
+          should_have_branch 'renamed_branch', :local
+        end
+      end
+    end
+    
+    context "having a local only branch" do
+      setup do
+        in_directory_for :local1
+        execute "git branch my_branch"
+      end
+      
+      should_have_branch 'my_branch', :local #Sanity check
+      
+      context "remotizing the branch" do
+        setup do
+          run_grb_with 'publish my_branch'
+        end
+        
+        should_have_branch 'my_branch', :remote
+        
+        context "the remote repository" do
+          setup do
+            in_directory_for :remote
+          end
+
+          should_have_branch 'my_branch', :local
+        end
+      end
+    end
+    
+    context "running grb with a detailed explain" do
+      setup do
+        in_directory_for :local1
+        @text = run_grb_with 'explain create teh_branch somewhere'
+      end
+      
+      should "display the commands to run with the user-specified values, including current_branch" do
+        %w{master somewhere refs/heads/teh_branch}.each do |word|
+          assert_match(/#{word}/, @text)
+        end
+      end
+    end
+  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'
+      end
+      
+      should "work" do
+        words_in_help = %w{create delete explain git_remote_branch}
+        words_in_help.each do |word|
+          assert_match(/#{word}/, @text)
+        end
+      end
+      
+      should "not complain" do
+        assert_no_match(/not a git repository/i, @text)
+      end
+    end
+    
+    context "running grb with a generic explain" do
+      setup do
+        @text = run_grb_with 'explain create'
+      end
+      
+      should "display the commands to run with dummy values filled in" do
+        #Not sure if this will turn out to be too precise to my liking...
+        generic_words_in_explain_create = %w{
+          origin current_branch refs/heads/branch_to_create
+          git push fetch checkout}
+        generic_words_in_explain_create.each do |word|
+          assert_match(/#{word}/, @text)
+        end
+      end
+    end
+    
+    context "running grb with a detailed explain" do
+      setup do
+        @text = run_grb_with 'explain create teh_branch somewhere'
+      end
+      
+      should "display the commands to run with the user-specified values (except for current_branch)" do
+        %w{somewhere current_branch refs/heads/teh_branch}.each do |word|
+          assert_match(/#{word}/, @text)
+        end
+      end
+    end
+  end
+end

data/test/helpers/array_extensions.rb

@@ -0,0 +1,14 @@
+# Can be included in any class that responds to #each. 
+# Such as Array.
+module CountDistinct
+  def count_all(purge_smaller_than=0)
+    h={}
+    self.each {|e|
+      h[e] ? h[e] += 1 : h[e] = 1
+    }
+    h.extract{|k,v| v >= purge_smaller_than}
+  end
+end
+
+Array.send :include, CountDistinct
+