convenient_service 0.12.0 → 0.13.0

data/lib/convenient_service/service/plugins/can_have_stubbed_results/middleware.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module CanHaveStubbedResults
+        class Middleware < MethodChainMiddleware
+          intended_for :result, scope: any_scope, entity: :service
+
+          ##
+          # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+          #
+          def next(...)
+            return cache[key_with_arguments] if cache.exist?(key_with_arguments)
+            return cache[key_without_arguments] if cache.exist?(key_without_arguments)
+
+            chain.next(...)
+          end
+
+          private
+
+          ##
+          # @return [ConvenientService::Support::Cache]
+          #
+          def cache
+            @cache ||= Utils::Object.clamp_class(entity).stubbed_results
+          end
+
+          ##
+          # @return [ConvenientService::Support::Cache::Entities::Key]
+          #
+          # @internal
+          #   NOTE: When middleware is used for a class, it takes arguments from class `result` method. For example:
+          #
+          #     # `next_arguments`.
+          #     result = Service.result(*args, **kwargs, &block)
+          #
+          #   NOTE: When middleware is used for an instance, it takes arguments from class `new` method. For example:
+          #
+          #     # `entity.constructor_arguments`.
+          #     service = Service.new(*args, **kwargs, &block)
+          #     result = service.result
+          #
+          #   TODO: Think about two separate middlewares with shared commands.
+          #
+          def key_with_arguments
+            @key_with_arguments ||=
+              if entity.instance_of?(::Class)
+                cache.keygen(*next_arguments.args, **next_arguments.kwargs, &next_arguments.block)
+              else
+                cache.keygen(*entity.constructor_arguments.args, **entity.constructor_arguments.kwargs, &entity.constructor_arguments.block)
+              end
+          end
+
+          ##
+          # @return [ConvenientService::Support::Cache::Entities::Key]
+          #
+          def key_without_arguments
+            @key_without_arguments ||= cache.keygen
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative "can_have_stubbed_results/commands"
+require_relative "can_have_stubbed_results/concern"
+require_relative "can_have_stubbed_results/container"
+require_relative "can_have_stubbed_results/middleware"

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

@@ -11,7 +11,7 @@ module ConvenientService
           # NOTE: `CanRecalculateResult` plugin expects that `CanBeCopied` plugin is already included.
           # That is why `copy` method is available.
           #
-          # NOTE: `CanRecalculateResult` plugin expects that `HasResult` plugin is already included.
+          # NOTE: `CanRecalculateResult` plugin expects that `HasJSendResult` plugin is already included.
           # That is why `result` method is available.
           #
           instance_methods do

data/lib/convenient_service/service/plugins/collects_services_in_exception/commands/extract_service_details.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module CollectsServicesInException
+        module Commands
+          class ExtractServiceDetails < Support::Command
+            ##
+            # @!attribute [r] service
+            #   @return [ConvenientService::Service]
+            #
+            attr_reader :service
+
+            ##
+            # @!attribute [r] method
+            #   @return [Symbol]
+            #
+            attr_reader :method
+
+            ##
+            # @param service [ConvenientService::Service]
+            # @return [void]
+            #
+            def initialize(service:, method:)
+              @service = service
+              @method = method
+            end
+
+            ##
+            # @return [Hash{Symbol => Object}]
+            #
+            def call
+              {instance: service, trigger: trigger}
+            end
+
+            ##
+            # @return [Hash{Symbol => Object}]
+            #
+            # @internal
+            #   PARANOID: `unless first_not_completed_step` is a paranoid code (probably `ConvenientService` bug).
+            #   - https://encyclopedia2.thefreedictionary.com/paranoid+programming
+            #   - https://dzone.com/articles/defensive-programming-just
+            #
+            def trigger
+              return {method: ":#{method}"} if method != :result
+              return {method: ":result"} if service.steps.none?
+              return {step: "Unknown Step", index: -1} unless first_not_completed_step
+
+              {step: first_not_completed_step.printable_service, index: first_not_completed_step.index}
+            end
+
+            ##
+            # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step, nil]
+            #
+            def first_not_completed_step
+              Utils.memoize_including_falsy_values(self, :@first_not_completed_step) { service.steps.find(&:not_completed?) }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/collects_services_in_exception/commands.rb

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

data/lib/convenient_service/service/plugins/collects_services_in_exception/constants.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module CollectsServicesInException
+        module Constants
+          ##
+          # @return [Integer]
+          #
+          DEFAULT_MAX_SERVICES_SIZE = 1_000
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/collects_services_in_exception/middleware.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module CollectsServicesInException
+        class Middleware < MethodChainMiddleware
+          intended_for [
+            :initialize,
+            :result,
+            :fallback_result
+          ],
+            entity: :service
+
+          ##
+          # @raise [StandardError]
+          #
+          # @internal
+          #   NOTE: `rescue ::StandardError => exception` is the same as `rescue => exception`.
+          #
+          def next(...)
+            chain.next(...)
+          rescue => exception
+            exception.instance_exec { define_singleton_method(:services) { @services ||= [] } } unless exception.respond_to?(:services)
+
+            Utils::Array.limited_push(exception.services, service_details, limit: max_services_size)
+
+            raise
+          end
+
+          private
+
+          ##
+          # @return [Hash{Symbol => Object}]
+          #
+          def service_details
+            Commands::ExtractServiceDetails.call(service: entity, method: method)
+          end
+
+          ##
+          # @return [Integer]
+          #
+          def max_services_size
+            middleware_arguments.kwargs.fetch(:max_services_size) { Constants::DEFAULT_MAX_SERVICES_SIZE }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "collects_services_in_exception/commands"
+require_relative "collects_services_in_exception/constants"
+require_relative "collects_services_in_exception/middleware"

