convenient_service 0.12.0 → 0.14.0

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Entities
           class Result
             module Plugins
@@ -12,18 +12,28 @@ module ConvenientService
                   class Status
                     module Concern
                       module InstanceMethods
+                        include Support::Copyable
+
                         ##
                         # @!attribute [r] value
                         #   @return [String]
                         #
                         attr_reader :value
 
+                        ##
+                        # @!attribute [r] result
+                        #   @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+                        #
+                        attr_reader :result
+
                         ##
                         # @param value [String]
+                        # @param result [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
                         # @return [void]
                         #
-                        def initialize(value:)
+                        def initialize(value:, result: nil)
                           @value = value
+                          @result = result
                         end
 
                         ##
@@ -31,11 +41,12 @@ module ConvenientService
                         # @return [Boolean, nil]
                         #
                         def ==(other)
-                          casted = cast(other)
+                          return unless other.instance_of?(self.class)
 
-                          return unless casted
+                          return false if result.class != other.result.class
+                          return false if value != other.value
 
-                          value == casted.value
+                          true
                         end
 
                         ##
@@ -81,13 +92,27 @@ module ConvenientService
                         end
 
                         ##
-                        # @param statuses [Array<Symbol, String, ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Status>]
+                        # @param statuses [Array<ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Status>]
                         # @return [Boolean]
                         #
                         def in?(statuses)
                           statuses.any? { |status| self == status }
                         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]
                         #

data/lib/convenient_service/service/plugins/{has_result → has_j_send_result}/entities/result/plugins/has_j_send_status_and_attributes/entities/status/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/status/plugins/aliases.rb

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

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/status/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 Status
+                    module Plugins
+                      module HasAwesomePrintInspect
+                        module Concern
+                          include Support::Concern
+
+                          instance_methods do
+                            ##
+                            # @return [String]
+                            #
+                            def inspect
+                              metadata = {
+                                ConvenientService: {
+                                  entity: "Status",
+                                  result: result.class.name,
+                                  type: 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/status/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/status/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 Status
+                    module Plugins
+                      module HasInspect
+                        module Concern
+                          include Support::Concern
+
+                          instance_methods do
+                            ##
+                            # @return [String]
+                            #
+                            def inspect
+                              "<#{self.class} type: :#{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/status/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/status/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/status.rb

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

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

@@ -3,13 +3,13 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Entities
           class Result
             module Plugins
               module HasJSendStatusAndAttributes
-                module Errors
-                  class NotExistingAttribute < ::ConvenientService::Error
+                module Exceptions
+                  class NotExistingAttribute < ::ConvenientService::Exception
                     ##
                     # @param attribute [Symbol]
                     # @return [void]

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

@@ -3,12 +3,14 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Entities
           class Result
             module Plugins
               module HasJSendStatusAndAttributes
-                class Middleware < Core::MethodChainMiddleware
+                class Middleware < MethodChainMiddleware
+                  intended_for :initialize, entity: :result
+
                   ##
                   # @param args [Array<Object>]
                   # @param kwargs [Hash{Symbol => Object}]
@@ -16,7 +18,7 @@ module ConvenientService
                   # @return [void]
                   #
                   def next(*args, **kwargs, &block)
-                    entity.internals.cache[:jsend_attributes] = Commands::CastJSendAttributes.call(attributes: kwargs)
+                    entity.internals.cache[:jsend_attributes] = Commands::CastJSendAttributes.call(result: entity, kwargs: kwargs)
 
                     chain.next(*args, **kwargs, &block)
                   end

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

@@ -3,13 +3,13 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Entities
           class Result
             module Plugins
               module HasJSendStatusAndAttributes
                 module Structs
-                  JSendAttributes = ::Struct.new(:service, :status, :data, :message, :code, keyword_init: true)
+                  JSendAttributes = ::Struct.new(:service, :status, :data, :message, :code, :extra_kwargs, keyword_init: true)
                 end
               end
             end

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

@@ -3,6 +3,6 @@
 require_relative "has_j_send_status_and_attributes/commands"
 require_relative "has_j_send_status_and_attributes/concern"
 require_relative "has_j_send_status_and_attributes/entities"
-require_relative "has_j_send_status_and_attributes/errors"
+require_relative "has_j_send_status_and_attributes/exceptions"
 require_relative "has_j_send_status_and_attributes/middleware"
 require_relative "has_j_send_status_and_attributes/structs"

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module HasStubbedResultInvocationsCounter
+                module Concern
+                  include Support::Concern
+
+                  instance_methods do
+                    ##
+                    # @return [ConvenientService::Support::ThreadSafeCounter]
+                    #
+                    def stubbed_result_invocations_counter
+                      extra_kwargs[:stubbed_result_invocations_counter]
+                    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_stubbed_result_invocations_counter/middleware.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module HasStubbedResultInvocationsCounter
+                class Middleware < MethodChainMiddleware
+                  intended_for :initialize, entity: :result
+
+                  ##
+                  # @param args [Array<Object>]
+                  # @param kwargs [Hash{Symbol => Object}]
+                  # @param block [Proc, nil]
+                  # @return [void]
+                  #
+                  # @internal
+                  #   NOTE: It is okish to assign to next method arguments here.
+                  #   Since splat for `args` and double splat for `kwargs` always create new arrays and hashes respectively.
+                  #   - https://github.com/ruby/spec/blob/c7ed8478a031d0df346d222495f4b4bbb298523b/language/keyword_arguments_spec.rb#L100
+                  #
+                  def next(*args, **kwargs, &block)
+                    kwargs[:stubbed_result_invocations_counter] = Support::ThreadSafeCounter.new if kwargs[:stubbed_result]
+
+                    chain.next(*args, **kwargs, &block)
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_stubbed_result_invocations_counter.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "has_stubbed_result_invocations_counter/concern"
+require_relative "has_stubbed_result_invocations_counter/middleware"

data/lib/convenient_service/service/plugins/{has_result/entities/result/plugins/raises_on_not_checked_result_status/errors.rb → has_j_send_result/entities/result/plugins/raises_on_not_checked_result_status/exceptions.rb}

@@ -3,13 +3,13 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Entities
           class Result
             module Plugins
               module RaisesOnNotCheckedResultStatus
-                module Errors
-                  class StatusIsNotChecked < ::ConvenientService::Error
+                module Exceptions
+                  class StatusIsNotChecked < ::ConvenientService::Exception
                     def initialize(attribute:)
                       message = <<~TEXT
                         Attribute `#{attribute}` is accessed before result status is checked.

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/raises_on_not_checked_result_status/middleware.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module RaisesOnNotCheckedResultStatus
+                class Middleware < MethodChainMiddleware
+                  intended_for [
+                    :data,
+                    :message,
+                    :code
+                  ], entity: :result
+
+                  ##
+                  # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+                  # @raise [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::RaisesOnNotCheckedResultStatus::Exceptions::StatusIsNotChecked]
+                  #
+                  def next(...)
+                    assert_has_checked_status!
+
+                    chain.next(...)
+                  end
+
+                  private
+
+                  ##
+                  # @return [void]
+                  # @raise [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::RaisesOnNotCheckedResultStatus::Exceptions::StatusIsNotChecked]
+                  #
+                  def assert_has_checked_status!
+                    return if entity.internals.cache.exist?(:has_checked_status)
+
+                    raise Exceptions::StatusIsNotChecked.new(attribute: method)
+                  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/raises_on_not_checked_result_status.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
-require_relative "raises_on_not_checked_result_status/errors"
+require_relative "raises_on_not_checked_result_status/exceptions"
 require_relative "raises_on_not_checked_result_status/middleware"

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

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
 require_relative "plugins/can_recalculate_result"
+require_relative "plugins/can_be_own_result"
+require_relative "plugins/can_be_stubbed_result"
+require_relative "plugins/can_have_fallbacks"
 require_relative "plugins/has_j_send_status_and_attributes"
 require_relative "plugins/has_inspect"
-require_relative "plugins/has_step"
+require_relative "plugins/has_stubbed_result_invocations_counter"
+require_relative "plugins/can_have_step"
 require_relative "plugins/can_have_parent_result"
-require_relative "plugins/has_result_short_syntax"
-require_relative "plugins/marks_result_status_as_checked"
+require_relative "plugins/can_have_checked_status"
 require_relative "plugins/raises_on_not_checked_result_status"
 
 require_relative "plugins/aliases"

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

@@ -6,7 +6,7 @@ require_relative "result/plugins"
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Entities
           class Result
             include Concern

data/lib/convenient_service/service/plugins/has_j_send_result/exceptions.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Exceptions
+          class ResultIsNotOverridden < ::ConvenientService::Exception
+            def initialize(service:)
+              message = <<~TEXT
+                Result method (#result) of `#{service.class}` is NOT overridden.
+              TEXT
+
+              super(message)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_j_send_result.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "has_j_send_result/concern"
+require_relative "has_j_send_result/constants"
+require_relative "has_j_send_result/container"
+require_relative "has_j_send_result/commands"
+require_relative "has_j_send_result/entities"
+require_relative "has_j_send_result/exceptions"

data/lib/convenient_service/service/plugins/{has_result_params_validations → has_j_send_result_params_validations}/using_active_model_validations/concern.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultParamsValidations
+      module HasJSendResultParamsValidations
         module UsingActiveModelValidations
           module Concern
             include Support::Concern

data/lib/convenient_service/service/plugins/has_j_send_result_params_validations/using_active_model_validations/middleware.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResultParamsValidations
+        module UsingActiveModelValidations
+          class Middleware < MethodChainMiddleware
+            intended_for :result, entity: :service
+
+            ##
+            # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+            #
+            def next(...)
+              return entity.public_send(status, data: errors, message: errors.first.to_a.map(&:to_s).join(" ")) if errors.any?
+
+              chain.next(...)
+            end
+
+            private
+
+            ##
+            # @internal
+            #   NOTE: errors method (from Active Model Validations) does NOT trigger validations
+            #   that is why valid? is called here.
+            #
+            #   Check the following link for more info:
+            #   - https://guides.rubyonrails.org/active_record_validations.html#validations-overview-errors
+            #
+            #   Quote (this method - errors):
+            #   > This method is only useful after validations have been run, because it only inspects the errors collection and does not trigger validations itself.
+            #
+            def errors
+              @errors ||= entity.tap(&:valid?).errors.messages.transform_values(&:first)
+            end
+
+            ##
+            # @return [Symbol]
+            #
+            def status
+              middleware_arguments.kwargs.fetch(:status) { :error }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/{has_result_params_validations → has_j_send_result_params_validations}/using_dry_validation/concern.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultParamsValidations
+      module HasJSendResultParamsValidations
         module UsingDryValidation
           module Concern
             include Support::Concern

data/lib/convenient_service/service/plugins/has_j_send_result_params_validations/using_dry_validation/middleware.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResultParamsValidations
+        module UsingDryValidation
+          class Middleware < MethodChainMiddleware
+            intended_for :result, entity: :service
+
+            ##
+            # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+            #
+            def next(...)
+              return entity.public_send(status, data: errors, message: errors.first.to_a.map(&:to_s).join(" ")) if errors.any?
+
+              chain.next(...)
+            end
+
+            private
+
+            ##
+            # @return [Hash{Symbol => Object}]
+            #
+            # @internal
+            #   NOTE: An example of `Dry::Validation::Contract` usage.
+            #   https://dry-rb.org/gems/dry-validation/1.8/#quick-start
+            #
+            #   TODO: Return one or all errors?
+            #
+            def errors
+              @errors ||= resolve_errors
+            end
+
+            ##
+            # @return [Hash{Symbol => Object}]
+            #
+            def constructor_kwargs
+              @constructor_kwargs ||= entity.constructor_arguments.kwargs
+            end
+
+            ##
+            # @return [Dry::Validation::Contract]
+            #
+            def contract
+              @contract ||= entity.class.contract
+            end
+
+            ##
+            # @return [Hash{Symbol => Object}]
+            #
+            def resolve_errors
+              return {} unless contract.schema
+
+              contract.new
+                .call(constructor_kwargs)
+                .errors
+                .to_h
+                .transform_values(&:first)
+            end
+
+            ##
+            # @return [Symbol]
+            #
+            def status
+              middleware_arguments.kwargs.fetch(:status) { :error }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/{has_result_short_syntax → has_j_send_result_short_syntax}/concern.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultShortSyntax
+      module HasJSendResultShortSyntax
         module Concern
           include Support::Concern