v1.3.0

Gemfile.lock

@@ -1,37 +1,35 @@
 PATH
   remote: .
   specs:
-    yawpa (1.1.0)
+    yawpa (1.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.2.5)
+    diff-lcs (1.3)
     docile (1.1.5)
-    json (1.8.1)
+    json (2.1.0)
-    multi_json (1.10.1)
+    rake (12.0.0)
-    rake (10.3.2)
+    rdoc (5.1.0)
-    rdoc (4.1.1)
+    rspec (3.6.0)
-      json (~> 1.4)
+      rspec-core (~> 3.6.0)
-    redcarpet (3.1.2)
+      rspec-expectations (~> 3.6.0)
-    rspec (3.0.0)
+      rspec-mocks (~> 3.6.0)
-      rspec-core (~> 3.0.0)
+    rspec-core (3.6.0)
-      rspec-expectations (~> 3.0.0)
+      rspec-support (~> 3.6.0)
-      rspec-mocks (~> 3.0.0)
+    rspec-expectations (3.6.0)
-    rspec-core (3.0.2)
-      rspec-support (~> 3.0.0)
-    rspec-expectations (3.0.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.0.0)
+      rspec-support (~> 3.6.0)
-    rspec-mocks (3.0.2)
+    rspec-mocks (3.6.0)
-      rspec-support (~> 3.0.0)
+      diff-lcs (>= 1.2.0, < 2.0)
-    rspec-support (3.0.2)
+      rspec-support (~> 3.6.0)
-    simplecov (0.8.2)
+    rspec-support (3.6.0)
+    simplecov (0.15.0)
       docile (~> 1.1.0)
-      multi_json
+      json (>= 1.8, < 3)
-      simplecov-html (~> 0.8.0)
+      simplecov-html (~> 0.10.0)
-    simplecov-html (0.8.0)
+    simplecov-html (0.10.2)
-    yard (0.8.7.4)
+    yard (0.9.9)
 
 PLATFORMS
   ruby
@@ -39,8 +37,10 @@ PLATFORMS
 DEPENDENCIES
   rake
   rdoc
-  redcarpet
   rspec
   simplecov
   yard
   yawpa!
+
+BUNDLED WITH
+   1.10.6

README.md

@@ -109,6 +109,10 @@ options that were not processed after observing a non-option parameters).
 
 ## Release Notes
 
+### v1.2.0
+
+- Always return non-frozen strings
+
 ### v1.1.0
 
 - Add `:boolean` option flag.

lib/yawpa.rb

@@ -13,16 +13,19 @@ require "yawpa/version"
 # - Options can be defined with a range specifying the allowed number of
 #   parameters
 module Yawpa
+
   # Exception class raised when an unknown option is observed.
   class ArgumentParsingException < Exception; end
 
+  class << self
+
     # Parse input parameters looking for options according to rules given in
     # flags.
     # Syntax:
     #   opts, args = parse(params, options, flags = {})
     #
-  # An ArgumentParsingException will be raised if an unknown option is observed
+    # An ArgumentParsingException will be raised if an unknown option is
-  # or insufficient arguments are present for an option.
+    # observed or insufficient arguments are present for an option.
     #
     # Example +options+:
     #
@@ -50,11 +53,12 @@ module Yawpa
     #     +{boolean: true}+)
     #   Hash::
     #     Possible option flags:
-  #     - +:short+: specify a short option letter to associate with the long option
+    #     - +:short+: specify a short option letter to associate with the long
+    #       option
     #     - +:nargs+: specify an exact number or range of possible numbers of
     #       arguments to the option
-  #     - +:boolean+: if true, specify that the option is a toggleable boolean
+    #     - +:boolean+: if true, specify that the option is a toggleable
-  #       option and allow a prefix of "no" to turn it off.
+    #       boolean option and allow a prefix of "no" to turn it off.
     # @param flags [Hash]
     #   Optional flags dictating how {.parse} should do its job.
     # @option flags [Boolean] :posix_order
@@ -71,7 +75,7 @@ module Yawpa
     #     parameters (if +:posix_order+ was passed in +flags+, this array might
     #     contain further options that were not processed after observing a
     #     non-option parameters).
-  def self.parse(params, options, flags = {})
+    def parse(params, options, flags = {})
       options = _massage_options(options)
       opts = {}
       args = []
@@ -114,16 +118,21 @@ module Yawpa
               opts[param_key] = true
             else
               opts[param_key] = []
-            i += _gather(opt_config[:nargs], i + 1, params, short_flags[short_idx + 1, short_flags.length], param_key, opts[param_key])
+              i += _gather(opt_config[:nargs],
+                           i + 1,
+                           params,
+                           short_flags[short_idx + 1, short_flags.length],
+                           param_key,
+                           opts[param_key])
               break
             end
             short_idx += 1
           end
         elsif flags[:posix_order]
-        args = params[i, params.length]
+          args = params[i, params.length].map(&:dup)
           break
         else
-        args << params[i]
+          args << params[i].dup
         end
         i += 1
       end
@@ -138,8 +147,10 @@ module Yawpa
       return [opts, args]
     end
 
+    private
+
     # Internal helper method to gather arguments for an option
-  def self._gather(nargs, start_idx, params, initial, param_key, result)
+    def _gather(nargs, start_idx, params, initial, param_key, result)
       n_gathered = 0
       if initial and initial != ''
         result << initial
@@ -150,7 +161,7 @@ module Yawpa
       while n_gathered < nargs.last and
             index < params.length and
             params[index][0] != '-' do
-      result << params[index]
+        result << params[index].dup
         index += 1
         num_indices_used += 1
         n_gathered += 1
@@ -160,10 +171,9 @@ module Yawpa
       end
       num_indices_used
     end
-  private_class_method :_gather
 
     # Internal helper method to format the options in a consistent format
-  def self._massage_options(options)
+    def _massage_options(options)
       {}.tap do |newopts|
         options.each_pair do |k, v|
           v = {} if v.nil?
@@ -171,21 +181,22 @@ module Yawpa
           newkey = k.to_s
           newopts[newkey] = {key: k}
           nargs = v[:nargs] || 0
-        nargs = (nargs..nargs) if nargs.is_a?(Fixnum)
+          nargs = (nargs..nargs) if nargs.is_a?(Integer)
           newopts[newkey][:nargs] = nargs
           newopts[newkey][:short] = v[:short] || ''
           newopts[newkey][:boolean] = v[:boolean]
         end
       end
     end
-  private_class_method :_massage_options
 
     # Internal helper method to find an option configuration by short name
-  def self._find_opt_config_by_short_name(options, short_name)
+    def _find_opt_config_by_short_name(options, short_name)
       options.each_pair do |k, v|
         return v if v[:short] == short_name
       end
       nil
     end
-  private_class_method :_find_opt_config_by_short_name
+
+  end
+
 end

lib/yawpa/version.rb

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

spec/yawpa_spec.rb

@@ -11,7 +11,7 @@ describe Yawpa do
     it "raises an exception when an invalid option is passed" do
       options = { }
       params = ['one', '--option', 'two']
-      expect { Yawpa.parse(params, options) }.to raise_error
+      expect { Yawpa.parse(params, options) }.to raise_error(Yawpa::ArgumentParsingException, /Unknown option/)
     end
 
     it "returns boolean options which are set" do
@@ -53,7 +53,7 @@ describe Yawpa do
         opt: {nargs: 2},
       }
       params = ['--opt', 'val']
-      expect { Yawpa.parse(params, options) }.to raise_error
+      expect { Yawpa.parse(params, options) }.to raise_error(Yawpa::ArgumentParsingException, /Not enough arguments supplied/)
     end
 
     it "uses --opt=val syntax for an option's value" do
@@ -179,7 +179,7 @@ describe Yawpa do
         a: {short: 'a'},
       }
       params = ['-ab']
-      expect { Yawpa.parse(params, options) }.to raise_error
+      expect { Yawpa.parse(params, options) }.to raise_error(Yawpa::ArgumentParsingException, /Unknown option/)
     end
 
     it "raises an error when not enough arguments are given to short option" do
@@ -187,7 +187,7 @@ describe Yawpa do
         a: {nargs: 1, short: 'a'},
       }
       params = ['-a']
-      expect { Yawpa.parse(params, options) }.to raise_error
+      expect { Yawpa.parse(params, options) }.to raise_error(Yawpa::ArgumentParsingException, /Not enough arguments supplied/)
     end
 
     it "overwrites option value when short option used after long" do
@@ -230,5 +230,32 @@ describe Yawpa do
       expect(opts).to eq(push: false, pull: true)
       expect(args).to eq(%w[arg])
     end
+
+    it "returns non-frozen strings" do
+      options = {
+        o1: {nargs: 1, short: "1"},
+        o2: {nargs: 1, short: "2"},
+        o3: {nargs: 1, short: "3"},
+        o4: {nargs: 1, short: "4"},
+      }
+
+      arguments = %w[--o1=one --o2 two -3 three -4four arg].map(&:freeze)
+
+      opts, args = Yawpa.parse(arguments, options)
+      expect(opts[:o1].frozen?).to be_falsey
+      expect{opts[:o1].sub!(/./, '-')}.to_not raise_error
+      expect(opts[:o2].frozen?).to be_falsey
+      expect{opts[:o2].sub!(/./, '-')}.to_not raise_error
+      expect(opts[:o3].frozen?).to be_falsey
+      expect{opts[:o3].sub!(/./, '-')}.to_not raise_error
+      expect(opts[:o4].frozen?).to be_falsey
+      expect{opts[:o4].sub!(/./, '-')}.to_not raise_error
+      expect(args[0].frozen?).to be_falsey
+      expect{args[0].sub!(/./, '-')}.to_not raise_error
+
+      opts, args = Yawpa.parse(arguments, options, posix_order: true)
+      expect(args[0].frozen?).to be_falsey
+      expect{args[0].sub!(/./, '-')}.to_not raise_error
+    end
   end
 end

yawpa.gemspec

@@ -20,5 +20,4 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rdoc"
   gem.add_development_dependency "yard"
-  gem.add_development_dependency "redcarpet"
 end