data/lib/convenient_service/service/plugins/counts_stubbed_results_invocations/middleware.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module CountsStubbedResultsInvocations
+        class Middleware < MethodChainMiddleware
+          intended_for :result, scope: any_scope, entity: :service
+
+          ##
+          # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+          #
+          def next(...)
+            result = chain.next(...)
+
+            result.stubbed_result_invocations_counter.increment! if result.stubbed_result?
+
+            result
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "counts_stubbed_results_invocations/middleware"

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasAwesomePrintInspect
+        module Concern
+          include Support::Concern
+
+          instance_methods do
+            ##
+            # @return [String]
+            #
+            def inspect
+              metadata = {
+                ConvenientService: {
+                  entity: "Service",
+                  name: inspect_values[:name]
+                }
+              }
+
+              metadata.ai
+            end
+
+            ##
+            # @return [Hash{Symbol => Object}]
+            #
+            # @internal
+            #   NOTE: It is a coincidence that `HasInspect#inspect_values` has exactly the same implementation. There is NO intention to keep them in sync.
+            #
+            def inspect_values
+              {name: Utils::Class.display_name(self.class)}
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/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_inspect/concern.rb

@@ -13,7 +13,14 @@ module ConvenientService
             # @since 0.2.0
             #
             def inspect
-              "<#{self.class.name}>"
+              "<#{inspect_values[:name]}>"
+            end
+
+            ##
+            # @return [Hash{Symbol => Object}]
+            #
+            def inspect_values
+              {name: Utils::Class.display_name(self.class)}
             end
           end
         end

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Commands
           class CreateResultClass < Support::Command
             include Support::DependencyContainer::Import

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Commands
+          class IsResult < Support::Command
+            ##
+            # @!attribute [r] result
+            #   @return [Object] Can be any type.
+            #
+            attr_reader :result
+
+            ##
+            # @param result [Object] Can be any type.
+            # @return [void]
+            #
+            def initialize(result:)
+              @result = result
+            end
+
+            ##
+            # @return [void]
+            #
+            def call
+              result.class.include?(Entities::Result::Concern)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
 # frozen_string_literal: true
 
 require_relative "commands/create_result_class"
+
+require_relative "commands/is_result"

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

@@ -3,29 +3,24 @@
 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.
             #
+            #   TODO: Is it OK to pass custom `message`, `code` to `success`? Why?
+            #   NOTE: Extract to `HasJSendResults`.
+            #
             def success(
-              service: create_without_initialize,
+              service: new_without_initialize,
               data: Constants::DEFAULT_SUCCESS_DATA
             )
-              result_class.create(
+              result_class.new(
                 service: service,
                 status: Constants::SUCCESS_STATUS,
                 data: data,
@@ -36,17 +31,22 @@ module ConvenientService
 
             ##
             # @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.
             #
+            #   TODO: Is it OK to pass custom `code` to `failure`? Why?
+            #   NOTE: Extract to `HasJSendResults`.
+            #
+            #   TODO: `data.first.join(" ")` is duplicated in `be_result` matcher.
+            #
             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
             )
-              result_class.create(
+              result_class.new(
                 service: service,
                 status: Constants::FAILURE_STATUS,
                 data: data,
@@ -57,17 +57,20 @@ module ConvenientService
 
             ##
             # @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.
             #
+            #   TODO: Is it OK to pass custom `data` to `error`? Why?
+            #   NOTE: Extract to `HasJSendResults`.
+            #
             def error(
-              service: create_without_initialize,
+              service: new_without_initialize,
               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/lib/convenient_service/service/plugins/{has_result → has_j_send_result}/concern/instance_methods.rb

@@ -3,21 +3,16 @@
 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]
+            #
+            # @internal
+            #   NOTE: Extract to `HasJSendResults`.
             #
             def success(**kwargs)
               self.class.success(**kwargs.merge(service: self))
@@ -26,7 +21,10 @@ module ConvenientService
             ##
             # @api public
             # @param kwargs [Hash{Symbol => Object}]
-            # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+            # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+            #
+            # @internal
+            #   NOTE: Extract to `HasJSendResults`.
             #
             def failure(**kwargs)
               self.class.failure(**kwargs.merge(service: self))
@@ -35,7 +33,10 @@ module ConvenientService
             ##
             # @api public
             # @param kwargs [Hash{Symbol => Object}]
-            # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+            # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+            #
+            # @internal
+            #   NOTE: Extract to `HasJSendResults`.
             #
             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

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

@@ -0,0 +1,21 @@
+# 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_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