slop 3.0.0.rc1 → 3.0.0

data/CHANGES.md

@@ -1,3 +1,34 @@
+3.0.0 (2012-01-24)
+------------------
+
+* value_to_range returns an x..x range if the value looks like an integer.
+* Lots of code refactoring
+* Use TomDoc documentation
+* Added `Slop::Commands` and removed existing command system
+* Configuration options altered:
+	* `:optional` has been renamed to `:optional_argument`
+	* Added `:required` for mandatory options
+	* `:argument` now accepts an `:optional` symbol as well as boolean value
+* Removed Slop instance methods:
+	* description=, description
+	* summary=, summary
+	* command
+	* on_empty
+	* on_noopts
+	* execute
+	* to_struct
+* Added Slop instance methods:
+	* separator
+	* fetch_option
+	* add_callback
+
+2.4.3 (2012-01-16)
+------------------
+
+* Allow the `:as` option to accept an object responding to :call for
+  custom type conversions (#45)
+* Ensure negative integers are not parsed as possible options (#46)
+
 2.4.2 (2011-12-18)
 ------------------
 

data/README.md

@@ -3,6 +3,8 @@ Slop
 
 Slop is a simple option parser with an easy to remember syntax and friendly API.
 
+This README is targeted at Slop v3.
+
 Installation
 ------------
 
@@ -48,10 +50,6 @@ on :p, :password, 'Your password', :optional_argument => true
 on '-p', 'password=?', 'Your password'
 ```
 
-For more information about creating options, see the
-[Creating Options](https://github.com/injekt/slop/wiki/Creating-Options)
-wiki page.
-
 You can also return your options as a Hash:
 
 ```ruby
@@ -91,7 +89,6 @@ Check out the following wiki pages for more features:
 
 * [Ranges](https://github.com/injekt/slop/wiki/Ranges)
 * [Auto Create](https://github.com/injekt/slop/wiki/Auto-Create)
-* [Commands](https://github.com/injekt/slop/wiki/Commands)
 
 Woah woah, why you hating on OptionParser?
 ------------------------------------------

data/lib/slop.rb

@@ -2,7 +2,9 @@ require 'slop/option'
 require 'slop/commands'
 
 class Slop
-  VERSION = '3.0.0.rc1'
+  include Enumerable
+
+  VERSION = '3.0.0'
 
   # The main Error class, all Exception classes inherit from this class.
   class Error < StandardError; end
@@ -228,6 +230,11 @@ class Slop
   end
   alias to_h to_hash
 
+  # Enumerable interface. Yields each Slop::Option.
+  def each(&block)
+    options.each(&block)
+  end
+
   # Check for an options presence.
   #
   # Examples:

data/lib/slop/commands.rb

@@ -40,7 +40,7 @@ class Slop
     #
     # Returns the newly created Slop instance mapped to command.
     def on(command, config = {}, &block)
-      commands[command] = Slop.new(@config.merge(config), &block)
+      commands[command.to_s] = Slop.new(@config.merge(config), &block)
     end
 
     # Add a Slop instance used when no other commands exist.
@@ -50,7 +50,7 @@ class Slop
     #
     # Returns the newly created Slop instance mapped to default.
     def default(config = {}, &block)
-      commands['default'] = Slop.new(@config.merge(config), &block)
+      on('default', config, &block)
     end
 
     # Add a global Slop instance.
@@ -60,7 +60,7 @@ class Slop
     #
     # Returns the newly created Slop instance mapped to global.
     def global(config = {}, &block)
-      commands['global'] = Slop.new(@config.merge(config), &block)
+      on('global', config, &block)
     end
 
     # Fetch the instance of Slop tied to a command.

data/lib/slop/option.rb

@@ -129,19 +129,23 @@ class Slop
 
     private
 
-    # Convert an object to a Range if possible. If this method is passed
-    # what does *not* look like a Range, but looks like an Integer of some
-    # sort, it will call #to_i on the Object and return the Integer
-    # representation.
+    # Convert an object to a Range if possible.
     #
     # value - The Object we want to convert to a range.
     #
     # Returns the Range value if one could be found, else the original object.
     def value_to_range(value)
-      if value.to_s =~ /\A(?:\-?\d+|(-?\d+?)(\.\.\.?|-|,)(-?\d+))\z/
-        $1 ? Range.new($1.to_i, $3.to_i, $2 == '...') : value.to_i
+      case value.to_s
+      when /\A(\-?\d+)\z/
+        Range.new($1.to_i, $1.to_i)
+      when /\A(-?\d+?)(\.\.\.?|-|,)(-?\d+)\z/
+        Range.new($1.to_i, $3.to_i, $2 == '...')
       else
-        value
+        if @slop.config[:strict]
+          raise InvalidArgumentError, "#{value} could not be coerced into Range"
+        else
+          value
+        end
       end
     end
 

data/slop.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'slop'
-  s.version = '3.0.0.rc1'
+  s.version = '3.0.0'
   s.summary = 'Option gathering made easy'
   s.description = 'A simple DSL for gathering options and parsing the command line'
   s.author = 'Lee Jarvis'

data/test/option_test.rb

@@ -66,6 +66,10 @@ class OptionTest < TestCase
     assert_equal (1...10), option_value(%w/-r 1...10/, :r=, :as => Range)
     assert_equal (-1..10), option_value(%w/-r -1..10/, :r=, :as => Range)
     assert_equal (1..-10), option_value(%w/-r 1..-10/, :r=, :as => Range)
+    assert_equal (1..1), option_value(%w/-r 1/, :r=, :as => Range)
+
+    opts = Slop.new(:strict => true) { on :r=, :as => Range }
+    assert_raises(Slop::InvalidArgumentError) { opts.parse %w/-r abc/ }
   end
 
   test "array type cast" do

data/test/slop_test.rb

@@ -23,6 +23,14 @@ class SlopTest < TestCase
     $stderr = STDERR
   end
 
+  test "includes Enumerable" do
+    assert_includes Slop.included_modules, Enumerable
+  end
+
+  test "enumerates Slop::Option objects in #each" do
+    Slop.new { on :f; on :b; }.each { |o| assert_kind_of Slop::Option, o }
+  end
+
   test "build_option" do
     assert_equal ['f', nil, nil, {}], build_option(:f)
     assert_equal [nil, 'foo', nil, {}], build_option(:foo)

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: slop
 version: !ruby/object:Gem::Version
-  version: 3.0.0.rc1
-  prerelease: 6
+  version: 3.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Lee Jarvis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-20 00:00:00.000000000 Z
+date: 2012-01-24 00:00:00.000000000 Z
 dependencies: []
 description: A simple DSL for gathering options and parsing the command line
 email: lee@jarvis.co
@@ -45,9 +45,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11