clamp 1.0.1 → 1.1.0

data/lib/clamp/help.rb

@@ -1,5 +1,5 @@
-require 'stringio'
-require 'clamp/messages'
+require "stringio"
+require "clamp/messages"
 
 module Clamp
 
@@ -15,8 +15,8 @@ module Clamp
     def description=(description)
       @description = description.dup
       if @description =~ /^\A\n*( +)/
-        indent = $1
-        @description.gsub!(/^#{indent}/, '')
+        indent = Regexp.last_match(1)
+        @description.gsub!(/^#{indent}/, "")
       end
       @description.strip!
     end
@@ -29,7 +29,7 @@ module Clamp
 
     def derived_usage_description
       parts = ["[OPTIONS]"]
-      parts += parameters.map { |a| a.name }
+      parts += parameters.map(&:name)
       parts.join(" ")
     end
 
@@ -69,21 +69,20 @@ module Clamp
       end
 
       def add_description(description)
-        if description
-          puts ""
-          puts description.gsub(/^/, "  ")
-        end
+        return unless description
+        puts ""
+        puts description.gsub(/^/, "  ")
       end
 
-      DETAIL_FORMAT = "    %-29s %s"
+      DETAIL_FORMAT = "    %-29s %s".freeze
 
       def add_list(heading, items)
         puts "\n#{heading}:"
         items.reject { |i| i.respond_to?(:hidden?) && i.hidden? }.each do |item|
           label, description = item.help
           description.each_line do |line|
-            puts DETAIL_FORMAT % [label, line]
-            label = ''
+            puts format(DETAIL_FORMAT, label, line)
+            label = ""
           end
         end
       end

data/lib/clamp/messages.rb

@@ -6,8 +6,8 @@ module Clamp
       messages.merge!(new_messages)
     end
 
-    def message(key, options={})
-      format_string(messages.fetch(key), options)
+    def message(key, options = {})
+      format(messages.fetch(key), options)
     end
 
     def clear_messages!
@@ -30,38 +30,15 @@ module Clamp
       :parameters_heading => "Parameters",
       :subcommands_heading => "Subcommands",
       :options_heading => "Options"
-    }
+    }.freeze
 
     def messages
-      unless defined?(@messages)
-        init_default_messages
-      end
+      init_default_messages unless defined?(@messages)
       @messages
     end
 
     def init_default_messages
-      @messages = DEFAULTS.clone
-    end
-
-    begin
-
-      ("%{foo}" % {:foo => "bar"}) # test Ruby 1.9 string interpolation
-
-      def format_string(format, params = {})
-        format % params
-      end
-
-    rescue ArgumentError
-
-      # string formatting for ruby 1.8
-      def format_string(format, params = {})
-        array_params = format.scan(/%[<{]([^>}]*)[>}]/).collect do |name|
-          name = name[0]
-          params[name.to_s] || params[name.to_sym]
-        end
-        format.gsub(/%[<]([^>]*)[>]/, '%').gsub(/%[{]([^}]*)[}]/, '%s') % array_params
-      end
-
+      @messages = DEFAULTS.dup
     end
 
   end

data/lib/clamp/option/declaration.rb

@@ -1,5 +1,5 @@
-require 'clamp/attribute/declaration'
-require 'clamp/option/definition'
+require "clamp/attribute/declaration"
+require "clamp/option/definition"
 
 module Clamp
   module Option
@@ -10,9 +10,9 @@ module Clamp
 
       def option(switches, type, description, opts = {}, &block)
         Option::Definition.new(switches, type, description, opts).tap do |option|
-          declared_options << option
           block ||= option.default_conversion_block
-          define_accessors_for(option, &block)
+          declare_attribute(option, &block)
+          declared_options << option
         end
       end
 
@@ -25,34 +25,35 @@ module Clamp
       end
 
       def recognised_options
-        declare_implicit_options
+        unless @implicit_options_declared
+          declare_implicit_help_option
+          @implicit_options_declared = true
+        end
         effective_options
       end
 
       private
 
