slop 3.6.0 → 4.0.0

data/test/options_test.rb

@@ -0,0 +1,79 @@
+require 'test_helper'
+
+describe Slop::Options do
+  before do
+    @options = Slop::Options.new
+  end
+
+  describe "#on" do
+    it "defaults to null type" do
+      assert_kind_of Slop::NullOption, @options.on("--foo")
+    end
+
+    it "accepts custom types" do
+      module Slop; class FooOption < Option; end; end
+      assert_kind_of Slop::FooOption, @options.on("--foo", type: :foo)
+    end
+
+    it "adds multiple flags" do
+      option = @options.on("-f", "-F", "--foo")
+      assert_equal %w(-f -F --foo), option.flags
+    end
+
+    it "accepts a trailing description" do
+      option = @options.on("--foo", "fooey")
+      assert_equal "fooey", option.desc
+    end
+
+    it "adds the option" do
+      option = @options.on("--foo")
+      assert_equal [option], @options.to_a
+    end
+
+    it "raises an error when a duplicate flag is used" do
+      @options.on("--foo")
+      assert_raises(ArgumentError) { @options.on("--foo") }
+    end
+  end
+
+  describe "#method_missing" do
+    it "uses the method name as an option type" do
+      option = @options.string("--name")
+      assert_kind_of Slop::StringOption, option
+    end
+
+    it "raises if a type doesn't exist" do
+      assert_raises(NoMethodError) { @options.unknown }
+    end
+  end
+
+  describe "#respond_to?" do
+    it "handles custom types" do
+      module Slop; class BarOption < Option; end; end
+      assert @options.respond_to?(:bar)
+    end
+  end
+
+  describe "#to_s" do
+    it "is prefixed with the banner" do
+      assert_match(/^usage/, @options.to_s)
+    end
+
+    it "aligns option strings" do
+      @options.on "-f", "--foo", "fooey"
+      @options.on "-s", "short"
+      assert_match(/^    -f, --foo  fooey/, @options.to_s)
+      assert_match(/^    -s         short/, @options.to_s)
+    end
+
+    it "can use a custom prefix" do
+      @options.on "-f", "--foo"
+      assert_match(/^ -f, --foo/, @options.to_s(prefix: " "))
+    end
+
+    it "ignores options with help: false" do
+      @options.on "-x", "something", help: false
+      refute_match(/something/, @options.to_s)
+    end
+  end
+end

data/test/parser_test.rb

@@ -0,0 +1,65 @@
+require 'test_helper'
+
+describe Slop::Parser do
+  before do
+    @options = Slop::Options.new
+    @verbose = @options.bool "-v", "--verbose"
+    @name    = @options.string "-n", "--name"
+    @unused  = @options.string "--unused"
+    @parser  = Slop::Parser.new(@options)
+    @result  = @parser.parse %w(foo -v --name lee argument)
+  end
+
+  it "ignores everything after --" do
+    @parser.reset.parse %w(-v -- --name lee)
+    assert_equal [@verbose], @parser.used_options
+  end
+
+  it "parses flag=argument" do
+    @options.integer "-p", "--port"
+    @result.parser.reset.parse %w(--name=bob -p=123)
+    assert_equal "bob", @result[:name]
+    assert_equal 123, @result[:port]
+  end
+
+  describe "parsing grouped short flags" do
+    before do
+      @options.bool "-q", "--quiet"
+    end
+
+    it "parses boolean flags" do
+      @result.parser.reset.parse %w(-qv)
+      assert_equal true, @result.quiet?
+      assert_equal true, @result.verbose?
+    end
+
+    it "sends the argument to the last flag" do
+      @result.parser.reset.parse %w(-qvn foo)
+      assert_equal "foo", @result[:name]
+    end
+
+    it "doesn't screw up single hyphen long options" do
+      @options.string "-host"
+      @result.parser.reset.parse %w(-host localhost)
+      assert_equal "localhost", @result[:host]
+    end
+  end
+
+  describe "#used_options" do
+    it "returns all options that were parsed" do
+      assert_equal [@verbose, @name], @parser.used_options
+    end
+  end
+
+  describe "#unused_options" do
+    it "returns all options that were not parsed" do
+      assert_equal [@unused], @parser.unused_options
+    end
+  end
+
+  describe "#arguments" do
+    it "returns all unparsed arguments" do
+      assert_equal %w(foo argument), @parser.arguments
+    end
+  end
+end

