simple_scripting 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '089c11f5b5e04174a3b9fdf92c0b902d90d98052767f199d1a527cc024d6317d'
-  data.tar.gz: fc39e4d74a0d30bdfc7af36599442b51fd14bd7aad4a342eb3154d3467ad5a76
+  metadata.gz: 0a10422c52637cb7df7e9bacac1c8268c642f3632aaabc0db20e756178f353bb
+  data.tar.gz: 6e7a8bb568dda330e5c134465adcb2e460217181c1bf13be9d061b381cdf6657
 SHA512:
-  metadata.gz: af7f13967863d6f1fc65a37e5d3c91c8c3edb115102dccd708932be124f6ae07e1aeb1b0323d14434ff1178d53d2ccf1390d554aee69fec34ccfc5f7db539c0d
-  data.tar.gz: d9c2c31845944fa3c7df01eedb76a0cdaf4224a14b59135c66cccd6cd6c32cf64813e8962606248c01f3b19f0eccf85703f7cab830f3782df857bb45c585eb54
+  metadata.gz: 7f4443a5315920f06f596a79fd2a784cc3839b7d5746e8d4ba96ca6c12d9991c23bc4b5b9fd82979d90087740dedf71afe2ec0cb10ec150b9d45c565383db57b
+  data.tar.gz: 43ea35ead6a6720660e3ab199cec87264c9ce2d6db4646be91a33db47dc6a806a96f12061afe06b98e9cf3fbc9f15880447cf2bf8b2c9250d66b3f7b64a313b0

data/.github/workflows/ci.yml

@@ -4,21 +4,28 @@ on: [pull_request]
 
 jobs:
   test:
+    name: Test Suite
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: [head, 3.2, 3.1, 3.0, 2.7]
+        ruby-version: [head, 4.0, 3.4, 3.3, 3.2]
       fail-fast: false
-    continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' }}
+    continue-on-error: ${{ endsWith(matrix['ruby-version'], 'head') }}
     steps:
-    - uses: actions/checkout@v3
-    - run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
+    - uses: actions/checkout@v7
     - name: Set up Ruby ${{ matrix.ruby-version }}
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true
-    - name: Install dependencies
-      run: bundle install
-    - name: Run tests
-      run: bundle exec rspec
+    - run: bundle exec rspec
+  # Summary job for branch-protection rules; head failures are ignored via continue-on-error above.
+  all-tests:
+    name: All (non-head) tests passed
+    runs-on: ubuntu-latest
+    needs: [test]
+    if: always()
+    steps:
+      - name: Check test suite result
+        run: |
+          [[ "${{ needs.test.result }}" == "success" ]] || exit 1

data/.simplecov

@@ -1,6 +1,3 @@
-require 'simplecov'
-require 'coveralls'
-
-SimpleCov.formatter = Coveralls::SimpleCov::Formatter
-
-SimpleCov.add_filter '/spec/'
+SimpleCov.start do
+  add_filter '/spec/'
+end

data/Gemfile

@@ -3,10 +3,10 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'coveralls', '~> 0.8.23', require: false
+  gem 'simplecov', '~> 0.22', require: false
 end
 
 group :tools do
-  gem 'byebug', '~> 10.0.2'
+  gem 'byebug'
   gem 'rubocop', '= 0.58.1'
 end

data/README.md

@@ -1,7 +1,5 @@
 [![Gem Version][GV img]](https://rubygems.org/gems/simple_scripting)
-[![Build Status][BS img]](https://travis-ci.org/saveriomiroddi/simple_scripting)
-[![Code Climate][CC img]](https://codeclimate.com/github/saveriomiroddi/simple_scripting)
-[![Coverage Status][CS img]](https://coveralls.io/r/saveriomiroddi/simple_scripting)
+[![CI][CI img]](https://github.com/64kramsystem/simple_scripting/actions/workflows/ci.yml)
 
 # SimpleScripting
 
@@ -90,7 +88,7 @@ Note that a **recent version of Zsh is required**; the stock Ubuntu 16.04 versio
 
 ### More complex use cases
 
-For a description of the more complex use cases, including edge cases and error handling, see the [wiki](https://github.com/saveriomiroddi/simple_scripting/wiki/SimpleScripting::TabCompletion-Guide).
+For a description of the more complex use cases, including edge cases and error handling, see the [wiki](https://github.com/64kramsystem/simple_scripting/wiki/SimpleScripting::TabCompletion-Guide).
 
 ## SimpleScripting::Argv
 
@@ -151,7 +149,7 @@ Commands are also supported (with unlimited depth), by using a hash:
       }
     ) || exit
 
-For the guide, see the [wiki page](https://github.com/saveriomiroddi/simple_scripting/wiki/SimpleScripting::Argv-Guide).
+For the guide, see the [wiki page](https://github.com/64kramsystem/simple_scripting/wiki/SimpleScripting::Argv-Guide).
 
 ## SimpleScripting::Configuration
 
@@ -190,9 +188,7 @@ The purpose of encryption in this library is just to avoid displaying passwords
 
 ## Help
 
-See the [wiki](https://github.com/saveriomiroddi/simple_scripting/wiki) for additional help.
+See the [wiki](https://github.com/64kramsystem/simple_scripting/wiki) for additional help.
 
 [GV img]: https://badge.fury.io/rb/simple_scripting.png
-[BS img]: https://travis-ci.org/saveriomiroddi/simple_scripting.svg?branch=master
-[CC img]: https://codeclimate.com/github/saveriomiroddi/simple_scripting.png
-[CS img]: https://coveralls.io/repos/saveriomiroddi/simple_scripting/badge.png?branch=master
+[CI img]: https://github.com/64kramsystem/simple_scripting/actions/workflows/ci.yml/badge.svg

data/lib/simple_scripting/argv.rb

@@ -21,14 +21,13 @@ module SimpleScripting
     end
 
     class ExitWithCommandsHelpPrinting < Struct.new(:commands_definition)
-      # Note that :long_help is not used.
-      def print_help(output, long_help)
+      def print_help(output)
         output.puts "Valid commands:", "", "  " + commands_definition.keys.join(', ')
       end
     end
 
-    class ExitWithArgumentsHelpPrinting < Struct.new(:commands_stack, :args, :parser_opts_copy)
-      def print_help(output, long_help)
+    class ExitWithArgumentsHelpPrinting < Struct.new(:commands_stack, :args, :parser_opts_copy, :long_help)
+      def print_help(output)
         parser_opts_help = parser_opts_copy.to_s
 
         if commands_stack.size > 0
@@ -56,19 +55,15 @@ module SimpleScripting
       output    = options.fetch(:output, $stdout)
       raise_errors = options.fetch(:raise_errors, false)
 
-      # WATCH OUT! @long_help can also be set in :decode_command!. See issue #17.
-      #
-      @long_help = long_help
-
       exit_data = catch(:exit) do
         if params_definition.first.is_a?(Hash)
-          return decode_command!(params_definition, arguments, auto_help)
+          return decode_command!(params_definition, arguments, auto_help, long_help)
         else
-          return decode_arguments!(params_definition, arguments, auto_help)
+          return decode_arguments!(params_definition, arguments, auto_help, long_help)
         end
       end
 
-      exit_data.print_help(output, @long_help)
+      exit_data.print_help(output)
 
       nil # to be used with the 'decode(...) || exit' pattern
     rescue SimpleScripting::Argv::ArgumentError, OptionParser::InvalidOption => error
@@ -79,12 +74,10 @@ module SimpleScripting
       raise if raise_errors
 
       output.puts <<~MESSAGE
-        Command error!: #{error.message}"
+        Command error!: #{error.message}
 
         Valid commands: #{error.valid_commands.join(", ")}
       MESSAGE
-    ensure
-      @long_help = nil
     end
 
     private
@@ -120,7 +113,7 @@ module SimpleScripting
     #
     #   [{"command1"=>["arg1", {:long_help=>"This is the long help."}], "command2"=>["arg2"]}]
     #
-    def decode_command!(params_definition, arguments, auto_help, commands_stack=[])
+    def decode_command!(params_definition, arguments, auto_help, long_help, commands_stack=[])
       commands_definition = params_definition.first
 
       # Set the `command` variable only after; in the case where we print the help, this variable
@@ -157,23 +150,23 @@ module SimpleScripting
 
         # Nested case! Decode recursively
         #
-        decode_command!([command_params_definition], arguments, auto_help, commands_stack)
+        decode_command!([command_params_definition], arguments, auto_help, long_help, commands_stack)
       else
         commands_stack << command
 
         if command_params_definition.last.is_a?(Hash)
           internal_params = command_params_definition.pop # only long_help is here, if present
-          @long_help = internal_params.delete(:long_help)
+          long_help = internal_params.delete(:long_help)
         end
 
         [
           compose_returned_commands(commands_stack),
-          decode_arguments!(command_params_definition, arguments, auto_help, commands_stack),
+          decode_arguments!(command_params_definition, arguments, auto_help, long_help, commands_stack),
         ]
       end
     end
 
-    def decode_arguments!(params_definition, arg_values, auto_help, commands_stack=[])
+    def decode_arguments!(params_definition, arg_values, auto_help, long_help, commands_stack=[])
       result           = {}
       parser_opts_copy = nil  # not available outside the block
       arg_definitions  = {}   # { 'name' => mandatory? }
@@ -197,7 +190,7 @@ module SimpleScripting
         #
         parser_opts.on('-h', '--help', 'Help') do
           if auto_help
-            throw :exit, ExitWithArgumentsHelpPrinting.new(commands_stack, arg_definitions, parser_opts_copy)
+            throw :exit, ExitWithArgumentsHelpPrinting.new(commands_stack, arg_definitions, parser_opts_copy, long_help)
           else
             # Needs to be better handled. When help is required, generally, it trumps the
             # correctness of the rest of the options/arguments.
@@ -212,9 +205,9 @@ module SimpleScripting
       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)
+          process_varargs!(arg_values, result, arg_name, arg_is_mandatory)
         else
-          process_regular_argument!(arg_values, result, commands_stack, arg_name, arg_is_mandatory)
+          process_regular_argument!(arg_values, result, arg_name, arg_is_mandatory)
         end
       end
 
@@ -260,14 +253,14 @@ module SimpleScripting
       end
     end
 
-    def process_varargs!(arg_values, result, commands_stack, arg_name, arg_is_mandatory)
+    def process_varargs!(arg_values, result, arg_name, arg_is_mandatory)
       raise ArgumentError.new("Missing mandatory argument(s)") if arg_is_mandatory && arg_values.empty?
 
       result[arg_name] = arg_values.dup
       arg_values.clear
     end
 
-    def process_regular_argument!(arg_values, result, commands_stack, arg_name, arg_is_mandatory)
+    def process_regular_argument!(arg_values, result, arg_name, arg_is_mandatory)
       if arg_values.empty?
         if arg_is_mandatory
           raise ArgumentError.new("Missing mandatory argument(s)")

data/lib/simple_scripting/tab_completion.rb

@@ -29,7 +29,7 @@ module SimpleScripting
       commandline_processor = CommandlineProcessor.process_commandline(source_commandline, cursor_position, @switches_definition)
 
       if commandline_processor.completing_an_option?
-        complete_option(commandline_processor, execution_target)
+        complete_option(commandline_processor)
       elsif commandline_processor.parsing_error?
         return
       else # completing_a_value?
@@ -43,7 +43,7 @@ module SimpleScripting
     # Completion!
     #############################################
 
-    def complete_option(commandline_processor, execution_target)
+    def complete_option(commandline_processor)
       all_switches = @switches_definition.select { |definition| definition.is_a?(Array) }.map { |definition| definition[1][/^--\S+/] }
 
       matching_switches = all_switches.select { |switch| switch.start_with?(commandline_processor.completing_word_prefix) }

data/lib/simple_scripting/version.rb

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

data/simple_scripting.gemspec

@@ -8,16 +8,18 @@ Gem::Specification.new do |s|
   s.name        = "simple_scripting"
   s.version     = SimpleScripting::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.required_ruby_version = '>= 2.7.0'
+  s.required_ruby_version = '>= 3.2.0'
   s.authors     = ["Saverio Miroddi"]
-  s.date        = "2023-04-20"
+  s.date        = "2026-07-01"
   s.email       = ["saverio.pub2@gmail.com"]
-  s.homepage    = "https://github.com/saveriomiroddi/simple_scripting"
+  s.homepage    = "https://github.com/64kramsystem/simple_scripting"
   s.summary     = "Library for simplifying some typical scripting functionalities."
   s.description = "Simplifies options parsing and configuration loading."
   s.license     = "GPL-3.0"
 
   s.add_runtime_dependency     "parseconfig", "~> 1.0"
+  s.add_runtime_dependency     "ostruct",     "~> 0.6.1"
+  s.add_runtime_dependency     "base64",      "~> 0.3"
 
   s.add_development_dependency "rake",        "~> 12.0"
   s.add_development_dependency "rspec",       "~> 3.7"

data/spec/simple_scripting/argv_spec.rb

@@ -359,6 +359,19 @@ module SimpleScripting
               valid_commands: ["command1", "command2"],
             ))
           end
+
+          it "should print the invalid-command error and valid commands by default, instead of raising" do
+            decoder_params[:arguments] = ['pizza']
+
+            actual_result = described_class.decode(decoder_params)
+
+            expect(actual_result).to be(nil)
+            expect(output_buffer.string).to eql(<<~OUTPUT)
+              Command error!: Invalid command: pizza
+
+              Valid commands: command1, command2
+            OUTPUT
+          end
         end # context "error handling"
 
         context "help" do
@@ -509,5 +522,26 @@ module SimpleScripting
         }.to raise_error(Argv::ArgumentError, "Too many arguments")
       end
     end # describe 'No definitions given'
+
+    describe 'Definition/options handling' do
+      it "should work when no options hash is passed, reading ARGV" do
+        original_argv = ARGV.dup
+        ARGV.replace(['m_arg'])
+
+        begin
+          actual_result = described_class.decode('mandatory')
+
+          expect(actual_result).to eql(mandatory: 'm_arg')
+        ensure
+          ARGV.replace(original_argv)
+        end
+      end
+
+      it "should raise on an unrecognized param definition" do
+        expect {
+          described_class.decode(123, arguments: [], output: output_buffer)
+        }.to raise_error(RuntimeError, "Unrecognized value: 123")
+      end
+    end # describe 'Definition/options handling'
   end # describe Argv
 end # module SimpleScripting

data/spec/simple_scripting/configuration_spec.rb

@@ -70,4 +70,22 @@ g2_key=bang
       File.delete(temp_config_file)
     end
   end
+
+  it "should derive the default config file from the program name, when none is given" do
+    Dir.mktmpdir do |home|
+      original_home = ENV['HOME']
+      original_prog = $PROGRAM_NAME
+      ENV['HOME'] = home
+      $PROGRAM_NAME = 'my_test_prog.rb'
+
+      begin
+        described_class.load
+
+        expect(File).to exist(File.join(home, '.my_test_prog'))
+      ensure
+        ENV['HOME'] = original_home
+        $PROGRAM_NAME = original_prog
+      end
+    end
+  end
 end # describe SimpleScripting::Configuration

data/spec/spec_helper.rb

@@ -1,7 +1,6 @@
 # Coverage setup
 
-require 'coveralls'
-Coveralls.wear!
+require 'simplecov'
 
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: simple_scripting
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Saverio Miroddi
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-20 00:00:00.000000000 Z
+date: 2026-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parseconfig
@@ -24,6 +23,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,11 +107,10 @@ files:
 - spec/simple_scripting/configuration_spec.rb
 - spec/simple_scripting/tab_completion_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/saveriomiroddi/simple_scripting
+homepage: https://github.com/64kramsystem/simple_scripting
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -92,15 +118,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
-signing_key: 
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Library for simplifying some typical scripting functionalities.
 test_files: