git_remote_branch 0.2.4 → 0.2.6

data/test/unit/param_reader_test.rb

@@ -0,0 +1,261 @@
+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"
+
+class ParamReaderTest < Test::Unit::TestCase
+  include ShouldaUnitHelpers
+  
+  context 'read_params' do
+    context "when on a valid branch" do
+      setup do
+        grb.stubs(:capture_process_output).returns([0, REGULAR_BRANCH_LISTING])
+      end
+      
+      context "on a normal valid command without an origin" do
+        setup do
+          @p = grb.read_params %w{create the_branch}
+        end
+        
+        should_set_action_to :create
+        should_set_branch_to 'the_branch'
+        should_set_origin_to 'origin'
+        should_set_current_branch_to 'stubbed_current_branch'
+        should_set_explain_to false
+        should_set_silent_to  false
+      end
+
+      context "on a normal valid command" do
+        setup do
+          @p = grb.read_params %w{create the_branch the_origin}
+        end
+        
+        should_set_action_to :create
+        should_set_branch_to 'the_branch'
+        should_set_origin_to 'the_origin'
+        should_set_current_branch_to 'stubbed_current_branch'
+        should_set_explain_to false
+        should_set_silent_to  false
+      end
+
+      should_explain_with_current_branch 'stubbed_current_branch', "use real current branch"
+      
+      should_return_help_for_parameters %w(help), "on a 'help' command"
+      should_return_help_for_parameters %w(create), "on an incomplete command"
+      should_return_help_for_parameters %w(decombobulate something), "on an invalid command"
+
+      context "understands the --silent parameter" do
+        context "at the beginning" do
+          setup do
+            @p = grb.read_params %w{--silent create some_branch some_origin}
+          end
+          should_set_silent_to true
+          should_set_action_to :create
+          should_set_branch_to 'some_branch'
+          should_set_origin_to 'some_origin'
+        end
+
+        context "at the end" do
+          setup do
+            @p = grb.read_params %w{create some_branch some_origin --silent}
+          end
+          should_set_silent_to true
+          should_set_action_to :create
+          should_set_branch_to 'some_branch'
+          should_set_origin_to 'some_origin'
+        end
+
+        context "in the freakin' middle" do
+          setup do
+            @p = grb.read_params %w{create --silent some_branch some_origin}
+          end
+          should_set_silent_to true
+          should_set_action_to :create
+          should_set_branch_to 'some_branch'
+          should_set_origin_to 'some_origin'
+        end
+      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
+      
+      GitRemoteBranch::COMMANDS.each_key do |action|
+        context "running the '#{action}' command" do
+          setup do
+            @command = [action.to_s, 'branch_name']
+          end
+          
+          context "raising an exception" do
+            setup do
+              begin
+                grb.read_params(@command)
+              rescue => @ex
+              end
+            end
+            
+            should "raise an InvalidBranchError" do
+              assert_kind_of GitRemoteBranch::InvalidBranchError, @ex
+            end
+
+            should "give a clear error message" do
+              assert_match(/identify.*branch/, @ex.message)
+            end
+            
+            should "display git's branch listing" do
+              assert_match(/\(no branch\)/, @ex.message)
+            end
+          end
+        end
+      end
+     
+      should_explain_with_current_branch 'current_branch', "use a dummy value for the current branch"
+      
+      should_return_help_for_parameters %w(help), "on a 'help' command"
+      should_return_help_for_parameters %w(create), "on an incomplete command"
+      should_return_help_for_parameters %w(decombobulate something), "on an invalid command"
+    end
+    
+    context "when not on a git repository" do
+      setup do
+        grb.stubs(:capture_process_output).returns([128, WHEN_NOT_ON_GIT_REPOSITORY])
+      end
+      
+      should_explain_with_current_branch 'current_branch', "use a dummy value for the current branch"
+
+      should_return_help_for_parameters %w(help), "on a 'help' command"
+      should_return_help_for_parameters %w(create), "on an incomplete command"
+      should_return_help_for_parameters %w(decombobulate something), "on an invalid command"
+
+      GitRemoteBranch::COMMANDS.each_key do |action|
+        context "running the '#{action}' command" do
+          setup do
+            @command = [action.to_s, 'branch_name']
+          end
+          
+          context "raising an exception" do
+            setup do
+              begin
+                grb.read_params(@command)
+              rescue => @ex
+              end
+            end
+            
+            should "raise an NotOnGitRepositoryError" do
+              assert_kind_of GitRemoteBranch::NotOnGitRepositoryError, @ex
+            end
+
+            should "give a clear error message" do
+              assert_match(/fatal/, @ex.message)
+            end
+          end
+        end
+      end
+    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
+        @array  = ['explain', 'create', 'some_branch']
+      end
+
+      should "return true" do
+        assert grb.explain_mode!(@array)
+      end
+
+      should 'accept symbol arrays as well' do
+        assert grb.explain_mode!( @array.map{|e| e.to_sym} )
+      end
+
+      should "remove 'explain' from the argument array" do
+        grb.explain_mode!(@array)
+        assert_equal ['create', 'some_branch'], @array
+      end
+    end
+
+    context "when it receives an array that doesn't begin with 'explain'" do
+      setup do
+        @array  = ['create', 'some_branch']
+      end
+
+      should "return false" do
+        assert_false grb.explain_mode!(@array)
+      end
+
+      should "not modify the argument array" do
+        grb.explain_mode!(@array)
+        assert_equal ['create', 'some_branch'], @array
+      end
+    end
+  end
+  
+  context 'get_action' do
+    GitRemoteBranch::COMMANDS.each_pair do |cmd, params|
+      should "recognize all #{cmd} aliases" do
+        params[:aliases].each do |alias_|
+          assert cmd, grb.get_action(alias_) 
+        end
+      end
+    end
+    should 'return nil on unknown aliases' do
+      assert_nil grb.get_action('please_dont_create_an_alias_named_like_this')
+    end  
+  end
+
+  context 'get_origin' do
+    should "default to 'origin' when the param is nil" do
+      assert_equal 'origin', grb.get_origin(nil)
+    end
+    should "return the unchanged param if it's not nil" do
+      assert_equal 'someword', grb.get_origin('someword')
+    end
+  end
+
+end

