convenient_service 0.12.0 → 0.13.0

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/concern/class_methods.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJSendStatusAndAttributes
+                module Concern
+                  module ClassMethods
+                    ##
+                    # @api private
+                    # @param value [Object] Can be any type.
+                    # @param result [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result].
+                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Code]
+                    # @raise [ConvenientService::Support::Castable::Exceptions::FailedToCast]
+                    #
+                    # @internal
+                    #   IMPORTANT: Skipping `result` is allowed only for tests.
+                    #
+                    def code(value:, result: new_without_initialize)
+                      code_class.cast!(value).copy(overrides: {kwargs: {result: result}})
+                    end
+
+                    ##
+                    # @api private
+                    # @param value [Object] Can be any type.
+                    # @param result [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result].
+                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Data]
+                    # @raise [ConvenientService::Support::Castable::Exceptions::FailedToCast]
+                    #
+                    # @internal
+                    #   IMPORTANT: Skipping `result` is allowed only for tests.
+                    #
+                    def data(value:, result: new_without_initialize)
+                      data_class.cast!(value).copy(overrides: {kwargs: {result: result}})
+                    end
+
+                    ##
+                    # @api private
+                    # @param value [Object] Can be any type.
+                    # @param result [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result].
+                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Message]
+                    # @raise [ConvenientService::Support::Castable::Exceptions::FailedToCast]
+                    #
+                    # @internal
+                    #   IMPORTANT: Skipping `result` is allowed only for tests.
+                    #
+                    def message(value:, result: new_without_initialize)
+                      message_class.cast!(value).copy(overrides: {kwargs: {result: result}})
+                    end
+
+                    ##
+                    # @api private
+                    # @param value [Object] Can be any type.
+                    # @param result [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result].
+                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Status]
+                    # @raise [ConvenientService::Support::Castable::Exceptions::FailedToCast]
+                    #
+                    # @internal
+                    #   IMPORTANT: Skipping `result` is allowed only for tests.
+                    #
+                    def status(value:, result: new_without_initialize)
+                      status_class.cast!(value).copy(overrides: {kwargs: {result: result}})
+                    end
+
+                    ##
+                    # @api private
+                    # @return [Class]
+                    #
+                    # @internal
+                    #   NOTE: A command instead of `import` is used in order to NOT pollute the public interface.
+                    #   TODO: Specs that prevent public interface accidental pollution.
+                    #
+                    def code_class
+                      @code_class ||= Commands::CreateCodeClass.call(result_class: self)
+                    end
+
+                    ##
+                    # @api private
+                    # @return [Class]
+                    #
+                    # @internal
+                    #   NOTE: A command instead of `import` is used in order to NOT pollute the public interface.
+                    #   TODO: Specs that prevent public interface accidental pollution.
+                    #
+                    def data_class
+                      @data_class ||= Commands::CreateDataClass.call(result_class: self)
+                    end
+
+                    ##
+                    # @api private
+                    # @return [Class]
+                    #
+                    # @internal
+                    #   NOTE: A command instead of `import` is used in order to NOT pollute the public interface.
+                    #   TODO: Specs that prevent public interface accidental pollution.
+                    #
+                    def message_class
+                      @message_class ||= Commands::CreateMessageClass.call(result_class: self)
+                    end
+
+                    ##
+                    # @api private
+                    # @return [Class]
+                    #
+                    # @internal
+                    #   NOTE: A command instead of `import` is used in order to NOT pollute the public interface.
+                    #   TODO: Specs that prevent public interface accidental pollution.
+                    #
+                    def status_class
+                      @status_class ||= Commands::CreateStatusClass.call(result_class: self)
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/{has_result → has_j_send_result}/entities/result/plugins/has_j_send_status_and_attributes/concern/instance_methods.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Entities
           class Result
             module Plugins
@@ -52,51 +52,87 @@ module ConvenientService
                     delegate :service, to: :jsend_attributes
 
                     ##
-                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Status]
+                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Status]
                     #
                     delegate :status, to: :jsend_attributes
 
                     ##
-                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Data]
+                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Data]
                     #
                     delegate :data, to: :jsend_attributes
 
                     ##
-                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Data]
+                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Data]
                     #
                     alias_method :unsafe_data, :data
 
                     ##
-                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Message]
+                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Message]
                     #
                     delegate :message, to: :jsend_attributes
 
                     ##
-                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Message]
+                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Message]
                     #
                     alias_method :unsafe_message, :message
 
                     ##
-                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Code]
+                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Code]
                     #
                     delegate :code, to: :jsend_attributes
 
                     ##
-                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Code]
+                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Code]
                     #
                     alias_method :unsafe_code, :code
 
                     ##
