config_parser 0.3.0 → 0.3.3

data/History

@@ -1,3 +1,17 @@
+== 0.3.3 / 2010-10-24
+
+* made options aware of whether or not they have assigned a value (fixes
+  a bug whereby lists would not override defaults)
+* added ability to specify a hint string
+
+== 0.3.2 / 2010-10-16
+
+* allow specification of any callback that responds to call
+
+== 0.3.1 / 2010-10-07
+
+* added nest keys to default guess for long
+
 == 0.3.0 / 2010-10-02
 
 * Cleanup of some variable and option names

data/lib/config_parser/flag.rb

@@ -8,35 +8,45 @@ class ConfigParser
   class Flag
     include Utils
     
-    # The config key
+    # The config key.
     attr_reader :key
     
-    # The config nesting keys
+    # The config nesting keys.
     attr_reader :nest_keys
     
-    # The default value
+    # The default value.
     attr_reader :default
     
-    # The short flag mapping to self
+    # The short flag mapping to self.
     attr_reader :short 
     
-    # The long flag mapping to self
+    # The long flag mapping to self.
     attr_reader :long
     
-    # The description printed by to_s
+    # The description printed by to_s.
     attr_reader :desc
     
-    # A callback for processing values
+    # A hint printed by to_s, after desc.
+    attr_reader :hint
+    
+    # A callback for processing values (must respond to call, or be nil).
     attr_reader :callback
     
-    def initialize(attrs={}, &callback)
+    # A tracking flag set to true when assign is called.  Useful when assign
+    # works differently for the first assignment than later assignments.  See
+    # reset.
+    attr_reader :assigned
+    
+    def initialize(attrs={})
       @key       = attrs[:key]
       @nest_keys = attrs[:nest_keys]
       @default   = attrs[:default]
       @short     = shortify(attrs[:short])
-      @long      = longify(attrs.has_key?(:long) ? attrs[:long] : key)
+      @long      = longify(attrs.has_key?(:long) ? attrs[:long] : default_long)
       @desc      = attrs[:desc]
-      @callback  = callback
+      @hint      = attrs[:hint]
+      @callback  = attrs[:callback]
+      reset
     end
     
     # Returns an array of flags mapping to self (ie [long, short]).
@@ -96,13 +106,24 @@ class ConfigParser
       callback ? callback.call(value) : value
     end
     
-    # Assign the value to the config hash, if key is set.  Returns config.
-    def assign(config, value=default)
+    # Assigns the default value into config and resets the assigned flag to
+    # false, such that the next assign behaves as if self has not put a value
+    # into config.  Returns config.
+    def assign_default(config)
+      assign(config, default)
+      reset
+      config
+    end
+    
+    # Assign the value to the config hash, if key is set, and flips assigned
+    # to true.  Returns config.
+    def assign(config, value)
       if key
         nest_config = nest(config)
         nest_config[key] = value
       end
       
+      @assigned = true
       config
     end
     
@@ -115,11 +136,16 @@ class ConfigParser
       config
     end
     
+    # Resets assigned to false.
+    def reset
+      @assigned = false
+    end
+    
     # Formats self as a help string for use on the command line.
     def to_s
-      lines = wrap(desc.to_s, 43)
+      lines = wrap(desc_str, 43)
       
-      header =  header_str
+      header = header_str
       header = header.length > 36 ? header.ljust(80) : (LINE_FORMAT % [header, lines.shift])
       
       if lines.empty?
@@ -152,5 +178,20 @@ class ConfigParser
     def long_str # :nodoc:
       long
     end
+    
+    def desc_str # :nodoc:
+      case
+      when hint.nil? && desc.nil?
+        ''
+      when hint.nil?
+        desc.to_s
+      else
+        "#{desc} (#{hint})"
+      end
+    end
+    
+    def default_long # :nodoc:
+      nest_keys ? (nest_keys + [key]).join(':') : key
+    end
   end
 end

data/lib/config_parser/list.rb

@@ -22,19 +22,25 @@ class ConfigParser
     
     # Splits the value into multiple values, and then process as usual.
     def process(value)
-      super split(value)
+      split(value).collect {|val| super(val) }
     end
     
-    # Assigns the values to config by concatenating onto an array, rather than
-    # directly setting into config.  As usual, no value is assigned if key is
-    # not set.
-    def assign(config, values=default)
+    # Assigns the values to config.  Multiple calls to assign will concatenate
+    # (ie when assigned is true) new values onto the existing values.  As
+    # usual, no values are assigned if key is not set.  Returns config.
+    def assign(config, values)
       if key
         nest_config = nest(config)
+        
+        unless assigned
+          nest_config.delete(key)
+        end
+        
         array = (nest_config[key] ||= [])
         array.concat(values)
       end
       
