twig 1.6 → 1.7

data/lib/twig/cli/help.rb

@@ -0,0 +1,174 @@
+class Twig
+  module Cli
+    # Handles printing help output for `twig help`.
+    module Help
+      def self.console_width
+        80
+      end
+
+      def self.intro
+        version_string = "Twig v#{Twig::VERSION}"
+
+        intro = Help.paragraph(%{
+          Twig is your personal Git branch assistant. It's a command-line tool
+          for listing your most recent branches, and for remembering branch
+          details for you, like issue tracker ids and todos. It also supports
+          subcommands, like automatically fetching statuses from your issue
+          tracking system.
+        })
+
+        intro = <<-BANNER.gsub(/^[ ]+/, '')
+
+          #{'=' * version_string.size}
+          #{version_string}
+          #{'=' * version_string.size}
+
+          #{intro}
+
+          #{Twig::HOMEPAGE}
+        BANNER
+
+        intro + ' ' # Force extra blank line
+      end
+
+      def self.description(text, options = {})
+        defaults = {
+          :add_blank_line => false,
+          :width => 40
+        }
+        options = defaults.merge(options)
+
+        width = options[:width]
+        words = text.gsub(/\n?\s+/, ' ').strip.split(' ')
+        lines = []
+
+        # Split words into lines
+        while words.any?
+          current_word      = words.shift
+          current_word_size = Display.unformat_string(current_word).size
+          last_line         = lines.last
+          last_line_size    = last_line && Display.unformat_string(last_line).size
+
+          if last_line_size && (last_line_size + current_word_size + 1 <= width)
+            last_line << ' ' << current_word
+          elsif current_word_size >= width
+            lines << current_word[0...width]
+            words.unshift(current_word[width..-1])
+          else
+            lines << current_word
+          end
+        end
+
+        lines << ' ' if options[:add_blank_line]
+        lines
+      end
+
+      def self.description_for_custom_property(option_parser, desc_lines, options = {})
+        options[:trailing] ||= "\n"
+        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.print_section(option_parser, help_desc, :trailing => options[:trailing])
+      end
+
+      def self.line_for_custom_property?(line)
+        is_custom_property_except = (
+          line.include?('--except-') &&
+          !line.include?('--except-branch') &&
+          !line.include?('--except-property') &&
+          !line.include?('--except-PROPERTY')
+        )
+        is_custom_property_only = (
+          line.include?('--only-') &&
+          !line.include?('--only-branch') &&
+          !line.include?('--only-property') &&
+          !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 self.paragraph(text)
+        Help.description(text, :width => console_width).join("\n")
+      end
+
+      def self.print_line(option_parser, text)
+        # Prints a single line of text without line breaks.
+        option_parser.separator(text)
+      end
+
+      def self.print_paragraph(option_parser, text, separator_options = {})
+        # Prints a long chunk of text with automatic word wrapping and a leading
+        # line break.
+
+        separator_options[:trailing] ||= ''
+        Help.print_section(option_parser, Help.paragraph(text), separator_options)
+      end
+
+      def self.print_section(option_parser, text, options = {})
+        # Prints text with leading and trailing line breaks.
+
+        options[:trailing] ||= ''
+        option_parser.separator "\n#{text}#{options[:trailing]}"
+      end
+
+      def self.subcommand_descriptions
+        descs = {
+          'checkout-child'  => 'Checks out a branch\'s child branch, if any.',
+          'checkout-parent' => 'Checks out a branch\'s parent branch.',
+          'create-branch'   => 'Creates a branch and sets its `diff-branch` property to the previous branch name.',
+          'diff'            => 'Shows the diff between a branch and its parent branch (`diff-branch`).',
+          'gh-open'         => 'Opens a browser window for the current GitHub repository.',
+          'gh-open-issue'   => 'Opens a browser window for a branch\'s GitHub issue, if any.',
+          'gh-update'       => 'Updates each branch with the latest issue status on GitHub.',
+          'help'            => 'Provides help for Twig and its subcommands.',
+          'init'            => 'Runs all Twig setup commands.',
+          'init-completion' => 'Initializes tab completion for Twig. Runs as part of `twig init`.',
+          'init-config'     => 'Creates a default `~/.twigconfig` file. Runs as part of `twig init`.',
+          'rebase'          => 'Rebases a branch onto its parent branch (`diff-branch`).'
+        }
+
+        line_prefix    = '- '
+        gutter_width   = 2 # Space between columns
+        names          = descs.keys.sort
+        max_name_width = names.map { |name| name.length }.max
+        names_width    = max_name_width + gutter_width
+        descs_width    = Help.console_width - line_prefix.length - names_width
+        desc_indent    = ' ' * (names_width + line_prefix.length)
+
+        names.map do |name|
+          line_prefix +
+          sprintf("%-#{names_width}s", name) +
+          Help.description(descs[name], :width => descs_width).join("\n" + desc_indent)
+        end
+      end
+
+      def self.header(option_parser, text, separator_options = {}, header_options = {})
+        separator_options[:trailing] ||= "\n\n"
+        header_options[:underline]   ||= '='
+
+        Help.print_section(
+          option_parser,
+          text + "\n" + (header_options[:underline] * text.size),
+          separator_options
+        )
+      end
+
+      def self.subheader(option_parser, text, separator_options = {})
+        header(option_parser, text, separator_options, :underline => '-')
+      end
+    end
+  end
+end

data/lib/twig/commit_time.rb

@@ -2,23 +2,79 @@ class Twig
 
   # Stores a branch's last commit time and its relative time representation.
   class CommitTime
+    def self.now
+      Time.now
+    end
 
-    def initialize(time, time_ago)
+    def initialize(time)
       @time = time
+      suffix = 'ago'
+
+      # Cache calculations against current time
+      years_ago   = count_years_ago
+      months_ago  = count_months_ago
+      weeks_ago   = count_weeks_ago
+      days_ago    = count_days_ago
+      hours_ago   = count_hours_ago
+      minutes_ago = count_minutes_ago
+      seconds_ago = count_seconds_ago
+
+      @time_ago =
+        if years_ago > 0
+          "#{years_ago}y"
+        elsif months_ago > 0 and weeks_ago > 4
+          "#{months_ago}mo"
+        elsif weeks_ago > 0
+          "#{weeks_ago}w"
+        elsif days_ago > 0
+          "#{days_ago}d"
+        elsif hours_ago > 0
+          "#{hours_ago}h"
+        elsif minutes_ago > 0
+          "#{minutes_ago}m"
+        else
+          "#{seconds_ago}s"
+        end
+      @time_ago << ' ' << suffix
+    end
+
+    def count_years_ago
+      seconds_in_a_year = 60 * 60 * 24 * 365
+      seconds = CommitTime.now - @time
+      seconds < seconds_in_a_year ? 0 : (seconds / seconds_in_a_year).round
+    end
+
+    def count_months_ago
+      now = CommitTime.now
+      (now.year * 12 + now.month) - (@time.year * 12 + @time.month)
+    end
 
-      # Shorten relative time
-      @time_ago = time_ago.
-        sub(/ years?/,  'y').
-        sub(' months',  'mo').
-        sub(' weeks',   'w').
-        sub(' days',    'd').
-        sub(' hours',   'h').
-        sub(' minutes', 'm').
-        sub(' seconds', 's')
+    def count_weeks_ago
+      seconds_in_a_week = 60 * 60 * 24 * 7
+      seconds = CommitTime.now - @time
+      seconds < seconds_in_a_week ? 0 : (seconds / seconds_in_a_week).round
+    end
+
+    def count_days_ago
+      seconds_in_a_day = 60 * 60 * 24
+      seconds = CommitTime.now - @time
+      seconds < seconds_in_a_day ? 0 : (seconds / seconds_in_a_day).round
+    end
+
+    def count_hours_ago
+      seconds_in_an_hour = 60 * 60
+      seconds = CommitTime.now - @time
+      seconds < seconds_in_an_hour ? 0 : (seconds / seconds_in_an_hour).round
+    end
+
+    def count_minutes_ago
+      seconds_in_a_minute = 60
+      seconds = CommitTime.now - @time
+      seconds < seconds_in_a_minute ? 0 : (seconds / seconds_in_a_minute).round
+    end
 
-      # 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(/,/, '')
+    def count_seconds_ago
+      (CommitTime.now - @time).to_i
     end
 
     def to_i
@@ -37,6 +93,5 @@ class Twig
     def <=>(other)
       to_i <=> other.to_i
     end
-
   end
 end

data/lib/twig/display.rb

@@ -1,4 +1,7 @@
 class Twig
+
+  # Handles displaying matching branches as a command-line table or as
+  # serialized data.
   module Display
     COLORS = {
       :black  => 30,
@@ -19,6 +22,11 @@ class Twig
     CURRENT_BRANCH_INDICATOR        = '* '
     EMPTY_BRANCH_PROPERTY_INDICATOR = '-'
 
+    def self.unformat_string(string)
+      # Returns a copy of the given string without color/weight markers.
+      string.gsub(/\e\[[0-9]+(;[0-9]+)?m/, '')
+    end
+
     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.
@@ -42,7 +50,7 @@ class Twig
 
       new_string = format_string(
         new_string,
-        options.reject { |k, v| ![:color, :weight].include?(k) }
+        options.reject { |key, value| ![:color, :weight].include?(key) }
       )
 
       new_string
@@ -144,11 +152,20 @@ class Twig
       data.to_json
     end
 
+    def format_strings?
+      !Twig::System.windows?
+    end
+
     def format_string(string, options)
       # Options:
       # - `:color`:  `nil` by default. Accepts a key from `COLORS`.
       # - `:weight`: `nil` by default. Accepts a key from `WEIGHTS`.
 
+      # Unlike `::unformat_string`, this is an instance method so that it can
+      # handle config options, e.g., globally disabling color.
+
+      return string unless format_strings?
+
       string_options = []
       string_options << COLORS[options[:color]] if options[:color]
       string_options << WEIGHTS[options[:weight]] if options[:weight]
@@ -159,9 +176,5 @@ class Twig
 
       open_format + string.to_s + close_format
     end
-
-    def unformat_string(string)
-      string.gsub(/\e\[[0-9]+(;[0-9]+)?m/, '')
-    end
-  end # module Display
+  end
 end

data/lib/twig/github.rb

@@ -1,14 +1,20 @@
 require 'uri'
 
 class Twig
+
+  # Represents a Git repository that is hosted on GitHub. Usage:
+  #
+  #     Twig::GithubRepo.new do |gh_repo|
+  #       puts gh_repo.username
+  #       puts gh_repo.repository
+  #     end
+  #
   class GithubRepo
     def initialize
-      unless Twig.repo?
-        abort 'Current directory is not a git repository.'
-      end
+      abort 'Current directory is not a git repository.' unless Twig.repo?
 
       if origin_url.empty? || !github_repo? || username.empty? || repository.empty?
-        abort_for_non_github_repo
+        abort 'This does not appear to be a GitHub repository.'
       end
 
       yield(self)
@@ -35,9 +41,5 @@ class Twig
     def repository
       @repo ||= origin_url_parts[-1].sub(/\.git$/, '') || ''
     end
-
-    def abort_for_non_github_repo
-      abort 'This does not appear to be a GitHub repository.'
-    end
   end
 end

data/lib/twig/options.rb

@@ -1,6 +1,7 @@
 class Twig
-  module Options
 
+  # Handles reading options from command-line switches and config files.
+  module Options
     CONFIG_PATH = '~/.twigconfig'
     DEPRECATED_CONFIG_PATH = '~/.twigrc'
     MIN_PROPERTY_WIDTH = 3
@@ -8,7 +9,7 @@ class Twig
     def readable_config_file_path
       config_path = File.expand_path(CONFIG_PATH)
 
-      if File.exists?(config_path)
+      if File.exist?(config_path)
         unless File.readable?(config_path)
           $stderr.puts "Warning: #{CONFIG_PATH} is not readable."
           return # Stop if file exists but is not readable
@@ -16,12 +17,12 @@ class Twig
       else
         config_path = File.expand_path(DEPRECATED_CONFIG_PATH)
 
-        if File.exists?(config_path)
+        if File.exist?(config_path)
           if File.readable?(config_path)
-            $stderr.puts "DEPRECATED: #{DEPRECATED_CONFIG_PATH} is deprecated. " <<
+            $stderr.puts "DEPRECATED: #{DEPRECATED_CONFIG_PATH} is deprecated. " \
               "Please rename it to #{CONFIG_PATH}."
           else
-            $stderr.puts "DEPRECATED: #{DEPRECATED_CONFIG_PATH} is deprecated. " <<
+            $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
@@ -50,8 +51,8 @@ class Twig
         if !key.empty? && value
           opts[key] = value.strip
         elsif !line.empty?
-          $stderr.puts %{Warning: Invalid line "#{line}" in #{config_path}. } <<
-            %{Expected format: `key: value`}
+          $stderr.puts %{Warning: Invalid line "#{line}" in #{config_path}. } \
+            'Expected format: `key: value`'
         end
 
         opts
@@ -99,6 +100,10 @@ class Twig
         when 'github-uri-prefix'
           set_option(:github_uri_prefix, value)
 
+        # Subcommands:
+        when 'twig-rebase-autoconfirm'
+          set_option(:twig_rebase_autoconfirm, value)
+
         end
       end
     end
@@ -148,6 +153,9 @@ class Twig
       when :reverse
         options[:reverse] = Twig::Util.truthy?(value)
 
+      when :twig_rebase_autoconfirm
+        options[:twig_rebase_autoconfirm] = Twig::Util.truthy?(value)
+
       when :unset_property
         options[key] = value
       end
@@ -187,11 +195,12 @@ class Twig
         min_property_value = [property_name_width, MIN_PROPERTY_WIDTH].max
 
         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
+          min_desc =
+            if property_value < property_name_width
+              %{#{property_name_width} (width of "#{property_name}")}
+            else
+              MIN_PROPERTY_WIDTH.to_s
+            end
 
           error = %{The value `--#{property_name}-width=#{property_value}` } +
             %{is too low. The minimum is #{min_desc}.}
@@ -206,6 +215,5 @@ class Twig
     def unset_option(key)
       options.delete(key)
     end
-
-  end # module Options
+  end
 end