simple_scripting 0.12.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58e50fed7e20d97c590ebbab5466313a9a98393c7fbec6124131bcbf166af043
-  data.tar.gz: 7b16435d1eb0544743043b58f437a3d63407bac2ceb1595defa4ee557b6a7523
+  metadata.gz: 0a31e06185c711924565be44455735e02e55b31a98fc6782a101214cf9d37266
+  data.tar.gz: 2fa2139a689a85e1703604a3da2be186ac8596b9b17c0bc2af4c8c8244c8ad4d
 SHA512:
-  metadata.gz: '088ce9b31b82294a6b0ac5a238edfabaff919c71358e82deae14ef31f620c33f2f44af4de4f6a8e1996c7b1f3d9574d2ac5b88a85ff65745e3b5752b02146b07'
-  data.tar.gz: a94f016103580b122129bd85070030d21b74b2b6b348e129259f674cffec2cbb847a86fcde5d0a4cac267ce4c7d7bc2fdae1e5ff6b0259d1f3a351dbe4df96cd
+  metadata.gz: bbf4a7477108d85b62922592eedbc550f0896ca75265385c219c052636d0c45628cd93ca59603649f9ee9227cf00fdf2526732918efb0ab7d55fe62d4b158196
+  data.tar.gz: b754caa9b812a0d7a5882d5bc2c67b0e72a276da9385a2be70d423838f00da711a182fb1f9b67c4072176c73a9d4020acb3b2070fba54f83615edd830cc5aa5c

data/lib/simple_scripting/argv.rb

@@ -243,7 +243,8 @@ module SimpleScripting
       end
 
       parser_opts.on(*param_definition) do |value|
-        result[key] = value || true
+        raise "Unexpected (nil; likely programmatic error) value for param definition #{param_definition}" if value.nil?
+        result[key] = value
       end
     end
 

data/lib/simple_scripting/version.rb

@@ -1,5 +1,5 @@
 module SimpleScripting
 
-  VERSION = "0.12.1"
+  VERSION = "0.13.0"
 
 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        = "2020-02-13"
+  s.date        = "2022-07-21"
   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

@@ -3,15 +3,12 @@ require_relative '../../lib/simple_scripting/argv.rb'
 require 'stringio'
 
 module SimpleScripting
-
   describe Argv do
-
     let(:output_buffer) do
       StringIO.new
     end
 
     describe 'Basic functionality' do
-
       let(:decoder_params) {[
         ['-a'                                        ],
         ['-b',                     '"-b" description'],
@@ -26,7 +23,6 @@ module SimpleScripting
       ]}
 
       context 'help' do
-
         it 'should print help automatically by default' do
           decoder_params.last[:arguments] = ['-h']
 
@@ -73,11 +69,10 @@ module SimpleScripting
             raise_errors: true,
           )
 
-          decoding = -> { described_class.decode(*decoder_params) }
-
-          expect(decoding).to raise_error(Argv::ArgumentError, "Missing mandatory argument(s)")
+          expect {
+            described_class.decode(*decoder_params)
+          }.to raise_error(Argv::ArgumentError, "Missing mandatory argument(s)")
         end
-
       end # context 'help'
 
       it "should implement basic switches, with conversion, and arguments (all set)" do
@@ -111,8 +106,49 @@ module SimpleScripting
         expect(actual_result).to eql(expected_result)
       end
 
-      context "multiple optional arguments" do
+      context "booleans" do
+        VALID_BOOLS = {
+          'false' => false,
+          'true'  => true,
+        }
 
+        INVALID_BOOLS = %w[falx FALSE TRUE]
+
+        VALID_BOOLS.each do |user_value, decoded_value|
+          it "should decode a #{decoded_value} value" do
+            decoder_params = [
+              ["-b", "--mybool VAL", TrueClass],
+              output:     output_buffer,
+              arguments: ['--mybool', 'false']
+            ]
+
+            actual_result = described_class.decode(*decoder_params)
+
+            expected_result = {
+              mybool: false
+            }
+
+            expect(actual_result).to eql(expected_result)
+          end
+        end # context "booleans"
+
+        INVALID_BOOLS.each do |value|
+          it "should raise an error on invalid bool #{value.inspect}" do
+            decoder_params = [
+              ["-b", "--mybool VAL", TrueClass],
+              output:       output_buffer,
+              arguments:    ['--mybool', value],
+              raise_errors: true,
+            ]
+
+            expect {
+              described_class.decode(*decoder_params)
+            }.to raise_error(OptionParser::InvalidArgument)
+          end
+        end
+      end
+
+      context "multiple optional arguments" do
         let(:decoder_params) {[
           '[optional1]',
           '[optional2]',
@@ -143,11 +179,9 @@ module SimpleScripting
 
           expect(actual_result).to eql(expected_result)
         end
-
       end
 
       context "error handling" do
-
         # All the other UTs use error raising, for convenience.
         it "should print the error, with a previx, by default, instead of raising an error" do
           decoder_params.last[:arguments] = []
@@ -167,9 +201,9 @@ module SimpleScripting
             raise_errors: true,
           )
 
-          decoding = -> { described_class.decode(*decoder_params) }
-
-          expect(decoding).to raise_error(Argv::ArgumentError, "Missing mandatory argument(s)")
+          expect {
+            described_class.decode(*decoder_params)
+          }.to raise_error(Argv::ArgumentError, "Missing mandatory argument(s)")
         end
 
         it "should raise an error when there are too many arguments" do
@@ -178,21 +212,16 @@ module SimpleScripting
             raise_errors: true,
           )
 
-          decoding = -> { described_class.decode(*decoder_params) }
-
-          expect(decoding).to raise_error(Argv::ArgumentError, "Too many arguments")
+          expect {
+            described_class.decode(*decoder_params)
+          }.to raise_error(Argv::ArgumentError, "Too many arguments")
         end
-
       end # context "error handling"
-
     end # describe 'Basic functionality'
 
     describe 'Varargs' do
-
       describe '(mandatory)' do
-
         context 'as only parameter' do
-
           let(:decoder_params) {[
             '*varargs',
             output:     output_buffer,
@@ -208,11 +237,9 @@ module SimpleScripting
 
             expect(actual_result).to eql(expected_result)
           end
-
         end
 
         context 'followed by varargs' do
-
           let(:decoder_params) {[
             'mandatory',
             '*varargs',
@@ -230,11 +257,9 @@ module SimpleScripting
 
             expect(actual_result).to eql(expected_result)
           end
-
         end
 
         context "error handling" do
-
           let(:decoder_params) {[
             '*varargs',
             output:     output_buffer,
@@ -244,17 +269,14 @@ module SimpleScripting
           it "should raise an error when they are not specified" do
             decoder_params.last[:raise_errors] = true
 
-            decoding = -> { described_class.decode(*decoder_params) }
-
-            expect(decoding).to raise_error(Argv::ArgumentError, "Missing mandatory argument(s)")
+            expect {
+              described_class.decode(*decoder_params)
+            }.to raise_error(Argv::ArgumentError, "Missing mandatory argument(s)")
           end
-
         end # context "error handling"
-
       end # describe '(mandatory)'
 
       describe '(optional)' do
-
         let(:decoder_params) {[
           '[*varargs]',
           output:     output_buffer,
@@ -283,15 +305,11 @@ module SimpleScripting
 
           expect(actual_result).to eql(expected_result)
         end
-
       end # describe '(optional)'
-
     end # describe 'Varargs'
 
     describe 'Commands' do
-
       describe 'regular case' do
-
         let(:decoder_params) {{
           'command1' => [
             'arg1',
@@ -314,16 +332,15 @@ module SimpleScripting
         end
 
         context "error handling" do
-
           it "should raise an error on invalid command" do
             decoder_params.merge!(
               arguments: ['pizza'],
               raise_errors: true,
             )
 
-            decoding = -> { described_class.decode(decoder_params) }
-
-            expect(decoding).to raise_error(an_instance_of(Argv::InvalidCommand).and having_attributes(
+            expect {
+              described_class.decode(decoder_params)
+            }.to raise_error(an_instance_of(Argv::InvalidCommand).and having_attributes(
               message: "Invalid command: pizza",
               valid_commands: ["command1", "command2"],
             ))
@@ -335,18 +352,16 @@ module SimpleScripting
               raise_errors: true,
             )
 
-            decoding = -> { described_class.decode(decoder_params) }
-
-            expect(decoding).to raise_error(an_instance_of(Argv::InvalidCommand).and having_attributes(
+            expect {
+              described_class.decode(decoder_params)
+            }.to raise_error(an_instance_of(Argv::InvalidCommand).and having_attributes(
               message: "Missing command!",
               valid_commands: ["command1", "command2"],
             ))
           end
-
         end # context "error handling"
 
         context "help" do
-
           it 'should implement the commands help' do
             decoder_params[:arguments] = ['-h']
 
@@ -377,7 +392,6 @@ module SimpleScripting
           end
 
           context 'auto_help: false' do
-
             it 'should not interpret the --help argument, and not print the help' do
               decoder_params.merge!(
                 arguments: ['-h'],
@@ -407,15 +421,11 @@ module SimpleScripting
 
               expect(actual_result).to eql(expected_result)
             end
-
           end # context 'auto_help: false'
-
         end # context 'help'
-
       end # describe 'regular case'
 
       describe 'Nested commands' do
-
         let(:decoder_params) {{
           'command1' => {
             'nested1a' => [
@@ -481,13 +491,11 @@ module SimpleScripting
           expect(output_buffer.string).to eql(expected_output)
         end
       end # describe 'Nested commands'
-
     end # describe 'Commands'
 
     # Special case.
     #
     describe 'No definitions given' do
-
       let(:decoder_params) {{
         output:     output_buffer,
       }}
@@ -496,13 +504,10 @@ module SimpleScripting
         decoder_params[:arguments] = ['pizza']
         decoder_params[:raise_errors] = true
 
-        decoding = -> { described_class.decode(decoder_params) }
-
-        expect(decoding).to raise_error(Argv::ArgumentError, "Too many arguments")
+        expect {
+          described_class.decode(decoder_params)
+        }.to raise_error(Argv::ArgumentError, "Too many arguments")
       end
-
     end # describe 'No definitions given'
-
   end # describe Argv
-
 end # module SimpleScripting

data/spec/simple_scripting/configuration_spec.rb

@@ -4,7 +4,6 @@ require 'tempfile'
 require 'tmpdir'
 
 module SimpleScripting::ConfigurationSpecHelper
-
   def with_tempfile(config_content)
     tempfile = Tempfile.new('ss_config_test')
     tempfile.write(config_content)
@@ -14,11 +13,9 @@ module SimpleScripting::ConfigurationSpecHelper
   ensure
     tempfile.unlink
   end
-
 end
 
 describe SimpleScripting::Configuration do
-
   include SimpleScripting::ConfigurationSpecHelper
 
   let(:configuration_text) {"
@@ -56,9 +53,9 @@ g2_key=bang
 
   it "should raise an error when required keys are missing" do
     with_tempfile(configuration_text) do |config_file|
-      error_call = -> { described_class.load(config_file: config_file, required: %w(abspath_key missing_key group1)) }
-
-      expect(error_call).to raise_error(RuntimeError, "Missing required configuration key(s): missing_key, group1")
+      expect {
+        described_class.load(config_file: config_file, required: %w(abspath_key missing_key group1))
+      }.to raise_error(RuntimeError, "Missing required configuration key(s): missing_key, group1")
     end
   end
 
@@ -73,5 +70,4 @@ g2_key=bang
       File.delete(temp_config_file)
     end
   end
-
-end
+end # describe SimpleScripting::Configuration

data/spec/simple_scripting/tab_completion_spec.rb

@@ -3,7 +3,6 @@
 require_relative '../../lib/simple_scripting/tab_completion.rb'
 
 describe SimpleScripting::TabCompletion do
-
   include TabCompletionCustomRSpecMatchers
 
   let(:output_buffer) {
@@ -45,9 +44,7 @@ describe SimpleScripting::TabCompletion do
   subject { described_class.new(switches_definition, output: output_buffer) }
 
   context "with a correct configuration" do
-
     context "standard cases" do
-
       # Note that the conversion of mandatory to optional argument is defined by most of the cases.
       #
       STANDARD_CASES = {
@@ -79,11 +76,9 @@ describe SimpleScripting::TabCompletion do
           expect(symbolic_commandline_options).to complete_with(expected_entries)
         end
       end
-
     end # context "standard cases"
 
     context "suffix management" do
-
       SUFFIX_CASES = {
         "arg1<tab>v"        => %w(arg1v1 arg1v2), # the execution target of the test suite doesn't
         "arg1<tab>x"        => %w(),              # ignore the suffix; programmer-defined
@@ -97,11 +92,9 @@ describe SimpleScripting::TabCompletion do
           expect(symbolic_commandline_options).to complete_with(expected_entries)
         end
       end
-
     end # context "suffix management"
 
     context "escaped cases" do
-
       ESCAPED_CASES = {
         "\ <tab>"           => [" _argv1spc"],
         '\-<tab>'           => %w(),                       # this is the result of typing `command "\-<tab>`
@@ -111,7 +104,6 @@ describe SimpleScripting::TabCompletion do
       ESCAPED_CASES.each do |symbolic_commandline_options, _|
         it "should output the entries for #{symbolic_commandline_options.inspect}"
       end
-
     end # context "escaped cases"
 
     it "should support multiple values for an option"
@@ -119,11 +111,9 @@ describe SimpleScripting::TabCompletion do
     it "should keep parsing also when --help is passed" do
       expect("--help a<tab>").to complete_with(%w(arg1v1 arg1v2))
     end
-
   end # context "with a correct configuration"
 
   context "with an incorrect configuration" do
-
     INCORRECT_CASES = [
       "a b <tab>",        # too many args
       "-O<tab>",          # no values for this option
@@ -134,7 +124,5 @@ describe SimpleScripting::TabCompletion do
         expect(symbolic_commandline_options).to not_complete
       end
     end
-
   end # context "with an incorrect configuration"
-
 end # describe SimpleScripting::TabCompletion

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_scripting
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.0
 platform: ruby
 authors:
 - Saverio Miroddi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-13 00:00:00.000000000 Z
+date: 2022-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parseconfig
@@ -99,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Library for simplifying some typical scripting functionalities.