data/test/result_test.rb

@@ -0,0 +1,85 @@
+require 'test_helper'
+
+module Slop
+  class ReverseEverythingOption < BoolOption
+    def finish(result)
+      result.used_options.grep(Slop::StringOption).each do |opt|
+        opt.value = opt.value.reverse
+      end
+    end
+  end
+end
+
+describe Slop::Result do
+  before do
+    @options = Slop::Options.new
+    @verbose = @options.bool "-v", "--verbose"
+    @name    = @options.string "--name"
+    @unused  = @options.string "--unused"
+    @result  = @options.parse %w(foo -v --name lee argument)
+  end
+
+  it "increments option count" do
+    # test this here so it's more "full stack"
+    assert_equal 1, @verbose.count
+    @result.parser.reset.parse %w(-v --verbose)
+    assert_equal 2, @verbose.count
+  end
+
+  it "handles default values" do
+    @options.string("--foo", default: "bar")
+    @result.parser.reset.parse %w()
+    assert_equal "bar", @result[:foo]
+  end
+
+  it "handles custom finishing" do
+    @options.string "--foo"
+    @options.reverse_everything "-r"
+    @result.parser.reset.parse %w(-r --name lee --foo bar)
+    assert_equal %w(eel rab), @result.to_hash.values_at(:name, :foo)
+  end
+
+  it "yields arguments to option blocks" do
+    output = nil
+    @options.string("--foo") { |v| output = v }
+    @result.parser.reset.parse %w(--foo bar)
+    assert_equal output, "bar"
+  end
+
+  describe "#[]" do
+    it "returns an options value" do
+      assert_equal "lee", @result["name"]
+      assert_equal "lee", @result[:name]
+      assert_equal "lee", @result["--name"]
+    end
+  end
+
+  describe "#method_missing" do
+    it "checks if options have been used" do
+      assert_equal true, @result.verbose?
+      assert_equal false, @result.unused?
+    end
+  end
+
+  describe "#option" do
+    it "returns an option by flag" do
+      assert_equal @verbose, @result.option("--verbose")
+      assert_equal @verbose, @result.option("-v")
+    end
+
+    it "ignores prefixed hyphens" do
+      assert_equal @verbose, @result.option("verbose")
+      assert_equal @verbose, @result.option("-v")
+    end
+
+    it "returns nil if nothing is found" do
+      assert_equal nil, @result.option("foo")
+    end
+  end
+
+  describe "#to_hash" do
+    it "returns option keys and values" do
+      assert_equal({ verbose: true, name: "lee", unused: nil }, @result.to_hash)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+$VERBOSE = true
+
+require 'slop'
+
+require 'minitest/autorun'
+require 'stringio'

data/test/types_test.rb

