simple_command_dispatcher 1.2.6 → 1.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c6a643ded964f7b90d4829f446e901108a01588d1a0f696145666884c78c50a
-  data.tar.gz: 8ba541e92fc308d58e76c0af86344f923618de79918d79986f8a9f9b683d7507
+  metadata.gz: 8394ce5aa8ac9f9270c37dd685efec66eaa80df6e72f390f8a1d7a72a4aa60c9
+  data.tar.gz: 31796a2d10978ea831e1ae19aff033030577b3916c2e51e90b300604ec5822b0
 SHA512:
-  metadata.gz: da6da7888c7c216cad99b9df62e6a8217f0b70dbee8da3873fedc49b9a38104bcca92f2d89832c216cd270e03a790a1147f4c1fb8e006e772df31300adbf61a7
-  data.tar.gz: a49157ec1695d78ad02cfddc3600f9d2ac3640867697e3d8f11936c05f1ba3d77e4ce218dbea1d09d42938e52c0aa4c66d4d92a83c9795865c59709b3488ab74
+  metadata.gz: 6d0617d0fbf74267879a77ec8665c24d9b8ec200fa67677ce8c9901c9a50e5363adac6bf047b2d486e5f8824ec052be4997c023c81591937f76a2f334bca3a8d
+  data.tar.gz: e0e204e5ab1f7a7c0e35a2af6e86475dc41894f8135458762de4282bef8bf1fded4c5168e47b5aa80eaf1969c650213dd8c9d5ac978b07a14552a768e4849dc5

data/.github/dependabot.yml

@@ -0,0 +1,16 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+    groups:
+      production-dependencies:
+        dependency-type: "production"
+      development-dependencies:
+        dependency-type: "development"

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+### Version 1.2.7
+* Update ruby gems.
+* Miscellaneous refactors.
 ### Version 1.2.6
 * Update ruby gems to patch CVE.
 ### Version 1.2.5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simple_command_dispatcher (1.2.6)
+    simple_command_dispatcher (1.2.7)
       activesupport (~> 5.0, >= 5.0.0.1)
       simple_command (~> 0.2.0)
 
@@ -19,14 +19,15 @@ GEM
     colorize (0.8.1)
     concurrent-ruby (1.2.2)
     diff-lcs (1.5.0)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
     method_source (1.0.0)
-    minitest (5.18.0)
-    parallel (1.22.1)
-    parser (3.2.2.0)
+    minitest (5.19.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -35,26 +36,27 @@ GEM
       pry (~> 0.13.0)
     psych (5.1.0)
       stringio
+    racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
     rdoc (6.5.0)
       psych (>= 4.0.0)
-    regexp_parser (2.7.0)
-    rexml (3.2.5)
+    regexp_parser (2.8.1)
+    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.1)
+    rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.49.0)
+    rspec-support (3.12.1)
+    rubocop (1.50.2)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
@@ -64,24 +66,23 @@ GEM
       rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
+    rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
-    rubocop-performance (1.16.0)
+    rubocop-performance (1.17.1)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.13.0)
     simple_command (0.2.1)
-    stringio (3.0.5)
+    stringio (3.0.6)
     thread_safe (0.3.6)
     tzinfo (1.2.11)
       thread_safe (~> 0.1)
     unicode-display_width (2.4.2)
-    webrick (1.7.0)
-    yard (0.9.28)
-      webrick (~> 1.7.0)
+    yard (0.9.34)
 
 PLATFORMS
   x86_64-darwin-19
+  x86_64-linux
 
 DEPENDENCIES
   bundler (~> 2.2, >= 2.2.17)

data/lib/simple_command_dispatcher/configure.rb

@@ -6,7 +6,7 @@ module SimpleCommand
   module Dispatcher
     class << self
       attr_writer :configuration
-      end
+    end
 
     # Returns the application configuration object.
     #

data/lib/simple_command_dispatcher/klass_transform.rb

@@ -10,24 +10,32 @@ module SimpleCommand
     # @param klass [Symbol or String] the class name.
     # @param klass_modules [Hash, Array or String] the modules klass belongs to.
     # @param options [Hash] the options that determine how klass_modules is transformed.
-    # @option options [Boolean] :camelize (false) determines whether or not both klass and klass_modules should be camelized.
-    # @option options [Boolean] :titleize (false) determines whether or not both klass and klass_modules should be titleized.
-    # @option options [Boolean] :class_titleize (false) determines whether or not klass names should be titleized.
-    # @option options [Boolean] :class_camelized (false) determines whether or not klass names should be camelized.
-    # @option options [Boolean] :module_titleize (false) determines whether or not klass_modules names should be titleized.
-    # @option options [Boolean] :module_camelized (false) determines whether or not klass_modules names should be camelized.
+    # @option options [Boolean] :camelize (false) determines whether or not both klass and klass_modules
+    #    should be camelized.
+    # @option options [Boolean] :titleize (false) determines whether or not both klass and klass_modules
+    #    should be titleized.
+    # @option options [Boolean] :class_titleize (false) determines whether or not klass names should be
+    #    titleized.
+    # @option options [Boolean] :class_camelized (false) determines whether or not klass names should be
+    #    camelized.
+    # @option options [Boolean] :module_titleize (false) determines whether or not klass_modules names
+    #    should be titleized.
+    # @option options [Boolean] :module_camelized (false) determines whether or not klass_modules names
+    #    should be camelized.
     #
     # @return [Class] the class constant. Can be used to call ClassConstant.constantize.
     #
     # @raise [NameError] if the constantized class string cannot be constantized; that is, if it is not
-    #   a valid class constant.
+    #    a valid class constant.
     #
     # @example
     #
     #   to_constantized_class("Authenticate", "Api") # => Api::Authenticate
     #   to_constantized_class(:Authenticate, [:Api, :AppName, :V1]) # => Api::AppName::V1::Authenticate
-    #   to_constantized_class(:Authenticate, { :api :Api, app_name: :AppName, api_version: :V2 }) # => Api::AppName::V2::Authenticate
-    #   to_constantized_class("authenticate", { :api :api, app_name: :app_name, api_version: :v1 }, { class_titleize: true, module_titleize: true }) # => Api::AppName::V1::Authenticate
+    #   to_constantized_class(:Authenticate, { :api :Api, app_name: :AppName, api_version: :V2 })
+    #     # => Api::AppName::V2::Authenticate
+    #   to_constantized_class("authenticate", { :api :api, app_name: :app_name, api_version: :v1 },
+    #     { class_titleize: true, module_titleize: true }) # => Api::AppName::V1::Authenticate
     #
     def to_constantized_class(klass, klass_modules = [], options = {})
       constantized_class_string = to_constantized_class_string(klass, klass_modules, options)
@@ -44,8 +52,10 @@ module SimpleCommand
     # @param [Symbol or String] klass the class name.
     # @param [Hash, Array or String] klass_modules the modules klass belongs to.
     # @param [Hash] options the options that determine how klass_modules is transformed.
-    # @option options [Boolean] :class_titleize (false) Determines whether or not klass should be titleized.
-    # @option options [Boolean] :module_titleize (false) Determines whether or not klass_modules should be titleized.
+    # @option options [Boolean] :class_titleize (false) Determines whether or not klass should be
+    #    titleized.
+    # @option options [Boolean] :module_titleize (false) Determines whether or not klass_modules
+    #    should be titleized.
     #
     # @return [String] the fully qualified class, which includes module(s) and class name.
     #
@@ -53,8 +63,10 @@ module SimpleCommand
     #
     #   to_constantized_class_string("Authenticate", "Api") # => "Api::Authenticate"
     #   to_constantized_class_string(:Authenticate, [:Api, :AppName, :V1]) # => "Api::AppName::V1::Authenticate"
