simple_command_dispatcher 3.0.2 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa98d701eb28cf475d72e5a4b2c3583f2efddccce1d5fa1c93678d7d9d7e2064
-  data.tar.gz: 66edc60249913db9118cc486783ca7b4fd1ffea813988c0c35039bf434426ea8
+  metadata.gz: 417dc02ceb788cc887a1131e3a01f1c4e35d981e1a6adddcc9b127e015165277
+  data.tar.gz: 2281645d67460eb71041d3860e343a632f95d0fec0e4011a5928e50d8ae8ec6f
 SHA512:
-  metadata.gz: 707b0d03278d1727a51930cc4b071539c1000e18a79b7a9c1e4345b823f75e8baafe7d0c8436a47eeda0872f7661c23b223b817eea0462de19d9f43ecbc78f26
-  data.tar.gz: e01869b77c22e45aee30c45542761f1b6db01bef7f16fd616e8a487b9aba663e19c925877ff53de5c4ac051c3c44751409b6ae3a4776f0e7f7ed7d269059a25e
+  metadata.gz: 75b4dd400bb1d39a718f852e94a95d79ed595e82bdcd1e26ffc8991693a95d2d8e4e68a60031b78a41907dfb1c6c09bccf6c0c84b38909de0bd32ef89e972b34
+  data.tar.gz: 6a4dc18d0364dfd93ca75137729beae59b48655b9ddbbcf5d2bd5a79fa9469a00e239d23214ed17ffddfcef1a8fa52ae30b71e48776ae75527203afe28bb9500

data/.rubocop.yml

@@ -13,7 +13,8 @@ require:
   - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.7.0
+  SuggestExtensions: false
+  TargetRubyVersion: 3.0.1
   NewCops: enable
   Exclude:
     - '.git/**/*'
@@ -127,9 +128,6 @@ Layout/LineLength:
 # Avoid methods longer than 15 lines of code.
 Metrics/MethodLength:
   Max: 20
-  IgnoredMethods:
-    - swagger_path
-    - operation
 
 
 # A complexity metric geared towards measuring complexity for a human reader.

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+### 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]

data/Gemfile

@@ -7,11 +7,20 @@ gemspec
 
 gem 'bundler', '~> 2.5', '>= 2.5.3'
 gem 'colorize', '>= 0.8.1', '< 2.0'
-gem 'pry-byebug', '>= 3.9', '< 4.0'
 gem 'rake', '>= 13.0', '< 14.0'
-gem 'rdoc', '>= 6.4', '< 7.0'
-gem 'rspec', '>= 3.10', '< 4.0'
-gem 'rubocop', '>= 1.35', '< 2.0'
-gem 'rubocop-performance', '>= 1.14', '< 2.0'
-gem 'rubocop-rspec', '~> 2.25'
-gem 'yard', '>= 0.9.28', '< 1.0'
+
+group :development do
+  gem 'pry-byebug', '>= 3.9', '< 4.0'
+  gem 'rdoc', '>= 6.4', '< 7.0'
+  gem 'rubocop', '>= 1.35', '< 2.0'
+  gem 'rubocop-performance', '>= 1.14', '< 2.0'
+  gem 'rubocop-rspec', '~> 2.25'
+end
+
+group :test do
+  gem 'rspec', '>= 3.10', '< 4.0'
+end
+
+group :documentation do
+  gem 'yard', '>= 0.9.28', '< 1.0'
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simple_command_dispatcher (3.0.2)
+    simple_command_dispatcher (3.0.3)
       activesupport (>= 7.0.8, < 8.0)
       simple_command (~> 1.0, >= 1.0.1)
 
@@ -34,7 +34,7 @@ GEM
     json (2.7.1)
     language_server-protocol (3.17.0.3)
     method_source (1.0.0)
-    minitest (5.21.2)
+    minitest (5.22.2)
     mutex_m (0.2.0)
     parallel (1.24.0)
     parser (3.3.0.5)
@@ -55,19 +55,19 @@ GEM
       psych (>= 4.0.0)
     regexp_parser (2.9.0)
     rexml (3.2.6)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.6)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.0)
     rubocop (1.60.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)

data/README.md

@@ -1,6 +1,6 @@
 [![Ruby](https://github.com/gangelo/simple_command_dispatcher/actions/workflows/ruby.yml/badge.svg?refresh=2)](https://github.com/gangelo/simple_command_dispatcher/actions/workflows/ruby.yml)
-[![GitHub version](https://badge.fury.io/gh/gangelo%2Fsimple_command_dispatcher.svg?refresh=3)](https://badge.fury.io/gh/gangelo%2Fsimple_command_dispatcher)
-[![Gem Version](https://badge.fury.io/rb/simple_command_dispatcher.svg?refresh=3)](https://badge.fury.io/rb/simple_command_dispatcher)
+[![GitHub version](https://badge.fury.io/gh/gangelo%2Fsimple_command_dispatcher.svg?refresh=4)](https://badge.fury.io/gh/gangelo%2Fsimple_command_dispatcher)
+[![Gem Version](https://badge.fury.io/rb/simple_command_dispatcher.svg?refresh=4)](https://badge.fury.io/rb/simple_command_dispatcher)
 [![](https://ruby-gem-downloads-badge.herokuapp.com/simple_command_dispatcher?type=total)](http://www.rubydoc.info/gems/simple_command_dispatcher/)
 [![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/simple_command_dispatcher/)
 [![Report Issues](https://img.shields.io/badge/report-issues-red.svg)](https://github.com/gangelo/simple_command_dispatcher/issues)
@@ -10,7 +10,7 @@
 # A. It's a Ruby gem!!!
 
 ## Overview
-__simple_command_dispatcher__ (SCD) allows you to execute __simple_command__ commands (and now _custom commands_ as of version 1.2.1) in a more dynamic way. If you are not familiar with the _simple_command_ gem, check it out [here][simple-command]. SCD was written specifically with the [rails-api][rails-api] in mind; however, you can use SDC wherever you would use simple_command commands. 
+__simple_command_dispatcher__ (SCD) allows you to execute __simple_command__ commands (and now _custom commands_ as of version 1.2.1) in a more dynamic way. If you are not familiar with the _simple_command_ gem, check it out [here][simple-command]. SCD was written specifically with the [rails-api][rails-api] in mind; however, you can use SDC wherever you would use simple_command commands.
 
 ## Update as of Version 1.2.1
 ### Custom Commands
@@ -29,31 +29,31 @@ This example assumes the following:
 
 Command classes (and the modules they reside under) are named *__according to their file name and respective location within the above folder structure__*; for example, the command class defined in the `/api/my_app1/v1/authenticate_request.rb` file would be defined in this manner:
 
-```ruby 
+```ruby
 # /api/my_app1/v1/authenticate_request.rb
 
-module Api 
-   module MyApp1 
-      module V1 
-         class AuthenticateRequest 
-         end 
-     end 
-   end 
+module Api
+   module MyApp1
+      module V1
+         class AuthenticateRequest
+         end
+     end
+   end
 end
 ```
-   
+
 Likewise, the command class defined in the `/api/my_app2/v2/update_user.rb` file would be defined in this manner, and so on:
 
-```ruby 
+```ruby
 # /api/my_app2/v2/update_user.rb
 
-module Api 
-   module MyApp2 
-      module V2 
-         class UpdateUser 
-         end 
-     end 
-   end 
+module Api
+   module MyApp2
+      module V2
+         class UpdateUser
+         end
+     end
+   end
 end
 ```
 
@@ -81,8 +81,8 @@ The __routes used in this example__, conform to the following format: `"/api/[ap
 #
 #   class Api::MyApp1::V1::AuthenticateRequest; end
 #
-# As opposed to this: 
-# 
+# As opposed to this:
+#
 #   module Api
 #      module MyApp1
 #         module V1
@@ -138,10 +138,10 @@ end
 # for custom command execution.
 SimpleCommand::Dispatcher.configure do |config|
    config.allow_custom_commands = true
-end 
+end
 ```
 
-```ruby 
+```ruby
 # /app/controllers/application_controller.rb
 
 require 'simple_command_dispatcher'
@@ -154,8 +154,8 @@ class ApplicationController < ActionController::API
 
    def get_command_path
       # request.env['PATH_INFO'] could return any number of paths. The important
-      # thing (in the case of our example), is that we get the portion of the 
-      # path that uniquely identifies the SimpleCommand we need to call; this 
+      # thing (in the case of our example), is that we get the portion of the
+      # path that uniquely identifies the SimpleCommand we need to call; this
       # would include the application, the API version and the SimpleCommand
       # name itself.
       command_path = request.env['PATH_INFO'] # => "/api/[app name]/v1/[action]”
@@ -163,16 +163,16 @@ class ApplicationController < ActionController::API
    end
 
    private
-   
+
    def authenticate_request
       # The parameters and options we are passing to the dispatcher, wind up equating
       # to the following: Api::MyApp1::V1::AuthenticateRequest.call(request.headers).
-      # Explaination: @param command_modules (e.g. path, "/api/my_app1/v1/"), in concert with @param 
-      # options { camelize: true }, is transformed into "Api::MyApp1::V1" and prepended to the 
+      # Explaination: @param command_modules (e.g. path, "/api/my_app1/v1/"), in concert with @param
+      # options { camelize: true }, is transformed into "Api::MyApp1::V1" and prepended to the
       # @param command, which becomes "Api::MyApp1::V1::AuthenticateRequest." This string is then
       # simply constantized; #call is then executed, passing the @param command_parameters
       # (e.g. request.headers, which contains ["Authorization"], out authorization token).
-      # Consequently, the correlation between our routes and command class module structure 
+      # Consequently, the correlation between our routes and command class module structure
       # was no coincidence.
       command = SimpleCommand::Dispatcher.call(:AuthenticateRequest, get_command_path, { camelize: true}, request.headers)
       if command.success?
@@ -191,7 +191,7 @@ As of __Version 1.2.1__ simple_command_dispatcher (SCD) allows you to execute _c
 In order to execute _custom commands_, there are three (3) requirements:
    1. Create a _custom command_. Your _custom command_ class must expose a public `::call` class method.
    2. Set the `Configuration#allow_custom_commands` property to `true`.
-   3. Execute your _custom command_ by calling the `::call` class method. 
+   3. Execute your _custom command_ by calling the `::call` class method.
 
 ### Custom Command Example
 
@@ -205,7 +205,7 @@ module Api
 
             # This is a custom command that does not prepend SimpleCommand.
             class CustomCommand
-               
+
                def self.call(*args)
                   command = self.new(*args)
                   if command
@@ -214,7 +214,7 @@ module Api
                      false
                   end
                end
-               
+
                private
 
                def initialize(params = {})
@@ -245,7 +245,7 @@ end
 
 SimpleCommand::Dispatcher.configure do |config|
     config.allow_custom_commands = true
-end 
+end
 ```
 
 #### 3. Execute your _Custom Command_
@@ -257,7 +257,7 @@ require 'simple_command_dispatcher'
 
 class SomeController < ApplicationController::API
    public
-   
+
    def some_api
       success = SimpleCommand::Dispatcher.call(:CustomCommand, get_command_path, { camelize: true}, request.headers)
       if success
@@ -306,4 +306,3 @@ The gem is available as open source under the terms of the [MIT License](http://
 
    [simple-command]: <https://rubygems.org/gems/simple_command>
    [rails-api]: <https://rubygems.org/gems/rails-api>
-

data/Rakefile

@@ -6,7 +6,7 @@ require 'yard'
 
 # Rspec
 RSpec::Core::RakeTask.new(:spec)
-task default: :spec
+#task default: :spec
 
 # Yard
 YARD::Rake::YardocTask.new do |t|
@@ -17,3 +17,8 @@ end
 
 # Load our custom rake tasks.
 Gem.find_files('tasks/**/*.rake').each { |path| import path }
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/simple_command_dispatcher/klass_transform.rb

@@ -1,3 +1,4 @@
+# rubocop:disable Style/OptionHash
 # frozen_string_literal: true
 
 require_relative '../core_extensions/string'
@@ -94,7 +95,7 @@ module SimpleCommand
     #   to_modules_string({ :api :api, app_name: :app_name, api_version: :v1 }, { module_titleize: true })
     #      # => "Api::AppName::V1::"
     #
-    def to_modules_string(klass_modules = [], options = {})
+    def to_modules_string(klass_modules = [], options = {}) # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
       klass_modules = validate_klass_modules(klass_modules)
 
       options = ensure_options(options)
@@ -246,3 +247,5 @@ module SimpleCommand
     end
   end
 end
+
+# rubocop:enable Style/OptionHash

data/lib/simple_command_dispatcher/version.rb

@@ -2,6 +2,6 @@
 
 module SimpleCommand
   module Dispatcher
-    VERSION = '3.0.2'
+    VERSION = '3.0.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_command_dispatcher
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.3
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-01 00:00:00.000000000 Z
+date: 2024-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport