twig 1.0.1 → 1.1

data/lib/twig/display.rb

@@ -46,11 +46,22 @@ class Twig
       new_string
     end
 
-    def branch_list_headers(header_options = { :color => :blue })
+    def branch_list_headers(header_options = {})
       columns_for_date_time    = 5
       columns_per_property     = 2
       branch_indicator_padding = ' ' * CURRENT_BRANCH_INDICATOR.size
 
+      header_options.merge!(
+        header_options.inject({}) do |opts, (key, value)|
+          if key == :header_color
+            opts[:color] = value
+          elsif key == :header_weight
+            opts[:weight] = value
+          end
+          opts
+        end
+      )
+
       out =
         column(' ', columns_for_date_time) <<
         Twig::Branch.all_properties.map do |property|
@@ -75,7 +86,7 @@ class Twig
       is_current_branch = branch.name == current_branch_name
 
       properties = Twig::Branch.all_properties.inject({}) do |result, property_name|
-        property = get_branch_property(branch.name, property_name).strip
+        property = (get_branch_property(branch.name, property_name) || '').strip
         property = column(EMPTY_BRANCH_PROPERTY_INDICATOR) if property.empty?
         property.gsub!(/[\n\r]+/, ' ')
         result.merge(property_name => property)
@@ -111,7 +122,11 @@ class Twig
       string_options << WEIGHTS[options[:weight]] if options[:weight]
       return string if string_options.empty?
 
-      "\033[#{string_options.join(';')}m#{string}\033[0m"
+      "\e[#{string_options.join(';')}m#{string}\e[0m"
+    end
+
+    def formatted_string_display_size(string)
+      string.gsub(/\e\[[0-9]+(;[0-9]+)?m/, '').size
     end
   end # module Display
 end

data/lib/twig/options.rb

@@ -10,7 +10,8 @@ class Twig
       File.open(config_file_path) do |f|
         opts = f.read.split("\n").inject({}) do |hsh, opt|
           key, value = opt.split(':', 2)
-          hsh.merge(key.strip => value.strip)
+          hsh[key.strip] = value.strip if key && value
+          hsh
         end
 
         opts.each do |key, value|
@@ -19,6 +20,7 @@ class Twig
           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)
           end
         end
       end
@@ -36,6 +38,8 @@ class Twig
         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
@@ -47,6 +51,27 @@ class Twig
       end
     end
 
+    def set_header_style_option(value)
+      style_values = value.split(/\s+/).map(&:to_sym)
+      colors  = Twig::Display::COLORS.keys
+      weights = Twig::Display::WEIGHTS.keys
+      color   = nil
+      weight  = nil
+
+      style_values.each do |style_value|
+        if !color && colors.include?(style_value)
+          color = style_value
+        elsif !weight && weights.include?(style_value)
+          weight = style_value
+        else
+          abort %{The value `--header-style=#{value}` is invalid.}
+        end
+      end
+
+      options[:header_color]  = color  if color
+      options[:header_weight] = weight if weight
+    end
+
     def unset_option(key)
       options.delete(key)
     end

data/lib/twig/version.rb

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

data/spec/twig/branch_spec.rb

@@ -101,17 +101,55 @@ describe Twig::Branch do
   end
 
   describe '#get_property' do
+    before :each do
+      @branch = Twig::Branch.new('test')
+    end
+
     it 'returns a property value' do
-      branch   = Twig::Branch.new('test')
       property = 'test'
       value    = 'value'
       Twig.should_receive(:run).
-        with(%{git config branch.#{branch}.#{property}}).
+        with(%{git config branch.#{@branch}.#{property}}).
         and_return(value)
 
-      result = branch.get_property(property)
+      result = @branch.get_property(property)
       result.should == value
     end
+
+    it 'removes whitespace from branch property names' do
+      bad_property = '  foo foo  '
+      property     = 'foofoo'
+      value        = 'bar'
+      Twig.should_receive(:run).
+        with(%{git config branch.#{@branch}.#{property}}).
+        and_return(value)
+
+      result = @branch.get_property(bad_property)
+      result.should == value
+    end
+
+    it 'returns nil if the property value is an empty string' do
+      property = 'test'
+      Twig.should_receive(:run).
+        with(%{git config branch.#{@branch}.#{property}}).
+        and_return('')
+
+      result = @branch.get_property(property)
+      result.should == nil
+    end
+
+    it 'raises an error if the property name is an empty string' do
+      property = ' '
+      Twig.should_not_receive(:run)
+
+      begin
+        @branch.get_property(property)
+      rescue Twig::Branch::EmptyPropertyNameError => exception
+        expected_exception = exception
+      end
+
+      expected_exception.message.should == Twig::Branch::EMPTY_PROPERTY_NAME_ERROR
+    end
   end
 
   describe '#set_property' do
@@ -133,33 +171,66 @@ describe Twig::Branch do
       )
     end
 
-    it 'does nothing if Git cannot set the property value' do
+    it 'raises an error if Git cannot set the property value' do
       property = 'test'
       value    = 'value'
       Twig.stub(:run) { `(exit 1)`; value } # Set `$?` to `1`
 
-      result = @branch.set_property(property, value)
-      result.should include(
+      begin
+        @branch.set_property(property, value)
+      rescue RuntimeError => exception
+        expected_exception = exception
+      end
+
+      expected_exception.message.should include(
         %{Could not save property "#{property}" as "#{value}" for branch "#{@branch}"}
       )
     end
 
-    it 'returns an error if trying to set a reserved branch property' do
+    it 'raises an error if the property name is an empty string' do
+      property = ' '
+      value    = 'value'
+      Twig.should_not_receive(:run)
+
+      begin
+        @branch.set_property(property, value)
+      rescue Twig::Branch::EmptyPropertyNameError => exception
+        expected_exception = exception
+      end
+
+      expected_exception.message.should == Twig::Branch::EMPTY_PROPERTY_NAME_ERROR
+    end
+
+    it 'raises an error if trying to set a reserved branch property' do
       property = 'merge'
       value    = 'NOOO'
       Twig.should_not_receive(:run)
 
-      result = @branch.set_property(property, value)
-      result.should include(%{Can't modify the reserved property "#{property}"})
+      begin
+        @branch.set_property(property, value)
+      rescue ArgumentError => exception
+        expected_exception = exception
+      end
+
+      expected_exception.message.should include(
+        %{Can't modify the reserved property "#{property}"}
+      )
     end
 
-    it 'returns an error if trying to set a branch property to an empty string' do
+    it 'raises an error if trying to set a branch property to an empty string' do
       property = 'test'
       value    = ''
       Twig.should_not_receive(:run)
 
-      result = @branch.set_property(property, value)
-      result.should include(%{Can't set a branch property to an empty string})
+      begin
+        @branch.set_property(property, value)
+      rescue ArgumentError => exception
+        expected_exception = exception
+      end
+
+      expected_exception.message.should include(
+        %{Can't set a branch property to an empty string}
+      )
     end
 
     it 'removes whitespace from branch property names' do
@@ -225,12 +296,45 @@ describe Twig::Branch do
       )
     end
 
-    it 'returns an error if the branch does not have the given property' do
-      property = 'test'
-      @branch.should_receive(:get_property).with(property).and_return('')
+    it 'removes whitespace from branch property names' do
+      bad_property = '  foo foo  '
+      property     = 'foofoo'
+      @branch.should_receive(:get_property).with(property).and_return('value')
+      Twig.should_receive(:run).
+        with(%{git config --unset branch.#{@branch}.#{property}})
 
-      result = @branch.unset_property(property)
+      result = @branch.unset_property(bad_property)
       result.should include(
+        %{Removed property "#{property}" for branch "#{@branch}"}
+      )
+    end
+
+    it 'raises an error if the property name is an empty string' do
+      bad_property = ' '
+      property     = ''
+      @branch.should_not_receive(:get_property)
+      Twig.should_not_receive(:run)
+
+      begin
+        @branch.unset_property(bad_property)
+      rescue Twig::Branch::EmptyPropertyNameError => exception
+        expected_exception = exception
+      end
+
+      expected_exception.message.should == Twig::Branch::EMPTY_PROPERTY_NAME_ERROR
+    end
+
+    it 'raises an error if the branch does not have the given property' do
+      property = 'test'
+      @branch.should_receive(:get_property).with(property).and_return(nil)
+
+      begin
+        @branch.unset_property(property)
+      rescue Twig::Branch::MissingPropertyError => exception
+        expected_exception = exception
+      end
+
+      expected_exception.message.should include(
         %{The branch "#{@branch}" does not have the property "#{property}"}
       )
     end

data/spec/twig/cli_spec.rb

@@ -39,6 +39,26 @@ describe Twig::Cli do
     end
   end
 
+  describe '#help_paragraph' do
+    before :each do
+      @twig = Twig.new
+    end
+
+    it 'returns long text in a paragraph with line breaks' do
+      text = Array.new(5) {
+        'The quick brown fox jumps over the lazy dog.'
+      }.join(' ')
+
+      result = @twig.help_paragraph(text)
+
+      result.should == [
+        "The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the",
+        "lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps",
+        "over the lazy dog. The quick brown fox jumps over the lazy dog."
+      ].join("\n")
+    end
+  end
+
   describe '#read_cli_options!' do
     before :each do
       @twig = Twig.new
@@ -105,6 +125,14 @@ describe Twig::Cli do
       @twig.read_cli_options!(['--version'])
     end
 
+    it 'recognizes `--header-style`' do
+      @twig.options[:header_color].should == Twig::DEFAULT_HEADER_COLOR
+      @twig.options[:header_weight].should be_nil
+      @twig.read_cli_options!(['--header-style', 'green bold'])
+      @twig.options[:header_color].should == :green
+      @twig.options[:header_weight].should == :bold
+    end
+
     it 'handles invalid options' do
       @twig.should_receive(:puts) do |message|
         message.should include('invalid option: --foo')
@@ -201,7 +229,7 @@ describe Twig::Cli do
 
         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('')
+            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}"}
@@ -210,6 +238,18 @@ describe Twig::Cli do
 
           @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)
+
+          @twig.read_cli_args!([property_name])
+        end
       end
 
       context 'with a specified branch' do
@@ -228,7 +268,7 @@ describe Twig::Cli do
 
         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('')
+            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}"}
@@ -269,6 +309,30 @@ describe Twig::Cli do
 
         @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
@@ -297,6 +361,30 @@ describe Twig::Cli do
 
         @twig.read_cli_args!([])
       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)
+
+        @twig.read_cli_args!([])
+      end
+
+      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.read_cli_args!([])
+      end
     end
   end
 

data/spec/twig/display_spec.rb

@@ -36,9 +36,11 @@ describe Twig::Display do
   end
 
   describe '#branch_list_headers' do
-    it 'returns a string of branch properties and underlines' do
+    before :each do
       Twig::Branch.stub(:all_properties => %w[foo quux])
+    end
 
+    it 'returns a string of branch properties and underlines' do
       result = @twig.branch_list_headers({})
       result_lines = result.split("\n")
 
@@ -54,6 +56,36 @@ describe Twig::Display do
         '----    ' + (' ' * column_width) +
         '  ------' + (' ' * column_width)
     end
+
+    it 'sets a header color' do
+      result = @twig.branch_list_headers({ :header_color => :green })
+      header_line = result.split("\n").first
+      color = Twig::Display::COLORS[:green]
+      header_line.gsub(/\s/, '').should ==
+        "\e[#{color}mfoo\e[0m" <<
+        "\e[#{color}mquux\e[0m" <<
+        "\e[#{color}mbranch\e[0m"
+    end
+
+    it 'sets a header weight' do
+      result = @twig.branch_list_headers({ :header_weight => :bold })
+      header_line = result.split("\n").first
+      weight = Twig::Display::WEIGHTS[:bold]
+      header_line.gsub(/\s/, '').should ==
+        "\e[#{weight}mfoo\e[0m" <<
+        "\e[#{weight}mquux\e[0m" <<
+        "\e[#{weight}mbranch\e[0m"
+    end
+
+    it 'sets a header color and weight' do
+      result = @twig.branch_list_headers({ :header_color => :red, :header_weight => :bold })
+      header_line = result.split("\n").first
+      color, weight = Twig::Display::COLORS[:red], Twig::Display::WEIGHTS[:bold]
+      header_line.gsub(/\s/, '').should ==
+        "\e[#{color};#{weight}mfoo\e[0m" <<
+        "\e[#{color};#{weight}mquux\e[0m" <<
+        "\e[#{color};#{weight}mbranch\e[0m"
+    end
   end
 
   describe '#branch_list_line' do
@@ -90,6 +122,19 @@ describe Twig::Display do
       result.should =~ /2000-01-01\s+foo!\s+bar!\s+#{Regexp.escape(branch.name)}/
     end
 
+    it 'returns a line containing an empty branch property' do
+      Twig::Branch.stub(:all_properties => %w[foo bar baz])
+      @twig.should_receive(:get_branch_property).
+        with(anything, 'baz').and_return(nil)
+      branch = Twig::Branch.new('other-branch')
+      branch.should_receive(:last_commit_time).and_return(@commit_time)
+
+      result = @twig.branch_list_line(branch)
+
+      empty_indicator = Twig::Display::EMPTY_BRANCH_PROPERTY_INDICATOR
+      result.should =~ /2000-01-01\s+foo!\s+bar!\s+#{empty_indicator}\s+#{Regexp.escape(branch.name)}/
+    end
+
     it 'changes line break characters to spaces' do
       branch = Twig::Branch.new('my-branch')
       branch.should_receive(:last_commit_time).and_return(@commit_time)
@@ -110,12 +155,12 @@ describe Twig::Display do
 
     it 'returns a string with a color code' do
       @twig.format_string('foo', :color => :red).
-        should == "\033[#{Twig::Display::COLORS[:red]}mfoo\033[0m"
+        should == "\e[#{Twig::Display::COLORS[:red]}mfoo\e[0m"
     end
 
     it 'returns a string with a weight code' do
       @twig.format_string('foo', :weight => :bold).
-        should == "\033[#{Twig::Display::WEIGHTS[:bold]}mfoo\033[0m"
+        should == "\e[#{Twig::Display::WEIGHTS[:bold]}mfoo\e[0m"
     end
 
     it 'returns a string with a color and weight code 'do
@@ -123,7 +168,34 @@ describe Twig::Display do
     weight_code = Twig::Display::WEIGHTS[:bold]
 
     @twig.format_string('foo', :color => :red, :weight => :bold).
-      should == "\033[#{color_code};#{weight_code}mfoo\033[0m"
+      should == "\e[#{color_code};#{weight_code}mfoo\e[0m"
+    end
+  end
+
+  describe '#formatted_string_display_size' do
+    it 'returns the width of a plain text string' do
+      @twig.formatted_string_display_size('foo').should == 3
+    end
+
+    it 'returns the width of a string with color' do
+      string = @twig.format_string('foo', :color => :red)
+      string.size.should > 3 # Precondition
+
+      @twig.formatted_string_display_size(string).should == 3
+    end
+
+    it 'returns the width of a string with weight' do
+      string = @twig.format_string('foo', :weight => :bold)
+      string.size.should > 3 # Precondition
+
+      @twig.formatted_string_display_size(string).should == 3
+    end
+
+    it 'returns the width of a string with color and weight' do
+      string = @twig.format_string('foo', :color => :red, :weight => :bold)
+      string.size.should > 3 # Precondition
+
+      @twig.formatted_string_display_size(string).should == 3
     end
   end
 end