-    #   to_constantized_class_string(:Authenticate, { :api :Api, app_name: :AppName, api_version: :V2 }) # => "Api::AppName::V2::Authenticate"
-    #   to_constantized_class_string("authenticate", { :api :api, app_name: :app_name, api_version: :v1 }, { class_titleize: true, module_titleize: true }) # => "Api::AppName::V1::Authenticate"
+    #   to_constantized_class_string(:Authenticate, { :api :Api, app_name: :AppName, api_version: :V2 })
+    #      # => "Api::AppName::V2::Authenticate"
+    #   to_constantized_class_string("authenticate", { :api :api, app_name: :app_name, api_version: :v1 },
+    #      { class_titleize: true, module_titleize: true }) # => "Api::AppName::V1::Authenticate"
     #
     def to_constantized_class_string(klass, klass_modules = [], options = {})
       options = ensure_options(options)
@@ -69,7 +81,8 @@ module SimpleCommand
     # @param [Hash] options the options that determine how klass_modules is transformed.
     # @option options [Boolean] :module_titleize (false) Determines whether or not klass_modules should be titleized.
     #
-    # @return [String] a string of modules that can be subsequently prepended to a class, to create a constantized class.
+    # @return [String] a string of modules that can be subsequently prepended to a class, to create a
+    #    constantized class.
     #
     # @raise [ArgumentError] if the klass_modules is not of type String, Hash or Array.
     #
@@ -78,7 +91,8 @@ module SimpleCommand
     #   to_modules_string("Api") # => "Api::"
     #   to_modules_string([:Api, :AppName, :V1]) # => "Api::AppName::V1::"
     #   to_modules_string({ :api :Api, app_name: :AppName, api_version: :V1 }) # => "Api::AppName::V1::"
-    #   to_modules_string({ :api :api, app_name: :app_name, api_version: :v1 }, { module_titleize: true }) # => "Api::AppName::V1::"
+    #   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 = {})
       klass_modules = validate_klass_modules(klass_modules)
@@ -143,7 +157,7 @@ module SimpleCommand
     def camelize(token)
       raise ArgumentError, 'Token is not a String' unless token.instance_of? String
 
-      token = token.titlecase.camelize.sub(/^:*/, '').trim_all unless token.empty?
+      token.titlecase.camelize.sub(/^:*/, '').trim_all unless token.empty?
     end
 
     private
@@ -153,8 +167,10 @@ module SimpleCommand
     # Ensures options are initialized and valid before accessing them.
     #
     # @param [Hash] options the options that determine how processing and transformations will be handled.
-    # @option options [Boolean] :camelize (false) determines whether or not both class and module names should be camelized.
-    # @option options [Boolean] :titleize (false) determines whether or not both class and module names should be titleized.
+    # @option options [Boolean] :camelize (false) determines whether or not both class and module names
+    #    should be camelized.
+    # @option options [Boolean] :titleize (false) determines whether or not both class and module names
+    #    should be titleized.
     # @option options [Boolean] :class_titleize (false) determines whether or not class names should be titleized.
     # @option options [Boolean] :module_titleize (false) determines whether or not module names should be titleized.
     # @option options [Boolean] :class_camelized (false) determines whether or not class names should be camelized.
@@ -192,7 +208,8 @@ module SimpleCommand
     def validate_klass(klass, _options)
       unless klass.is_a?(Symbol) || klass.is_a?(String)
         raise ArgumentError,
-          'Class is not a String or Symbol. Class must equal the class name of the SimpleCommand or Command to call in the form of a String or Symbol.'
+          'Class is not a String or Symbol. Class must equal the class name of the ' \
+          'SimpleCommand or Command to call in the form of a String or Symbol.'
       end
 
       klass = klass.to_s.strip

data/lib/simple_command_dispatcher/version.rb

@@ -2,6 +2,6 @@
 
 module SimpleCommand
   module Dispatcher
-    VERSION = '1.2.6'
+    VERSION = '1.2.7'
   end
 end

data/lib/simple_command_dispatcher.rb

@@ -23,39 +23,49 @@ module SimpleCommand
     class << self
       include SimpleCommand::KlassTransform
 
-      # Calls a *SimpleCommand* or *Command* given the command name, the modules the command belongs to and the parameters to pass to the command.
+      # Calls a *SimpleCommand* or *Command* given the command name, the modules the command belongs to
+      # and the parameters to pass to the command.
       #
       # @param command [Symbol, String] the name of the SimpleCommand or Command to call.
       #