@@ -0,0 +1,78 @@
+require 'test_helper'
+
+describe Slop::BoolOption do
+  before do
+    @options = Slop::Options.new
+    @age     = @options.bool "--verbose"
+    @age     = @options.bool "--quiet"
+    @result  = @options.parse %w(--verbose)
+  end
+
+  it "returns true if used" do
+    assert_equal true, @result[:verbose]
+  end
+
+  it "returns false if not used" do
+    assert_equal false, @result[:quiet]
+  end
+end
+
+describe Slop::IntegerOption do
+  before do
+    @options = Slop::Options.new
+    @age     = @options.integer "--age"
+    @result  = @options.parse %w(--age 20)
+  end
+
+  it "returns the value as an integer" do
+    assert_equal 20, @result[:age]
+  end
+
+  it "returns nil for non-numbers by default" do
+    @result.parser.reset.parse %w(--age hello)
+    assert_equal nil, @result[:age]
+  end
+end
+
+describe Slop::ArrayOption do
+  before do
+    @options = Slop::Options.new
+    @files   = @options.array "--files"
+    @delim   = @options.array "-d", delimiter: ":"
+    @result  = @options.parse %w(--files foo.txt,bar.rb)
+  end
+
+  it "defaults to []" do
+    assert_equal [], @result[:d]
+  end
+
+  it "parses comma separated args" do
+    assert_equal %w(foo.txt bar.rb), @result[:files]
+  end
+
+  it "collects multiple option values" do
+    @result.parser.reset.parse %w(--files foo.txt --files bar.rb)
+    assert_equal %w(foo.txt bar.rb), @result[:files]
+  end
+
+  it "can use a custom delimiter" do
+    @result.parser.reset.parse %w(-d foo.txt:bar.rb)
+    assert_equal %w(foo.txt bar.rb), @result[:d]
+  end
+end
+
+describe Slop::NullOption do
+  before do
+    @options = Slop::Options.new
+    @version = @options.null('--version')
+    @result  = @options.parse %w(--version)
+  end
+
+  it 'has a return value of true' do
+    assert_equal true, @result[:version]
+  end
+
+  it 'is not included in to_hash' do
+    assert_equal({}, @result.to_hash)
+  end
+end

metadata

@@ -1,64 +1,70 @@
 --- !ruby/object:Gem::Specification
 name: slop
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Lee Jarvis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-18 00:00:00.000000000 Z
+date: 2014-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 5.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 5.0.0
-description: A simple DSL for gathering options and parsing the command line
+description: A DSL for gathering options and parsing command line flags
 email: ljjarvis@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
-- CHANGES.md
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/slop.rb
-- lib/slop/commands.rb
+- lib/slop/error.rb
 - lib/slop/option.rb
+- lib/slop/options.rb
+- lib/slop/parser.rb
+- lib/slop/result.rb
+- lib/slop/types.rb
 - slop.gemspec
-- test/commands_test.rb
-- test/helper.rb
+- test/error_test.rb
 - test/option_test.rb
-- test/slop_test.rb
+- test/options_test.rb
+- test/parser_test.rb
+- test/result_test.rb
+- test/test_helper.rb
+- test/types_test.rb
 homepage: http://github.com/leejarvis/slop
 licenses:
 - MIT
@@ -69,22 +75,25 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Simple Lightweight Option Parsing
 test_files:
-- test/commands_test.rb
-- test/helper.rb
+- test/error_test.rb
 - test/option_test.rb
-- test/slop_test.rb
+- test/options_test.rb
+- test/parser_test.rb
+- test/result_test.rb
+- test/test_helper.rb
+- test/types_test.rb

data/CHANGES.md

