simple_command_dispatcher 3.0.4 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: affdce217794089694d86418bdc80a5901dbe7621498e9498b044250e49c6d1c
-  data.tar.gz: 269ae817ca4bb2b199daba300bbce52f3aacce51d262d81f5a17171394218564
+  metadata.gz: 0144dd27d6c3f36427f08f5c44d12960a2a3d3807b08cad71ea1599ea13e8c32
+  data.tar.gz: 7c8505c9dda676c57695c1860972b5bbe3ad693b14e3c69e0468fda3292b7a62
 SHA512:
-  metadata.gz: 6f229d94273cc3a072be9e9f1ed212c4fc50d0cc914e9ac425776912cdbdceaa706fcb80f26711317796fdade20fe6c6ad94a6bdcf39daebd4837d3825f24cef
-  data.tar.gz: ab780c6fb47d74dede8675fafd9cf381f41d6307f1800bc65996b9392a0a358a226f676975006db90a4f2094fcb82671308582918f2867e9e2dc4a943dd0c427
+  metadata.gz: afaa936a89c964a9463652cdfc46c50e0c040ce6f57cf2c4b30ffe08f500ebc00ebf7947162c65894301e008776d8c10508353a684e1d6dc060c3dfdc4ef15ed
+  data.tar.gz: d9497737a1f54a2b43d2dbd54809c8af707da645ba7ef2aace3dc9706a31db051bbe002df484a79525d940c97be3a00bc609f6879434205ef46bf7763b74874c

data/.github/workflows/ruby.yml

@@ -1,40 +1,62 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake.
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
 name: Ruby
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
   pull_request:
-    branches: [ "main" ]
+    branches: ["main"]
 
 permissions:
   contents: read
 
 jobs:
   test:
-
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        # Use `rbenv install -l` and only use the latest stable
-        # version of ruby.
-        ruby-version: ["3.0.1", "3.0.6", "3.1.4", "3.2.2"]
+        # See https://github.com/actions/runner-images
+        os:
+          [
+            ubuntu-22.04,
+            ubuntu-latest,
+            macos-13,
+            macos-14,
+            macos-15,
+            windows-2022,
+            windows-latest,
+          ]
+        # Use `rbenv install --list` to determine what stable ruby versions to test against.
+        ruby: ["3.3", "3.4"]
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Run tests
-      run: bundle exec rake
+      - uses: actions/checkout@v3
+
+      - name: Set timezone on Linux
+        if: contains(matrix.os, 'ubuntu')
+        run: sudo timedatectl set-timezone 'America/New_York'
+
+      - name: Set timezone on macOS
+        if: contains(matrix.os, 'macos')
+        run: sudo systemsetup -settimezone America/New_York
+
+      - name: Set timezone on Windows
+        if: contains(matrix.os, 'windows')
+        run: tzutil /s "Eastern Standard Time"
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Update RubyGems
+        run: gem update --system
+
+      - name: Disable bundler frozen setting
+        run: bundle config set frozen false
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

@@ -17,4 +17,7 @@
 *.code-workspace
 
 scratch.rb
+snippets.rb
 readme.txt
+
+.claude/**/*

data/.rubocop.yml

@@ -1,31 +1,22 @@
-# The behavior of RuboCop can be controlled via the .rubocop.yml
-# configuration file. It makes it possible to enable/disable
-# certain cops (checks) and to alter their behavior if they accept
-# any parameters. The file can be placed either in your home
-# directory or in some project directory.
-#
-# RuboCop will start looking for the configuration file in the directory
-# where the inspected file is and continue its way up to the root directory.
-#
-# See https://docs.rubocop.org/rubocop/configuration
-require:
-#  - rubocop-performance
-#  - rubocop-rspec
+plugins:
+  - rubocop-performance
+  - rubocop-rspec
+  - rubocop-rake
 
 AllCops:
-  SuggestExtensions: false
-  TargetRubyVersion: 3.0.1
+  TargetRubyVersion: 3.4
   NewCops: enable
   Exclude:
-    - '.git/**/*'
-    - '.idea/**/*'
-    - 'init/*'
-    - 'Rakefile'
-    - '*.gemspec'
-    - 'spec/**/*'
-    - 'vendor/**/*'
-    - 'lib/tasks/**/*'
-    - 'scratch.rb'
+    - "*.gemspec"
+    - ".git/**/*"
+    - ".idea/**/*"
+    - "Rakefile"
+    - "init/*"
+    # - "lib/tasks/*"
+    - "scratch*.rb"
+    - "snippets*.rb"
+    - "vendor/**/*"
+    - "spec/**/*"
 
 # Align the elements of a hash literal if they span more than one line.
 Layout/HashAlignment:
