convenient_service 0.12.0 → 0.13.0

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

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module CanBeOwnResult
+                module Concern
+                  include Support::Concern
+
+                  instance_methods do
+                    ##
+                    # Checks whether a result is an own result for a service instance.
+                    # If the result is own then it is one of `success`, `failure`, `error` or step result.
+                    # Otherwise it is foreign for that particular service instance.
+                    #
+                    # @api private
+                    #
+                    # @param service [ConvenientService::Service]
+                    # @return [Boolean]
+                    #
+                    # @example `success`, `failure` and `error` are own results for service instance.
+                    #   class Service
+                    #     include ConvenientService::Standard::Config
+                    #
+                    #     def result
+                    #       success
+                    #     end
+                    #   end
+                    #
+                    #   first_service = Service.new
+                    #   second_service = Service.new
+                    #
+                    #   first_service.result.own_result_for?(first_service)
+                    #   # => true
+                    #
+                    #   second_service.result.own_result_for?(first_service)
+                    #   # => false
+                    #
+                    # @example Service step results are own results for service instance.
+                    #   class Service
+                    #     include ConvenientService::Standard::Config
+                    #
+                    #     step OtherService
+                    #   end
+                    #
+                    #   first_service = Service.new
+                    #   second_service = Service.new
+                    #
+                    #   first_service.steps.first.result.own_result_for?(first_service)
+                    #   # => true
+                    #
+                    #   second_service.steps.first.result.own_result_for?(first_service)
+                    #   # => false
+                    #
+                    # @example Method step results are own results for service instance.
+                    #   class Service
+                    #     include ConvenientService::Standard::Config
+                    #
+                    #     step :foo
+                    #
+                    #     def foo
+                    #       success
+                    #     end
+                    #   end
+                    #
+                    #   first_service = Service.new
+                    #   second_service = Service.new
+                    #
+                    #   first_service.steps.first.result.own_result_for?(first_service)
+                    #   # => true
+                    #
+                    #   second_service.steps.first.result.own_result_for?(first_service)
+                    #   # => false
+                    #
+                    # @example All results that are NOT any of `success`, `failure`, `error` or step results are NOT own results for service instance. Such results are called `foreign` service results.
+                    #   class Service
+                    #     include ConvenientService::Standard::Config
+                    #
+                    #     def result
+                    #       OtherService.result
+                    #     end
+                    #   end
+                    #
+                    #   first_service = Service.new
+                    #   second_service = Service.new
+                    #
+                    #   first_service.result.own_result_for?(first_service)
+                    #   # => false
+                    #
+                    #   second_service.result.own_result_for?(first_service)
+                    #   # => false
+                    #
+                    # @example Edge case: Step results are always own even when method step result calls foreign service result.
+                    #   class Service
+                    #     include ConvenientService::Standard::Config
+                    #
+                    #     step :foo
+                    #
+                    #     def foo
+                    #       OtherService.result
+                    #     end
+                    #   end
+                    #
+                    #   first_service = Service.new
+                    #   second_service = Service.new
+                    #
+                    #   first_service.result.own_result_for?(first_service)
+                    #   # => true
+                    #
+                    #   second_service.result.own_result_for?(first_service)
+                    #   # => false
+                    #
+                    def own_result_for?(service)
+                      self.service.equal?(service)
+                    end
+
+                    ##
+                    # Checks whether a result is a foreign result for a service instance.
+                    # Opposite to own result.
+                    #
+                    # @api private
+                    #
+                    # @param service [ConvenientService::Service]
+                    # @return [Boolean]
+                    #
+                    def foreign_result_for?(service)
+                      !own_result_for?(service)
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/can_be_stubbed_result/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 CanBeStubbedResult
+                module Concern
+                  include Support::Concern
+
+                  instance_methods do
+                    ##
+                    # @return [Boolean]
+                    #
+                    def stubbed_result?
+                      Utils.to_bool(extra_kwargs[:stubbed_result])
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/can_have_checked_status/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 CanHaveCheckedStatus
+                module Concern
+                  include Support::Concern
+
+                  instance_methods do
+                    ##
+                    # @return [Boolean]
+                    #
+                    def has_checked_status?
+                      Utils.to_bool(internals.cache[:has_checked_status])
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module CanHaveCheckedStatus
+                class Middleware < MethodChainMiddleware
+                  intended_for [
+                    :success?,
+                    :failure?,
+                    :error?,
+                    :not_success?,
+                    :not_failure?,
+                    :not_error?
+                  ],
+                    entity: :result
+
+                  ##
+                  # @param args [Array<Object>]
+                  # @param kwargs [Hash{Symbol => Object}]
+                  # @param block [Proc, nil]
+                  # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+                  #
+                  def next(*args, **kwargs, &block)
+                    mark_status_as_checked = kwargs.fetch(:mark_status_as_checked) { true }
+
+                    entity.internals.cache[:has_checked_status] = true if mark_status_as_checked
+
+                    chain.next(*args, **Utils::Hash.except(kwargs, [:mark_status_as_checked]), &block)
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -3,17 +3,20 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Entities
           class Result
             module Plugins
-              module HasStep
+              module CanHaveFallback
                 module Concern
                   include Support::Concern
 
                   instance_methods do
-                    def step
-                      @step ||= internals.cache[:step]
+                    ##
+                    # @return [Boolean]
+                    #
+                    def fallback_result?
+                      Utils.to_bool(extra_kwargs[:fallback_result])
                     end
                   end
                 end

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

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

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Entities
           class Result
             module Plugins
