rake-commander 0.3.3 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b93ede4d58a5bc19446930380b5f9a785f7bcc404a93c1db63360dff78da2fd
-  data.tar.gz: 8113a37d4d4301b7028923aaab04734dfa38c8e3979a272750d0e0b35fb649bd
+  metadata.gz: f671966099a385b76b7e0535fb3a0e584072a5996265c5c56adb26f047bd6fa2
+  data.tar.gz: 32617c52c0773ca1aeff4b8665c197cc765c9e879866eb684310bf62523709f4
 SHA512:
-  metadata.gz: 1255ab72c7599bc831aa08ca375c4b9c4563698c9e91223184b4348c7ace025b67f0f7b11e6c9818b83774d58099c8cb14be9173f67665b96b228c22a421ad70
-  data.tar.gz: 2bac8657f4b0b43523f5343617067fb371e1a4b5ea36d0aea32679e46b523cbf497e7a0af7ef7abaaf1b3fa02c89dd0cdd8f492df2dab5ef0e1150059b4aabd0
+  metadata.gz: 2d114f3fd737cc41f659b00d5a539c110057b9371335688e94d4777853a0082c86c2473beabc5a4ed1fdbe5595879028f6bd11683ba1fccf97b86551e7d70471
+  data.tar.gz: c2afd435a3f70f2fdf7af647eb7facb2dbe89593ff668af6453d766f8f4346d87ccd25a555572873f1c74d6fd748a218b290f2150f22addfc8b9ee8501cfffe4

data/CHANGELOG.md

@@ -2,6 +2,7 @@
 All notable changes to this project will be documented in this file.
 
 ## TO DO
