simple_scripting 0.10.1 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4b1be8a601a79595da23945788e7c16ff9491c527929c6d8ab718b23f032e7f
-  data.tar.gz: 92fe06a625a0ff3661f5c4d9034a6f16aa8846ba88f8327bd9d848bd49bc40e8
+  metadata.gz: d451df42fd6ecf5e2de7ec01680151cecaf8f7438fe38beecc20c8a096669c3c
+  data.tar.gz: e295f1ff9885ce49834785c2c134aee3a85c5d26840a0234ab613d5041f7e4b9
 SHA512:
-  metadata.gz: e1c88943a0a2adbd3887374dc01e5f1b4be1edf14530cc7bd0408da1c8a35f3e5a1e3bf49dd72fc6fa9b077284e569c304ead13f16f77890eeacbcd6d7f579df
-  data.tar.gz: c351644417ea83f5c50b7bd011631df9b0b852a8a4bf553889464237da33437fe5a035d7ec687a8a668b68649f3fd2b260ffc578e41b9c3b7cb5391afe43867a
+  metadata.gz: 51e691d5371ae18047cda52434f84e3e87bee48f1aa3b6db9022287e066be389f32bc3a9e3a9249289755c9b206ee634550562e4231474ce99fb8087a588fa94
+  data.tar.gz: 063a6e93572108e28a9228d8f06c121599dfc19dcbf031c2262fe4e18e22cfbbf1782acf60c1c8e2d2273aae05399b8264fce0bb094a2e04c98a12da0b137677

data/.travis.yml

@@ -4,3 +4,4 @@ rvm:
   - 2.3
   - 2.4
   - 2.5
+  - 2.6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simple_scripting (0.10.0)
+    simple_scripting (0.10.1)
       parseconfig (~> 1.0)
 
 GEM

data/lib/simple_scripting/argv.rb

@@ -37,7 +37,14 @@ module SimpleScripting
 
     extend self
 
-    def decode(*params_definition, arguments: ARGV, long_help: nil, auto_help: true, output: $stdout)
+    def decode(*definition_and_options)
+      params_definition, options = decode_definition_and_options(definition_and_options)
+
+      arguments = options.fetch(:arguments, ARGV)
+      long_help = options[:long_help]
+      auto_help = options.fetch(:auto_help, true)
+      output    = options.fetch(:output, $stdout)
+
       # WATCH OUT! @long_help can also be set in :decode_command!. See issue #17.
       #
       @long_help = long_help
@@ -59,6 +66,31 @@ module SimpleScripting
 
     private
 
+    # This is trivial to define with named arguments, however, Ruby 2.6 removed the support for
+    # mixing strings and symbols as argument keys, so we're forced to perform manual decoding.
+    # The complexity of this code supports the rationale for the removal of the functionality.
+    #
+    def decode_definition_and_options(definition_and_options)
+      # Only a hash (commands)
+      if definition_and_options.size == 1 && definition_and_options.first.is_a?(Hash)
+        options = definition_and_options.first.each_with_object({}) do |(key, value), current_options|
+          current_options[key] = definition_and_options.first.delete(key) if key.is_a?(Symbol)
+        end
+
+        # If there is an empty hash left, we remove it, so it's not considered commands.
+        #
+        definition_and_options = [] if definition_and_options.first.empty?
+      # Options passed
+      elsif definition_and_options.last.is_a?(Hash)
+        options = definition_and_options.pop
+      # No options passed
+      else
+        options = {}
+      end
+
+      [definition_and_options, options]
+    end
+
     # MAIN CASES ###########################################
 
     # Input params_definition for a non-nested case:
@@ -118,10 +150,10 @@ module SimpleScripting
       end
     end
 
-    def decode_arguments!(params_definition, arguments, auto_help, commands_stack=[])
+    def decode_arguments!(params_definition, arg_values, auto_help, commands_stack=[])
       result           = {}
       parser_opts_copy = nil  # not available outside the block
-      args             = {}   # { 'name' => mandatory? }
+      arg_definitions  = {}   # { 'name' => mandatory? }
 
       OptionParser.new do |parser_opts|
         params_definition.each do |param_definition|
@@ -129,7 +161,7 @@ module SimpleScripting
           when Array
             process_option_definition!(param_definition, parser_opts, result)
           when String
-            process_argument_definition!(param_definition, args)
+            process_argument_definition!(param_definition, arg_definitions)
           else
             # This is an error in the params definition, so it doesn't follow the user error/help
             # workflow.
@@ -142,7 +174,7 @@ module SimpleScripting
         #
         parser_opts.on('-h', '--help', 'Help') do
           if auto_help
-            throw :exit, ExitWithArgumentsHelpPrinting.new(commands_stack, args, parser_opts_copy)
+            throw :exit, ExitWithArgumentsHelpPrinting.new(commands_stack, arg_definitions, parser_opts_copy)
           else
             # Needs to be better handled. When help is required, generally, it trumps the
             # correctness of the rest of the options/arguments.
@@ -152,16 +184,19 @@ module SimpleScripting
         end
 
         parser_opts_copy = parser_opts
-      end.parse!(arguments)
-
-      first_arg_name = args.keys.first.to_s
+      end.parse!(arg_values)
 
-      if first_arg_name.start_with?('*')
-        process_varargs!(arguments, result, commands_stack, args, parser_opts_copy)
-      else
-        process_regular_argument!(arguments, result, commands_stack, args, parser_opts_copy)
+      arg_definitions.each do |arg_name, arg_is_mandatory|
+        if arg_name.to_s.start_with?('*')
+          arg_name = arg_name.to_s[1..-1].to_sym
+          process_varargs!(arg_values, result, commands_stack, arg_name, arg_is_mandatory)
+        else
+          process_regular_argument!(arg_values, result, commands_stack, arg_name, arg_is_mandatory)
+        end
       end
 
+      check_no_remaining_arguments(arg_values)
+
       result
     end
 
@@ -191,38 +226,25 @@ module SimpleScripting
       end
     end
 
-    def process_varargs!(arguments, result, commands_stack, args, parser_opts_copy)
-      first_arg_name = args.keys.first.to_s
+    def process_varargs!(arg_values, result, commands_stack, arg_name, arg_is_mandatory)
+      raise ArgumentError.new("Missing mandatory argument(s)") if arg_is_mandatory && arg_values.empty?
 
-      # Mandatory argument
-      if args.fetch(first_arg_name.to_sym)
-        if arguments.empty?
-          raise ArgumentError.new("Missing mandatory argument(s)")
-        else
-          name = args.keys.first[1..-1].to_sym
+      result[arg_name] = arg_values.dup
+      arg_values.clear
+    end
 
-          result[name] = arguments
+    def process_regular_argument!(arg_values, result, commands_stack, arg_name, arg_is_mandatory)
+      if arg_values.empty?
+        if arg_is_mandatory
+          raise ArgumentError.new("Missing mandatory argument(s)")
         end
-      # Optional
       else
-        name = args.keys.first[1..-1].to_sym
-
-        result[name] = arguments
+        result[arg_name] = arg_values.shift
       end
     end
 
-    def process_regular_argument!(arguments, result, commands_stack, args, parser_opts_copy)
-      min_args_size = args.count { |_, mandatory| mandatory }
-
-      if arguments.size < min_args_size
-        raise ArgumentError.new("Missing mandatory argument(s)")
-      elsif arguments.size > args.size
-        raise ArgumentError.new("Too many arguments")
-      else
-        arguments.zip(args) do |value, (name, _)|
-          result[name] = value
-        end
-      end
+    def check_no_remaining_arguments(arg_values)
+      raise ArgumentError.new("Too many arguments") if !arg_values.empty?
     end
 
     # HELPERS ##############################################

data/lib/simple_scripting/version.rb

@@ -1,5 +1,5 @@
 module SimpleScripting
 
-  VERSION = "0.10.1"
+  VERSION = "0.10.2"
 
 end

data/simple_scripting.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.required_ruby_version = '>= 2.3.0'
   s.authors     = ["Saverio Miroddi"]
-  s.date        = "2018-12-03"
+  s.date        = "2019-01-15"
   s.email       = ["saverio.pub2@gmail.com"]
   s.homepage    = "https://github.com/saveriomiroddi/simple_scripting"
   s.summary     = "Library for simplifying some typical scripting functionalities."

data/spec/simple_scripting/argv_spec.rb

@@ -169,28 +169,57 @@ describe SimpleScripting::Argv do
 
     describe '(mandatory)' do
 
-      let(:decoder_params) {[
-        '*varargs',
-        output:     output_buffer,
-      ]}
+      context 'as only parameter' do
 
-      it "should be decoded" do
-        decoder_params.last[:arguments] = ['varval1', 'varval2']
+        let(:decoder_params) {[
+          '*varargs',
+          output:     output_buffer,
+          arguments:  ['varval1', 'varval2'],
+        ]}
 
-        actual_result = described_class.decode(*decoder_params)
+        it "should be decoded" do
+          actual_result = described_class.decode(*decoder_params)
 
-        expected_result = {
-          varargs:   ['varval1', 'varval2'],
-        }
+          expected_result = {
+            varargs:   ['varval1', 'varval2'],
+          }
+
+          expect(actual_result).to eql(expected_result)
+        end
+
+      end
+
+      context 'followed by varargs' do
+
+        let(:decoder_params) {[
+          'mandatory',
+          '*varargs',
+          output:     output_buffer,
+          arguments:  ['mandval', 'varval1', 'varval2']
+        ]}
+
+        it "should be decoded" do
+          actual_result = described_class.decode(*decoder_params)
+
+          expected_result = {
+            mandatory: 'mandval',
+            varargs:   ['varval1', 'varval2'],
+          }
+
+          expect(actual_result).to eql(expected_result)
+        end
 
-        expect(actual_result).to eql(expected_result)
       end
 
       context "error handling" do
 
-        it "should exit when they are not specified" do
-          decoder_params.last[:arguments] = []
+        let(:decoder_params) {[
+          '*varargs',
+          output:     output_buffer,
+          arguments:  [],
+        ]}
 
+        it "should exit when they are not specified" do
           decoding = -> { described_class.decode(*decoder_params) }
 
           expect(decoding).to raise_error(SimpleScripting::Argv::ArgumentError, "Missing mandatory argument(s)")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_scripting
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.10.2
 platform: ruby
 authors:
 - Saverio Miroddi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-03 00:00:00.000000000 Z
+date: 2019-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parseconfig
@@ -101,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Library for simplifying some typical scripting functionalities.