@@ -13,16 +13,19 @@ module ConvenientService
 
                   instance_methods do
                     ##
-                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result, nil]
+                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result, nil]
+                    #
+                    # @internal
+                    #   TODO: What if result is created from method step? Who is its parent?
                     #
                     def parent
-                      Utils::Object.memoize_including_falsy_values(self, :@parent) { internals.cache[:parent] }
+                      Utils.memoize_including_falsy_values(self, :@parent) { extra_kwargs[:parent] }
                     end
 
                     ##
                     # @param include_self [Boolean]
                     # @param limit [Integer]
-                    # @return [Array<ConvenientService::Service::Plugins::HasResult::Entities::Result>]
+                    # @return [Array<ConvenientService::Service::Plugins::HasJSendResult::Entities::Result>]
                     #
                     # @internal
                     #   Without enumerator `parents` method is roughly equivalent to the following code:
@@ -54,7 +57,7 @@ module ConvenientService
                     ##
                     # @param include_self [Boolean]
                     # @param limit [Integer]
-                    # @return [Enumerator<ConvenientService::Service::Plugins::HasResult::Entities::Result>]
+                    # @return [Enumerator<ConvenientService::Service::Plugins::HasJSendResult::Entities::Result>]
                     #
                     # @see https://ruby-doc.org/core-2.7.0/Enumerator.html
                     #

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Entities
           class Result
             module Plugins

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

@@ -2,5 +2,3 @@
 
 require_relative "can_have_parent_result/concern"
 require_relative "can_have_parent_result/constants"
-require_relative "can_have_parent_result/initialize"
-require_relative "can_have_parent_result/to_kwargs"

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/can_have_step/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 CanHaveStep
+                module Concern
+                  include Support::Concern
+
+                  instance_methods do
+                    ##
+                    # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step, nil]
+                    #
+                    def step
+                      Utils.memoize_including_falsy_values(self, :@step) { extra_kwargs[:step] }
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -3,7 +3,7 @@
 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_awesome_print_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 HasAwesomePrintInspect
+                module Concern
+                  include Support::Concern
+
+                  instance_methods do
+                    ##
+                    # @return [String]
+                    #
+                    def inspect
+                      metadata = {
+                        ConvenientService: {
+                          entity: "Result",
+                          service: service.inspect_values[:name],
+                          status: status.to_sym
+                        }
+                      }
+
+                      metadata.ai
+                    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_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_result → has_j_send_result}/entities/result/plugins/has_inspect/concern.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Entities
           class Result
             module Plugins
@@ -14,10 +14,9 @@ module ConvenientService
                   instance_methods do
                     ##
                     # @return [String]
-                    # @since 0.2.0
                     #
                     def inspect
-                      "<#{service.class.name}::Result status: :#{status}>"
+                      "<#{service.inspect_values[:name]}::Result status: :#{status}>"
                     end
                   end
                 end

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

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJSendStatusAndAttributes
+                module Commands
+                  class CastJSendAttributes < Support::Command
+                    ##
+                    # @!attribute [r] result
+                    #   @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+                    #
+                    attr_reader :result
+
+                    ##
+                    # @!attribute [r] kwargs
+                    #   @return [Hash{Symbol => Object}]
+                    #
+                    attr_reader :kwargs
+
+                    ##
+                    # @param result [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+                    # @param kwargs [Hash{Symbol => Object}]
+                    # @return [void]
+                    #
+                    def initialize(result:, kwargs:)
+                      @result = result
+                      @kwargs = kwargs
+                    end
+
+                    ##
+                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Structs::JSendAttributes]
+                    # @raise [ConvenientService::Support::Castable::Exceptions::FailedToCast]
+                    #
+                    def call
+                      Structs::JSendAttributes.new(service: service, status: status, data: data, message: message, code: code, extra_kwargs: extra_kwargs)
+                    end
+
+                    private
+
+                    ##
+                    # @return [Object]
+                    #
+                    def service
+                      kwargs[:service]
+                    end
+
+                    ##
+                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Status]
+                    # @raise [ConvenientService::Support::Castable::Exceptions::FailedToCast]
+                    #
+                    def status
+                      @status ||= result.class.status(value: kwargs[:status], result: result)
+                    end
+
+                    ##
+                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Data]
+                    # @raise [ConvenientService::Support::Castable::Exceptions::FailedToCast]
+                    #
+                    def data
+                      @data ||= result.class.data(value: kwargs[:data], result: result)
+                    end
+
+                    ##
+                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Message]
+                    # @raise [ConvenientService::Support::Castable::Exceptions::FailedToCast]
+                    #
+                    def message
+                      @message ||= result.class.message(value: kwargs[:message], result: result)
+                    end
+
+                    ##
+                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Code]
+                    # @raise [ConvenientService::Support::Castable::Exceptions::FailedToCast]
+                    #
+                    def code
+                      @code ||= result.class.code(value: kwargs[:code], result: result)
+                    end
+
+                    ##
+                    # @return [Hash{Symbol => Object}]
+                    #
+                    def extra_kwargs
+                      @extra_kwargs ||= Utils::Hash.except(kwargs, [:service, :status, :data, :message, :code])
+                    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/commands/create_code_class.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Entities
           class Result
             module Plugins

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Entities
           class Result
             module Plugins

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Entities
           class Result
             module Plugins

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Entities
           class Result
             module Plugins