config_parser 0.2.0 → 0.3.0

data/History

@@ -1,3 +1,9 @@
+== 0.3.0 / 2010-10-02
+
+* Cleanup of some variable and option names
+* Removed limits on lists
+* Updated to bundler 1.0
+
 == 0.2.0 / 2010-08-01
 
 Release candidate with cleaner implementation and accurate documentation.

data/lib/config_parser.rb

@@ -64,12 +64,12 @@ class ConfigParser
 
   # Registers the option with self by adding it to the registry and mapping
   # the option flags into options. Raises an error for conflicting flags.
-  # Returns self.
+  # Returns option.
   #
   # If override is specified, options with conflicting flags are removed and
   # no error is raised.  Note that this may remove multiple options.
   def register(option, override=false)
-    return if option.nil?
+    return nil if option.nil?
     
     if override
       existing = option.flags.collect {|flag| @options.delete(flag) }
@@ -90,14 +90,41 @@ class ConfigParser
       @options[flag] = option
     end
     
-    self
+    option
   end
   
   # Unregisters the option by removing it from the registry and options.
-  # Returns self.
+  # Returns option.
   def unregister(option)
     @registry.delete(option)
     @options.delete_if {|key, value| option == value }
+    option
+  end
+  
+  # Sorts options in the registry as specified by the block.  Groups of
+  # options as delimited by separators are sorted independently.  If no
+  # block is given, options are sorted by their long and short keys.
+  def sort_opts!(&block)
+    block ||= lambda {|option| option.long || option.short }
+    
+    splits = []
+    current = []
+    
+    options = self.options.values.uniq
+    registry.each do |option|
+      if options.include?(option)
+        current << option
+      else
+        splits << current
+        splits << option
+        current = []
+      end
+    end
+    
+    splits << current
+    @registry = splits.collect {|split| split.kind_of?(Array) ? split.sort_by(&block) : split }
+    @registry.flatten!
+    
     self
   end
   
@@ -142,23 +169,19 @@ class ConfigParser
   # If this is too ambiguous (and at times it is), provide a trailing hash
   # defining all or part of the option:
   #
-  #   psr.on('-k', 'description', :long => '--key', :type => :list) do |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.
   def on(*args, &block)
-    option = new_option(args, &block)
-    register option
-    option
+    register new_option(args, &block)
   end
   
   # Same as on, but overrides options with overlapping flags.
   def on!(*args, &block)
-    option = new_option(args, &block)
-    register option, true
-    option
+    register new_option(args, &block), true
   end
   
   # An alternate syntax for on, where the key and default attributes are set
@@ -179,15 +202,15 @@ class ConfigParser
   end
   
   # Removes options by key.  Any options with the specified key are removed.
-  # Returns self.
+  # Returns the removed options.
   def rm(key)
-    options.values.each do |option| 
+    options.values.collect do |option| 
       if option.key == key 
         unregister(option)
+      else
+        nil
       end
-    end
-    
-    self
+    end.compact
   end
   
   # Parses options from argv in a non-destructive manner. Parsing stops if an
@@ -268,7 +291,7 @@ class ConfigParser
   protected
   
   def option_class(attrs) # :nodoc:
-    type = attrs[:type] || guess_type(attrs)
+    type = attrs[:option_type] || guess_option_type(attrs)
     
     case type
     when :option then Option

data/lib/config_parser/flag.rb

@@ -130,6 +130,11 @@ class ConfigParser
       end
     end
     
+    # Returns an inspect string.
+    def inspect
+      "#<#{self.class}:#{object_id} key=#{key.inspect} default=#{default.inspect} long=#{long.inspect} short=#{short.inspect}>"
+    end
+    
     private
     
     def header_str # :nodoc:

data/lib/config_parser/list.rb

@@ -9,9 +9,6 @@ class ConfigParser
     # The default split character for multiple values
     DELIMITER = ','
     
-    # The maximum number of values that may be specified; nil for unlimited.
-    attr_reader :limit
-    
     # The delimiter on which to split single values into multiple values; use
     # nil to prevent splitting.
     attr_reader :delimiter
@@ -20,7 +17,6 @@ class ConfigParser
       super
       
       @delimiter = attrs.has_key?(:delimiter) ? attrs[:delimiter] : DELIMITER
-      @limit   = attrs[:limit]
       @default = split(@default)
     end
     
@@ -37,10 +33,6 @@ class ConfigParser
         nest_config = nest(config)
         array = (nest_config[key] ||= [])
         array.concat(values)
-      
-        if limit && array.length > limit
-          raise "too many assignments for #{key.inspect}"
-        end
       end
       
       config

data/lib/config_parser/switch.rb

@@ -10,7 +10,7 @@ class ConfigParser
     attr_reader :prefix
     
     # The negative long flag, determined from long and prefix.
-    attr_reader :nolong
+    attr_reader :negative_long
     
     def initialize(attrs={})
       attrs[:default] = true unless attrs.has_key?(:default)
@@ -18,12 +18,12 @@ class ConfigParser
       
       raise ArgumentError, "no long specified" unless long
       @prefix = attrs[:prefix] || 'no'
-      @nolong = prefix_long(long, "#{prefix}-")
+      @negative_long = prefix_long(long, "#{prefix}-")
     end
     
-    # Returns an array of flags mapping to self (ie [long, nolong, short]).
+    # Returns an array of flags mapping to self (ie [long, negative_long, short]).
     def flags
-      [long, nolong, short].compact
+      [long, negative_long, short].compact
     end
     
     # Assigns default into config for positive flags and !default for negative
@@ -32,7 +32,7 @@ class ConfigParser
     def parse(flag, value=nil, argv=[], config={})
       raise "value specified for #{flag}: #{value.inspect}" if value
       
-      value = (flag == nolong ? !default : default)
+      value = (flag == negative_long ? !default : default)
       assign(config, process(value))
     end
 

data/lib/config_parser/utils.rb

@@ -23,7 +23,7 @@ class ConfigParser
     # match:
     #   
     #   $1:: the nesting prefix ('nest')
-    #   $2:: the nolong prefix ('no')
+    #   $2:: the negative long prefix ('no')
     #   $3:: the long flag name ('opt')
     #
     SWITCH = /\A--(.*?)\[(.*?)-\](.+)\z/
@@ -112,14 +112,14 @@ class ConfigParser
     #   -s                  :short => '-s'
     #   --long              :long => '--long'
     #   --long ARG          :long => '--long', :arg_name => 'ARG'
-    #   --[no-]long         :long => '--long', :prefix => 'no', :type => :switch
+    #   --[no-]long         :long => '--long', :prefix => 'no', :option_type => :switch
     #   --nest:long         :long => '--nest:long', :nest_keys => ['nest']
     #   'some string'       :desc => 'some string'
     #
     # Usually you overlay these patterns, for example:
     #
     #   -s ARG              :short => '-s', :arg_name => 'ARG'
-    #   --nest:[no-]long    :long => '--nest:long', :nest_keys => ['nest'], :prefix => 'no', :type => :switch
+    #   --nest:[no-]long    :long => '--nest:long', :nest_keys => ['nest'], :prefix => 'no', :option_type => :switch
     #
     # The goal of this method is to get things right most of the time, not to
     # be clean, simple, or robust.  Some errors in declarations (like an
@@ -170,26 +170,26 @@ class ConfigParser
     #
     #   if...            then...
     #   prefix      =>   :switch
-    #   arg_name    =>   guess_type_by_arg_name || guess_type_by_value
-    #   default     =>   (guess_type_by_value)
+    #   arg_name    =>   guess_option_type_by_arg_name || guess_option_type_by_value
+    #   default     =>   (guess_option_type_by_value)
     #   all else    =>   :flag
     #
     # A guess is just a guess; for certainty specify the type manually.
-    def guess_type(attrs)
+    def guess_option_type(attrs)
       case
       when attrs.has_key?(:prefix)
         :switch
       when attrs.has_key?(:arg_name)
-        guess_type_by_arg_name(attrs[:arg_name]) || guess_type_by_value(attrs[:default])
+        guess_option_type_by_arg_name(attrs[:arg_name]) || guess_option_type_by_value(attrs[:default])
       when attrs.has_key?(:default)
-        guess_type_by_value(attrs[:default])
+        guess_option_type_by_value(attrs[:default])
       else
         :flag
       end
     end
     
     # Guesses :list if the arg_name has a comma, or nil.
-    def guess_type_by_arg_name(arg_name)
+    def guess_option_type_by_arg_name(arg_name)
       arg_name.to_s.include?(',') ? :list : nil
     end
     
@@ -202,7 +202,7 @@ class ConfigParser
     #   all else    =>   :option
     #
     # A guess is just a guess; for certainty specify the type manually.
-    def guess_type_by_value(value)
+    def guess_option_type_by_value(value)
       case value
       when true  then :switch
       when false then :flag

data/lib/config_parser/version.rb

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

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: config_parser
 version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Simon Chiang
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-01 00:00:00 -06:00
+date: 2010-10-02 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: lazydoc
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 15
         segments: 
         - 1
         - 0
@@ -66,23 +69,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: ""
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Parse command-line options into a configuration hash