optparse-range 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/BSDL

@@ -0,0 +1,22 @@
+Copyright (C) 2012 KITAITI Makoto. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in optparse-range.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,56 @@
+OptionParser::Range is copyrighted free software by KITAITI Makoto <KitaitiMakoto@gmail.com>.
+You can redistribute it and/or modify it under either the terms of the
+2-clause BSDL (see the file BSDL), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or binary form,
+     provided that you do at least ONE of the following:
+
+       a) distribute the binaries and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under these terms.
+
+     For the list of those files and their copying conditions, see the
+     file LEGAL.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/README.markdown

@@ -0,0 +1,142 @@
+OptionParser::Range
+===================
+
+This RubyGem allows standard bundled `OptionParser` to accept option arguments as `Range` object.
+
+Inspired by [Slop][slop] gem's [Range][sloprange] feature
+
+Note that `OptionParser::Range` module doesn't exist.
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+    gem 'optparse-range'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install optparse-range
+
+Usage
+-----
+
+    require 'optparse/range'
+    
+    opts = OptionParser.new do |opti|
+      opti.on '--page=STARTPAGE-ENDPAGE', OptionParser::DecimalRange
+    end.getopts
+    # for instance, when --page=024-160 passed
+    opts #=> {"page"=>24..160}
+    opts['page'].class #=> Range
+
+When only one argument passed, it handled as both start and end:
+
+    opts = OptionParser.new do |opti|
+      opti.on '--port=STARTPORT-ENDPORT', OptionParser::DecimalRange
+    end
+    # when --port=8080
+    opts #=> {"port"=>8080..8080}
+
+You can replace `OptionParser::DecimalRange` in above example with other type of `Range`.
+Currently provided:
+
+### `OptionParser::DecimalRange` ###
+
+* `Integer` range
+* `--number=1-5` => `1..5`
+*  only zero or positive integers are supported currently
+
+### `OptionParser::FloatRange` ###
+
+* `Float` range
+* `--ratio=1.2-1.5` => `1.2..1.5`
+* only zero or positive floats are supported currently
+
+### `OptionParser::DateRange` ###
+* `Date` range
+* `--trip=0810-0820` => `#<Date: 2012-08-10 ((2456150j,0s,0n),+0s,2299161j)>..#<Date: 2012-08-20 ((2456160j,0s,0n),+0s,2299161j)>`
+
+### `OptionParser::DateTimeRange` ###
+
+* `DateTime` range
+* `--flight=0810T10:00-0810T12:20` => `#<DateTime: 2012-08-10T10:00:00+00:00 ((2456150j,36000s,0n),+0s,2299161j)>..#<DateTime: 2012-08-10T12:20:00+00:00 ((2456150j,44400s,0n),+0s,2299161j)>`
+
+### `OptionParser::TimeRange` ###
+
+* `Time` range
+* `--flight=10:00-12:20` => `>2012-07-29 10:00:00 +0900..2012-07-29 12:20:00 +0900`
+
+### `OptionParser::StringRange` ###
+
+* `String` range
+* `--chars=A-Z` => `"A".."Z"`
+
+Adding Type of Rnage
+--------------------
+
+To add a type of range, use `OptionParser.accept_range`.
+
+1. Define class which can be used as points of `Range`(`MyClass` here).
+2. Define class or `Regexp` which allows `OptionParser` to accept class above as the points of `Range`(`MyClassRange`). Class is recommended.
+3. Pass the class and `Symbol` or `Proc` which converts a command line option(`String`) to an object of point(`MyClass`). `lambda` is used here. `to_proc` will be called when `Symbol` is passed.
+4. Now, you can pass the class for range(`MyClassRange`) to `OptionParser#on` and use the option argument as `Range`.
+
+Example:
+
+    require 'optparse/range'
+    
+    class MyClass
+      class << self
+        def parse(arg)
+          # parse arg and return MyClass object
+          new(arg)
+        end
+      end
+    
+      attr_reader :arg
+    
+      def initialize(arg)
+        @arg = arg
+      end
+    
+      def <=>(other)
+        @arg <=> other.arg
+      end
+    end
+    
+    class MyClassRange; end
+    OptionParser.accept_range MyClassRange, lambda {|range| MyClass.parse range}
+    
+    opts = OptionParser.new do |opti|
+      opti.on '--myoption=MYSTART-MYEND', MyClassRange
+    end.getopts
+    p opts
+
+Result:
+
+    $ ./mycommand --myoption=mystart-myend
+    {"myoption"=>#<MyClass:0x000000031824c0 @arg="mystart">..#<MyClass:0x00000003182420 @arg="myend">}
+
+Contributing
+------------
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+License
+-------
+
+OptionParser::Range is released under the Ruby's license.
+See the file LICENSE.txt.
+
+<!-- Links -->
+[slop]: https://github.com/injekt/slop
+[sloprange]: https://github.com/injekt/slop/wiki/Ranges

data/Rakefile

@@ -0,0 +1,6 @@
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+task :default => :test
+
+Rake::TestTask.new

data/lib/optparse/range.rb

@@ -0,0 +1,77 @@
+require 'optparse'
+
+class OptionParser
+  class << self
+    def accept_range(accepter, converter)
+      accept accepter do |range,|
+        return unless range
+        terms = range.split('-')
+        raise AmbiguousArgument if terms.length > 2
+        terms << terms.first if terms.length == 1
+        Range.new *terms.map(&converter)
+      end
+    end
+  end
+
+  decimal = '\d+(?:_\d+)*'
+  DecimalRange = /#{decimal}(?:\-#{decimal})/io
+  accept_range DecimalRange, :to_i
+
+  float = "(?:#{decimal}(?:\\.(?:#{decimal})?)?|\\.#{decimal})(?:E[-+]?#{decimal})?"
+  FloatRange = /#{float}-#{float}/io
+  accept_range FloatRange, :to_f
+
+  class DateRange
+    class << self
+      attr_reader :converter
+    end
+    @converter = lambda {|date|
+      begin
+        Date.parse date
+      rescue NameError
+        require 'date'
+        retry
+      rescue ArgumentError
+        raise InvalidArgument, date
+      end
+    }
+  end
+  accept_range DateRange, DateRange.converter
+
+  class DateTimeRange
+    class << self
+      attr_reader :converter
+    end
+    @converter = lambda {|dt|
+      begin
+        DateTime.parse dt
+      rescue NameError
+        require 'date'
+        retry
+      rescue ArgumentError
+        raise InvalidArgument, dt
+      end
+    }
+  end
+  accept_range DateTimeRange, DateTimeRange.converter
+
+  class TimeRange
+    class << self
+      attr_reader :converter
+    end
+    @converter = lambda {|time|
+      begin
+        Time.httpdate(time) rescue Time.parse(time)
+      rescue NoMethodError
+        require 'time'
+        retry
+      rescue
+        raise InvalidArgument, time
+      end
+    }
+  end
+  accept_range TimeRange, TimeRange.converter
+
+  class StringRange; end
+  accept_range StringRange, :to_s
+end

data/optparse-range.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |gem|
+  gem.name          = "optparse-range"
+  gem.version       = '0.0.1'
+  gem.authors       = ["KITAITI Makoto"]
+  gem.email         = ["KitaitiMakoto@gmail.com"]
+  gem.description   = %q{This RubyGem allows standard bundled `OptionParser` to accept option arguments as `Range` object.}
+  gem.summary       = %q{Range command line arguments handling}
+  gem.homepage      = "https://github.com/KitaitiMakoto/optparse-range"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/test/test_range.rb

@@ -0,0 +1,54 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'test/unit'
+require 'optparse/range'
+
+class TestOptionParserRange < Test::Unit::TestCase
+  def setup
+    @opt = OptionParser.new
+  end
+
+  def test_decimal_range
+    assert_equal 81..123, parse_option(OptionParser::DecimalRange, '081-123')
+    assert_equal 1..1, parse_option(OptionParser::DecimalRange, '1')
+  end
+
+  def test_float_range
+    assert_equal (1.2)..(64.33), parse_option(OptionParser::FloatRange, '01.20-64.33')
+    assert_equal (30.0)..(30.0), parse_option(OptionParser::FloatRange, '30')
+  end
+
+  def test_date_range
+    actual = parse_option(OptionParser::DateRange, '0701-0731')
+    assert_equal Date.parse('0701')..Date.parse('0731'), actual
+  end
+
+  def test_date_time_range
+    actual = parse_option(OptionParser::DateTimeRange, '20120601T00:00:00-20120630T24:00:00')
+    assert_equal DateTime.parse('20120601T00:00:00')..DateTime.parse('20120630T24:00:00'),
+                 actual
+  end
+
+  def test_time_range
+    actual = parse_option(OptionParser::TimeRange, '04:30-19:12:14')
+    dawn = '4:30'
+    dawn = Time.httpdate(dawn) rescue Time.parse(dawn)
+    dusk = '19:12:14'
+    dusk = Time.httpdate(dusk) rescue Time.parse(dusk)
+    assert_equal dawn..dusk, actual
+  end
+
+  def test_string_range
+    assert_equal 'A'..'Z', parse_option(OptionParser::StringRange, 'A-Z')
+  end
+
+  private
+
+  def parse_option(accepter, arg)
+    opts = {}
+    @opt.def_option "--range=START-END", accepter do |range|
+      opts['range'] = range
+    end
+    @opt.parse! ["--range=#{arg}"]
+    opts['range']
+  end
+end

data/test/test_range.rb~

@@ -0,0 +1 @@
+require 'test/unit'

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: optparse-range
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- KITAITI Makoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-28 00:00:00.000000000Z
+dependencies: []
+description: This RubyGem allows standard bundled `OptionParser` to accept option
+  arguments as `Range` object.
+email:
+- KitaitiMakoto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gemtest
+- .gitignore
+- .travis.yml
+- BSDL
+- Gemfile
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- lib/optparse/range.rb
+- optparse-range.gemspec
+- test/test_range.rb
+- test/test_range.rb~
+homepage: https://github.com/KitaitiMakoto/optparse-range
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 714120662123402692
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 714120662123402692
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: Range command line arguments handling
+test_files:
+- test/test_range.rb
+- test/test_range.rb~