thunder 0.6.1 → 0.6.2

data/README.md

@@ -2,11 +2,18 @@
 =======
 Ruby gem for quick and easy command line interfaces
 
+[![Gem Version](https://badge.fury.io/rb/thunder.png)](http://badge.fury.io/rb/thunder)
+[![Code Climate](https://codeclimate.com/github/stevenkaras/thunder.png)](https://codeclimate.com/github/stevenkaras/thunder)
+
 Usage
 -----
 
     gem install thunder
 
+or if you're running ruby 1.9.3:
+
+    gem install thunder-1.9.3
+
 or if you're running [ruby 1.8.7](http://www.ruby-lang.org/en/news/2011/10/06/plans-for-1-8-7):
 
     gem install thunder-1.8.7

data/bin/thunder-completion

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require 'thunder'
+require File.expand_path("../../lib/thunder", __FILE__)
 require 'erb'
 
 def thunder_commands(spec)

data/bin/thunder-spec

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require 'thunder'
+require File.expand_path("../../lib/thunder", __FILE__)
 require 'pp'
 
 module Thunder

data/lib/thunder.rb

@@ -10,14 +10,11 @@ module Thunder
   # Start the object as a command line program,
   # processing the given arguments and using the provided options.
   #
-  # @param args [<String>] the command line arguments [ARGV]
-  # @param options [{Symbol => *}] the default options to use [{}]
-  def start(args=ARGV.dup, options={})
+  # @param args [<String>] (ARGV) the command line arguments
+  # @param options [{Symbol => *}] ({}) the default options to use
+  def start(args = ARGV.dup, options = {})
     command_spec = determine_command(args)
-
-    unless command_spec
-      return
-    end
+    return unless command_spec
 
     if command_spec[:name] == :help && command_spec[:default_help]
       return get_help(args, options)
@@ -25,12 +22,10 @@ module Thunder
 
     parsed_options = process_options(args, command_spec)
     options.merge!(parsed_options) if parsed_options
-    if command_spec[:subcommand]
-      return command_spec[:subcommand].start(args, options)
-    end
-    if parsed_options
-      args << options
-    end
+
+    return command_spec[:subcommand].start(args, options) if command_spec[:subcommand]
+
+    args << options if parsed_options
 
     if command_spec[:params]
       min = command_spec[:params].count { |param| param.first == :req}
@@ -82,7 +77,7 @@ module Thunder
     return nil unless command_spec[:options]
 
     unless self.class.thunder[:options_processor]
-      require 'thunder/options/optparse'
+      require File.expand_path("../thunder/options/optparse", __FILE__)
       self.class.thunder[:options_processor] = Thunder::OptParseAdapter
     end
     self.class.thunder[:options_processor].process_options(args, command_spec)
@@ -93,7 +88,7 @@ module Thunder
   # @param args [<String>] the arguments list
   # @param options [Hash] any included options
   def get_help(args, options)
-    if args.size == 0
+    if args.empty?
       puts help_list(self.class.thunder[:commands])
     else
       puts help_command(determine_command(args))
@@ -105,11 +100,7 @@ module Thunder
   # @param commands [<Hash>] the commands to list
   # @return [String] the rendered help
   def help_list(commands)
-    unless self.class.thunder[:help_formatter]
-      require 'thunder/help/default'
-      self.class.thunder[:help_formatter] = Thunder::DefaultHelp
-    end
-    self.class.thunder[:help_formatter].help_list(commands)
+    self.class.get_help_formatter.help_list(commands)
   end
 
   # Render detailed help on a specific command
@@ -117,11 +108,7 @@ module Thunder
   # @param command_spec [Hash] the command to render detailed help for
   # @return [String] the rendered help
   def help_command(command_spec)
-    unless self.class.thunder[:help_formatter]
-      require 'thunder/help/default'
-      self.class.thunder[:help_formatter] = Thunder::DefaultHelp
-    end
-    self.class.thunder[:help_formatter].help_command(command_spec)
+    self.class.get_help_formatter.help_command(command_spec)
   end
 
   public
@@ -152,6 +139,14 @@ module Thunder
       }
     end
 
+    def get_help_formatter
+      unless thunder[:help_formatter]
+        require File.expand_path("../thunder/help/default", __FILE__)
+        thunder[:help_formatter] = Thunder::DefaultHelp
+      end
+      thunder[:help_formatter]
+    end
+
     # @api private
     # Registers a method as a thunder task
     def method_added(method)

data/lib/thunder/help/default.rb

@@ -1,92 +1,90 @@
-module Thunder
-  # Provides an easy to parse help formatter
-  class DefaultHelp
-    class << self
+# Provides an easy to parse help formatter
+class Thunder::DefaultHelp
+  class << self
 
-      # @see Thunder#help_command(command_spec)
-      def help_command(command_spec)
-        preamble = determine_preamble
-        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
+    # @see Thunder#help_command(command_spec)
+    def help_command(command_spec)
+      preamble = determine_preamble
+      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]}
 
 #{footer.strip}
-        EOS
-        output.rstrip
-      end
+      EOS
+      output.rstrip
+    end
 
-      # @see Thunder#help_list(commands)
-      def help_list(commands)
-        preamble = determine_preamble
-        help = []
-        commands.each do |name, command_spec|
-          help << short_help(preamble, command_spec)
-        end
-        render_table(help)
+    # @see Thunder#help_list(commands)
+    def help_list(commands)
+      preamble = determine_preamble
+      help = []
+      commands.each do |name, command_spec|
+        help << short_help(preamble, command_spec)
       end
+      render_table(help)
+    end
 
-      private
+    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, ": ")
+    # 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
+    # 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
-      def determine_preamble
-        preamble = "#{File.basename($0)}"
-        ARGV.each do |arg|
-          break if arg == "help"
-          preamble << " #{arg}"
-        end
-        preamble
+    # determine the preamble
+    #
+    # @return [String] the preamble
+    def determine_preamble
+      preamble = "#{File.basename($0)}"
+      ARGV.each do |arg|
+        break if arg == "help"
+        preamble << " #{arg}"
       end
