twig 1.1 → 1.2

data/lib/twig/options.rb

@@ -17,10 +17,14 @@ class Twig
         opts.each do |key, value|
           case key
           when 'branch'        then set_option(:branch,        value)
-          when 'except-branch' then set_option(:branch_except, value)
-          when 'only-branch'   then set_option(:branch_only,   value)
-          when 'max-days-old'  then set_option(:max_days_old,  value)
           when 'header-style'  then set_option(:header_style,  value)
+          when 'max-days-old'  then set_option(:max_days_old,  value)
+          when /^except-/
+            property_name = key.sub(/^except-/, '').to_sym
+            set_option(:property_except, property_name => value)
+          when /^only-/
+            property_name = key.sub(/^only-/, '').to_sym
+            set_option(:property_only, property_name => value)
           end
         end
       end
@@ -34,18 +38,31 @@ class Twig
         else
           abort %{The branch "#{value}" could not be found.}
         end
-      when :branch_except
-        options[:branch_except] = Regexp.new(value)
-      when :branch_only
-        options[:branch_only] = Regexp.new(value)
+
       when :header_style
         set_header_style_option(value)
+
       when :max_days_old
         if Twig::Util.numeric?(value)
           options[:max_days_old] = value.to_f
         else
           abort %{The value `--max-days-old=#{value}` is invalid.}
         end
+
+      when :property_except
+        property_hash = value.inject({}) do |hsh, (property, val)|
+          hsh.merge(property => Regexp.new(val))
+        end
+        options[:property_except] ||= {}
+        options[:property_except].merge!(property_hash)
+
+      when :property_only
+        property_hash = value.inject({}) do |hsh, (property, val)|
+          hsh.merge(property => Regexp.new(val))
+        end
+        options[:property_only] ||= {}
+        options[:property_only].merge!(property_hash)
+
       when :unset_property
         options[:unset_property] = value
       end

data/lib/twig/version.rb

@@ -1,3 +1,3 @@
 class Twig
-  VERSION = '1.1'
+  VERSION = '1.2'
 end

data/spec/twig/cli_spec.rb

@@ -82,34 +82,112 @@ describe Twig::Cli do
       @twig.options[:branch].should == 'test'
     end
 
-    it 'recognizes `--except-branch` and sets a `:branch_except` option' do
-      @twig.options[:branch_except].should be_nil # Precondition
+    it 'recognizes `--max-days-old` and sets a `:max_days_old` option' do
+      @twig.options[:max_days_old].should be_nil # Precondition
+      @twig.read_cli_options!(%w[--max-days-old 30])
+      @twig.options[:max_days_old].should == 30
+    end
+
+    it 'recognizes `--except-branch` and sets a `:property_except` option' do
+      @twig.options[:property_except].should be_nil # Precondition
       @twig.read_cli_options!(%w[--except-branch test])
-      @twig.options[:branch_except].should == /test/
+      @twig.options[:property_except].should == { :branch => /test/ }
     end
 
-    it 'recognizes `--only-branch` and sets a `:branch_only` option' do
-      @twig.options[:branch_only].should be_nil # Precondition
+    it 'recognizes `--only-branch` and sets a `:property_only` option' do
+      @twig.options[:property_only].should be_nil # Precondition
       @twig.read_cli_options!(%w[--only-branch test])
-      @twig.options[:branch_only].should == /test/
+      @twig.options[:property_only].should == { :branch => /test/ }
     end
 
