twig 1.5 → 1.6

data/lib/twig/commit_time.rb

@@ -8,7 +8,7 @@ class Twig
 
       # Shorten relative time
       @time_ago = time_ago.
-        sub(' years',   'y').
+        sub(/ years?/,  'y').
         sub(' months',  'mo').
         sub(' weeks',   'w').
         sub(' days',    'd').

data/lib/twig/display.rb

@@ -66,7 +66,6 @@ class Twig
     end
 
     def branch_list_headers(header_options = {})
-      all_property_names = Twig::Branch.all_property_names
       branch_indicator_padding = ' ' * CURRENT_BRANCH_INDICATOR.size
 
       header_options.merge!(
@@ -81,7 +80,7 @@ class Twig
       )
 
       out = column(' ', :width => date_time_column_width) << column_gutter
-      out << all_property_names.map do |property|
+      out << property_names.map do |property|
         width = property_column_width(property)
         column(property, header_options.merge(:width => width)) << column_gutter
       end.join
@@ -89,7 +88,7 @@ class Twig
       out << "\n"
 
       out << column(' ', :width => date_time_column_width) << column_gutter
-      out << all_property_names.map do |property|
+      out << property_names.map do |property|
         width = property_column_width(property)
         underline = '-' * property.size
         column(underline, header_options.merge(:width => width)) << column_gutter
@@ -101,11 +100,10 @@ class Twig
     end
 
     def branch_list_line(branch)
-      all_property_names = Twig::Branch.all_property_names
       is_current_branch  = branch.name == current_branch_name
 
-      properties = branch.get_properties(all_property_names)
-      properties = all_property_names.inject({}) do |result, property_name|
+      properties = branch.get_properties(property_names)
+      properties = property_names.inject({}) do |result, property_name|
         property_value = (properties[property_name] || '').strip
         property_value = EMPTY_BRANCH_PROPERTY_INDICATOR if property_value.empty?
         property_value.gsub!(/[\n\r]+/, ' ')
@@ -116,7 +114,7 @@ class Twig
       line << column_gutter
 
       line <<
-        all_property_names.map do |property_name|
+        property_names.map do |property_name|
           property_value = properties[property_name] || ''
           width = property_column_width(property_name)
           column(property_value, :width => width) << column_gutter
@@ -141,7 +139,7 @@ class Twig
       require 'json'
 
       data = {
-        'branches' => branches.map { |branch| branch.to_hash }
+        'branches' => branches.map { |branch| branch.to_hash(property_names) }
       }
       data.to_json
     end

data/lib/twig/options.rb

@@ -66,6 +66,21 @@ class Twig
       options.each do |key, value|
         case key
 
+        # Displaying branches:
+        when 'format'
+          set_option(:format, value)
+        when 'except-property'
+          set_option(:property_except_name, value)
+        when 'only-property'
+          set_option(:property_only_name, value)
+        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)
+
         # Filtering branches:
         when 'branch'
           set_option(:branch, value)
@@ -78,17 +93,6 @@ class Twig
           property_name = key.sub(/^only-/, '').to_sym
           set_option(:property_only, property_name => value)
 
-        # Displaying branches:
-        when 'format'
-          set_option(:format, value)
-        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)
-
         # GitHub integration:
         when 'github-api-uri-prefix'
           set_option(:github_api_uri_prefix, value)
@@ -102,7 +106,7 @@ class Twig
     def set_option(key, value)
       case key
       when :branch
-        if all_branch_names.include?(value)
+        if Twig::Branch.all_branch_names.include?(value)
           options[:branch] = value
         else
           abort %{The branch `#{value}` could not be found.}
@@ -128,19 +132,15 @@ class Twig
           abort %{The value `--max-days-old=#{value}` is invalid.}
         end
 
-      when :property_except
+      when :property_except, :property_only
         property_hash = value.inject({}) do |hsh, (property, val)|
           hsh.merge(property => Regexp.new(val))
         end
-        options[:property_except] ||= {}
-        options[:property_except].merge!(property_hash)
+        options[key] ||= {}
+        options[key].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 :property_except_name, :property_only_name
+        options[key] = Regexp.new(value)
 
       when :property_width
         set_property_width_option(value)
@@ -149,7 +149,7 @@ class Twig
         options[:reverse] = Twig::Util.truthy?(value)
 
       when :unset_property
-        options[:unset_property] = value
+        options[key] = value
       end
     end
 
@@ -175,6 +175,8 @@ class Twig
     end
 
     def set_property_width_option(value)
+      options[:property_width] ||= {}
+
       value.each do |property_name, property_value|
         unless Twig::Util.numeric?(property_value)
           abort %{The value `--#{property_name}-width=#{property_value}` is invalid.}
