yawpa 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a5f3b1572ad428775ff39af66082b520cf60021e
-  data.tar.gz: 836e39335702df951e737fc1f67d36ce5cf51161
+SHA256:
+  metadata.gz: e5fcd7ef44592d02c72ee21a350c6656b5cffccb8e4e2ce8b946409e3cfbf115
+  data.tar.gz: fc7be5044326da3ef8ec9259053b8b59c293c310ffe42344192abf887417d3bd
 SHA512:
-  metadata.gz: 1189c18023a920a81781c1334123a8877e7a63ba82e54ec92e0afce4febfb435c3c5be2be2aaf26a62410a51e1c14f4a74e5dcdc4d7ae630de7a8b4f8aba63db
-  data.tar.gz: 200fd56c6bacb4f1c9a6fd3d1dc0cb0925a3b1f060663d0d23946a59cea7070c3fe75b8152391cf1beda7f1af7d5b66e2041fac3893d796148b1612b264785c7
+  metadata.gz: ad4c50a7090a8a51a3435dd1fdbc774f33fb7eb1d4e84f513eee3aac5a9609460738b72701194f425cd0cef0f982f1817fe010510fd66c89dbae973bd0bc67c6
+  data.tar.gz: 7b5219aba7f6f2fc1a02724d61a8c997edeca3f91e5260996a17a346c9701a5c8271e2c774db2519cf30adaf1095ebdf86fd2787d876bb7b1b101a447380df57

data/Gemfile.lock

@@ -1,35 +1,41 @@
 PATH
   remote: .
   specs:
-    yawpa (1.3.0)
+    yawpa (1.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.3)
-    docile (1.1.5)
-    json (2.1.0)
-    rake (12.0.0)
-    rdoc (5.1.0)
-    rspec (3.6.0)
-      rspec-core (~> 3.6.0)
-      rspec-expectations (~> 3.6.0)
-      rspec-mocks (~> 3.6.0)
-    rspec-core (3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-expectations (3.6.0)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    psych (5.1.0)
+      stringio
+    rake (13.0.6)
+    rdoc (6.5.0)
+      psych (>= 4.0.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-mocks (3.6.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.4)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-support (3.6.0)
-    simplecov (0.15.0)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    yard (0.9.9)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    stringio (3.0.5)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
 
 PLATFORMS
   ruby
@@ -43,4 +49,4 @@ DEPENDENCIES
   yawpa!
 
 BUNDLED WITH
-   1.10.6
+   2.4.10

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Josh Holtrop
+Copyright (c) 2013-2023 Josh Holtrop
 
 MIT License
 
@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -10,6 +10,21 @@ Yet Another Way to Parse Arguments is an argument-parsing library for Ruby.
 - Options can require an arbitrary number of parameters
 - Options can be defined with a range specifying the allowed number of parameters
 
+## Usage
+
+Yawpa can be used from another Ruby gem as a regular gem dependency, by adding
+a dependency on the "yawpa" gem at a particular version.
+For example:
+
+```ruby
+  gem.add_dependency "yawpa", "~> 1.3"
+```
+
+Yawpa can also be used by simply copying the contents of the one source file
+into any project that desires to use it.
+This can be useful if you desire to avoid having any external dependencies, or
+if you are producing a redistributable standalone script.
+
 ## Example 1
 
 ```ruby
@@ -69,6 +84,10 @@ Parse input parameters looking for options according to rules given in flags
       arguments to the option
     - `:boolean`: if true, specify that the option is a toggleable boolean
       option and allow a prefix of "no" to turn it off.
+    - `:multi`: if true, instead of the last value specified for this
+      option being returned, an Array of all values specified for this
+      option will be returned, allowing the argument to appear multiple
+      times in the argument list
 - `flags` is optional. It supports the following keys:
   - `:posix_order`: Stop processing parameters when a non-option is seen.
     Set this to `true` if you want to implement subcommands.
@@ -86,9 +105,12 @@ or insufficient arguments are present for an option.
   username: {nargs: 1},
   password: {nargs: 1},
   color: :boolean,
+  scan: {nargs: 1, multi: true},
 }
 ```
 
+### `options` Values
+
 The keys of the `options` hash can be either strings or symbols.
 
 Possible option flags:
@@ -98,6 +120,10 @@ Possible option flags:
   arguments to the option
 - `:boolean`: if true, specify that the option is a toggleable boolean
   option and allow a prefix of "no" to turn it off.
+- `:multi`: if true, instead of the last value specified for this
+  option being returned, an Array of all values specified for this
+  option will be returned, allowing the argument to appear multiple
+  times in the argument list
 
 ### Return values
 
@@ -109,6 +135,14 @@ options that were not processed after observing a non-option parameters).
 
 ## Release Notes
 
+### v1.4.0
+
+- Add multi option flag to allow accepting multiple instances of an argument
+
+### v1.3.0
+
+- Remove use of Fixnum for Ruby 2.4+ compatibility
+
 ### v1.2.0
 
 - Always return non-frozen strings

data/lib/yawpa.rb

@@ -1,5 +1,3 @@
-require "yawpa/version"
-
 # Yet Another Way to Parse Arguments is an argument-parsing library for Ruby.
 #
 # Yawpa does not try to provide a fancy DSL.
@@ -14,6 +12,9 @@ require "yawpa/version"
 #   parameters
 module Yawpa
 
+  # gem version
+  VERSION = "1.4.0"
+
   # Exception class raised when an unknown option is observed.
   class ArgumentParsingException < Exception; end
 
@@ -36,6 +37,7 @@ module Yawpa
     #     username: {nargs: 1},
     #     password: {nargs: 1},
     #     color: :boolean,
+    #     scan: {nargs: 1, multi: true},
     #   }
     #
     # The keys of the +options+ Hash can be either strings or symbols.
@@ -59,6 +61,10 @@ module Yawpa
     #       arguments to the option
     #     - +:boolean+: if true, specify that the option is a toggleable
     #       boolean option and allow a prefix of "no" to turn it off.
+    #     - +:multi+: if true, instead of the last value specified for this
+    #       option being returned, an Array of all values specified for this
+    #       option will be returned, allowing the argument to appear multiple
+    #       times in the argument list
     # @param flags [Hash]
     #   Optional flags dictating how {.parse} should do its job.
     # @option flags [Boolean] :posix_order
@@ -98,13 +104,14 @@ module Yawpa
           raise ArgumentParsingException.new("Unknown option '#{param_name}'") unless opt_config
           param_key = opt_config[:key]
           if opt_config[:boolean]
-            opts[param_key] = bool_val
+            param_val = bool_val
           elsif opt_config[:nargs].last == 0
-            opts[param_key] = true
+            param_val = true
           else
-            opts[param_key] = []
-            i += _gather(opt_config[:nargs], i + 1, params, val, param_key, opts[param_key])
+            param_val = []
+            i += _gather(opt_config[:nargs], i + 1, params, val, param_key, param_val)
           end
+          _record_opt_val(opts, opt_config, param_key, param_val)
         elsif param =~ /^-(.+)$/
           short_flags = $1
           short_idx = 0
@@ -115,15 +122,17 @@ module Yawpa
             end
             param_key = opt_config[:key]
             if opt_config[:nargs].last == 0
-              opts[param_key] = true
+              param_val = true
+              _record_opt_val(opts, opt_config, param_key, param_val)
             else
-              opts[param_key] = []
+              param_val = []
               i += _gather(opt_config[:nargs],
                            i + 1,
                            params,
                            short_flags[short_idx + 1, short_flags.length],
                            param_key,
-                           opts[param_key])
+                           param_val)
+              _record_opt_val(opts, opt_config, param_key, param_val)
               break
             end
             short_idx += 1
@@ -137,18 +146,24 @@ module Yawpa
         i += 1
       end
 
-      # Condense 1-element arrays of option values to just the element itself
-      opts.each_key do |k|
-        if opts[k].is_a?(Array) and opts[k].length == 1
-          opts[k] = opts[k].first
-        end
-      end
-
       return [opts, args]
     end
 
     private
 
+    def _record_opt_val(opts, opt_config, param_key, value)
+      # Condense 1-element arrays of option values to just the element itself
+      if value.is_a?(Array) and value.length == 1
+        value = value.first
+      end
+      if opt_config[:multi]
+        opts[param_key] ||= []
+        opts[param_key] << value
+      else
+        opts[param_key] = value
+      end
+    end
+
     # Internal helper method to gather arguments for an option
     def _gather(nargs, start_idx, params, initial, param_key, result)
       n_gathered = 0
@@ -185,6 +200,7 @@ module Yawpa
           newopts[newkey][:nargs] = nargs
           newopts[newkey][:short] = v[:short] || ''
           newopts[newkey][:boolean] = v[:boolean]
+          newopts[newkey][:multi] = v[:multi]
         end
       end
     end

data/spec/yawpa_spec.rb

@@ -257,5 +257,36 @@ describe Yawpa do
       expect(args[0].frozen?).to be_falsey
       expect{args[0].sub!(/./, '-')}.to_not raise_error
     end
+
+    it "overwrites an option's value when multiple argument instances are present and multi flag is not set" do
+      options = {
+        scan: {short: "s", nargs: 1},
+      }
+      params = ['--scan', 'scan1', '-s', 'scan2', 'arg']
+      opts, args = Yawpa.parse(params, options)
+      expect(opts[:scan]).to eq('scan2')
+      expect(args).to eq(['arg'])
+    end
+
+    it "returns an Array of option values when multiple argument instances are present and multi flag is set" do
+      options = {
+        scan: {short: "s", nargs: 1, multi: true},
+      }
+      params = ['--scan', 'scan1', '-s', 'scan2', 'arg']
+      opts, args = Yawpa.parse(params, options)
+      expect(opts[:scan]).to eq(%w[scan1 scan2])
+      expect(args).to eq(['arg'])
+    end
+
+    it "returns an Array of Arrays of option values when multiple argument instances are present and multi flag is set and nargs > 1" do
+      options = {
+        opt: {short: "o", nargs: 2, multi: true},
+      }
+      params = %w[--opt o1 o2 -o o3 o4 a1 a2]
+      opts, args = Yawpa.parse(params, options)
+      expect(opts[:opt]).to eq([%w[o1 o2], %w[o3 o4]])
+      expect(args).to eq(%w[a1 a2])
+    end
+
   end
 end

data/yawpa.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/yawpa/version', __FILE__)
+require File.expand_path('../lib/yawpa', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Josh Holtrop"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yawpa
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Josh Holtrop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-08 00:00:00.000000000 Z
+date: 2023-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -96,7 +96,6 @@ files:
 - README.md
 - Rakefile.rb
 - lib/yawpa.rb
-- lib/yawpa/version.rb
 - spec/spec_helper.rb
 - spec/yawpa_spec.rb
 - yawpa.gemspec
@@ -118,8 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Yet Another Way to Parse Arguments

data/lib/yawpa/version.rb

@@ -1,4 +0,0 @@
-module Yawpa
-  # gem version
-  VERSION = "1.3.0"
-end