twig 1.6 → 1.7

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
 SHA1: 
-  metadata.gz: 360381819d893fa2d71b315d1c19a0c48e98132e
-  data.tar.gz: 82c42e49a983d5a0539b29b9784b19daf35a21e4
+  data.tar.gz: 652595cdad13fa87f888765b0ba912f0d21b840b
+  metadata.gz: 74cf0612d43de9ade52a217d2845d0bd899e19b5
 SHA512: 
-  metadata.gz: d9b7ddf8e5904fc1a76bad82461d33e3e7b729a7ef243a65dcca2c22978c7ba2c0ede1cd35ca900674b3d0bb86ca3001600eb008ffe6c746364162c58a1d0aa2
-  data.tar.gz: 8df02602a640c113ac00dd28f8321515ae2409f22d080d2cadec234c987c2dd8375e07e147faf1879a40e8673f7d87e32533424bad8b273ad7932ad7ec91e751
+  data.tar.gz: 25b82c034a5d398bb78f25280b58c42f51cfc86b2857bdd16256de5685863f0fdfcb5421231beab411c0d883b2cb46c6f3e4b57f3cd37e951d72331818eab831
+  metadata.gz: d62797278db061c8b5858c0bcc0517ec0e4f0bfe8d75e8e06b443a7f82a1f8767b2c6a46c245b55a0b3a34d2588dd8620654cd4406a3661b0b57fa5e6f36fb5e

data/.travis.yml

@@ -1,5 +1,7 @@
 language: ruby
 rvm:
+  - 2.1.2
+  - 2.1.1
   - 2.1.0
   - 2.0.0
   - 1.9.3

data/HISTORY.md

@@ -1,6 +1,33 @@
 Twig
 ====
 
