rake-commander 0.3.6 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81af760fc8b135dae5ced0487cb346032eb088df3596bef256e2fe0d97f6c09e
-  data.tar.gz: af9ed108e3436eae5c705b43070066c2e208d816ef0b7f5dc497cf4f46e6f15a
+  metadata.gz: 5a73808173b38457d53944c3dc6d62f739746133a6d42f0b306a5d4bb40b3d23
+  data.tar.gz: 9f2d2754d5464e0d34fe3db2f2fcddba471652936d8e8ea73106cb33bd044e02
 SHA512:
-  metadata.gz: 42d7b3bdc73a577f5c149323a119e36c5dfa43ae0796548fe9f5f5acf9cc833f73f805c15dc14ddb132d6f932222b8f57258de81adec4320a46629f6c585e977
-  data.tar.gz: 0bcb309f5284ca49bb3af8493313b78fd9f86c75facc1ba3d8aaf419560bfff6d488dc15b7d4420668bcb745463f79c5812a1f5f467e2c9f777840a3d1fdcd77
+  metadata.gz: caf48388e42c830e15d761a97354291c9354b94652de4e7b0f059f10303d57467970769497980cae1f2aa7eaf7559e4c5f404e9e98e34cc094ee67b256627cf1
+  data.tar.gz: 41e1c1afd1cb0613a9fc2c10348e7b0bb2c54c1abbbfb8d839c60edd10c827400a8777adf74f84fe54694489103a5b89f580e2b4d0d8a586b1a8ec132bc4ce72

data/.markdownlint.json

@@ -0,0 +1,4 @@
+{
+  "MD013": false,
+  "MD024": false
+}

data/.rubocop.yml

@@ -1,80 +1,93 @@
 AllCops:
-  TargetRubyVersion: 2.7.2
-  Exclude:
-    - 'config/routes.rb'
+  TargetRubyVersion: 3.2.2
+  NewCops: enable
 
-Naming/VariableNumber:
-  EnforcedStyle: snake_case
-Naming/FileName:
-  Enabled: false
-
-Metrics/LineLength:
-  Enabled: false
-Metrics/BlockLength:
-  ExcludedMethods: [context, describe]
-  Max: 50
-Metrics/MethodLength:
-  Max: 50
 Metrics/ClassLength:
-  Max: 200
+  Max: 500
 Metrics/ModuleLength:
-  Max: 200
+  Max: 300
+Metrics/MethodLength:
+  Max: 50
 Metrics/AbcSize:
+  Max: 30
+Metrics/ParameterLists:
+  Max: 5
+  CountKeywordArgs: false
+Metrics/BlockLength:
+  CountAsOne: ['array', 'heredoc', 'method_call']
   Max: 50
 Metrics/CyclomaticComplexity:
-  Max: 10
+  Max: 30
 Metrics/PerceivedComplexity:
-  Max: 10
+  Max: 30
 
-ParameterLists:
-  Max: 5
-  CountKeywordArgs: false
-
-Style/Alias:
-  EnforcedStyle: prefer_alias_method
-Style/StringLiterals:
+Style/AccessorGrouping:
   Enabled: false
-Style/FrozenStringLiteralComment:
+Style/ConditionalAssignment:
   Enabled: false
-Style/CommentedKeyword:
+Style/BlockDelimiters:
+  BracesRequiredMethods: ['log']
+  AllowedPatterns: ['proc', 'new']
+Style/ClassAndModuleChildren:
   Enabled: false
-Style/MultilineBlockChain:
+Style/FrozenStringLiteralComment:
   Enabled: false
-Style/Documentation:
+Style/StringLiterals:
   Enabled: false
 Style/StringLiteralsInInterpolation:
   Enabled: false
-Style/AndOr:
+Style/Documentation:
   Enabled: false
-Style/SlicingWithRange:
+Style/CommentedKeyword:
   Enabled: false
-Style/ClassAndModuleChildren:
+Style/MultilineBlockChain:
   Enabled: false
-Style/OptionalBooleanParameter:
+Style/AndOr:
+  Enabled: false
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+Style/FetchEnvVar:
   Enabled: false
+Style/RegexpLiteral:
+  EnforcedStyle: mixed
+  AllowInnerSlashes: true
 
 Layout/HashAlignment:
   EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+Layout/LeadingCommentSpace:
+  Enabled: false
+  AllowGemfileRubyComment: true
+Layout/ParameterAlignment:
+  Enabled: false
+Layout/MultilineMethodDefinitionBraceLayout:
+  EnforcedStyle: symmetrical
+Layout/LineLength:
+  Enabled: true
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+Layout/SpaceInsideBlockBraces:
+  Enabled: false
+Layout/SpaceAroundOperators:
+  Enabled: false
 Layout/ExtraSpacing:
   AllowForAlignment: true
+  AllowBeforeTrailingComments: true
 Layout/AccessModifierIndentation:
   EnforcedStyle: indent
 Layout/DotPosition:
   EnforcedStyle: trailing
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
-Layout/SpaceInsideHashLiteralBraces:
-  Enabled: false
-Layout/SpaceInsideBlockBraces:
-  Enabled: false
-Layout/SpaceAroundOperators:
-  Enabled: false
 Layout/FirstHashElementIndentation:
   Enabled: false
 Layout/EmptyLineAfterGuardClause:
   Enabled: false
-Layout/LeadingCommentSpace:
-  Enabled: false
 
-Lint/AssignmentInCondition:
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+  CheckSymbols: false
+Naming/MethodParameterName:
+  AllowedNames: ['x', 'y', 'i', 'j', 'id', 'io', 'to']
+Naming/RescuedExceptionsVariableName:
   Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/CHANGELOG.md

@@ -1,175 +1,203 @@
 # Change Log
+
 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
-    - Include the symbol name keys (configurable). Note that dash will be replaced by underscore.
-  - Type Coercions
-    - Add a way to define/redefine a set and use them.
-    - 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`
-    - Configuration: allow to define option override behaviour and whether it should trigger an exception
-  - Error handlers
-    - See if it would be possible to parse all the valid options so we get all the valid results before some error is raised. Although this can be achieved with `OptionParser#order!`, it destroys switches; which would require to give it two parsing shots whenever there is an error.
-      - It should be ensured that the parsed options results object is remains the same.
-      - Think about options that modify other options. Technically this should be hold only at behaviour level
-    - This would allow to make the order of the options irrelevant when it comes to modify error handling behaviour via options themselves.
-  - Rake task parameters (see: https://stackoverflow.com/a/825832/4352306 & https://stackoverflow.com/a/825832/4352306)
-  - Add `enhance` functionality (when a task is invoked it runs before it; declared with `task` as well)
-  - Add `no_short` option (which should give the result of that option with the option name key)
-  - Add `on_option` handler at instance level, so within a `task` definition, we can decide certain things, such as if the functionality should be active when the `self.class` does not have that option.
-    * This is specially useful to be able to extend through inheritance chain, where we extend `task` (rather than redefining it), but we don't want options we removed (with `option_remove`) to throw unexpected results.
-    * Example: `on_option(:t, defined: true) {|option| do-stuff}` <- block to be called only if the option is defined in the class (alternative: `defined: :only`)
-    * Example: `on_option(:t, defined: false) {|option| do-stuff}` <- block to be called regardless the option exists (alternative: `defined: :ignore`)
-    * 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?`)
-
-
-## [0.3.7] - 2023-05-xx
+
+- 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
+  - Include the symbol name keys (configurable). Note that dash will be replaced by underscore.
+- Type Coercions
+  - Add a way to define/redefine a set and use them.
+  - 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`
+  - Configuration: allow to define option override behaviour and whether it should trigger an exception
+- Error handlers
+  - See if it would be possible to parse all the valid options so we get all the valid results before some error is raised. Although this can be achieved with `OptionParser#order!`, it destroys switches; which would require to give it two parsing shots whenever there is an error.
+    - It should be ensured that the parsed options results object is remains the same.
+    - Think about options that modify other options. Technically this should be hold only at behaviour level
+  - This would allow to make the order of the options irrelevant when it comes to modify error handling behaviour via options themselves.
+- Rake task parameters (see: <https://stackoverflow.com/a/825832/4352306> & <https://stackoverflow.com/a/825832/4352306>)
+- Add `enhance` functionality (when a task is invoked it runs before it; declared with `task` as well)
+- Add `no_short` option (which should give the result of that option with the option name key)
+- Add `on_option` handler at instance level, so within a `task` definition, we can decide certain things, such as if the functionality should be active when the `self.class` does not have that option.
+  - This is specially useful to be able to extend through inheritance chain, where we extend `task` (rather than redefining it), but we don't want options we removed (with `option_remove`) to throw unexpected results.
+  - Example: `on_option(:t, defined: true) {|option| do-stuff}` <- block to be called only if the option is defined in the class (alternative: `defined: :only`)
+  - Example: `on_option(:t, defined: false) {|option| do-stuff}` <- block to be called regardless the option exists (alternative: `defined: :ignore`)
+  - 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?`)
+
+## [0.4.1] - 2023-08-xx
 
 ### Added
+
 ### Fixed
+
+### Changed
+
+## [0.4.0] - 2023-08-01
+
 ### Changed
 
+- require `ruby 3`
+
 ## [0.3.6] - 2023-05-15
 
 ### Fixed
-  - `RakeCommander::Options` inheritance of options in `options_hash` was NOT doing a `dup`
+
+- `RakeCommander::Options` inheritance of options in `options_hash` was NOT doing a `dup`
 
 ### Changed
-  - `RakeCommander::Options#options_hash` made public method
+
+- `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.
+
+- `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.
+
+- `RakeCommand::Option#name` boolean form (`[no-]`) should not be part of the name.
 
 ### Changed
-  - Slight refactor to the patch
+
+- 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.
+
+- Replaced the patching method, so the `Rake` application doesn't need re-launch.
 
 ## [0.2.12] - 2023-05-01
 
 ### Fixed
-  - `RakeCommander::Option#type_coercion` wasn't correctly captured.
 
+- `RakeCommander::Option#type_coercion` wasn't correctly captured.
 
 ## [0.2.11] - 2023-05-01
 
 ### Fixed
-  - When `RakeCommander::Option#type_coercion` is `FalseClass`, it should reverse the result.
+
+- When `RakeCommander::Option#type_coercion` is `FalseClass`, it should reverse the result.
 
 ## [0.2.10] - 2023-05-01
 
 ### Fixed
-  - `RakeCommander::Options` clean `options_hash` inheritance.
 
+- `RakeCommander::Options` clean `options_hash` inheritance.
 
 ## [0.2.7] - 2023-05-01
 
 ### Fixed
-  - `RakeCommander::Option#desc` when fetching from other, should not fetch array but single value.
+
+- `RakeCommander::Option#desc` when fetching from other, should not fetch array but single value.
 
 ## [0.2.6] - 2023-05-01
 
 ### Changed
-  - `RakeCommander::Option` configure_other should only apply when the instance vars are not defined.
+
+- `RakeCommander::Option` configure_other should only apply when the instance vars are not defined.
 
 ## [0.2.5] - 2023-05-01
 
 ### Changed
-  - `RakeCommander::Base::ClassInheritable#inherited_class_value` now expects a reference to the subclass
+
+- `RakeCommander::Base::ClassInheritable#inherited_class_value` now expects a reference to the subclass
 
 ## [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.
+
+- `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.
+
+- Include Symbol option names in the parsed option results.
 
 ## [0.2.2] - 2023-04-29
 
 ### Fixed
-  - Typo in `RakeCommander::Base::ClassAutoLoader`
+
+- 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`
 
+- `RakeCommander::Option` type coercion was not being inherited
+- Typo on `coertion`: writes `coercion`
 
 ## [0.2.0] - 2023-04-28
 
 ### Added
-  - Better support for `RakeCommander::Options::Set`
-    - `RakeCommander::Options::options_use` accepts it as a parameter.
-    - Added `override` parameter to specify if this should override clashed option names.
-  - `RakeCommander::Options::class_resolver` to define the `RakeCommander::Option` class.
-    - Serves the purpose to ease class extension through inheritance.
-  - Ability to reopen options without changing the order.
-    - `RakeCommander::Options::option_reopen` which upserts (adds if not existing).
-    - New parameter `reopen` to `RakeCommander::Options::option` (redirects to the above method).
-  - Automatic option shortcuts (`implicit_shorts`) show in help and only when applicable.
-    - These are added automatically by `OptionParser`
-  - `OptionParser` leftovers trigger an error by default.
-    - This behaviour can be disabled or modified via callback/block by using `RakeCommander::Options:Error::error_on_leftovers`.
-  - Description auto **multi-line**
-    - Currently based on `RakeCommander::Options::Description::DESC_MAX_LENGTH`
-  - `RakeCommander::Options#remove_option`
-  - `RakeCommander::Options::Error::Base` and children can be raised using different methods (see `RakeCommander::Options::Error` for examples).
-    - The **task** `name` that raised the error is included in the message.
-  - `RakeCommander::Options::Error::Handling` which provides **configurability** around actions on specific option errors with a default to a general options parsing error.
+
+- Better support for `RakeCommander::Options::Set`
+  - `RakeCommander::Options::options_use` accepts it as a parameter.
+  - Added `override` parameter to specify if this should override clashed option names.
+- `RakeCommander::Options::class_resolver` to define the `RakeCommander::Option` class.
+  - Serves the purpose to ease class extension through inheritance.
+- Ability to reopen options without changing the order.
+  - `RakeCommander::Options::option_reopen` which upserts (adds if not existing).
+  - New parameter `reopen` to `RakeCommander::Options::option` (redirects to the above method).
+- Automatic option shortcuts (`implicit_shorts`) show in help and only when applicable.
+  - These are added automatically by `OptionParser`
+- `OptionParser` leftovers trigger an error by default.
+  - This behaviour can be disabled or modified via callback/block by using `RakeCommander::Options:Error::error_on_leftovers`.
+- Description auto **multi-line**
+  - Currently based on `RakeCommander::Options::Description::DESC_MAX_LENGTH`
+- `RakeCommander::Options#remove_option`
+- `RakeCommander::Options::Error::Base` and children can be raised using different methods (see `RakeCommander::Options::Error` for examples).
+  - The **task** `name` that raised the error is included in the message.
+- `RakeCommander::Options::Error::Handling` which provides **configurability** around actions on specific option errors with a default to a general options parsing error.
 
 ### Fixed
-  - `RakeCommander::Base::ClassAutoLoader`
-    - Register excluded child classes (singleton classes) into their own property,
-      rather than in the `autoloaded_children` (they are not autoloaded).
-  - Missing `rake` dependency in gemspec file.
-  - Boolean switch detection (pre-parse arguments) and parsing
-    - It adds support for boolean option names such as `--[no-]verbose`
-  - Error messaging. There were missing cases, specially with implicit short options.
-  - `RakeCommander::Options`
-    - `#option_reopen` fixed
-    - **Inheritance fixed**
+
+- `RakeCommander::Base::ClassAutoLoader`
+  - Register excluded child classes (singleton classes) into their own property,
+    rather than in the `autoloaded_children` (they are not autoloaded).
+- Missing `rake` dependency in gemspec file.
+- Boolean switch detection (pre-parse arguments) and parsing
+  - It adds support for boolean option names such as `--[no-]verbose`
+- Error messaging. There were missing cases, specially with implicit short options.
+- `RakeCommander::Options`
+  - `#option_reopen` fixed
+  - **Inheritance fixed**
 
 ### Changed
-  - Development: examples invokation via `Rake`
-  - Refactored `RakeCommander::Options` to acquire functionality through extension.
-  - `attr_inheritable` and `inheritable_class_var` are the new names of previous methods
-    - Behaviour has been changed, so you define if it should `dup` the variables, and you can pass a `block` to do the `dup` yourself. They won **NOT** `freeze` anymore, as we are mostly working at class level.
+
+- Development: examples invokation via `Rake`
+- Refactored `RakeCommander::Options` to acquire functionality through extension.
+- `attr_inheritable` and `inheritable_class_var` are the new names of previous methods
+  - Behaviour has been changed, so you define if it should `dup` the variables, and you can pass a `block` to do the `dup` yourself. They won **NOT** `freeze` anymore, as we are mostly working at class level.
 
 ## [0.1.4] - 2023-04-20
 
 ### Fixed
-  - `rubocop` offenders
-  - Added implicity `exit(0)` when wrapping the `task` block
+
+- `rubocop` offenders
+- Added implicity `exit(0)` when wrapping the `task` block
 
 ## [0.1.3] - 2023-04-20
 
 ### Fixed
-  - Reference to repo and gem
+
+- Reference to repo and gem
 
 ## [0.1.2] - 2023-04-19
 
 ### Added
-  - First commit
+
+- First commit

data/README.md

@@ -32,6 +32,10 @@ Or install it yourself as:
 
     $ gem install rake-commander
 
+## Changelog
+
+See {file:CHANGELOG.md} for a list of changes.
+
 ## Usage
 
 See [**the `examples`**](https://github.com/rellampec/rake-commander/tree/main/examples).

data/lib/rake-commander/version.rb

@@ -1,3 +1,3 @@
 class RakeCommander
-  VERSION = '0.3.6'.freeze
+  VERSION = '0.4.0'.freeze
 end

data/rake-commander.gemspec

@@ -12,17 +12,18 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/rellampec/rake-commander"
   spec.licenses      = %w[MIT]
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.required_ruby_version = '>= 3.2.2'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.7.2'
-
-  spec.add_development_dependency "bundler",   ">= 2.4.9",  "< 3"
-  spec.add_development_dependency 'dotenv',    '>= 2.7.6',  '< 3'
+  spec.add_development_dependency 'dotenv',    '~> 3'
   spec.add_development_dependency "rake",      ">= 13.0.6", "< 14"
   spec.add_development_dependency "redcarpet", ">= 3.6.0",  "< 4"
   spec.add_development_dependency "rspec",     ">= 3.10.0", "< 4"

metadata

@@ -1,53 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: rake-commander
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.0
 platform: ruby
 authors:
 - Oscar Segura Samper
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-15 00:00:00.000000000 Z
+date: 2024-08-01 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.4.9
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.4.9
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.7.6
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.7.6
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
@@ -158,8 +132,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".markdownlint.json"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
@@ -212,7 +188,8 @@ files:
 homepage: https://github.com/rellampec/rake-commander
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -221,14 +198,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.2
+      version: 3.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: Classing rake tasks with options. Creating re-usable tasks, options and samples