rake-commander 0.2.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce1bfcde79ef608b7e13c440c626ee3ace47ec5adf3088e6fc969bf85502cc59
-  data.tar.gz: f785888cff61578247dfb1fdfed6c4e44fd076180d8be0dd1e00bf14ac0f1700
+  metadata.gz: bcd5bb7ca707d1e8e6cf543712c447cbd63061e7bbe8cfdc6e3c0c0755c338e5
+  data.tar.gz: 7b02270fbe937b0b50b6e8c4b1001005ba377c69f7a799ce97823fea42356893
 SHA512:
-  metadata.gz: 5d998c21f52d117ff59e5eb066a43cd0c5a0939a4187af2c5ee1dc3cbaead328b65d71ad67e333adf426ab465926fd56fc5830e4e7a3a7b048602f02dea39344
-  data.tar.gz: 2afaaa3bb046e6de18b13fe4b0e762dead4ace9a14b3d097c2b6c37142e7e0e0d111f5eecd9846647e50a64f13cbf8491b291d7572fafaada91cdc408400d064
+  metadata.gz: 00d05400483297153797a08d02c32fb5bde4510a829cdb158121324d1d034d62dafa3560c2a56daa6893b6bc35ee9a46a832493e2b37403a34eb949f10082fc4
+  data.tar.gz: 01c09729261196848948383dfeb356c1463086f858e4365bcfb20a043e98e521284fe45b20cf8f39ef0ab139a37fa26ce381e433974fad48c860d6ea9c377476

data/CHANGELOG.md

@@ -2,11 +2,13 @@
 All notable changes to this project will be documented in this file.
 
 ## TO DO
+  - `option_reopen` -> upsert should be optional (add `upsert: false` as default an raise missing option if not found)
+    - The error on missing short pops up where it's not clear the short was missed in the option_reopen call.
   - Option results
     - Include the symbol name keys (configurable). Note that dash will be replaced by underscore.
-  - Type Coertions
+  - Type Coercions
     - Add a way to define/redefine a set and use them.
-    - Add more supported type_coertions as native to the gem (i.e. `Symbol`)
+    - Add more supported type_coercions as native to the gem (i.e. `Symbol`)
     - Add support [for `ActiveRecord::Enum`](https://apidock.com/rails/ActiveRecord/Enum)
   - Option definitions
     - Order: `where: [:tail, :top]` and `[after, before]: :option_name`
@@ -30,12 +32,31 @@ All notable changes to this project will be documented in this file.
   - Option to globally enable/disable the 2nd patch?
     * That would make this gem completely useless.
 
-## [0.2.1] - 2023-04-xx
+## [0.2.4] - 2023-04-xx
 
 ### Added
 ### Fixed
 ### Changed
 
+## [0.2.3] - 2023-04-29
+
+### Added
+  - Include Symbol option names in the parsed option results.
+
+### Fixed
+### Changed
+
+## [0.2.2] - 2023-04-29
+
+### Fixed
+  - Typo in `RakeCommander::Base::ClassAutoLoader`
+
+## [0.2.1] - 2023-04-29
+
+### Fixed
+  - `RakeCommander::Option` type coercion was not being inherited
+  - Typo on `coertion`: writes `coercion`
+
 
 ## [0.2.0] - 2023-04-28
 

data/README.md

@@ -9,12 +9,12 @@ Rake commander is a way to declare **rake tasks** with re-usable classes. It enh
 Although the `OptionParser` ruby native class is used for parsing the options, the declaration of options, additionally to the ones of `OptionParser` comes with some **opinionated improvements** and amendments:
 
 1. It is possible to declare options as `required`
-  * This is additional to required option arguments.
-  * Options are inheritable (they get a custom `deep_dup`)
-2. An option can have a `default` value.
-  * Which can optionally be automatically used when the option accepts or requires an argument.
-3. Options parsing raises specific option errors. For a given task/class, each error type can have its own handler or preferred action.
-  * Defined error handling is inheritable and can be redefined.
+   * This is additional to required option arguments.
+   * Options are inheritable (they get a custom `deep_dup`)
+1. An option can have a `default` value.
+   * Which can optionally be automatically used when the option accepts or requires an argument.
+1. Options parsing raises specific option errors. For a given task/class, each error type can have its own handler or preferred action.
+   * Defined error handling is inheritable and can be redefined.
 
 ## Installation
 
@@ -74,10 +74,11 @@ rspec logging and results
 It supports most of options syntax of the native `OptionParser` but for a couple of exceptions perhaps:
   1. It does **NOT** support definitions or parsing of shortcuts with **embedded argument** (i.e. `-nNAME`).
   2. It does **NOT** support definitions that include equal sign (i.e. `name=NAME`, `n=NAME`)
+  3. Currently, declaring a short and a name for the option is compulsory.
 
-An argument should be explicitly declared in the `name` part:
+An argument of an option should be explicitly declared in the `name` part:
 
-```
+```ruby
   option :n, '--name NAME'
 ```
 
@@ -89,7 +90,7 @@ Although it is planned to extend the syntax, the current version shares the opti
 rake [rake-options] task1 task2 -- [shared-task-options]
 ```
 
-The double dash ` -- ` delimiter allows to modify the `ARGV` parsing behaviour of `rake`, giving room for **opinionated enhanced syntax**. Anything that comes before the double dash is feed to standard `rake`, and anything after `--` are parsed as option tasks via `rake commander`.
+The double dash ` -- ` delimiter allows to modify the `ARGV` parsing behaviour of `rake`, giving room for **opinionated enhanced syntax**. Anything that comes before the double dash is fed to standard `rake`, and anything after `--` are parsed as option tasks via `rake commander`.
 
 ```
 <rake part> -- [tasks options part]

data/examples/02_a_chainer_example.rb

@@ -24,6 +24,7 @@ class RakeCommander::Custom::Chainer < RakeCommander
   option '-m', 'method [METHOD]', default: 'system', desc: str_desc
 
   def task(*_args)
+    print_options if options[:b]
     if options[:c]
       cmd = "#{subcommand_base} -- #{subcommand_arguments.join(' ')}"
       puts "Calling --> '#{cmd}'"
@@ -51,6 +52,11 @@ class RakeCommander::Custom::Chainer < RakeCommander
 
   private
 
+  def print_options
+    puts "These are the options received:"
+    pp options
+  end
+
   def puts(str)
     return super unless options[:b]
     super "#{app_id}   #{str}   #{thread_id}"

data/examples/02_b_chained_example.rb

@@ -8,6 +8,7 @@ class RakeCommander::Custom::Chained < RakeCommander::Custom::Chainer
 
   def task(*_args)
     puts "Called !!"
+    print_options if options[:b]
     puts options[:s] if options[:s]
   end
 end

data/lib/rake-commander/base/class_auto_loader.rb

@@ -41,7 +41,7 @@ class RakeCommander
         autoloaded_namespaces(type).tap do |target|
           next if namespaces.empty?
           other_type = type == :include ? :ignore : :include
-          namespaces.each {|nm_sp| autoloaded_namespace(other_type).delete(nm_sp)}
+          namespaces.each {|nm_sp| autoloaded_namespaces(other_type).delete(nm_sp)}
           target.concat(namespaces)
         end
       end

data/lib/rake-commander/option.rb

@@ -16,7 +16,7 @@ class RakeCommander
       @default        = kargs[:default]  if kargs.key?(:default)
       @desc           = kargs[:desc]     if kargs.key?(:desc)
       @required       = kargs[:required] if kargs.key?(:required)
-      @type_coertion  = kargs[:type]     if kargs.key?(:type)
+      @type_coercion  = kargs[:type]     if kargs.key?(:type)
       @other_args     = args
       @original_block = block
       configure_other
@@ -91,8 +91,8 @@ class RakeCommander
     end
 
     # @return [Class, NilClass]
-    def type_coertion
-      @type_coertion || (default? && default.class)
+    def type_coercion
+      @type_coercion || (default? && default.class)
     end
 
     # @return [Boolean]
@@ -130,6 +130,7 @@ class RakeCommander
         kargs.merge!(name:     name_full.dup.freeze)  if name_full
         kargs.merge!(desc:     desc.dup)              if desc
         kargs.merge!(default:  default.dup)           if default?
+        kargs.merge!(type:     @type_coercion)        if @type_coercion.is_a?(Class)
         kargs.merge!(required: required?)
       end
     end
@@ -139,7 +140,7 @@ class RakeCommander
       configure_other
       args = [short_hyphen, name_hyphen]
       args.push(*switch_desc(implicit_short: implicit_short))
-      args << type_coertion if type_coertion
+      args << type_coercion if type_coercion
       args
     end
 
@@ -147,7 +148,7 @@ class RakeCommander
 
     # Called on parse runtime
     def option_block(&middleware)
-      block_extra_args = [default, short, name]
+      block_extra_args = [default, short, name, self]
       proc do |value|
         args = block_extra_args.dup.unshift(value)
         original_block&.call(*args)
@@ -228,7 +229,7 @@ class RakeCommander
     # It consumes `other_args`, to prevent direct overrides to be overriden by it.
     def configure_other
       if type = other_args.find {|arg| arg.is_a?(Class)}
-        @type_coertion = type
+        @type_coercion = type
         other_args.delete(type)
       end
       if value = other_args.find {|arg| arg.is_a?(String)}

data/lib/rake-commander/options/result.rb

@@ -24,6 +24,12 @@ class RakeCommander
         # It **re-opens** the method and adds a middleware to gather and return
         # the results of the parsing (including the `leftovers`)
         # @note this extends the method parameters and changes the returned value.
+        # @yield [value, default, short, name, option] do somethin  with parsed `value` for `option`
+        # @yieldparam value [] the resulting parsed value
+        # @yieldparam default [] the default value of the option
+        # @yieldparam short [Symbol] the symbol short of the option
+        # @yieldparam name [Symbol] the symbol name of the option
+        # @yieldparam option [RakeCommander::Option] the option that is being parsed
         # @param leftovers [Array<String>] see RakeCommander::Options#parse_options`
         # @param results [Hash] with `short` option as `key` and final value as `value`.
         # @see `RakeCommander::Options#parse_options`
@@ -66,9 +72,9 @@ class RakeCommander
         # @return [Proc] the results collector that wraps the middleware.
         def results_collector(results, &middleware)
           results = result_defaults(results)
-          proc do |value, default, short, name|
-            middleware&.call(value, default, short, name)
-            results[short] = value.nil?? default : value
+          proc do |value, default, short, name, opt|
+            middleware&.call(value, default, short, name, opt)
+            results[name] = results[short] = value.nil?? default : value
           end
         end
 
@@ -79,7 +85,7 @@ class RakeCommander
               (options_with_defaults && opt.default?) \
               || (opt.required? && opt.default?)
             end.each do |opt|
-              res_def[opt.short] = opt.default
+              res_def[opt.name] = res_def[opt.short] = opt.default
             end
           end
         end

data/lib/rake-commander/version.rb

@@ -1,3 +1,3 @@
 class RakeCommander
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.2.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rake-commander
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Oscar Segura Samper
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-27 00:00:00.000000000 Z
+date: 2023-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler