twig 1.5 → 1.6

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  metadata.gz: 360381819d893fa2d71b315d1c19a0c48e98132e
+  data.tar.gz: 82c42e49a983d5a0539b29b9784b19daf35a21e4
+SHA512: 
+  metadata.gz: d9b7ddf8e5904fc1a76bad82461d33e3e7b729a7ef243a65dcca2c22978c7ba2c0ede1cd35ca900674b3d0bb86ca3001600eb008ffe6c746364162c58a1d0aa2
+  data.tar.gz: 8df02602a640c113ac00dd28f8321515ae2409f22d080d2cadec234c987c2dd8375e07e147faf1879a40e8673f7d87e32533424bad8b273ad7932ad7ec91e751

data/.gitignore

@@ -1,4 +1,6 @@
 *.gem
+.bundle/
+.ruby-gemset
 .rvmrc
 Gemfile.lock
 _site/

data/.travis.yml

@@ -1,5 +1,7 @@
 language: ruby
 rvm:
+  - 2.1.0
+  - 2.0.0
   - 1.9.3
   - 1.9.2
   - 1.8.7

data/CONTRIBUTING.md

@@ -1,7 +1,7 @@
 How to contribute
 =================
 
-Let's make life easier for people with lots of Git branches.
+Let's make life easier for people who have lots of Git branches.
 
 Found a bug or have a suggestion? [Please open an issue][issues] or ping
 [@ronalddevera on Twitter][twitter].
@@ -17,8 +17,9 @@ If you want to hack on some code, even better! Here are the basics:
 4.  Run the tests to make sure that they pass on your machine: `bundle && rake`
 5.  Add one or more failing tests for your feature or bug fix.
 6.  Write your feature or bug fix to make the test(s) pass.
-    * Tests should pass in the latest **Ruby 1.8.7** and **Ruby 1.9.3**, which
-      you can do with [rvm][rvm] or [rbenv][rbenv].
+    * Tests should pass for the Ruby versions listed in
+      [.travis.yml][travis.yml], which you can confirm with [rvm][rvm] or
+      [rbenv][rbenv].
     * Keep the branch focused on a single topic, rather than covering multiple
       features or bug fixes in a single branch. This makes branches quicker to
       review and merge.
@@ -34,3 +35,4 @@ Thanks for contributing!
 [dev branch]: https://github.com/rondevera/twig/commits/development
 [rvm]:        https://rvm.io/
 [rbenv]:      http://rbenv.org/
+[travis.yml]: https://github.com/rondevera/twig/blob/master/.travis.yml

data/HISTORY.md

@@ -1,6 +1,29 @@
 Twig
 ====
 
+1.6 (2014-03-04)
+----------------
+* ENHANCEMENT: Add `--only-property <pattern>` and `--except-property <pattern>`
+  for including/excluding property names in list view and JSON view. Useful for
+  hiding properties that are frequently too long to show in list view (e.g.,
+  `todo`), or for hiding groups of properties that are just issue tracker
+  metadata. (GH-25. Thanks [slucero](https://github.com/slucero) for the idea!)
+* ENHANCEMENT: Add `twig init` subcommand, the new recommended way to set up
+  Twig after installing the gem.
+* ENHANCEMENT: Add `twig checkout-parent` subcommand, which checks out the
+  current branch's parent branch, if any, based on its `diff-branch` property.
+  (GH-34)
+* ENHANCEMENT: Add `twig checkout-child` subcommand, which checks out the
+  current branch's child branch, if any, based on the child's `diff-branch`
+  property. If the current branch has multiple child branches, this subcommand
+  lists all of them and prompts for a selection. (GH-35)
+* ENHANCEMENT: Add `twig create-branch` subcommand, which creates a branch off
+  of the current branch, and sets the child branch's `diff-branch` property
+  automatically.
+* FIX: Fix `(1y ago)` (previously displayed as `(1 ago)`) in branch list view.
+* FIX: Make `property` a reserved property name, along with `branch`, `merge`,
+  `rebase`, and `remote`.
+
 1.5 (2013-11-21)
 ----------------
 * ENHANCEMENT: Add `--format=json` option for printing branch data as JSON

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Ron DeVera
+Copyright (c) 2014 Ron DeVera
 
 MIT License
 

data/README.md

@@ -27,11 +27,15 @@ Here's how Twig looks in action:
     2013-01-20 19:45:42 (6d ago)  -      -            -               master
 
 
-Installation
-============
+Quick start
+===========
 
     gem install twig
 
+    twig init    # Sets up tab completion; one run works across all repos
+    twig         # Lists your branches
+    twig --help  # More info
+
 
 Usage
 =====
@@ -46,7 +50,7 @@ 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 init-completion`:                Set up tab completion for `-b` and `--branch`
+* `twig init`:                           Set up tab completion for `-b` and `--branch`; one run works across all repos
 * `twig init-completion --force`:        Update to the latest tab completion script
 * `twig --help`:                         More info
 
@@ -86,6 +90,7 @@ be automatically included when you run `twig`. Example:
     except-branch: staging
     header-style:  green bold
     max-days-old:  30
+    reverse:       true
 
 
 Examples
@@ -161,6 +166,87 @@ properties. You can [write your own](#writing-a-subcommand), but here are some
 subcommands that Twig comes with.
 
 
+twig checkout-child
+-------------------
+
+Twig uses each branch's `diff-branch` property to remember its parent branch so
+you don't have to. If you need to check out one of the child branches for your
+current branch, you can use `twig checkout-child`:
+
+    $ git checkout feature-branch
+
+    # Look for any branch whose `diff-branch` property is `feature-branch`, and
+    # checkout that branch:
+    $ twig checkout-child
+
+    # If the current branch has multiple child, Twig asks what to do:
+    Checkout which child branch?
+     1. child-branch-1
+     2. child-branch-2
+     3. child-branch-3
+    > 3
+    Switched to branch 'child-branch-3'
+
+More advanced usage:
+
+    # Switch to a child branch of any other branch:
+    $ twig checkout-child -b other-feature-branch
+    Switched to branch 'other-child-branch'
+
+You can use this with `twig checkout-parent` and `twig create-branch` to
+traverse your tree of branches.
+
+
+twig checkout-parent
+--------------------
+
+If your branch has a `diff-branch` property, you can use `twig checkout-parent`
+to quickly switch to that branch:
+
+    $ git checkout branch2
+
+    # Remember your branch's diff branch:
+    $ twig diff-branch branch1
+    Saved property "diff-branch" as "branch1" for branch "branch2".
+
+    # Later, switch from branch2 (the current branch) to its parent branch:
+    $ twig checkout-parent
+    Switched to branch 'branch1'
+
+More advanced usage:
+
+    # Switch to the parent branch of any other branch:
+    $ twig checkout-parent -b other-branch-2
+    Switched to branch 'other-branch-1'
+
+You can use this with `twig checkout-child` and `twig create-branch` to traverse
+your tree of branches.
+
+
+twig create-branch
+------------------
+
+When creating a branch, you can use `twig create-branch` to create a child
+branch and set its `diff-branch` property automatically:
+
+    $ git checkout master
+    $ twig create-branch my-branch
+    Branch my-branch set up to track local branch master.
+    Switched to a new branch 'my-branch'
+    Saved property "diff-branch" as "master" for branch "my-branch".
+
+    # Confirm that the new branch's `diff-branch` is its parent:
+    $ twig diff-branch
+    master
+
+    # Check out the new branch's parent:
+    $ twig checkout-parent
+    Switched to branch 'master'
+
+You can use this with `twig checkout-child` and `twig checkout-parent` to
+traverse your tree of branches.
+
+
 twig diff
 ---------
 
@@ -176,7 +262,7 @@ to remember which branch to diff against. `twig diff` makes it easy:
     # Generate a diff between branch1 (the current branch) and branch2:
     $ twig diff
 
-More usage:
+More advanced usage:
 
     # Generate a diff between any given branch and its `diff-branch`:
     $ twig diff my-other-branch
@@ -191,8 +277,8 @@ More usage:
 twig rebase
 -----------
 
-If you have a stack of branches that you need to rebase in the same order,
-`twig rebase` simplifies the process:
+If you have a stack of branches that you need to rebase in the same order every
+time, `twig rebase` simplifies the process:
 
     $ git checkout branch2
 
@@ -204,7 +290,7 @@ If you have a stack of branches that you need to rebase in the same order,
     $ twig rebase
     Rebase "branch2" onto "development"? (y/n)
 
-More usage:
+More advanced usage:
 
     # Rebase any given branch onto its `diff-branch`:
     $ twig rebase my-other-branch
@@ -292,15 +378,15 @@ Writing a subcommand
 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
+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.)
+    [`bin/twig-checkout-parent`][twig-checkout-parent] 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
+[twig-checkout-parent]: https://github.com/rondevera/twig/blob/master/bin/twig-checkout-parent
 
 Some ideas for subcommands:
 
@@ -322,8 +408,8 @@ add it to the [Twig wiki][wiki]!
 More info
 =========
 
-* **Requirements:** Tested with Git 1.6.5+ and Ruby 1.8.7/1.9.2/1.9.3. Probably
-  works with older software, but it's not guaranteed.
+* **Requirements:** Tested with Git 1.7.12+ and Ruby 1.8.7, 1.9.2, 1.9.3, 2.0.0,
+  and 2.1.0. 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

data/bin/twig

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 
 # Entry point for Twig: <http://rondevera.github.io/twig/>
+# More info: `twig --help`
 
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'twig'))
 

data/bin/twig-checkout-child

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+# Synopsis:
+#
+#   twig checkout-child [-b|--branch <branch>]
+#
+# Description:
+#
+#   Checks out the current branch's child branch, if any, based on the child's
+#   `diff-branch` property. If the current branch has multiple child branches,
+#   this subcommand lists all of them and prompts for a selection.
+#
+#   You can use this with `twig checkout-parent` to traverse your tree of
+#   branches.
+#
+# Options:
+#
+#   `-b` or `--branch`: Checks out the child branch for the given branch, rather
+#   than the current branch.
+#
+# Subcommand for Twig: <http://rondevera.github.io/twig/>
+# Author: Ron DeVera <http://rondevera.com>
+
+require 'rubygems'
+require 'twig'
+
+def checkout_branch(branch_name)
+  `git checkout "#{branch_name}"`
+end
+
+twig = Twig.new(:read_options => true)
+target_branch = twig.target_branch_name
+target_branch_regexp = Regexp.new("\\A#{target_branch}\\z")
+twig.set_option(:property_only, :'diff-branch' => target_branch_regexp)
+child_branch_names = twig.branches
+
+if child_branch_names.size > 1
+  prompt = 'Checkout which child branch?'
+  child_branch_name = Twig::Cli.prompt_with_choices(prompt, child_branch_names)
+
+  if child_branch_name
+    checkout_branch(child_branch_name)
+  else
+    abort 'No child branch selected.'
+  end
+elsif child_branch_names.size == 1
+  checkout_branch(child_branch_names.first)
+else
+  abort "There are no branches whose `diff-branch` property is `#{target_branch}`."
+end

data/bin/twig-checkout-parent

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+# Synopsis:
+#
+#   twig checkout-parent [-b|--branch <branch>]
+#
+# Description:
+#
+#   Checks out the current branch's parent branch, if any, based on the current
+#   branch's `diff-branch` property.
+#
+#   You can use this with `twig checkout-child` to traverse your tree of
+#   branches.
+#
+# Options:
+#
+#   `-b` or `--branch`: Checks out the parent branch of the given branch, rather
+#   than the current branch.
+#
+# Subcommand for Twig: <http://rondevera.github.io/twig/>
+# Author: Ron DeVera <http://rondevera.com>
+
+require 'rubygems'
+require 'twig'
+
+twig = Twig.new(:read_options => true)
+parent_property = 'diff-branch'
+target_branch = twig.target_branch_name
+parent_branch = twig.get_branch_property(target_branch, parent_property) || ''
+
+if parent_branch.empty?
+  abort %{The branch "#{target_branch}" does not have the property "#{parent_property}".}
+else
+  exec %{git checkout "#{parent_branch}"}
+end

data/bin/twig-create-branch

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+# Synopsis:
+#
+#   twig create-branch <branch>
+#
+# Description:
+#
+#   Creates a branch with the given name, and sets the new branch's
+#   `diff-branch` property to the previous branch's name. This allows for
+#   traversing the branch tree with `twig checkout-parent` and
+#   `twig checkout-child`.
+#
+# Subcommand for Twig: <http://rondevera.github.io/twig/>
+# Author: Ron DeVera <http://rondevera.com>
+
+new_branch_name = (ARGV[0] || '').strip
+abort 'Usage: twig create-branch <branch name>' if new_branch_name.empty?
+
+current_branch_name = `git rev-parse --abbrev-ref HEAD`.strip
+
+cmd = %{git checkout -b "#{new_branch_name}"}
+cmd << %{ && twig diff-branch "#{current_branch_name}"}
+exec(cmd)

data/bin/twig-diff

@@ -1,24 +1,27 @@
 #!/usr/bin/env ruby
 
-# Summary:
+# Synopsis:
 #
-#   `twig diff [<branch>] [<options>]`
+#   twig diff [<branch>] [<options>]
 #
-# Usage:
+# Description:
 #
-# - `twig diff`:
 #   Shows the diff between the current branch and its `diff-branch` property.
+#   All options are passed through to `git-diff`.
 #
-# - `twig diff <options>`:
-#   Shows the diff between the current branch and its `diff-branch`, and passes
-#   options through to `git-diff`, e.g., `twig diff --stat`.
+# Examples:
 #
-# - `twig diff <branch>`:
-#   Shows the diff between the given branch and its `diff-branch` property.
+#   Show diff stats between the current branch and its `diff-branch`:
 #
-# - `twig diff <branch> <options>`:
-#   Shows the diff between the given branch and its `diff-branch`, and passes
-#   options through to `git-diff`, e.g., `twig diff my_branch --stat`.
+#     twig diff --stat
+#
+#   Show the diff between the given branch and its `diff-branch`:
+#
+#     twig diff my_branch
+#
+#   Show diff stats between the given branch and its `diff-branch`:
+#
+#     twig diff my_branch --stat
 #
 # Subcommand for Twig: <http://rondevera.github.io/twig/>
 # Author: Ron DeVera <http://rondevera.com>

data/bin/twig-gh-open

@@ -1,6 +1,18 @@
 #!/usr/bin/env ruby
 
-# Opens a browser window for the current GitHub repo.
+# Synopsis:
+#
+#   twig gh-open
+#
+# Description:
+#
+#   Opens a browser window for the current GitHub repo.
+#
+#   To customize the GitHub URI prefix (e.g., for GitHub Enterprise
+#   installations), set GitHub options in `~/.twigconfig`:
+#
+#     github-uri-prefix:     http://example-enterprise.github.com
+#     github-api-uri-prefix: http://example-enterprise.github.com
 #
 # Subcommand for Twig: <http://rondevera.github.io/twig/>
 # Author: Ron DeVera <http://rondevera.com>
@@ -10,10 +22,7 @@ require 'twig'
 require 'launchy'
 
 Twig::GithubRepo.new do |gh_repo|
-  twig = Twig.new
-  twig.read_config_file!
-  twig.read_cli_options!(ARGV)
-
+  twig = Twig.new(:read_options => true)
   gh_uri_prefix = twig.options[:github_uri_prefix]
   url = "#{gh_uri_prefix}/#{gh_repo.username}/#{gh_repo.repository}"