twig 1.2.1 → 1.3

data/HISTORY.md

@@ -1,9 +1,22 @@
 Twig
 ====
 
+1.3 (2013-05-22)
+----------------
+* ENHANCEMENT: Add `--branch-width` and `--<property>-width` options for setting
+  custom column widths.
+* ENHANCEMENT: Add `--reverse` option for listing least recently updated
+  branches first. This can be used in a config file as `reverse: true`.
+* ENHANCEMENT: Make `gh-open` and `gh-open-issue` work cross-platform.
+  (GH-18. Thanks [ixti](https://github.com/ixti)!)
+* FIX: Allow getting, setting, and unsetting properties for branches older than
+  the `max-days-old` option, if given.
+* FIX: Abort `twig gh-*` subcommands early if working in a non-Github
+  repository.
+
 1.2.1 (2013-05-04)
 ------------------
-* FIX: Add User-Agent string to `twig-gh-update` GitHub requests to comply with
+* FIX: Add User-Agent string to `twig gh-update` GitHub requests to comply with
   GitHub API v3.
 
 1.2 (2013-03-21)

data/README.md

@@ -43,13 +43,21 @@ chronologically with their properties.
 * `twig <property> -b <branch>`:         Get property for any branch
 * `twig <property> <value> -b <branch>`: Set property for any branch
 * `twig --unset <property> -b <branch>`: Unset property for any branch
-* `twig --header-style <format>`:        Change the header style, e.g., "red", "green bold"
 * `twig init-completion`:                Set up tab completion for `-b` and `--branch`
 * `twig --help`:                         More info
 
 
-Filtering branches
-------------------
+Display options
+---------------
+
+* `twig --header-style <format>`:       Change the header style, e.g., "red", "green bold"
+* `twig --branch-width <number>`:       Set the character width for the `branch` column
+* `twig --<property>-width <number>`:   Set the character width for a specific property column
+* `twig --reverse`:                     List oldest branches first
+
+
+Filtering options
+-----------------
 
 Twig lists all of your branches by default (newest first), but you can filter
 them by age, name, and custom properties:
@@ -154,7 +162,6 @@ a browser window if possible:
 
     $ twig gh-open
     GitHub URL: https://github.com/myname/myproject
-    # Also opens a browser window (OS X only).
 
 If you're working on an issue for a GitHub repository, the `gh-update`
 subcommand syncs issue statuses with GitHub:
@@ -193,7 +200,6 @@ subcommand to view that issue on GitHub:
     # Current branch:
     $ twig gh-open-issue
     GitHub issue URL: https://github.com/myname/myproject/issues/111
-    # Also opens a browser window (OS X only).
 
     # Any branch:
     $ twig gh-open-issue -b <branch name>

data/bin/twig

@@ -2,13 +2,13 @@
 
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'twig'))
 
-twig = Twig.new
 repo_required = ARGV != ['--help'] && ARGV != ['help'] && ARGV != ['--version']
 
-if repo_required && !twig.repo?
+if repo_required && !Twig.repo?
   abort "Current directory is not a git repository."
 end
 
 # Gettin' twiggy wit' it.
+twig = Twig.new
 twig.read_config_file!
 twig.read_cli_args!(ARGV)

data/bin/twig-gh-open

@@ -5,10 +5,11 @@
 # Author: Ron DeVera <http://rondevera.com>
 
 require 'rubygems'
-require 'twig/github'
+require 'twig'
+require 'launchy'
 
 Twig::GithubRepo.new do |gh_repo|
   url = "https://github.com/#{gh_repo.username}/#{gh_repo.repository}"
   puts "GitHub URL: #{url}"
-  `which open && open #{url}`
+  Launchy.open(url) rescue nil
 end

data/bin/twig-gh-open-issue

@@ -10,6 +10,7 @@
 
 require 'rubygems'
 require 'twig'
+require 'launchy'
 
 Twig::GithubRepo.new do |gh_repo|
   twig = Twig.new
@@ -25,5 +26,5 @@ Twig::GithubRepo.new do |gh_repo|
   url << "/issues/#{issue_id}"
 
   puts "GitHub issue URL: #{url}"
-  `which open && open #{url}`
+  Launchy.open(url) rescue nil
 end

data/lib/twig.rb

@@ -18,6 +18,11 @@ class Twig
     `#{command}`.strip
   end
 
