slop 4.6.2 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2ebf99ce79c4681f07967df62008038b3b3ef878
-  data.tar.gz: e074639079cede3024fc00eac71218a744427678
+SHA256:
+  metadata.gz: a823b880e0feb218800faed1d191258594fb26ab2078fdfd5282df024677fd06
+  data.tar.gz: fe212b6f93ff3548873896606de836842081319c3acbfd99438a15b38539c2a2
 SHA512:
-  metadata.gz: 28ea608999bd09c8c02a43d9f67d571590dfd8742d3dd6712b5a67d3259d80273cfe3e434285dba0b6c524481d38de2fb2db599c4cab8d52d080088ace093cfb
-  data.tar.gz: 2cbedaf601a63a4a5ae57e46ea832827c54ebde7c69319f8313c034f89b0482af0f767fd6a4f9adbcfd5834ca31d7f6a087e4e60240399cbe96a19a3019a6380
+  metadata.gz: 467b52c6de36c7a164739b301ef016efcef5abd62891682e8353f67f63b125bc8238abd853112fb544cdc2391d93dc492446c93a01220a5ef8c908ff2cb95ee1
+  data.tar.gz: 6d027c76c43e84f8dab52bc04236568045c1dff962a58b0df029693b35cf535f03b2d5e4445993964bfcabe3d9093ff6465ba3ebfb399e661cc187388178b059

data/.travis.yml

@@ -1,15 +1,28 @@
 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.4.9
+  - 2.5.7
+  - 2.6.5
+  - 2.7.0
+  - jruby-9.2.16.0
   - jruby-head
   - ruby-head
+  - truffleruby-head
+jdk:
+  - openjdk8
 notifications:
   email:
     on_success: change

data/CHANGELOG.md

@@ -1,31 +1,79 @@
 Changelog
 =========
 