-    it 'recognizes `--max-days-old` and sets a `:max_days_old` option' do
-      @twig.options[:max_days_old].should be_nil # Precondition
-      @twig.read_cli_options!(%w[--max-days-old 30])
-      @twig.options[:max_days_old].should == 30
+    context 'with custom property "only" filtering' do
+      before :each do
+        @twig.options[:property_only].should be_nil # Precondition
+      end
+
+      it 'recognizes `--only-<property>` and sets a `:property_only` option' do
+        Twig::Branch.stub(:all_properties) { %w[foo] }
+        @twig.read_cli_options!(%w[--only-foo test])
+        @twig.options[:property_only].should == { :foo => /test/ }
+      end
+
+      it 'recognizes `--only-branch` and `--only-<property>` together' do
+        Twig::Branch.stub(:all_properties) { %w[foo] }
+
+        @twig.read_cli_options!(%w[--only-branch test --only-foo bar])
+
+        @twig.options[:property_only].should == {
+          :branch => /test/,
+          :foo    => /bar/
+        }
+      end
+
+      it 'does not recognize `--only-<property>` for a missing property' do
+        property_name = 'foo'
+        Twig::Branch.all_properties.should_not include(property_name) # Precondition
+        @twig.stub(:puts)
+
+        begin
+          @twig.read_cli_options!(["--only-#{property_name}", 'test'])
+        rescue SystemExit => exception
+          expected_exception = exception
+        end
+
+        expected_exception.should_not be_nil
+        expected_exception.status.should == 0
+        @twig.options[:property_only].should be_nil
+      end
+    end
+
+    context 'with custom property "except" filtering' do
+      before :each do
+        @twig.options[:property_except].should be_nil # Precondition
+      end
+
+      it 'recognizes `--except-<property>` and sets a `:property_except` option' do
+        Twig::Branch.stub(:all_properties) { %w[foo] }
+        @twig.read_cli_options!(%w[--except-foo test])
+        @twig.options[:property_except].should == { :foo => /test/ }
+      end
+
+      it 'recognizes `--except-branch` and `--except-<property>` together' do
+        Twig::Branch.stub(:all_properties) { %w[foo] }
+
+        @twig.read_cli_options!(%w[--except-branch test --except-foo bar])
+
+        @twig.options[:property_except].should == {
+          :branch => /test/,
+          :foo    => /bar/
+        }
+      end
+
+      it 'does not recognize `--except-<property>` for a missing property' do
+        property_name = 'foo'
+        Twig::Branch.all_properties.should_not include(property_name) # Precondition
+        @twig.stub(:puts)
+
+        begin
+          @twig.read_cli_options!(["--except-#{property_name}", 'test'])
+        rescue SystemExit => exception
+          expected_exception = exception
+        end
+
+        expected_exception.should_not be_nil
+        expected_exception.status.should == 0
+        @twig.options[:property_except].should be_nil
+      end
     end
 
     it 'recognizes `--all` and unsets other options except `:branch`' do
       @twig.set_option(:max_days_old, 30)
-      @twig.set_option(:branch_except, /test/)
-      @twig.set_option(:branch_only, /test/)
+      @twig.set_option(:property_except, :branch => /test/)
+      @twig.set_option(:property_only,   :branch => /test/)
 
       @twig.read_cli_options!(['--all'])
 
       @twig.options[:max_days_old].should be_nil
-      @twig.options[:branch_except].should be_nil
-      @twig.options[:branch_only].should be_nil
+      @twig.options[:property_except].should be_nil
+      @twig.options[:property_only].should be_nil
     end
 
     it 'recognizes `--unset` and sets an `:unset_property` option' do
@@ -134,27 +212,38 @@ describe Twig::Cli do
     end
 
     it 'handles invalid options' do
-      @twig.should_receive(:puts) do |message|
-        message.should include('invalid option: --foo')
+      @twig.should_receive(:abort_for_option_exception) do |exception|
+        exception.should be_a(OptionParser::InvalidOption)
+        exception.message.should include('invalid option: --foo')
       end
-      @twig.should_receive(:puts) do |message|
-        message.should include('`twig --help`')
-      end
-      @twig.should_receive(:exit)
 
       @twig.read_cli_options!(['--foo'])
     end
 
     it 'handles missing arguments' do
-      @twig.should_receive(:puts) do |message|
-        message.should include('missing argument: --branch')
+      @twig.should_receive(:abort_for_option_exception) do |exception|
+        exception.should be_a(OptionParser::MissingArgument)
+        exception.message.should include('missing argument: --branch')
       end