+  def self.repo?
+    Twig.run('git rev-parse 2>&1')
+    $?.success?
+  end
+
   def initialize
     self.options = {}
 
@@ -25,14 +30,8 @@ class Twig
     set_option(:header_style, DEFAULT_HEADER_COLOR.to_s)
   end
 
-  def repo?
-    Twig.run('git rev-parse 2>&1')
-    $?.success?
-  end
-
   def current_branch_name
-    @_current_branch_name ||=
-      Twig.run('git symbolic-ref -q HEAD').sub(%r{^#{ REF_PREFIX }}, '')
+    @_current_branch_name ||= Twig.run('git rev-parse --abbrev-ref HEAD')
   end
 
   def all_branches
@@ -84,8 +83,8 @@ class Twig
     end
   end
 
-  def branch_names
-    branches.map { |branch| branch.name }
+  def all_branch_names
+    all_branches.map { |branch| branch.name }
   end
 
 
@@ -103,9 +102,11 @@ class Twig
 
     out = "\n" << branch_list_headers(options)
 
-    # List most recently modified branches first
-    listable_branches =
-      branches.sort_by { |branch| branch.last_commit_time }.reverse
+    # List least recently modified branches first
+    listable_branches = branches.sort_by { |branch| branch.last_commit_time }
+    if options[:reverse] != true
+      listable_branches.reverse! # List most recently modified branches first
+    end
 
     branch_lines = listable_branches.inject([]) do |result, branch|
       result << branch_list_line(branch)

data/lib/twig/cli.rb

@@ -12,7 +12,7 @@ class Twig
         for your Git branches.
       })
 
-      <<-BANNER.gsub(/^[ ]+/, '')
+      intro = <<-BANNER.gsub(/^[ ]+/, '')
 
         #{version_string}
         #{'-' * version_string.size}
@@ -20,8 +20,9 @@ class Twig
         #{intro}
 
         #{Twig::HOMEPAGE}
-
       BANNER
+
+      intro + ' ' # Force extra blank line
     end
 
     def help_separator(option_parser, text, options={})
@@ -54,11 +55,47 @@ class Twig
       lines
     end
 
+    def help_description_for_custom_property(option_parser, desc_lines)
+      indent = '      '
+      left_column_width = 29
+
+      help_desc = desc_lines.inject('') do |desc, (left_column, right_column)|
+        desc + indent +
+        sprintf("%-#{left_column_width}s", left_column) + right_column + "\n"
+      end
+
+      help_separator(option_parser, help_desc, :trailing => "\n")
+    end
+
     def help_paragraph(text)
       help_description(text, :width => 80).join("\n")
     end
 
+    def help_line_for_custom_property?(line)
+      is_custom_property_except = (
+        line.include?('--except-') &&
+        !line.include?('--except-branch') &&
+        !line.include?('--except-PROPERTY')
+      )
+      is_custom_property_only = (
+        line.include?('--only-') &&
+        !line.include?('--only-branch') &&
+        !line.include?('--only-PROPERTY')
+      )
+      is_custom_property_width = (
+        line =~ /--.+-width/ &&
+        !line.include?('--branch-width') &&
+        !line.include?('--PROPERTY-width')
+      )
+
+      is_custom_property_except ||
+      is_custom_property_only ||
+      is_custom_property_width
+    end
+
     def read_cli_options!(args)
+      custom_properties = Twig::Branch.all_properties
+
       option_parser = OptionParser.new do |opts|
         opts.banner         = help_intro
         opts.summary_indent = ' ' * 2
@@ -82,22 +119,17 @@ class Twig
 
         desc = 'Show this help content.'
         opts.on('--help', *help_description(desc)) do
-          summary_lines = opts.to_a
+          summary_lines = opts.to_s.split("\n")
 
-          # Filter out `--only-PROPERTY` lines
+          # Filter out custom property lines
+          prev_line = nil
           summary_lines.each do |line|
-            is_custom_property_only = (
-              line.include?('--only-') &&
-              !line.include?('--only-branch') &&
-              !line.include?('--only-PROPERTY')
-            )
-            is_custom_property_except = (
-              line.include?('--except-') &&
-              !line.include?('--except-branch') &&
-              !line.include?('--except-PROPERTY')
-            )
-            unless is_custom_property_only || is_custom_property_except
+            # Squash successive blank lines
+            next if line == "\n" && prev_line == "\n"
+
+            unless help_line_for_custom_property?(line)
               puts line
+              prev_line = line
             end
           end
 
@@ -129,16 +161,10 @@ class Twig
         end
 
         desc = 'Do not list branches whose name matches a given pattern.'
-        opts.on(
-          '--except-branch PATTERN',
-          *help_description(desc, :add_separator => false)
-            # `:add_separator => false` skips the extra line generated by the
-            # custom property filters below.
-        ) do |pattern|
+        opts.on('--except-branch PATTERN', *help_description(desc)) do |pattern|
           set_option(:property_except, :branch => pattern)
         end
 
-        custom_properties = Twig::Branch.all_properties
         custom_properties.each do |property_name|
           opts.on("--only-#{property_name} PATTERN") do |pattern|
             set_option(:property_only, property_name.to_sym => pattern)
@@ -148,18 +174,14 @@ class Twig
             set_option(:property_except, property_name.to_sym => pattern)
           end
         end
-
-        custom_properties_desc_lines = [
+        help_description_for_custom_property(opts, [
           ['--only-PROPERTY PATTERN',   'Only list branches with a given property'],
           ['',                          'that matches a given pattern.'],
-          ['', ''],
+        ])
+        help_description_for_custom_property(opts, [
           ['--except-PROPERTY PATTERN', 'Do not list branches with a given property'],
           ['',                          'that matches a given pattern.']
-        ]
-        custom_properties_desc = custom_properties_desc_lines.inject('') do |desc, line_parts|
-          desc + sprintf('      %-29s', line_parts[0]) + line_parts[1] + "\n"
-        end
-        help_separator(opts, custom_properties_desc, :trailing => "\n")
+        ])
 
         desc =
           'Lists all branches regardless of other filtering options. ' +
@@ -175,11 +197,25 @@ class Twig
 
         help_separator(opts, 'Listing branches:')
 
+        desc = 'Set the width for the `branch` column.'
+        opts.on('--branch-width NUMBER', *help_description(desc)) do |width|
+          set_option(:property_width, :branch => width)
+        end
+
+        custom_properties.each do |property_name|
+          opts.on("--#{property_name}-width NUMBER") do |width|
+            set_option(:property_width, property_name.to_sym => width)
+          end
+        end
+        help_description_for_custom_property(opts, [
+          ['--PROPERTY-width NUMBER', "Set the width for a given property's column."]
+        ])
+
         colors = Twig::Display::COLORS.keys.map do |value|
-          format_string(value, { :color => value })
+          format_string(value, :color => value)
         end.join(', ')
         weights = Twig::Display::WEIGHTS.keys.map do |value|
