climate 0.2.0 → 0.3.0

data/lib/climate.rb

@@ -40,8 +40,6 @@ module Climate
 end
 
 require 'climate/errors'
-require 'climate/argument'
-require 'climate/option'
 require 'climate/parser'
 require 'climate/command'
 require 'climate/help'

data/lib/climate/command.rb

@@ -14,11 +14,11 @@ module Climate
 
       # Create an instance of this command class and run it against the given
       # arguments
-      # @param [Array<String>] arguments A list of arguments, ARGV style
+      # @param [Array<String>] argv A list of arguments, ARGV style
       # @param [Hash] options see {#initialize}
-      def run(arguments, options={})
+      def run(argv, options={})
         begin
-          instance = new(arguments, options)
+          instance = new(argv, options)
         rescue Trollop::HelpNeeded
           raise HelpNeeded.new(self)
         end
@@ -47,6 +47,13 @@ module Climate
         @name
       end
 
+      # because we've extended Class.name, we expose the original method
+      # under another name
+      # FIXME: surely there is a saner way of doing this?
+      def class_name
+        Class.method(:name).unbind.bind(self).call
+      end
+
       # Register this class as being a subcommand of another {Command} class
       # @param [Command] parent_class The parent we hang off of
       def subcommand_of(parent_class)
@@ -64,6 +71,15 @@ module Climate
         end
       end
 
+      # Call this during class definition time if you don't want any of the
+      # usual command line parsing to happen
+      def disable_parsing
+        @parsing_disabled = true
+      end
+
+      # Returns true if parsing is disabled
+      attr_accessor :parsing_disabled
+
       # Set the parent of this command
       attr_accessor :parent
 
@@ -116,16 +132,24 @@ module Climate
     # @option options [IO] :stdout stream to use as stdout, defaulting to `$stdout`
     # @option options [IO] :stderr stream to use as stderr, defaulting to `$stderr`
     # @option options [IO] :stdin stream to use as stdin, defaulting to `$stdin`
-    def initialize(arguments, options={})
+    def initialize(argv, options={})
+      @argv = argv.clone
       @parent = options[:parent]
 
       @stdout = options[:stdout] || $stdout
       @stderr = options[:stderr] || $stderr
       @stdin =  options[:stdin]  || $stdin
 
-      @arguments, @options, @leftovers = self.class.parse(arguments)
+      if ! self.class.parsing_disabled
+        @arguments, @options, @leftovers = self.class.parse(argv)
+      end
     end
 
+    # @return [Array]
+    # The original list of unparsed argv style arguments that were given to
+    # the command
+    attr_accessor :argv
+
     # @return [Hash]
     # Options that were parsed from the command line
     attr_accessor :options
@@ -156,5 +180,11 @@ module Climate
         parent.ancestor(ancestor_class)
       end
     end
+
+    # Run the command, must be implemented by all commands that are not parent
+    # commands (leaf commands)
+    def run
+      raise NotImplementedError, "Leaf commands must implement a run method"
+    end
   end
 end

data/lib/climate/help.rb

@@ -101,7 +101,7 @@ module Climate
     end
 
     def puts(string='')
-      string.split("\n").each do |line|
+      wrap(string).split("\n").each do |line|
         @output.puts((' ' * spaces) + line)
       end
     end
@@ -129,7 +129,7 @@ module Climate
 
       string.split("\n\n").map { |para|
 
-        words = para.split(/[\n ]/)
+        words = para.split(/[\n ]+/)
         words[1..-1].inject([words.first]) { |m, v|
           new_last_line = m.last + " " + v
 

data/lib/climate/parser.rb

@@ -1,9 +1,97 @@
 module Climate
 
+  # Keeps the description munging code in one place
+  module Described
+    attr_reader :name
+
+    def initialize(name, description, *rest)
+      @name        = name
+      @description = description
+    end
+
+    def description
+      (@description || '').gsub(/\{default\}/, default.to_s)
+    end
+  end
+
+  # Wraps the properties supplied to Trollop::Parser#opt for some OO over
+  # engineered sweetness
+  class Option
+    include Described
+    attr_reader :options
+
+    def initialize(name, description, options={})
+      @options     = options
+      super
+    end
+
+    def type    ; spec[:type]    ; end
+    def long    ; spec[:long]    ; end
+    def short   ; spec[:short]   ; end
+    def default ; spec[:default] ; end
+
+    def optional? ; spec.has_key?(:default) ; end
+    def required? ; ! optional?             ; end
+
+    def spec ; @specs ||= parser.specs[@name] ; end
+
+    def parser
+      @parser ||= Trollop::Parser.new.tap {|p| add_to(p) }
+    end
+
+    def long_usage
+      type == :flag ? "--#{long}" : "--#{long}=<#{type}>"
+    end
+
+    def short_usage
+      short && (type == :flag ? "-#{short}" : "-#{short}<#{type}>")
+    end
+
+    def usage(options={})
+      help = short_usage || long_usage
+
+      if options[:with_long] && (long_usage != help)
+        help = [help, long_usage].compact.join(options.fetch(:separator, '|'))
+      end
+
+      if optional? && !options.fetch(:hide_optional, false)
+        "[#{help}]"
+      else
+        help
+      end
+    end
+
+    def add_to(parser)
+      parser.opt(@name, @description, @options)
+    end
+  end
+
+  # argument definition is stored in these
+  class Argument
+    include Described
+    attr_reader :default
+
+    def initialize(name, description, options={})
+      super
+      @required    = options.fetch(:required, ! options.has_key?(:default))
+      @multi       = options.fetch(:multi, false)
+      @default     = options.fetch(:default, nil)
+    end
+
+    def required? ; @required   ; end
+    def optional? ; ! required? ; end
+    def multi?    ; @multi      ; end
+
+    def usage
+      string = "<#{name}>"
+      string += '...' if multi?
+      optional??  "[#{string}]" : string
+    end
+  end
+
   module ParsingMethods
 
     def arg(*args)
-
       arg = Argument.new(*args)
 
       raise DefinitionError, "can not define more arguments after a multi " +
@@ -24,27 +112,13 @@ module Climate
     end
 
     def trollop_parser
-      parser = Trollop::Parser.new
-
-      parser.stop_on @stop_on
+      Trollop::Parser.new.tap do |parser|
+        parser.stop_on @stop_on
 
-      if cli_arguments.size > 0
-        parser.banner ""
-        max_length = cli_arguments.map { |h| h.name.to_s.length }.max
-        cli_arguments.each do |argument|
-          parser.banner("  " + argument.name.to_s.rjust(max_length) + " - #{argument.description}")
+        cli_options.each do |option|
+          option.add_to(parser)
         end
       end
-
-      parser.banner ""
-      cli_options.each do |option|
-        option.add_to(parser)
-      end
-      parser
-    end
-
-    def help_banner(out=$stdout)
-      trollop_parser.educate(out)
     end
 
     def parse_arguments(args, command=self)
@@ -69,7 +143,7 @@ module Climate
       end
 
       arg_list.zip(args).map do |argument, arg_value|
-
+        arg_value ||= argument.default
         if argument.required? && arg_value.nil?
           raise MissingArgumentError.new(argument.name, command)
         end

data/lib/climate/version.rb

@@ -1,3 +1,3 @@
 module Climate
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: climate
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Nick Griffiths
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-23 00:00:00 Z
+date: 2012-08-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: trollop
@@ -85,9 +85,7 @@ extra_rdoc_files: []
 files: 
 - lib/climate/version.rb
 - lib/climate/help/man.rb
-- lib/climate/argument.rb
 - lib/climate/command.rb
-- lib/climate/option.rb
 - lib/climate/parser.rb
 - lib/climate/errors.rb
 - lib/climate/script.rb

data/lib/climate/argument.rb

@@ -1,28 +0,0 @@
-module Climate
-  class Argument
-
-    attr_reader :name
-    attr_reader :description
-
-    def initialize(name, description, options={})
-      @name        = name
-      @description = description
-      @required    = options.fetch(:required, true)
-      @multi       = options.fetch(:multi, false)
-    end
-
-    def required? ; @required   ; end
-    def optional? ; ! required? ; end
-    def multi?    ; @multi      ; end
-
-    def usage
-      string = "<#{name}>"
-      string += '...' if multi?
-      optional??  "[#{string}]" : string
-    end
-
-    def formatted
-       required?? name.to_s.upcase : "[#{name.to_s.upcase}]"
-    end
-  end
-end

data/lib/climate/option.rb

@@ -1,54 +0,0 @@
-module Climate
-  class Option
-
-    attr_reader :name
-    attr_reader :description
-    attr_reader :options
-
-    def initialize(name, description, options={})
-      @name        = name
-      @description = description
-      @options     = options
-    end
-
-    def type    ; spec[:type]    ; end
-    def long    ; spec[:long]    ; end
-    def short   ; spec[:short]   ; end
-    def default ; spec[:default] ; end
-
-    def optional? ; spec.has_key?(:default) ; end
-    def required? ; ! optional?             ; end
-
-    def spec ; @specs ||= parser.specs[@name] ; end
-
-    def parser
-      @parser ||= Trollop::Parser.new.tap {|p| add_to(p) }
-    end
-
-    def long_usage
-      type == :flag ? "--#{long}" : "--#{long}=<#{type}>"
-    end
-
-    def short_usage
-      short && (type == :flag ? "-#{short}" : "-#{short}<#{type}>")
-    end
-
-    def usage(options={})
-      help = short_usage || long_usage
-
-      if options[:with_long] && (long_usage != help)
-        help = [help, long_usage].compact.join(options.fetch(:separator, '|'))
-      end
-
-      if optional? && !options.fetch(:hide_optional, false)
-        "[#{help}]"
-      else
-        help
-      end
-    end
-
-    def add_to(parser)
-      parser.opt(@name, @description, @options)
-    end
-  end
-end