config_parser 0.5.3 → 0.5.4

data/{History → History.rdoc}

@@ -1,3 +1,9 @@
+== 0.5.4 / 2011-07-11
+
+Misc cleanup to the README and project structure. Also:
+
+* guess no hint for empty array
+
 == 0.5.3 / 2010-12-04
 
 * altered targname formatting for list to use an elipsis rather than brackets

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010, Simon Chiang
+Copyright (c) 2010-2011, Simon Chiang
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/README.rdoc

@@ -0,0 +1,92 @@
+= ConfigParser
+
+Parse command-line options into a configuration hash.
+
+== Description
+
+ConfigParser is an analogue of
+{OptionParser}[http://www.ruby-doc.org/core/classes/OptionParser.html] that
+formalizes the pattern of setting parsed options into a hash. ConfigParser
+uses a similar, simplified declaration syntax and provides an API that
+integrates well with libraries like
+{Configurable}[http://github.com/thinkerbot/configurable].
+
+== Usage
+
+Define options and their default values using +add+:
+
+  parser = ConfigParser.new
+  parser.add :option, 'default'      # regular option with a default value
+  parser.add :switch, true           # true makes a --[no-]switch
+  parser.add :flag, false            # false as a default makes a --flag
+  parser.add :list, []               # an array makes a list-style option
+  
+  parser.parse 'a b --flag --list x --list y,z c'
+  # => ['a', 'b', 'c']
+  
+  parser.config
+  # => {
+  #   :option => 'default',
+  #   :switch => true,
+  #   :flag   => true,
+  #   :list   => ['x', 'y', 'z']
+  # }
+
+The OptionParser +on+ syntax may also be used, if desired (most syntax
+variations will work). Use the parser as if it were the config hash:
+
+  parser = ConfigParser.new
+  parser.on '--option OPTION', 'a standard option' do |value|
+    parser[:option] = value
+  end
+
+  parser.on '--[no-]switch', 'a switch' do |value|
+    parser[:switch] = value
+  end
+
+  parser.on '--flag', 'a flag' do
+    parser[:flag] = true
+  end
+
+  parser.parse 'a b --flag --switch --option value c'
+  # => ['a', 'b', 'c']
+
+  parser.config
+  # => {
+  #   :option => 'value',
+  #   :switch => true,
+  #   :flag   => true
+  # }
+
+Added options may be further defined using arguments just like +on+ or with an
+attributes hash. Notably, the key for the config does not have to correspond
+to the option (although by default it does). As you may expect a block can be
+given to process values before they are set as configs.
+
+  parser = ConfigParser.new
+  
+  # use args to define the option
+  parser.add(:x, nil, '-o', '--one')
+  
+  # use an options hash to define the option
+  parser.add(:y, nil, :short => 't', :long => 'two')
+  
+  # use a block to process the values
+  parser.add(:z, nil, :long => 'three') {|value| value.upcase }
+  
+  parser.parse('a b --one uno --two dos --three tres c')
+  # => ['a', 'b', 'c']
+  
+  parser.config
+  # => {:x => 'uno', :y => 'dos', :z => 'TRES'}
+
+== Installation
+
+ConfigParser is available as a gem[http://rubygems.org/gems/config_parser].
+
+  % gem install config_parser
+
+== Info
+
+Developer:: {Simon Chiang}[http://github.com/thinkerbot]
+License:: {MIT-Style}[link:files/MIT-LICENSE.html]

data/lib/config_parser/utils.rb

@@ -221,7 +221,8 @@ class ConfigParser
       when true, false, nil
         nil
       when Array
-        default.join(attrs[:delimiter] || DELIMITER)
+        hint = default.join(attrs[:delimiter] || DELIMITER)
+        hint.empty? ? nil : hint
       else
         default.to_s
       end

data/lib/config_parser/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: config_parser
 version: !ruby/object:Gem::Version 
-  hash: 13
-  prerelease: false
+  hash: 3
+  prerelease: 
   segments: 
   - 0
   - 5
-  - 3
-  version: 0.5.3
+  - 4
+  version: 0.5.4
 platform: ruby
 authors: 
 - Simon Chiang
@@ -15,28 +15,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-04 00:00:00 -07:00
+date: 2011-07-11 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
-        version: "1.0"
-  type: :runtime
-  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: bundler
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -47,7 +32,7 @@ dependencies:
         - 0
         version: "1.0"
   type: :development
-  version_requirements: *id002
+  version_requirements: *id001
 description: 
 email: simon.a.chiang@gmail.com
 executables: []
@@ -55,8 +40,8 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- History
-- README
+- History.rdoc
+- README.rdoc
 - MIT-LICENSE
 files: 
 - lib/config_parser.rb
@@ -66,8 +51,8 @@ files:
 - lib/config_parser/switch.rb
 - lib/config_parser/utils.rb
 - lib/config_parser/version.rb
-- History
-- README
+- History.rdoc
+- README.rdoc
 - MIT-LICENSE
 has_rdoc: true
 homepage: ""
@@ -76,7 +61,7 @@ licenses: []
 post_install_message: 
 rdoc_options: 
 - --main
-- README
+- README.rdoc
 - -S
 - -N
 - --title
@@ -104,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: ""
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Parse command-line options into a configuration hash

data/README

@@ -1,95 +0,0 @@
-= ConfigParser
-
-Parse command-line options into a configuration hash.
-
-== Description
-
-ConfigParser is an analogue of
-{OptionParser}[http://www.ruby-doc.org/core/classes/OptionParser.html] that
-formalizes the pattern of setting parsed options into a hash. ConfigParser
-uses a similar, simplified declaration syntax and provides an API that
-integrates well with libraries like
-{Configurable}[http://tap.rubyforge.org/configurable].
-
-== Usage
-
-ConfigParser can be used much like OptionParser, where the parser can set
-values into a config hash.
-
-  parser = ConfigParser.new
-  parser.on '-s', '--long LONG', 'a standard option' do |value|
-    parser[:long] = value
-  end
- 
-  parser.on '--[no-]switch', 'a switch' do |value|
-    parser[:switch] = value
-  end
-
-  parser.on '--flag', 'a flag' do
-    parser[:flag] = true
-  end
-  
-  parser.parse('a b --long arg --switch --flag c')
-  # => ['a', 'b', 'c']
-  
-  parser.config     
-  # => {:long => 'arg', :switch => true, :flag => true}
-  
-  parser.to_s
-  # => %q{
-  #     -s, --long LONG             a standard option
-  #     --[no-]switch               a switch
-  #     --flag                      a flag
-  # }
-
-ConfigParser formalizes this pattern of setting values into a config hash as
-they occur, and adds the ability to specify default values.
-
-  parser = ConfigParser.new
-  parser.add :flag, false            # false as a default makes a --flag
-  parser.add :switch, true           # true makes a --[no-]switch
-  parser.add :list, []               # an array makes a list-style option
-  parser.add :opt, 'default'         # all others make an ordinary option
-
-  parser.parse('a b c')              # => ['a', 'b', 'c']
-  parser.config
-  # => {
-  #   :flag   => false,
-  #   :switch => true,
-  #   :list   => [],
-  #   :opt    => 'default'
-  # }
-  
-  args = %w{a b --flag --no-switch --list one --list two,three --opt value c}
-  parser.parse(args)                 # => ['a', 'b', 'c']
-  parser.config
-  # => {
-  #   :flag   => true,
-  #   :switch => false,
-  #   :list   => ['one', 'two', 'three'],
-  #   :opt    => 'value'
-  # }
-
-Options can be defined using arguments just like on, or with an attributes
-hash. A block can be given to process values before they are set as configs.
-
-  parser = ConfigParser.new
-  parser.add(:x, nil, '--one', 'by args') {|value| value.upcase }
-  parser.add(:y, nil, :long => 'two', :desc => 'by hash')
-  
-  parser.parse('a b --one value --two value c')
-  # => ['a', 'b', 'c']
-  
-  parser.config
-  # => {:x => 'VALUE', :y => 'value'}
-
-== Installation
-
-ConfigParser is available as a gem via {Gemcutter}[http://rubygems.org/gems/config_parser].
-
-  % gem install config_parser
-
-== Info
-
-Copyright (c) 2010, Simon Chiang
-License:: {MIT-Style}[link:files/MIT-LICENSE.html]