+v4.9.0 (2021-05-11)
+-------------------
+
+Features:
+  * Add SymbolOption [#263](https://github.com/leejarvis/slop/pull/263)
+
+Bug fixes:
+  * Use `+=` over `<<` to handle frozen string literals. [255](https://github.com/leejarvis/slop/pull/255)
+
+v4.8.2 (2020-07-10)
+-------------------
+
+Bug fixes:
+  * Fix bug where separator position was messed up if using `help: false`
+    [#253](https://github.com/leejarvis/slop/issues/253)
+
+v4.8.1 (2020-03-31)
+-------------------
+
+Bug fixes:
+  * Fix keyword argument warning. [#251](https://github.com/leejarvis/slop/pull/251)
+
+
+v4.8.0 (2020-01-17)
+-------------------
+
+Features:
+  * Add support for prefixing integer values with `+` character
+  [#243](https://github.com/leejarvis/slop/pull/243) (Juha Ylitalo)
+  * Add support for parsing floats with scientific notation
+  [#250](https://github.com/leejarvis/slop/pull/250) (Hansuk Hong)
+
+Maintenance:
+  * Add 2.7.0 to CI and fix warnings
+  [#248](https://github.com/leejarvis/slop/pull/248) (Juha Ylitalo, Andrew Kane)
+
+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 +85,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

@@ -3,9 +3,6 @@ Slop
 
 Slop is a simple option parser with an easy to remember syntax and friendly API.
 
-Version 4 of Slop is aimed at Ruby 2.0 or later. Please use
-[Version 3](https://github.com/leejarvis/slop/tree/v3) for Ruby 1.9 support.
-
 [![Build Status](https://travis-ci.org/leejarvis/slop.svg?branch=master)](http://travis-ci.org/leejarvis/slop)
 
 Installation
@@ -21,6 +18,7 @@ opts = Slop.parse do |o|
   o.string '-h', '--host', 'a hostname'
   o.integer '--port', 'custom port', default: 80
   o.string '-l', '--login', required: true
+  o.symbol '-m', '--method', default: :get
   o.bool '-v', '--verbose', 'enable verbose mode'
   o.bool '-q', '--quiet', 'suppress output (quiet mode)'
   o.bool '-c', '--check-ssl-certificate', 'check SSL certificate for host'
@@ -30,15 +28,16 @@ opts = Slop.parse do |o|
   end
 end
 
-ARGV #=> -v --login alice --host 192.168.0.1 --check-ssl-certificate
+ARGV #=> -v --login alice --host 192.168.0.1 -m post --check-ssl-certificate
 
 opts[:host]                 #=> 192.168.0.1
 opts[:login]                #=> alice
+opts[:method]               #=> :post
 opts.verbose?               #=> true
 opts.quiet?                 #=> false
 opts.check_ssl_certificate? #=> true
 
-opts.to_hash  #=> { host: "192.168.0.1", login: "alice", port: 80, verbose: true, quiet: false, check_ssl_certificate: true }
+opts.to_hash  #=> { host: "192.168.0.1", port: 80, login: "alice", method: :post, verbose: true, quiet: false, check_ssl_certificate: true }
 ```
 
 Note that the block we've added to the `--version` flag will be executed
@@ -59,6 +58,7 @@ o.integer #=> Slop::IntegerOption, expects an argument, aliased to IntOption
 o.float   #=> Slop::FloatOption, expects an argument
 o.array   #=> Slop::ArrayOption, expects an argument
 o.regexp  #=> Slop::RegexpOption, expects an argument
+o.symbol  #=> Slop::SymbolOption, expects an argument
 o.null    #=> Slop::NullOption, no argument and ignored from `to_hash`
 o.on      #=> alias for o.null
 ```
@@ -275,89 +275,4 @@ end
 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.
-
-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:
-
-#### No more `instance_eval`
-
-Before:
-
-```ruby
-Slop.parse do
-  on 'v', 'version' do
-    puts VERSION
-  end
-end
-```
-
-After:
-
-```ruby
-Slop.parse do |o|
-  o.on '-v', '--version' do
-    puts VERSION
-  end
-end
-```
-
-#### No more `as` for option types
-
-Instead, the type is declared in the method call. Before:
-
-```ruby
-on 'port=', as: Integer
-```
-
-After:
-
-```ruby
-o.int '--port' # or integer
-```
-
-See the custom types section of the document.
-
-#### No more trailing `=`
-
-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.
-
-#### 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'`
-
-#### Strict is now on by default
-
-v3 had a `strict` option. v4 has no such option, and to suppress errors you can
-instead provide the `suppress_errors: true` option to Slop.
-
-#### No more parse!
-
-Where v3 has both `Slop.parse` and `Slop.parse!`, v4 only has `parse`. The
-former was used to decide whether Slop should or should not mutate the
-original args (usually ARGV). This is almost never what you want, and it
-can lead to confusion. Instead, `Slop::Result` provides an `arguments`
-methods:
-
-```ruby
-opts = Slop.parse do |o|
-  o.string '--hostname', '...'
-end
-
-# ARGV is "hello --hostname foo bar"
-p opts.arguments #=> ["hello", "bar"]
-```
+Slop not longer has built in support for git-style subcommands.

data/lib/slop.rb

@@ -6,7 +6,7 @@ require 'slop/types'
 require 'slop/error'
 
 module Slop
-  VERSION = '4.6.2'
+  VERSION = '4.9.0'
 
   # Parse an array of options (defaults to ARGV). Accepts an
   # optional hash of configuration options and block.
@@ -20,7 +20,7 @@ module Slop
   #
   # Returns a Slop::Result.
   def self.parse(items = ARGV, **config, &block)
-    Options.new(config, &block).parse(items)
+    Options.new(**config, &block).parse(items)
   end
 
   # Example:

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

@@ -24,12 +24,12 @@ module Slop
     # The String banner prefixed to the help string.
     attr_accessor :banner
 
-    def initialize(**config)
+    def initialize(**config, &block)
       @options    = []
       @separators = []
       @banner     = config[:banner].is_a?(String) ? config[:banner] : config.fetch(:banner, "usage: #{$0} [options]")
       @config     = DEFAULT_CONFIG.merge(config)
-      @parser     = Parser.new(self, @config)
+      @parser     = Parser.new(self, **@config)
 
       yield self if block_given?
     end
@@ -52,14 +52,14 @@ module Slop
       desc   = flags.pop unless flags.last.start_with?('-')
       config = self.config.merge(config)
       klass  = Slop.string_to_option_class(config[:type].to_s)
-      option = klass.new(flags, desc, config, &block)
+      option = klass.new(flags, desc, **config, &block)
 
       add_option option
     end
 
     # 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
@@ -82,7 +82,7 @@ module Slop
     def method_missing(name, *args, **config, &block)
       if respond_to_missing?(name)
         config[:type] = name
-        on(*args, config, &block)
+        on(*args, **config, &block)
       else
         super
       end
@@ -102,17 +102,17 @@ module Slop
       str = config[:banner] ? "#{banner}\n" : ""
       len = longest_flag_length
 
-      options.select(&:help?).each_with_index.sort_by{ |o,i| [o.tail, i] }.each do |opt, i|
+      options.select.each_with_index.sort_by{ |o,i| [o.tail, i] }.each do |opt, i|
         # use the index to fetch an associated separator
         if sep = separators[i]
-          str << "#{sep}\n"
+          str += "#{sep}\n"
         end
 
-        str << "#{prefix}#{opt.to_s(offset: len)}\n"
+        str += "#{prefix}#{opt.to_s(offset: len)}\n" if opt.help?
       end
 
       if sep = separators[options.size]
-        str << "#{sep}\n"
+        str += "#{sep}\n"
       end
 
       str

data/lib/slop/parser.rb

@@ -52,7 +52,6 @@ module Slop
 
         # support `foo=bar`
         orig_flag = flag.dup
-        orig_arg = arg
         if match = flag.match(/([^=]+)=([^=]+)/)
           flag, arg = match.captures
         end
@@ -64,7 +63,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 +105,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/lib/slop/types.rb

@@ -6,6 +6,13 @@ module Slop
     end
   end
 
+  # Cast the option argument to a symbol.
+  class SymbolOption < Option
+    def call(value)
+      value.to_sym
+    end
+  end
+
   # Cast the option argument to true or false.
   # Override default_value to default to false instead of nil.
   # This option type does not expect an argument. However, the API
@@ -44,16 +51,17 @@ module Slop
   # Cast the option argument to an Integer.
   class IntegerOption < Option
     def call(value)
-      value =~ /\A-?\d+\z/ && value.to_i
+      value =~ /\A[+-]?\d+\z/ && value.to_i
     end
   end
   IntOption = IntegerOption
 
   # Cast the option argument to a Float.
   class FloatOption < Option
+    FLOAT_STRING_REGEXP = /\A[+-]?(?:0|[1-9]\d*)(?:\.\d*)?(?:[eE][+-]?\d+)?\z/.freeze
+
     def call(value)
-      # TODO: scientific notation, etc.
-      value =~ /\A-?\d*\.*\d+\z/ && value.to_f
+      value =~ FLOAT_STRING_REGEXP && value.to_f
     end
   end
 

data/test/option_test.rb

@@ -1,8 +1,8 @@
 require 'test_helper'
 
 describe Slop::Option do
-  def option(*args)
-    Slop::Option.new(*args)
+  def option(*args, **kwargs, &block)
+    Slop::Option.new(*args, **kwargs, &block)
   end
 
   describe "#flag" do

data/test/options_test.rb

@@ -64,6 +64,23 @@ 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
+
+    it "correctly handles options with `help: false`" do
+      @options.boolean "--opt1"
+      @options.boolean "--opt2", help: false
+      @options.separator "other options"
+      @options.boolean "--opt3", help: false
+      @options.boolean "--opt4"
+
+      _usage, help = @options.to_s.squeeze(" ").split("\n", 2)
+      assert_equal "--opt1 \nother options\n --opt4", help.strip
+    end
   end
 
   describe "#method_missing" do
@@ -115,11 +132,11 @@ describe Slop::Options do
 
   describe "custom banner" do
     it "is prefixed with defined banner" do
-      @options_config = Slop::Options.new({banner: "custom banner"})
+      @options_config = Slop::Options.new(**{banner: "custom banner"})
       assert_match(/^custom banner/, @options_config.to_s)
     end
     it "banner is disabled" do
-      @options_config = Slop::Options.new({banner: false})
+      @options_config = Slop::Options.new(**{banner: false})
       assert_match("", @options_config.to_s)
     end
   end

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"]

data/test/slop_test.rb

@@ -1,6 +1,16 @@
 require "test_helper"
 
 describe Slop do
+  describe ".parse" do
+    it "parses a list of arguments" do
+      result = Slop.parse(%w[--name Lee]) do |o|
+        o.string "--name"
+      end
+
+      assert_equal "Lee", result[:name]
+    end
+  end
+
   describe ".option_defined?" do
     it "handles bad constant names" do
       assert_equal false, Slop.option_defined?("Foo?Bar")

data/test/types_test.rb

@@ -1,5 +1,33 @@
 require 'test_helper'
 
+describe Slop::StringOption do
+  before do
+    @options = Slop::Options.new
+    @age     = @options.string "--name"
+    @minus   = @options.string "--zipcode"
+    @result  = @options.parse %w(--name Foo --zipcode 12345)
+  end
+
+  it "returns the value as a string" do
+    assert_equal "Foo", @result[:name]
+    assert_equal "12345", @result[:zipcode]
+  end
+end
+
+describe Slop::SymbolOption do
+  before do
+    @options = Slop::Options.new
+    @age     = @options.symbol "--name"
+    @minus   = @options.symbol "--zipcode"
+    @result  = @options.parse %w(--name Foo --zipcode 12345)
+  end
+
+  it "returns the value as a symbol" do
+    assert_equal :Foo, @result[:name]
+    assert_equal :'12345', @result[:zipcode]
+  end
+end
+
 describe Slop::BoolOption do
   before do
     @options  = Slop::Options.new
@@ -32,11 +60,15 @@ describe Slop::IntegerOption do
   before do
     @options = Slop::Options.new
     @age     = @options.integer "--age"
-    @result  = @options.parse %w(--age 20)
+    @minus   = @options.integer "--minus"
+    @plus    = @options.integer "--plus"
+    @result  = @options.parse %w(--age 20 --minus -10 --plus +30)
   end
 
   it "returns the value as an integer" do
     assert_equal 20, @result[:age]
+    assert_equal (-10), @result[:minus]
+    assert_equal 30, @result[:plus]
   end
 
   it "returns nil for non-numbers by default" do
@@ -50,11 +82,37 @@ describe Slop::FloatOption do
     @options = Slop::Options.new
     @apr     = @options.float "--apr"
     @apr_value = 2.9
-    @result  = @options.parse %W(--apr #{@apr_value})
+    @minus = @options.float "--minus"
+    @plus = @options.float "--plus"
+    @scientific_notation = @options.float "--scientific-notation"
+    @scientific_notation_value = 4e21
+    @result  = @options.parse %W(--apr #{@apr_value} --minus -6.1 --plus +9.4 --scientific-notation #{@scientific_notation_value})
   end
 
   it "returns the value as a float" do
     assert_equal @apr_value, @result[:apr]
+    assert_equal (-6.1), @result[:minus]
+    assert_equal 9.4, @result[:plus]
+  end
+
+  it "parses scientific notations" do
+    assert_equal @scientific_notation_value, @result[:scientific_notation]
+
+    @scientific_notation_value = 4E21
+    @result  = @options.parse %W(--scientific-notation #{@scientific_notation_value})
+    assert_equal @scientific_notation_value, @result[:scientific_notation]
+
+    @scientific_notation_value = 4.0e21
+    @result  = @options.parse %W(--scientific-notation #{@scientific_notation_value})
+    assert_equal @scientific_notation_value, @result[:scientific_notation]
+
+    @scientific_notation_value = -4e21
+    @result  = @options.parse %W(--scientific-notation #{@scientific_notation_value})
+    assert_equal @scientific_notation_value, @result[:scientific_notation]
+
+    @scientific_notation_value = 4e-21
+    @result  = @options.parse %W(--scientific-notation #{@scientific_notation_value})
+    assert_equal @scientific_notation_value, @result[:scientific_notation]
   end
 
   it "returns nil for non-numbers by default" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slop
 version: !ruby/object:Gem::Version
-  version: 4.6.2
+  version: 4.9.0
 platform: ruby
 authors:
 - Lee Jarvis
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-03-12 00:00:00.000000000 Z
+date: 2021-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -71,7 +71,7 @@ homepage: http://github.com/leejarvis/slop
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -86,9 +86,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Simple Lightweight Option Parsing
 test_files: