twig 1.6 → 1.7

data/bin/twig-init-completion

@@ -1,24 +1,51 @@
 #!/usr/bin/env ruby
 
-# Synopsis:
-#
-#   twig init-completion [--force]
-#
-# Description:
-#
-#   Initializes tab completion for Twig. Instead of running this directly,
-#   run `twig init` to run all setup tasks.
-#
-# Options:
-#
-#   `--force`: By default, `twig init-completion` preserves the existing tab
-#   completion script, if any. If this option is used, the command will
-#   overwrite any existing tab completion script.
-#
-# Subcommand for Twig: <http://rondevera.github.io/twig/>
-# Author: Ron DeVera <http://rondevera.com>
-
-args  = ARGV.dup
+def help_content
+  <<-HELP
+
+twig-init-completion
+====================
+
+Initializes tab completion for Twig. Use `twig init` to run all setup.
+
+Synopsis
+--------
+
+  twig init-completion [--force]
+
+Description
+-----------
+
+  Initializes tab completion for Twig. Instead of running this directly,
+  run `twig init` to run all setup tasks.
+
+Options
+-------
+
+  `--force`: By default, `twig init-completion` preserves the existing tab
+  completion script, if any. If this option is used, the command will
+  overwrite any existing tab completion script.
+
+See also
+--------
+
+  twig-init
+  twig-init-completion-bash
+  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
+
 debug = args.delete('--debug')
 bash_version = `bash -c 'echo $BASH_VERSION'`.strip
 

data/bin/twig-init-completion-bash

@@ -1,21 +1,48 @@
 #!/usr/bin/env ruby
 
-# Synopsis:
-#
-#   twig init-completion-bash
-#
-# Description:
-#
-#   Initializes bash tab completion for Twig. Instead of running this directly,
-#   run `twig init` to run all setup tasks for the current shell. Uses all
-#   options available for `twig init-completion`.
-#
-# Subcommand for Twig: <http://rondevera.github.io/twig/>
-# Author: Ron DeVera <http://rondevera.com>
-
-require 'fileutils'
 require 'rubygems'
 require 'twig'
+require 'fileutils'
+
+def help_content
+  <<-HELP
+
+twig-init-completion-bash
+=========================
+
+Initializes bash tab completion for Twig. Use `twig init` to run all setup.
+
+Synopsis
+--------
+
+  twig init-completion-bash
+
+Description
+-----------
+
+  Initializes bash tab completion for Twig. Instead of running this directly,
+  run `twig init` to run all setup tasks for the current shell. Uses all
+  options available for `twig init-completion`.
+
+See also
+--------
+
+  twig-init
+  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
 
 script = <<-SCRIPT
 
@@ -78,9 +105,6 @@ complete -F __twig twig
 SCRIPT
 script = script.strip + "\n"
 
-
-
-args  = ARGV.dup
 force = args.delete('--force')
 
 twig_dir = '~/.twig'
@@ -88,28 +112,29 @@ FileUtils.mkdir_p(File.expand_path(twig_dir))
 
 script_path      = File.join(twig_dir, '/twig-completion.bash')
 full_script_path = File.expand_path(script_path)
-script_exists    = File.exists?(full_script_path)
+script_exists    = File.exist?(full_script_path)
 
 if script_exists && !force
   twig = Twig.new
   puts twig.format_string("The file `#{script_path}` already exists.", :color => :red)
-  puts "To overwrite it, run `twig init-completion --force`."
+  puts 'To overwrite it with a default file, run `twig init-completion --force`.'
 else
   File.open(full_script_path, 'w') do |file|
     file.write script
   end
 
   if script_exists
-    puts "Overwrote #{script_path}."
+    puts "Overwrote `#{script_path}`."
   else
-    puts "Created #{script_path}."
+    puts "Created `#{script_path}`."
   end
 end
 
 puts
-puts 'To enable tab completion for Twig, add the following to your `~/.bashrc`'
-puts 'or equivalent:'
+puts ' => To enable tab completion for Twig, add the following to your `~/.bashrc`'
+puts '    or equivalent:'
+puts
+puts "      [[ -s #{script_path} ]] && source #{script_path}"
 puts
-puts "  [[ -s #{script_path} ]] && source #{script_path}"
+puts ' => To finish setup, open a new command-line window or run `source ~/.bashrc`.'
 puts
-puts 'To finish setup, open a new command-line window or run `source ~/.bashrc`.'

data/bin/twig-init-config

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'twig'
+require 'fileutils'
+
+def help_content
+  <<-HELP
+
+twig-init-config
+================
+
+Creates a default `~/.twigconfig` file. Use `twig init` to run all setup.
+
+Synopsis
+--------
+
+  twig init-config [--force]
+
+Description
+-----------
+
+  Creates a default `.twigconfig` file in your home directory. Instead of
+  running this directly, run `twig init` to run all setup tasks.
+
+Options
+-------
+
+  `--force`: By default, `twig init-config` preserves the existing
+  `.twigconfig` file, if any. If this option is used, the command will
+  overwrite any existing config file.
+
+See also
+--------
+
+  twig-init
+  twig-init-completion
+
+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
+
+force = args.delete('--force')
+
+config_path      = Twig::Options::CONFIG_PATH
+full_config_path = File.expand_path(config_path)
+config_exists    = File.exist?(full_config_path)
+
+if config_exists && !force
+  twig = Twig.new
+  puts twig.format_string("The file `#{config_path}` already exists.", :color => :red)
+  puts 'To overwrite it with a default file, run `twig init-config --force`.'
+else
+  config_template_path = File.expand_path(
+    File.join(File.dirname(__FILE__), '..', 'config', 'twigconfig')
+  )
+  FileUtils.cp(config_template_path, full_config_path)
+
+  if config_exists
+    puts "Overwrote `#{config_path}`."
+  else
+    puts "Created `#{config_path}`."
+  end
+end
+
+puts
+puts " => You can edit `#{config_path}` to customize Twig's appearance and behavior."
+puts

data/bin/twig-rebase

@@ -1,46 +1,98 @@
 #!/usr/bin/env ruby
 
-# Synopsis:
-#
-#   twig rebase [<branch>] [<options>]
-#
-# Description:
-#
-#   Rebases the current branch onto the branch in its `diff-branch` property.
-#   All options are passed through to `git-rebase`.
-#
-# Examples:
-#
-#   Rebase the current branch onto its `diff-branch` interactively:
-#
-#     twig rebase -i
-#
-#   Rebase the given branch onto its `diff-branch`:
-#
-#     twig rebase my_branch
-#
-#   Rebase the given branch onto its `diff-branch` interactively:
-#
-#     twig rebase my_branch -i
-#
-# Subcommand for Twig: <http://rondevera.github.io/twig/>
-# Author: Ron DeVera <http://rondevera.com>
+require 'rubygems'
+require 'twig'
+
+def help_content
+  <<-HELP
+
+twig-rebase
+===========
+
+Rebases a branch onto its parent branch (`diff-branch`).
+
+Synopsis
+--------
+
+  twig rebase [<branch>] [<options>]
+
+Description
+-----------
+
+  Rebases the current branch onto the branch in its `diff-branch` property.
+  All options except `--autoconfirm` are passed through to `git-rebase`.
+
+Options
+-------
+
+  `--autoconfirm`: Automatically confirm rebasing the branch onto its parent
+  branch without prompting. To automatically confirm whenever running
+  `twig rebase`, set `twig-rebase-autoconfirm` in `~/.twigconfig`.
+
+Examples
+--------
+
+  Rebase the current branch onto its `diff-branch` interactively:
+
+    twig rebase -i
+
+  Rebase the given branch onto its `diff-branch`:
+
+    twig rebase my_branch
+
+  Rebase the given branch onto its `diff-branch` interactively:
+
+    twig rebase my_branch -i
+
+  Skip the prompt when rebasing:
+
+    twig rebase --autoconfirm
+
+  Skip the prompt every time you use `twig-rebase`:
+
+    echo 'twig-rebase-autoconfirm: true' >> ~/.twigconfig
+
+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
+twig.read_config_file!
+  # Only read options from the config file, not from arguments, because most
+  # of the latter is passed through to `git-rebase`.
+
 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
 
-base_branch    = `twig diff-branch -b "#{topic_branch}"`.strip
-rebase_options = args.join(' ') # Pass remaining options to `git-rebase`
-
+base_branch = `twig diff-branch -b "#{topic_branch}"`.strip
 abort if base_branch.empty?
 
-print %{Rebase "#{topic_branch}" onto "#{base_branch}"? (y/n) }
-input = $stdin.gets.strip.downcase
-if input == 'y' || input == 'yes'
-  exec %{git rebase #{rebase_options} "#{base_branch}" "#{topic_branch}"}
+twig_rebase_options = [args.delete('--autoconfirm')] # Twig-specific options
+git_rebase_options  = args.join(' ') # Pass remaining options to `git-rebase`
+
+autoconfirm =
+  twig.options[:twig_rebase_autoconfirm] ||     # Option set via config file
+  twig_rebase_options.include?('--autoconfirm') # Option set via CLI
+
+if autoconfirm
+  puts %{Rebasing "#{topic_branch}" onto "#{base_branch}"...}
+else
+  print %{Rebase "#{topic_branch}" onto "#{base_branch}"? (y/n) }
+  input = $stdin.gets.strip.downcase
+end
+
+if autoconfirm || input == 'y' || input == 'yes'
+  exec %{git rebase #{git_rebase_options} "#{base_branch}" "#{topic_branch}"}
 else
-  puts 'Cancelled.'
+  abort 'Cancelled.'
 end

data/config/twigconfig

@@ -0,0 +1,47 @@
+# This file belongs at `~/.twigconfig`. You can regenerate it with `twig init`.
+#
+# For more info, run `twig help` or visit <http://rondevera.github.io/twig/>.
+
+
+### Filtering branches ###
+
+# Limit how many branches you list when running `twig`:
+# (Temporarily override with `twig --all`)
+max-days-old: 30
+
+
+### Displaying branches ###
+
+# Set the width of the `branch` column:
+# (Use `<property>-width` to set the width of any property column, e.g.,
+# `todo-width: 30`)
+branch-width: 30
+
+# Customize the headers above each column (e.g., "red", "blue bold"):
+# header-style: blue bold
+
+# Set to `true` to list the oldest branches first:
+# reverse: true
+
+# Hide branches that have a property value matching a regex:
+# except-branch: production_release_*
+# except-status: closed|resolved
+
+# Hide columns where the property name matches a regex:
+# (e.g., Hide long todos; hide issue tracker metadata)
+# except-property: todo
+
+
+### GitHub integration ###
+
+# If you're working with GitHub Enterprise repositories, change these to match
+# your installation. This will let you use `twig gh-update`, `twig gh-open`, and
+# `twig gh-open-issue`:
+# github-api-uri-prefix: 'https://api.my-github-enterprise.example.com'
+# github-uri-prefix:     'https://my-github-enterprise.example.com'
+
+
+### Subcommands ###
+
+# Set to `true` to skip prompts when using `twig rebase`:
+# twig-rebase-autoconfirm: true

data/lib/twig.rb

@@ -1,4 +1,5 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__)) # For gem development
+require 'shellwords'
 require 'twig/branch'
 require 'twig/cli'
 require 'twig/commit_time'
@@ -24,8 +25,9 @@ class Twig
   DEFAULT_GITHUB_URI_PREFIX = 'https://github.com'
   DEFAULT_HEADER_COLOR = :blue
   REF_FORMAT_SEPARATOR = '|'
-  REF_FORMAT = %w[refname:short committerdate committerdate:relative].
-                map { |field| '%(' + field + ')' }.join(REF_FORMAT_SEPARATOR)
+  REF_FORMAT = %w[refname:short committerdate:iso].
+                map { |field| '%(' + field + ')' }.
+                join(REF_FORMAT_SEPARATOR)
   REF_PREFIX = 'refs/heads/'
 
   def self.run(command)
@@ -61,6 +63,10 @@ class Twig
     options[:branch] || current_branch_name
   end
 
+  def target_branch
+    Twig::Branch.new(target_branch_name)
+  end
+
   def branches
     branches = Twig::Branch.all_branches
     now = Time.now
@@ -123,17 +129,18 @@ class Twig
     end
   end
 
-
-
   ### Actions ###
 
   def list_branches
     if branches.empty?
-      if Twig::Branch.all_branches.any?
-        return 'There are no branches matching your selected options.'
-      else
-        return 'This repository has no branches.'
-      end
+      msg = 
+        if Twig::Branch.all_branches.any?
+          "There are no branches matching your selected options.\n" \
+          "To list all branches, use `twig --all`."
+        else
+          'This repository has no branches.'
+        end
+      return msg
     end
 
     out = "\n" << branch_list_headers(options)
@@ -159,5 +166,4 @@ class Twig
     branch = Branch.new(branch_name)
     branch.unset_property(property_name)
   end
-
 end