thunder 0.6.3 → 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1250c4a71eb698607638e27011a1f6c97ce1c579
+  data.tar.gz: 9d6bb6dc9b8c72bbf53d70efa298dc51794f7cdf
+SHA512:
+  metadata.gz: d2228226de16c78009f1c32a07bed754d1b518dfb8dadf0490360f9e2aa5face229d66db57ab48e59ea292b678854708c95ae0f433dc0c9faf23752b20391237
+  data.tar.gz: 94c8cfcfdaeec9a1e2c9e6f349fa62bfc1293e4a2b161753255f83039507864eb984fa945b162d304433b42123f3ce983a00dda77db73a8edae043c92b8e7012

data/bin/thunder-completion

@@ -7,11 +7,9 @@ def thunder_commands(spec)
   spec[:commands].map(&:first).map(&:to_s)
 end
 
-def thunder_options(command)
-  return nil unless command[:options]
-
+def thunder_options(spec)
   result = []
-  command[:options].each do |opt, option|
+  spec.each do |opt, option|
     result << "--#{opt}"
     next unless option[:short]
     result << "-#{option[:short]}"
@@ -27,9 +25,39 @@ def indent(text, amount, indent=" ")
   return result
 end
 
+def thunder_completion_options(spec)
+  default_template = ERB.new <<-TEMPLATE, nil, "%>"
+if [[ $current_word == "-" ]]; then
+    words="<%= thunder_options(spec).join(" ") %>"
+fi
+  TEMPLATE
+  default_template.filename="thunder-completion-options"
+  default_template = default_template.result(binding)
+  template = ERB.new <<-TEMPLATE, nil, "%>"
+% complex_options = false
+% complex_options = true if spec.values.any? { |option| option[:type] != Thunder::Boolean }
+% if complex_options
+case $previous_word; in
+%   spec.select { |name, option| option[:type] != Thunder::Boolean }.each do |name, option|
+    <%= ["--"+name.to_s, option[:short] ? "-"+option[:short].to_s : nil ].compact.join("|") %>)
+        # placeholder for proper completion
+        ;;
+%   end
+    *)
+<%= indent(default_template, 8) %>
+        ;;
+esac
+% else
+<%= default_template %>
+% end
+  TEMPLATE
+  template.filename="thunder-completion-options-complex"
+  return template.result(binding)
+end
+
 def thunder_completion(depth, spec)
-    template = ERB.new <<-TEMPLATE, nil, "%>"
-if ((COMP_CWORD == <%= depth+1 %>)); then
+  template = ERB.new <<-TEMPLATE, nil, "%>"
+if (($which_word == <%= depth+1 %>)); then
     # display only commands
     words="<%= thunder_commands(spec).join(" ") %>"
 else
@@ -41,9 +69,7 @@ else
         words="<%= thunder_commands(spec).join(" ") %>"
 %   end
 %   if command[:options]
-        if [[ ${COMP_WORDS[COMP_CWORD]:0:1} == "-" ]]; then
-            words="<%= thunder_options(command).join(" ") %>"
-        fi
+<%= indent(thunder_completion_options(command[:options]), 8) %>
 %   end
 %   if command[:subcommand]
 <%= indent(thunder_completion(depth+1, command[:subcommand].class.thunder), 8) %>
@@ -52,8 +78,9 @@ else
 % end
     esac
 fi
-    TEMPLATE
-    return template.result(binding)
+  TEMPLATE
+  template.filename="thunder-completion-main-#{depth}"
+  return template.result(binding)
 end
 
 module Thunder
@@ -63,13 +90,23 @@ module Thunder
 
 % progname = File.basename(ARGV.first)
 __<%= progname %>_completion() {
+    local current_word=${COMP_WORDS[COMP_CWORD]}
+    local previous_word=${COMP_WORDS[COMP_CWORD-1]}
+    local all_words=("${COMP_WORDS[@]}")
+    local which_word=$COMP_CWORD
+    if [[ $current_word == *"="* ]]; then
+        previous_word=${current_word%=*}
+        current_word=${current_word#*=}
+    fi
+
     local words=""
 <%= indent(thunder_completion(0, self.class.thunder), 4) %>
-    COMPREPLY=($(compgen -W "$words" -- ${COMP_WORDS[COMP_CWORD]}))
+    COMPREPLY=($(compgen -W "$words" -- $current_word))
 }
 
 complete -o default -o nospace -F __<%= progname %>_completion <%= progname %>
     TEMPLATE
+    template.filename="thunder-complete-start"
     puts template.result(binding)
   end
 end

data/bin/thunder-manual

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+
+require File.expand_path("../../lib/thunder", __FILE__)
+require 'erb'
+
+def generate_man_page(script_name, spec)
+  template = ERB.new <<-TEMPLATE, nil, "%"
+.TH <%= script_name.upcase %> 1 "<%= Time.new.strftime("%d %b %Y") %>" "<%= script_name.to_s %> 1.0" "<%= script_name.to_s %> Manual"
+.SH NAME
+<%= script_name %> \\- very short summary of your program
+.SH SYNOPSIS
+% spec[:commands].each do |_, command|
+.PP
+.B <%= script_name %> <%= command[:name].to_s %>
+%   (command[:params] || []).each do |type, param|
+%     next if command[:options] and param == :options
+%     case type
+%     when :req
+.I <%= param.to_s %>
+%     when :opt
+[ \\fI<%= param.to_s %>\\fR ]
+%     when :rest
+[ \\fI<%= param.to_s %>\\fR... ]
+%     when :block
+%     end
+%   end
+%   (command[:options] || []).each do |_, option|
+[ \\fB\\-\\-<%= option[:name] %><%= " \\\\fI"+option[:name].to_s unless option[:type] == Thunder::Boolean %> \\fR]
+%   end
+% end
+.SH DESCRIPTION
+<%= script_name %> prints the string "Hello world" on standard output.
+.SH COMMANDS
+% spec[:commands].each do |_, command|
+.SS "<%= command[:name].to_s %>"
+<%= command[:description] unless command[:description].empty? %>
+<%= (command[:long_description] || "").split(".").join(".\n") %>
+%   (command[:options] || []).each do |_, option|
+.B --<%= option[:name] %><%= " \\\\fI"+option[:name].to_s+"\\\\fR" unless option[:type] == Thunder::Boolean %>
+.RS
+<%= option[:description] || "This option does xxx" %>
+.RE
+%   end
+% end
+.SH AUTHOR
+Anon Y. Mouse
+  TEMPLATE
+  template.filename="thunder-manual-start"
+  return template.result(binding).split("\n").reject(&:empty?).join("\n")
+end
+
+module Thunder
+  def start(args=ARGV.dup, options={})
+    puts generate_man_page(ARGV.first, self.class.thunder)
+  end
+end
+
+if ARGV.size != 1
+  puts "Usage: #{File.basename(__FILE__)} THUNDER_SCRIPT"
+  puts
+  puts "Prints out the suggested template for a bash completion script for the given thunder script"
+  exit 1
+end
+
+load File.expand_path(ARGV.first)

data/lib/thunder/help/default.rb

@@ -48,7 +48,7 @@ Usage:
     # @return [(String, String)] the formatted option and its description
     def format_option(option_spec)
       usage = "  -#{option_spec[:short]}, --#{option_spec[:name]}"
-      usage << " [#{option_spec[:name].to_s.upcase}]" unless option_spec[:type] == Boolean
+      usage << " [#{option_spec[:name].to_s.upcase}]" unless option_spec[:type] == Thunder::Boolean
       return usage, option_spec[:desc]
     end
 

data/lib/thunder/options/trollop.rb

@@ -13,7 +13,7 @@ class Thunder::TrollopAdapter
         type = option_spec[:type]
         type = :flag if type == Thunder::Boolean
         opt_options[:type] = type
-        opt_options[:default] = option_spec[:default] if options_spec.has_key? :default
+        opt_options[:default] = option_spec[:default] if option_spec.has_key? :default
         opt_options[:short] = "-" + option_spec[:short]
 
         opt name, description, opt_options

data/lib/thunder/version.rb

@@ -1,4 +1,4 @@
 module Thunder
   # Version string for gemspec
-  VERSION = "0.6.3"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,59 +1,59 @@
 --- !ruby/object:Gem::Specification
 name: thunder
 version: !ruby/object:Gem::Version
-  version: 0.6.3
-  prerelease: 
+  version: 0.7.0
 platform: ruby
 authors:
 - Steven Karas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-09 00:00:00.000000000 Z
+date: 2013-11-11 00:00:00.000000000 Z
 dependencies: []
 description: Thunder does command line interfaces. Nothing more, nothing less.
 email: steven.karas@gmail.com
 executables:
-- thunder-completion
 - thunder-spec
+- thunder-completion
+- thunder-manual
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/thunder/help/default.rb
+- lib/thunder/version.rb
 - lib/thunder/options/optparse.rb
 - lib/thunder/options/trollop.rb
-- lib/thunder/version.rb
 - lib/thunder.rb
 - spec/spec_thunder.rb
-- DESIGN.md
 - Rakefile
+- DESIGN.md
 - README.md
-- bin/thunder-completion
 - bin/thunder-spec
+- bin/thunder-completion
+- bin/thunder-manual
 homepage: http://stevenkaras.github.com/thunder
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Thunder makes command lines apps easy!
 test_files: []
 has_rdoc: