twig 1.3 → 1.4

data/lib/twig/branch.rb

@@ -1,9 +1,9 @@
 class Twig
   class Branch
 
-    EMPTY_PROPERTY_NAME_ERROR     = 'Branch property names cannot be empty strings.'
-    PROPERTY_NAME_FROM_GIT_CONFIG = /^branch\.[^.]+\.([^=]+)=.*$/
-    RESERVED_BRANCH_PROPERTIES    = %w[branch merge rebase remote]
+    EMPTY_PROPERTY_NAME_ERROR      = 'Branch property names cannot be empty strings.'
+    PROPERTY_NAME_FROM_GIT_CONFIG  = /^branch\.[^.]+\.([^=]+)=.*$/
+    RESERVED_BRANCH_PROPERTY_NAMES = %w[branch merge rebase remote]
 
     class EmptyPropertyNameError < ArgumentError
       def initialize(message = nil)
@@ -15,8 +15,8 @@ class Twig
 
     attr_accessor :name, :last_commit_time
 
-    def self.all_properties
-      @_all_properties ||= begin
+    def self.all_property_names
+      @_all_property_names ||= begin
         config_lines = Twig.run('git config --list').split("\n")
 
         properties = config_lines.map do |line|
@@ -29,7 +29,7 @@ class Twig
           key_parts.last if key_parts[0] == 'branch' && key_parts.size > 2
         end.compact
 
-        properties.uniq.sort - RESERVED_BRANCH_PROPERTIES
+        properties.uniq.sort - RESERVED_BRANCH_PROPERTY_NAMES
       end
     end
 
@@ -46,12 +46,43 @@ class Twig
       property_name.gsub(/[ _]+/, '')
     end
 
