twig 1.0.0

data/lib/twig/cli.rb

@@ -0,0 +1,177 @@
+require 'optparse'
+
+class Twig
+  module Cli
+
+    def help_intro
+      version_string = "Twig v#{Twig::VERSION}"
+
+      <<-BANNER.gsub(/^[ ]+/, '')
+
+        #{version_string}
+        #{'-' * version_string.size}
+
+        Twig is your personal Git branch assistant. It shows you your most
+        recent branches, and tracks issue tracker ids, tasks, and other metadata
+        for your Git branches.
+
+        https://rondevera.github.com/twig
+
+      BANNER
+    end
+
+    def help_separator(option_parser, text)
+      option_parser.separator "\n#{text}\n\n"
+    end
+
+    def help_description(text, options={})
+      width = options[:width] || 40
+      text  = text.dup
+
+      # Split into lines
+      lines = []
+      until text.empty?
+        if text.size > width
+          split_index = text[0..width].rindex(' ') || width
+          lines << text.slice!(0, split_index)
+          text.strip!
+        else
+          lines << text.slice!(0..-1)
+        end
+      end
+
+      lines << ' ' if options[:add_separator]
+
+      lines
+    end
+
+    def read_cli_options!(args)
+      option_parser = OptionParser.new do |opts|
+        opts.banner         = help_intro
+        opts.summary_indent = ' ' * 2
+        opts.summary_width  = 32
+
+
+
+        help_separator(opts, 'Common options:')
+
+        desc = 'Use a specific branch.'
+        opts.on(
+          '-b BRANCH', '--branch BRANCH', *help_description(desc)
+        ) do |branch|
+          set_option(:branch, branch)
+        end
+
+        desc = 'Unset a branch property.'
+        opts.on('--unset PROPERTY', *help_description(desc)) do |property_name|
+          set_option(:unset_property, property_name)
+        end
+
+        desc = 'Show this help content.'
+        opts.on('--help', *help_description(desc)) do
+          puts opts; exit
+        end
+
+        desc = 'Show Twig version.'
+        opts.on('--version', *help_description(desc)) do
+          puts Twig::VERSION; exit
+        end
+
+
+
+        help_separator(opts, 'Filtering branches:')
+
+        desc = 'Only list branches whose name matches a given pattern.'
+        opts.on(
+          '--only-branch PATTERN',
+          *help_description(desc, :add_separator => true)
+        ) do |pattern|
+          set_option(:branch_only, pattern)
+        end
+
+        desc = 'Do not list branches whose name matches a given pattern.'
+        opts.on(
+          '--except-branch PATTERN',
+          *help_description(desc, :add_separator => true)
+        ) do |pattern|
+          set_option(:branch_except, pattern)
+        end
+
+        desc = 'Only list branches below a given age.'
+        opts.on(
+          '--max-days-old AGE', *help_description(desc, :add_separator => true)
+        ) do |age|
+          set_option(:max_days_old, age)
+        end
+
+        desc =
+          'Lists all branches regardless of age or name options. ' +
+          'Useful for overriding options in ' +
+          File.basename(Twig::Options::CONFIG_FILE) + '.'
+        opts.on('--all', *help_description(desc)) do |pattern|
+          unset_option(:max_days_old)
+          unset_option(:branch_except)
+          unset_option(:branch_only)
+        end
+
+        help_separator(opts, [
+          'You can put your most frequently used branch filtering options in',
+          "#{Twig::Options::CONFIG_FILE}. For example:",
+          '',
+          '      except-branch: staging',
+          '      max-days-old:  30'
+        ].join("\n"))
+      end
+
+      option_parser.parse!(args)
+    rescue OptionParser::InvalidOption, OptionParser::MissingArgument => exception
+      puts exception.to_s
+      puts 'For a list of options, run `twig --help`.'
+      exit
+    end
+
+    def read_cli_args!(args)
+      if args.any?
+        # Run subcommand binary, if any, and exit here
+        possible_subcommand_name = args[0]
+        command_path = Twig.run("which twig-#{possible_subcommand_name}")
+        unless command_path.empty?
+          command = ([command_path] + args[1..-1]).join(' ')
+          exec(command)
+        end
+      end
+
+      read_cli_options!(args)
+      branch_name = options[:branch] || current_branch_name
+      property_to_unset = options.delete(:unset_property)
+
+      # Handle remaining arguments, if any
+      if args.any?
+        property_name, property_value = args[0], args[1]
+
+        read_cli_options!(args)
+
+        # Get/set branch property
+        if property_value
+          # `$ twig <key> <value>`
+          puts set_branch_property(branch_name, property_name, property_value)
+        else
+          # `$ twig <key>`
+          value = get_branch_property(branch_name, property_name)
+          if value && !value.empty?
+            puts value
+          else
+            puts %{The branch "#{branch_name}" does not have the property "#{property_name}".}
+          end
+        end
+      elsif property_to_unset
+        # `$ twig --unset <key>`
+        puts unset_branch_property(branch_name, property_to_unset)
+      else
+        # `$ twig`
+        puts list_branches
+      end
+    end
+
+  end
+end