data/vendor/capture_fu.rb

@@ -0,0 +1,58 @@
+module CaptureFu
+  VERSION = '0.0.1'
+
+  def capture_output(&block)
+    real_out, real_err = $stdout, $stderr
+    result = fake_out = fake_err = nil
+    begin
+      fake_out, fake_err = Helpers::PipeStealer.new, Helpers::PipeStealer.new
+      $stdout, $stderr = fake_out, fake_err
+      result = yield
+    ensure
+      $stdout, $stderr = real_out, real_err
+    end
+    return result, fake_out.captured, fake_err.captured
+  end
+
+  # This first implementation is only intended for batch executions.
+  # You can't pipe stuff programmatically to the child process.
+  def capture_process_output(command)
+
+    #capture stderr in the same stream
+    command << ' 2>&1' unless Helpers.stderr_already_redirected(command)
+
+    out = `#{command}`
+    return $?.exitstatus, out
+  end
+
+
+  private
+
+  module Helpers
+    
+    def self.stderr_already_redirected(command)
+      #Already redirected to stdout (valid for Windows)
+      return true if command =~ /2>&1\s*\Z/
+
+      #Redirected to /dev/null (this is clearly POSIX-dependent)
+      return true if command =~ /2>\/dev\/null\s*\Z/
+
+      return false
+    end
+
+    class PipeStealer < File
+      attr_reader :captured
+      def initialize
+        @captured = ''
+      end
+      def write(s)
+        @captured << s
+      end
+      def captured
+        return nil if @captured.empty?
+        @captured.dup
+      end
+    end
+
+  end #Helper module
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: git_remote_branch
 version: !ruby/object:Gem::Version 
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors: 
 - Mathieu Martin
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-15 00:00:00 -04:00
+date: 2008-08-06 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,15 +32,39 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- Rakefile
-- README
-- TODO
+- bin
 - bin/grb
+- CHANGELOG
+- COPYING
+- lib
 - lib/git_remote_branch.rb
 - lib/param_reader.rb
-- test/git_helper.rb
+- lib/version.rb
+- Rakefile
+- README
+- tasks
+- tasks/gem.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/extractable.rb
+- test/helpers/git_helper.rb
+- test/helpers/more_assertions.rb
+- test/helpers/shoulda_functional_helpers.rb
+- test/helpers/shoulda_unit_helpers.rb
+- test/helpers/temp_dir_helper.rb
 - test/test_helper.rb
+- test/unit
 - test/unit/git_helper_test.rb
+- test/unit/git_remote_branch_test.rb
+- test/unit/param_reader_test.rb
+- TODO
+- vendor
+- vendor/capture_fu.rb
 has_rdoc: false
 homepage: http://github.com/webmat/git_remote_branch
 post_install_message: 
@@ -62,12 +86,25 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: grb
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: git_remote_branch eases the interaction with remote branches
 test_files: 
-- test/git_helper.rb
+- test/functional
+- test/functional/grb_test.rb
+- test/helpers
+- test/helpers/array_extensions.rb
+- test/helpers/dir_stack.rb
+- test/helpers/extractable.rb
+- test/helpers/git_helper.rb
+- test/helpers/more_assertions.rb
+- test/helpers/shoulda_functional_helpers.rb
+- test/helpers/shoulda_unit_helpers.rb
+- test/helpers/temp_dir_helper.rb
 - test/test_helper.rb
+- test/unit
 - test/unit/git_helper_test.rb
+- test/unit/git_remote_branch_test.rb
+- test/unit/param_reader_test.rb

data/test/git_helper.rb

@@ -1,57 +0,0 @@
-require 'fileutils'
-require 'tmpdir'
-
-# Instantiating a GitHelper object creates a temp directory containing 3 repos.
-# 1 that's considered the remote repo and 2 peer local repos (local1 and local2).
-# All 3 are synchronized with the same data (they contain a few dummy files).
-# Once instantiated you can access the 3 full repo locations through attribute readers
-# remote, local1 and local2.
-class GitHelper
-  include FileUtils
-
-  @@WORK_DIR = 'repo_test'
-  
-  attr_reader :remote, :local1, :local2
-  
-  def initialize
-    @wd = get_temp_dir
-    
-    @remote = init_repo(@wd, 'remote')
-    @local1 = clone_repo(@remote, @wd, 'local1')
-    @local2 = clone_repo(@remote, @wd, 'local2')
-  end
-  
-  def cleanup
-    rm_rf @wd
-  end
-  
-  protected
-  def get_temp_dir
-    #Note: it's NOT a good idea to do this stuff un a subdirectory of the 
-    #git_remote_branch repo. Trust me :-)
-    wd = File.expand_path( File.join( Dir::tmpdir, @@WORK_DIR) )
-    Dir.mkdir wd unless File.exists? wd
-    
-    #Create new subdir with a random name
-    new_dir=''
-    begin
-      new_dir = File.join( wd, "#{rand(10000)}" )
-      Dir.mkdir new_dir
-    rescue
-      retry
-    end
-    
-    new_dir
-  end
-  
-  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"`
-    repo_dir
-  end
-  
-  def clone_repo(origin_path, clone_path, name)
-    `cd #{clone_path}; git clone #{File.join(origin_path, '.git')} #{name}`
-    return File.join(clone_path, name)
-  end
-end