webmat-git_remote_branch 0.2.4 → 0.2.6

data/test/helpers/shoulda_unit_helpers.rb

@@ -0,0 +1,88 @@
+module ShouldaUnitHelpers
+  def self.included(base)
+    base.extend ClassMethods 
+    add_param_checkers(base)
+  end
+  
+  def self.add_param_checkers(base)
+    # Excuse my french but:
+    %w(action branch origin current_branch silent explain).each do |param|
+      base.instance_eval(%Q!
+        def self.should_set_#{param}_to(#{param}_value)
+          should "set #{param} to #{ '#{' }#{ param }_value}" do
+            assert_equal #{param}_value, @p[:#{param}]
+          end
+        end
+      !)
+    end
+    # In other words, create a bunch of helpers like:
+    # 
+    # def self.should_set_explain_to(explain_value)
+    #   should "set explain to #{explain_value}" do
+    #     assert_equal explain_value, @p[:explain]
+    #   end
+    # end
+    
+  end
+  
+  module ClassMethods
+    def should_return_help_for_parameters(params, context_explanation)
+      context context_explanation do
+        setup do
+          @p = grb.read_params params
+        end
+        
+        should "not even get to checking the current_branch" do
+          grb.expects(:get_current_branch).never
+          grb.read_params ['help']
+        end
+        
+        should "only return a hash specifying the action" do
+          assert_array_content [:action], @p.keys
+        end
+        
+        should_set_action_to :help
+      end
+    end
+    
+    def should_explain_with_current_branch(current_branch_value, current_branch_explanation)
+      context "on an 'explain' command" do
+        context "with no information provided other than the action" do
+          setup do
+            @p = grb.read_params %w{explain create}
+          end
+          
+          should_set_explain_to         true
+          should_set_action_to          :create
+          should_set_origin_to          'origin'
+          
+          context current_branch_explanation do
+            should_set_current_branch_to  current_branch_value
+          end
+          
+          should "set a dummy new branch name" do
+            assert @p[:branch]
+          end
+        end
+        
+        context "with all information provided" do
+          setup do
+            @p = grb.read_params %w{explain create specific_branch specific_origin}
+          end
+          
+          should_set_explain_to         true
+          should_set_action_to          :create
+          should_set_current_branch_to  current_branch_value
+          
+          should "set the origin to 'specific_origin'" do
+            assert_equal 'specific_origin', @p[:origin]
+          end
+          
+          should "set the specified branch name" do
+            assert_equal 'specific_branch', @p[:branch]
+          end
+        end
+      end
+    end
+  end
+end

data/test/helpers/temp_dir_helper.rb

@@ -0,0 +1,38 @@
+require 'fileutils'
+require 'tmpdir'
+
+class TempDirHelper
+  include FileUtils
+  
+  attr_reader :directory
+
+  def initialize(namespace='temp_dir_helper')
+    @directory = get_temp_dir!(namespace)
+  end
+  
+  def cleanup
+    rm_rf @directory
+  end
+  
+  def to_s
+    directory
+  end
+  
+  private
+    def get_temp_dir!(namespace='')
+      wd = File.expand_path( File.join( Dir::tmpdir, namespace) )
+      mkdir wd unless File.exists? wd
+      
+      #Create new subdir with a random name
+      new_dir=''
+      begin
+        new_dir = File.join( wd, "#{rand(10000)}" )
+        mkdir new_dir
+        
+      rescue
+        retry
+      end
+      
+      new_dir
+    end
+end

data/test/test_helper.rb

@@ -3,19 +3,27 @@ require 'test/unit'
 
 test_dir = File.dirname(__FILE__)
 
-require 'redgreen'
+# Install the non-Rails shoulda gem with 'gem install Shoulda'
+# Notice the capitalization in the name.
+require 'shoulda'
+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'
 
-require File.join(test_dir, 'git_helper')
 require File.join( [test_dir] + %w{ .. lib git_remote_branch} )
 
+Dir[test_dir+'/helpers/**/*.rb'].each{|f| require f} 
+
 class Test::Unit::TestCase
-  include GitRemoteBranch
+  include MoreAssertions
 
-  # Passes assertion if condition is false  
-  def assert_false(condition, message = nil)
-    message = "assert_false failed" unless message
-    assert condition == false, message
+  attr_reader :grb
+  def setup
+    @grb = Object.new
+    @grb.send :extend, GitRemoteBranch
   end
-
 end

data/test/unit/git_remote_branch_test.rb

@@ -0,0 +1,39 @@
+require File.join( File.dirname(__FILE__), '..', 'test_helper')
+
+class GitRemoteBranchTest < Test::Unit::TestCase
+  context 'help' do
+    should 'contain examples for all basic commands' do
+      GitRemoteBranch::COMMANDS.keys.each do |k|
+        assert_match "grb #{k} branch_name", grb.get_usage
+      end
+    end
+    
+    should 'contain an example for explain' do
+      assert_match 'grb explain', grb.get_usage
+    end
+    
+    should 'contain an enumeration of all aliases' do
+      GitRemoteBranch::COMMANDS.each_pair do |k,v|
+        assert_match "#{k}: #{v[:aliases].join(', ')}", grb.get_usage
+      end
+    end
+  end
+  
+  context "the reverse mapping for aliases" do
+    GitRemoteBranch::COMMANDS.each_pair do |cmd, params|
+      params[:aliases].each do |alias_|
+        should "contain the alias #{alias_}" do
+          assert GitRemoteBranch::ALIAS_REVERSE_MAP[alias_]
+        end
+      end
+    end
+    
+    context "upon creation" do
+      should "raise an exception when there are duplicates" do
+        assert_raise(RuntimeError) do
+          GitRemoteBranch.get_reverse_map( GitRemoteBranch::COMMANDS.merge(:new_command => {:aliases => ['create']}) )
+        end
+      end
+    end
+  end
+end

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