-      def declare_implicit_options
-        return nil if defined?(@implicit_options_declared)
-        unless effective_options.find { |o| o.handles?("--help") }
-          help_switches = ["--help"]
-          help_switches.unshift("-h") unless effective_options.find { |o| o.handles?("-h") }
-          option help_switches, :flag, "print help" do
-            request_help
-          end
+      def declare_implicit_help_option
+        return false if effective_options.find { |o| o.handles?("--help") }
+        help_switches = ["--help"]
+        help_switches.unshift("-h") unless effective_options.find { |o| o.handles?("-h") }
+        option help_switches, :flag, "print help" do
+          request_help
         end
-        @implicit_options_declared = true
       end
 
       def effective_options
         ancestors.inject([]) do |options, ancestor|
-          if ancestor.kind_of?(Clamp::Option::Declaration)
-            options + ancestor.declared_options
-          else
-            options
-          end
+          options + options_declared_on(ancestor)
         end
       end
 
+      def options_declared_on(ancestor)
+        return [] unless ancestor.is_a?(Clamp::Option::Declaration)
+        ancestor.declared_options
+      end
+
     end
 
   end

data/lib/clamp/option/definition.rb

@@ -1,5 +1,5 @@
-require 'clamp/attribute/definition'
-require 'clamp/truthy'
+require "clamp/attribute/definition"
+require "clamp/truthy"
 
 module Clamp
   module Option
@@ -12,16 +12,11 @@ module Clamp
         @description = description
         super(options)
         @multivalued = options[:multivalued]
-        if options.has_key?(:required)
-          @required = options[:required]
-          # Do some light validation for conflicting settings.
-          if options.has_key?(:default)
-            raise ArgumentError, "Specifying a :default value with :required doesn't make sense"
-          end
-          if type == :flag
-            raise ArgumentError, "A required flag (boolean) doesn't make sense."
-          end
-        end
+        return unless options.key?(:required)
+        @required = options[:required]
+        # Do some light validation for conflicting settings.
+        raise ArgumentError, "Specifying a :default value with :required doesn't make sense" if options.key?(:default)
+        raise ArgumentError, "A required flag (boolean) doesn't make sense." if type == :flag
       end
 
       attr_reader :switches, :type
@@ -39,7 +34,7 @@ module Clamp
       end
 
       def flag_value(switch)
-        !(switch =~ /^--no-(.*)/ && switches.member?("--\[no-\]#{$1}"))
+        !(switch =~ /^--no-(.*)/ && switches.member?("--\[no-\]#{Regexp.last_match(1)}"))
       end
 
       def read_method
@@ -59,9 +54,7 @@ module Clamp
       end
 
       def default_conversion_block
-        if flag?
-          Clamp.method(:truthy?)
-        end
+        Clamp.method(:truthy?) if flag?
       end
 
       def help_lhs
@@ -75,7 +68,7 @@ module Clamp
       def recognised_switches
         switches.map do |switch|
           if switch =~ /^--\[no-\](.*)/
-            ["--#{$1}", "--no-#{$1}"]
+            ["--#{Regexp.last_match(1)}", "--no-#{Regexp.last_match(1)}"]
           else
             switch
           end
@@ -86,7 +79,7 @@ module Clamp
         unless long_switch
           raise Clamp::DeclarationError, "You must specify either a long-switch or an :attribute_value"
         end
-        inferred_name = long_switch.sub(/^--(\[no-\])?/, '').tr('-', '_')
+        inferred_name = long_switch.sub(/^--(\[no-\])?/, "").tr("-", "_")
         inferred_name += "_list" if multivalued?
         inferred_name
       end

data/lib/clamp/option/parsing.rb

@@ -6,23 +6,30 @@ module Clamp
       protected
 
       def parse_options
+        set_options_from_command_line
+        default_options_from_environment
+        verify_required_options_are_set
+      end
+
+      private
 
-        while remaining_arguments.first =~ /\A-/
+      def set_options_from_command_line
+        while remaining_arguments.first && remaining_arguments.first.start_with?("-")
 
           switch = remaining_arguments.shift
           break if switch == "--"
 
           case switch
           when /\A(-\w)(.+)\z/m # combined short options
-            switch = $1
+            switch = Regexp.last_match(1)
             if find_option(switch).flag?
-              remaining_arguments.unshift("-" + $2)
+              remaining_arguments.unshift("-" + Regexp.last_match(2))
             else
-              remaining_arguments.unshift($2)
+              remaining_arguments.unshift(Regexp.last_match(2))
             end
           when /\A(--[^=]+)=(.*)\z/m
-            switch = $1
-            remaining_arguments.unshift($2)
+            switch = Regexp.last_match(1)
+            remaining_arguments.unshift(Regexp.last_match(2))
           end
 
           option = find_option(switch)
@@ -35,31 +42,33 @@ module Clamp
           end
 
         end
+      end
 
-        # Fill in gap from environment
+      def default_options_from_environment
         self.class.recognised_options.each do |option|
           option.of(self).default_from_environment
         end
+      end
 
-        # Verify that all required options are present
+      def verify_required_options_are_set
         self.class.recognised_options.each do |option|
           # If this option is required and the value is nil, there's an error.
-          if option.required? and send(option.attribute_name).nil?
-            if option.environment_variable
-              message = Clamp.message(:option_or_env_required, :option => option.switches.first, :env => option.environment_variable)
-            else
-              message = Clamp.message(:option_required, :option => option.switches.first)
-            end
-            signal_usage_error message
+          next unless option.required? && send(option.attribute_name).nil?
+          if option.environment_variable
+            message = Clamp.message(:option_or_env_required,
+                                    :option => option.switches.first,
+                                    :env => option.environment_variable)
+          else
+            message = Clamp.message(:option_required,
+                                    :option => option.switches.first)
           end
+          signal_usage_error message
         end
       end
 
-      private
-
       def find_option(switch)
         self.class.find_option(switch) ||
-        signal_usage_error(Clamp.message(:unrecognised_option, :switch => switch))
+          signal_usage_error(Clamp.message(:unrecognised_option, :switch => switch))
       end
 
     end

data/lib/clamp/parameter/declaration.rb

@@ -1,5 +1,5 @@
-require 'clamp/attribute/declaration'
-require 'clamp/parameter/definition'
+require "clamp/attribute/declaration"
+require "clamp/parameter/definition"
 
 module Clamp
   module Parameter
@@ -18,11 +18,24 @@ module Clamp
 
       def parameter(name, description, options = {}, &block)
         Parameter::Definition.new(name, description, options).tap do |parameter|
+          declare_attribute(parameter, &block)
           parameters << parameter
-          define_accessors_for(parameter, &block)
         end
       end
 
+      protected
+
+      def inheritable_parameters
+        superclass_inheritable_parameters + parameters.select(&:inheritable?)
+      end
+
+      private
+
+      def superclass_inheritable_parameters
+        return [] unless superclass.respond_to?(:inheritable_parameters, true)
+        superclass.inheritable_parameters
+      end
+
     end
 
   end

data/lib/clamp/parameter/definition.rb

@@ -1,4 +1,4 @@
-require 'clamp/attribute/definition'
+require "clamp/attribute/definition"
 
 module Clamp
   module Parameter
@@ -13,10 +13,15 @@ module Clamp
         @required = options.fetch(:required) do
           (@name !~ OPTIONAL)
         end
+        @inheritable = options.fetch(:inheritable, true)
       end
 
       attr_reader :name
 
+      def inheritable?
+        @inheritable
+      end
+
       def help_lhs
         name
       end
@@ -34,7 +39,7 @@ module Clamp
       VALID_ATTRIBUTE_NAME = /^[a-z0-9_]+$/
 
       def infer_attribute_name
-        inferred_name = name.downcase.tr('-', '_').sub(ELLIPSIS_SUFFIX, '').sub(OPTIONAL) { $1 }
+        inferred_name = name.downcase.tr("-", "_").sub(ELLIPSIS_SUFFIX, "").sub(OPTIONAL) { Regexp.last_match(1) }
         unless inferred_name =~ VALID_ATTRIBUTE_NAME
           raise "cannot infer attribute_name from #{name.inspect}"
         end

data/lib/clamp/parameter/parsing.rb

@@ -6,7 +6,13 @@ module Clamp
       protected
 
       def parse_parameters
+        set_parameters_from_command_line
+        default_parameters_from_environment
+      end
+
+      private
 
+      def set_parameters_from_command_line
         self.class.parameters.each do |parameter|
           begin
             parameter.consume(remaining_arguments).each do |value|
@@ -16,11 +22,12 @@ module Clamp
             signal_usage_error Clamp.message(:parameter_argument_error, :param => parameter.name, :message => e.message)
           end
         end
+      end
 
+      def default_parameters_from_environment
         self.class.parameters.each do |parameter|
           parameter.of(self).default_from_environment
         end
-
       end
 
     end

data/lib/clamp/subcommand/declaration.rb

@@ -1,5 +1,5 @@
-require 'clamp/errors'
-require 'clamp/subcommand/definition'
+require "clamp/errors"
+require "clamp/subcommand/definition"
 
 module Clamp
   module Subcommand
@@ -11,19 +11,8 @@ module Clamp
       end
 
       def subcommand(name, description, subcommand_class = self, &block)
-        unless has_subcommands?
-          @subcommand_parameter = if @default_subcommand
-            parameter "[SUBCOMMAND]", "subcommand", :attribute_name => :subcommand_name, :default => @default_subcommand
-          else
-            parameter "SUBCOMMAND", "subcommand", :attribute_name => :subcommand_name, :required => false
-          end
-          remove_method :default_subcommand_name
-          parameter "[ARG] ...", "subcommand arguments", :attribute_name => :subcommand_arguments
-        end
-        if block
-          # generate a anonymous sub-class
-          subcommand_class = Class.new(subcommand_class, &block)
-        end
+        subcommand_class = Class.new(subcommand_class, &block) if block
+        declare_subcommand_parameters unless has_subcommands?
         recognised_subcommands << Subcommand::Definition.new(name, description, subcommand_class)
       end
 
@@ -37,20 +26,14 @@ module Clamp
 
       def find_subcommand_class(*names)
         names.inject(self) do |command_class, name|
-          if command_class
-            if subcommand = command_class.find_subcommand(name)
-              subcommand.subcommand_class
-            end
-          end
+          return nil unless command_class
+          subcommand = command_class.find_subcommand(name)
+          subcommand.subcommand_class if subcommand
         end
       end
 
-      def parameters_before_subcommand
-        parameters.take_while { |p| p != @subcommand_parameter }
-      end
-
       def inheritable_attributes
-        recognised_options + parameters_before_subcommand
+        recognised_options + inheritable_parameters
       end
 
       def default_subcommand=(name)
@@ -71,6 +54,26 @@ module Clamp
         end
       end
 
+      private
+
+      def declare_subcommand_parameters
+        if @default_subcommand
+          parameter "[SUBCOMMAND]", "subcommand",
+                    :attribute_name => :subcommand_name,
+                    :default => @default_subcommand,
+                    :inheritable => false
+        else
+          parameter "SUBCOMMAND", "subcommand",
+                    :attribute_name => :subcommand_name,
+                    :required => false,
+                    :inheritable => false
+        end
+        remove_method :default_subcommand_name
+        parameter "[ARG] ...", "subcommand arguments",
+                  :attribute_name => :subcommand_arguments,
+                  :inheritable => false
+      end
+
     end
 
   end