+
+      @twig.read_cli_options!(['--branch'])
+    end
+  end
+
+  describe '#abort_for_option_exception' do
+    before :each do
+      @twig = Twig.new
+    end
+
+    it 'prints a message and exits' do
+      exception = Exception.new('test exception')
+      @twig.should_receive(:puts).with(exception.message)
       @twig.should_receive(:puts) do |message|
         message.should include('`twig --help`')
       end
       @twig.should_receive(:exit)
 
-      @twig.read_cli_options!(['--branch'])
+      @twig.abort_for_option_exception(exception)
     end
   end
 
@@ -187,7 +276,6 @@ describe Twig::Cli do
         # Since we're stubbing `exec` (with an expectation), we still need it
         # to exit early like the real implementation. The following handles the
         # exit somewhat gracefully.
-        expected_exception = nil
         begin
           @twig.read_cli_args!(['subcommand'])
         rescue SystemExit => exception
@@ -214,71 +302,22 @@ describe Twig::Cli do
         @property_value = 'bar'
       end
 
-      context 'with the current branch' do
-        before :each do
-          @twig.should_receive(:current_branch_name).and_return(@branch_name)
-        end
-
-        it 'gets a property' do
-          @twig.should_receive(:get_branch_property).
-            with(@branch_name, @property_name).and_return(@property_value)
-          @twig.should_receive(:puts).with(@property_value)
-
-          @twig.read_cli_args!([@property_name])
-        end
-
-        it 'shows an error if getting a property that is not set' do
-          @twig.should_receive(:get_branch_property).
-            with(@branch_name, @property_name).and_return(nil)
-          @twig.should_receive(:abort) do |message|
-            message.should include(
-              %{The branch "#{@branch_name}" does not have the property "#{@property_name}"}
-            )
-          end
-
-          @twig.read_cli_args!([@property_name])
-        end
-
-        it 'shows an error if getting a property whose name is an empty string' do
-          property_name = ' '
-          error_message = 'test error'
-          @twig.should_receive(:get_branch_property).
-            with(@branch_name, property_name) do
-              raise ArgumentError, error_message
-            end
-          @twig.should_receive(:abort).with(error_message)
+      it 'gets a property for the current branch' do
+        @twig.should_receive(:current_branch_name).and_return(@branch_name)
+        @twig.should_receive(:get_branch_property_for_cli).
+          with(@branch_name, @property_name)
 
-          @twig.read_cli_args!([property_name])
-        end
+        @twig.read_cli_args!([@property_name])
       end
 
-      context 'with a specified branch' do
-        before :each do
-          @twig.should_receive(:branch_names).and_return([@branch_name])
-          @twig.set_option(:branch, @branch_name)
-        end
-
-        it 'gets a property' do
-          @twig.should_receive(:get_branch_property).
-            with(@branch_name, @property_name).and_return(@property_value)
-          @twig.should_receive(:puts).with(@property_value)
-
-          @twig.read_cli_args!([@property_name])
-        end
-
-        it 'shows an error if getting a property that is not set' do
-          @twig.should_receive(:get_branch_property).
-            with(@branch_name, @property_name).and_return(nil)
-          @twig.should_receive(:abort) do |message|
-            message.should include(
-              %{The branch "#{@branch_name}" does not have the property "#{@property_name}"}
-            )
-          end
+      it 'gets a property for a specified branch' do
+        @twig.should_receive(:branch_names).and_return([@branch_name])
+        @twig.set_option(:branch, @branch_name)
+        @twig.should_receive(:get_branch_property_for_cli).
+          with(@branch_name, @property_name)
 
-          @twig.read_cli_args!([@property_name])
-        end
+        @twig.read_cli_args!([@property_name])
       end
-
     end
 
     context 'setting properties' do
@@ -291,10 +330,8 @@ describe Twig::Cli do
 
       it 'sets a property for the current branch' do
         @twig.should_receive(:current_branch_name).and_return(@branch_name)
