slop 3.0.4 → 3.1.0

data/.gitignore

@@ -4,3 +4,4 @@ doc
 *.swp
 *.gem
 *.rbc
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,12 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+notifications:
+  email:
+    on_success: change
+    on_failure: always

data/CHANGES.md

@@ -1,3 +1,12 @@
+3.1.0
+-----
+
+* Allow options to be fetched via underscores instead of dashes
+  (as a fallback) (Eric Anderson, #51)
+* Added `Slop#strict?` method.
+* Added strict checks for Integer/Float type casting. (Amon Sha)
+* Ensure separators are not replacing existing separators (#61)
+
 3.0.4 (2012-01-31)
 ------------------
 

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -5,6 +5,8 @@ Slop is a simple option parser with an easy to remember syntax and friendly API.
 
 This README is targeted at Slop v3.
 
+[![Build Status](https://secure.travis-ci.org/injekt/slop.png)](http://travis-ci.org/injekt/slop)
+
 Installation
 ------------
 
@@ -27,7 +29,7 @@ opts = Slop.parse do
   banner "ruby foo.rb [options]\n"
   on :name=, 'Your name'
   on :p, :password, 'Your password', :argument => :optional
-  on :v :verbose, 'Enable verbose mode'
+  on :v, :verbose, 'Enable verbose mode'
 end
 
 # if ARGV is `--name Lee -v`
@@ -130,4 +132,4 @@ opts = Slop.parse do
 end
 
 opts.to_hash #=> { :name => 'lee', :age => 105 }
-```
+```

data/lib/slop.rb

@@ -4,7 +4,7 @@ require 'slop/commands'
 class Slop
   include Enumerable
 
-  VERSION = '3.0.4'
+  VERSION = '3.1.0'
 
   # The main Error class, all Exception classes inherit from this class.
   class Error < StandardError; end
@@ -89,7 +89,7 @@ class Slop
     # Returns a new instance of Slop.
     def optspec(string, config = {})
       config[:banner], optspec = string.split(/^--+$/, 2) if string[/^--+$/]
-      lines = string.split("\n").reject(&:empty?)
+      lines = optspec.split("\n").reject(&:empty?)
       opts  = Slop.new(config)
 
       lines.each do |line|
@@ -97,7 +97,7 @@ class Slop
         short, long = opt.split(',').map { |s| s.sub(/\A--?/, '') }
         opt = opts.on(short, long, description)
 
-        if long && long[-1] == ?$
+        if long && long.end_with?('=')
           long.sub!(/\=$/, '')
           opt.config[:argument] = true
         end
@@ -154,6 +154,13 @@ class Slop
     end
   end
 
+  # Is strict mode enabled?
+  #
+  # Returns true if strict mode is enabled, false otherwise.
+  def strict?
+    config[:strict]
+  end
+
   # Set the banner.
   #
   # banner - The String to set the banner.
@@ -260,7 +267,7 @@ class Slop
   # with a ? character it will instead call super().
   def method_missing(method, *args, &block)
     meth = method.to_s
-    if meth[-1] == ??
+    if meth.end_with?('?')
       present?(meth.chop)
     else
       super
@@ -272,7 +279,7 @@ class Slop
   # Returns true if this option key exists in our list of options.
   def respond_to?(method)
     method = method.to_s
-    if method[-1] == ?? && options.any? { |o| o.key == method.chop }
+    if method.end_with?('?') && options.any? { |o| o.key == method.chop }
       true
     else
       super
@@ -325,7 +332,11 @@ class Slop
   #
   # text - The String text to print.
   def separator(text)
-    @separators[options.size] = text
+    if @separators[options.size]
+      @separators[options.size] << "\n#{text}"
+    else
+      @separators[options.size] = text
+    end
   end
 
   # Print a handy Slop help string.
@@ -363,17 +374,17 @@ class Slop
       return items
     end
 
-    items.each_with_index { |item, index|
+    items.each_with_index do |item, index|
       @trash << index && break if item == '--'
       autocreate(items, index) if config[:autocreate]
       process_item(items, index, &block) unless @trash.include?(index)
-    }
-    items.reject!.with_index { |item, index| delete && @trash.include?(index) }
+    end
+    items.reject!.with_index { |item, index| @trash.include?(index) } if delete
 
-    required_options = options.select { |opt| opt.required? && opt.count < 1 }
-    if required_options.any?
+    missing_options = options.select { |opt| opt.required? && opt.count < 1 }
+    if missing_options.any?
       raise MissingOptionError,
-        "Missing required option(s): #{required_options.map(&:key).join(', ')}"
+      "Missing required option(s): #{missing_options.map(&:key).join(', ')}"
     end
 
     if @unknown_options.any?
@@ -397,10 +408,10 @@ class Slop
   # Returns nothing.
   def process_item(items, index, &block)
     item = items[index]
-    option, argument = extract_option(item) if item[0, 1] == '-'
+    option, argument = extract_option(item) if item.start_with?('-')
 
     if option
-      option.count += 1 unless item[0, 5] == '--no-'
+      option.count += 1 unless item.start_with?('--no-')
       @trash << index
       @triggered_options << option
 
@@ -426,7 +437,7 @@ class Slop
         option.call(nil)
       end
     else
-      @unknown_options << item if config[:strict] && item =~ /\A--?/
+      @unknown_options << item if strict? && item =~ /\A--?/
       block.call(item) if block && !@trash.include?(index)
     end
   end
@@ -441,7 +452,7 @@ class Slop
   # Returns nothing.
   def execute_option(option, argument, index, item = nil)
     if !option
-      if config[:multiple_switches] && config[:strict]
+      if config[:multiple_switches] && strict?
         raise InvalidOptionError, "Unknown option -#{item}"
       end
       return
@@ -482,6 +493,7 @@ class Slop
   def extract_option(flag)
     option = fetch_option(flag)
     option ||= fetch_option(flag.downcase) if config[:ignore_case]
+    option ||= fetch_option(flag.gsub(/([^-])-/, '\1_'))
 
     unless option
       case flag
@@ -506,7 +518,7 @@ class Slop
       argument = items[index + 1]
       option.config[:argument] = (argument && argument !~ /\A--?/)
       option.config[:autocreated] = true
-      @options << option
+      options << option
     end
   end
 
@@ -538,7 +550,7 @@ class Slop
   def extract_short_flag(objects, config)
     flag = clean(objects.first)
 
-    if flag.size == 2 && flag[-1, 1] == '='
+    if flag.size == 2 && flag.end_with?('=')
       config[:argument] ||= true
       flag.chop!
     end
@@ -556,8 +568,8 @@ class Slop
   def extract_long_flag(objects, config)
     flag = objects.first.to_s
     if flag =~ /\A(?:--?)?[a-zA-Z][a-zA-Z0-9_-]+\=?\??\z/
-      config[:argument] ||= true if flag[-1, 1] == '='
-      config[:optional_argument] = true if flag[-2, 2] == '=?'
+      config[:argument] ||= true if flag.end_with?('=')
+      config[:optional_argument] = true if flag.end_with?('=?')
       objects.shift
       clean(flag).sub(/\=\??\z/, '')
     end

data/lib/slop/commands.rb

@@ -12,6 +12,27 @@ class Slop
     #
     # config - An optional configuration Hash.
     # block  - Optional block used to define commands.
+    #
+    # Examples:
+    #
+    #   commands = Slop::Commands.new do
+    #     on :new do
+    #       on '-o', '--outdir=', 'The output directory'
+    #       on '-v', '--verbose', 'Enable verbose mode'
+    #     end
+    #
+    #     on :generate do
+    #       on '--assets', 'Generate assets', :default => true
+    #     end
+    #
+    #     global do
+    #       on '-D', '--debug', 'Enable debug mode', :default => false
+    #     end
+    #   end
+    #
+    #   commands[:new].class #=> Slop
+    #   commands.parse
+    #
     def initialize(config = {}, &block)
       @config = config
       @commands = {}

data/lib/slop/option.rb

@@ -39,13 +39,12 @@ class Slop
       @config = DEFAULT_OPTIONS.merge(config)
       @count = 0
       @callback = block_given? ? block : config[:callback]
-      @value = nil
 
       @types = {
         :string  => proc { |v| v.to_s },
         :symbol  => proc { |v| v.to_sym },
-        :integer => proc { |v| v.to_s.to_i },
-        :float   => proc { |v| v.to_f },
+        :integer => proc { |v| value_to_integer(v) },
+        :float   => proc { |v| value_to_float(v) },
         :array   => proc { |v| v.split(@config[:delimiter], @config[:limit]) },
         :range   => proc { |v| value_to_range(v) }
       }
@@ -129,6 +128,40 @@ class Slop
 
     private
 
+    # Convert an object to an Integer if possible.
+    #
+    # value - The Object we want to convert to an integer.
+    #
+    # Returns the Integer value if possible to convert, else a zero.
+    def value_to_integer(value)
+      if @slop.strict?
+        begin
+          Integer(value.to_s, 10)
+        rescue ArgumentError
+          raise InvalidArgumentError, "#{value} could not be coerced into Integer"
+        end
+      else
+        value.to_s.to_i
+      end
+    end
+
+    # Convert an object to a Float if possible.
+    #
+    # value - The Object we want to convert to a float.
+    #
+    # Returns the Float value if possible to convert, else a zero.
+    def value_to_float(value)
+      if @slop.strict?
+        begin
+          Float(value.to_s)
+        rescue ArgumentError
+          raise InvalidArgumentError, "#{value} could not be coerced into Float"
+        end
+      else
+        value.to_s.to_f
+      end
+    end
+
     # Convert an object to a Range if possible.
     #
     # value - The Object we want to convert to a range.
@@ -141,7 +174,7 @@ class Slop
       when /\A(-?\d+?)(\.\.\.?|-|,)(-?\d+)\z/
         Range.new($1.to_i, $3.to_i, $2 == '...')
       else
-        if @slop.config[:strict]
+        if @slop.strict?
           raise InvalidArgumentError, "#{value} could not be coerced into Range"
         else
           value
@@ -150,4 +183,4 @@ class Slop
     end
 
   end
-end
+end

data/slop.gemspec

@@ -1,11 +1,14 @@
 Gem::Specification.new do |s|
-  s.name = 'slop'
-  s.version = '3.0.4'
-  s.summary = 'Option gathering made easy'
+  s.name        = 'slop'
+  s.version     = '3.1.0'
+  s.summary     = 'Option gathering made easy'
   s.description = 'A simple DSL for gathering options and parsing the command line'
-  s.author = 'Lee Jarvis'
-  s.email = 'lee@jarvis.co'
-  s.homepage = 'http://github.com/injekt/slop'
-  s.files      = `git ls-files`.split("\n")
-  s.test_files = `git ls-files -- test/*`.split("\n")
+  s.author      = 'Lee Jarvis'
+  s.email       = 'lee@jarvis.co'
+  s.homepage    = 'http://github.com/injekt/slop'
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- test/*`.split("\n")
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'minitest'
 end

data/test/option_test.rb

@@ -56,6 +56,14 @@ class OptionTest < TestCase
     opts.on :f=, :as => Integer
     opts.parse %w'-f 1'
     assert_equal 1, opts[:f]
+    
+    opts = Slop.new(:strict => true) { on :r=, :as => Integer }
+    assert_raises(Slop::InvalidArgumentError) { opts.parse %w/-r abc/ }
+  end
+
+  test "float type cast" do
+    opts = Slop.new(:strict => true) { on :r=, :as => Float }
+    assert_raises(Slop::InvalidArgumentError) { opts.parse %w/-r abc/ }
   end
 
   test "symbol type cast" do
@@ -115,4 +123,4 @@ class OptionTest < TestCase
     slop.on :foo, :help => '    -f, --foo  SOMETHING FOOEY'
     assert_equal '    -f, --foo  SOMETHING FOOEY', slop.fetch_option(:foo).help
   end
-end
+end

data/test/slop_test.rb

@@ -256,6 +256,13 @@ class SlopTest < TestCase
     assert_equal 'bar', opts[:foo]
   end
 
+  test "supporting dash" do
+    opts = Slop.new { on :foo_bar= }
+    opts.parse %w' --foo-bar baz '
+    assert_equal 'baz', opts[:foo_bar]
+    assert opts.foo_bar?
+  end
+
   test "parsing an optspec and building options" do
     optspec = <<-SPEC
     ruby foo.rb [options]
@@ -284,9 +291,10 @@ class SlopTest < TestCase
     opts = Slop.new do
       on :foo
       separator "hello"
+      separator "world"
       on :bar
     end
-    assert_equal "        --foo      \nhello\n        --bar      ", opts.help
+    assert_equal "        --foo      \nhello\nworld\n        --bar      ", opts.help
   end
 
   test "printing help with :help => true" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slop
 version: !ruby/object:Gem::Version
-  version: 3.0.4
+  version: 3.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,30 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-31 00:00:00.000000000 Z
-dependencies: []
+date: 2012-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70221805243820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70221805243820
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70221805243060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70221805243060
 description: A simple DSL for gathering options and parsing the command line
 email: lee@jarvis.co
 executables: []
@@ -18,7 +40,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - CHANGES.md
+- Gemfile
 - LICENSE
 - README.md
 - Rakefile
@@ -42,12 +66,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2177478579712084864
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2177478579712084864
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11