twig 1.6 → 1.7

data/lib/twig/subcommands.rb

@@ -1,6 +1,5 @@
 class Twig
   module Subcommands
-
     BIN_PREFIX = 'twig-'
 
     def self.all_names
@@ -22,5 +21,18 @@ class Twig
       ENV['PATH'].split(':')
     end
 
+    def self.exec_subcommand_if_any(cli_args)
+      # Run subcommand binary, if any, and exit here
+
+      subcommand_name = cli_args[0]
+      bin_name = Twig::Subcommands::BIN_PREFIX + subcommand_name
+      subcommand_path = Twig.run("which #{bin_name} 2>/dev/null")
+      return if subcommand_path.empty?
+
+      subcommand_args = cli_args[1..-1]
+      command = ([subcommand_path] + subcommand_args).join(' ')
+
+      exec(command)
+    end
   end
 end

data/lib/twig/system.rb

@@ -1,9 +1,7 @@
 class Twig
   module System
-
     def self.windows?
       RbConfig::CONFIG['host_os'] =~ /(cygwin|mingw|windows|win32)/
     end
-
   end
 end

data/lib/twig/util.rb

@@ -1,6 +1,5 @@
 class Twig
   module Util
-
     def self.numeric?(value)
       !!Float(value) rescue false
     end
@@ -8,6 +7,5 @@ class Twig
     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.6'
+  VERSION = '1.7'
 end

data/spec/spec_helper.rb

@@ -1,9 +1,10 @@
 require 'twig'
 require 'json'
-require 'rspec/radar'
 
 RSpec.configure do |config|
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
+  config.mock_with :rspec do |mocks|
+    mocks.verify_doubled_constant_names = true
+    mocks.verify_partial_doubles = true
+    mocks.yield_receiver_to_any_instance_implementation_blocks = true
   end
 end

data/spec/twig/branch_spec.rb

@@ -1,5 +1,6 @@
 # encoding: UTF-8
 require 'spec_helper'
+require 'shellwords'
 
 describe Twig::Branch do
   before :each do
@@ -13,16 +14,18 @@ describe Twig::Branch do
         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']
+      @commit_time_strings = %w[
+        2001-01-01
+        2002-02-02
+        2003-03-03
+      ]
       @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]
+          @commit_time_strings[i]
         ].join(Twig::REF_FORMAT_SEPARATOR)
       end.join("\n")
     end
@@ -34,15 +37,15 @@ describe Twig::Branch do
 
       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\)}
+        /#{@commit_time_strings[0]}/
       )
       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\)}
+        /#{@commit_time_strings[1]}/
       )
       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\)}
+        /#{@commit_time_strings[2]}/
       )
     end
 
@@ -144,6 +147,26 @@ describe Twig::Branch do
     end
   end
 
+  describe '.shellescape_property_value' do
+    it 'escapes backticks' do
+      value  = 'value_`ls`'
+      result = Twig::Branch.shellescape_property_value(value)
+      expect(result).to eql('value_\`ls\`')
+    end
+
+    it 'escapes dollar signs' do
+      value  = 'value_$PATH'
+      result = Twig::Branch.shellescape_property_value(value)
+      expect(result).to eql('value_\$PATH')
+    end
+
+    it 'does not escape spaces' do
+      value  = 'foo  bar'
+      result = Twig::Branch.shellescape_property_value(value)
+      expect(result).to eql('foo  bar')
+    end
+  end
+
   describe '#initialize' do
     it 'requires a name' do
       branch = Twig::Branch.new('test')
@@ -155,7 +178,7 @@ describe Twig::Branch do
     end
 
     it 'accepts a last commit time' do
-      commit_time = Twig::CommitTime.new(Time.now, '99 days ago')
+      commit_time = Twig::CommitTime.new(Time.now)
       branch = Twig::Branch.new('test', :last_commit_time => commit_time)
       expect(branch.last_commit_time).to eq(commit_time)
     end
@@ -172,7 +195,7 @@ describe Twig::Branch do
     before :each do
       @branch = Twig::Branch.new('test')
       time = Time.parse('2000-01-01 18:30 UTC')
-      commit_time = Twig::CommitTime.new(time, '')
+      commit_time = Twig::CommitTime.new(time)
       @time_string = time.iso8601
       allow(@branch).to receive(:last_commit_time) { commit_time }
     end
@@ -207,6 +230,24 @@ describe Twig::Branch do
     end
   end
 
+  describe '#parent_name' do
+    before :each do
+      @branch = Twig::Branch.new('test')
+    end
+
+    it 'returns the parent branch name' do
+      parent_name = 'parent'
+      allow(@branch).to receive(:get_property).with('diff-branch').and_return(parent_name)
+
+      expect(@branch.parent_name).to eq(parent_name)
+    end
+
+    it 'returns nil if the parent branch is unknown' do
+      allow(@branch).to receive(:get_property).with('diff-branch')
+      expect(@branch.parent_name).to be_nil
+    end
+  end
+
   describe '#sanitize_property' do
     before :each do
       @branch = Twig::Branch.new('test')
@@ -259,6 +300,7 @@ describe Twig::Branch do
       branch     = Twig::Branch.new('utf8_{･ิω･ิ}')
       properties = { 'test1' => 'value1' }
       git_result = "branch.#{branch}.test1 value1"
+      expect(Shellwords).to receive(:escape).with(branch.to_s) { branch.to_s }
       expect(Twig).to receive(:run).
         with(%{git config --get-regexp "branch.#{branch}.(test1)$"}).
         and_return(git_result)
@@ -322,7 +364,7 @@ describe Twig::Branch do
       end
 
       expect(expected_exception.message).to eq(
-        Twig::Branch::EMPTY_PROPERTY_NAME_ERROR
+        Twig::Branch::EmptyPropertyNameError::DEFAULT_MESSAGE
       )
     end
   end
@@ -403,7 +445,7 @@ describe Twig::Branch do
       end
 
       expect(expected_exception.message).to eq(
-        Twig::Branch::EMPTY_PROPERTY_NAME_ERROR
+        Twig::Branch::EmptyPropertyNameError::DEFAULT_MESSAGE
       )
     end
 
@@ -483,6 +525,37 @@ describe Twig::Branch do
         %{Saved property "#{property}" as "#{value}" for branch "#{@branch}"}
       )
     end
+
+    it 'sets a property for a branch whose name contains a backtick' do
+      branch   = Twig::Branch.new('branch_`ls`')
+      property = 'test'
+      value    = 'value'
+      escaped_branch_name = branch.to_s.shellescape
+      expect(Twig).to receive(:run).
+        with(%{git config branch.#{escaped_branch_name}.#{property} "#{value}"}) do
+          `(exit 0)`; value # Set `$?` to `0`
+        end
+
+      result = branch.set_property(property, value)
+      expect(result).to include(
+        %{Saved property "#{property}" as "#{value}" for branch "#{branch}"}
+      )
+    end
+
+    it 'sets a property value that contains special shell characters' do
+      property      = 'test'
+      value         = 'value `ls` $PATH'
+      escaped_value = 'value \`ls\` \$PATH'
+      expect(Twig).to receive(:run).
+        with(%{git config branch.#{@branch}.#{property} "#{escaped_value}"}) do
+          `(exit 0)`; value # Set `$?` to `0`
+        end
+
+      result = @branch.set_property(property, value)
+      expect(result).to include(
+        %{Saved property "#{property}" as "#{value}" for branch "#{@branch}"}
+      )
+    end
   end
 
   describe '#unset_property' do
@@ -519,7 +592,6 @@ describe Twig::Branch do
 
     it 'raises an error if the property name is an empty string' do
       bad_property = ' '
-      property     = ''
       expect(@branch).not_to receive(:get_property)
       expect(Twig).not_to receive(:run)
 
@@ -530,7 +602,7 @@ describe Twig::Branch do
       end
 
       expect(expected_exception.message).to eq(
-        Twig::Branch::EMPTY_PROPERTY_NAME_ERROR
+        Twig::Branch::EmptyPropertyNameError::DEFAULT_MESSAGE
       )
     end
 
@@ -548,6 +620,21 @@ describe Twig::Branch do
         %{The branch "#{@branch}" does not have the property "#{property}"}
       )
     end
+
+    it 'unsets a property for a branch whose name contains a backtick' do
+      branch   = Twig::Branch.new('branch_`ls`')
+      property = 'test'
+      expect(branch).to receive(:get_property).
+        with(property).and_return('value')
+      expect(Twig).to receive(:run).with(
+        %{git config --unset branch.#{branch.to_s.shellescape}.#{property}}
+      )
+
+      result = branch.unset_property(property)
+      expect(result).to include(
+        %{Removed property "#{property}" for branch "#{branch}"}
+      )
+    end
   end
 
 end

data/spec/twig/cli/help_spec.rb

@@ -0,0 +1,187 @@
+require 'spec_helper'
+
+describe Twig::Cli::Help do
+  Help = Twig::Cli::Help
+
+  describe '.description' do
+    before :each do
+      @twig = Twig.new
+    end
+
+    it 'returns short text in a single line' do
+      text = 'The quick brown fox.'
+      result = Help.description(text, :width => 80)
+      expect(result).to eq([text])
+    end
+
+    it 'returns long text in a string with line breaks' do
+      text = 'The quick brown fox jumps over the lazy, lazy dog.'
+      result = Help.description(text, :width => 20)
+      expect(result).to eq([
+        'The quick brown fox',
+        'jumps over the lazy,',
+        'lazy dog.'
+      ])
+    end
+
+    it 'breaks a long word by max line length' do
+      text = 'Thequickbrownfoxjumpsoverthelazydog.'
+      result = Help.description(text, :width => 20)
+      expect(result).to eq([
+        'Thequickbrownfoxjump',
+        'soverthelazydog.'
+      ])
+    end
+
+    it 'adds a blank line' do
+      text = 'The quick brown fox.'
+      result = Help.description(text, :width => 80, :add_blank_line => true)
+      expect(result).to eq([text, ' '])
+    end
+  end
+
+  describe '.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
+      expect(Help).to receive(:print_section) do |opt_parser, desc, options|
+        expect(opt_parser).to eq(option_parser)
+        expect(desc).to eq("      --test-option                Test option description\n")
+        expect(options).to eq(:trailing => "\n")
+      end
+
+      Help.description_for_custom_property(option_parser, [
+        ['--test-option', 'Test option description']
+      ])
+    end
+
+    it 'supports custom trailing whitespace' do
+      option_parser = OptionParser.new
+      expect(Help).to receive(:print_section) do |opt_parser, desc, options|
+        expect(opt_parser).to eq(option_parser)
+        expect(desc).to eq("      --test-option                Test option description\n")
+        expect(options).to eq(:trailing => '')
+      end
+
+      Help.description_for_custom_property(option_parser, [
+        ['--test-option', 'Test option description']
+      ], :trailing => '')
+    end
+  end
+
+  describe '.line_for_custom_property?' do
+    before :each do
+      @twig = Twig.new
+    end
+
+    it 'returns true for `--except-foo`' do
+      expect(Help.line_for_custom_property?('  --except-foo  ')).to eql(true)
+    end
+
+    it 'returns false for `--except-branch`' do
+      expect(Help.line_for_custom_property?('  --except-branch  ')).to be_falsy
+    end
+
+    it 'returns false for `--except-property`' do
+      expect(Help.line_for_custom_property?('  --except-property  ')).to be_falsy
+    end
+
+    it 'returns false for `--except-PROPERTY`' do
+      expect(Help.line_for_custom_property?('  --except-PROPERTY  ')).to be_falsy
+    end
+
+    it 'returns true for `--only-foo`' do
+      expect(Help.line_for_custom_property?('  --only-foo  ')).to eql(true)
+    end
+
+    it 'returns false for `--only-branch`' do
+      expect(Help.line_for_custom_property?('  --only-branch  ')).to be_falsy
+    end
+
+    it 'returns false for `--only-property`' do
+      expect(Help.line_for_custom_property?('  --only-property  ')).to be_falsy
+    end
+
+    it 'returns false for `--only-PROPERTY`' do
+      expect(Help.line_for_custom_property?('  --only-PROPERTY  ')).to be_falsy
+    end
+
+    it 'returns true for `--foo-width`' do
+      expect(Help.line_for_custom_property?('  --foo-width  ')).to eql(true)
+    end
+
+    it 'returns false for `--branch-width`' do
+      expect(Help.line_for_custom_property?('  --branch-width  ')).to be_falsy
+    end
+
+    it 'returns false for `--PROPERTY-width`' do
+      expect(Help.line_for_custom_property?('  --PROPERTY-width  ')).to be_falsy
+    end
+  end
+
+  describe '.paragraph' do
+    before :each do
+      @twig = Twig.new
+    end
+
+    it 'returns long text in a paragraph with line breaks' do
+      text = Array.new(5) do
+        'The quick brown fox jumps over the lazy dog.'
+      end.join(' ')
+
+      result = Help.paragraph(text)
+
+      expect(result).to eq([
+        '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 '.subcommand_descriptions' do
+    it 'returns a word-wrapped list of subcommand descriptions' do
+      output_lines = Help.subcommand_descriptions
+
+      # Some lines are actually multi-line descriptions. Split them so we can
+      # count characters per line.
+      output_lines = output_lines.map { |line| line.split("\n") }.flatten
+
+      output_line_max_width = output_lines.map { |line| line.length }.max
+      expect(output_line_max_width).to be <= Help.console_width
+    end
+  end
+
+  describe '.header' do
+    it 'generates a header section' do
+      option_parser = double
+      text = 'Some header'
+      expected_text = "Some header\n==========="
+      expect(Help).to receive(:print_section).with(
+        option_parser,
+        expected_text,
+        :trailing => "\n\n"
+      )
+
+      Help.header(option_parser, text)
+    end
+  end
+
+  describe '.subheader' do
+    it 'generates a subheader section' do
+      option_parser = double
+      text = 'Some subheader'
+      expected_text = "Some subheader\n--------------"
+      expect(Help).to receive(:print_section).with(
+        option_parser,
+        expected_text,
+        :trailing => "\n\n"
+      )
+
+      Help.subheader(option_parser, text)
+    end
+  end
+end