+    def get_properties(property_names)
+      return {} if property_names.empty?
+
+      property_name_regexps = property_names.map do |property_name|
+        property_name = sanitize_property(property_name)
+        raise EmptyPropertyNameError if property_name.empty?
+        Regexp.escape(property_name)
+      end.join('|')
+
+      git_config_regexp = "branch\.#{name}\.(#{ property_name_regexps })$"
+      cmd = %{git config --get-regexp "#{git_config_regexp}"}
+
+      git_result = Twig.run(cmd) || ''
+      git_result_lines = git_result.split("\n")
+
+      git_result_lines.inject({}) do |properties, line|
+        match_data = line.match(/^branch\.#{name}\.([^\s]+)\s+(.*)$/)
+
+        if match_data
+          property_name = match_data[1]
+          property_value = match_data[2]
+        else
+          property_value = ''
+        end
+
+        if property_value.empty?
+          properties
+        else
+          properties.merge(property_name => property_value)
+        end
+      end
+
+    end
+
     def get_property(property_name)
       property_name = sanitize_property(property_name)
-      raise EmptyPropertyNameError if property_name.empty?
-
-      value = Twig.run("git config branch.#{name}.#{property_name}")
-      value == '' ? nil : value
+      get_properties([property_name])[property_name]
     end
 
     def set_property(property_name, value)
@@ -60,14 +91,15 @@ class Twig
 
       if property_name.empty?
         raise EmptyPropertyNameError
-      elsif RESERVED_BRANCH_PROPERTIES.include?(property_name)
+      elsif RESERVED_BRANCH_PROPERTY_NAMES.include?(property_name)
         raise ArgumentError,
           %{Can't modify the reserved property "#{property_name}".}
       elsif value.empty?
         raise ArgumentError,
           %{Can't set a branch property to an empty string.}
       else
-        Twig.run(%{git config branch.#{name}.#{property_name} "#{value}"})
+        git_config = "branch.#{name}.#{property_name}"
+        Twig.run(%{git config #{git_config} "#{value}"})
         result_body = %{property "#{property_name}" as "#{value}" for branch "#{name}".}
         if $?.success?
           "Saved #{result_body}"
@@ -84,7 +116,8 @@ class Twig
       value = get_property(property_name)
 
       if value
-        Twig.run(%{git config --unset branch.#{name}.#{property_name}})
+        git_config = "branch.#{name}.#{property_name}"
+        Twig.run(%{git config --unset #{git_config}})
         %{Removed property "#{property_name}" for branch "#{name}".}
       else
         raise MissingPropertyError,

data/lib/twig/cli.rb

@@ -94,7 +94,7 @@ class Twig
     end
 
     def read_cli_options!(args)
-      custom_properties = Twig::Branch.all_properties
+      custom_properties = Twig::Branch.all_property_names
 
       option_parser = OptionParser.new do |opts|
         opts.banner         = help_intro
@@ -186,7 +186,7 @@ class Twig
         desc =
           'Lists all branches regardless of other filtering options. ' +
           'Useful for overriding options in ' +
-          File.basename(Twig::Options::CONFIG_FILE) + '.'
+          File.basename(Twig::Options::CONFIG_PATH) + '.'
         opts.on('--all', *help_description(desc)) do |pattern|
           unset_option(:max_days_old)
           unset_option(:property_except)
@@ -240,15 +240,42 @@ class Twig
 
 
 
+        help_separator(opts, 'GitHub integration:')
+
+        desc = <<-DESC
+          Set a custom GitHub API URI prefix, e.g.,
+          https://github-enterprise.example.com/api/v3.
+        DESC
+        opts.on(
+          '--github-api-uri-prefix PREFIX',
+          *help_description(desc, :add_separator => true)
+        ) do |prefix|
+          set_option(:github_api_uri_prefix, prefix)
+        end
+
+        desc = <<-DESC
+          Set a custom GitHub URI prefix, e.g.,
+          https://github-enterprise.example.com.
+        DESC
+        opts.on(
+          '--github-uri-prefix PREFIX',
+          *help_description(desc, :add_separator => true)
+        ) do |prefix|
+          set_option(:github_uri_prefix, prefix)
+        end
+
+
+
         help_separator(opts, help_paragraph(%{
           You can put your most frequently used options for filtering and
-          listing branches into #{Twig::Options::CONFIG_FILE}. For example:
+          listing branches into #{Twig::Options::CONFIG_PATH}. For example:
         }), :trailing => '')
 
         help_separator(opts, [
           '      except-branch: staging',
           '      header-style:  green bold',
-          '      max-days-old:  30'
+          '      max-days-old:  30',
+          '      reverse:       true',
         ].join("\n"), :trailing => '')
 
         help_separator(opts, help_paragraph(%{

data/lib/twig/display.rb

@@ -66,6 +66,7 @@ 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!(
@@ -80,7 +81,7 @@ class Twig
       )
 
       out = column(' ', :width => date_time_column_width) << column_gutter
-      out << Twig::Branch.all_properties.map do |property|
+      out << all_property_names.map do |property|
         width = property_column_width(property)
         column(property, header_options.merge(:width => width)) << column_gutter
       end.join
@@ -88,7 +89,7 @@ class Twig
       out << "\n"
 
       out << column(' ', :width => date_time_column_width) << column_gutter
-      out << Twig::Branch.all_properties.map do |property|
+      out << all_property_names.map do |property|
         width = property_column_width(property)
         underline = '-' * property.size
         column(underline, header_options.merge(:width => width)) << column_gutter
@@ -100,20 +101,22 @@ class Twig
     end
 
     def branch_list_line(branch)
-      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 = EMPTY_BRANCH_PROPERTY_INDICATOR if property.empty?
-        property.gsub!(/[\n\r]+/, ' ')
-        result.merge(property_name => property)
+      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|
+        property_value = (properties[property_name] || '').strip
+        property_value = EMPTY_BRANCH_PROPERTY_INDICATOR if property_value.empty?
+        property_value.gsub!(/[\n\r]+/, ' ')
+        result.merge(property_name => property_value)
       end
 
       line = column(branch.last_commit_time.to_s, :width => date_time_column_width)
       line << column_gutter
 
       line <<
-        Twig::Branch.all_properties.map do |property_name|
+        all_property_names.map do |property_name|
           property_value = properties[property_name] || ''
           width = property_column_width(property_name)
           column(property_value, :width => width) << column_gutter
@@ -144,7 +147,10 @@ class Twig
       string_options << WEIGHTS[options[:weight]] if options[:weight]
       return string if string_options.empty?
 
-      "\e[#{string_options.join(';')}m#{string}\e[0m"
+      open_format  = "\e[#{string_options.join(';')}m"
+      close_format = "\e[0m"
+
+      open_format + string.to_s + close_format
     end
 
     def unformat_string(string)

data/lib/twig/github.rb

@@ -1,3 +1,5 @@
+require 'uri'
+
 class Twig
   class GithubRepo
     def initialize
@@ -21,7 +23,9 @@ class Twig
     end
 
     def github_repo?
-      origin_url.include?('github.com')
+      gh_url_prefix = 'https://github.com'
+      uri = URI.parse(gh_url_prefix)
+      origin_url.include?(uri.host)
     end
 
     def username

data/lib/twig/options.rb

@@ -1,15 +1,24 @@
 class Twig
   module Options
 
-    CONFIG_FILE = '~/.twigrc'
+    CONFIG_PATH = '~/.twigconfig'
+    DEPRECATED_CONFIG_PATH = '~/.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)
+      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}."
+        else
+          return
+        end
+      end
 
-      File.open(config_file_path) do |f|
-        opts = f.read.split("\n").inject({}) do |hsh, line|
+      File.open(config_path) do |file|
+        opts = file.read.split("\n").inject({}) do |hsh, line|
           line = line.strip
 
           if line !~ /^#/
@@ -44,6 +53,12 @@ class Twig
             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
@@ -58,6 +73,9 @@ class Twig
           abort %{The branch "#{value}" could not be found.}
         end
 
+      when :github_api_uri_prefix, :github_uri_prefix
+        options[key] = value
+
       when :header_style
         set_header_style_option(value)
 
@@ -122,17 +140,18 @@ class Twig
 
         property_name_width = property_name.to_s.size
         property_value = property_value.to_i
+        min_property_value = [property_name_width, MIN_PROPERTY_WIDTH].max
 
-        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}.}
+        if property_value < min_property_value
+          min_desc = if property_value < property_name_width
+            %{#{property_name_width} (width of "#{property_name}")}
+          else
+            %{#{MIN_PROPERTY_WIDTH}}
           end
 
+          error = %{The value `--#{property_name}-width=#{property_value}` } +
+            %{is too low. The minimum is #{min_desc}.}
+
           abort error
         end
 

data/lib/twig/version.rb

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

data/spec/twig/branch_spec.rb

@@ -5,9 +5,9 @@ describe Twig::Branch do
     @twig = Twig.new
   end
 
-  describe '.all_properties' do
+  describe '.all_property_names' do
     before :each do
-      Twig::Branch.instance_variable_set(:@_all_properties, nil)
+      Twig::Branch.instance_variable_set(:@_all_property_names, nil)
       @config = %{
         user.name=Ron DeVera
         branch.autosetupmerge=always
@@ -29,7 +29,7 @@ describe Twig::Branch do
     it 'returns the union of properties for all branches' do
       Twig.should_receive(:run).with('git config --list').and_return(@config)
 
-      result = Twig::Branch.all_properties
+      result = Twig::Branch.all_property_names
       result.should == %w[test0 test1 test2]
     end
 
@@ -37,7 +37,7 @@ describe Twig::Branch do
       @config << 'branch.dot1.dot2.dot3.dotproperty=dotvalue'
       Twig.should_receive(:run).with('git config --list').and_return(@config)
 
-      result = Twig::Branch.all_properties
+      result = Twig::Branch.all_property_names
       result.should == %w[dotproperty test0 test1 test2]
     end
 
@@ -45,20 +45,20 @@ describe Twig::Branch do
       @config << 'branch.eq1=eq2=eq3.eqproperty=eqvalue'
       Twig.should_receive(:run).with('git config --list').and_return(@config)
 
-      result = Twig::Branch.all_properties
+      result = Twig::Branch.all_property_names
       result.should == %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)
-      result = Twig::Branch.all_properties
+      result = Twig::Branch.all_property_names
       result.should_not include 'foo_path'
     end
 
     it 'memoizes the result' do
       Twig.should_receive(:run).once.and_return(@config)
-      2.times { Twig::Branch.all_properties }
+      2.times { Twig::Branch.all_property_names }
     end
   end
 
@@ -100,50 +100,78 @@ describe Twig::Branch do
     end
   end
 
-  describe '#get_property' do
+  describe '#get_properties' do
     before :each do
       @branch = Twig::Branch.new('test')
     end
 
-    it 'returns a property value' do
-      property = 'test'
-      value    = 'value'
+    it 'returns a hash of property names and values' do
+      properties = {
+        'test1' => 'value1',
+        'test2' => 'value2'
+      }
+      git_result = [
+        "branch.#{@branch}.test1 value1",
+        "branch.#{@branch}.test2 value2"
+      ].join("\n")
       Twig.should_receive(:run).
-        with(%{git config branch.#{@branch}.#{property}}).
-        and_return(value)
+        with(%{git config --get-regexp "branch.#{@branch}.(test1|test2)$"}).
+        and_return(git_result)
 
-      result = @branch.get_property(property)
-      result.should == value
+      result = @branch.get_properties(%w[test1 test2])
+      result.should == properties
     end
 
-    it 'removes whitespace from branch property names' do
-      bad_property = '  foo foo  '
-      property     = 'foofoo'
-      value        = 'bar'
+    it 'returns an empty hash if no property names are given' do
+      Twig.should_not_receive(:run)
+
+      result = @branch.get_properties([])
+      result.should == {}
+    end
+
+    it 'returns an empty hash if no matching property names are found' do
+      git_result = ''
       Twig.should_receive(:run).
-        with(%{git config branch.#{@branch}.#{property}}).
-        and_return(value)
+        with(%{git config --get-regexp "branch.#{@branch}.(test1|test2)$"}).
+        and_return(git_result)
 
-      result = @branch.get_property(bad_property)
-      result.should == value
+      result = @branch.get_properties(%w[test1 test2])
+      result.should == {}
     end
 
-    it 'returns nil if the property value is an empty string' do
-      property = 'test'
+    it 'removes whitespace from property names' do
+      bad_property_name = '  foo foo  '
+      property_name     = 'foofoo'
+      property_value    = 'bar'
+      properties        = { property_name => property_value }
+      git_result = "branch.#{@branch}.#{property_name} #{property_value}"
       Twig.should_receive(:run).
-        with(%{git config branch.#{@branch}.#{property}}).
-        and_return('')
+        with(%{git config --get-regexp "branch.#{@branch}.(#{property_name})$"}).
+        and_return(git_result)
 
-      result = @branch.get_property(property)
-      result.should == nil
+      result = @branch.get_properties([bad_property_name])
+      result.should == properties
     end
 
-    it 'raises an error if the property name is an empty string' do
-      property = ' '
+    it 'excludes properties whose values are empty strings' do
+      git_result = [
+        "branch.#{@branch}.test1 value1",
+        "branch.#{@branch}.test2"
+      ].join("\n")
+      Twig.should_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' }
+    end
+
+    it 'raises an error if any property name is an empty string' do
+      property_name = '  '
       Twig.should_not_receive(:run)
 
       begin
-        @branch.get_property(property)
+        @branch.get_properties(['test1', property_name])
       rescue Twig::Branch::EmptyPropertyNameError => exception
         expected_exception = exception
       end
@@ -152,6 +180,35 @@ describe Twig::Branch do
     end
   end
 
+  describe '#get_property' do
+    before :each do
+      @branch = Twig::Branch.new('test')
+    end
+
+    it 'returns a property value' do
+      property = 'test'
+      value    = 'value'
+      @branch.should_receive(:get_properties).
+        with([property]).
+        and_return(property => value)
+
+      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'
+      @branch.should_receive(:get_properties).
+        with([property]).
+        and_return(property => value)
+
+      result = @branch.get_property(bad_property)
+      result.should == value
+    end
+  end
+
   describe '#set_property' do
     before :each do
       @branch = Twig::Branch.new('test')