thunder 0.4.1 → 0.4.2

data/CHANGELOG

@@ -1,3 +1,12 @@
+v0.4.2
+- fixed boolean flags in default options processor
+- default help formatter now strips whitespace properly
+- all options now have optional arguments
++ default values are now set properly
++ added trollop adapter for option processing
++ improved documentation and help formatting for options
+- fixed handling of ARGV and subcommands
+
 v0.4.1
 - fixed fatal options processing bug
 

data/README.md

@@ -2,10 +2,19 @@ Thunder
 =======
 Ruby gem for quick and easy command line interfaces
 
+Usage
+-----
+
+    gem install thunder
+
+see 'sample' for a quick overview of all features
+
 Philosophy
 ----------
 The command line is the most basic interface we have with a computer. It makes sense that we should invest as much time and effort as possible to build tools to work with the command line, and tie into code we write as quickly as possible. Sadly, this has not taken place as much as one would expect. This library steps up to bridge the admittedly small gap between your standard shell and ruby code.
 
+While this is possible, and even easy using existing libraries, they either violate the principle of locality, or provide too many services.
+
 The overarching philosophy here is that a library should do one or two things, and do them extremely well.
 
 Goals
@@ -16,7 +25,7 @@ Phase 1: call a method from the command line
 Phase 2: provide options and arguments 
 Phase 3: provide help/banner formatter
 Phase 4: provide yardoc integration
-Phase 5: provide a bash-completion script.
+Phase 5: provide a bash-completion script
 Phase 6: ???
 Phase 7: Profit!
 

data/lib/thunder.rb

@@ -12,7 +12,7 @@ module Thunder
   # 
   # @param args [<String>] the command line arguments [ARGV]
   # @param options [{Symbol => *}] the default options to use [{}]
-  def start(args=ARGV, options={})
+  def start(args=ARGV.dup, options={})
     command_spec = determine_command(args)
 
     unless command_spec
@@ -56,7 +56,7 @@ module Thunder
   #
   # @param args [<String>] the argument list to process
   # @param command_spec [Hash] the command specification to use
-  # @return [{Symbol => *}] the options
+  # @return [{Symbol => *},nil] the options
   def process_options(args, command_spec)
     return nil unless command_spec[:options]
 
@@ -119,6 +119,7 @@ module Thunder
             name: :help,
             usage: "help [COMMAND]",
             description: "list available commands or describe a specific command",
+            long_description: nil,
             options: nil,
             default_help: true
           },
@@ -183,6 +184,7 @@ module Thunder
     # @option options :short [String] the short version of the option [the first letter of the option name]
     # @option options :type [Class] the datatype of this option [Boolean]
     # @option options :desc [String] the long description of this option [""]
+    # @option options :default [*] the default value
     #
     # @example
     #   option :output_file, type: String
@@ -195,18 +197,18 @@ module Thunder
       options[:name] = name
       options[:short] ||= name[0]
       options[:type] ||= Boolean
-      options[:description] ||= ""
+      options[:desc] ||= ""
       thunder[:options] ||= {}
       thunder[:options][name] = options
     end
 
     # Define a subcommand
     #
-    # @param command [String] the command that transfers processing to the provided handler
+    # @param command [Symbol,String] the command that transfers processing to the provided handler
     # @param handler [Thunder] the handler that processes the request
     def subcommand(command, handler)
-      method_added(command)
-      thunder[:commands][command][:subcommand] = handler
+      method_added(command.to_sym)
+      thunder[:commands][command.to_sym][:subcommand] = handler
     end
 
   end

data/lib/thunder/help/default.rb

@@ -7,14 +7,17 @@ module Thunder
       def help_command(command_spec)
         preamble = determine_preamble
         #TODO: add options to output
+        footer = ""
+        footer << command_spec[:description] + "\n" if command_spec[:description]
+        footer << command_spec[:long_description] + "\n" if command_spec[:long_description]
+        footer << "\n" + format_options(command_spec[:options]) if command_spec[:options]
         output = <<-EOS
 Usage:
   #{preamble} #{command_spec[:usage]}
 
-#{command_spec[:description]}
-#{command_spec[:long_description]}
+#{footer.strip}
         EOS
-        output.chomp
+        output.rstrip
       end
 
       # @see Thunder#help_list(commands)
@@ -28,6 +31,29 @@ Usage:
       end
 
       private
+
+      # format a set of option specs
+      #
+      # @param options [<Hash>] the option specs to format
+      # @return [String]
+      def format_options(options)
+        data = []
+        options.each do |name, option_spec|
+          data << format_option(option_spec)
+        end
+        "Options:\n" + render_table(data, ": ")
+      end
+
+      # format an option
+      #
+      # @param option_spec [Hash] the option spec to format
+      # @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
+        return usage, option_spec[:desc]
+      end
+
       # determine the preamble
       # 
       # @return [String] the preamble
@@ -54,13 +80,13 @@ Usage:
       # @param data [(String,String)]
       # @param separator [String]
       # @return [String] a two-column table
-      def render_table(data, separator = "#")
+      def render_table(data, separator = " # ")
         column_width = data.group_by do |data|
           data.first.size
         end.max.first
         "".tap do |output|
           data.each do |line|
-            output << "%-#{column_width}s #{separator} %s\n" % line
+            output << "%-#{column_width}s#{separator}%s\n" % line
           end
         end
       end

data/lib/thunder/options/optparse.rb

@@ -1,4 +1,4 @@
-require "optparse"
+require 'optparse'
 
 module Thunder
   # Provides an adapter to the optparse library included in the Ruby std-lib
@@ -13,12 +13,12 @@ module Thunder
           opt = []
           opt << "-#{option_spec[:short]}"
           opt << if option_spec[:type] == Boolean
-            "--[no]#{name}"
+            "--[no-]#{name}"
           else
-            "--#{name} OPT"
+            "--#{name} [#{name.to_s.upcase}]"
           end
           opt << option_spec[:type] unless option_spec[:type] == Boolean
-          opt << option_spec[:description]
+          opt << option_spec[:desc]
           parser.on(*opt) do |value|
             options[name] = value
           end
@@ -26,7 +26,18 @@ module Thunder
       end
       command_spec[:options_processor].parse!(args)
 
+      # set default values
+      command_spec[:options].each do |name, option_spec|
+        next if options.has_key? name
+        next unless option_spec[:default]
+        options[name] = option_spec[:default]
+      end
+
       return options
+    rescue OptionParser::InvalidOption => e
+      puts e
+      puts "Try --help for help."
+      exit 1
     end
   end
 end

data/lib/thunder/options/trollop.rb

@@ -0,0 +1,27 @@
+require 'trollop'
+
+module Thunder
+  # provides an adapter to the popular trollop option parsing library (requires trollop.rb be on the load path)
+  class TrollopAdapter
+    # @see Thunder#process_options
+    def self.process_options(args, command_spec)
+      return nil unless command_spec[:options]
+      #TODO: fix the unspecified option bug
+      command_spec[:option_processor] ||= Trollop::Parser.new do
+        command_spec[:options].each do |name, option_spec|
+          opt_options = {}
+          description = option_spec[:desc] || ""
+          type = option_spec[:type]
+          type = :flag if type == Thunder::Boolean
+          opt_options[:type] = type
+          default_value = option_spec[:default]
+          opt_options[:default] = default_value if default_value
+          opt_options[:short] = "-" + option_spec[:short]
+
+          opt name, description, opt_options
+        end
+      end
+      command_spec[:option_processor].parse(args)
+    end
+  end
+end

data/lib/thunder/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thunder
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-04 00:00:00.000000000 Z
+date: 2012-08-05 00:00:00.000000000 Z
 dependencies: []
 description: Thor does everything and the kitchen sink. Thunder only does command
   line interfaces.
@@ -20,6 +20,7 @@ extra_rdoc_files: []
 files:
 - lib/thunder/help/default.rb
 - lib/thunder/options/optparse.rb
+- lib/thunder/options/trollop.rb
 - lib/thunder/version.rb
 - lib/thunder.rb
 - spec/spec_thunder.rb