+      preamble
+    end
 
-      # render the short help string for a command
-      #
-      # @param preamble [String] the preamble
-      # @param command_spec [Hash]
-      # @return [String] the short help string for the given command
-      def short_help(preamble, command_spec)
-        return "  #{preamble} #{command_spec[:usage]}", command_spec[:description]
-      end
+    # render the short help string for a command
+    #
+    # @param preamble [String] the preamble
+    # @param command_spec [Hash]
+    # @return [String] the short help string for the given command
+    def short_help(preamble, command_spec)
+      return "  #{preamble} #{command_spec[:usage]}", command_spec[:description]
+    end
 
-      # render a two-column table
-      #
-      # @param data [(String,String)]
-      # @param separator [String]
-      # @return [String] a two-column table
-      def render_table(data, separator = " # ")
-        column_width = data.group_by do |row|
-          row.first.size
-        end.max.first
-        "".tap do |output|
-          data.each do |row|
-            output << "%-#{column_width}s#{separator}%s\n" % row
-          end
+    # render a two-column table
+    #
+    # @param data [(String,String)]
+    # @param separator [String]
+    # @return [String] a two-column table
+    def render_table(data, separator = " # ")
+      column_width = data.group_by do |row|
+        row.first.size
+      end.max.first
+      "".tap do |output|
+        data.each do |row|
+          output << "%-#{column_width}s#{separator}%s\n" % row
         end
       end
     end

data/lib/thunder/options/optparse.rb

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

data/lib/thunder/options/trollop.rb

@@ -1,27 +1,25 @@
 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]
+# provides an adapter to the popular trollop option parsing library (requires trollop.rb be on the load path)
+class Thunder::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
+        opt name, description, opt_options
       end
-      command_spec[:option_processor].parse(args)
     end
+    command_spec[:option_processor].parse(args)
   end
 end

data/lib/thunder/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thunder
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-07 00:00:00.000000000 Z
+date: 2013-09-09 00:00:00.000000000 Z
 dependencies: []
 description: Thunder does command line interfaces. Nothing more, nothing less.
 email: steven.karas@gmail.com
@@ -31,7 +31,8 @@ files:
 - bin/thunder-completion
 - bin/thunder-spec
 homepage: http://stevenkaras.github.com/thunder
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -50,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Thunder makes command lines apps easy!