@@ -90,7 +81,7 @@ Layout/MultilineMethodCallIndentation:
 # Allow `debug` in tasks for now
 Lint/Debugger:
   Exclude:
-    - 'RakeFile'
+    - "RakeFile"
 
 # A calculated magnitude based on number of assignments, branches, and
 #   conditions.
@@ -102,9 +93,9 @@ Metrics/AbcSize:
 # Avoid long blocks with many lines.
 Metrics/BlockLength:
   Exclude:
-    - 'RakeFile'
-    - 'db/seeds.rb'
-    - 'spec/**/*.rb'
+    - "RakeFile"
+    - "db/seeds.rb"
+    - "spec/**/*.rb"
 
 # Avoid classes longer than 100 lines of code.
 # NOTE: This is temporarily disabled until we can eliminate existing Rubocop
@@ -112,7 +103,7 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Max: 200
   Exclude:
-    - 'spec/**/*.rb'
+    - "spec/**/*.rb"
 
 # A complexity metric that is strongly correlated to the number of test cases
 #   needed to validate a method.
@@ -122,26 +113,20 @@ Metrics/CyclomaticComplexity:
 # Limit lines to 80 characters
 Layout/LineLength:
   Exclude:
-    - 'RakeFile'
-    - 'spec/**/*.rb'
+    - "RakeFile"
+    - "spec/**/*.rb"
 
 # Avoid methods longer than 15 lines of code.
 Metrics/MethodLength:
   Max: 20
-
+  AllowedMethods:
+    - swagger_path
+    - operation
 
 # A complexity metric geared towards measuring complexity for a human reader.
 Metrics/PerceivedComplexity:
   Max: 10
 
-# Naming/FileName:
-#  Exclude:
-#    - 'lib/file.rb'
-
-# Allow `downcase == ` instead of forcing `casecmp`
-#Performance/Casecmp:
-#  Enabled: false
-
 # Require children definitions to be nested or compact in classes and modules
 Style/ClassAndModuleChildren:
   Enabled: false
@@ -166,7 +151,7 @@ Style/GuardClause:
 
 Style/MixinUsage:
   Exclude:
-    - 'RakeFile'
+    - "RakeFile"
 
 # Avoid multi-line method signatures.
 Style/MultilineMethodSignature:
@@ -195,3 +180,13 @@ Style/StringMethods:
 # Checks for use of parentheses around ternary conditions.
 Style/TernaryParentheses:
   EnforcedStyle: require_parentheses_when_complex
+
+# RSpec cops configuration
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 6
+
+RSpec/NestedGroups:
+  Max: 4

data/.ruby-version

@@ -1 +1 @@
-3.0.1
+3.4.1

data/CHANGELOG.md

@@ -1,59 +1,148 @@
-### Version 3.0.3 [2024-08-03]
-* Update ruby gems.
-* Patch CVE related to rexml gem.
-### Version 3.0.3 [2024-02-18]
-* Update ruby gems.
-### Version 3.0.2 [2024-01-31]
-* Update ruby gems.
-### Version 3.0.1 [2024-01-07]
-* Relax ruby version to Gem::Requirement.new('>= 3.0.1', '< 4.0')
-* Update ruby gems.
-### Version 3.0.0 [2023-12-27]
-* Now requires Ruby >= 3.0
-* Now requires simple_command '~> 1.0', '>= 1.0.1'; I will try to remove this dependency somehow for users who are not using simple_command.
-* Update ruby gems.
-### Version 2.0.1 [2023-12-02]
-* Update ruby gems.
-### Version 2.0.0 [2023-11-01]
-* simple_command_dispatcher now depends on ruby version >= 2.7.0
-* Update ruby gems.
-### Version 1.2.8 [2023-08-30]
-* Update ruby gems.
-### Version 1.2.7
-* Update ruby gems.
-* Miscellaneous refactors.
-### Version 1.2.6
-* Update ruby gems to patch CVE.
-### Version 1.2.5
-* Check in Gemfile.lock
-### Version 1.2.4
-* Now requires Ruby 2.6.3
-* Fix broken spec.
-* Update Ruby gems.
-* Patch CVEs: activesupport CVE-2020-8165, rake CVE-2020-8130, rdoc CVE-2021-31799, tzinfo CVE-2022-31163, yard CVE-2017-17042 and CVE-2019-1020001.
-* Fix rubocop violations.
-### Version 1.2.3
-* Refactor 'requires' in configure.rb and simple_command_dispatcher.rb
-* Update gemspec summary and description
-### Version 1.2.2
-* Bug fix
-  * Fixed NoMethodError on 'configure' metnod when trying to include configuration block in /config/initializers/simple_command_dispatcher.rb
-### Version 1.2.1
-* Configuration class
-  * Added the new Configuration class that exposes the #allow_custom_classes property which takes a Boolean allowing/disallowing the use of custom commands to be used. See the documentation for details and usage.
-* Custom commands
-  * Allow ability for users to use custom commands (i.e. classes that do not prepend the SimpleCommand module) as long as the command class respond_to? the ::call public class method. Note: Configuration#allow_custom_commands must be set to true to use custom commands.
-* Documentation updates
-  * Add documentation for new Configuration class and miscellaneous other code additions/changes.
-
-### Version 1.1.1
-* Documentation updates
-  * Add example code in README.md to include clarification on command namespacing, and how to autoload command classes to avoid NameError exceptions when SimpleCommand::Dispatcher.call(...) is call due to uninitialized command constants.
-
-## Version 1.1.0 - 2016-11-01 [YANKED]
-## Version 1.0.0 - 2016-11-01 [YANKED]
-## Version 0.2.0 - 2016-11-01 [YANKED]
-## Version 0.1.3 - 2016-11-01 [YANKED]
-## Version 0.1.2 - 2016-10-29 [YANKED]
-## Version 0.1.1 - 2016-10-29 [YANKED]
-## Version 0.1.0 - 2016-10-29 [YANKED]
+# CHANGELOG
+
+## Version 4.0.0 - 2025-07-12
+
+- **Documentation Overhaul**:
+
+  - Completely rewrote README.md with modern examples and comprehensive Rails integration guides
+  - Fixed documentation accuracy issues across all modules and classes
+  - Corrected method signatures and parameter types in YARD documentation
+  - Updated all examples to use keyword arguments and match current implementation
+  - Added comprehensive documentation for helper methods and error classes
+  - Added migration guide from v3.x to v4.x with breaking change explanations
+  - Included advanced usage patterns (route-based dispatch, batch execution, dynamic versioning)
+
+- **Test Coverage Enhancements**:
+
+  - Added comprehensive test suite for `CommandNamespaceService` (previously untested)
+  - Replaced placeholder tests with full implementations for `Camelize` and `TrimAll` helpers
+  - Added thorough test coverage for `Kernel#eigenclass` extension
+  - Created direct unit tests for custom error classes with edge case testing
+  - Improved overall test coverage with real-world scenarios and Unicode support
+  - Added extensive edge case testing for input validation and error conditions
+
+- **Helper Method Improvements**:
+
+  - Enhanced `Camelize` helper to better handle RESTful route conversion to Ruby constants
+  - Improved `TrimAll` helper with Unicode whitespace support using `\p{Space}` regex
+  - Added robust error handling and edge case management for various input types
+  - Optimized performance for route-to-constant transformations using Rails' proven methods
+  - Better handling of mixed separators (hyphens, dots, spaces, colons)
+
+- **Code Quality & Tooling**:
+
+  - Fixed RuboCop configuration errors (typo in `plugins`, removed deprecated `RSpec/NotToNot`)
+  - Added proper `RSpec/NestedGroups` configuration
+  - All RuboCop checks now pass with zero offenses
+  - Improved code organization and consistency
+
+- **Breaking Changes**:
+  - Minimum ruby version changed from 3.0.1 to 3.3
+  - Removed dependency on `simple_command` gem for lighter footprint
+  - Removed `allow_custom_commands` configuration option (all commands are now "custom")
+  - `SimpleCommandDispatcher.call` method signature changed to accept keyword arguments: `command:`, `command_namespace:`, and `request_params:`
+  - Changed gem namespace from `SimpleCommand::Dispatcher` to `SimpleCommandDispatcher`
+  - Removed `options:` parameter and all camelization options (camelization is now automatic)
+  - Fixed duplicate `Errors` namespacing on error classes under `SimpleCommandDispatcher::Errors`
+
+## Version 3.0.3 - 2024-08-03
+
+- Update Ruby gems.
+- Patch CVE related to `rexml` gem.
+
+## Version 3.0.3 - 2024-02-18
+
+- Update Ruby gems.
+
+## Version 3.0.2 - 2024-01-31
+
+- Update Ruby gems.
+
+## Version 3.0.1 - 2024-01-07
+
+- Relax Ruby version requirement to `>= 3.0.1`, `< 4.0`.
+- Update Ruby gems.
+
+## Version 3.0.0 - 2023-12-27
+
+- Now requires Ruby `>= 3.0`.
+- Now requires `simple_command` `~> 1.0`, `>= 1.0.1`.
+  - Note: Attempting to remove this dependency for users not using `simple_command`.
+- Update Ruby gems.
+
+## Version 2.0.1 - 2023-12-02
+
+- Update Ruby gems.
+
+## Version 2.0.0 - 2023-11-01
+
+- `simple_command_dispatcher` now depends on Ruby `>= 2.7.0`.
+- Update Ruby gems.
+
+## Version 1.2.8 - 2023-08-30
+
+- Update Ruby gems.
+
+## Version 1.2.7
+
+- Update Ruby gems.
+- Miscellaneous refactors.
+
+## Version 1.2.6
+
+- Update Ruby gems to patch CVE.
+
+## Version 1.2.5
+
+- Check in `Gemfile.lock`.
+
+## Version 1.2.4
+
+- Now requires Ruby `2.6.3`.
+- Fix broken spec.
+- Update Ruby gems.
+- Patch CVEs:
+  - `activesupport` (CVE-2020-8165)
+  - `rake` (CVE-2020-8130)
+  - `rdoc` (CVE-2021-31799)
+  - `tzinfo` (CVE-2022-31163)
+  - `yard` (CVE-2017-17042, CVE-2019-1020001).
+- Fix RuboCop violations.
+
+## Version 1.2.3
+
+- Refactor `requires` in `configure.rb` and `simple_command_dispatcher.rb`.
+- Update gemspec summary and description.
+
+## Version 1.2.2
+
+- **Bug Fix**:
+  - Fixed `NoMethodError` in `configure` method when trying to include configuration block in `/config/initializers/simple_command_dispatcher.rb`.
+
+## Version 1.2.1
+
+- **Configuration Class**:
+  - Added the new `Configuration` class exposing the `#allow_custom_classes` property.
+  - Allows/disallows the use of custom commands. See documentation for details and usage.
+- **Custom Commands**:
+  - Allow users to use custom commands (i.e., classes that do not prepend the `SimpleCommand` module).
+  - Commands must respond to the `::call` public class method.
+  - Note: `Configuration#allow_custom_commands` must be set to `true` to use custom commands.
+- **Documentation Updates**:
+  - Added documentation for the new `Configuration` class and miscellaneous other code additions/changes.
+
+## Version 1.1.1
+
+- **Documentation Updates**:
+  - Added example code in `README.md` to clarify command namespacing and how to autoload command classes.
+  - Helps avoid `NameError` exceptions when `SimpleCommandDispatcher.call(...)` is invoked due to uninitialized command constants.
+
+## [YANKED VERSIONS]
+
+- **Version 1.1.0** - 2016-11-01
+- **Version 1.0.0** - 2016-11-01
+- **Version 0.2.0** - 2016-11-01
+- **Version 0.1.3** - 2016-11-01
+- **Version 0.1.2** - 2016-10-29
+- **Version 0.1.1** - 2016-10-29
+- **Version 0.1.0** - 2016-10-29

data/Gemfile

@@ -11,16 +11,13 @@ gem 'rake', '>= 13.0', '< 14.0'
 
 group :development do
   gem 'pry-byebug', '>= 3.9', '< 4.0'
-  gem 'rdoc', '>= 6.4', '< 7.0'
   gem 'rubocop', '>= 1.62', '< 2.0'
   gem 'rubocop-performance', '>= 1.20', '< 2.0'
-  gem 'rubocop-rspec', '>= 2.28', '< 3.0'
+  gem 'rubocop-rake', '>= 0.6', '< 1.0'
+  gem 'rubocop-rspec', '~> 3.0', '>= 3.0.3'
 end
 
 group :test do
   gem 'rspec', '>= 3.10', '< 4.0'
-end
-
-group :documentation do
-  gem 'yard', '>= 0.9.28', '< 1.0'
+  gem 'simplecov', '>= 0.22.0', '< 1.0'
 end