slop 4.8.2 → 4.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b79c8ecabc4f59e446e17b38a61381a4711e1da44918d5bfa3c459e3330fa7c5
-  data.tar.gz: 6a5c4c2b6a0624a0f533ea86bc7855774a23d134d581f178d2d6fa476b01da59
+  metadata.gz: db594ae38cd4d8b8d078d3b3854e5dce764f4763107caacc02b0b270c33098d8
+  data.tar.gz: 6e1348ca3f3d642bff87411d33c78b2f3d1b654c11c079a228f327f82648cd5f
 SHA512:
-  metadata.gz: 15ac86c2fe54c3c5dffb8d186e50341febfa6ed858eedae5347a416fc9261159262d68873645c7bb11d1cc2155473f6deb3a8740da2c4fcc1a78f0f477cccfc8
-  data.tar.gz: d1a078ebc9c8ddd2b970e9cc39dcf72fc20b3e67a50abed4bf51a7d22bafe8ae7170c03930bf8d3073f487d167f6f27fe1475b5e5735b4bf2090efa446a0eff5
+  metadata.gz: b578d6d172adf2b9c88d482fe27798d97a821b83ef7ff4f8b6e8ed37d63cd7f7963b9634b9f734e80d744c0fc077f47bc2a08e00feed02af90452c6415383494
+  data.tar.gz: 8fc6007694ba5df48585ac6561c1ec68cf50141d92cb6f080d50b6de700a0244aefd3d3d647f7ccee197c57cfcd3ad4721b2c88039ab6f9667cb47d4dc705620

data/.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+    paths:
+      - "lib/**"
+      - "test/**"
+      - ".github/**"
+      - "Rakefile"
+  pull_request:
+    branches: ["**"]
+    paths:
+      - "lib/**"
+      - "test/**"
+      - ".github/**"
+      - "Rakefile"
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ "2.0", "2.1", "2.2", "2.3", "2.4", "2.5", "2.6", "2.7", "3.0", "3.1", head, jruby, truffleruby ]
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler: none
+      - name: Run tests
+        run: rake test

data/CHANGELOG.md

@@ -1,6 +1,28 @@
 Changelog
 =========
 
+v4.9.2 (2022-03-26)
+-------------------
+
+Bug fixes:
+  * Handle flag arguments that contain equals character [#275](https://github.com/leejarvis/slop/pull/275) (ConnorWGarvey)
+
+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)
 -------------------
 

data/README.md

@@ -3,7 +3,7 @@ Slop
 
 Slop is a simple option parser with an easy to remember syntax and friendly API.
 
-[![Build Status](https://travis-ci.org/leejarvis/slop.svg?branch=master)](http://travis-ci.org/leejarvis/slop)
+[![Build Status](https://github.com/leejarvis/slop/actions/workflows/ci.yml/badge.svg)](https://github.com/leejarvis/slop/actions/workflows/ci.yml)
 
 Installation
 ------------
@@ -18,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'
@@ -27,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
@@ -56,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
 ```
@@ -132,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

data/lib/slop/options.rb

@@ -105,14 +105,14 @@ module Slop
       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" if opt.help?
+        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,7 @@ module Slop
 
         # support `foo=bar`
         orig_flag = flag.dup
-        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

data/lib/slop.rb

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

data/test/parser_test.rb

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'shellwords'
 
 describe Slop::Parser do
   before do
@@ -16,16 +17,34 @@ describe Slop::Parser do
     assert_equal ["-v", "--name", "lee"], @parser.arguments
   end
 
-  it "parses flag=argument" do
-    @options.integer "-p", "--port"
-    @result.parser.parse %w(--name=bob -p=123)
-    assert_equal "bob", @result[:name]
-    assert_equal 123, @result[:port]
+  describe "for flag=argument" do
+    it "parses names and values" do
+      @options.integer "-p", "--port"
+      @result.parser.parse %w(--name=bob -p=123)
+      assert_equal "bob", @result[:name]
+      assert_equal 123, @result[:port]
+    end
+
+    it "treats an = separated by a space as a value" do
+      @options.string "--foo"
+      @result.parser.parse %w(--foo = =)
+      assert_equal "=", @result[:foo]
+      assert_equal %w(=), @result.args
+    end
+
+    it "includes = in strings" do
+      @result.parser.parse(%w(--name=b=b))
+      assert_equal "b=b", @result[:name]
+    end
+  end
+
+  it "parses flag=''" do
+    @options.string "--str"
+    @options.array "--arr", default: ["array"]
+    @result.parser.parse %(--str="" --arr="").shellsplit
 
-    @options.string "--foo"
-    @result.parser.parse %w(--foo = =)
-    assert_equal "=", @result[:foo]
-    assert_equal %w(=), @result.args
+    assert_equal "", @result[:str]
+    assert_equal [], @result[:arr]
   end
 
   it "parses arg with leading -" do

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slop
 version: !ruby/object:Gem::Version
-  version: 4.8.2
+  version: 4.9.2
 platform: ruby
 authors:
 - Lee Jarvis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-10 00:00:00.000000000 Z
+date: 2022-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -44,8 +44,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -86,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Simple Lightweight Option Parsing

data/.travis.yml

@@ -1,28 +0,0 @@
-cache: bundler
-before_install:
-  - |
-    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.9
-  - 2.5.7
-  - 2.6.5
-  - 2.7.0
-  - jruby-9.2.9.0
-  - jruby-head
-  - ruby-head
-jdk:
-  - openjdk8
-notifications:
-  email:
-    on_success: change
-    on_failure: always