-                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Structs::JSendAttributes]
+                    # @return [Hash{Object => Symbol}]
+                    #
+                    delegate :extra_kwargs, to: :jsend_attributes
+
+                    ##
+                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Structs::JSendAttributes]
                     #
                     def jsend_attributes
                       internals.cache[:jsend_attributes]
                     end
 
                     ##
-                    # @param other [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+                    # @return [Symbol]
+                    #
+                    def create_status(status)
+                      self.class.status(value: status, result: self)
+                    end
+
+                    ##
+                    # @return [Hash{Symbol => Object}]
+                    #
+                    def create_data(data)
+                      self.class.data(value: data, result: self)
+                    end
+
+                    ##
+                    # @return [String]
+                    #
+                    def create_message(message)
+                      self.class.message(value: message, result: self)
+                    end
+
+                    ##
+                    # @return [Symbol]
+                    #
+                    def create_code(code)
+                      self.class.code(value: code, result: self)
+                    end
+
+                    ##
+                    # @param other [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
                     # @return [Boolean, nil]
                     #
+                    # @internal
+                    #   TODO: Currently `==` does NOT compare `extra_kwargs`. Is it OK?
+                    #
                     def ==(other)
                       return unless other.instance_of?(self.class)
 
@@ -110,16 +146,24 @@ module ConvenientService
                     end
 
                     ##
-                    # @return [Hash]
+                    # @return [Hash{Symbol => Object}]
                     #
                     def to_kwargs
-                      {
+                      to_arguments.kwargs
+                    end
+
+                    ##
+                    # @return [ConveninentService::Support::Arguments]
+                    #
+                    def to_arguments
+                      Support::Arguments.new(
                         service: service,
                         status: status,
                         data: unsafe_data,
                         message: unsafe_message,
-                        code: unsafe_code
-                      }
+                        code: unsafe_code,
+                        **extra_kwargs
+                      )
                     end
                   end
                 end

data/lib/convenient_service/service/plugins/{has_result → has_j_send_result}/entities/result/plugins/has_j_send_status_and_attributes/concern.rb

@@ -6,7 +6,7 @@ require_relative "concern/instance_methods"
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Entities
           class Result
             module Plugins

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/code/commands/is_code.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJSendStatusAndAttributes
+                module Entities
+                  class Code
+                    module Commands
+                      ##
+                      # Check whether `code` can be considered as `Code` instance.
+                      #
+                      class IsCode < Support::Command
+                        ##
+                        # @!attribute [r] code
+                        #   @return [Object] Can be any type.
+                        #
+                        attr_reader :code
+
+                        ##
+                        # @param code [Object] Can be any type.
+                        # @return [void]
+                        #
+                        def initialize(code:)
+                          @code = code
+                        end
+
+                        ##
+                        # @return [Boolean]
+                        #
+                        def call
+                          code.class.include?(Entities::Code::Concern)
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/code/commands.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "commands/is_code"

data/lib/convenient_service/service/plugins/{has_result → has_j_send_result}/entities/result/plugins/has_j_send_status_and_attributes/entities/code/concern/class_methods.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Entities
           class Result
             module Plugins
@@ -14,7 +14,7 @@ module ConvenientService
                       module ClassMethods
                         ##
                         # @param other [Object] Can be any type.
-                        # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Code, nil]
+                        # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Code, nil]
                         #
                         def cast(other)
                           case other
@@ -26,6 +26,18 @@ module ConvenientService
                             new(value: other.value)
                           end
                         end
+
+                        ##
+                        # @param other [Object] Can be any type.
+                        # @return [Boolean, nil]
+                        #
+                        # @internal
+                        #   NOTE: Check `Module.===` in order to get an idea of how `super` works.
+                        #   - https://ruby-doc.org/core-2.7.0/Module.html#method-i-3D-3D-3D
+                        #
+                        def ===(other)
+                          Commands::IsCode.call(code: other) || super
+                        end
                       end
                     end
                   end

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/code/concern/instance_methods.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJSendStatusAndAttributes
+                module Entities
+                  class Code
+                    module Concern
+                      module InstanceMethods
+                        include Support::Copyable
+
+                        ##
+                        # @!attribute [r] value
+                        #   @return [Symbol]
+                        #
+                        attr_reader :value
+
+                        ##
+                        # @!attribute [r] result
+                        #   @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+                        #
+                        attr_reader :result
+
+                        ##
+                        # @param value [Symbol]
+                        # @param result [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+                        # @return [void]
+                        #
+                        def initialize(value:, result: nil)
+                          @value = value
+                          @result = result
+                        end
+
+                        ##
+                        # @param other [Object] Can be any type.
+                        # @return [Boolean, nil]
+                        #
+                        def ==(other)
+                          return unless other.instance_of?(self.class)
+
+                          return false if result.class != other.result.class
+                          return false if value != other.value
+
+                          true
+                        end
+
+                        ##
+                        # @param other [Object] Can be any type.
+                        # @return [Boolean, nil]
+                        #
+                        # @note `Code#===` allows to use RSpec expectation matchers and RSpec mocks arguments matchers for comparison.
+                        #
+                        # @example RSpec expectation matchers.
+                        #   expect(result).to be_error.with_code(match(/bar/))
+                        #
+                        # @see https://rspec.info/features/3-12/rspec-expectations/built-in-matchers
+                        # @see https://rspec.info/documentation/3.12/rspec-expectations/RSpec/Matchers/BuiltIn.html
+                        # @see https://github.com/rspec/rspec-expectations/blob/v3.12.3/lib/rspec/matchers/composable.rb#L45
+                        #
+                        # @example RSpec mocks arguments matchers.
+                        #   expect(result).to be_success.with_code(instance_of(Symbol))
+                        #
+                        # @see https://rspec.info/features/3-12/rspec-mocks/setting-constraints/matching-arguments
+                        # @see https://rspec.info/documentation/3.12/rspec-mocks/RSpec/Mocks/ArgumentMatchers.html
+                        # @see https://github.com/rspec/rspec-mocks/blob/v3.12.3/lib/rspec/mocks/argument_matchers.rb#L282
+                        #
+                        # @internal
+                        #   IMPORTANT: Must be kept in sync with `#==`.
+                        #   NOTE: Ruby does NOT have `!==` operator.
+                        #
+                        def ===(other)
+                          return unless other.instance_of?(self.class)
+
+                          return false if result.class != other.result.class
+                          return false unless value === other.value
+
+                          true
+                        end
+
+                        ##
+                        # @return [Hash{Symbol => Object}]
+                        #
+                        def to_kwargs
+                          to_arguments.kwargs
+                        end
+
+                        ##
+                        # @return [ConveninentService::Support::Arguments]
+                        #
+                        def to_arguments
+                          @to_arguments ||= Support::Arguments.new(value: value, result: result)
+                        end
+
+                        ##
+                        # @return [String]
+                        #
+                        def to_s
+                          @to_s ||= value.to_s
+                        end
+
+                        ##
+                        # @return [Symbol]
+                        #
+                        def to_sym
+                          @to_sym ||= value.to_sym
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/{has_result → has_j_send_result}/entities/result/plugins/has_j_send_status_and_attributes/entities/code/concern.rb

@@ -6,7 +6,7 @@ require_relative "concern/instance_methods"
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Entities
           class Result
             module Plugins

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/code/plugins/aliases.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Plugins
+    Code = ::ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Code::Plugins
+  end
+end

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/code/plugins/has_awesome_print_inspect/concern.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJSendStatusAndAttributes
+                module Entities
+                  class Code
+                    module Plugins
+                      module HasAwesomePrintInspect
+                        module Concern
+                          include Support::Concern
+
+                          instance_methods do
+                            ##
+                            # @return [String]
+                            #
+                            def inspect
+                              metadata = {
+                                ConvenientService: {
+                                  entity: "Code",
+                                  result: result.class.name,
+                                  value: to_sym
+                                }
+                              }
+
+                              metadata.ai
+                            end
+                          end
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/code/plugins/has_awesome_print_inspect.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "has_awesome_print_inspect/concern"

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/code/plugins/has_inspect/concern.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJSendStatusAndAttributes
+                module Entities
+                  class Code
+                    module Plugins
+                      module HasInspect
+                        module Concern
+                          include Support::Concern
+
+                          instance_methods do
+                            ##
+                            # @return [String]
+                            #
+                            def inspect
+                              "<#{self.class} value: :#{value}>"
+                            end
+                          end
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/code/plugins/has_inspect.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "has_inspect/concern"

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/code/plugins.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "plugins/has_inspect"
+
+require_relative "plugins/aliases"

data/lib/convenient_service/service/plugins/{has_result → has_j_send_result}/entities/result/plugins/has_j_send_status_and_attributes/entities/code.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
+require_relative "code/commands"
 require_relative "code/concern"
+require_relative "code/plugins"
 
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Entities
           class Result
             module Plugins

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/data/commands/is_data.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJSendStatusAndAttributes
+                module Entities
+                  class Data
+                    module Commands
+                      ##
+                      # Check whether `data` can be considered as `Data` instance.
+                      #
+                      class IsData < Support::Command
+                        ##
+                        # @!attribute [r] data
+                        #   @return [Object] Can be any type.
+                        #
+                        attr_reader :data
+
+                        ##
+                        # @param data [Object] Can be any type.
+                        # @return [void]
+                        #
+                        def initialize(data:)
+                          @data = data
+                        end
+
+                        ##
+                        # @return [Boolean]
+                        #
+                        def call
+                          data.class.include?(Entities::Data::Concern)
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/data/commands.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "commands/is_data"