+      @assigned = true
       config
     end
     

data/lib/config_parser/option.rb

@@ -14,7 +14,7 @@ class ConfigParser
     # The argument name printed by to_s.
     attr_reader :arg_name
     
-    # Set to true to make the argument optional
+    # Set to true to make the argument optional.
     attr_reader :optional
     
     def initialize(attrs={})

data/lib/config_parser/version.rb

@@ -1,7 +1,7 @@
 class ConfigParser
   MAJOR = 0
   MINOR = 3
-  TINY  = 0
+  TINY  = 3
 
   VERSION = "#{MAJOR}.#{MINOR}.#{TINY}"
 end

data/lib/config_parser.rb

@@ -17,16 +17,16 @@ class ConfigParser
   # '--long' to the Option that handles them.
   attr_reader :options
   
-  # The hash receiving configs.
+  # The hash receiving parsed configs.
   attr_accessor :config
   
-  # The argument to stop processing options
+  # The argument to stop processing options.
   attr_accessor :option_break
   
-  # Set to true to preserve the option break
+  # Set to true to preserve the option break.
   attr_accessor :preserve_option_break
   
-  # Set to true to assign config defaults on parse
+  # Set to true to assign config defaults on parse.
   attr_accessor :assign_defaults
   
   # Initializes a new ConfigParser and passes it to the block, if given.
@@ -130,7 +130,8 @@ class ConfigParser
   
   # Constructs an Option using args and registers it with self. The args may
   # contain (in any order) a short switch, a long switch, and a description
-  # string. A block may be provided to process values for the option.
+  # string. A callback may be provided as a block to process values for the
+  # option.
   #
   # The option type (flag, switch, list, or option) is guessed from the args,
   # and affects what is passed to the block.
@@ -147,10 +148,10 @@ class ConfigParser
   #   psr.on('-o ARG_NAME') do |arg|
   #     # ...
   #   end
-  #       
+  #               
   #   # use an argname with commas to make a list,
-  #   # an array of values is passed to the block
-  #   psr.on('--list A,B,C') do |args|
+  #   # each arg is passed to the block separately
+  #   psr.on('--list A,B,C') do |arg|
   #     # ...
   #   end
   #
@@ -167,14 +168,18 @@ class ConfigParser
   #   end
   #
   # If this is too ambiguous (and at times it is), provide a trailing hash
-  # defining all or part of the option:
+  # defining all or part of the option.  Note any object that responds to call
+  # may be set as the callback:
+  #
+  #   psr.on('-k', 'description',
+  #     :long => '--key',
+  #     :option_type => :list,
+  #     :callback => lambda {|args| ... }
+  #   )
   #
-  #   psr.on('-k', 'description', :long => '--key', :option_type => :list) do |args|
-  #     # ...
-  #   end
-  #   
   # The trailing hash wins if there is any overlap in the parsed attributes
-  # and those provided by the hash.
+  # and those provided by the hash.  The block wins if both a block and a
+  # callback are given.
   def on(*args, &block)
     register new_option(args, &block)
   end
@@ -229,10 +234,9 @@ class ConfigParser
   def parse!(argv=ARGV)
     argv = Shellwords.shellwords(argv) if argv.kind_of?(String)
     
-    if assign_defaults
-      registry.each do |option|
-        next unless option.respond_to?(:assign)
-        option.assign(config)
+    registry.each do |option|
+      if assign_defaults && option.respond_to?(:assign_default)
+        option.assign_default(config)
       end
     end
     
@@ -280,6 +284,22 @@ class ConfigParser
     argv
   end
   
+  # Resets each option and clears the config (if specified).  Returns self.
+  def reset(options={})
+    options = {
+      :clear => true
+    }.merge(options)
+    
+    registry.each do |option|
+      if option.respond_to?(:reset)
+        option.reset
+      end
+    end
+    
+    config.clear if options[:clear]
+    self
+  end
+  
   # Converts the options and separators in self into a help string suitable
   # for display on the command line.
   def to_s
@@ -308,6 +328,7 @@ class ConfigParser
   def new_option(argv, &block) # :nodoc:
     attrs = argv.last.kind_of?(Hash) ? argv.pop : {}
     attrs = parse_attrs(argv).merge(attrs)
-    option_class(attrs).new(attrs, &block)
+    attrs[:callback] = block if block
+    option_class(attrs).new(attrs)
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: config_parser
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 3
+  version: 0.3.3
 platform: ruby
 authors: 
 - Simon Chiang
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-02 00:00:00 -06:00
+date: 2010-10-24 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,6 +33,21 @@ dependencies:
         version: "1.0"
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  version_requirements: *id002
 description: 
 email: simon.a.chiang@gmail.com
 executables: []