twig 1.2.1 → 1.3

data/lib/twig/github.rb

@@ -1,12 +1,11 @@
 class Twig
   class GithubRepo
-    def self.run(command)
-      # Duplicated from `Twig.run` for making lightweight subcommands.
-      `#{command}`.strip
-    end
-
     def initialize
-      if origin_url.empty? || username.empty? || repository.empty?
+      unless Twig.repo?
+        abort 'Current directory is not a git repository.'
+      end
+
+      if origin_url.empty? || !github_repo? || username.empty? || repository.empty?
         abort_for_non_github_repo
       end
 
@@ -14,13 +13,17 @@ class Twig
     end
 
     def origin_url
-      @origin_url ||= Twig::GithubRepo.run('git config remote.origin.url')
+      @origin_url ||= Twig.run('git config remote.origin.url')
     end
 
     def origin_url_parts
       @origin_url_parts ||= origin_url.split(/[\/:]/)
     end
 
+    def github_repo?
+      origin_url.include?('github.com')
+    end
+
     def username
       @username ||= origin_url_parts[-2] || ''
     end

data/lib/twig/options.rb

@@ -2,29 +2,48 @@ class Twig
   module Options
 
     CONFIG_FILE = '~/.twigrc'
+    MIN_PROPERTY_WIDTH = 3
 
     def read_config_file!
       config_file_path = File.expand_path(Twig::CONFIG_FILE)
       return unless File.readable?(config_file_path)
 
       File.open(config_file_path) do |f|
-        opts = f.read.split("\n").inject({}) do |hsh, opt|
-          key, value = opt.split(':', 2)
-          hsh[key.strip] = value.strip if key && value
+        opts = f.read.split("\n").inject({}) do |hsh, line|
+          line = line.strip
+
+          if line !~ /^#/
+            key, value = line.split(':', 2)
+            hsh[key.strip] = value.strip if key && value
+          end
+
           hsh
         end
 
         opts.each do |key, value|
           case key
-          when 'branch'        then set_option(:branch,        value)
-          when 'header-style'  then set_option(:header_style,  value)
-          when 'max-days-old'  then set_option(:max_days_old,  value)
+
+          # Filtering branches:
+          when 'branch'
+            set_option(:branch, value)
+          when 'max-days-old'
+            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)
+
+          # Displaying branches:
+          when 'header-style'
+            set_option(:header_style, value)
+          when 'reverse'
+            set_option(:reverse, value)
+          when /-width$/
+            property_name = key.sub(/-width$/, '').to_sym
+            set_option(:property_width, property_name => value)
+
           end
         end
       end
@@ -33,7 +52,7 @@ class Twig
     def set_option(key, value)
       case key
       when :branch
-        if branch_names.include?(value)
+        if all_branch_names.include?(value)
           options[:branch] = value
         else
           abort %{The branch "#{value}" could not be found.}
@@ -63,6 +82,12 @@ class Twig
         options[:property_only] ||= {}
         options[:property_only].merge!(property_hash)
 
+      when :property_width
+        set_property_width_option(value)
+
+      when :reverse
+        options[:reverse] = Twig::Util.truthy?(value)
+
       when :unset_property
         options[:unset_property] = value
       end
@@ -89,6 +114,33 @@ class Twig
       options[:header_weight] = weight if weight
     end
 
