simple_scripting 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a10422c52637cb7df7e9bacac1c8268c642f3632aaabc0db20e756178f353bb
-  data.tar.gz: 6e7a8bb568dda330e5c134465adcb2e460217181c1bf13be9d061b381cdf6657
+  metadata.gz: 19d1802651a6d6c7ba48675475a2031da57ccde2ca508977f35c4865897734b1
+  data.tar.gz: 81108ceef64d225fd28c2752992aba5f46053ece551e3179364426cd708c9788
 SHA512:
-  metadata.gz: 7f4443a5315920f06f596a79fd2a784cc3839b7d5746e8d4ba96ca6c12d9991c23bc4b5b9fd82979d90087740dedf71afe2ec0cb10ec150b9d45c565383db57b
-  data.tar.gz: 43ea35ead6a6720660e3ab199cec87264c9ce2d6db4646be91a33db47dc6a806a96f12061afe06b98e9cf3fbc9f15880447cf2bf8b2c9250d66b3f7b64a313b0
+  metadata.gz: 64373b69f2c72da9d253d8ad0bfa4660ca8e39de83ba3d3c7140454c71e76a82a80b33f1e5a1e885216c6ac8d573b3e0c373de1316db459e44b0a43f532f9c83
+  data.tar.gz: 6dd6a9ef7ceec62cf139f006f66a364ae881325bdfa5e2af61baad56377ce02ad8536eb440a9fc445cc110c977c7d1856655067f75707d946f61a15d901dcff5

data/.simplecov

@@ -1,3 +1,5 @@
 SimpleCov.start do
   add_filter '/spec/'
+
+  enable_coverage :branch
 end

data/README.md

@@ -182,6 +182,10 @@ This is the workflow and functionality offered by `Configuration`:
 
     configuration.a_group.group_key                 # 'baz'; also supports #full_path and #decrypted
 
+### Local configuration
+
+If a file with the same name plus the `.local` suffix exists (e.g. `$HOME/.foo_my_bar.local`), its keys are merged over the main configuration's (per-group). This is useful for keeping the main file shared across machines, with machine-specific overrides in the local one.
+
 ### Encryption note
 
 The purpose of encryption in this library is just to avoid displaying passwords in plaintext; it's not considered safe against attacks.

data/lib/simple_scripting/configuration.rb

@@ -16,11 +16,21 @@ module SimpleScripting
     def load(config_file: default_config_file, passwords_key: nil, required: [])
       create_empty_file(config_file) if !File.exist?(config_file)
 
-      configuration = ParseConfig.new(config_file)
+      params = ParseConfig.new(config_file).params
 
-      enforce_required_keys(configuration.params, required)
+      local_config_file = "#{config_file}.local"
 
-      convert_to_cool_format(OpenStruct.new, configuration.params, passwords_key)
+      if File.exist?(local_config_file)
+        local_params = ParseConfig.new(local_config_file).params
+
+        params = params.merge(local_params) do |_, value, local_value|
+          value.is_a?(Hash) && local_value.is_a?(Hash) ? value.merge(local_value) : local_value
+        end
+      end
+
+      enforce_required_keys(params, required)
+
+      convert_to_cool_format(OpenStruct.new, params, passwords_key)
     end
 
     private

data/lib/simple_scripting/tab_completion/commandline_processor.rb

@@ -8,7 +8,7 @@ module SimpleScripting
 
   class TabCompletion
 
-    class CommandlineProcessor < Struct.new(:processed_argv, :cursor_marker, :switches_definition)
+    class CommandlineProcessor < Struct.new(:processed_argv, :cursor_marker, :switches_definition, :escaped_dash)
 
       # Arbitrary; can be anything (except an empty string).
       BASE_CURSOR_MARKER = "<tab>"
@@ -27,7 +27,12 @@ module SimpleScripting
             # Remove the executable.
             processed_argv = Shellwords.split(commandline_with_marker)[1..-1]
 
-            return new(processed_argv, cursor_marker, switches_definition)
+            # Shellwords strips the backslash, losing the information that the word is a value, not
+            # an option.
+            #
+            escaped_dash = commandline_with_marker.match?(/(?:\A|\s)\\-\S*#{Regexp.escape(cursor_marker)}/)
+
+            return new(processed_argv, cursor_marker, switches_definition, escaped_dash)
           end
         end
       end
@@ -56,15 +61,23 @@ module SimpleScripting
         parsed_pairs = parse_argv || raise("Parsing error")
 
         key, value = parsed_pairs.detect do |_, value|
-          !boolean?(value) && value.include?(cursor_marker)
+          if value.is_a?(Array)
+            value.any? { |entry| entry.include?(cursor_marker) }
+          else
+            !boolean?(value) && value.include?(cursor_marker)
+          end
         end
 
         # Impossible case, unless there is a programmatic error.
         #
         key || raise("Guru meditation! (#{self.class}##{__method__}:#{__LINE__})")
 
+        value = value.detect { |entry| entry.include?(cursor_marker) } if value.is_a?(Array)
+
         value_prefix, value_suffix = value.split(cursor_marker)
 
+        value_prefix = "-#{value_prefix}" if escaped_dash
+
         parsed_pairs.delete(key)
 
         [key, value_prefix || "", value_suffix || "", parsed_pairs]
@@ -98,7 +111,10 @@ module SimpleScripting
           adapted_switches_definition[i] = "[#{definition}]" if definition.is_a?(String) && !definition.start_with?('[')
         end
 
-        SimpleScripting::Argv.decode(*adapted_switches_definition, arguments: processed_argv.dup, auto_help: false)
+        adapted_argv = processed_argv.dup
+        adapted_argv[marked_word_position] = adapted_argv[marked_word_position].delete_prefix("-") if escaped_dash
+
+        SimpleScripting::Argv.decode(*adapted_switches_definition, arguments: adapted_argv, auto_help: false)
       rescue Argv::InvalidCommand, Argv::ArgumentError, OptionParser::InvalidOption
         # OptionParser::InvalidOption: see case "-O<tab>" in test suite.
 

data/lib/simple_scripting/version.rb

@@ -1,5 +1,5 @@
 module SimpleScripting
 
-  VERSION = "0.15.0"
+  VERSION = "0.16.0"
 
 end

data/simple_scripting.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.required_ruby_version = '>= 3.2.0'
   s.authors     = ["Saverio Miroddi"]
-  s.date        = "2026-07-01"
+  s.date        = "2026-07-07"
   s.email       = ["saverio.pub2@gmail.com"]
   s.homepage    = "https://github.com/64kramsystem/simple_scripting"
   s.summary     = "Library for simplifying some typical scripting functionalities."

data/spec/simple_scripting/argv_spec.rb

@@ -45,6 +45,18 @@ module SimpleScripting
           expect(return_value).to be(nil)
         end
 
+        it 'should print help without arguments usage and long help, when they are not defined' do
+          described_class.decode(['-a'], output: output_buffer, arguments: ['-h'])
+
+          expected_output = <<~OUTPUT
+            Usage: rspec [options]
+                -a
+                -h, --help                       Help
+          OUTPUT
+
+          expect(output_buffer.string).to eql(expected_output)
+        end
+
         it 'should not interpret the --help argument, and not print the help, on auto_help: false' do
           decoder_params.last.merge!(
             arguments: ['--help', 'm_arg'],

data/spec/simple_scripting/configuration_spec.rb

@@ -51,6 +51,42 @@ g2_key=bang
     end
   end
 
+  it "should merge the .local configuration file, when present, over the main one" do
+    with_tempfile(configuration_text) do |config_file|
+      local_configuration_text = "
+relpath_key=local_foo
+
+[group1]
+g_key=local_baz
+      "
+
+      File.write("#{config_file}.local", local_configuration_text)
+
+      begin
+        configuration = described_class.load(config_file: config_file)
+
+        expect(configuration.relpath_key).to eql('local_foo')
+        expect(configuration.group1.g_key).to eql('local_baz')
+
+        # Keys not overridden are preserved.
+        expect(configuration.abspath_key).to eql('/tmp/bar')
+        expect(configuration.group2.g2_key).to eql('bang')
+      ensure
+        File.delete("#{config_file}.local")
+      end
+    end
+  end
+
+  it "should raise an error when decrypting a value without the passwords key" do
+    with_tempfile(configuration_text) do |config_file|
+      configuration = described_class.load(config_file: config_file)
+
+      expect {
+        configuration.encr_key.decrypted
+      }.to raise_error("Encryption key not provided!")
+    end
+  end
+
   it "should raise an error when required keys are missing" do
     with_tempfile(configuration_text) do |config_file|
       expect {

data/spec/simple_scripting/tab_completion_spec.rb

@@ -13,6 +13,7 @@ describe SimpleScripting::TabCompletion do
     [
       ["-o", "--opt1 ARG"],
       ["-O", "--opt2"],
+      ["-m", "--multi V1,V2"],
       "arg1",               # this and the following are internally converted to optional, as
       "arg2",               # according to the Argv spec, without brackets they are mandatory.
     ]
@@ -33,6 +34,10 @@ describe SimpleScripting::TabCompletion do
         ['arg1v1', 'arg1v2', '_arg1v3', ' _argv1spc'].select { |entry| entry =~ /^#{prefix}#{suffix}/ }
       end
 
+      def multi(prefix, suffix, context)
+        %w(multiv1 _multiv2).select { |entry| entry =~ /^#{prefix}#{suffix}/ }
+      end
+
       def arg2(prefix, suffix, context)
         # A value starting with minus is valid.
         #
@@ -57,11 +62,11 @@ describe SimpleScripting::TabCompletion do
         "a -- --<tab>"      => %w(--arg2v3),
         "-- --aaa <tab>"    => %w(arg2v1 arg2v2 --arg2v3),
 
-        "--<tab>"           => %w(--opt1 --opt2),
-        "--<tab> a"         => %w(--opt1 --opt2),
-        "--<tab> -- a"      => %w(--opt1 --opt2),
-        "--<tab> -- b"      => %w(--opt1 --opt2),
-        "--<tab> --xyz"     => %w(--opt1 --opt2),
+        "--<tab>"           => %w(--opt1 --opt2 --multi),
+        "--<tab> a"         => %w(--opt1 --opt2 --multi),
+        "--<tab> -- a"      => %w(--opt1 --opt2 --multi),
+        "--<tab> -- b"      => %w(--opt1 --opt2 --multi),
+        "--<tab> --xyz"     => %w(--opt1 --opt2 --multi),
         "--opt1 <tab> a"    => %w(opt1v1 _opt1v2),
         "--opt1 o<tab> a"   => %w(opt1v1),
 
@@ -96,17 +101,25 @@ describe SimpleScripting::TabCompletion do
 
     context "escaped cases" do
       ESCAPED_CASES = {
-        "\ <tab>"           => [" _argv1spc"],
+        '\ <tab>'           => [" _argv1spc"],
         '\-<tab>'           => %w(),                       # this is the result of typing `command "\-<tab>`
         'a \-<tab>'         => %w(--arg2v3),
       }
 
-      ESCAPED_CASES.each do |symbolic_commandline_options, _|
-        it "should output the entries for #{symbolic_commandline_options.inspect}"
+      ESCAPED_CASES.each do |symbolic_commandline_options, expected_entries|
+        it "should output the entries for #{symbolic_commandline_options.inspect}" do
+          expect(symbolic_commandline_options).to complete_with(expected_entries)
+        end
       end
     end # context "escaped cases"
 
-    it "should support multiple values for an option"
+    it "should support multiple values for an option" do
+      expect("--multi multiv1,m<tab>").to complete_with(%w(multiv1))
+    end
+
+    it "should use the next cursor marker when the commandline contains the base one" do
+      expect("a<tab0> <tab>").to complete_with(%w(arg2v1 arg2v2 --arg2v3))
+    end
 
     it "should keep parsing also when --help is passed" do
       expect("--help a<tab>").to complete_with(%w(arg1v1 arg1v2))
@@ -114,14 +127,16 @@ describe SimpleScripting::TabCompletion do
   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
-    ]
+    INCORRECT_CASES = {
+      "a b <tab>" => "Command error!: Too many arguments\n",        # too many args
+      "-O<tab>"   => "Command error!: invalid option: -<tab0>\n",   # no values for this option
+    }
 
-    INCORRECT_CASES.each do |symbolic_commandline_options|
+    INCORRECT_CASES.each do |symbolic_commandline_options, expected_error_message|
       it "should not output any entries for #{symbolic_commandline_options.inspect}" do
-        expect(symbolic_commandline_options).to not_complete
+        expect {
+          expect(symbolic_commandline_options).to not_complete
+        }.to output(expected_error_message).to_stdout
       end
     end
   end # context "with an incorrect configuration"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: simple_scripting
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Saverio Miroddi
 bindir: bin
 cert_chain: []
-date: 2026-07-01 00:00:00.000000000 Z
+date: 2026-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parseconfig