simple_scripting 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b48ec9aa43f6c12c254cb2fbee5a3edc83ec0163
-  data.tar.gz: eb52ce4f6ead68bf0a862212dd85fda7494fd0c8
+  metadata.gz: 59993d0d200b77aa1deb2aadda05560b427cee00
+  data.tar.gz: 1baeb57678e05f4fac32cf8d34afb42b175d5b08
 SHA512:
-  metadata.gz: 82969adc5d00c028c8a378342df4bd02bc384dfee01c9c73efae1199ec469f6e4334f17e6fd14544a3a8ead295cec5f0fcdb2bdf41737ce427bb4e47ed7bb2b9
-  data.tar.gz: 74e6fcd47cbca2d77304a35d2d005dde2ec408e6e6fb1eb8fec5690765283970bc5c759b3a4654b541db08924f86d3842ee7ae147dfd906d0e74ca26e2a1cf44
+  metadata.gz: a06e70451f2b78d8833edaa7649c7ac9130920aca97b2cd9ec171ca3db30a370a65fd15a120a05256f29289bc3e66cad8202c8a8e0f4ea3c04c47ce7ba09d0a3
+  data.tar.gz: 52cf1615fa2ca5b6f8c1147176ba3859cccc856b613fba1a178d21185bd826f9005cd1d6d88d6fd602e3d8646c267dab4d2a7321357a3c7fe8563c0869821363

data/README.md

@@ -15,6 +15,8 @@
 
 This is a definition example:
 
+    require 'simple_scripting/argv'
+
     result = SimpleOptParse::Argv.decode(
       ['-s', '--only-scheduled-days',     'Only print scheduled days'                           ],
       ['-d', '--print-defaults TEMPLATE', 'Print the default activities from the named template'],
@@ -61,6 +63,7 @@ Say one writes a script (`foo_my_bar.rb`), with a corresponding (`$HOME/.foo_my_
 
     some_relative_file_path=foo
     some_absolute_file_path=/path/to/bar
+    multiple_paths=foo:/path/to/bar
     my_password=uTxllKRD2S+IH92oi30luwu0JIqp7kKA
 
     [a_group]
@@ -68,6 +71,8 @@ Say one writes a script (`foo_my_bar.rb`), with a corresponding (`$HOME/.foo_my_
 
 This is the workflow and functionality offered by `SS::C`:
 
+    require 'simple_scripting/configuration'
+
     # Picks up automatically the configuration file name, based on the calling program
     #
     configuration = SimpleScripting::Configuration.load(passwords_key: 'encryption_key')
@@ -75,6 +80,7 @@ This is the workflow and functionality offered by `SS::C`:
     configuration.some_relative_file_path.full_path # '$HOME/foo'
     configuration.some_absolute_file_path           # '/path/to/bar'
     configuration.some_absolute_file_path.full_path # '/path/to/bar' (recognized as absolute)
+    configuration.multiple_paths.full_paths         # ['$HOME/foo', '/path/to/bar']
 
     configuration.my_password.decrypted             # 'encrypted_value'
 
@@ -85,3 +91,7 @@ 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.

data/lib/simple_scripting/argv.rb

@@ -6,7 +6,7 @@ module SimpleScripting
 
     extend self
 
-    def decode(*params_definition, arguments: ARGV, long_help: nil, output: $stdout)
+    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.
       #
@@ -25,7 +25,7 @@ module SimpleScripting
           print_optparse_commands_help(commands_definition, output, true)
           output == $stdout ? exit : return
         else
-          return [command, decode(*command_params_definition, arguments: arguments, output: output)]
+          return [command, decode(*command_params_definition, arguments: arguments, output: output, command: command)]
         end
       end
 
@@ -33,8 +33,8 @@ module SimpleScripting
       parser_opts_ref  = nil  # not available outside the block
       args             = {}   # { 'name' => mandatory? }
 
-      OptionParser.new do | parser_opts |
-        params_definition.each do | param_definition |
+      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?('--')
@@ -61,8 +61,8 @@ module SimpleScripting
           end
         end
 
-        parser_opts.on( '-h', '--help', 'Help' ) do
-          print_optparse_help( parser_opts, args, long_help, output )
+        parser_opts.on('-h', '--help', 'Help') do
+          print_optparse_help(parser_opts, args, long_help, output, command: command)
           output == $stdout ? exit : return
         end
 
@@ -76,29 +76,29 @@ module SimpleScripting
         # Mandatory?
         if args.fetch(first_arg_name.to_sym)
           if arguments.empty?
-            print_optparse_help( parser_opts_ref, args, long_help, output )
+            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
+            name = args.keys.first[1..-1].to_sym
 
-            result[ name ] = arguments
+            result[name] = arguments
           end
         # Optional
         else
-          name = args.keys.first[ 1 .. - 1 ].to_sym
+          name = args.keys.first[1..-1].to_sym
 
-          result[ name ] = arguments
+          result[name] = arguments
         end
       else
-        min_args_size = args.count { | name, mandatory | mandatory }
+        min_args_size = args.count { |name, mandatory| mandatory }
 
         case arguments.size
         when (min_args_size .. args.size)
-          arguments.zip(args) do | value, (name, mandatory) |
+          arguments.zip(args) do |value, (name, mandatory)|
             result[name] = value
           end
         else
-          print_optparse_help(parser_opts_ref, args, long_help, output)
+          print_optparse_help(parser_opts_ref, args, long_help, output, command: command)
           output == $stdout ? exit : return
         end
       end
@@ -113,9 +113,17 @@ module SimpleScripting
       output.puts "Valid commands:", "", "  " + commands_definition.keys.join(', ')
     end
 
-    def print_optparse_help(parser_opts, args, long_help, output)
-      args_display = args.map { | name, mandatory | mandatory ? "<#{ name }>" : "[<#{ name }>]" }.join(' ')
-      parser_opts_help = parser_opts.to_s.sub!(/^(Usage: .*)/, "\\1 #{args_display}")
+    def print_optparse_help(parser_opts, args, long_help, output, command: nil)
+      parser_opts_help = parser_opts.to_s
+
+      if command
+        parser_opts_help = parser_opts_help.sub!(/(\[options\])/, "#{command} \\1")
+      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}")
+      end
 
       output.puts parser_opts_help
       output.puts "", long_help if long_help

data/lib/simple_scripting/configuration/value.rb

@@ -24,6 +24,10 @@ module SimpleScripting
         start_with?('/') ? self : File.expand_path(self, '~')
       end
 
+      def full_paths
+        split(':').map { |value| self.class.new(value).full_path }
+      end
+
       def decrypted
         raise "Encryption key not provided!" if @encryption_key.nil?
 

data/lib/simple_scripting/version.rb

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

data/spec/simple_scripting/argv_spec.rb

@@ -183,7 +183,7 @@ Invalid command. Valid commands:
         expect(output_buffer.string).to eql(expected_output)
       end
 
-      it 'should implement the help' do
+      it 'should implement the commands help' do
         decoder_params[:arguments] = ['-h']
 
         described_class.decode(decoder_params)
@@ -197,17 +197,28 @@ Valid commands:
         expect(output_buffer.string).to eql(expected_output)
       end
 
+      it "should display the command given command's help" do
+        decoder_params[:arguments] = ['command1', '-h']
+$a = true
+        described_class.decode(decoder_params)
+
+        expected_output = %Q{\
+Usage: rspec command1 [options] <arg1>
+    -h, --help                       Help
+}
+
+        expect(output_buffer.string).to eql(expected_output)
+      end
+
     end
 
-    describe 'pitfall' do
+    describe 'No argv case' do
 
       let(:decoder_params) {{
         output:     output_buffer,
       }}
 
-      # Make sure that the options (in this case, :output) are not interpreted as commands definition.
-      #
-      it 'should be avoided' do
+      it 'should avoided options being interpreted as definitions' do
         decoder_params[:arguments] = ['pizza']
 
         actual_result = described_class.decode(decoder_params)

data/spec/simple_scripting/configuration_spec.rb

@@ -23,6 +23,7 @@ describe SimpleScripting::Configuration do
   let(:configuration_text) {"
 abspath_key=/tmp/bar
 relpath_key=foo
+mixed_multiple_paths_key=/tmp/bar:foo
 encr_key=uTxllKRD2S+IH92oi30luwu0JIqp7kKA
 
 [group1]
@@ -40,6 +41,8 @@ g2_key=bang
 
       expect(configuration.relpath_key.full_path).to eql(File.expand_path('foo', '~'))
 
+      expect(configuration.mixed_multiple_paths_key.full_paths).to eql(['/tmp/bar', File.expand_path('foo', '~')])
+
       expect(configuration.encr_key.decrypted).to eql('encrypted_value')
 
       expect(configuration.group1.g_key).to eql('baz')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_scripting
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Saverio Miroddi