+1.7 (2014-07-29)
+----------------
+* ENHANCEMENT: Expand `twig init` to also create a default `~/.twigconfig` file.
+  This uses a new `twig init-config` subcommand behind the scenes.
+* ENHANCEMENT: Add `twig help <subcommand>` for showing help content for any
+  built-in Twig subcommand (e.g., `twig help rebase`). To make a custom
+  subcommand work with this system (e.g., `twig help my-subcommand`), simply add
+  `--help` support to the subcommand (e.g., `twig my-subcommand --help`), and
+  Twig will call it automatically.
+* ENHANCEMENT: List built-in subcommands in `twig help` with short descriptions
+  of each. (GH-32)
+* ENHANCEMENT: Support `twig rebase --autoconfirm` for skipping the prompt when
+  rebasing a branch onto its parent branch. To skip the prompt every time you
+  use `twig rebase`, add `twig-rebase-autoconfirm: true` to your
+  `~/.twigconfig`. (GH-24. Thanks [ljharb](https://github.com/ljharb) for the
+  idea!)
+* ENHANCEMENT: Suggest `twig --all` if there are no matching branches. (GH-33)
+* ENHANCEMENT: Add Ruby 2.1.1 and 2.1.2 to official list of supported Rubies.
+* FIX: Don't require a Git repo for initialization (e.g., `twig init`) or for
+  showing help content (e.g., `twig help rebase`).
+* FIX: Show units of time for relative time strings when not using English.
+  (GH-37, GH-38. Thanks [matteosister](https://github.com/matteosister)!)
+* FIX: Handle special shell characters (e.g., backticks, dollar signs) in branch
+  names and property values.
+* FIX: Disable unsupported string formatting in Windows. (GH-39. Thanks
+  [rcdailey](https://github.com/rcdailey) for the bug report!)
+
 1.6 (2014-03-04)
 ----------------
 * ENHANCEMENT: Add `--only-property <pattern>` and `--except-property <pattern>`

data/README.md

@@ -5,9 +5,8 @@ Twig: Your personal Git branch assistant.
 [![Build Status](https://travis-ci.org/rondevera/twig.png?branch=development)](https://travis-ci.org/rondevera/twig)
 
 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.
+also need their issue tracker ids, issue statuses, and reminders of what to do
+next with each branch. `git branch` just isn't cutting it.
 
 **Twig shows you your most recent branches, and remembers branch details for
 you.** It supports subcommands, like automatically fetching statuses from your
@@ -32,9 +31,9 @@ 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
+    twig init  # Sets up tab completion; one run works across all repos
+    twig       # Lists your branches
+    twig help  # More info
 
 
 Usage
@@ -50,9 +49,9 @@ 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`:                           Set up tab completion for `-b` and `--branch`; one run works across all repos
+* `twig init`:                           Set up tab completion and `~/.twigconfig`; one runs works across all repos
 * `twig init-completion --force`:        Update to the latest tab completion script
-* `twig --help`:                         More info
+* `twig help`:                           More info
 
 
 Display options
@@ -71,7 +70,7 @@ Twig lists all of your branches by default (newest first), but you can filter
 them by age, name, and custom properties:
 
 * `twig --max-days-old <age>`:
-  Only list branches below a given age
+  Only list branches that were touched in the last # days
 * `twig --only-branch <pattern>`:
   Only list branches whose name matches a given pattern
 * `twig --except-branch <pattern>`:
@@ -80,18 +79,30 @@ them by age, name, and custom properties:
   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 --only-property <pattern>`:
+  Only show columns for properties whose name matches a given pattern
+* `twig --except-property <pattern>`:
+  Don't show columns for properties whose name matches a given pattern
 * `twig --all`:
   List all branches regardless of other filtering options
 
-You can put your most frequently used options into `~/.twigconfig`, and they'll
-be automatically included when you run `twig`. Example:
+Saving favorite options
+-----------------------
+
+Running `twig init` generates a `~/.twigconfig` file with default options.
+Afterwards, you can put your most frequently used options into this file, and
+they'll automatically be included when you run `twig`. For example:
 
     # ~/.twigconfig:
-    except-branch: staging
+
+    # Display options:
     header-style:  green bold
-    max-days-old:  30
     reverse:       true
 
+    # Filtering options:
+    except-branch: staging
+    max-days-old:  30
+
 
 Examples
 --------
@@ -179,11 +190,11 @@ current branch, you can use `twig checkout-child`:
     # checkout that branch:
     $ twig checkout-child
 
-    # If the current branch has multiple child, Twig asks what to do:
+    # If the current branch has multiple child branches, Twig asks what to do:
     Checkout which child branch?
-     1. child-branch-1
-     2. child-branch-2
-     3. child-branch-3
+      1. child-branch-1
+      2. child-branch-2
+      3. child-branch-3
     > 3
     Switched to branch 'child-branch-3'
 
@@ -298,6 +309,12 @@ More advanced usage:
     # Pass options through to `git rebase`:
     $ twig rebase -i
 
+    # Skip the prompt when rebasing:
+    $ twig rebase --autoconfirm
+
+    # Skip the prompt every time you run `twig rebase`:
+    $ echo 'twig-rebase-autoconfirm: true' >> ~/.twigconfig
+
 
 twig gh-open
 ------------
@@ -311,7 +328,7 @@ open a browser window if possible:
     GitHub URL: https://github.com/myname/myproject
 
 For GitHub Enterprise or other installations, you can change
-`https://github.com` by setting `github-uri-prefix` in `~/.twigrc`.
+`https://github.com` by setting `github-uri-prefix` in `~/.twigconfig`.
 
 
 twig gh-open-issue
@@ -329,7 +346,7 @@ subcommand to view that issue on GitHub:
     GitHub issue URL: https://github.com/myname/myproject/issues/222
 
 For GitHub Enterprise or other installations, you can change
-`https://github.com` by setting `github-uri-prefix` in `~/.twigrc`.
+`https://github.com` by setting `github-uri-prefix` in `~/.twigconfig`.
 
 
 twig gh-update
@@ -369,7 +386,7 @@ Run `twig gh-update` periodically to keep up with GitHub issues locally.
 
 For GitHub Enterprise or other installations, you can change the default
 `https://api.github.com` endpoint prefix by setting `github-api-uri-prefix` in
-`~/.twigrc`.
+`~/.twigconfig`.
 
 
 Writing a subcommand
@@ -408,8 +425,9 @@ add it to the [Twig wiki][wiki]!
 More info
 =========
 
-* **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.
+* **Requirements:** Tested with Git 1.8.4+ and Ruby 1.8.7+ (see
+  [Travis CI config][travis-yml]) on OS X and other *nix systems. Might work
+  with older software and other systems, 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
@@ -426,3 +444,4 @@ More info
 [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
+[travis-yml]:     https://github.com/rondevera/twig/blob/development/.travis.yml

data/bin/twig

@@ -1,17 +1,25 @@
 #!/usr/bin/env ruby
 
 # Entry point for Twig: <http://rondevera.github.io/twig/>
-# More info: `twig --help`
+# More info: `twig help`
 
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'twig'))
 
-repo_required = ARGV != ['--help'] && ARGV != ['help'] && ARGV != ['--version']
+args = ARGV.dup
+repo_required =
+  !args.include?('--help') &&
+  args[0] != 'help' && # e.g., `twig help <subcommand>`
+  args != ['--version'] &&
+  args != ['init'] &&
+  args != ['init-completion'] &&
+  args != ['init-completion-bash'] &&
+  args != ['init-config']
 
 if repo_required && !Twig.repo?
-  abort "Current directory is not a git repository."
+  abort 'Current directory is not a git repository.'
 end
 
 # Gettin' twiggy wit' it.
 twig = Twig.new
 twig.read_config_file!
-twig.read_cli_args!(ARGV)
+twig.read_cli_args!(args)

data/bin/twig-checkout-child

@@ -1,26 +1,5 @@
 #!/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'
 
@@ -28,10 +7,60 @@ def checkout_branch(branch_name)
   `git checkout "#{branch_name}"`
 end
 
+def help_content
+  <<-HELP
+
+twig-checkout-child
+===================
+
+Checks out a branch's child branch, if any.
+
+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.
+
+See also
+--------
+
+  twig-checkout-parent
+  twig-create-branch
+
+Subcommand for Twig: <http://rondevera.github.io/twig/>
+Author: Ron DeVera <http://rondevera.com>
+
+  HELP
+end
+
+args = ARGV.dup
+
+if args.include?('--help')
+  puts help_content
+  exit
+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)
+target_branch_name = twig.target_branch_name
+target_branch_regexp = Regexp.new("\\A#{target_branch_name}\\z")
+parent_property = Twig::Branch::PARENT_PROPERTY
+
+twig.set_option(:property_only, parent_property.to_sym => target_branch_regexp)
 child_branch_names = twig.branches
 
 if child_branch_names.size > 1
@@ -46,5 +75,7 @@ if child_branch_names.size > 1
 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}`."
+  abort %{The branch "#{target_branch_name}" has no known child branches.\n} \
+    "To set this as parent branch for some child branch, run:\n\n" \
+    "  twig diff-branch #{target_branch_name} -b <child branch name>"
 end

data/bin/twig-checkout-parent

@@ -1,35 +1,63 @@
 #!/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'
 
+def help_content
+  <<-HELP
+
+twig-checkout-parent
+====================
+
+Checks out a branch's parent branch.
+
+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.
+
+See also
+--------
+
+  twig-checkout-child
+  twig-create-branch
+
+Subcommand for Twig: <http://rondevera.github.io/twig/>
+Author: Ron DeVera <http://rondevera.com>
+
+HELP
+end
+
+args = ARGV.dup
+
+if args.include?('--help')
+  puts help_content
+  exit
+end
+
 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) || ''
+target_branch = twig.target_branch
+parent_branch_name = target_branch.parent_name
 
-if parent_branch.empty?
-  abort %{The branch "#{target_branch}" does not have the property "#{parent_property}".}
+if parent_branch_name && !parent_branch_name.empty?
+  exec %{git checkout "#{parent_branch_name}"}
 else
-  exec %{git checkout "#{parent_branch}"}
+  parent_property = Twig::Branch::PARENT_PROPERTY
+  abort %{The branch "#{target_branch}" has no known parent branch.\n} \
+    "To set the parent branch, run:\n\n" \
+    "  twig diff-branch <parent branch name> -b #{target_branch}"
 end

data/bin/twig-create-branch

@@ -1,20 +1,45 @@
 #!/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
+def help_content
+  <<-HELP
+
+twig-create-branch
+==================
+
+Creates a branch and sets its `diff-branch` property to the previous branch name.
+
+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`.
+
+See also
+--------
+
+  twig-checkout-child
+  twig-checkout-parent
+
+Subcommand for Twig: <http://rondevera.github.io/twig/>
+Author: Ron DeVera <http://rondevera.com>
+
+  HELP
+end
+
+args = ARGV.dup
+
+if args.include?('--help')
+  puts help_content
+  exit
+end
+
+new_branch_name = (args[0] || '').strip
 abort 'Usage: twig create-branch <branch name>' if new_branch_name.empty?
 
 current_branch_name = `git rev-parse --abbrev-ref HEAD`.strip