-          format_string(value, { :weight => value })
+          format_string(value, :weight => value)
         end.join(' and ')
         default_color = format_string(
           Twig::DEFAULT_HEADER_COLOR.to_s,
@@ -190,10 +226,18 @@ class Twig
           Valid colors are #{colors}. Valid weights are #{weights}.
           The default is "#{default_color}".
         DESC
-        opts.on('--header-style "STYLE"', *help_description(desc)) do |style|
+        opts.on(
+          '--header-style "STYLE"',
+          *help_description(desc, :add_separator => true)
+        ) do |style|
           set_option(:header_style, style)
         end
 
+        desc = 'Show oldest branches first.'
+        opts.on('--reverse', *help_description(desc)) do
+          set_option(:reverse, true)
+        end
+
 
 
         help_separator(opts, help_paragraph(%{

data/lib/twig/display.rb

@@ -14,41 +14,58 @@ class Twig
       :normal => 0,
       :bold   => 1
     }
+    DEFAULT_PROPERTY_COLUMN_WIDTH = 16
+    DEFAULT_BRANCH_COLUMN_WIDTH   = 48
     CURRENT_BRANCH_INDICATOR        = '* '
     EMPTY_BRANCH_PROPERTY_INDICATOR = '-'
 
-    def column(string = ' ', num_columns = 1, column_options = {})
+    def column(string, options = {})
       # Returns `string` with an exact fixed width. If `string` is too wide, it
       # is truncated with an ellipsis and a trailing space to separate columns.
       #
-      # `column_options`:
+      # `options`:
       # - `:color`:  `nil` by default. Accepts a key from `COLORS`.
       # - `:weight`: `nil` by default. Accepts a key from `WEIGHTS`.
       # - `:width`:  8 (characters) by default.
 
-      width_per_column = column_options[:width] || 8
-      total_width      = num_columns * width_per_column
-      new_string       = string[0, total_width]
-      omission         = '... '
+      string ||= ' '
+      width      = options[:width] || 8
+      new_string = string[0, width]
+      omission   = '...'
 
-      if string.size >= total_width
+      if string.size > width
         new_string[-omission.size, omission.size] = omission
       else
-        new_string = ' ' * total_width
+        new_string = ' ' * width
         new_string[0, string.size] = string
       end
 
       new_string = format_string(
         new_string,
-        column_options.reject { |k, v| ![:color, :weight].include?(k) }
+        options.reject { |k, v| ![:color, :weight].include?(k) }
       )
 
       new_string
     end
 
+    def date_time_column_width; 35; end
+    def column_gutter; '  '; end
+
+    def property_column_width(property_name = nil)
+      if property_name && options[:property_width]
+        width = options[:property_width][property_name.to_sym]
+      end
+
+      if width
+        width
+      elsif property_name == :branch
+        Twig::Display::DEFAULT_BRANCH_COLUMN_WIDTH
+      else
+        Twig::Display::DEFAULT_PROPERTY_COLUMN_WIDTH
+      end
+    end
+
     def branch_list_headers(header_options = {})
-      columns_for_date_time    = 5
-      columns_per_property     = 2
       branch_indicator_padding = ' ' * CURRENT_BRANCH_INDICATOR.size
 
       header_options.merge!(
@@ -62,22 +79,22 @@ class Twig
         end
       )
 
-      out =
-        column(' ', columns_for_date_time) <<
-        Twig::Branch.all_properties.map do |property|
-          column(property, columns_per_property, header_options)
-        end.join <<
-        column(branch_indicator_padding + 'branch',
-          columns_per_property, header_options) <<
-        "\n"
-      out <<
-        column(' ', columns_for_date_time) <<
-        Twig::Branch.all_properties.map do |property|
-          column('-' * property.size, columns_per_property, header_options)
-        end.join <<
-        column(branch_indicator_padding + '------',
-          columns_per_property, header_options) <<
-        "\n"
+      out = column(' ', :width => date_time_column_width) << column_gutter
+      out << Twig::Branch.all_properties.map do |property|
+        width = property_column_width(property)
+        column(property, header_options.merge(:width => width)) << column_gutter
+      end.join
+      out << column(branch_indicator_padding + 'branch', header_options)
+      out << "\n"
+
+      out << column(' ', :width => date_time_column_width) << column_gutter
+      out << Twig::Branch.all_properties.map do |property|
+        width = property_column_width(property)
+        underline = '-' * property.size
+        column(underline, header_options.merge(:width => width)) << column_gutter
+      end.join
+      out << column(branch_indicator_padding + '------', header_options)
+      out << "\n"
 
       out
     end
@@ -87,24 +104,29 @@ class Twig
 
       properties = Twig::Branch.all_properties.inject({}) do |result, property_name|
         property = (get_branch_property(branch.name, property_name) || '').strip
-        property = column(EMPTY_BRANCH_PROPERTY_INDICATOR) if property.empty?
+        property = EMPTY_BRANCH_PROPERTY_INDICATOR if property.empty?
         property.gsub!(/[\n\r]+/, ' ')
         result.merge(property_name => property)
       end
 
-      line = column(branch.last_commit_time.to_s, 5)
+      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|
-          property = properties[property_name] || ''
-          column(property, 2)
+          property_value = properties[property_name] || ''
+          width = property_column_width(property_name)
+          column(property_value, :width => width) << column_gutter
         end.join
 
+      branch_column_width = property_column_width(:branch)
+      branch_column = column(branch.to_s, :width => branch_column_width)
+      branch_column.strip! # Strip final column
       line <<
         if is_current_branch
-          CURRENT_BRANCH_INDICATOR + branch.to_s
+          CURRENT_BRANCH_INDICATOR + branch_column
         else
-          (' ' * CURRENT_BRANCH_INDICATOR.size) + branch.to_s
+          (' ' * CURRENT_BRANCH_INDICATOR.size) + branch_column
         end
 
       line = format_string(line, :weight => :bold) if is_current_branch