micro-optparse 0.8.1 → 0.8.2

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Florian Pilz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and  associated documentation files (the "Software"),  to deal in
+the Software  without restriction, including  without limitation the  rights to
+use, copy, modify,  merge, publish, distribute, sublicense,  and/or sell copies
+of the Software, and to permit persons  to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this  permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE  IS PROVIDED  "AS IS",  WITHOUT WARRANTY OF  ANY KIND,  EXPRESS OR
+IMPLIED,  INCLUDING  BUT NOT  LIMITED  TO  THE WARRANTIES  OF  MERCHANTABILITY,
+FITNESS FOR  A PARTICULAR PURPOSE  AND NONINFRINGEMENT.  IN NO EVENT  SHALL THE
+AUTHORS  OR  COPYRIGHT HOLDERS  BE  LIABLE  FOR  ANY  CLAIM, DAMAGES  OR  OTHER
+LIABILITY, WHETHER IN  AN ACTION OF CONTRACT, TORT OR  OTHERWISE, ARISING FROM,
+OUT OF OR IN  CONNECTION WITH THE SOFTWARE OR THE USE OR  OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+µ-optparse
+==========
+
+Why another command line parser?
+--------------------------------
+
+There are lots of command line parser out there, for example [trollop](http://trollop.rubyforge.org/) is a great alternative.
+However, it is 800 lines long.
+In addition, trollop sucks at validating the input.
+So µ-optparse is for you if you are looking for
+
+* a small command line parser to copy and paste it into your scripts to avoid injecting gem-dependencies
+* a command line parser with powerful validations
+* an easily usable, understandable and extendable command line parser
+* a wrapper around optparse, which intelligently fills out most informations on its own
+
+What is µ-optparse?
+-------------------
+
+µ-optparse is a small wrapper around [optparse](http://www.ruby-doc.org/stdlib/libdoc/optparse/rdoc/classes/OptionParser.html), weighing **less than 75 lines of code**.
+optparse (or OptionParser) on the other hand is a command line parser, which ships with ruby.
+After you defined available options, it automatically creates a help page and is able to parse ARGV accordingly.
+However, optparse requires you to repeat yourself quite often, which leads to many lines of code, just to configure the available options.
+µ-optparse removes this obstacle by extracting the information contained in few lines of configuration.
+In addition, µ-optparse extends optparse by some **powerful validations**, which where inspired by [OptiFlag](http://optiflag.rubyforge.org/quick.html).
+
+Talk in code!
+-------------
+
+    require 'rubygems' # necessary for ruby v1.8.*
+    require 'micro-optparse'
+    options = Parser.new do |p|
+       p.banner = "This is a fancy script, for usage see below"
+       p.version = "fancy script 0.0 alpha"
+       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!
+
+What this piece of code does is the following:
+
+* it creates a help message and help options, with the banner above the options
+* it creates a version option, which displays the given text
+* it creates a long accessor for each option, according to the symbol - for example `"--verbose"` for `:verbose`
+* it crease a short accessor, which is the first character of the long accessor (automatically resolves duplicates)
+* it checks if the class of the input and the default value match
+* it creates a switch, if no default value exist or the default value is `true` or `false`
+* when value\_in\_set is given, it validates if the input value is in the given array
+* when value_matches is given, it validates if the input value matches the regular expression
+* when value_satisfies is given, it validates if the lamda or Proc evaluates to `true`, when fed with the input value
+* it stores all parsed arguments and default values in the options hash, i.e. to access the value of `:mutation` in your script, write `options[:mutation]`
+
+The automatically generated help message looks like this:
+
+    This is a fancy script, for usage see below
+        -s, --severity 4                 set severity
+        -v, --[no-]verbose               enable verbose output
+        -m, --mutation MightyMutation    set mutation
+        -p, --[no-]plus-selection        use plus-selection if set
+        -l, --selection BestSelection    selection used
+        -c, --chance 0.8                 set mutation chance
+        -h, --help                       Show this message
+        -V, --version                    Print version
+
+Where do I get &micro;-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.
+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.
+However, improvements must be one of the following:
+
+* use fewer lines of code, without sacrificing readablity or functionality
+* enhance readablity or functionality, without increasing the lines of code

data/lib/micro-optparse/version.rb

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

data/micro-optparse.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Florian Pilz"]
   s.email       = ["fpilz87@googlemail.com"]
-  s.homepage    = ""
+  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.}
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: micro-optparse
 version: !ruby/object:Gem::Version 
-  hash: 61
+  hash: 59
   prerelease: 
   segments: 
   - 0
   - 8
-  - 1
-  version: 0.8.1
+  - 2
+  version: 0.8.2
 platform: ruby
 authors: 
 - Florian Pilz
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-26 00:00:00 +01:00
+date: 2011-02-27 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -31,13 +31,15 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- MIT-LICENSE
+- README.md
 - Rakefile
 - lib/micro-optparse.rb
 - lib/micro-optparse/parser.rb
 - lib/micro-optparse/version.rb
 - micro-optparse.gemspec
 has_rdoc: true
-homepage: ""
+homepage: http://florianpilz.github.com/micro-optparse/
 licenses: 
 - MIT
 post_install_message: