slop 4.7.0 → 4.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 125a7e982b88caf3675166359579515c0af86540002d463042c336c45de8f310
-  data.tar.gz: a0518f68ab2a02cb7cdcdc18fbf0fb9134eac55dc903b1486fa569e66b15a18a
+  metadata.gz: c7b0c61e7c1636499757933c40267cb03c8762eeddc928ed49859de31eae21ab
+  data.tar.gz: a3dcbf06cb7af2ab4edac0664de185553781a59137fdf8602986ef92cb86d3a9
 SHA512:
-  metadata.gz: 463bd12f9ab37a1f27ebca2bdb98954d69f3160bb64d6b8d813a319f66bde91f07c9002ebfd5267277fbbe87bfb20dc50faa0b74e7478ffe3e1acad049dd765e
-  data.tar.gz: 0c5fa72e533dbdf3ff4bfc1f1f5c7c0944aa4e8f1afc41b41ffe7b8c29807be11b111d5f2c218a3f68034dc65243ea527cad4f0a27af56a5fefddce6e20550ba
+  metadata.gz: a4a7a0c057d34ef83972cf56ccda260af5b349adc0c91922898cee4d2b7841d6e5bc8a31b1a83477a2b0404853de053250a34de2e27a4a8d07657bd157faa703
+  data.tar.gz: 96d2291b6b6504aceb7485f79ae3f035fdfa3b8a0aa8a7c84fb41e620b30f6ff5e8903b6c1c57e00cd855ea1fe1c54fac0629fde8a56cde5c816927637d4fa20

data/.travis.yml

@@ -13,12 +13,17 @@ rvm:
   - 2.1
   - 2.2
   - 2.3.4
-  - 2.4.1
-  - 2.5.3
-  - 2.6.0
-  - jruby-9.2.5.0
+  - 2.4.10
+  - 2.5.9
+  - 2.6.7
+  - 2.7.3
+  - 3.0.1
+  - jruby-9.2.17.0
   - jruby-head
   - ruby-head
+  - truffleruby-head
+jdk:
+  - openjdk8
 notifications:
   email:
     on_success: change

data/CHANGELOG.md

@@ -1,12 +1,56 @@
 Changelog
 =========
 
+v4.9.1 (2021-05-28)
+-------------------
+
+Bug fixes:
+  * Fixed a bug where `flag=arg` syntax would raise an error when an
+    empty value was passed. [#266](https://github.com/leejarvis/slop/issues/266)
+
+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)
 

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
 ```
@@ -135,9 +135,11 @@ opts = Slop.parse do |o|
   o.array '--files', 'a list of files', delimiter: ','
 end
 
-# both of these will return o[:files] as ["foo.txt", "bar.rb"]:
+# Both of these will return o[:files] as ["foo.txt", "bar.rb"]:
 # --files foo.txt,bar.rb
 # --files foo.txt --files bar.rb
+# This will return o[:files] as []:
+# --files ""
 ```
 
 If you want to disable the built-in string-splitting, set the delimiter to
@@ -275,87 +277,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).
-
-Upgrading from version 3
-------------------------
-
-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`
-
-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 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. 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.7.0'
+  VERSION = '4.9.1'
 
   # 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/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,7 +52,7 @@ 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
@@ -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,8 +52,7 @@ module Slop
 
         # support `foo=bar`
         orig_flag = flag.dup
-        orig_arg = arg
-        if match = flag.match(/([^=]+)=([^=]+)/)
+        if match = flag.match(/([^=]+)=([^=]*)/)
           flag, arg = match.captures
         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

@@ -70,6 +70,17 @@ describe Slop::Options do
 
       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
@@ -121,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

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'shellwords'
 
 describe Slop::Parser do
   before do
@@ -28,6 +29,15 @@ describe Slop::Parser do
     assert_equal %w(=), @result.args
   end
 
+  it "parses flag=''" do
+    @options.string "--str"
+    @options.array "--arr", default: ["array"]
+    @result.parser.parse %(--str="" --arr="").shellsplit
+
+    assert_equal "", @result[:str]
+    assert_equal [], @result[:arr]
+  end
+
   it "parses arg with leading -" do
     @options.string "-t", "--text"
     @result.parser.parse %w(--name=bob --text --sometext)

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.7.0
+  version: 4.9.1
 platform: ruby
 authors:
 - Lee Jarvis
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-29 00:00:00.000000000 Z
+date: 2021-05-28 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.7.6
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Simple Lightweight Option Parsing
 test_files: