micro-optparse 0.8.2 → 1.0.0

data/Rakefile

@@ -1,2 +1,7 @@
 require 'bundler'
+require 'rspec/core/rake_task'
+
 Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/micro-optparse.rb

@@ -1,19 +1 @@
-require 'micro-optparse/parser'
-# 
-# options = Parser.new do |p|
-#   # p.banner = "test"
-#   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!
-# 
-# puts options[:severity]
-# puts options[:verbose]
-# puts options[:mutation]
-# puts options[:plus_selection]
-# puts options[:selection]
-# puts options[:chance]
+require 'micro-optparse/parser'

data/lib/micro-optparse/parser.rb

@@ -16,23 +16,23 @@ class Parser
 
   def short_from(name)
     name.to_s.chars.each do |c|
-      next if @used_short.include?(c)
+      next if @used_short.include?(c) || c == "_"
       return c # returns from short_from method
     end
   end
 
   def validate(options) # remove this method if you want fewer lines of code and don't need validations
     options.each_pair do |key, value|
-      opt = nil
-      @options.each { |o| opt = o if o[0] == key }
+      opt = @options.find_all{ |o| o[0] == key }.first
+      key = "--" << key.to_s.gsub("_", "-")
       unless opt[2][:value_in_set].nil? || opt[2][:value_in_set].include?(value)
-        puts "Parameter for " << key.to_s << " must be in [" << opt[2][:value_in_set].join(",") << "]" ; exit(1)
+        puts "Parameter for #{key} must be in [" << opt[2][:value_in_set].join(",") << "]" ; exit(1)
       end
       unless opt[2][:value_matches].nil? || opt[2][:value_matches] =~ value
-        puts "Parameter must match /" << opt[2][:value_matches].source << "/" ; exit(1)
+        puts "Parameter for #{key} must match /" << opt[2][:value_matches].source << "/" ; exit(1)
       end
       unless opt[2][:value_satisfies].nil? || opt[2][:value_satisfies].call(value)
-        puts "Parameter must satisfy given conditions (see description)" ; exit(1)
+        puts "Parameter for #{key} must satisfy given conditions (see description)" ; exit(1)
       end
     end
   end
@@ -45,7 +45,7 @@ class Parser
         options[o[0]] = o[2][:default] || false # set default
         klass = o[2][:default].class == Fixnum ? Integer : o[2][:default].class
 
-        if klass == TrueClass || klass == FalseClass || klass == NilClass # boolean switch
+        if [TrueClass, FalseClass, NilClass].include?(klass) # boolean switch
           p.on("-" << short, "--[no-]" << o[0].to_s.gsub("_", "-"), o[1]) {|x| options[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}

data/lib/micro-optparse/version.rb

@@ -1,5 +1,5 @@
 module Micro
   module Optparse
-    VERSION = "0.8.2"
+    VERSION = "1.0.0"
   end
 end

data/micro-optparse.gemspec

@@ -10,12 +10,14 @@ Gem::Specification.new do |s|
   s.email       = ["fpilz87@googlemail.com"]
   s.homepage    = "http://florianpilz.github.com/micro-optparse/"
   s.summary     = %q{A very small wrapper around optparse.}
-  s.description = %q{This gem wraps all the functionality of optparse into an easy to use, clear and short syntax. In addtion, strong validations are added. You can either use this gem as a lightweight alternative to trollop or copy all its 75 lines into your script to have an command-line parser without injecting a gem dependency.}
-
-  s.license = "MIT"
+  s.description = %q{This gem wraps all the functionality of optparse into an easy to use, clear and short syntax. In addtion, strong validations are added. You can either use this gem as a lightweight alternative to trollop or copy all its 75 lines into your script to have a command-line parser without injecting a gem dependency.}
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+  
+  s.license = "MIT"
+  s.has_rdoc = false
+  s.add_development_dependency("rspec")
 end

data/spec/parser_spec.rb

@@ -0,0 +1,152 @@
+require "micro-optparse"
+
+describe Parser do
+  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.each do |result|
+        result.should include("--help")
+        result.should include("Show this message")
+      end
+    end
+  end
+
+  describe "banner message" do
+    it "should include the banner info in the help message" do
+      result = `ruby spec/programs/example.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]")
+    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.each do |result|
+        result.strip.should == "OptParseWrapper 0.8 (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"
+    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`
+      ]
+      results.each do |result|
+        result.strip.should == "empty_example: 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.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"
+    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!!!"
+    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"
+    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]"
+    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/"
+    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)"
+    end
+
+    it "should validate all given validations" do
+      result = `ruby spec/programs/another_example.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.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.should include("--eat-cake")
+      result.should include("-a, --eat-salad")
+      result.should include("-t, --eat-bagel")
+      result.should include("-n, --[no-]eat-nothing")
+      result.should include("-m, --eat-marshmellow")
+      result.should include("-e, --eat-me")
+    end
+  end
+end

data/spec/programs/another_example.rb

@@ -0,0 +1,16 @@
+require "rubygems"
+require "micro-optparse"
+
+options = Parser.new do |p|
+  p.version = "OptParseWrapper 0.8 (c) Florian Pilz 2011"
+  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_nothing, "Stupid decision ..."
+  p.option :eat_marshmellow, "Filled with sugar.", :default => "Sugar"
+  p.option :eat_me, "WHAT?!?", :default => "TastyHuman"
+end.process!
+
+options.each_pair do |key, value|
+  puts ":#{key} => #{value}"
+end

data/spec/programs/empty_example.rb

@@ -0,0 +1,9 @@
+require "rubygems"
+require "micro-optparse"
+
+options = Parser.new do |p|
+end.process!
+
+options.each_pair do |key, value|
+  puts ":#{key} => #{value}"
+end

data/spec/programs/example.rb

@@ -0,0 +1,17 @@
+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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: micro-optparse
 version: !ruby/object:Gem::Version 
-  hash: 59
+  hash: 23
   prerelease: 
   segments: 
+  - 1
   - 0
-  - 8
-  - 2
-  version: 0.8.2
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Florian Pilz
@@ -15,11 +15,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-27 00:00:00 +01:00
+date: 2011-03-13 00:00:00 +01:00
 default_executable: 
-dependencies: []
-
-description: This gem wraps all the functionality of optparse into an easy to use, clear and short syntax. In addtion, strong validations are added. You can either use this gem as a lightweight alternative to trollop or copy all its 75 lines into your script to have an command-line parser without injecting a gem dependency.
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: This gem wraps all the functionality of optparse into an easy to use, clear and short syntax. In addtion, strong validations are added. You can either use this gem as a lightweight alternative to trollop or copy all its 75 lines into your script to have a command-line parser without injecting a gem dependency.
 email: 
 - fpilz87@googlemail.com
 executables: []
@@ -38,6 +51,10 @@ files:
 - lib/micro-optparse/parser.rb
 - 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
 has_rdoc: true
 homepage: http://florianpilz.github.com/micro-optparse/
 licenses: 
@@ -72,5 +89,8 @@ rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: A very small wrapper around optparse.
-test_files: []
-
+test_files: 
+- spec/parser_spec.rb
+- spec/programs/another_example.rb
+- spec/programs/empty_example.rb
+- spec/programs/example.rb