slop 4.6.2 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2ebf99ce79c4681f07967df62008038b3b3ef878
-  data.tar.gz: e074639079cede3024fc00eac71218a744427678
+SHA256:
+  metadata.gz: 125a7e982b88caf3675166359579515c0af86540002d463042c336c45de8f310
+  data.tar.gz: a0518f68ab2a02cb7cdcdc18fbf0fb9134eac55dc903b1486fa569e66b15a18a
 SHA512:
-  metadata.gz: 28ea608999bd09c8c02a43d9f67d571590dfd8742d3dd6712b5a67d3259d80273cfe3e434285dba0b6c524481d38de2fb2db599c4cab8d52d080088ace093cfb
-  data.tar.gz: 2cbedaf601a63a4a5ae57e46ea832827c54ebde7c69319f8313c034f89b0482af0f767fd6a4f9adbcfd5834ca31d7f6a087e4e60240399cbe96a19a3019a6380
+  metadata.gz: 463bd12f9ab37a1f27ebca2bdb98954d69f3160bb64d6b8d813a319f66bde91f07c9002ebfd5267277fbbe87bfb20dc50faa0b74e7478ffe3e1acad049dd765e
+  data.tar.gz: 0c5fa72e533dbdf3ff4bfc1f1f5c7c0944aa4e8f1afc41b41ffe7b8c29807be11b111d5f2c218a3f68034dc65243ea527cad4f0a27af56a5fefddce6e20550ba

data/.travis.yml

@@ -1,13 +1,22 @@
 cache: bundler
 before_install:
-  - gem install bundler
+  - |
+    export RVM_CURRENT=`rvm current|cut -c6-8`
+    if [ "${RVM_CURRENT}" = "2.0" ] || \
+       [ "${RVM_CURRENT}" = "2.1" ] || \
+       [ "${RVM_CURRENT}" = "2.2" ]; then
+      gem install bundler -v '< 2'
+    fi
+
 rvm:
   - 2.0.0
   - 2.1
   - 2.2
   - 2.3.4
   - 2.4.1
-  - jruby-9.1.13.0
+  - 2.5.3
+  - 2.6.0
+  - jruby-9.2.5.0
   - jruby-head
   - ruby-head
 notifications:

data/CHANGELOG.md

@@ -1,31 +1,42 @@
 Changelog
 =========
 
