twig 1.4 → 1.5

data/lib/twig/commit_time.rb

@@ -1,4 +1,6 @@
 class Twig
+
+  # Stores a branch's last commit time and its relative time representation.
   class CommitTime
 
     def initialize(time, time_ago)
@@ -13,6 +15,10 @@ class Twig
         sub(' hours',   'h').
         sub(' minutes', 'm').
         sub(' seconds', 's')
+
+      # Keep only the most significant units in the relative time
+      time_ago_parts = @time_ago.split(/\s+/)
+      @time_ago = "#{time_ago_parts[0]} #{time_ago_parts[-1]}".gsub(/,/, '')
     end
 
     def to_i
@@ -24,6 +30,10 @@ class Twig
       "#{time_string} (#{@time_ago})"
     end
 
+    def iso8601
+      @time.iso8601
+    end
+
     def <=>(other)
       to_i <=> other.to_i
     end

data/lib/twig/display.rb

@@ -137,6 +137,15 @@ class Twig
       line
     end
 
+    def branches_json
+      require 'json'
+
+      data = {
+        'branches' => branches.map { |branch| branch.to_hash }
+      }
+      data.to_json
+    end
+
     def format_string(string, options)
       # Options:
       # - `:color`:  `nil` by default. Accepts a key from `COLORS`.

data/lib/twig/options.rb

@@ -5,61 +5,96 @@ class Twig
     DEPRECATED_CONFIG_PATH = '~/.twigrc'
     MIN_PROPERTY_WIDTH = 3
 
-    def read_config_file!
-      config_path = File.expand_path(Twig::CONFIG_PATH)
-      unless File.readable?(config_path)
-        config_path = File.expand_path(Twig::DEPRECATED_CONFIG_PATH)
-        if File.readable?(config_path)
-          $stderr.puts "DEPRECATED: #{DEPRECATED_CONFIG_PATH} is deprecated. " <<
-            "Please rename it to #{CONFIG_PATH}."
+    def readable_config_file_path
+      config_path = File.expand_path(CONFIG_PATH)
+
+      if File.exists?(config_path)
+        unless File.readable?(config_path)
+          $stderr.puts "Warning: #{CONFIG_PATH} is not readable."
+          return # Stop if file exists but is not readable
+        end
+      else
+        config_path = File.expand_path(DEPRECATED_CONFIG_PATH)
+
+        if File.exists?(config_path)
+          if File.readable?(config_path)
+            $stderr.puts "DEPRECATED: #{DEPRECATED_CONFIG_PATH} is deprecated. " <<
+              "Please rename it to #{CONFIG_PATH}."
+          else
+            $stderr.puts "DEPRECATED: #{DEPRECATED_CONFIG_PATH} is deprecated. " <<
+              "Please rename it to #{CONFIG_PATH} and make it readable."
+            return # Stop if file exists but is not readable
+          end
         else
-          return
+          return # Stop if neither file exists
         end
       end
 
+      config_path
+    end
+
+    def parse_config_file(config_path)
+      lines = []
+
       File.open(config_path) do |file|
-        opts = file.read.split("\n").inject({}) do |hsh, line|
-          line = line.strip
+        lines = file.read.split("\n")
+      end
 
-          if line !~ /^#/
-            key, value = line.split(':', 2)
-            hsh[key.strip] = value.strip if key && value
-          end
+      lines.inject({}) do |opts, line|
+        line = line.strip
+        next opts if line =~ /^#/
+
+        key, value = line.split(':', 2)
+        key = key ? key.strip : ''
 
-          hsh
+        if !key.empty? && value
+          opts[key] = value.strip
+        elsif !line.empty?
+          $stderr.puts %{Warning: Invalid line "#{line}" in #{config_path}. } <<
+            %{Expected format: `key: value`}
         end
 
-        opts.each do |key, value|
-          case key
-
-          # 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)
-
-          # GitHub integration:
-          when 'github-api-uri-prefix'
-            set_option(:github_api_uri_prefix, value)
-          when 'github-uri-prefix'
-            set_option(:github_uri_prefix, value)
+        opts
+      end
+    end
+
+    def read_config_file!
+      config_path = readable_config_file_path
+      return unless config_path
+
+      options = parse_config_file(config_path)
+      options.each do |key, value|
+        case key
+
+        # 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 '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)
+        when 'github-uri-prefix'
+          set_option(:github_uri_prefix, value)
 
-          end
         end
       end
     end
@@ -70,7 +105,14 @@ class Twig
         if all_branch_names.include?(value)
           options[:branch] = value
         else
-          abort %{The branch "#{value}" could not be found.}
+          abort %{The branch `#{value}` could not be found.}
+        end
+
+      when :format
+        if value == 'json'
+          options[:format] = value.to_sym
+        else
+          abort %{The format `#{value}` is not supported; only `json` is supported.}
         end
 
       when :github_api_uri_prefix, :github_uri_prefix

data/lib/twig/subcommands.rb

@@ -0,0 +1,26 @@
+class Twig
+  module Subcommands
+
+    BIN_PREFIX = 'twig-'
+
+    def self.all_names
+      bin_paths = []
+
+      bin_dir_paths.each do |bin_dir_path|
+        path_pattern = File.join(bin_dir_path, BIN_PREFIX + '*')
+        Dir.glob(path_pattern) do |bin_path|
+          bin_paths << File.basename(bin_path)
+        end
+      end
+
+      bin_paths.uniq.sort.map do |bin_path|
+        bin_path.sub(Regexp.new('^' << BIN_PREFIX), '')
+      end
+    end
+
+    def self.bin_dir_paths
+      ENV['PATH'].split(':')
+    end
+
+  end
+end

data/lib/twig/system.rb

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

data/lib/twig/version.rb

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

data/spec/spec_helper.rb

@@ -1 +1,8 @@
 require 'twig'
+require 'json'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/twig/branch_spec.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 require 'spec_helper'
 
 describe Twig::Branch do
@@ -27,37 +28,37 @@ describe Twig::Branch do
     end
 
     it 'returns the union of properties for all branches' do
-      Twig.should_receive(:run).with('git config --list').and_return(@config)
+      expect(Twig).to receive(:run).with('git config --list').and_return(@config)
 
       result = Twig::Branch.all_property_names
-      result.should == %w[test0 test1 test2]
+      expect(result).to eq(%w[test0 test1 test2])
     end
 
     it 'handles branch names that contain dots' do
       @config << 'branch.dot1.dot2.dot3.dotproperty=dotvalue'
-      Twig.should_receive(:run).with('git config --list').and_return(@config)
+      expect(Twig).to receive(:run).with('git config --list').and_return(@config)
 
       result = Twig::Branch.all_property_names
-      result.should == %w[dotproperty test0 test1 test2]
+      expect(result).to eq(%w[dotproperty test0 test1 test2])
     end
 
     it 'handles branch names that contain equal signs' do
       @config << 'branch.eq1=eq2=eq3.eqproperty=eqvalue'
-      Twig.should_receive(:run).with('git config --list').and_return(@config)
+      expect(Twig).to receive(:run).with('git config --list').and_return(@config)
 
       result = Twig::Branch.all_property_names
-      result.should == %w[eqproperty test0 test1 test2]
+      expect(result).to eq(%w[eqproperty test0 test1 test2])
     end
 
     it 'skips path values with an equal sign but no value' do
       @config << 'foo_path='
-      Twig.should_receive(:run).with('git config --list').and_return(@config)
+      expect(Twig).to receive(:run).with('git config --list').and_return(@config)
       result = Twig::Branch.all_property_names
-      result.should_not include 'foo_path'
+      expect(result).not_to include('foo_path')
     end
 
     it 'memoizes the result' do
-      Twig.should_receive(:run).once.and_return(@config)
+      expect(Twig).to receive(:run).once.and_return(@config)
       2.times { Twig::Branch.all_property_names }
     end
   end
@@ -65,24 +66,65 @@ describe Twig::Branch do
   describe '#initialize' do
     it 'requires a name' do
       branch = Twig::Branch.new('test')
-      branch.name.should == 'test'
+      expect(branch.name).to eq('test')
 
-      lambda { Twig::Branch.new      }.should raise_exception
-      lambda { Twig::Branch.new(nil) }.should raise_exception
-      lambda { Twig::Branch.new('')  }.should raise_exception
+      expect { Twig::Branch.new      }.to raise_exception
+      expect { Twig::Branch.new(nil) }.to raise_exception
+      expect { Twig::Branch.new('')  }.to raise_exception
     end
 
     it 'accepts a last commit time' do
       commit_time = Twig::CommitTime.new(Time.now, '99 days ago')
       branch = Twig::Branch.new('test', :last_commit_time => commit_time)
-      branch.last_commit_time.should == commit_time
+      expect(branch.last_commit_time).to eq(commit_time)
     end
   end
 
   describe '#to_s' do
     it 'returns the branch name' do
       branch = Twig::Branch.new('test')
-      branch.to_s.should == 'test'
+      expect(branch.to_s).to eq('test')
+    end
+  end
+
+  describe '#to_hash' do
+    before :each do
+      @branch = Twig::Branch.new('test')
+      time = Time.parse('2000-01-01 18:30 UTC')
+      commit_time = Twig::CommitTime.new(time, '')
+      @time_string = time.iso8601
+      allow(@branch).to receive(:last_commit_time) { commit_time }
+    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
+        { 'foo' => 'foo!', 'bar' => 'bar!' }
+      end
+
+      result = @branch.to_hash
+
+      expect(result).to eq(
+        'name' => 'test',
+        'last-commit-time' => @time_string,
+        'properties' => {
+          'foo' => 'foo!',
+          'bar' => 'bar!'
+        }
+      )
+    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({})
+
+      result = @branch.to_hash
+
+      expect(result).to eq(
+        'name' => 'test',
+        'last-commit-time' => @time_string,
+        'properties' => {}
+      )
     end
   end
 
@@ -92,11 +134,23 @@ describe Twig::Branch do
     end
 
     it 'removes whitespace from branch property names' do
-      @branch.sanitize_property('  foo bar  ').should == 'foobar'
+      expect(@branch.sanitize_property('  foo bar  ')).to eq('foobar')
     end
 
     it 'removes underscores from branch property names' do
-      @branch.sanitize_property('__foo_bar__').should == 'foobar'
+      expect(@branch.sanitize_property('__foo_bar__')).to eq('foobar')
+    end
+  end
+
+  describe '#escaped_property_names' do
+    before :each do
+      @branch = Twig::Branch.new('test')
+    end
+
+    it 'converts an array of property names into an array of regexps' do
+      property_names = %w[test.1 test.2]
+      result = @branch.escaped_property_names(property_names)
+      expect(result).to eq(%w[test\\.1 test\\.2])
     end
   end
 
@@ -114,29 +168,41 @@ describe Twig::Branch do
         "branch.#{@branch}.test1 value1",
         "branch.#{@branch}.test2 value2"
       ].join("\n")