@@ -197,8 +199,7 @@ class Twig
           abort error
         end
 
-        options[:property_width] ||= {}
-        options[:property_width].merge!(property_name => property_value)
+        options[:property_width][property_name] = property_value
       end
     end
 

data/lib/twig/version.rb

@@ -1,3 +1,3 @@
 class Twig
-  VERSION = '1.5'
+  VERSION = '1.6'
 end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'twig'
 require 'json'
+require 'rspec/radar'
 
 RSpec.configure do |config|
   config.expect_with :rspec do |c|

data/spec/twig/branch_spec.rb

@@ -6,6 +6,73 @@ describe Twig::Branch do
     @twig = Twig.new
   end
 
+  describe '.all_branches' do
+    before :each do
+      @branch_names = %w[
+        fix_some_of_the_things
+        fix_some_other_of_the_things
+        fix_nothing
+      ]
+      @commit_time_strings = ['2001-01-01',   '2002-02-02',   '2003-03-03'           ]
+      @commit_time_agos    = ['111 days ago', '2 months ago', '3 years, 3 months ago']
+      @command =
+        %{git for-each-ref #{Twig::REF_PREFIX} --format="#{Twig::REF_FORMAT}"}
+
+      @branch_tuples = (0..2).map do |i|
+        [
+          @branch_names[i],
+          @commit_time_strings[i],
+          @commit_time_agos[i]
+        ].join(Twig::REF_FORMAT_SEPARATOR)
+      end.join("\n")
+    end
+
+    it 'returns an array of branches' do
+      expect(Twig).to receive(:run).with(@command).and_return(@branch_tuples)
+
+      branches = Twig::Branch.all_branches
+
+      expect(branches[0].name).to eq(@branch_names[0])
+      expect(branches[0].last_commit_time.to_s).to match(
+        %r{#{@commit_time_strings[0]} .* \(111d ago\)}
+      )
+      expect(branches[1].name).to eq(@branch_names[1])
+      expect(branches[1].last_commit_time.to_s).to match(
+        %r{#{@commit_time_strings[1]} .* \(2mo ago\)}
+      )
+      expect(branches[2].name).to eq(@branch_names[2])
+      expect(branches[2].last_commit_time.to_s).to match(
+        %r{#{@commit_time_strings[2]} .* \(3y ago\)}
+      )
+    end
+
+    it 'memoizes the result' do
+      Twig::Branch.instance_variable_set(:@_all_branches, nil)
+      expect(Twig).to receive(:run).with(@command).once.and_return(@branch_tuples)
+
+      2.times { Twig::Branch.all_branches }
+    end
+  end
+
+  describe '.all_branch_names' do
+    before :each do
+      @branch_names = %w[foo bar baz]
+      @branches = @branch_names.map { |name| Twig::Branch.new(name) }
+    end
+
+    it 'returns an array of all branch names' do
+      expect(Twig::Branch).to receive(:all_branches).and_return(@branches)
+      expect(Twig::Branch.all_branch_names).to eq(@branch_names)
+    end
+
+    it 'memoizes the result' do
+      Twig::Branch.instance_variable_set(:@_all_branch_names, nil)
+      expect(Twig::Branch).to receive(:all_branches).once.and_return(@branches)
+
+      2.times { Twig::Branch.all_branch_names }
+    end
+  end
+
   describe '.all_property_names' do
     before :each do
       Twig::Branch.instance_variable_set(:@_all_property_names, nil)
@@ -63,6 +130,20 @@ describe Twig::Branch do
     end
   end
 
+  describe '.validate_property_name' do
+    it 'raises an exception if the property name is empty' do
+      expect {
+        Twig::Branch.validate_property_name('')
+      }.to raise_exception(Twig::Branch::EmptyPropertyNameError)
+    end
+
+    it 'does nothing if the property name is not empty' do
+      expect {
+        Twig::Branch.validate_property_name('test')
+      }.not_to raise_exception
+    end
+  end
+
   describe '#initialize' do
     it 'requires a name' do
       branch = Twig::Branch.new('test')
@@ -97,12 +178,11 @@ describe Twig::Branch do
     end
 
     it 'returns the hash for a branch with properties' do
-      expect(Twig::Branch).to receive(:all_property_names) { %w[foo bar] }
-      expect(@branch).to receive(:get_properties) do
+      expect(@branch).to receive(:get_properties).with(%w[foo bar]) do
         { 'foo' => 'foo!', 'bar' => 'bar!' }
       end
 
-      result = @branch.to_hash
+      result = @branch.to_hash(%w[foo bar])
 
       expect(result).to eq(
         'name' => 'test',
@@ -115,10 +195,9 @@ describe Twig::Branch do
     end
 
     it 'returns the hash for a branch with no properties' do
-      expect(Twig::Branch).to receive(:all_property_names) { %w[foo bar] }
-      expect(@branch).to receive(:get_properties).and_return({})
+      expect(@branch).to receive(:get_properties).with(%w[foo bar]).and_return({})
 
-      result = @branch.to_hash
+      result = @branch.to_hash(%w[foo bar])
 
       expect(result).to eq(
         'name' => 'test',

data/spec/twig/cli_spec.rb

@@ -2,6 +2,44 @@ require 'spec_helper'
 
 describe Twig::Cli do
 
+  describe '.prompt_with_choices' do
+    it 'prints a prompt with the given choices' do
+      stdout_orig = $stdout
+      stdout_test = StringIO.new
+      $stdout     = stdout_test
+      prompt      = 'What does the fox say?'
+      choices     = [
+        'Ring-ding-ding-ding-dingeringeding!',
+        'Wa-pa-pa-pa-pa-pa-pow!',
+        'Hatee-hatee-hatee-ho!',
+        'Joff-tchoff-tchoffo-tchoffo-tchoff!'
+      ]
+      expect($stdin).to receive(:gets).and_return('4')
+
+      result = Twig::Cli.prompt_with_choices(prompt, choices)
+
+      $stdout = stdout_orig
+      expect(stdout_test.string).to eq(
+        prompt + "\n" +
+        "  1. #{choices[0]}\n" +
+        "  2. #{choices[1]}\n" +
+        "  3. #{choices[2]}\n" +
+        "  4. #{choices[3]}\n" +
+        '> '
+      )
+      expect(result).to eq(choices[3])
+    end
+
+    it 'requires at least two choices' do
+      expect {
+        Twig::Cli.prompt_with_choices(
+          'What does the fox say?',
+          ['Ring-ding-ding-ding-dingeringeding!']
+        )
+      }.to raise_exception(ArgumentError)
+    end
+  end
+
   describe '#help_description' do
     before :each do
       @twig = Twig.new
@@ -104,6 +142,10 @@ describe Twig::Cli do
       expect(@twig.help_line_for_custom_property?('  --except-branch  ')).to be_false
     end
 
+    it 'returns false for `--except-property`' do
+      expect(@twig.help_line_for_custom_property?('  --except-property  ')).to be_false
+    end
+
     it 'returns false for `--except-PROPERTY`' do
       expect(@twig.help_line_for_custom_property?('  --except-PROPERTY  ')).to be_false
     end
@@ -116,6 +158,10 @@ describe Twig::Cli do
       expect(@twig.help_line_for_custom_property?('  --only-branch  ')).to be_false
     end
 
+    it 'returns false for `--only-property`' do
+      expect(@twig.help_line_for_custom_property?('  --only-property  ')).to be_false
+    end
+
     it 'returns false for `--only-PROPERTY`' do
       expect(@twig.help_line_for_custom_property?('  --only-PROPERTY  ')).to be_false
     end
@@ -200,7 +246,7 @@ describe Twig::Cli do
     end
 
     it 'recognizes `-b` and sets a `:branch` option' do
-      expect(@twig).to receive(:all_branch_names).and_return(['test'])
+      expect(Twig::Branch).to receive(:all_branch_names).and_return(['test'])
       expect(@twig.options[:branch]).to be_nil
 
       @twig.read_cli_options!(%w[-b test])
@@ -209,7 +255,7 @@ describe Twig::Cli do
     end
 
     it 'recognizes `--branch` and sets a `:branch` option' do
-      expect(@twig).to receive(:all_branch_names).and_return(['test'])
+      expect(Twig::Branch).to receive(:all_branch_names).and_return(['test'])
       expect(@twig.options[:branch]).to be_nil
 
       @twig.read_cli_options!(%w[--branch test])
@@ -262,14 +308,13 @@ describe Twig::Cli do
         expect(Twig::Branch.all_property_names).not_to include(property_name)
         allow(@twig).to receive(:puts)
 
-        begin
+        expect {
           @twig.read_cli_options!(["--only-#{property_name}", 'test'])
-        rescue SystemExit => exception
-          expected_exception = exception
-        end
+        }.to raise_exception { |exception|
+          expect(exception).to be_a(SystemExit)
+          expect(exception.status).to eq(1)
+        }
 
-        expect(expected_exception).not_to be_nil
-        expect(expected_exception.status).to eq(0)
         expect(@twig.options[:property_only]).to be_nil
       end
     end
@@ -301,14 +346,13 @@ describe Twig::Cli do
         expect(Twig::Branch.all_property_names).not_to include(property_name)
         allow(@twig).to receive(:puts)
 
-        begin
+        expect {
           @twig.read_cli_options!(["--except-#{property_name}", 'test'])
-        rescue SystemExit => exception
-          expected_exception = exception
-        end
+        }.to raise_exception { |exception|
+          expect(exception).to be_a(SystemExit)
+          expect(exception.status).to eq(1)
+        }
 
-        expect(expected_exception).not_to be_nil
-        expect(expected_exception.status).to eq(0)
         expect(@twig.options[:property_except]).to be_nil
       end
     end
@@ -346,6 +390,18 @@ describe Twig::Cli do
       @twig.read_cli_options!(%w[--foo-width 10])
     end
 
+    it 'recognizes `--only-property`' do
+      expect(@twig.options[:property_only_name]).to be_nil
+      @twig.read_cli_options!(%w[--only-property foo])
+      expect(@twig.options[:property_only_name]).to eq(/foo/)
+    end
+
+    it 'recognizes `--except-property`' do
+      expect(@twig.options[:property_except_name]).to be_nil
+      @twig.read_cli_options!(%w[--except-property foo])
+      expect(@twig.options[:property_except_name]).to eq(/foo/)
+    end
+
     it 'recognizes `--header-style`' do
       expect(@twig.options[:header_color]).to eq(Twig::DEFAULT_HEADER_COLOR)
       expect(@twig.options[:header_weight]).to be_nil
@@ -402,15 +458,18 @@ describe Twig::Cli do
       @twig = Twig.new
     end
 
-    it 'prints a message and exits' do
+    it 'prints a message and aborts' do
       exception = Exception.new('test exception')
-      expect(@twig).to receive(:puts).with(exception.message)
       expect(@twig).to receive(:puts) do |message|
         expect(message).to include('`twig --help`')
       end
-      expect(@twig).to receive(:exit)
 
-      @twig.abort_for_option_exception(exception)
+      expect {
+        @twig.abort_for_option_exception(exception)
+      }.to raise_exception { |exception|
+        expect(exception).to be_a(SystemExit)
+        expect(exception.status).to eq(1)
+      }
     end
   end
 
@@ -431,14 +490,12 @@ 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.
-      begin
+      expect {
         @twig.read_cli_args!(['subcommand'])
-      rescue SystemExit => exception
-        expected_exception = exception
-      end
-
-      expect(expected_exception).not_to be_nil
-      expect(expected_exception.status).to eq(0)
+      }.to raise_exception { |exception|
+        expect(exception).to be_a(SystemExit)
+        expect(exception.status).to eq(0)
+      }
     end
 
     it 'does not recognize a subcommand' do
@@ -459,14 +516,12 @@ describe Twig::Cli do
     it 'checks for and executes a subcommand if there are any args' do
       expect(@twig).to receive(:exec_subcommand_if_any).with(['foo']) { exit }
 
-      begin
+      expect {
         @twig.read_cli_args!(['foo'])
-      rescue SystemExit => exception
-        expected_exception = exception
-      end
-
-      expect(expected_exception).not_to be_nil
-      expect(expected_exception.status).to eq(0)
+      }.to raise_exception { |exception|
+        expect(exception).to be_a(SystemExit)
+        expect(exception.status).to eq(0)
+      }
     end
 
     it 'does not check for a subcommand if there are no args' do
@@ -513,7 +568,7 @@ describe Twig::Cli do
       end
 
       it 'gets a property for a specified branch' do
-        expect(@twig).to receive(:all_branch_names).and_return([@branch_name])
+        expect(Twig::Branch).to receive(:all_branch_names).and_return([@branch_name])
         @twig.set_option(:branch, @branch_name)
         expect(@twig).to receive(:get_branch_property_for_cli).
           with(@branch_name, @property_name)
@@ -539,7 +594,7 @@ describe Twig::Cli do
       end
 
       it 'sets a property for a specified branch' do
-        expect(@twig).to receive(:all_branch_names).and_return([@branch_name])
+        expect(Twig::Branch).to receive(:all_branch_names).and_return([@branch_name])
         @twig.set_option(:branch, @branch_name)
         expect(@twig).to receive(:set_branch_property_for_cli).
           with(@branch_name, @property_name, @property_value).
@@ -566,7 +621,7 @@ describe Twig::Cli do
       end
 
       it 'unsets a property for a specified branch' do
-        expect(@twig).to receive(:all_branch_names).and_return([@branch_name])
+        expect(Twig::Branch).to receive(:all_branch_names).and_return([@branch_name])
         @twig.set_option(:branch, @branch_name)
         expect(@twig).to receive(:unset_branch_property_for_cli).
           with(@branch_name, @property_name)