climate 0.5.0 → 0.6.0

data/README.md

@@ -7,6 +7,11 @@ structure.
 
 Designed for both simple and more complex cases.
 
+ - Embed a CLI in to your application
+ - Builds on trollop, a refreshingly sane option parsing library
+ - N-levels of subcommands
+ - Nice help output
+
 # Easy
 
 Useful for one-shot scripts:
@@ -29,14 +34,13 @@ Useful for one-shot scripts:
 
 This style is intended for embedding a CLI in to your existing application.
 
-    class Parent < Climate::Command
-      name 'thing'
+    class Parent < Climate::Command('thing')
       description "App that does it all, yet without fuss"
       opt    :log, "Whether to log to stdout" :default => false
     end
 
     class Arbitrary < Climate::Command
-      name 'arbitrary'
+      set_name 'arbitrary'
       subcommand_of, Parent
       description "Do something arbitrary to a file"
       arg    :path "Path to input file"

data/lib/climate/command.rb

@@ -131,7 +131,7 @@ module Climate
         command_name, *arguments = parent.leftovers
 
         if command_name.nil?
-          raise MissingArgumentError.new("command #{parent.class.command_name}" +
+          raise MissingSubcommandError.new("command #{parent.class.command_name}" +
             " expects a subcommand as an argument", parent)
         end
 

data/lib/climate/errors.rb

@@ -50,6 +50,7 @@ module Climate
 
   # Raised when a {Command} is run with insufficient arguments
   class MissingArgumentError < ParsingError ; end
+  class MissingSubcommandError < MissingArgumentError ; end
 
   # Raised when two or more options conflict
   class ConflictingOptionError < ParsingError ; end

data/lib/climate/script.rb

@@ -10,7 +10,11 @@ module Climate
         @included = true
         at_exit do
           Climate.with_standard_exception_handling do
-            othermodule.send(:parse_argv)
+            begin
+              othermodule.send(:parse_argv)
+            rescue Trollop::HelpNeeded => e
+              raise HelpNeeded.new(othermodule)
+            end
             othermodule.send(:run)
           end
         end
@@ -35,7 +39,7 @@ module Climate
     attr_reader :arguments, :options, :leftovers
 
     def ancestors ; [self] ; end
-    def name ; File.basename($CLIMATE_PROGRAM_NAME || $PROGRAM_NAME) ; end
+    def command_name ; File.basename($CLIMATE_PROGRAM_NAME || $PROGRAM_NAME) ; end
 
     def has_subcommands? ; false ; end
 

data/lib/climate/version.rb

@@ -1,3 +1,3 @@
 module Climate
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/lib/climate.rb

@@ -2,38 +2,59 @@ require 'trollop'
 
 module Climate
 
-  def self.with_standard_exception_handling(options={}, &block)
+  def self.error_messages
     error_messages = {
-      UnexpectedArgumentError => 'Unknown argument',
-      UnknownCommandError => 'Unknown command',
-      MissingArgumentError => 'Missing argument',
-      ConflictingOptionError => 'Conflicting options given'
+      UnexpectedArgumentError =>
+      proc {|e| "Unknown argument: #{e}" },
+      UnknownCommandError =>
+      proc {|e| "Unknown command '#{e}': #{e.command_class.ancestors.map(&:command_name).join(' ')} expects one of: #{e.command_class.subcommands.map(&:command_name).join(' ')}" },
+      MissingArgumentError =>
+      proc {|e| "Missing argument: #{e.message}" },
+      MissingSubcommandError =>
+      proc {|e| "Missing argument: #{e.command_class.ancestors.map(&:command_name).join(' ')} expects one of: #{e.command_class.subcommands.map(&:command_name).join(' ')}" },
+      ConflictingOptionError =>
+      proc {|e| "Conflicting options given: #{e}" }
     }
+  end
 
+  def self.with_standard_exception_handling(options={}, &block)
     begin
       yield
-    rescue ExitException => e
-      # exit silently if there is no error message to print out
-      $stderr.puts(e.message) if e.has_message?
-      exit(e.exit_code)
-    rescue HelpNeeded => e
-      print_usage(e.command_class, options)
-      exit(0)
-    rescue ParsingError => e
-      $stderr.puts(error_messages[e.class] + ": #{e.message}")
-      print_usage(e.command_class, options)
-      exit(1)
     rescue => e
-      $stderr.puts("Unexpected error: #{e.class.name} - #{e.message}")
-      $stderr.puts(e.backtrace)
-      exit(2)
+      exit handle_error(e, options)
     end
   end
 
-  def self.print_usage(command_class, options={})
-    help = Help.new(command_class)
+  # extracted for stubbing/overriding without having to do it globally
+  def self.stderr ; $stderr ; end
+  def self.stdout ; $stdout ; end
+
+  def self.handle_error(e, options)
+    case e
+    when ExitException
+      # exit silently if there is no error message to print out
+      stderr.puts(e.message) if e.has_message?
+      e.exit_code
+    when HelpNeeded
+      help(e.command_class).print(options)
+      0
+    when ParsingError
+      stderr.puts(error_messages[e.class].call(e))
+      help(e.command_class).print_usage
+      1
+    else
+      stderr.puts("Unexpected error: #{e.class.name} - #{e.message}")
+      stderr.puts(e.backtrace)
+      2
+    end
+  end
 
-    help.print(options)
+  def self.help(command_class)
+    Help.new(command_class)
+  end
+
+  def self.print_usage(command_class, options={})
+    help(command_class).print_usage(options)
   end
 
   def run(&block)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: climate
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 7
   prerelease: 
   segments: 
   - 0
-  - 5
+  - 6
   - 0
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Nick Griffiths
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-05 00:00:00 Z
+date: 2013-02-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: trollop
@@ -84,15 +84,15 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/climate.rb
-- lib/climate/help.rb
-- lib/climate/command_compat.rb
 - lib/climate/version.rb
-- lib/climate/script.rb
-- lib/climate/errors.rb
-- lib/climate/parser.rb
-- lib/climate/command.rb
 - lib/climate/help/man.rb
+- lib/climate/command_compat.rb
+- lib/climate/command.rb
+- lib/climate/parser.rb
+- lib/climate/errors.rb
+- lib/climate/script.rb
+- lib/climate/help.rb
+- lib/climate.rb
 - README.md
 - bin/climate
 homepage: 
@@ -124,9 +124,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Library for building command line interfaces
 test_files: []
 
+has_rdoc: