rake-commander 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd67a354c71f5013039c3cef58f8070aed34cad128c3b753eee699f7ed7c70e2
-  data.tar.gz: f5b46e640c4395493906f80b1263b3b96636d1b60bc3880ba03d75b6abb3dd84
+  metadata.gz: e676c7895883ca91c58c1ef5a025a4a8f52795ed12ac79e2e53f304b59e5a9ee
+  data.tar.gz: 871c881ac31b06e1cf4a13bab7846d063bfee83bfcca4b332eeeb345f04c3051
 SHA512:
-  metadata.gz: d16c7a9e9dcb95466463fcc3eddab2181314d4884613d6b23003e179b881be9e6eb15d72be783e76add51b3f26cf0e9082a6e4a8115c04f9d8054086d704869b
-  data.tar.gz: 8c89aef16e4087fc5894f2033a21b09638599420a96ad6d474118e2a26ba76983e024e08ac4cec28fd811bbf7c4797bff08db6f76887b8da9fd237e5b6a36650
+  metadata.gz: 78d4f8199e7e220d26e48346fd0cd23aec273c739ee8bcd949ed12cf147191ec988f056d6ef273f5dc186e64bb71a2bc7eb33dbcbc2525f2d20278dac3ce1df2
+  data.tar.gz: 31a2dca9846b7521b43ca14d79a562f57a30fafad01af42e3a0886e4aceb3b4d43d71f8b6133f08ca538cbf9e6d5210ed82447dbfb20f70ea8ab315797dedae7

data/CHANGELOG.md

@@ -2,6 +2,8 @@
 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 Coercions
@@ -30,12 +32,24 @@ 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.2] - 2023-04-xx
+## [0.2.5] - 2023-04-xx
 
 ### Added
 ### Fixed
 ### Changed
 
+## [0.2.4] - 2023-04-30
+
+### Added
+  - `RakeCommander::Options`
+    - `::option_get` retrieves an option by name or short, may it exist.
+    - `::option?` to check if an opion exists.
+
+## [0.2.3] - 2023-04-29
+
+### Added
+  - Include Symbol option names in the parsed option results.
+
 ## [0.2.2] - 2023-04-29
 
 ### Fixed

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/option.rb

@@ -148,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)

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/options.rb

@@ -94,6 +94,18 @@ class RakeCommander
         options_hash.values.uniq
       end
 
+      # @param sym [Symbol] the `name` or `short` of the option.
+      # @return [RakeCommander::Option, NilClass] retrieves the option.
+      def option_get(sym)
+        options_hash[sym.to_sym]
+      end
+
+      # @param sym [Symbol] the `name` or `short` of the option.
+      # @return [Boolean] whether an option has been declared.
+      def option?(sym)
+        options_hash.key?(sym.to_sym)
+      end
+
       # @return [Boolean] are there options defined?
       def options?
         !options.empty?
@@ -149,7 +161,7 @@ class RakeCommander
       def implicit_shorts
         options.each_with_object({}) do |opt, implicit|
           short = opt.short_implicit
-          implicit[short] = opt unless options_hash.key?(short)
+          implicit[short] = opt unless option?(short)
         end
       end
 
@@ -159,7 +171,7 @@ class RakeCommander
       # @note `OptionParser` already has `-h --help` as a native option.
       # @param opts [OptionParser] where the help will be added.
       def option_help(opts)
-        return false if options_hash.key?(:help) || options_hash.key?(:h)
+        return false if option?(:help) || option?(:h)
         option(:h, :help, 'Prints this help') do
           puts opts
           exit(0)
@@ -191,12 +203,12 @@ class RakeCommander
       # @return [RakeCommander::Option, NilClass] the option that was added, `nil` is returned otherwise.
       def add_to_options(opt, override: true)
         name_ref = respond_to?(:name)? " (#{name})" : ''
-        if sprev = options_hash[opt.short]
+        if sprev = option_get(opt.short)
           return nil unless override
           puts "Warning#{name_ref}: Overriding option '#{sprev.name}' with short '#{sprev.short}' ('#{opt.name}')"
           delete_from_options(sprev)
         end
-        if nprev = options_hash[opt.name]
+        if nprev = option_get(opt.name)
           return nil unless override
           puts "Warning#{name_ref}: Overriding option '#{nprev.short}' with name '#{nprev.name}' ('#{opt.short}')"
           delete_from_options(nprev)

data/lib/rake-commander/version.rb

@@ -1,3 +1,3 @@
 class RakeCommander
-  VERSION = '0.2.2'.freeze
+  VERSION = '0.2.4'.freeze
 end

metadata

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