convenient_service 0.12.0 → 0.14.0

data/lib/convenient_service/service/plugins/{has_result → has_j_send_result}/concern/class_methods.rb

@@ -3,74 +3,70 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Concern
           module ClassMethods
-            ##
-            # @api public
-            # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
-            #
-            def result(...)
-              new(...).result
-            end
-
             ##
             # @api private
-            # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+            # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
             #
             # @internal
             #   NOTE: This method is internally used by custom RSpec helper `stub_service`. It should NOT be used in the client code.
             #
             def success(
-              service: create_without_initialize,
-              data: Constants::DEFAULT_SUCCESS_DATA
+              service: new_without_initialize,
+              data: Constants::DEFAULT_SUCCESS_DATA,
+              message: Constants::DEFAULT_SUCCESS_MESSAGE,
+              code: Constants::DEFAULT_SUCCESS_CODE
             )
-              result_class.create(
+              result_class.new(
                 service: service,
                 status: Constants::SUCCESS_STATUS,
                 data: data,
-                message: Constants::SUCCESS_MESSAGE,
-                code: Constants::SUCCESS_CODE
+                message: message,
+                code: code
               )
             end
 
             ##
             # @api private
-            # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+            # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
             #
             # @internal
             #   NOTE: This method is internally used by custom RSpec helper `stub_service`. It should NOT be used in the client code.
             #
             def failure(
-              service: create_without_initialize,
+              service: new_without_initialize,
               data: Constants::DEFAULT_FAILURE_DATA,
-              message: data.any? ? data.first.join(" ") : Constants::DEFAULT_FAILURE_MESSAGE
+              message: Constants::DEFAULT_FAILURE_MESSAGE,
+              code: Constants::DEFAULT_FAILURE_CODE
             )
-              result_class.create(
+              result_class.new(
                 service: service,
                 status: Constants::FAILURE_STATUS,
                 data: data,
                 message: message,
-                code: Constants::FAILURE_CODE
+                code: code
               )
             end
 
             ##
             # @api private
-            # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+            # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
             #
             # @internal
             #   NOTE: This method is internally used by custom RSpec helper `stub_service`. It should NOT be used in the client code.
             #
             def error(
-              service: create_without_initialize,
+              service: new_without_initialize,
+              data: Constants::DEFAULT_ERROR_DATA,
               message: Constants::DEFAULT_ERROR_MESSAGE,
               code: Constants::DEFAULT_ERROR_CODE
             )
-              result_class.create(
+              result_class.new(
                 service: service,
                 status: Constants::ERROR_STATUS,
-                data: Constants::ERROR_DATA,
+                data: data,
                 message: message,
                 code: code
               )

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

@@ -3,21 +3,13 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Concern
           module InstanceMethods
-            ##
-            # @api public
-            # @raise [ConvenientService::Service::Plugins::HasResult::Errors::ResultIsNotOverridden]
-            #
-            def result
-              raise Errors::ResultIsNotOverridden.new(service: self)
-            end
-
             ##
             # @api public
             # @param kwargs [Hash{Symbol => Object}]
-            # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+            # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
             #
             def success(**kwargs)
               self.class.success(**kwargs.merge(service: self))
@@ -26,7 +18,7 @@ module ConvenientService
             ##
             # @api public
             # @param kwargs [Hash{Symbol => Object}]
-            # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+            # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
             #
             def failure(**kwargs)
               self.class.failure(**kwargs.merge(service: self))
@@ -35,7 +27,7 @@ module ConvenientService
             ##
             # @api public
             # @param kwargs [Hash{Symbol => Object}]
-            # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+            # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
             #
             def error(**kwargs)
               self.class.error(**kwargs.merge(service: self))

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "concern/instance_methods"
+require_relative "concern/class_methods"
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Concern
+          include Support::Concern
+
+          included do |service_class|
+            service_class.include InstanceMethods
+
+            service_class.extend ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Constants
           SUCCESS_STATUS = :success
           FAILURE_STATUS = :failure
@@ -11,14 +11,14 @@ module ConvenientService
 
           DEFAULT_SUCCESS_DATA = {}
           DEFAULT_FAILURE_DATA = {}
-          ERROR_DATA = {}
+          DEFAULT_ERROR_DATA = {}
 
-          SUCCESS_MESSAGE = ""
+          DEFAULT_SUCCESS_MESSAGE = ""
           DEFAULT_FAILURE_MESSAGE = ""
           DEFAULT_ERROR_MESSAGE = ""
 
-          SUCCESS_CODE = :success
-          FAILURE_CODE = :failure
+          DEFAULT_SUCCESS_CODE = :default_success
+          DEFAULT_FAILURE_CODE = :default_failure
           DEFAULT_ERROR_CODE = :default_error
         end
       end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Container
+          include Support::DependencyContainer::Export
+
+          export :"commands.is_result?" do |result|
+            Commands::IsResult.call(result: result)
+          end
+
+          export :"constants.DEFAULT_SUCCESS_CODE" do
+            Constants::DEFAULT_SUCCESS_CODE
+          end
+
+          export :"constants.DEFAULT_FAILURE_CODE" do
+            Constants::DEFAULT_FAILURE_CODE
+          end
+
+          export :"constants.DEFAULT_ERROR_CODE" do
+            Constants::DEFAULT_ERROR_CODE
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

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

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_result/entities/result/plugins/has_inspect → has_j_send_result/entities/result/plugins/can_be_stubbed_result}/concern.rb

@@ -3,21 +3,20 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Entities
           class Result
             module Plugins
-              module HasInspect
+              module CanBeStubbedResult
                 module Concern
                   include Support::Concern
 
                   instance_methods do
                     ##
-                    # @return [String]
-                    # @since 0.2.0
+                    # @return [Boolean]
                     #
-                    def inspect
-                      "<#{service.class.name}::Result status: :#{status}>"
+                    def stubbed_result?
+                      Utils.to_bool(extra_kwargs[:stubbed_result])
                     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_result/entities/result/plugins/has_step → has_j_send_result/entities/result/plugins/can_have_checked_status}/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 CanHaveCheckedStatus
                 module Concern
                   include Support::Concern
 
                   instance_methods do
-                    def step
-                      @step ||= internals.cache[:step]
+                    ##
+                    # @return [Boolean]
+                    #
+                    def has_checked_status?
+                      Utils.to_bool(internals.cache[:has_checked_status])
                     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_j_send_result/entities/result/plugins/can_have_fallbacks/concern.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module CanHaveFallbacks
+                module Concern
+                  include Support::Concern
+
+                  instance_methods do
+                    ##
+                    # @return [Boolean]
+                    #
+                    def fallback_failure_result?
+                      Utils.to_bool(extra_kwargs[:fallback_failure_result])
+                    end
+
+                    ##
+                    # @return [Boolean]
+                    #
+                    def fallback_error_result?
+                      Utils.to_bool(extra_kwargs[:fallback_error_result])
+                    end
+
+                    ##
+                    # @return [Boolean]
+                    #
+                    def fallback_result?
+                      fallback_failure_result? || fallback_error_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_have_fallbacks.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "can_have_fallbacks/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