@@ -1,309 +0,0 @@
-3.6.0 (2014-06-18)
-------------------
-
-* Add example of rest arguments usage in the readme file #139
-* Default values on options are printed in the help message #134
-
-3.5.0 (2014-03-12)
-------------------
-
-* Add support for `as: Regexp` #132
-
-3.4.7 (2013-11-14)
-------------------
-
-* Ensure trash is cleared on every parse so you can parse multiple
-  times with the same instance (#130)
-
-3.4.5 (2013-05-14)
-------------------
-
-* Allow specifying long options starting with numbers (#110, Peter Zotov)
-* Ensure short-options still consume trailing arguments, ie `-abc foo`
-  should assign `foo` to the option `c` if it expects an argument (#114).
-
-3.4.4 (2013-03-12)
-------------------
-
-* Disable the run callback when the help option is used and `-h`
-  or `--help` is passed. #106
-* Ensure default `--help` option exits by default (#107, Autumn Perrault).
-
-3.4.3 (2013-01-14)
-------------------
-
-* Ensure `parse!` removes commands and their options.
-
-3.4.2 (2013-01-14)
-------------------
-
-* Expose the Hash commands as public API.
-* Deprecated `Slop.optspec`.
-* Ensure help output prints to stdout, not stderr.
-
-3.4.1 (2013-01-13)
-------------------
-
-* Ensure options replace any existing duplicates
-* Command config options now inherit config options from top level Slop.
-* Command help output now adds command in usage string.
-
-3.4.0 (2013-01-12)
-------------------
-
-* Implement new command system (#95)
-* Deprecate Slop::Commands
-* Ensure 'no-foo' options are not inverted when parsing '--no-foo' (#86)
-* Code refactoring and simplification (Kenichi Kamiya, #84, #85)
-
-3.3.3 (2012-08-29)
-------------------
-
-* Ensure autocreate arguments are not created as options (#77)
-* Ensure options are not swallowed when using short options with argument
-  included (#74)
-
-3.3.2 (2012-06-26)
-------------------
-
-* Ensure multiple options are not executed unless they exist (#70)
-
-3.3.1 (2012-05-31)
-------------------
-
-* Stop multiple switches from trashing arguments (Conrad Irwin, #66)
-
-3.3.0 (2012-05-30)
-------------------
-
-* Fix `:as => :count` when using multiple switches.
-* Ensure range typecast allows negative range values.
-* Ignore nil objects send to #parse instead of choking.
-
-3.2.0 (2012-05-15)
-------------------
-
-* Ensure boolean options appear correctly in `to_hash` output. (#59)
-
-3.1.1 (2012-04-24)
-------------------
-
-* Ensure separators before any options are still being processed (#62)
-
-3.1.0 (2012-04-23)
-------------------
-
-* 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)
-------------------
-
-* Ensure `option=argument` syntax does not consume following arguments (#55).
-
-3.0.3 (2012-01-30)
-------------------
-
-* Ensure options passed after option terminator do not raise an exception
-  (#54, Amon Sha)
-
-3.0.2 (2012-01-27)
-------------------
-
-* Ensure `--option=value` is being evaluated before multiple switches (#52)
-
-3.0.1 (2012-01-27)
-------------------
-
-* Ensure tests run green on 1.8.7
-* Ensure `:argument => :optional` works with `:option=` format.
-* Ruby 1.8.7 compat fix (dont chain Enumerable methods!) (Eric Anderson)
-
-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)
-------------------
-
-* Fix checking of required options (Dominik Honnef)
-
-2.4.1 (2011-12-08)
-------------------
-
-* Ensure optional arguments are returned correctly
-
-2.4.0 (2011-11-26)
-------------------
-
-* Avoid `define_method` for checking an options presence (and caching it) #37
-* Ensure the short option allows an appended `=` for accepting arguments
-* Implement `respond_to?`
-
-2.3.1 (2011-11-11)
-------------------
-
-* Return `nil` for any options using casting which don't expect arguments (#33)
-* Fix parenthesis warning on 1.8.7 (@shevegen)
-* Ensure long argument is a string before attempting to use `#[]` method on it
-
-2.3.0 (2011-11-04)
-------------------
-
-* Allow flags to have suffixed `=` char for options which accept an argument
-
-2.2.0 (2011-11-02)
-------------------
-
-* Support `bup.options` style optspec parsing
-    * http://apenwarr.ca/log/?m=201111
-
-* Allow `:as` to accept a `count` value (Conrad Irwin):
-
-    `on :v, :verbose, :as => :count # -vv; opts[:verbose] #=> 2`
-
-2.1.0 (2011-08-03)
-------------------
-
-* Added `Slop#missing` for returning a list of missing options parsed
-* Allow `Slop#present?` to accept multiple arguments
-* Added `:all_accept_arguments` to Slop configuration options, this saves
-  having to specify that every option takes an argument
-* Added `Slop#to_struct` for building new classes from options
-
-2.0.0 (2011-07-07)
-------------------
-
-* Deprecations:
-  * Removed `Slop::Options#to_hash` continue using `Slop#to_hash` directly.
-    This method also now returns symbols by default instead of strings. If
-    you want strings use `opts.to_hash(false)`
-  * `:multiple_switches` is now enabled by default, to parse `fbar` as the
-    option `f` with value `bar` you must disable `:multiple_switches`
-  * Removed `Slop::Options#to_help` and merged its contents into `Slop#help`
-  * Removed `lib/slop/options.rb` and merged `Slop::Options` into slop.rb
-  * Removed `lib/slop/option.rb` and merged `Slop::Option` into slop.rb
-  * These changes make Slop much easier to vendor in libraries
-* `Slop::Option` now inherits from `Struct.new`
-* Added Slop::Error subclassing from StandardError which all exception
-  classes should inherit from
-* Added Slop::MissingOptionError and `:required` option to Slop::Option.
-  This exception is raised when a mandatory option is not used
-
-1.9.1 (2011-06-16)
-------------------
-
-* Ensure optional items with no arguments still return true when searching
-  for presence
-
-1.9.0 (2011-06-15)
-------------------
-
-* Add command completion and support for an error message when ambiguous
-  commands are used
-* Add command aliases
-* Fix: Ensure parsed elements are removed from original arguments when using
-  `:multiple_switches`
-* Ensure anything after `--` is parsed as an argument and not option even
-  if prefixed with `/--?/`
-* Performance improvements when making many calls to `Slop#option?` for
-  checking an options presence (Rob Gleeson)
-* Ensure `execute` passes command arguments to the block
-* Support for summary and description (Denis Defreyne)
-
-1.8.0 (2011-06-12)
-------------------
-
-* Added `execute` method to Slop for commands. This block will be invoked
-  when a specific command is used. The Slop object will be yielded to the
-  block
-* Allow passing a class name to `on` to be used as an `:as` option. ie:
-  `on :people, 'Some people', Array`
-* Get smart with parsing options optparse style: `on '--name NAME'` and
-  `on 'password [OPTIONAL]'`
-* Feature: `:arguments` setting to enable argument passing for all options
-
-1.7.0 (2011-06-06)
-------------------
-
-* Feature: Autocreate (auto create options at parse time, making assumptions)
-* Feature: When parsing options as arrays, push multiple arguments into a
-  single array
-
-1.6.1 (2011-06-01)
-------------------
-
-* Fix tests and using a temporary Array for ARGV, fixes RubyGems Test issues
-* General cleanup of code
-
-1.6.0 (2011-05-18)
-------------------
-
-* Add `:ignore_case` to Slop options for case insensitive option matching
-* Add `:on_noopts` for triggering an event when the arguments contain no
-  options
-* Add `:unless` to Slop::Option for omitting execution of the Options block
-  when this object exists in the Array of items passed to Slop.new
-* Bugfix: Do not parse negative integers as options. A valid option must
-  start with an alphabet character
-* Bugfix: Allow a Range to accept a negative Integer at either end
-
-1.5.5 (2011-05-03)
-------------------
-
-* Bugfix: only attempt to extract options prefixed with `-`
-
-1.5.4 (2011-05-01)
-------------------
-
-* Bugfix: `parse!` should not remove items with the same value as items used
-  in option arguments. Fixes #22 (Utkarsh Kukreti)
-
-1.5.3 (2011-04-22)
-------------------
-
-* Bugfix: Use integers when fetching array indexes, not strings
-
-1.5.2 (2011-04-17)
-------------------
-
-* Bugfix: Ensure `ARGV` is empty when using the `on_empty` event
-
-1.5.0 (2011-04-15)
-------------------
-
-* Add `Slop#get` as alias to `Slop#[]`
-* Add `Slop#present?` as alias for `Slop#<option>?`
-* Add `Option#count` for monitoring how many times an option is called
-* Add `:io` for using a custom IO object when using the `:help` option
-* Numerous performance tweaks