micro-optparse 1.0.2 → 1.1.3

data/README.md

@@ -65,13 +65,28 @@ The automatically generated help message looks like this:
         -h, --help                       Show this message
         -V, --version                    Print version
 
+It doesn't stop at the command line!
+------------------------------------
+
+µ-optparse can parse any array which is formatted like ARGV, e.g. `["--severity", "4"]` is the same as typing `"--severity 4"` behind your program call.
+You can even process several arrays with the same parser (see example below).
+In addition, you don't need to specify all options at once, i.e. you can pass the parser around and add more options until you call the `process!`-method.
+
+    require 'rubygems' # necessary for ruby v1.8.*
+    require 'micro-optparse'
+    
+    parser = Parser.new
+    parser.option :eat_snickers, "How many?", :default => 0
+    options1 = parser.process!(["--eat-snickers", "2"])
+    options2 = parser.process!(["--eat-snickers", "1"])
+
 Where do I get µ-optparse?
 --------------------------
 
-You can either go and install the gem via `gem install micro-optparse` or grab it from [github](https://github.com/florianpilz/micro-optparse/blob/master/lib/micro-optparse/parser.rb) and paste it into your script.
+You can either go and install the gem via `gem install micro-optparse` or grab it from [this repository](https://github.com/florianpilz/micro-optparse/blob/master/lib/micro-optparse/parser.rb) and paste it into your script.
 If you choose the latter option, you may delete the `validate`-method to spare another 15 lines of code.
 
-If you want to contribute, you can fork the [github repository](https://github.com/florianpilz/micro-optparse), make your changes and send me a pull request.
+If you want to contribute, you can fork this repository, make your changes and send me a pull request.
 However, improvements must be one of the following:
 
 * use fewer lines of code, without sacrificing readablity or functionality

data/lib/micro-optparse/parser.rb

@@ -3,11 +3,10 @@ require 'optparse'
 
 class Parser
   attr_accessor :banner, :version
-
   def initialize
     @options = []
     @used_short = []
-    yield self
+    yield self if block_given?
   end
 
   def option(name, desc, settings = {})
@@ -37,18 +36,18 @@ class Parser
     end
   end
 
-  def process!
-    options = {}
-    optionparser = OptionParser.new do |p|
+  def process!(arguments = ARGV)
+    @result = (@default_values || {}).clone # reset or new
+    @optionparser ||= OptionParser.new do |p| # prepare only once
       @options.each do |o|
         @used_short << short = o[2][:short] || short_from(o[0])
-        options[o[0]] = o[2][:default] || false # set default
+        @result[o[0]] = o[2][:default] || false # set default
         klass = o[2][:default].class == Fixnum ? Integer : o[2][:default].class
 
         if [TrueClass, FalseClass, NilClass].include?(klass) # boolean switch
-          p.on("-" << short, "--[no-]" << o[0].to_s.gsub("_", "-"), o[1]) {|x| options[o[0]] = x}
+          p.on("-" << short, "--[no-]" << o[0].to_s.gsub("_", "-"), o[1]) {|x| @result[o[0]] = x}
         else # argument with parameter
-          p.on("-" << short, "--" << o[0].to_s.gsub("_", "-") << " " << o[2][:default].to_s, klass, o[1]) {|x| options[o[0]] = x}
+          p.on("-" << short, "--" << o[0].to_s.gsub("_", "-") << " " << o[2][:default].to_s, klass, o[1]) {|x| @result[o[0]] = x}
         end
       end
 
@@ -56,15 +55,16 @@ class Parser
       p.on_tail("-h", "--help", "Show this message") {puts p ; exit}
       short = @used_short.include?("v") ? "-V" : "-v"
       p.on_tail(short, "--version", "Print version") {puts @version ; exit} unless @version.nil?
+      @default_values = @result.clone # save default values to reset @result in subsequent calls
     end
 
     begin
-      optionparser.parse!(ARGV)
+      @optionparser.parse!(arguments)
     rescue OptionParser::ParseError => e
       puts e.message ; exit(1)
     end
-
-    validate(options) if self.respond_to?("validate")
-    options
+    
+    validate(@result) if self.respond_to?("validate")
+    @result
   end
 end

data/lib/micro-optparse/version.rb

@@ -1,5 +1,5 @@
 module Micro
   module Optparse
-    VERSION = "1.0.2"
+    VERSION = "1.1.3"
   end
 end

data/spec/parser_spec.rb

@@ -1,9 +1,98 @@
 require "micro-optparse"
 
 describe Parser do
+  before(:all) do
+    @evolutionary_algorithm_parser = Parser.new do |p|
+      p.option :severity, "set severity", :default => 4, :value_in_set => [4,5,6,7,8]
+      p.option :verbose, "enable verbose output"
+      p.option :mutation, "set mutation", :default => "MightyMutation", :value_matches => /Mutation/
+      p.option :plus_selection, "use plus-selection if set", :default => true
+      p.option :selection, "selection used", :default => "BestSelection", :short => "l"
+      p.option :chance, "set mutation chance", :default => 0.8, :value_satisfies => lambda {|x| x >= 0.0 && x <= 1.0}
+    end
+  end
+  
+  describe "parsing of default values" do
+    it "should assume false as default value if no default value was given" do
+      result = @evolutionary_algorithm_parser.process!([])
+      result[:verbose].should == false
+    end
+    
+    it "should return default values if called without arguments" do
+      result = @evolutionary_algorithm_parser.process!([])
+      result[:severity].should == 4
+      result[:verbose].should == false
+      result[:mutation].should == "MightyMutation"
+      result[:plus_selection].should == true
+      result[:selection].should == "BestSelection"
+      result[:chance].should == 0.8
+    end
+  end
+
+  describe "setting of custom values" do
+    it "should display overwritten values accordingly when long option names were used" do
+      args = ["--severity", "5", "--verbose", "--mutation", "DumbMutation",
+              "--no-plus-selection", "--selection", "WorstSelection", "--chance", "0.1"]
+      result = @evolutionary_algorithm_parser.process!(args)
+      result[:severity].should == 5
+      result[:verbose].should == true
+      result[:mutation].should == "DumbMutation"
+      result[:plus_selection].should == false
+      result[:selection].should == "WorstSelection"
+      result[:chance].should == 0.1
+    end
+    
+    it "should display overwritten values accordingly when the 'long=value' form was used" do
+      args = ["--severity=5", "--mutation=DumbMutation", "--selection=WorstSelection", "--chance=0.1"]
+      result = @evolutionary_algorithm_parser.process!(args)
+      result[:severity].should == 5
+      result[:mutation].should == "DumbMutation"
+      result[:selection].should == "WorstSelection"
+      result[:chance].should == 0.1
+    end
+
+    it "should display overwritten values accordingly when short option names were used" do
+      # there is no short form to set switches to false
+      args = ["-s", "5", "-v", "-m", "DumbMutation", "--no-plus-selection", "-l", "WorstSelection", "-c", "0.1"]
+      result = @evolutionary_algorithm_parser.process!(args)
+      result[:severity].should == 5
+      result[:verbose].should == true
+      result[:mutation].should == "DumbMutation"
+      result[:plus_selection].should == false
+      result[:selection].should == "WorstSelection"
+      result[:chance].should == 0.1
+    end
+  end
+  
+  describe "parsing of several arrays using the same parser" do
+    it "should not manipulate old results" do
+      result1 = @evolutionary_algorithm_parser.process!(["--severity=5"])
+      result2 = @evolutionary_algorithm_parser.process!(["--severity=6"])
+      result3 = @evolutionary_algorithm_parser.process!([])
+
+      result1[:severity].should == 5
+      result2[:severity].should == 6
+      result3[:severity].should == 4
+    end
+  end
+  
+  describe "empty parser" do
+    it "should be allowed to create a parser with an empty block" do
+      parser = Parser.new { }
+      parser.should_not be_nil
+      parser.class.should == Parser
+    end
+    
+    it "should be allowed to create a parser without a block" do
+      parser = Parser.new
+      parser.should_not be_nil
+      parser.class.should == Parser
+    end
+  end
+  
   describe "help message" do
     it "should show help message when called with --help or -h" do
-      results = [`ruby spec/programs/example.rb -h`, `ruby spec/programs/example.rb --help`]
+      results = [`ruby spec/programs/eating.rb -h`, `ruby spec/programs/eating.rb --help`]
       results.each do |result|
         result.should include("--help")
         result.should include("Show this message")
@@ -13,134 +102,91 @@ describe Parser do
 
   describe "banner message" do
     it "should include the banner info in the help message" do
-      result = `ruby spec/programs/example.rb --help`
+      result = `ruby spec/programs/eating.rb --help`
       result.should include("This is a banner")
     end
 
     it "should include the default banner info if no banner message was set" do
-      result = `ruby spec/programs/empty_example.rb --help`
-      result.should include("Usage: empty_example [options]")
+      result = `ruby spec/programs/empty.rb --help`
+      result.should include("Usage: empty [options]")
     end
   end
 
   describe "version information" do
     it "should display the version when called with --version or -V" do
       # here -V is used for version, as -v is already taken for the verbose switch
-      results = [`ruby spec/programs/example.rb -V`, `ruby spec/programs/example.rb --version`]
+      results = [`ruby spec/programs/eating.rb -V`, `ruby spec/programs/eating.rb --version`]
       results.each do |result|
-        result.strip.should == "OptParseWrapper 0.8 (c) Florian Pilz 2011"
+        result.strip.should == "EatingScript 1.0 (c) Florian Pilz 2011"
       end
     end
 
     it "should display the version when called with -v" do
-      result = `ruby spec/programs/another_example.rb -v`
-      result.strip.should == "OptParseWrapper 0.8 (c) Florian Pilz 2011"
+      result = `ruby spec/programs/version.rb -v`
+      result.strip.should == "VersionScript 0.0 (c) Florian Pilz 2011"
     end
 
     it "should display a warning when --version or -v was called but no version was set" do
       results = [
-        `ruby spec/programs/empty_example.rb --version 2>&1`,
-        `ruby spec/programs/empty_example.rb -v 2>&1`
+        `ruby spec/programs/empty.rb --version 2>&1`,
+        `ruby spec/programs/empty.rb -v 2>&1`
       ]
       results.each do |result|
-        result.strip.should == "empty_example: version unknown"
+        result.strip.should == "empty: version unknown"
       end
     end
   end
 
-  describe "parsing of default values" do
-    it "should display the default values if called without arguments" do
-      result = `ruby spec/programs/example.rb`
-      result.should include(":severity => 4")
-      result.should include(":verbose => false")
-      result.should include(":mutation => MightyMutation")
-      result.should include(":plus_selection => true")
-      result.should include(":selection => BestSelection")
-      result.should include(":chance => 0.8")
-    end
-
-    it "should assume false as default value if no default value was given" do
-      result = `ruby spec/programs/another_example.rb`
-      result.should include(":eat_nothing => false")
-    end
-  end
-
-  describe "setting of custom values" do
-    it "should display overwritten values accordingly when long option names were used" do
-      args = "--severity 5 --verbose --mutation DumbMutation \
-              --no-plus-selection --selection WorstSelection --chance 0.1"
-      result = `ruby spec/programs/example.rb #{args}`
-      result.should include(":severity => 5")
-      result.should include(":verbose => true")
-      result.should include(":mutation => DumbMutation")
-      result.should include(":plus_selection => false")
-      result.should include(":selection => WorstSelection")
-      result.should include(":chance => 0.1")
-    end
-
-    it "should display overwritten values accordingly when short option names were used" do
-      # there is no short form to set switches to false
-      args = "-s 5 -v -m DumbMutation --no-plus-selection -l WorstSelection -c 0.1"
-      result = `ruby spec/programs/example.rb #{args}`
-      result.should include(":severity => 5")
-      result.should include(":verbose => true")
-      result.should include(":mutation => DumbMutation")
-      result.should include(":plus_selection => false")
-      result.should include(":selection => WorstSelection")
-      result.should include(":chance => 0.1")
-    end
-  end
-
   describe "warnings from optparse" do
     it "should display a warning if an argument was invalid" do
-      result = `ruby spec/programs/example.rb --free-beer`
+      result = `ruby spec/programs/eating.rb --free-beer`
       result.strip.should == "invalid option: --free-beer"
     end
 
     it "should display a warning if another argument is needed" do
-      result = `ruby spec/programs/example.rb --mutation`
-      result.strip.should == "missing argument: --mutation"
+      result = `ruby spec/programs/eating.rb --eat-cake`
+      result.strip.should == "missing argument: --eat-cake"
     end
 
     it "should display a warning if an argument of the wrong type was given" do
-      result = `ruby spec/programs/example.rb --severity OMFG!!!`
-      result.strip.should == "invalid argument: --severity OMFG!!!"
+      result = `ruby spec/programs/eating.rb --eat-marshmellows OMFG!!!`
+      result.strip.should == "invalid argument: --eat-marshmellows OMFG!!!"
     end
 
     it "should display a warning if autocompletion of an argument was ambiguous" do
-      result = `ruby spec/programs/example.rb --se 5`
-      result.strip.should == "ambiguous option: --se"
+      result = `ruby spec/programs/eating.rb --eat yummy!`
+      result.strip.should == "ambiguous option: --eat"
     end
   end
 
   describe "warnings if validation failed" do
     it "should display a warning if validation value_in_set failed" do
-      result = `ruby spec/programs/example.rb --severity 1`
-      result.strip.should == "Parameter for --severity must be in [4,5,6,7,8]"
+      result = `ruby spec/programs/eating.rb --eat-bagel AshBagel`
+      result.strip.should match(/Parameter for --eat-bagel must be in \[SalmonBagel,\s?ParmesanBagel\]/)
     end
 
     it "should display a warning if validation value_matches failed" do
-      result = `ruby spec/programs/example.rb --mutation Bazinga`
-      result.strip.should == "Parameter for --mutation must match /Mutation/"
+      result = `ruby spec/programs/eating.rb --eat-cake Chocolate`
+      result.strip.should == "Parameter for --eat-cake must match /Cake/"
     end
 
     it "should display a warning if validation value_satisfies failed" do
-      result = `ruby spec/programs/example.rb --chance 300.21`
-      result.strip.should == "Parameter for --chance must satisfy given conditions (see description)"
+      result = `ruby spec/programs/eating.rb --eat-cake 12Cakes`
+      result.strip.should == "Parameter for --eat-cake must satisfy given conditions (see description)"
     end
 
-    it "should validate all given validations" do
-      result = `ruby spec/programs/another_example.rb --eat-cake VanillaBrownie`
+    it "should validate all validations if several are given for an option" do
+      result = `ruby spec/programs/eating.rb --eat-cake VanillaBrownie`
       result.strip.should == "Parameter for --eat-cake must match /Cake/"
 
-      result = `ruby spec/programs/another_example.rb --eat-cake 2VanillaCakes`
+      result = `ruby spec/programs/eating.rb --eat-cake 2VanillaCakes`
       result.strip.should == "Parameter for --eat-cake must satisfy given conditions (see description)"
     end
   end
 
   describe "automatic assignment of default accessors" do
     it "should assign a different character for the short accessor if the first / second / ... is already taken" do
-      result = `ruby spec/programs/another_example.rb --help`
+      result = `ruby spec/programs/eating.rb --help`
       result.should include("--eat-cake")
       result.should include("-a, --eat-salad")
       result.should include("-t, --eat-bagel")

data/spec/programs/{another_example.rb → eating.rb}

@@ -2,12 +2,14 @@ require "rubygems"
 require "micro-optparse"
 
 options = Parser.new do |p|
-  p.version = "OptParseWrapper 0.8 (c) Florian Pilz 2011"
+  p.version = "EatingScript 1.0 (c) Florian Pilz 2011"
+  p.banner = "This is a banner"
+  p.option :verbose, "Switch on verbosity"
   p.option :eat_cake, "Eath the yummy cake!", :default => "PlainCake", :value_matches => /Cake/, :value_satisfies => lambda { |arg| arg.to_i == 0 }
   p.option :eat_salad, "It's healty!", :default => "CucumberSalad"
-  p.option :eat_bagel, "You should try it with salmon.", :default => "SalmonBagel"
+  p.option :eat_bagel, "You should try it with salmon.", :default => "SalmonBagel", :value_in_set => ["SalmonBagel", "ParmesanBagel"]
   p.option :eat_nothing, "Stupid decision ..."
-  p.option :eat_marshmellow, "Filled with sugar.", :default => "Sugar"
+  p.option :eat_marshmellows, "How many?", :default => 0
   p.option :eat_me, "WHAT?!?", :default => "TastyHuman"
 end.process!
 

data/spec/programs/version.rb

@@ -0,0 +1,10 @@
+require "rubygems"
+require "micro-optparse"
+
+options = Parser.new do |p|
+  p.version = "VersionScript 0.0 (c) Florian Pilz 2011"
+end.process!
+
+options.each_pair do |key, value|
+  puts ":#{key} => #{value}"
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: micro-optparse
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 21
   prerelease: 
   segments: 
   - 1
-  - 0
-  - 2
-  version: 1.0.2
+  - 1
+  - 3
+  version: 1.1.3
 platform: ruby
 authors: 
 - Florian Pilz
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-19 00:00:00 +01:00
+date: 2011-04-19 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,9 +52,9 @@ files:
 - lib/micro-optparse/version.rb
 - micro-optparse.gemspec
 - spec/parser_spec.rb
-- spec/programs/another_example.rb
-- spec/programs/empty_example.rb
-- spec/programs/example.rb
+- spec/programs/eating.rb
+- spec/programs/empty.rb
+- spec/programs/version.rb
 has_rdoc: true
 homepage: http://florianpilz.github.com/micro-optparse/
 licenses: 
@@ -91,6 +91,6 @@ specification_version: 3
 summary: An option parser which is 70 lines short.
 test_files: 
 - spec/parser_spec.rb
-- spec/programs/another_example.rb
-- spec/programs/empty_example.rb
-- spec/programs/example.rb
+- spec/programs/eating.rb
+- spec/programs/empty.rb
+- spec/programs/version.rb

data/spec/programs/example.rb

@@ -1,17 +0,0 @@
-require "rubygems"
-require "micro-optparse"
-
-options = Parser.new do |p|
-  p.banner = "This is a banner"
-  p.version = "OptParseWrapper 0.8 (c) Florian Pilz 2011"
-  p.option :severity, "set severity", :default => 4, :value_in_set => [4,5,6,7,8]
-  p.option :verbose, "enable verbose output"
-  p.option :mutation, "set mutation", :default => "MightyMutation", :value_matches => /Mutation/
-  p.option :plus_selection, "use plus-selection if set", :default => true
-  p.option :selection, "selection used", :default => "BestSelection", :short => "l"
-  p.option :chance, "set mutation chance", :default => 0.8, :value_satisfies => lambda {|x| x >= 0.0 && x <= 1.0}
-end.process!
-
-options.each_pair do |key, value|
-  puts ":#{key} => #{value}"
-end