-      # @param command_modules [Hash, Array] the ruby modules that qualify the SimpleCommand to call. When passing a Hash, the Hash
-      #    keys serve as documentation only. For example, ['Api', 'AppName', 'V1'] and { :api :Api, app_name: :AppName, api_version: :V1 }
-      #    will both produce 'Api::AppName::V1', this string will be prepended to the command to form the SimpleCommand to call
+      # @param command_modules [Hash, Array] the ruby modules that qualify the SimpleCommand to call. When
+      #    passing a Hash, the Hash keys serve as documentation only. For example, ['Api', 'AppName', 'V1']
+      #    and { :api :Api, app_name: :AppName, api_version: :V1 } will both produce 'Api::AppName::V1',
+      #    this string will be prepended to the command to form the SimpleCommand to call
       #    (e.g. 'Api::AppName::V1::MySimpleCommand' = Api::AppName::V1::MySimpleCommand.call(*command_parameters)).
       #
       # @param [Hash] options the options that determine how command and command_module are transformed.
-      # @option options [Boolean] :camelize (false) determines whether or not both class and module names should be camelized.
-      # @option options [Boolean] :titleize (false) determines whether or not both class and module names should be titleized.
+      # @option options [Boolean] :camelize (false) determines whether or not both class and module names should be
+      #    camelized.
+      # @option options [Boolean] :titleize (false) determines whether or not both class and module names should be
+      #    titleized.
       # @option options [Boolean] :class_titleize (false) determines whether or not class names should be titleized.
       # @option options [Boolean] :class_camelized (false) determines whether or not class names should be camelized.
       # @option options [Boolean] :module_titleize (false) determines whether or not module names should be titleized.
       # @option options [Boolean] :module_camelized (false) determines whether or not module names should be camelized.
       #
-      # @param command_parameters [Array<Symbol>] the parameters to pass to the call method of the SimpleCommand . This parameter is simply
-      #    passed through to the call method of the SimpleCommand/Command.
+      # @param command_parameters [Array<Symbol>] the parameters to pass to the call method of the SimpleCommand.
+      #    This parameter is simplypassed through to the call method of the SimpleCommand/Command.
       #
-      # @return [SimpleCommand, Object] the SimpleCommand or Object returned as a result of calling the SimpleCommand#call method or the Command#call method respectfully.
+      # @return [SimpleCommand, Object] the SimpleCommand or Object returned as a result of calling the
+      #    SimpleCommand#call method or the Command#call method respectfully.
       #
       # @example
       #
-      #  # Below call equates to the following: Api::Carz4Rent::V1::Authenticate.call({ email: 'sam@gmail.com', password: 'AskM3!' })
-      #  SimpleCommand::Dispatcher.call(:Authenticate, { api: :Api, app_name: :Carz4Rent, api_version: :V1 },
-      #                              { email: 'sam@gmail.com', password: 'AskM3!' } ) # => SimpleCommand result
+      #  # Below call equates to the following:
+      #  # Api::Carz4Rent::V1::Authenticate.call({ email: 'sam@gmail.com', password: 'AskM3!' })
+      #  SimpleCommand::Dispatcher.call(:Authenticate,
+      #     { api: :Api, app_name: :Carz4Rent, api_version: :V1 },
+      #     { email: 'sam@gmail.com', password: 'AskM3!' } ) # => SimpleCommand result
       #
       #  # Below equates to the following: Api::Carz4Rent::V2::Authenticate.call('sam@gmail.com', 'AskM3!')
-      #  SimpleCommand::Dispatcher.call(:Authenticate, ['Api', 'Carz4Rent', 'V2'], 'sam@gmail.com', 'AskM3!') # => SimpleCommand result
+      #  SimpleCommand::Dispatcher.call(:Authenticate,
+      #     ['Api', 'Carz4Rent', 'V2'], 'sam@gmail.com', 'AskM3!') # => SimpleCommand result
       #
-      #  # Below equates to the following: Api::Auth::JazzMeUp::V1::Authenticate.call('jazz_me@gmail.com', 'JazzM3!')
-      #  SimpleCommand::Dispatcher.call(:Authenticate, ['Api::Auth::JazzMeUp', :V1], 'jazz_me@gmail.com', 'JazzM3!') # => SimpleCommand result
+      #  # Below equates to the following:
+      #  # Api::Auth::JazzMeUp::V1::Authenticate.call('jazz_me@gmail.com', 'JazzM3!')
+      #  SimpleCommand::Dispatcher.call(:Authenticate, ['Api::Auth::JazzMeUp', :V1],
+      #     'jazz_me@gmail.com', 'JazzM3!') # => SimpleCommand result
       #
       def call(command = '', command_modules = {}, options = {}, *command_parameters)
         # Create a constantized class from our command and command_modules...
@@ -63,12 +73,13 @@ module SimpleCommand
 
         # If we're NOT allowing custom commands, make sure we're dealing with a a command class
         # that prepends the SimpleCommand module.
-        if !SimpleCommand::Dispatcher.configuration.allow_custom_commands && !is_simple_command?(command_class_constant)
+        if !SimpleCommand::Dispatcher.configuration.allow_custom_commands && !simple_command?(command_class_constant)
           raise ArgumentError,
-            "Class \"#{command_class_constant}\" must prepend module SimpleCommand if Configuration#allow_custom_commands is true."
+            "Class \"#{command_class_constant}\" " \
+            'must prepend module SimpleCommand if Configuration#allow_custom_commands is true.'
         end
 
-        if is_valid_command(command_class_constant)
+        if valid_command?(command_class_constant)
           # We know we have a valid SimpleCommand; all we need to do is call #call,
           # pass the command_parameter variable arguments to the call, and return the results.
           run_command(command_class_constant, command_parameters)
@@ -83,23 +94,27 @@ module SimpleCommand
       # class method named ::call defined. Commands that do not have a public class method
       # named ::call, are considered invalid.
       #
-      # @param klass_constant [String] a class constant that will be validated to see whether or not the class is a valid command.
+      # @param klass_constant [String] a class constant that will be validated to see whether or not the
+      #    class is a valid command.
       #
-      # @return [Boolean] true if klass_constant has a public class method named ::call defined, false otherwise.
+      # @return [Boolean] true if klass_constant has a public class method named ::call defined,
+      #    false otherwise.
       #
       # @!visibility public
-      def is_valid_command(klass_constant)
+      def valid_command?(klass_constant)
         klass_constant.eigenclass.public_method_defined?(:call)
       end
 
-      # Returns true or false depending on whether or not the class constant prepends module SimpleCommand::ClassMethods.
+      # Returns true or false depending on whether or not the class constant prepends module
+      #    SimpleCommand::ClassMethods.
       #
-      # @param klass_constant [String] a class constant that will be validated to see whether or not the class prepends module SimpleCommand::ClassMethods.
+      # @param klass_constant [String] a class constant that will be validated to see whether
+      #    or not the class prepends module SimpleCommand::ClassMethods.
       #
       # @return [Boolean] true if klass_constant prepends Module SimpleCommand::ClassMethods, false otherwise.
       #
       # @!visibility public
-      def is_simple_command?(klass_constant)
+      def simple_command?(klass_constant)
         klass_constant.eigenclass.included_modules.include? SimpleCommand::ClassMethods
       end
 

data/simple_command_dispatcher.gemspec

@@ -37,7 +37,6 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.2.2'
   spec.add_runtime_dependency 'activesupport', '~> 5.0', '>= 5.0.0.1'
-  #spec.add_runtime_dependency 'simple_command', '>= 0.0.9'
   spec.add_runtime_dependency 'simple_command', '~> 0.2.0'
 
   spec.add_development_dependency 'pry-byebug', '~> 3.9'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_command_dispatcher
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.2.7
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-05 00:00:00.000000000 Z
+date: 2023-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -200,6 +200,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".gitignore"
 - ".reek.yml"
 - ".rspec"