data/lib/twig/commit_time.rb

@@ -0,0 +1,32 @@
+class Twig
+  class CommitTime
+
+    def initialize(time, time_ago)
+      @time = time
+
+      # 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')
+    end
+
+    def to_i
+      @time.to_i
+    end
+
+    def to_s
+      time_string = @time.strftime('%F %R %z')
+      "#{time_string} (#{@time_ago})"
+    end
+
+    def <=>(other)
+      to_i <=> other.to_i
+    end
+
+  end
+end

data/lib/twig/display.rb

@@ -0,0 +1,116 @@
+class Twig
+  module Display
+    COLORS = {
+      :black  => 30,
+      :red    => 31,
+      :green  => 32,
+      :yellow => 33,
+      :blue   => 34,
+      :purple => 35,
+      :cyan   => 36,
+      :white  => 37
+    }
+    WEIGHTS = {
+      :normal => 0,
+      :bold   => 1
+    }
+    CURRENT_BRANCH_INDICATOR        = '* '
+    EMPTY_BRANCH_PROPERTY_INDICATOR = '-'
+
+    def column(string = ' ', num_columns = 1, column_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`:
+      # - `: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         = '... '
+
+      if string.size >= total_width
+        new_string[-omission.size, omission.size] = omission
+      else
+        new_string = ' ' * total_width
+        new_string[0, string.size] = string
+      end
+
+      new_string = format_string(
+        new_string,
+        column_options.reject { |k, v| ![:color, :weight].include?(k) }
+      )
+
+      new_string
+    end
+
+    def branch_list_headers(header_options = { :color => :blue })
+      columns_for_date_time    = 5
+      columns_per_property     = 2
+      branch_indicator_padding = ' ' * CURRENT_BRANCH_INDICATOR.size
+
+      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
+    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 = column(EMPTY_BRANCH_PROPERTY_INDICATOR) if property.empty?
+        result.merge(property_name => property)
+      end
+
+      line = column(branch.last_commit_time.to_s, 5)
+
+      line <<
+        Twig::Branch.all_properties.map do |property_name|
+          property = properties[property_name] || ''
+          column(property, 2)
+        end.join
+
+      line <<
+        if is_current_branch
+          CURRENT_BRANCH_INDICATOR + branch.to_s
+        else
+          (' ' * CURRENT_BRANCH_INDICATOR.size) + branch.to_s
+        end
+
+      line = format_string(line, :weight => :bold) if is_current_branch
+
+      line
+    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`.
+
+      string_options = []
+      string_options << COLORS[options[:color]] if options[:color]
+      string_options << WEIGHTS[options[:weight]] if options[:weight]
+      return string if string_options.empty?
+
+      "\033[#{string_options.join(';')}m#{string}\033[0m"
+    end
+  end # module Display
+end

data/lib/twig/options.rb

@@ -0,0 +1,55 @@
+class Twig
+  module Options
+
+    CONFIG_FILE = '~/.twigrc'
+
+    def read_config_file!
+      config_file_path = File.expand_path(Twig::CONFIG_FILE)
+      return unless File.readable?(config_file_path)
+
+      File.open(config_file_path) do |f|
+        opts = f.read.split("\n").inject({}) do |hsh, opt|
+          key, value = opt.split(':', 2)
+          hsh.merge(key.strip => value.strip)
+        end
+
+        opts.each do |key, value|
+          case key
+          when 'branch'        then set_option(:branch,        value)
+          when 'except-branch' then set_option(:branch_except, value)
+          when 'only-branch'   then set_option(:branch_only,   value)
+          when 'max-days-old'  then set_option(:max_days_old,  value)
+          end
+        end
+      end
+    end
+
+    def set_option(key, value)
+      case key
+      when :branch
+        if branch_names.include?(value)
+          options[:branch] = value
+        else
+          abort %{The branch "#{value}" could not be found.}
+        end
+      when :branch_except
+        options[:branch_except] = Regexp.new(value)
+      when :branch_only
+        options[:branch_only] = Regexp.new(value)
+      when :max_days_old
+        if Twig::Util.numeric?(value)
+          options[:max_days_old] = value.to_f
+        else
+          abort %{The value `--max-days-old=#{value}` is invalid.}
+        end
+      when :unset_property
+        options[:unset_property] = value
+      end
+    end
+
+    def unset_option(key)
+      options.delete(key)
+    end
+
+  end # module Options
+end

data/lib/twig/util.rb

@@ -0,0 +1,9 @@
+class Twig
+  module Util
+
+    def self.numeric?(value)
+      !!Float(value) rescue false
+    end
+
+  end
+end

data/lib/twig/version.rb

@@ -0,0 +1,3 @@
+class Twig
+  VERSION = '1.0.0'
+end

data/lib/twig.rb

@@ -0,0 +1,119 @@
+Dir[File.join(File.dirname(__FILE__), 'twig', '*')].each { |file| require file }
+require 'time'
+
+class Twig
+  include Cli
+  include Display
+  include Options
+
+  attr_accessor :options
+
+  REF_FORMAT_SEPARATOR = ','
+  REF_FORMAT = %w[refname committerdate committerdate:relative].
+                map { |field| '%(' + field + ')' }.join(REF_FORMAT_SEPARATOR)
+  REF_PREFIX = 'refs/heads/'
+
+  def self.run(command)
+    `#{command}`.strip
+  end
+
+  def initialize(options = {})
+    # Options:
+    # - :branch_except (Regexp)
+    # - :branch_only (Regexp)
+    # - :max_days_old (integer)
+
+    self.options = options
+  end
+
+  def repo?
+    Twig.run('git rev-parse')
+    $?.success?
+  end
+
+  def current_branch_name
+    @_current_branch_name ||=
+      Twig.run('git symbolic-ref -q HEAD').sub(%r{^#{ REF_PREFIX }}, '')
+  end
+
+  def all_branches
+    @_all_branches ||= begin
+      branch_tuples = Twig.
+        run(%{git for-each-ref #{ REF_PREFIX } --format="#{ REF_FORMAT }"}).
+        split("\n")
+
+      branch_tuples.inject([]) do |result, branch_tuple|
+        ref, time_string, time_ago = branch_tuple.split(REF_FORMAT_SEPARATOR)
+        name        = ref.sub(%r{^#{ REF_PREFIX }}, '')
+        time        = Time.parse(time_string)
+        commit_time = Twig::CommitTime.new(time, time_ago)
+        branch      = Branch.new(name, :last_commit_time => commit_time)
+        result << branch
+      end
+    end
+  end
+
+  def branches
+    branches = all_branches
+    now = Time.now
+    max_seconds_old = options[:max_days_old] * 86400 if options[:max_days_old]
+
+    branches.select do |branch|
+      if max_seconds_old
+        seconds_old = now.to_i - branch.last_commit_time.to_i
+        next if seconds_old > max_seconds_old
+      end
+
+      next if options[:branch_except] && branch.name =~ options[:branch_except]
+      next if options[:branch_only]   && branch.name !~ options[:branch_only]
+
+      true
+    end
+  end
+
+  def branch_names
+    branches.map { |branch| branch.name }
+  end
+
+
+
+  ### Actions ###
+
+  def list_branches
+    if branches.empty?
+      if all_branches.any?
+        return 'There are no branches matching your selected options.'
+      else
+        return 'This repository has no branches.'
+      end
+    end
+
+    out = "\n" << branch_list_headers
+
+    # List most recently modified branches first
+    listable_branches =
+      branches.sort_by { |branch| branch.last_commit_time }.reverse
+
+    branch_lines = listable_branches.inject([]) do |result, branch|
+      result << branch_list_line(branch)
+    end
+
+    out << branch_lines.join("\n")
+  end
+
+  def get_branch_property(branch_name, property_name)
+    branch = Branch.new(branch_name)
+    branch.get_property(property_name)
+  end
+
+  def set_branch_property(branch_name, property_name, value)
+    branch = Branch.new(branch_name)
+    branch.set_property(property_name, value)
+  end
+
+  def unset_branch_property(branch_name, property_name)
+    branch = Branch.new(branch_name)
+    branch.unset_property(property_name)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'twig'