twig 1.1 → 1.2

data/HISTORY.md

@@ -1,6 +1,17 @@
 Twig
 ====
 
+1.2 (2013-03-21)
+----------------
+* ENHANCEMENT: Add `--only-<property>` and `--except-<property>` options for
+  filtering custom properties by value.
+* ENHANCEMENT: Simplify setup for writing GitHub-related Twig subcommands.
+* FIX: Fix showing `twig --help` outside of a Git repository. (GH-16. Thanks
+  [ryangreenberg](https://github.com/ryangreenberg)!)
+* FIX: Fix showing `twig --version` outside of a Git repository.
+* FIX: Fix the project's homepage URL in `twig --help`. (GH-17. Thanks
+  [ryangreenberg](https://github.com/ryangreenberg)!)
+
 1.1 (2013-03-06)
 ----------------
 * ENHANCEMENT: Add branch name tab completion for `-b` and `--branch` options.

data/README.md

@@ -52,14 +52,18 @@ Filtering branches
 ------------------
 
 Twig lists all of your branches by default (newest first), but you can filter
-them by name and age:
+them by age, name, and custom properties:
 
+* `twig --max-days-old <age>`:
+  Only list branches below a given age
 * `twig --only-branch <pattern>`:
   Only list branches whose name matches a given pattern
 * `twig --except-branch <pattern>`:
   Don't list branches whose name matches a given pattern
-* `twig --max-days-old <age>`:
-  Only list branches below a given age
+* `twig --only-<property> <pattern>`:
+  Only list branches with a given property that matches a given pattern
+* `twig --except-<property> <pattern>`:
+  Don't list branches with a given property that matches a given pattern
 * `twig --all`:
   List all branches regardless of other filtering options
 

data/bin/twig

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

data/bin/twig-gh-open

@@ -4,37 +4,10 @@
 #
 # Author: Ron DeVera <http://rondevera.com>
 
-class TwigGithubRepo
-  def initialize
-    if origin_url.empty? || username.empty? || repository.empty?
-      abort_for_non_github_repo
-    end
+require 'rubygems'
+require 'twig/github'
 
-    yield(self)
-  end
-
-  def origin_url
-    @origin_url ||= `git config remote.origin.url`.strip
-  end
-
-  def origin_url_parts
-    @origin_url_parts ||= origin_url.split(/[\/:]/)
-  end
-
-  def username
-    @username ||= origin_url_parts[-2] || ''
-  end
-
-  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
-
-TwigGithubRepo.new do |gh_repo|
+Twig::GithubRepo.new do |gh_repo|
   url = "https://github.com/#{gh_repo.username}/#{gh_repo.repository}"
   puts "GitHub URL: #{url}"
   `which open && open #{url}`

data/bin/twig-gh-open-issue

@@ -11,37 +11,7 @@
 require 'rubygems'
 require 'twig'
 
-class TwigGithubRepo
-  def initialize
-    if origin_url.empty? || username.empty? || repository.empty?
-      abort_for_non_github_repo
-    end
-
-    yield(self)
-  end
-
-  def origin_url
-    @origin_url ||= `git config remote.origin.url`.strip
-  end
-
-  def origin_url_parts
-    @origin_url_parts ||= origin_url.split(/[\/:]/)
-  end
-
-  def username
-    @username ||= origin_url_parts[-2] || ''
-  end
-
-  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
-
-TwigGithubRepo.new do |gh_repo|
+Twig::GithubRepo.new do |gh_repo|
   twig = Twig.new
   twig.read_cli_options!(ARGV)
   branch_name = twig.options[:branch] || twig.current_branch_name

data/bin/twig-gh-update

@@ -10,41 +10,11 @@ require 'json'
 require 'net/https'
 require 'uri'
 
-class TwigGithubRepo
-  def initialize
-    if origin_url.empty? || username.empty? || repository.empty?
-      abort_for_non_github_repo
-    end
-
-    yield(self)
-  end
-
-  def origin_url
-    @origin_url ||= `git config remote.origin.url`.strip
-  end
-
-  def origin_url_parts
-    @origin_url_parts ||= origin_url.split(/[\/:]/)
-  end
-
-  def username
-    @username ||= origin_url_parts[-2] || ''
-  end
-
-  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
-
 twig = Twig.new
 twig.read_config_file!
 twig.read_cli_options!(ARGV)
 
-TwigGithubRepo.new do |gh_repo|
+Twig::GithubRepo.new do |gh_repo|
   $stdout.sync = true
   print 'Getting latest states for GitHub issues...'
 

data/lib/twig.rb

@@ -26,7 +26,7 @@ class Twig
   end
 
   def repo?
-    Twig.run('git rev-parse')
+    Twig.run('git rev-parse 2>&1')
     $?.success?
   end
 
@@ -57,15 +57,30 @@ class Twig
     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
+      catch :skip_branch do
+        if max_seconds_old
+          seconds_old = now.to_i - branch.last_commit_time.to_i
+          next if seconds_old > max_seconds_old
+        end
+
+        (options[:property_except] || {}).each do |property_name, property_value|
+          if property_name == :branch
+            throw :skip_branch if branch.name =~ property_value
+          elsif branch.get_property(property_name.to_s) =~ property_value
+            throw :skip_branch
+          end
+        end
+
+        (options[:property_only] || {}).each do |property_name, property_value|
+          if property_name == :branch
+            throw :skip_branch if branch.name !~ property_value
+          elsif branch.get_property(property_name.to_s) !~ property_value
+            throw :skip_branch
+          end
+        end
+
+        true
       end
-
-      next if options[:branch_except] && branch.name =~ options[:branch_except]
-      next if options[:branch_only]   && branch.name !~ options[:branch_only]
-
-      true
     end
   end
 

data/lib/twig/cli.rb

@@ -19,7 +19,7 @@ class Twig
 
         #{intro}
 
-        https://rondevera.github.com/twig
+        http://rondevera.github.com/twig
 
       BANNER
     end
@@ -37,8 +37,8 @@ class Twig
       # Split words into lines
       while words.any?
         current_word = words.shift
-        current_word_size = formatted_string_display_size(current_word)
-        last_line_size = lines.last && formatted_string_display_size(lines.last)
+        current_word_size = unformat_string(current_word).size
+        last_line_size = lines.last && unformat_string(lines.last).size
 
         if last_line_size && (last_line_size + current_word_size + 1 <= width)
           lines.last << ' ' << current_word
@@ -82,7 +82,26 @@ class Twig
 
         desc = 'Show this help content.'
         opts.on('--help', *help_description(desc)) do
-          puts opts; exit
+          summary_lines = opts.to_a
+
+          # Filter out `--only-PROPERTY` lines
+          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
+              puts line
+            end
+          end
+
+          exit
         end
 
         desc = 'Show Twig version.'
@@ -94,37 +113,62 @@ class Twig
 
         help_separator(opts, 'Filtering branches:')
 
+        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 = '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)
+          set_option(:property_only, :branch => pattern)
         end
 
         desc = 'Do not list branches whose name matches a given pattern.'
         opts.on(
           '--except-branch PATTERN',
-          *help_description(desc, :add_separator => true)
+          *help_description(desc, :add_separator => false)
+            # `:add_separator => false` skips the extra line generated by the
+            # custom property filters below.
         ) do |pattern|
-          set_option(:branch_except, pattern)
+          set_option(:property_except, :branch => 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)
+        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)
+          end
+
+          opts.on("--except-#{property_name} PATTERN") do |pattern|
+            set_option(:property_except, property_name.to_sym => pattern)
+          end
         end
 
+        custom_properties_desc_lines = [
+          ['--only-PROPERTY PATTERN',   'Only list branches with a given property'],
+          ['',                          'that matches a given pattern.'],
+          ['', ''],
+          ['--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 age or name options. ' +
+          'Lists all branches regardless of other filtering 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)
+          unset_option(:property_except)
+          unset_option(:property_only)
         end
 
 
@@ -171,7 +215,11 @@ class Twig
 
       option_parser.parse!(args)
     rescue OptionParser::InvalidOption, OptionParser::MissingArgument => exception
-      puts exception.to_s
+      abort_for_option_exception(exception)
+    end
+
+    def abort_for_option_exception(exception)
+      puts exception.message
       puts 'For a list of options, run `twig --help`.'
       exit
     end
@@ -200,36 +248,49 @@ class Twig
         # Get/set branch property
         if property_value
           # `$ twig <key> <value>`
-          begin
-            puts set_branch_property(branch_name, property_name, property_value)
-          rescue ArgumentError, RuntimeError => exception
-            abort exception.message
-          end
+          set_branch_property_for_cli(branch_name, property_name, property_value)
         else
           # `$ twig <key>`
-          begin
-            value = get_branch_property(branch_name, property_name)
-            if value
-              puts value
-            else
-              abort %{The branch "#{branch_name}" does not have the property "#{property_name}".}
-            end
-          rescue ArgumentError => exception
-            abort exception.message
-          end
+          get_branch_property_for_cli(branch_name, property_name)
         end
       elsif property_to_unset
         # `$ twig --unset <key>`
-        begin
-          puts unset_branch_property(branch_name, property_to_unset)
-        rescue ArgumentError, Twig::Branch::MissingPropertyError => exception
-          abort exception.message
-        end
+        unset_branch_property_for_cli(branch_name, property_to_unset)
       else
         # `$ twig`
         puts list_branches
       end
     end
 
+    def get_branch_property_for_cli(branch_name, property_name)
+      begin
+        value = get_branch_property(branch_name, property_name)
+        if value
+          puts value
+        else
+          raise Twig::Branch::MissingPropertyError,
+            %{The branch "#{branch_name}" does not have the property "#{property_name}".}
+        end
+      rescue ArgumentError, Twig::Branch::MissingPropertyError => exception
+        abort exception.message
+      end
+    end
+
+    def set_branch_property_for_cli(branch_name, property_name, property_value)
+      begin
+        puts set_branch_property(branch_name, property_name, property_value)
+      rescue ArgumentError, RuntimeError => exception
+        abort exception.message
+      end
+    end
+
+    def unset_branch_property_for_cli(branch_name, property_name)
+      begin
+        puts unset_branch_property(branch_name, property_name)
+      rescue ArgumentError, Twig::Branch::MissingPropertyError => exception
+        abort exception.message
+      end
+    end
+
   end
 end

data/lib/twig/display.rb

@@ -125,8 +125,8 @@ class Twig
       "\e[#{string_options.join(';')}m#{string}\e[0m"
     end
 
-    def formatted_string_display_size(string)
-      string.gsub(/\e\[[0-9]+(;[0-9]+)?m/, '').size
+    def unformat_string(string)
+      string.gsub(/\e\[[0-9]+(;[0-9]+)?m/, '')
     end
   end # module Display
 end

data/lib/twig/github.rb

@@ -0,0 +1,36 @@
+class Twig
+  class GithubRepo
+    def self.run(command)
+      # Duplicated from `Twig.run` for making lightweight subcommands.
+      `#{command}`.strip
+    end
+
+    def initialize
+      if origin_url.empty? || username.empty? || repository.empty?
+        abort_for_non_github_repo
+      end
+
+      yield(self)
+    end
+
+    def origin_url
+      @origin_url ||= Twig::GithubRepo.run('git config remote.origin.url')
+    end
+
+    def origin_url_parts
+      @origin_url_parts ||= origin_url.split(/[\/:]/)
+    end
+
+    def username
+      @username ||= origin_url_parts[-2] || ''
+    end
+
+    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