twig 1.6 → 1.7

data/bin/twig-diff

@@ -1,33 +1,52 @@
 #!/usr/bin/env ruby
 
-# Synopsis:
-#
-#   twig diff [<branch>] [<options>]
-#
-# Description:
-#
-#   Shows the diff between the current branch and its `diff-branch` property.
-#   All options are passed through to `git-diff`.
-#
-# Examples:
-#
-#   Show diff stats between the current branch and its `diff-branch`:
-#
-#     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>
+def help_content
+  <<-HELP
+
+twig-diff
+=========
+
+Shows the diff between a branch and its parent branch (`diff-branch`).
+
+Synopsis
+--------
+
+  twig diff [<branch>] [<options>]
+
+Description
+-----------
+
+  Shows the diff between the current branch and its `diff-branch` property. All
+  options are passed through to `git-diff`.
+
+Examples
+--------
+
+  Show diff stats between the current branch and its `diff-branch`:
+
+    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>
+
+  HELP
+end
 
 args = ARGV.dup
 
+if args.include?('--help')
+  puts help_content
+  exit
+end
+
 branch_given = args.any? && args.first[0, 1] != '-'
 topic_branch = args.shift.strip if branch_given           # Use given branch
 topic_branch ||= `git rev-parse --abbrev-ref HEAD`.strip  # Use current branch

data/bin/twig-gh-open

@@ -1,26 +1,52 @@
 #!/usr/bin/env ruby
 
-# 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>
-
 require 'rubygems'
 require 'twig'
 require 'launchy'
 
+def help_content
+  <<-HELP
+
+twig-gh-open
+============
+
+Opens a browser window for the current GitHub repository.
+
+Synopsis
+--------
+
+  twig gh-open
+
+Description
+-----------
+
+  Opens a browser window for the current GitHub repository.
+
+  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
+
+See also
+--------
+
+  twig-gh-open-issue
+  twig-gh-update
+
+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::GithubRepo.new do |gh_repo|
   twig = Twig.new(:read_options => true)
   gh_uri_prefix = twig.options[:github_uri_prefix]

data/bin/twig-gh-open-issue

@@ -1,30 +1,57 @@
 #!/usr/bin/env ruby
 
-# Synopsis:
-#
-#   twig gh-open-issue [-b|--branch <branch>]
-#
-# Description:
-#
-#   Opens a browser window the GitHub issue, if any, for the current branch.
-#
-#   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
-#
-# Options:
-#
-#   `-b` or `--branch`: Opens the GitHub issue, if any, for the given branch.
-#
-# Subcommand for Twig: <http://rondevera.github.io/twig/>
-# Author: Ron DeVera <http://rondevera.com>
-
 require 'rubygems'
 require 'twig'
 require 'launchy'
 
+def help_content
+  <<-HELP
+
+twig-gh-open-issue
+==================
+
+Opens a browser window for a branch's GitHub issue, if any.
+
+Synopsis
+--------
+
+  twig gh-open-issue [-b|--branch <branch>]
+
+Description
+-----------
+
+  Opens a browser window for the GitHub issue, if any, for the current branch.
+
+  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
+
+Options
+-------
+
+  `-b` or `--branch`: Opens the GitHub issue, if any, for the given branch.
+
+See also
+--------
+
+  twig-gh-open
+  twig-gh-update
+
+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::GithubRepo.new do |gh_repo|
   twig = Twig.new(:read_options => true)
   target_branch_name = twig.target_branch_name
@@ -35,8 +62,9 @@ Twig::GithubRepo.new do |gh_repo|
   end
 
   gh_uri_prefix = twig.options[:github_uri_prefix]
-  url = "#{gh_uri_prefix}/#{gh_repo.username}/#{gh_repo.repository}"
-  url << "/issues/#{issue_id}"
+  url =
+    "#{gh_uri_prefix}/#{gh_repo.username}/#{gh_repo.repository}" \
+    "/issues/#{issue_id}"
 
   puts "GitHub issue URL: #{url}"
   Launchy.open(url) rescue nil

data/bin/twig-gh-update

@@ -1,28 +1,54 @@
 #!/usr/bin/env ruby
 
-# Synopsis:
-#
-#   twig gh-update
-#
-# Description:
-#
-#   Updates each branch with the latest issue status on GitHub.
-#
-#   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>
-
-require File.join(File.dirname(__FILE__), '..', 'lib', 'twig')
 require 'rubygems'
+require 'twig'
 require 'json'
 require 'net/https'
 require 'uri'
 
+def help_content
+  <<-HELP
+
+twig-gh-update
+==============
+
+Updates each branch with the latest issue status on GitHub.
+
+Synopsis
+--------
+
+  twig gh-update
+
+Description
+-----------
+
+  Updates each branch with the latest issue status on GitHub.
+
+  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
+
+See also
+--------
+
+  twig-gh-open
+  twig-gh-open-issue
+
+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)
 
 Twig::GithubRepo.new do |gh_repo|
@@ -39,7 +65,7 @@ Twig::GithubRepo.new do |gh_repo|
   ]
   user_agent = "Twig/#{Twig::VERSION} (for Git; <#{Twig::HOMEPAGE}>)"
 
-  error = "\n\nERROR: Couldn't get open issues from GitHub." <<
+  error = "\n\nERROR: Couldn't get open issues from GitHub." \
     "\n- API endpoints: " << issues_uris.map { |uri| "<#{uri}>" }.join(', ')
 
   begin
@@ -62,7 +88,7 @@ Twig::GithubRepo.new do |gh_repo|
         abort error + "\n- Response: #{response.code}"
       end
     end
-  rescue OpenSSL::SSL::SSLError => exception
+  rescue OpenSSL::SSL::SSLError
     abort error
   end
 

data/bin/twig-help

@@ -1,8 +1,52 @@
 #!/usr/bin/env ruby
 
-# Your friendly neighborhood `twig --help` alias.
-#
-# Subcommand for Twig: <http://rondevera.github.io/twig/>
-# Author: Ron DeVera <http://rondevera.com>
+def help_content
+  <<-HELP
 
-exec('twig --help')
+twig-help
+=========
+
+Provides help for Twig and its subcommands.
+
+Synopsis
+--------
+
+  twig help [<subcommand>]
+
+Description
+-----------
+
+  Shows help content for Twig and for its built-in subcommands.
+
+  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.
+
+Examples
+--------
+
+  Show help content for Twig:
+
+    twig help
+
+  Show help content for a Twig subcommand, e.g., `twig-rebase`:
+
+    twig help rebase
+
+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
+
+subcommand = args[0] || ''
+
+# If no subcommand was given, default to `twig --help`
+exec("twig #{subcommand} --help")

data/bin/twig-init

@@ -1,15 +1,48 @@
 #!/usr/bin/env ruby
 
-# Synopsis:
-#
-#   twig init
-#
-# Description:
-#
-#   Runs all initialization commands. This is only needed once after installing
-#   Twig, and affects all Git repositories.
-#
-# Subcommand for Twig: <http://rondevera.github.io/twig/>
-# Author: Ron DeVera <http://rondevera.com>
-
-exec('twig init-completion')
+def help_content
+  <<-HELP
+
+twig-init
+=========
+
+Runs all Twig setup commands.
+
+Synopsis
+--------
+
+  twig init
+
+Description
+-----------
+
+  Runs all setup commands. This is only needed once after installing Twig, and
+  affects all Git repositories.
+
+See also
+--------
+
+  twig-init-completion
+  twig-init-config
+
+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
+
+commands = [
+  'echo',
+  'twig init-config',
+  'twig init-completion',
+  'echo "*** Twig is almost ready! Follow the steps above,  ***"',
+  'echo "*** then run \`twig\` or \`twig help\` to get started. ***"'
+]
+exec commands.join(';')