-      Twig.should_receive(:run).
+      expect(Twig).to receive(:run).
         with(%{git config --get-regexp "branch.#{@branch}.(test1|test2)$"}).
         and_return(git_result)
 
       result = @branch.get_properties(%w[test1 test2])
-      result.should == properties
+      expect(result).to eq(properties)
+    end
+
+    it 'returns properties for a branch with UTF-8 characters in its name' do
+      branch     = Twig::Branch.new('utf8_{･ิω･ิ}')
+      properties = { 'test1' => 'value1' }
+      git_result = "branch.#{branch}.test1 value1"
+      expect(Twig).to receive(:run).
+        with(%{git config --get-regexp "branch.#{branch}.(test1)$"}).
+        and_return(git_result)
+
+      result = branch.get_properties(%w[test1])
+      expect(result).to eq(properties)
     end
 
     it 'returns an empty hash if no property names are given' do
-      Twig.should_not_receive(:run)
+      expect(Twig).not_to receive(:run)
 
       result = @branch.get_properties([])
-      result.should == {}
+      expect(result).to eq({})
     end
 
     it 'returns an empty hash if no matching property names are found' do
       git_result = ''
-      Twig.should_receive(:run).
+      expect(Twig).to receive(:run).
         with(%{git config --get-regexp "branch.#{@branch}.(test1|test2)$"}).
         and_return(git_result)
 
       result = @branch.get_properties(%w[test1 test2])
-      result.should == {}
+      expect(result).to eq({})
     end
 
     it 'removes whitespace from property names' do