+    def set_property_width_option(value)
+      value.each do |property_name, property_value|
+        unless Twig::Util.numeric?(property_value)
+          abort %{The value `--#{property_name}-width=#{property_value}` is invalid.}
+        end
+
+        property_name_width = property_name.to_s.size
+        property_value = property_value.to_i
+
+        if property_value < [property_name_width, MIN_PROPERTY_WIDTH].max
+          error = %{The value `--#{property_name}-width=#{property_value}` } +
+            %{is too low. The minimum is }
+
+          if property_value < property_name_width
+            error << %{#{property_name_width} (width of "#{property_name}").}
+          elsif property_value < MIN_PROPERTY_WIDTH
+            error << %{#{MIN_PROPERTY_WIDTH}.}
+          end
+
+          abort error
+        end
+
+        options[:property_width] ||= {}
+        options[:property_width].merge!(property_name => property_value)
+      end
+    end
+
     def unset_option(key)
       options.delete(key)
     end

data/lib/twig/util.rb

@@ -5,5 +5,9 @@ class Twig
       !!Float(value) rescue false
     end
 
+    def self.truthy?(value)
+      %w[true yes y on 1].include?(value.to_s.downcase)
+    end
+
   end
 end

data/lib/twig/version.rb

@@ -1,3 +1,3 @@
 class Twig
-  VERSION = '1.2.1'
+  VERSION = '1.3'
 end

data/spec/twig/cli_spec.rb

@@ -39,6 +39,25 @@ describe Twig::Cli do
     end
   end
 
+  describe '#help_description_for_custom_property' do
+    before :each do
+      @twig = Twig.new
+    end
+
+    it 'returns a help string for a custom property' do
+      option_parser = OptionParser.new
+      @twig.should_receive(:help_separator) do |opt_parser, desc, options|
+        opt_parser.should == option_parser
+        desc.should == "      --test-option                Test option description\n"
+        options.should == { :trailing => "\n" }
+      end
+
+      @twig.help_description_for_custom_property(option_parser, [
+        ['--test-option', 'Test option description']
+      ])
+    end
+  end
+
   describe '#help_paragraph' do
     before :each do
       @twig = Twig.new
@@ -59,13 +78,79 @@ describe Twig::Cli do
     end
   end
 
+  describe '#help_line_for_custom_property?' do
+    before :each do
+      @twig = Twig.new
+    end
+
+    it 'returns true for `--except-foo`' do
+      @twig.help_line_for_custom_property?('  --except-foo  ').should be_true
+    end
+
+    it 'returns false for `--except-branch`' do
+      @twig.help_line_for_custom_property?('  --except-branch  ').should be_false
+    end
+
+    it 'returns false for `--except-PROPERTY`' do
+      @twig.help_line_for_custom_property?('  --except-PROPERTY  ').should be_false
+    end
+
+    it 'returns true for `--only-foo`' do
+      @twig.help_line_for_custom_property?('  --only-foo  ').should be_true
+    end
+
+    it 'returns false for `--only-branch`' do
+      @twig.help_line_for_custom_property?('  --only-branch  ').should be_false
+    end
+
+    it 'returns false for `--only-PROPERTY`' do
+      @twig.help_line_for_custom_property?('  --only-PROPERTY  ').should be_false
+    end
+
+    it 'returns true for `--foo-width`' do
+      @twig.help_line_for_custom_property?('  --foo-width  ').should be_true
+    end
+
+    it 'returns false for `--branch-width`' do
+      @twig.help_line_for_custom_property?('  --branch-width  ').should be_false
+    end
+
+    it 'returns false for `--PROPERTY-width`' do
+      @twig.help_line_for_custom_property?('  --PROPERTY-width  ').should be_false
+    end
+  end
+
   describe '#read_cli_options!' do
     before :each do
       @twig = Twig.new
     end
 
+    it 'recognizes `--unset` and sets an `:unset_property` option' do
+      @twig.options[:unset_property].should be_nil # Precondition
+      @twig.read_cli_options!(%w[--unset test])
+      @twig.options[:unset_property].should == 'test'
+    end
+
+    it 'recognizes `--help` and prints the help content' do
+      help_lines = []
+      @twig.stub(:puts) { |message| help_lines << message.strip }
+      @twig.should_receive(:exit)
+
+      @twig.read_cli_options!(['--help'])
+
+      help_lines.should include("Twig v#{Twig::VERSION}")
+      help_lines.should include('http://rondevera.github.io/twig/')
+    end
+
+    it 'recognizes `--version` and prints the current version' do
+      @twig.should_receive(:puts).with(Twig::VERSION)
+      @twig.should_receive(:exit)
+
+      @twig.read_cli_options!(['--version'])
+    end
+
     it 'recognizes `-b` and sets a `:branch` option' do
-      @twig.should_receive(:branch_names).and_return(['test'])
+      @twig.should_receive(:all_branch_names).and_return(['test'])
       @twig.options[:branch].should be_nil # Precondition
 
       @twig.read_cli_options!(%w[-b test])
@@ -74,7 +159,7 @@ describe Twig::Cli do
     end
 
     it 'recognizes `--branch` and sets a `:branch` option' do
-      @twig.should_receive(:branch_names).and_return(['test'])
+      @twig.should_receive(:all_branch_names).and_return(['test'])
       @twig.options[:branch].should be_nil # Precondition
 
       @twig.read_cli_options!(%w[--branch test])
@@ -190,17 +275,19 @@ describe Twig::Cli do
       @twig.options[:property_only].should be_nil
     end
 
-    it 'recognizes `--unset` and sets an `:unset_property` option' do
-      @twig.options[:unset_property].should be_nil # Precondition
-      @twig.read_cli_options!(%w[--unset test])
-      @twig.options[:unset_property].should == 'test'
+    it 'recognizes `--branch-width`' do
+      @twig.options[:property_width].should be_nil
+      @twig.should_receive(:set_option).with(:property_width, :branch => '10')
+
+      @twig.read_cli_options!(%w[--branch-width 10])
     end
 
-    it 'recognizes `--version` and prints the current version' do
-      @twig.should_receive(:puts).with(Twig::VERSION)
-      @twig.should_receive(:exit)
+    it 'recognizes `--<property>-width`' do
+      Twig::Branch.stub(:all_properties) { %w[foo] }
+      @twig.options[:property_width].should be_nil
+      @twig.should_receive(:set_option).with(:property_width, :foo => '10')
 
-      @twig.read_cli_options!(['--version'])
+      @twig.read_cli_options!(%w[--foo-width 10])
     end
 
     it 'recognizes `--header-style`' do
@@ -211,6 +298,12 @@ describe Twig::Cli do
       @twig.options[:header_weight].should == :bold
     end
 
+    it 'recognizes `--reverse`' do
+      @twig.options[:reverse].should be_nil
+      @twig.read_cli_options!(['--reverse'])
+      @twig.options[:reverse].should be_true
+    end
+
     it 'handles invalid options' do
       @twig.should_receive(:abort_for_option_exception) do |exception|
         exception.should be_a(OptionParser::InvalidOption)
@@ -311,7 +404,7 @@ describe Twig::Cli do
       end
 
       it 'gets a property for a specified branch' do
-        @twig.should_receive(:branch_names).and_return([@branch_name])
+        @twig.should_receive(:all_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)
@@ -337,7 +430,7 @@ describe Twig::Cli do
       end
 
       it 'sets a property for a specified branch' do
-        @twig.should_receive(:branch_names).and_return([@branch_name])
+        @twig.should_receive(:all_branch_names).and_return([@branch_name])
         @twig.set_option(:branch, @branch_name)
         @twig.should_receive(:set_branch_property_for_cli).
           with(@branch_name, @property_name, @property_value).
@@ -364,7 +457,7 @@ describe Twig::Cli do
       end
 
       it 'unsets a property for a specified branch' do
-        @twig.should_receive(:branch_names).and_return([@branch_name])
+        @twig.should_receive(:all_branch_names).and_return([@branch_name])
         @twig.set_option(:branch, @branch_name)
         @twig.should_receive(:unset_branch_property_for_cli).
           with(@branch_name, @property_name)

data/spec/twig/display_spec.rb

@@ -7,23 +7,15 @@ describe Twig::Display do
 
   describe '#column' do
     it 'returns a string with an exact fixed width' do
-      @twig.column('foo', 1, :width => 8).should == 'foo' + (' ' * 5)
+      @twig.column('foo', :width => 8).should == 'foo' + (' ' * 5)
     end
 
     it 'returns a string that fits a column exactly' do
-      @twig.column('asdfasdf', 1, :width => 8).should == 'asdf... '
+      @twig.column('asdfasdf', :width => 8).should == 'asdfasdf'
     end
 
     it 'truncates a wide string with an ellipsis' do
-      @twig.column('asdfasdfasdf', 1, :width => 8).should == 'asdf... '
-    end
-
-    it 'returns a string that spans multiple columns' do
-      @twig.column('foo', 2, :width => 8).should == 'foo' + (' ' * 13)
-    end
-
-    it 'returns a string that spans multiple columns and is truncated' do
-      @twig.column('asdf' * 5, 2, :width => 8).should == 'asdfasdfasdf... '
+      @twig.column('asdfasdfasdf', :width => 8).should == 'asdfa...'
     end
 
     it 'passes options through to `format_string`' do
@@ -31,7 +23,52 @@ describe Twig::Display do
       @twig.should_receive(:format_string).
         with('foo' + (' ' * 5), format_options)
 
-      @twig.column('foo', 1, format_options)
+      @twig.column('foo', format_options)
+    end
+  end
+
+  describe '#property_column_width' do
+    it 'returns a default width if no property name is given' do
+      @twig.property_column_width.should ==
+        Twig::Display::DEFAULT_PROPERTY_COLUMN_WIDTH
+    end
+
+    context 'with no custom column widths set' do
+      before :each do
+        @twig.options[:property_width].should be_nil
+      end
+
+      it 'returns a default width if a property name is given' do
+        @twig.property_column_width(:foo).should ==
+          Twig::Display::DEFAULT_PROPERTY_COLUMN_WIDTH
+      end
+
+      it 'returns a default width if :branch is given' do
+        @twig.property_column_width(:branch).should ==
+          Twig::Display::DEFAULT_BRANCH_COLUMN_WIDTH
+      end
+    end
+
+    context 'with custom column widths set' do
+      it 'returns a default width if a property name is given but it has no custom width' do
+        @twig.property_column_width(:baz).should ==
+          Twig::Display::DEFAULT_PROPERTY_COLUMN_WIDTH
+      end
+
+      it 'returns a custom width if a property name is given and it has a custom width' do
+        @twig.set_option(:property_width, :foo => 20)
+        @twig.property_column_width(:foo).should == 20
+      end
+
+      it 'returns a default width if :branch is given but it has no custom width' do
+        @twig.property_column_width(:branch).should ==
+          Twig::Display::DEFAULT_BRANCH_COLUMN_WIDTH
+      end
+
+      it 'returns a custom width if :branch is given but it has no custom width' do
+        @twig.set_option(:property_width, :branch => 20)
+        @twig.property_column_width(:branch).should == 20
+      end
     end
   end
 
@@ -44,17 +81,36 @@ describe Twig::Display do
       result = @twig.branch_list_headers({})
       result_lines = result.split("\n")
 
-      column_width = 8
-      columns_for_date_time = 5
-      first_column_width = column_width * columns_for_date_time
-      result_lines[0].should == (' ' * first_column_width) +
-        'foo     ' + (' ' * column_width) +
-        'quux    ' + (' ' * column_width) +
-        '  branch' + (' ' * column_width)
-      result_lines[1].should == (' ' * first_column_width) +
-        '---     ' + (' ' * column_width) +
-        '----    ' + (' ' * column_width) +
-        '  ------' + (' ' * column_width)
+      date_time_column_width      = 35
+      extra_property_column_width = 8
+      column_gutter = @twig.column_gutter
+      result_lines[0].should == (' ' * date_time_column_width) + column_gutter +
+        'foo     ' + (' ' * extra_property_column_width) + column_gutter +
+        'quux    ' + (' ' * extra_property_column_width) + column_gutter +
+        '  branch'
+      result_lines[1].should == (' ' * date_time_column_width) + column_gutter +
+        '---     ' + (' ' * extra_property_column_width) + column_gutter +
+        '----    ' + (' ' * extra_property_column_width) + column_gutter +
+        '  ------'
+    end
+
+    it 'sets a header width' do
+      @twig.set_option(:property_width, :foo => 4)
+
+      result = @twig.branch_list_headers({})
+      result_lines = result.split("\n")
+
+      date_time_column_width      = 35
+      extra_property_column_width = 8
+      column_gutter = @twig.column_gutter
+      result_lines[0].should == (' ' * date_time_column_width) + column_gutter +
+        'foo '     + column_gutter +
+        'quux    ' + (' ' * extra_property_column_width) + column_gutter +
+        '  branch'
+      result_lines[1].should == (' ' * date_time_column_width) + column_gutter +
+        '--- '     + column_gutter +
+        '----    ' + (' ' * extra_property_column_width) + column_gutter +
+        '  ------'
     end
 
     it 'sets a header color' do
@@ -146,6 +202,58 @@ describe Twig::Display do
 
       result.should include('line breaks')
     end
+
+    it 'returns a line with custom column widths' do
+      branch = Twig::Branch.new('other-branch')
+      branch.should_receive(:last_commit_time).and_return(@commit_time)
+      @twig.set_option(:property_width, :foo => 5)
+
+      result = @twig.branch_list_line(branch)
+
+      column_gutter = @twig.column_gutter
+      result.should ==
+        '2000-01-01' + (' ' * 25) + column_gutter +
+        'foo! ' + column_gutter +
+        'bar!' + (' ' * 12) + column_gutter +
+        '  ' + branch.name
+    end
+
+    context 'with a custom width for the branch column' do
+      before :each do
+        @twig.set_option(:property_width, :branch => 8)
+      end
+
+      it 'returns a line for the current branch' do
+        indicator     = Twig::Display::CURRENT_BRANCH_INDICATOR
+        branch        = Twig::Branch.new('my-branch')
+        branch_regexp = /#{Regexp.escape(indicator)}#{Regexp.escape(branch.name)}/
+        branch.should_receive(:last_commit_time).and_return(@commit_time)
+
+        result = @twig.branch_list_line(branch)
+        unformatted_result = @twig.unformat_string(result)
+
+        column_gutter = @twig.column_gutter
+        unformatted_result.should ==
+          '2000-01-01' + (' ' * 25) + column_gutter +
+          'foo!' + (' ' * 12) + column_gutter +
+          'bar!' + (' ' * 12) + column_gutter +
+          indicator + 'my-br...'
+      end
+
+      it 'returns a line for a branch other than the current branch' do
+        branch = Twig::Branch.new('other-branch')
+        branch.should_receive(:last_commit_time).and_return(@commit_time)
+
+        result = @twig.branch_list_line(branch)
+
+        column_gutter = @twig.column_gutter
+        result.should ==
+          '2000-01-01' + (' ' * 25) + column_gutter +
+          'foo!' + (' ' * 12) + column_gutter +
+          'bar!' + (' ' * 12) + column_gutter +
+          '  ' + 'other...'
+      end
+    end
   end
 
   describe '#format_string' do