-        @twig.should_receive(:set_branch_property).
-          with(@branch_name, @property_name, @property_value).
-          and_return(@message)
-        @twig.should_receive(:puts).with(@message)
+        @twig.should_receive(:set_branch_property_for_cli).
+          with(@branch_name, @property_name, @property_value)
 
         @twig.read_cli_args!([@property_name, @property_value])
       end
@@ -302,37 +339,12 @@ describe Twig::Cli do
       it 'sets a property for a specified branch' do
         @twig.should_receive(:branch_names).and_return([@branch_name])
         @twig.set_option(:branch, @branch_name)
-        @twig.should_receive(:set_branch_property).
+        @twig.should_receive(:set_branch_property_for_cli).
           with(@branch_name, @property_name, @property_value).
           and_return(@message)
-        @twig.should_receive(:puts).with(@message)
 
         @twig.read_cli_args!([@property_name, @property_value])
       end
-
-      it 'handles ArgumentError when setting an invalid branch property' do
-        error_message = 'test error'
-        @twig.should_receive(:current_branch_name).and_return(@branch_name)
-        @twig.should_receive(:set_branch_property).
-          with(@branch_name, @property_name, '') do
-            raise ArgumentError, error_message
-          end
-        @twig.should_receive(:abort).with(error_message)
-
-        @twig.read_cli_args!([@property_name, ''])
-      end
-
-      it 'handles RuntimeError when setting an invalid branch property' do
-        error_message = 'test error'
-        @twig.should_receive(:current_branch_name).and_return(@branch_name)
-        @twig.should_receive(:set_branch_property).
-          with(@branch_name, @property_name, '') do
-            raise RuntimeError, error_message
-          end
-        @twig.should_receive(:abort).with(error_message)
-
-        @twig.read_cli_args!([@property_name, ''])
-      end
     end
 
     context 'unsetting properties' do
@@ -345,9 +357,8 @@ describe Twig::Cli do
 
       it 'unsets a property for the current branch' do
         @twig.should_receive(:current_branch_name).and_return(@branch_name)
-        @twig.should_receive(:unset_branch_property).
-          with(@branch_name, @property_name).and_return(@message)
-        @twig.should_receive(:puts).with(@message)
+        @twig.should_receive(:unset_branch_property_for_cli).
+          with(@branch_name, @property_name)
 
         @twig.read_cli_args!([])
       end
@@ -355,36 +366,133 @@ describe Twig::Cli do
       it 'unsets a property for a specified branch' do
         @twig.should_receive(:branch_names).and_return([@branch_name])
         @twig.set_option(:branch, @branch_name)
-        @twig.should_receive(:unset_branch_property).
-          with(@branch_name, @property_name).and_return(@message)
-        @twig.should_receive(:puts).with(@message)
+        @twig.should_receive(:unset_branch_property_for_cli).
+          with(@branch_name, @property_name)
 
         @twig.read_cli_args!([])
       end
+    end
+  end
 
-      it 'handles ArgumentError when unsetting an invalid branch property' do
-        error_message = 'test error'
-        @twig.should_receive(:current_branch_name).and_return(@branch_name)
-        @twig.should_receive(:unset_branch_property).
-          with(@branch_name, @property_name) do
-            raise ArgumentError, error_message
-          end
-        @twig.should_receive(:abort).with(error_message)
+  describe '#get_branch_property_for_cli' do
+    before :each do
+      @twig          = Twig.new
+      @branch_name   = 'test'
+      @property_name = 'foo'
+    end
 
-        @twig.read_cli_args!([])
-      end
+    it 'gets a property' do
+      property_value = 'bar'
+      @twig.should_receive(:get_branch_property).
+        with(@branch_name, @property_name).and_return(property_value)
+      @twig.should_receive(:puts).with(property_value)
 
-      it 'handles MissingPropertyError when unsetting a missing branch property' do
-        error_message = 'test error'
-        @twig.should_receive(:current_branch_name).and_return(@branch_name)
-        @twig.should_receive(:unset_branch_property).
-          with(@branch_name, @property_name) do
-            raise Twig::Branch::MissingPropertyError, error_message
-          end
-        @twig.should_receive(:abort).with(error_message)
+      @twig.get_branch_property_for_cli(@branch_name, @property_name)
+    end
 