@@ -145,12 +211,12 @@ describe Twig::Branch do
       property_value    = 'bar'
       properties        = { property_name => property_value }
       git_result = "branch.#{@branch}.#{property_name} #{property_value}"
-      Twig.should_receive(:run).
+      expect(Twig).to receive(:run).
         with(%{git config --get-regexp "branch.#{@branch}.(#{property_name})$"}).
         and_return(git_result)
 
       result = @branch.get_properties([bad_property_name])
-      result.should == properties
+      expect(result).to eq(properties)
     end
 
     it 'excludes properties whose values are empty strings' do
@@ -158,17 +224,17 @@ describe Twig::Branch do
         "branch.#{@branch}.test1 value1",
         "branch.#{@branch}.test2"
       ].join("\n")
-      Twig.should_receive(:run).
+      expect(Twig).to receive(:run).
         with(%{git config --get-regexp "branch.#{@branch}.(test1|test2)$"}).
         and_return(git_result)
 
       result = @branch.get_properties(%w[test1 test2])
-      result.should == { 'test1' => 'value1' }
+      expect(result).to eq('test1' => 'value1')
     end
 
     it 'raises an error if any property name is an empty string' do
       property_name = '  '
-      Twig.should_not_receive(:run)
+      expect(Twig).not_to receive(:run)
 
       begin
         @branch.get_properties(['test1', property_name])
@@ -176,7 +242,9 @@ describe Twig::Branch do
         expected_exception = exception
       end
 
-      expected_exception.message.should == Twig::Branch::EMPTY_PROPERTY_NAME_ERROR
+      expect(expected_exception.message).to eq(
+        Twig::Branch::EMPTY_PROPERTY_NAME_ERROR
+      )
     end
   end
 
@@ -188,24 +256,24 @@ describe Twig::Branch do
     it 'returns a property value' do
       property = 'test'
       value    = 'value'
-      @branch.should_receive(:get_properties).
+      expect(@branch).to receive(:get_properties).
         with([property]).
         and_return(property => value)
 
       result = @branch.get_property(property)
-      result.should == value
+      expect(result).to eq(value)
     end
 
     it 'removes whitespace from branch property names' do
       bad_property = '  foo foo  '
       property     = 'foofoo'
       value        = 'bar'
-      @branch.should_receive(:get_properties).
+      expect(@branch).to receive(:get_properties).
         with([property]).
         and_return(property => value)
 
       result = @branch.get_property(bad_property)
-      result.should == value
+      expect(result).to eq(value)
     end
   end
 
@@ -217,13 +285,13 @@ describe Twig::Branch do
     it 'sets a property value' do
       property = 'test'
       value    = 'value'
-      Twig.should_receive(:run).
+      expect(Twig).to receive(:run).
         with(%{git config branch.#{@branch}.#{property} "#{value}"}) do
           `(exit 0)`; value # Set `$?` to `0`
         end
 
       result = @branch.set_property(property, value)
-      result.should include(
+      expect(result).to include(
         %{Saved property "#{property}" as "#{value}" for branch "#{@branch}"}
       )
     end
@@ -231,7 +299,7 @@ describe Twig::Branch 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`
+      allow(Twig).to receive(:run) { `(exit 1)`; value } # Set `$?` to `1`
 
       begin
         @branch.set_property(property, value)
@@ -239,7 +307,7 @@ describe Twig::Branch do
         expected_exception = exception
       end
 
-      expected_exception.message.should include(
+      expect(expected_exception.message).to include(
         %{Could not save property "#{property}" as "#{value}" for branch "#{@branch}"}
       )
     end
@@ -247,7 +315,7 @@ describe Twig::Branch do
     it 'raises an error if the property name is an empty string' do
       property = ' '
       value    = 'value'
-      Twig.should_not_receive(:run)
+      expect(Twig).not_to receive(:run)
 
       begin
         @branch.set_property(property, value)
@@ -255,13 +323,15 @@ describe Twig::Branch do
         expected_exception = exception
       end
 
-      expected_exception.message.should == Twig::Branch::EMPTY_PROPERTY_NAME_ERROR
+      expect(expected_exception.message).to eq(
+        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)
+      expect(Twig).not_to receive(:run)
 
       begin
         @branch.set_property(property, value)
@@ -269,7 +339,7 @@ describe Twig::Branch do
         expected_exception = exception
       end
 
-      expected_exception.message.should include(
+      expect(expected_exception.message).to include(
         %{Can't modify the reserved property "#{property}"}
       )
     end
@@ -277,7 +347,7 @@ describe Twig::Branch 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)
+      expect(Twig).not_to receive(:run)
 
       begin
         @branch.set_property(property, value)
@@ -285,7 +355,7 @@ describe Twig::Branch do
         expected_exception = exception
       end
 
-      expected_exception.message.should include(
+      expect(expected_exception.message).to include(
         %{Can't set a branch property to an empty string}
       )
     end
@@ -294,13 +364,13 @@ describe Twig::Branch do
       bad_property = '  foo foo  '
       property     = 'foofoo'
       value        = 'bar'
-      Twig.should_receive(:run).
+      expect(Twig).to receive(:run).
         with(%{git config branch.#{@branch}.#{property} "#{value}"}) do
           `(exit 0)`; value # Set `$?` to `0`
         end
 
       result = @branch.set_property(bad_property, value)
-      result.should include(
+      expect(result).to include(
         %{Saved property "#{property}" as "#{value}" for branch "#{@branch}"}
       )
     end
@@ -309,13 +379,13 @@ describe Twig::Branch do
       bad_property = 'foo_foo'
       property     = 'foofoo'
       value        = 'bar'
-      Twig.should_receive(:run).
+      expect(Twig).to receive(:run).
         with(%{git config branch.#{@branch}.#{property} "#{value}"}) do
           `(exit 0)`; value # Set `$?` to `0`
         end
 
       result = @branch.set_property(bad_property, value)
-      result.should include(
+      expect(result).to include(
         %{Saved property "#{property}" as "#{value}" for branch "#{@branch}"}
       )
     end
@@ -324,13 +394,13 @@ describe Twig::Branch do
       property  = 'test'
       bad_value = '  foo  '
       value     = 'foo'
-      Twig.should_receive(:run).
+      expect(Twig).to receive(:run).
         with(%{git config branch.#{@branch}.#{property} "#{value}"}) do
           `(exit 0)`; value # Set `$?` to `0`
         end
 
       result = @branch.set_property(property, bad_value)
-      result.should include(
+      expect(result).to include(
         %{Saved property "#{property}" as "#{value}" for branch "#{@branch}"}
       )
     end
@@ -343,12 +413,13 @@ describe Twig::Branch do
 
     it 'unsets a branch property' do
       property = 'test'
-      @branch.should_receive(:get_property).with(property).and_return('value')
-      Twig.should_receive(:run).
+      expect(@branch).to receive(:get_property).
+        with(property).and_return('value')
+      expect(Twig).to receive(:run).
         with(%{git config --unset branch.#{@branch}.#{property}})
 
       result = @branch.unset_property(property)
-      result.should include(
+      expect(result).to include(
         %{Removed property "#{property}" for branch "#{@branch}"}
       )
     end
@@ -356,12 +427,13 @@ describe Twig::Branch do
     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).
+      expect(@branch).to receive(:get_property).
+        with(property).and_return('value')
+      expect(Twig).to receive(:run).
         with(%{git config --unset branch.#{@branch}.#{property}})
 
       result = @branch.unset_property(bad_property)
-      result.should include(
+      expect(result).to include(
         %{Removed property "#{property}" for branch "#{@branch}"}
       )
     end
@@ -369,8 +441,8 @@ describe Twig::Branch do
     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)
+      expect(@branch).not_to receive(:get_property)
+      expect(Twig).not_to receive(:run)
 
       begin
         @branch.unset_property(bad_property)
@@ -378,12 +450,14 @@ describe Twig::Branch do
         expected_exception = exception
       end
 
-      expected_exception.message.should == Twig::Branch::EMPTY_PROPERTY_NAME_ERROR
+      expect(expected_exception.message).to eq(
+        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)
+      expect(@branch).to receive(:get_property).with(property).and_return(nil)
 
       begin
         @branch.unset_property(property)
@@ -391,7 +465,7 @@ describe Twig::Branch do
         expected_exception = exception
       end
 
-      expected_exception.message.should include(
+      expect(expected_exception.message).to include(
         %{The branch "#{@branch}" does not have the property "#{property}"}
       )
     end