+v4.7.0 (2019-06-29)
+-------------------
+
+Features:
+  * Add `Slop::Result#fetch`. It returns the value of given option, or raises an error if given option is not present. [#232](https://github.com/leejarvis/slop/pull/232) ([Giovanni Benussi](https://github.com/giovannibenussi))
+  * Adding a separator without passing any arguments now creates a separator with the empty string. [#238](https://github.com/leejarvis/slop/pull/238) ([Teemu Matilainen](https://github.com/tmatilai))
+Bug fixes
+  * Ensure non-string option types have their flags consumed properly [#241] (Sutou Kouhei)
+
+
 v4.6.2 (2018-03-12)
+-------------------
 
 Bug fixes/Enhancements
-  * Fix equals character (=) being parsed incorrectly in some cases. #226
+  * Fix equals character (=) being parsed incorrectly in some cases. [#226](https://github.com/leejarvis/slop/issues/226)
 
 v4.6.1 (2017-11-20)
 -------------------
 
 Bug fixes/Enhancements
-  * Fix separator so it doesn't mutate user data. #223 (Marc-André Lafortune)
+  * Fix separator so it doesn't mutate user data. [#223](https://github.com/leejarvis/slop/issues/223) (Marc-André Lafortune)
   * Add additional tests for `Options#separator` and fix issue where
-    the last separator was ignored. #222
+    the last separator was ignored. [#222](https://github.com/leejarvis/slop/issues/222)
 
 v4.6.0 (2017-10-06)
 -------------------
 
 Features
-  * Add support for required options. #218 (William Woodruff)
+  * Add support for required options. [#218](https://github.com/leejarvis/slop/issues/218) (William Woodruff)
 
 v4.5.0 (2017-05-22)
 -------------------
 
 Features:
   * Added config option to avoid translating flags-with-dashes into
-  underscores. #206 (@lbriais)
+  underscores. [#206](https://github.com/leejarvis/slop/issues/206) (@lbriais)
 
 v4.4.3 (2017-05-02)
 -------------------
@@ -37,73 +48,73 @@ v4.4.2 (2017-04-29)
 -------------------
 
 Bug fixes:
-  * Fix support for parsing -x5 or -nfoo. #199
-  * Fix removing arguments after `--`. #194
+  * Fix support for parsing -x5 or -nfoo. [#199](https://github.com/leejarvis/slop/issues/199)
+  * Fix removing arguments after `--`. [#194](https://github.com/leejarvis/slop/issues/194)
 
 v4.4.1 (2016-08-21)
 -------------------
 
 Bug fixes:
-  * Handle bad constant names in `Slop.option_defined?`. #198
+  * Handle bad constant names in `Slop.option_defined?`. [#198](https://github.com/leejarvis/slop/issues/198)
     (Ellen Marie Dash)
 
 v4.4.0 (2016-08-15)
 -------------------
 
 Features
-  * Support parsing arguments prefixed with dashes. #192 (Andrew Clemons)
+  * Support parsing arguments prefixed with dashes. [#192](https://github.com/leejarvis/slop/issues/192) (Andrew Clemons)
 
 Bug fixes:
-  * Retain sort order inside tail sort. #193 (Caio Chassot)
+  * Retain sort order inside tail sort. [#193](https://github.com/leejarvis/slop/issues/193) (Caio Chassot)
 
 v4.3.0 (2016-03-19)
 -------------------
 
 Features
-  * Allow disabling array delimiter. #189 (Mike Pastore)
-  * Allow passing custom banner as config. #191 (Philip Rees)
+  * Allow disabling array delimiter. [#189](https://github.com/leejarvis/slop/issues/189) (Mike Pastore)
+  * Allow passing custom banner as config. [#191](https://github.com/leejarvis/slop/issues/191) (Philip Rees)
 
 v4.2.1 (2015-11-25)
 -------------------
 
 Features:
-  * Better handling of option names with multiple words. #169 (Tim Rogers)
+  * Better handling of option names with multiple words. [#169](https://github.com/leejarvis/slop/issues/169) (Tim Rogers)
 
 Minor enhancements:
-  * add ARGF notes to Arguments (README). #173 (Rick Hull)
+  * add ARGF notes to Arguments (README). [#173](https://github.com/leejarvis/slop/issues/173) (Rick Hull)
 
 Bug fixes:
-  * Fix arguments removed with option arguments. #182 (Naoki Mizuno)
+  * Fix arguments removed with option arguments. [#182](https://github.com/leejarvis/slop/issues/182) (Naoki Mizuno)
   * Fix bug where true is passed to BoolOption block regardless
-    of --no- prefix. #184 (Ben Brady)
-  * only raise MissingArgument if not `default_value`. #163 (Ben Brady)
+    of --no- prefix. [#184](https://github.com/leejarvis/slop/issues/184) (Ben Brady)
+  * only raise MissingArgument if not `default_value`. [#163](https://github.com/leejarvis/slop/issues/163) (Ben Brady)
 
 v4.2.0 (2015-04-18)
 -------------------
 
 Features:
-  * Support for Regexp option type #167 (Laurent Arnoud)
+  * Support for Regexp option type [#167](https://github.com/leejarvis/slop/issues/167) (Laurent Arnoud)
   * Support prefixed `--no-` for explicitly setting boolean options
-    to `false` #168
-  * Better handling of flags with multiple words #169 (Tim Rogers)
+    to `false` [#168](https://github.com/leejarvis/slop/issues/168)
+  * Better handling of flags with multiple words [#169](https://github.com/leejarvis/slop/issues/169) (Tim Rogers)
 
 v4.1.0 (2015-04-18)
 -------------------
 
 Features:
-  * Support for FloatOption #156 (Rick Hull)
+  * Support for FloatOption [#156](https://github.com/leejarvis/slop/issues/156) (Rick Hull)
   * Support for `limit` config to ArrayOption.
   * Support for `tail` config to add options to the bottom of
     the help text.
-  * Add explicit setter (#[]=) to Result class. #162
+  * Add explicit setter (#[]=) to Result class. [#162](https://github.com/leejarvis/slop/issues/162)
   * Implement flag gettings for UnknownOption and MissingArgument
-    error classes. #165 (sigurdsvela)
+    error classes. [#165](https://github.com/leejarvis/slop/issues/165) (sigurdsvela)
 
 Minor enhancements:
   * Reset parser every time `parse` is called.
 
 Bug fixes:
-  * Remove "--" from unprocessed arguments #157 (David Rodríguez).
+  * Remove "--" from unprocessed arguments [#157](https://github.com/leejarvis/slop/issues/157) (David Rodríguez).
 
 v4.0.0 (2014-12-27)
 -------------------

data/README.md

@@ -276,16 +276,14 @@ Commands
 --------
 
 As of version 4, Slop does not have built in support for git-style subcommands.
-You can use version 3 of Slop (see `v3` branch). I also expect there to be some
-external libraries released soon that wrap around Slop to provide support for
-this feature. I'll update this document when that happens.
+You can use version 3 of Slop (see `v3` branch).
 
 Upgrading from version 3
 ------------------------
 
-Slop v4 is completely non-backwards compatible. The code has been rewritten
-from the ground up. If you're already using version 3 you *have* to update
-your code to use version 4. Here's an overview of the more fundamental changes:
+Slop v4 is not backwards compatible. The code has been completely rewritten.
+If you're already using version 3 you *have* to update your code to use version 4.
+Here's an overview of the large changes:
 
 #### No more `instance_eval`
 
@@ -327,22 +325,22 @@ See the custom types section of the document.
 
 #### No more trailing `=`
 
-Instead, the "does this option expect an argument" question is answered by
+Instead, the "does this option expect an argument?" question is answered by
 the option type (i.e `on` and `bool` options do not expect arguments, all
-others do. They handle type conversion, too.
+others do). They handle type conversion, too.
 
 #### Hyphens are required
 
 This was a hard decision to make, but you must provide prefixed hyphens when
-declaring your flags. This makes the underlying code much nicer and much less
-ambiguous, which leads to less error prone code. It also means you can easily
-support single hyphen prefix for a long flag, i.e `-hostname` which you
-could not do before. It also provides a hidden feature, which is infinity flag
-aliases: `o.string '-f', '-x', '--foo', '--bar', 'this is insane'`
+declaring your flags. This improves the implementation nicer and makes things
+much less ambiguous, which leads to less error prone code. It also means you
+can easily support single hyphen prefix for a long flag, i.e `-hostname` which
+you could not do before. It also means you can provide infinite flag aliases:
+`o.string '-f', '-x', '--foo', '--bar', 'this is insane'`
 
 #### Strict is now on by default
 
-v3 had a `strict` option. v4 has no such option, and to suppress errors you can
+v3 had a `strict` option. v4 has no such option. To suppress errors you can
 instead provide the `suppress_errors: true` option to Slop.
 
 #### No more parse!

data/lib/slop.rb

@@ -6,7 +6,7 @@ require 'slop/types'
 require 'slop/error'
 
 module Slop
-  VERSION = '4.6.2'
+  VERSION = '4.7.0'
 
   # Parse an array of options (defaults to ARGV). Accepts an
   # optional hash of configuration options and block.

data/lib/slop/error.rb

@@ -22,8 +22,9 @@ module Slop
     end
   end
 
-  # Raised when an unknown option is parsed. Suppress
-  # with the `suppress_errors` config option.
+  # Raised when an unknown option is parsed or when trying to fetch an
+  # unexisting option via `Slop::Result#fetch`.
+  # Suppress with the `suppress_errors` config option.
   class UnknownOption < Error
     attr_reader :flag
 

data/lib/slop/options.rb

@@ -59,7 +59,7 @@ module Slop
 
     # Add a separator between options. Used when displaying
     # the help text.
-    def separator(string)
+    def separator(string = "")
       if separators[options.size]
         separators[-1] += "\n#{string}"
       else

data/lib/slop/parser.rb

@@ -64,7 +64,7 @@ module Slop
           if opt.expects_argument?
 
             # if we consumed the argument, remove the next pair
-            if orig_arg == opt.value.to_s
+            if consume_next_argument?(orig_flag)
               pairs.delete_at(idx + 1)
             end
 
@@ -106,6 +106,13 @@ module Slop
 
     private
 
+    def consume_next_argument?(flag)
+      return false if flag.include?("=")
+      return true if flag.start_with?("--")
+      return true if /\A-[a-zA-Z]\z/ === flag
+      false
+    end
+
     # We've found an option, process and return it
     def process(option, arg)
       option.ensure_call(arg)

data/lib/slop/result.rb

@@ -14,12 +14,23 @@ module Slop
       @options = parser.options
     end
 
-    # Returns an options value, nil if the option does not exist.
+    # Returns an option's value, nil if the option does not exist.
     def [](flag)
       (o = option(flag)) && o.value
     end
     alias get []
 
+    # Returns an option's value, raises UnknownOption if the option does not exist.
+    def fetch(flag)
+      o = option(flag)
+      if o.nil?
+        cleaned_key = clean_key(flag)
+        raise UnknownOption.new("option not found: '#{cleaned_key}'", "#{cleaned_key}")
+      else
+        o.value
+      end
+    end
+
     # Set the value for an option. Raises an ArgumentError if the option
     # does not exist.
     def []=(flag, value)
@@ -33,13 +44,8 @@ module Slop
 
     # Returns an Option if it exists. Ignores any prefixed hyphens.
     def option(flag)
-      cleaned = -> (f) do
-        key = f.to_s.sub(/\A--?/, '')
-        key = key.tr '-', '_' if parser.config[:underscore_flags]
-        key.to_sym
-      end
       options.find do |o|
-        o.flags.any? { |f| cleaned.(f) == cleaned.(flag) }
+        o.flags.any? { |f| clean_key(f) == clean_key(flag) }
       end
     end
 
@@ -90,5 +96,13 @@ module Slop
     def to_s(**opts)
       options.to_s(**opts)
     end
+
+    private
+
+    def clean_key(key)
+      key = key.to_s.sub(/\A--?/, '')
+      key = key.tr '-', '_' if parser.config[:underscore_flags]
+      key.to_sym
+    end
   end
 end

data/test/options_test.rb

@@ -64,6 +64,12 @@ describe Slop::Options do
       @options.separator("foo".freeze)
       @options.separator("bar".freeze)
     end
+
+    it "defaults to empty string" do
+      @options.separator
+
+      assert_equal [""], @options.separators
+    end
   end
 
   describe "#method_missing" do

data/test/parser_test.rb

@@ -35,6 +35,12 @@ describe Slop::Parser do
     assert_equal "--sometext", @result[:text]
   end
 
+  it "parses regexp arg with leading -" do
+    @options.regexp "--pattern"
+    @result.parser.parse %w(--pattern -x)
+    assert_equal(/-x/, @result[:pattern])
+  end
+
   it "parses negative integer" do
     @options.integer "-p", "--port"
     @result.parser.parse %w(--name=bob --port -123)

data/test/result_test.rb

@@ -62,6 +62,31 @@ describe Slop::Result do
     end
   end
 
+  describe "#fetch" do
+    it "returns an options value" do
+      assert_equal "lee", @result.fetch("--name")
+    end
+
+    it "raises Slop::UnknownOption when an option does not exists" do
+      e = assert_raises(Slop::UnknownOption) { @result.fetch("--unexisting") }
+      assert_equal "option not found: 'unexisting'", e.message
+    end
+
+    it "returns the default value of an option when a value is not provided" do
+      @options.string("--foo", default: "bar")
+      @result.parser.parse %w(--foo)
+
+      assert_equal 'bar', @result.fetch('foo')
+    end
+
+    it "returns nil when an option is not provided and it does not have a default value" do
+      @options.string("--hello")
+      @result.parser.parse %w()
+
+      assert_nil @result.fetch('hello')
+    end
+  end
+
   describe "#[]=" do
     it "sets an options value" do
       assert_equal "lee", @result["name"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slop
 version: !ruby/object:Gem::Version
-  version: 4.6.2
+  version: 4.7.0
 platform: ruby
 authors:
 - Lee Jarvis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-12 00:00:00.000000000 Z
+date: 2019-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -87,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Simple Lightweight Option Parsing