-        @twig.read_cli_args!([])
-      end
+    it 'shows an error when getting a property that is not set' do
+      error_message = 'test error'
+      @twig.should_receive(:get_branch_property).
+        with(@branch_name, @property_name).and_return(nil)
+      Twig::Branch::MissingPropertyError.any_instance.
+        stub(:message) { error_message }
+      @twig.should_receive(:abort).with(error_message)
+
+      @twig.get_branch_property_for_cli(@branch_name, @property_name)
+    end
+
+    it 'handles ArgumentError when getting an invalid branch property name' do
+      bad_property_name = ''
+      error_message     = 'test error'
+      @twig.should_receive(:get_branch_property).
+        with(@branch_name, bad_property_name) do
+          raise ArgumentError, error_message
+        end
+      @twig.should_receive(:abort).with(error_message)
+
+      @twig.get_branch_property_for_cli(@branch_name, bad_property_name)
+    end
+  end
+
+  describe '#set_branch_property_for_cli' do
+    before :each do
+      @twig          = Twig.new
+      @branch_name   = 'test'
+      @property_name = 'foo'
+    end
+
+    it 'sets a property for the specified branch' do
+      success_message = 'test success'
+      property_value  = 'bar'
+      @twig.should_receive(:set_branch_property).
+        with(@branch_name, @property_name, property_value).
+        and_return(success_message)
+      @twig.should_receive(:puts).with(success_message)
+
+      @twig.set_branch_property_for_cli(@branch_name, @property_name, property_value)
+    end
+
+    it 'handles ArgumentError when unsetting an invalid branch property name' do
+      error_message  = 'test error'
+      property_value = ''
+      @twig.should_receive(:set_branch_property).
+        with(@branch_name, @property_name, property_value) do
+          raise ArgumentError, error_message
+        end
+      @twig.should_receive(:abort).with(error_message)
+
+      @twig.set_branch_property_for_cli(@branch_name, @property_name, property_value)
+    end
+
+    it 'handles RuntimeError when Git is unable to set a branch property' do
+      error_message  = 'test error'
+      property_value = ''
+      @twig.should_receive(:set_branch_property).
+        with(@branch_name, @property_name, property_value) do
+          raise RuntimeError, error_message
+        end
+      @twig.should_receive(:abort).with(error_message)
+
+      @twig.set_branch_property_for_cli(@branch_name, @property_name, property_value)
+    end
+  end
+
+  describe '#unset_branch_property_for_cli' do
+    before :each do
+      @twig          = Twig.new
+      @branch_name   = 'test'
+      @property_name = 'foo'
+    end
+
+    it 'unsets a property for the specified branch' do
+      success_message = 'test success'
+      @twig.should_receive(:unset_branch_property).
+        with(@branch_name, @property_name).and_return(success_message)
+      @twig.should_receive(:puts).with(success_message)
+
+      @twig.unset_branch_property_for_cli(@branch_name, @property_name)
+    end
+
+    it 'handles ArgumentError when unsetting an invalid branch property name' do
+      error_message = 'test error'
+      @twig.should_receive(:unset_branch_property).
+        with(@branch_name, @property_name) do
+          raise ArgumentError, error_message
+        end
+      @twig.should_receive(:abort).with(error_message)
+
+      @twig.unset_branch_property_for_cli(@branch_name, @property_name)
+    end
+
+    it 'handles MissingPropertyError when unsetting a branch property that is not set' do
+      error_message = 'test error'
+      @twig.should_receive(:unset_branch_property).
+        with(@branch_name, @property_name) do
+          raise Twig::Branch::MissingPropertyError, error_message
+        end
+      @twig.should_receive(:abort).with(error_message)
+
+      @twig.unset_branch_property_for_cli(@branch_name, @property_name)
     end
   end