twig 1.0.0

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+Gemfile.lock
+_site/

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.8.7-p358@twig --create

data/CONTRIBUTING.md

@@ -0,0 +1,26 @@
+How to contribute
+=================
+
+Let's make life easier for people with lots of Git branches.
+
+Found a bug or have a suggestion? [Please open an issue][issues] or ping
+[@ronalddevera on Twitter][twitter].
+
+If you want to hack on some code, even better! Here are the basics:
+
+1.  Fork the Twig repo.
+2.  Check out the [**`development`** branch][dev branch]; the `master` branch is
+    for stable builds only.
+3.  Run the tests to make sure that they pass on your machine: `bundle && rake`
+4.  Add one or more failing tests for your feature or bug fix.
+5.  Write your feature or bug fix to make the test(s) pass.
+6.  Test the change manually:
+    1.  `gem build twig.gemspec`
+    2.  `gem install twig-x.y.z.gem` (fill in the current version number)
+7.  Push to your fork and submit a pull request.
+
+Thanks for contributing!
+
+[issues]:     https://github.com/rondevera/twig/issues
+[twitter]:    https://twitter.com/ronalddevera
+[dev branch]: https://github.com/rondevera/twig/commits/development

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/HISTORY.md

@@ -0,0 +1,6 @@
+Twig
+====
+
+1.0
+---
+* Initial release.

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ron DeVera
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,232 @@
+Twig: Your personal Git branch assistant.
+=========================================
+
+It's hard enough trying to remember the names of all of your Git branches. You
+also need those branches' issue tracker ids, issue statuses, and reminders of
+what to do next with each branch. `git branch` only lists them in alphabetical
+order, which just doesn't cut it.
+
+**Twig shows you your most recent branches, and remembers branch details for
+you.** It supports subcommands, like automatically fetching statuses from your
+issue tracking system. It's flexible enough to fit your everyday Git workflow,
+and will save you a ton of time.
+
+Here's how Twig looks in action:
+
+    $ twig
+
+                                  issue  status       todo            branch
+                                  -----  ------       ----            ------
+    2013-01-26 18:00:21 (7m ago)  486    In progress  Rebase          optimize-all-the-things
+    2013-01-26 16:49:21 (2h ago)  268    In progress  -               whitespace-all-the-things
+    2013-01-23 18:35:21 (3d ago)  159    Shipped      Test in prod  * refactor-all-the-things
+    2013-01-22 17:12:09 (4d ago)  -      -            -               development
+    2013-01-20 19:45:42 (6d ago)  -      -            -               master
+
+
+Installation
+============
+
+    gem install twig
+
+
+Usage
+=====
+
+Twig lets you get/set custom properties for each branch, and list branches
+chronologically with their properties.
+
+* `twig`:                                List all branches with properties, newest first
+* `twig <property>`:                     Get a property for the current branch
+* `twig <property> <value>`:             Set a property for the current branch
+* `twig --unset <property>`:             Unset a property for the current branch
+* `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 --help`:                         More info
+
+
+Filtering branches
+------------------
+
+Twig lists all of your branches by default (newest first), but you can filter
+them by name and 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 --all`:
+  List all branches regardless of other filtering options
+
+You can put your most frequently used options into `~/.twigrc`, and they'll be
+automatically included when you run `twig`. Example:
+
+    # ~/.twigrc:
+    except-branch: staging
+    max-days-old:  30
+
+
+Examples
+--------
+
+List your branches, and highlight the current branch:
+
+    $ twig
+
+    2013-01-26 18:07:21 (7m ago)  * refactor-all-the-things
+    2013-01-24 17:12:09 (2d ago)    development
+    2013-01-23 19:45:42 (3d ago)    master
+
+Remember a branch's issue tracker id:
+
+    $ git checkout my-branch
+    Switched to branch 'my-branch'.
+
+    $ twig issue 123
+    Saved property "issue" as "123" for branch "my-branch".
+    # Nearly any property name will do, like "bug" or "ticket".
+
+    $ twig issue
+    123
+
+    $ open "https://github.com/myname/myproject/issues/`twig issue`"
+    # Opens a browser window for this GitHub issue (in OS X).
+
+Keep notes on what you need to do with each branch:
+
+    $ twig todo "Run tests"
+    Saved property "todo" as "Run tests" for branch "my-branch".
+
+    $ twig todo "Deploy" -b finished-branch
+    Saved property "todo" as "Deploy" for branch "finished-branch".
+
+    $ twig
+
+                                  todo         branch
+                                  ----         ------
+    2013-01-26 18:00:25 (7m ago)  Run tests  * my-branch
+    2013-01-23 18:35:12 (3d ago)  Deploy       finished-branch
+    2013-01-22 17:12:23 (4d ago)  -            master
+
+Remember the order in which you were rebasing your stack of branches:
+
+    $ git checkout master
+    Switched to branch 'master'.
+
+    $ twig rebase-onto branch2 -b branch3
+    Saved property "rebase-onto" as "branch2" for branch "branch3".
+
+    $ twig rebase-onto branch1 -b branch2
+    Saved property "rebase-onto" as "branch1" for branch "branch2".
+
+    $ twig
+
+                                  rebase-onto    branch
+                                  -----------    ------
+    2013-01-26 18:00:25 (7m ago)  branch2        branch3
+    2013-01-26 16:49:47 (2h ago)  branch1        branch2
+    2013-01-23 18:35:12 (3d ago)  -              branch1
+    2013-01-22 17:12:23 (4d ago)  -            * master
+
+You can set just about any custom property you need to remember for each branch.
+
+
+Subcommands
+===========
+
+Twig comes with two subcommands, `gh-open` and `gh-update`, which are handy for
+use with GitHub repositories.
+
+While inside a Git repo, run `twig gh-open` to see the repo's GitHub URL, and open
+a browser window if possible:
+
+    $ cd myproject
+
+    $ 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, you can also use the
+`gh-update` subcommand:
+
+    $ git checkout add-feature
+    Switched to branch 'add-feature'.
+
+    $ twig issue 222
+    Saved property "issue" as "222" for branch "add-feature".
+
+    $ twig
+
+                                  issue  status    branch
+                                  -----  ------    ------
+    2013-01-26 18:00:25 (7m ago)  222    -       * add-feature
+    2013-01-23 18:35:12 (3d ago)  111    -         fix-bug
+    2013-01-22 17:12:23 (4d ago)  -      -         master
+
+    $ twig gh-update
+    # Automatically looks up the GitHub issue status for each
+    # of your local branches, and saves it locally.
+
+    $ twig
+
+                                  issue  status    branch
+                                  -----  ------    ------
+    2013-01-26 18:00:25 (7m ago)  222    open    * add-feature
+    2013-01-23 18:35:12 (3d ago)  111    closed    fix-bug
+    2013-01-22 17:12:23 (4d ago)  -      -         master
+
+Run `twig gh-update` periodically to keep up with GitHub issues locally.
+
+You can write any Twig subcommand that fits your own Git workflow. To write a
+Twig subcommand:
+
+1.  Write a script. Any language will do. (If you want to take advantage of
+    Twig's option parsing and branch processing, you'll need Ruby. See
+    [`bin/twig-gh-update`][twig-gh-update] for an example.)
+2.  Save it with the `twig-` prefix in your `$PATH`,
+    e.g., `~/bin/twig-my-subcommand`.
+3.  Make it executable: `chmod ugo+x ~/bin/twig-my-subcommand`
+4.  Run your subcommand: `twig my-subcommand` (with a *space* after `twig`)
+
+[twig-gh-update]: https://github.com/rondevera/twig/blob/master/bin/twig-gh-update
+
+Some ideas for subcommands:
+
+* Get each branch's status for any issue tracking system that has an API,
+  like [JIRA](http://www.atlassian.com/software/jira/overview),
+  [FogBugz](http://www.fogcreek.com/fogbugz/), or
+  [Lighthouse](http://lighthouseapp.com/).
+* Given an issue tracker id, check out that issue's branch locally. Great for
+  following teammates' branches, remembering their issue ids, and knowing when
+  they've shipped.
+* Generate a formatted list of your branches from the past week. Useful for
+  emailing your team about what you're up to.
+
+If you write a subcommand that others can appreciate, send a pull request or add
+it to the [Twig wiki][wiki]!
+
+
+More info
+=========
+
+- **Requirements:** Tested with Git 1.6.5 and Ruby 1.8.7. Probably works with
+  older software, but it's not guaranteed.
+- **Contributing:** Found a bug or have a suggestion? [Please open an
+  issue][issues] or ping [@ronalddevera on Twitter][twitter]. If you want to
+  hack on some features or contribute a subcommand you've written, feel free to
+  fork and send a pull request for the **[development branch][dev branch]**.
+  (The master branch is for stable builds only.) See the full details in the
+  [Contributing][contributing] instructions.
+- **History:** [History/changelog for Twig][history]
+- **License:** Twig is released under the [MIT License][license].
+
+[issues]:         https://github.com/rondevera/twig/issues
+[wiki]:           https://github.com/rondevera/twig/wiki
+[twitter]:        https://twitter.com/ronalddevera
+[dev branch]:     https://github.com/rondevera/twig/commits/development
+[contributing]:   https://github.com/rondevera/twig/blob/master/CONTRIBUTING.md
+[history]:        https://github.com/rondevera/twig/blob/master/HISTORY.md
+[license]:        https://github.com/rondevera/twig/blob/master/LICENSE.md

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'rspec/core/rake_task'
+require 'bundler'
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+Bundler::GemHelper.install_tasks

data/bin/twig

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'twig')
+
+twig = Twig.new
+abort unless twig.repo?
+
+# Gettin' twiggy wit' it.
+twig.read_config_file!
+twig.read_cli_args!(ARGV)

data/bin/twig-gh-open

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+# Opens a browser window for the current GitHub repo.
+#
+# Author: Ron DeVera <http://rondevera.com>
+
+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|
+  url = "https://github.com/#{gh_repo.username}/#{gh_repo.repository}"
+  puts "GitHub URL: #{url}"
+  `which open && open #{url}`
+end

data/bin/twig-gh-update

@@ -0,0 +1,93 @@
+#!/usr/bin/env ruby
+
+# Updates each branch with the latest issue status on GitHub.
+#
+# Author: Ron DeVera <http://rondevera.com>
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'twig')
+require 'rubygems'
+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|
+  $stdout.sync = true
+  print 'Getting latest states for GitHub issues...'
+
+  issues = {}
+  issues_uri_base =
+    "https://api.github.com/repos/#{gh_repo.username}/#{gh_repo.repository}/issues"
+  issues_uris = [
+    URI.parse("#{issues_uri_base}?state=open"),
+    URI.parse("#{issues_uri_base}?state=closed")
+  ]
+
+  begin
+    issues_uris.each do |issues_uri|
+      http = Net::HTTP.new(issues_uri.host, issues_uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      request = Net::HTTP::Get.new(issues_uri.path + '?' + issues_uri.query)
+      response = http.request(request)
+
+      if response.code.to_i == 200
+        issues_data = JSON.parse(response.body)
+        issues_data.each do |issue_data|
+          issues[issue_data['number']] = issue_data
+        end
+      else
+        puts "\nERROR: Couldn't get open issues from GitHub. " <<
+          "(Response: #{response.code})"
+      end
+    end
+  end
+
+  twig.branches.each do |branch|
+    issue_number = branch.get_property('issue').to_i
+    next unless issue_number > 0
+
+    issue = issues[issue_number]
+    next unless issue
+
+    state = issue['state']
+    branch.set_property('status', state) unless state.nil? || state.empty?
+
+    print '.'
+  end
+
+  puts
+end

data/bin/twig-help

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+# Your friendly neighborhood `twig --help` alias.
+puts `twig --help`

data/install

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+twig_bin_path = File.expand_path(File.dirname(__FILE__)) + '/bin/**/twig*'
+twig_bins = Dir.glob(twig_bin_path)
+user_bin_path = '~/bin'
+
+twig_bins.each do |bin|
+  `ln -fs #{bin} #{user_bin_path}`
+end
+
+if `which twig` && $?.success?
+  puts 'All set! Run `twig` to list your local branches.'
+  puts 'For more info, run `twig --help`.'
+else
+  puts 'Argh! Something went wrong. Please try symlinking the files in '
+  puts '`./bin/` to `~/bin/` and ensure that `~/bin/` is in your `$PATH`, or '
+  puts 'contact rondevera on GitHub.'
+end

data/lib/twig/branch.rb

@@ -0,0 +1,72 @@
+class Twig
+  class Branch
+
+    RESERVED_BRANCH_PROPERTIES    = %w[merge rebase remote]
+    PROPERTY_NAME_FROM_GIT_CONFIG = /^branch\.[^.]+\.([^=]+)=.*$/
+
+    attr_accessor :name, :last_commit_time
+
+    def self.all_properties
+      @_all_properties ||= begin
+        config_lines = Twig.run('git config --list').split("\n")
+
+        properties = config_lines.map do |line|
+          # Split by rightmost `=`, allowing branch names to contain `=`:
+          key, value = line.match(/(.+)=(.+)/)[1..2]
+
+          key_parts = key.split('.')
+          key_parts.last if key_parts[0] == 'branch' && key_parts.size > 2
+        end.compact
+
+        properties.uniq.sort - RESERVED_BRANCH_PROPERTIES
+      end
+    end
+
+    def initialize(name, attrs = {})
+      self.name = name
+      raise ArgumentError, '`name` is required' if name.empty?
+
+      self.last_commit_time = attrs[:last_commit_time]
+    end
+
+    def to_s ; name ; end
+
+    def sanitize_property(property_name)
+      property_name.gsub(/[ _]+/, '')
+    end
+
+    def get_property(property_name)
+      Twig.run("git config branch.#{name}.#{property_name}")
+    end
+
+    def set_property(property_name, value)
+      property_name = sanitize_property(property_name)
+      value = value.to_s.strip
+
+      if RESERVED_BRANCH_PROPERTIES.include?(property_name)
+        %{Can't modify the reserved property "#{property_name}".}
+      elsif value.empty?
+        %{Can't set a branch property to an empty string.}
+      else
+        Twig.run(%{git config branch.#{name}.#{property_name} "#{value}"})
+        result_body = %{property "#{property_name}" as "#{value}" for branch "#{name}".}
+        if $?.success?
+          "Saved #{result_body}"
+        else
+          "Could not save #{result_body}"
+        end
+      end
+    end
+
+    def unset_property(property_name)
+      value = get_property(property_name)
+      if value && !value.empty?
+        Twig.run(%{git config --unset branch.#{name}.#{property_name}})
+        %{Removed property "#{property_name}" for branch "#{name}".}
+      else
+        %{The branch "#{name}" does not have the property "#{property_name}".}
+      end
+    end
+
+  end
+end