simple_scripting 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59993d0d200b77aa1deb2aadda05560b427cee00
-  data.tar.gz: 1baeb57678e05f4fac32cf8d34afb42b175d5b08
+  metadata.gz: f48ef28748f34f32e008d951c4b4d7471e5cbe4b
+  data.tar.gz: e6cd1cd8132eb9df036e0b5aff06ab0f8e2dd1ec
 SHA512:
-  metadata.gz: a06e70451f2b78d8833edaa7649c7ac9130920aca97b2cd9ec171ca3db30a370a65fd15a120a05256f29289bc3e66cad8202c8a8e0f4ea3c04c47ce7ba09d0a3
-  data.tar.gz: 52cf1615fa2ca5b6f8c1147176ba3859cccc856b613fba1a178d21185bd826f9005cd1d6d88d6fd602e3d8646c267dab4d2a7321357a3c7fe8563c0869821363
+  metadata.gz: fa2f35c9e810e06a1e29125650d071de636e4bb80ce3d9010a8eb74e006646f0a786cdab9311a33e0fb77d33d541c55724a78bb9ffb607a199db952dc7f28819
+  data.tar.gz: 4e2bdc8da33f0aeede34d91dffeff61f2e420ab633d45cd408519f60becd026d35d13f0139af655c035074792626abae88e8041b1b95bf83e0b5f376f928a946

data/.gitignore

@@ -1 +1,2 @@
 .byebug_history
+coverage/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -8,4 +8,5 @@ end
 
 group :test do
   gem 'rspec', '~> 3.6'
+  gem 'coveralls', '~> 0.8.21', require: false
 end

data/Gemfile.lock

@@ -1,7 +1,15 @@
 GEM
   remote: https://rubygems.org/
   specs:
+    coveralls (0.8.21)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.14.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
     diff-lcs (1.3)
+    docile (1.1.5)
+    json (2.1.0)
     parseconfig (1.0.8)
     rake (12.0.0)
     rspec (3.6.0)
@@ -17,11 +25,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.6.0)
     rspec-support (3.6.0)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.6.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    tins (1.15.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  coveralls (~> 0.8.21)
   parseconfig (~> 1.0)
   rake (~> 12.0)
   rspec (~> 3.6)

data/README.md

@@ -1,4 +1,8 @@
+[![Gem Version][GV img]](https://rubygems.org/gems/simple_scripting)
 [![Build Status][BS img]](https://travis-ci.org/saveriomiroddi/simple_scripting)
+[![Dependency Status][DS img]](https://gemnasium.com/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)
 
 # SimpleScripting
 
@@ -23,7 +27,7 @@ This is a definition example:
       'schedule',
       '[weeks]',
       long_help: 'This is the long help! It can span multiple lines.'
-    )
+    ) || exit
 
 which:
 
@@ -33,7 +37,7 @@ which:
 - optionally accepts the `weeks` argument,
 - automatically adds the `-h` and `--help` switches,
 - prints all the options and the long help if the help is invoked,
-- prints the help and exits if invalid parameters are passed (eg. too many).
+- exits with a descriptive error if invalid parameters are passed.
 
 This is a sample result:
 
@@ -90,8 +94,12 @@ This is the workflow and functionality offered by `SS::C`:
 
 The purpose of encryption in this library is just to avoid displaying passwords in plaintext; it's not considered safe against attacks.
 
-[BS img]: https://travis-ci.org/saveriomiroddi/simple_scripting.svg?branch=master
-
 ## Help
 
 See the [wiki](https://github.com/saveriomiroddi/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
+[DS img]: https://gemnasium.com/saveriomiroddi/simple_scripting.png
+[CC img]: https://codeclimate.com/github/saveriomiroddi/simple_scripting.png
+[CS img]: https://coveralls.io/repos/saveriomiroddi/simple_scripting/badge.png?branch=master

data/lib/simple_scripting/argv.rb

@@ -4,129 +4,200 @@ module SimpleScripting
 
   module Argv
 
+    class ExitError < StandardError; end
+
     extend self
 
-    def decode(*params_definition, arguments: ARGV, long_help: nil, output: $stdout, command: nil)
-      # If the param is a Hash, we have multiple commands. We check and if the command is correct,
-      # recursively call the function with the specific parameters.
+    def decode(*params_definition, arguments: ARGV, long_help: nil, output: $stdout)
+      # WATCH OUT! @long_help can also be set in :decode_command!. See issue #17.
       #
+      @long_help = long_help
+      @output = output
+
       if params_definition.first.is_a?(Hash)
-        command = arguments.shift
-        commands_definition = params_definition.first
+        decode_command!(params_definition, arguments)
+      else
+        decode_arguments!(params_definition, arguments)
+      end
+    rescue ExitError
+      # return nil, to be used with the 'decode(...) || exit' pattern
+    ensure
+      # Clean up the instance variables.
+      #
+      # There is a balance to strike between instance variables, and local variables
+      # passed around. One of the options, which is this case, is to set and instance
+      # variables only these two, which are constant.
 
-        if command == '-h' || command == '--help'
-          print_optparse_commands_help(commands_definition, output, false)
-          output == $stdout ? exit : return
-        end
+      @long_help = nil
+      @output = nil
+    end
 
-        command_params_definition = commands_definition[command]
+    private
 
-        if command_params_definition.nil?
-          print_optparse_commands_help(commands_definition, output, true)
-          output == $stdout ? exit : return
-        else
-          return [command, decode(*command_params_definition, arguments: arguments, output: output, command: command)]
+    # MAIN CASES ###########################################
+
+    # Input params_definition for a non-nested case:
+    #
+    #   [{"command1"=>["arg1", {:long_help=>"This is the long help."}], "command2"=>["arg2"]}]
+    #
+    def decode_command!(params_definition, arguments, commands_stack=[])
+      commands_definition = params_definition.first
+
+      # Set the `command` variable only after; in the case where we print the help, this variable
+      # must be unset.
+      #
+      command_for_check = arguments.shift
+
+      if command_for_check == '-h' || command_for_check == '--help'
+        print_optparse_commands_help(nil, commands_definition)
+      end
+
+      command = command_for_check
+      command_params_definition = commands_definition[command]
+
+      case command_params_definition
+      when nil
+        print_optparse_commands_help(command, commands_definition)
+      when Hash
+        commands_stack << command
+
+        # Nested case! Decode recursively
+        #
+        decode_command!([command_params_definition], arguments, 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)
         end
+
+        [
+          command,
+          decode_arguments!(command_params_definition, arguments, commands_stack),
+        ]
       end
+    end
 
+    def decode_arguments!(params_definition, arguments, commands_stack=[])
       result           = {}
-      parser_opts_ref  = nil  # not available outside the block
+      parser_opts_copy = nil  # not available outside the block
       args             = {}   # { 'name' => mandatory? }
 
       OptionParser.new do |parser_opts|
         params_definition.each do |param_definition|
           case param_definition
           when Array
-            if param_definition[1] && param_definition[1].start_with?('--')
-              key = param_definition[1].split(' ')[0][2 .. -1].gsub('-', '_').to_sym
-            else
-              key = param_definition[0][1 .. -1].to_sym
-            end
-
-            parser_opts.on(*param_definition) do |value|
-              result[key] = value || true
-            end
+            process_option_definition!(param_definition, parser_opts, result)
           when String
-            if param_definition.start_with?('[')
-              arg_name = param_definition[1 .. -2].to_sym
-
-              args[arg_name] = false
-            else
-              arg_name = param_definition.to_sym
-
-              args[arg_name] = true
-            end
+            process_argument_definition!(param_definition, args)
           else
             raise "Unrecognized value: #{param_definition}"
           end
         end
 
         parser_opts.on('-h', '--help', 'Help') do
-          print_optparse_help(parser_opts, args, long_help, output, command: command)
-          output == $stdout ? exit : return
+          print_optparse_arguments_help(commands_stack, args, parser_opts_copy)
         end
 
-        parser_opts_ref = parser_opts
+        parser_opts_copy = parser_opts
       end.parse!(arguments)
 
       first_arg_name = args.keys.first.to_s
 
-      # Varargs
       if first_arg_name.start_with?('*')
-        # Mandatory?
-        if args.fetch(first_arg_name.to_sym)
-          if arguments.empty?
-            print_optparse_help(parser_opts_ref, args, long_help, output, command: command)
-            output == $stdout ? exit : return
-          else
-            name = args.keys.first[1..-1].to_sym
+        process_varargs!(arguments, result, commands_stack, args, parser_opts_copy)
+      else
+        process_regular_argument!(arguments, result, commands_stack, args, parser_opts_copy)
+      end
 
-            result[name] = arguments
-          end
-        # Optional
+      result
+    end
+
+    # DEFINITIONS PROCESSING ###############################
+
+    def process_option_definition!(param_definition, parser_opts, result)
+      if param_definition[1] && param_definition[1].start_with?('--')
+        key = param_definition[1].split(' ')[0][2 .. -1].tr('-', '_').to_sym
+      else
+        key = param_definition[0][1 .. -1].to_sym
+      end
+
+      parser_opts.on(*param_definition) do |value|
+        result[key] = value || true
+      end
+    end
+
+    def process_argument_definition!(param_definition, args)
+      if param_definition.start_with?('[')
+        arg_name = param_definition[1 .. -2].to_sym
+
+        args[arg_name] = false
+      else
+        arg_name = param_definition.to_sym
+
+        args[arg_name] = true
+      end
+    end
+
+    def process_varargs!(arguments, result, commands_stack, args, parser_opts_copy)
+      first_arg_name = args.keys.first.to_s
+
+      # Mandatory argument
+      if args.fetch(first_arg_name.to_sym)
+        if arguments.empty?
+          print_optparse_arguments_help(commands_stack, args, parser_opts_copy)
         else
           name = args.keys.first[1..-1].to_sym
 
           result[name] = arguments
         end
+      # Optional
       else
-        min_args_size = args.count { |name, mandatory| mandatory }
+        name = args.keys.first[1..-1].to_sym
 
-        case arguments.size
-        when (min_args_size .. args.size)
-          arguments.zip(args) do |value, (name, mandatory)|
-            result[name] = value
-          end
-        else
-          print_optparse_help(parser_opts_ref, args, long_help, output, command: command)
-          output == $stdout ? exit : return
-        end
+        result[name] = arguments
       end
+    end
 
-      result
+    def process_regular_argument!(arguments, result, commands_stack, args, parser_opts_copy)
+      min_args_size = args.count { |_, mandatory| mandatory }
+
+      case arguments.size
+      when (min_args_size .. args.size)
+        arguments.zip(args) do |value, (name, _)|
+          result[name] = value
+        end
+      else
+        print_optparse_arguments_help(commands_stack, args, parser_opts_copy)
+      end
     end
 
-    private
+    # HELP #################################################
+
+    def print_optparse_commands_help(command, commands_definition)
+      @output.print "Invalid command. " if command
+      @output.puts "Valid commands:", "", "  " + commands_definition.keys.join(', ')
 
-    def print_optparse_commands_help(commands_definition, output, is_error)
-      output.print "Invalid command. " if is_error
-      output.puts "Valid commands:", "", "  " + commands_definition.keys.join(', ')
+      raise ExitError
     end
 
-    def print_optparse_help(parser_opts, args, long_help, output, command: nil)
-      parser_opts_help = parser_opts.to_s
+    def print_optparse_arguments_help(commands_stack, args, parser_opts_copy)
+      parser_opts_help = parser_opts_copy.to_s
 
-      if command
-        parser_opts_help = parser_opts_help.sub!(/(\[options\])/, "#{command} \\1")
+      if commands_stack.size > 0
+        parser_opts_help = parser_opts_help.sub!('[options]', commands_stack.join(' ') + ' [options]')
       end
 
       if args.size > 0
         args_display = args.map { |name, mandatory| mandatory ? "<#{ name }>" : "[<#{ name }>]" }.join(' ')
-        parser_opts_help = parser_opts_help.sub!(/^(Usage: .*)/, "\\1 #{args_display}")
+        parser_opts_help = parser_opts_help.sub!(/^(Usage: .*)/) { |text| "#{text} #{args_display}" }
       end
 
-      output.puts parser_opts_help
-      output.puts "", long_help if long_help
+      @output.puts parser_opts_help
+      @output.puts "", @long_help if @long_help
+
+      raise ExitError
     end
 
   end

data/lib/simple_scripting/version.rb

@@ -1,5 +1,5 @@
 module SimpleScripting
 
-  VERSION = "0.9.1"
+  VERSION = "0.9.2"
 
 end

data/simple_scripting.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "rake",        "~> 12.0"
   s.add_development_dependency "rspec",       "~> 3.6"
+  s.add_development_dependency 'coveralls',   "~> 0.8.21"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- spec/*`.split("\n")

data/spec/simple_scripting/argv_spec.rb

@@ -26,7 +26,7 @@ describe SimpleScripting::Argv do
     it 'should implement the help' do
       decoder_params.last[:arguments] = ['-h']
 
-      described_class.decode(*decoder_params)
+      return_value = described_class.decode(*decoder_params)
 
       expected_output = %Q{\
 Usage: rspec [options] <mandatory> [<optional>]
@@ -42,6 +42,7 @@ This is the long help!
 }
 
       expect(output_buffer.string).to eql(expected_output)
+      expect(return_value).to be(nil)
     end
 
     it "should implement basic switches and arguments (all set)" do
@@ -145,13 +146,14 @@ This is the long help!
 
   end
 
-  describe 'Multiple commands' do
+  describe 'Commands' do
 
     describe 'regular case' do
 
       let(:decoder_params) {{
         'command1' => [
-          'arg1'
+          'arg1',
+          long_help: 'This is the long help.'
         ],
         'command2' => [
           'arg2'
@@ -205,6 +207,8 @@ $a = true
         expected_output = %Q{\
 Usage: rspec command1 [options] <arg1>
     -h, --help                       Help
+
+This is the long help.
 }
 
         expect(output_buffer.string).to eql(expected_output)
@@ -212,6 +216,54 @@ Usage: rspec command1 [options] <arg1>
 
     end
 
+    describe 'Nested commands' do
+
+      let(:decoder_params) {{
+        'command1' => {
+          'nested1a' => [
+            'arg1',
+            long_help: 'nested1a long help.'
+          ],
+          'nested1b' => [
+            'arg1b'
+          ],
+        },
+        'command2' => [
+          'arg2'
+        ],
+        output:     output_buffer
+      }}
+
+      it 'should print the command1 help' do
+        decoder_params[:arguments] = ['command1', '-h']
+
+        actual_result = described_class.decode(decoder_params)
+
+        expected_output = "\
+Valid commands:
+
+  nested1a, nested1b
+"
+
+        expect(output_buffer.string).to eql(expected_output)
+      end
+
+      it 'should print the nested1a help, and long help' do
+        decoder_params[:arguments] = ['command1', 'nested1a', '-h']
+
+        actual_result = described_class.decode(decoder_params)
+
+        expected_output = "\
+Usage: rspec command1 nested1a [options] <arg1>
+    -h, --help                       Help
+
+nested1a long help.
+"
+
+        expect(output_buffer.string).to eql(expected_output)
+      end
+    end
+
     describe 'No argv case' do
 
       let(:decoder_params) {{

data/spec/spec_helper.rb

@@ -0,0 +1,51 @@
+# Coverage setup
+
+require 'coveralls'
+Coveralls.wear!
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_scripting
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Saverio Miroddi
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.21
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.21
 description: Simplifies options parsing and configuration loading.
 email:
 - saverio.pub2@gmail.com
@@ -60,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -74,6 +89,7 @@ files:
 - spec/simple_scripting/argv_spec.rb
 - spec/simple_scripting/configuration/value_spec.rb
 - spec/simple_scripting/configuration_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/saveriomiroddi/simple_scripting
 licenses:
 - GPL-3.0
@@ -94,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Library for simplifying some typical scripting functionalities.
@@ -102,3 +118,4 @@ test_files:
 - spec/simple_scripting/argv_spec.rb
 - spec/simple_scripting/configuration/value_spec.rb
 - spec/simple_scripting/configuration_spec.rb
+- spec/spec_helper.rb