+  - Think if [`binstubs`](https://github.com/rbenv/rbenv/wiki/Understanding-binstubs) would offer a neater patch right on `Rake::Application#init`
   - `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
@@ -28,17 +29,35 @@ All notable changes to this project will be documented in this file.
     * Example: `on_options(:t, :s, present: true) {|options| do-stuff}` <- block to be called only when the option `:t` and `:s` are both present in the parsed `options` result.
     - Once this has been done,  think about it being a hash-alike object with methods for the option names (i.e. `options.debug?`)
 
-## DISCARDED IMPROVENTS
-  - Option to globally enable/disable the 2nd patch?
-    * That would make this gem completely useless.
 
-## [0.3.2] - 2023-05-xx
+## [0.3.7] - 2023-05-xx
 
 ### Added
 ### Fixed
 ### Changed
 
-## [0.3.2] - 2023-05-01
+## [0.3.6] - 2023-05-15
+
+### Fixed
+  - `RakeCommander::Options` inheritance of options in `options_hash` was NOT doing a `dup`
+
+### Changed
+  - `RakeCommander::Options#options_hash` made public method
+
+## [0.3.5] - 2023-05-08
+
+### Fixed
+  - `RakeCommander::Options#option_reopen` using name to reopen should not redefine if passed as Symbol.
+
+## [0.3.4] - 2023-05-08
+
+### Fixed
+  - `RakeCommand::Option#name` boolean form (`[no-]`) should not be part of the name.
+
+### Changed
+  - Slight refactor to the patch
+
+## [0.3.3] - 2023-05-01
 
 ### Changed
   - Replaced the patching method, so the `Rake` application doesn't need re-launch.

data/README.md

@@ -121,10 +121,6 @@ The double dash ` -- ` delimiter allows to modify the `ARGV` parsing behaviour o
 
 Work has been done with the aim of providing a full patch on `rake`, provided that the main invocation command remains as `rake`.
 
-To preserve `rake` as invocation command, though, the patch needs to relaunch the rake application when it has already started. The reason is that `rake` has already pre-parsed `ARGV` when `rake-commander` is loaded (i.e. from a `Rakefile`) and has identified as tasks things that are part of the task options.
-
-  * For compatibility with tasks declared using `RakeCommander`, the rake application is always relaunched. Anything that does not belong to task options should not be feed to rake tasks declared with rake commander classes.
-
 ### Patching `Rake`
 
 There is only one patch onto [`Rake::Application#top_level` method](https://github.com/ruby/rake/blob/48e798484babf725b0562cc417986da513e5d0ae/lib/rake/application.rb#L131), [`collect_command_line_tasks`](https://github.com/ruby/rake/blob/48e798484babf725b0562cc417986da513e5d0ae/lib/rake/application.rb#L782) is recalled with the arguments cut (so it does not interpret task option arguments as tasks).

data/lib/rake-commander/option.rb

@@ -32,9 +32,9 @@ class RakeCommander
 
     # Creates a new option, result of merging this `opt` with this option,
     # @return [RakeCommander::Option] where opt has been merged
-    def merge(opt)
+    def merge(opt, **kargs)
       raise "Expecting RakeCommander::Option. Given: #{opt.class}" unless opt.is_a?(RakeCommander::Option)
-      dup(**opt.dup_key_arguments, &opt.original_block)
+      dup(**opt.dup_key_arguments.merge(kargs), &opt.original_block)
     end
 
     # @return [Boolean] whether this option is required.

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

@@ -127,9 +127,8 @@ class RakeCommander
       # @see #name_sym
       # @return [Symbol, NilClass]
       def name_word_sym(value)
-        return nil unless value = name_sym(value)
         value = value.to_s.gsub(BOOLEAN_TOKEN, '')
-
+        return nil unless value = name_sym(value)
         return nil unless value = name_words(value).first
         value.downcase.to_sym
       end

data/lib/rake-commander/options.rb

@@ -16,7 +16,7 @@ class RakeCommander
         base.attr_inheritable :banner
         base.attr_inheritable(:options_hash) do |value, subclass|
           next nil unless value
-          value.values.uniq.each {|opt| subclass.send :add_to_options, opt}
+          value.values.uniq.each {|opt| subclass.send :add_to_options, opt.dup}
           subclass.send(:options_hash)
         end
         base.class_resolver :option_class, RakeCommander::Option
@@ -44,6 +44,8 @@ class RakeCommander
       end
 
       # It re-opens an option for edition. If it does not exist, it **upserts** it.
+      # @note To allow reopen using the name without modifying the argument, use a Symbol
+      #   Example: `option_reopen :opt_with_arg` will keep the argument of 'opt_with_arg'
       # @note
       #   1. If `override` is `false, it will fail to change the `name` or the `short`
       #     when they are already taken by some other option.
@@ -54,7 +56,10 @@ class RakeCommander
         aux = option_class.new(*args, **kargs, sample: true, &block)
         opt = options_hash.values_at(aux.name, aux.short).compact.first
         return option(*args, **kargs, &block) unless opt
-        replace_in_options(opt, opt.merge(aux), override: override)
+        mod = {}.tap do |mkargs|
+          mkargs.merge!(name: opt.name_full) if aux.name_full.is_a?(Symbol)
+        end
+        replace_in_options(opt, opt.merge(aux, **mod), override: override)
       end
 
       # Removes options with short or name `keys` from options
@@ -91,6 +96,16 @@ class RakeCommander
         options_parser(&middleware).send(method, argv)
       end
 
+      # The options indexed by the short and the name (so doubled up in the hash).
+      # @param with_implicit [Boolean] whether free implicit shorts of declared options should be included
+      #   among the keys (pointing to the specific option that has it implicit).
+      # @return [Hash] with Symbol name and shorts as keys, and `RakeCommander::Option` as values.
+      def options_hash(with_implicit: false)
+        @options_hash ||= {}
+        return @options_hash unless with_implicit
+        @options_hash.merge(implicit_shorts)
+      end
+
       # List of configured options
       # @return [Array<RakeCommander::Option>]
       def options
@@ -143,16 +158,6 @@ class RakeCommander
         OptionParser.new(&block)
       end
 
-      # The options indexed by the short and the name (so doubled up in the hash).
-      # @param with_implicit [Boolean] whether free implicit shorts of declared options should be included
-      #   among the keys (pointing to the specific option that has it implicit).
-      # @return [Hash] with Symbol name and shorts as keys, and `RakeCommander::Option` as values.
-      def options_hash(with_implicit: false)
-        @options_hash ||= {}
-        return @options_hash unless with_implicit
-        @options_hash.merge(implicit_shorts)
-      end
-
       # This covers the gap where `OptionParser` auto-generates shorts out of option names.
       # @note `OptionParser` implicitly generates a short for the option name. When defining
       #   an option that uses this short, the short gets overriden/reused by the explicit option.

data/lib/rake-commander/patcher/application/top_level_resume.rb

@@ -26,10 +26,21 @@ class RakeCommander
           # when `Rake::Application` requires the `Rakefile` that loads `rake-commander`,
           # we technically only need to fix the `top_level_tasks` that have been detected.
           def top_level
+            RakeCommander.rectify_rake_application
+            super
+          end
+        end
+
+        module ClassMethods
+          include RakeCommander::Patcher::Debug
+
+          # Reloading `Rakefile` has drawbacks around `require` only being launched once per
+          # dependency. Apparently some tasks of some gems are installed at `require` run-time.
+          # This requires to keep known tasks when we switch the application.
+          def rectify_rake_application
             RakeCommander.self_load_reset
             argv = RakeCommander.argv_rake_native_arguments(ARGV)
             Rake.application.send(:collect_command_line_tasks, argv)
-            super
           end
         end
       end

data/lib/rake-commander/version.rb

@@ -1,3 +1,3 @@
 class RakeCommander
-  VERSION = '0.3.3'.freeze
+  VERSION = '0.3.5'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rake-commander
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.5
 platform: ruby
 authors:
 - Oscar Segura Samper
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-01 00:00:00.000000000 Z
+date: 2023-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -228,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
 summary: Classing rake tasks with options. Creating re-usable tasks, options and samples