convenient_service 0.12.0 → 0.13.0

data/lib/convenient_service/common/plugins/caches_constructor_params/concern.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Common
-    module Plugins
-      module CachesConstructorParams
-        module Concern
-          include Support::Concern
-
-          ##
-          # TODO: `internals.cache[:constructor_params] || Entities::NullConstructorParams.new`
-          #
-          instance_methods do
-            def constructor_params
-              internals.cache[:constructor_params]
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/common/plugins/caches_constructor_params/entities/constructor_params.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Common
-    module Plugins
-      module CachesConstructorParams
-        module Entities
-          class ConstructorParams
-            attr_reader :args, :kwargs, :block
-
-            ##
-            # TODO: Specs for default values.
-            #
-            def initialize(args: [], kwargs: {}, block: nil)
-              @args = args
-              @kwargs = kwargs
-              @block = block
-            end
-
-            def ==(other)
-              return unless other.instance_of?(self.class)
-
-              return false if args != other.args
-              return false if kwargs != other.kwargs
-              return false if block&.source_location != other.block&.source_location
-
-              true
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/common/plugins/caches_constructor_params/entities.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "entities/constructor_params"

data/lib/convenient_service/common/plugins/caches_constructor_params/middleware.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Common
-    module Plugins
-      module CachesConstructorParams
-        class Middleware < Core::MethodChainMiddleware
-          def next(*args, **kwargs, &block)
-            entity.internals.cache[:constructor_params] = Entities::ConstructorParams.new(args: args, kwargs: kwargs, block: block)
-
-            chain.next(*args, **kwargs, &block)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/common/plugins/caches_constructor_params.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "caches_constructor_params/concern"
-require_relative "caches_constructor_params/entities"
-require_relative "caches_constructor_params/middleware"

data/lib/convenient_service/core/class_methods.rb

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Core
-    module ClassMethods
-      ##
-      # @see ConvenientService::Core::Entities::Config#concerns
-      #
-      # @internal
-      #   NOTE: The instance variable is named `@__convenient_service_config__` intentionally in order to decrease the possibility of accidental redefinition by the end-user.
-      #   NOTE: An `attr_reader` for `@__convenient_service_config__` is NOT created intentionally in order to NOT pollute the end-user class interface.
-      #
-      def concerns(...)
-        (@__convenient_service_config__ ||= Entities::Config.new(klass: self)).concerns(...)
-      end
-
-      ##
-      # @see ConvenientService::Core::Entities::Config#middlewares
-      #
-      # @internal
-      #   NOTE: The instance variable is named `@__convenient_service_config__` intentionally in order to decrease the possibility of accidental redefinition by the end-user.
-      #   NOTE: An `attr_reader` for `@__convenient_service_config__` is NOT created intentionally in order to NOT pollute the end-user class interface.
-      #
-      def middlewares(...)
-        (@__convenient_service_config__ ||= Entities::Config.new(klass: self)).middlewares(...)
-      end
-
-      ##
-      # Commits config when called for the first time.
-      # Does nothing for the subsequent calls.
-      #
-      # @param trigger [ConvenientService::Support::UniqueValue]
-      # @return [Boolean] true if called for the first time, false otherwise (similarly as Kernel#require).
-      #
-      # @see https://ruby-doc.org/core-3.1.2/Kernel.html#method-i-require
-      #
-      # @internal
-      #   NOTE: The instance variable is named `@__convenient_service_config__` intentionally in order to decrease the possibility of accidental redefinition by the end-user.
-      #   NOTE: An `attr_reader` for `@__convenient_service_config__` is NOT created intentionally in order to NOT pollute the end-user class interface.
-      #
-      def commit_config!(trigger: ConvenientService::Core::Constants::Triggers::USER)
-        (@__convenient_service_config__ ||= Entities::Config.new(klass: self)).commit!(trigger: trigger)
-          .tap { ConvenientService.logger.debug { "[Core] Committed config for `#{self}` | Triggered by `.commit_config!(trigger: #{trigger.inspect})` " } }
-      end
-
-      ##
-      # @see https://thoughtbot.com/blog/always-define-respond-to-missing-when-overriding
-      # @see https://stackoverflow.com/a/3304683/12201472
-      #
-      # @param method_name [Symbol, String]
-      # @param include_private [Boolean]
-      # @return [Boolean]
-      #
-      def respond_to_missing?(method_name, include_private = false)
-        return true if singleton_class.method_defined?(method_name)
-        return true if concerns.class_method_defined?(method_name)
-
-        if include_private
-          return true if singleton_class.private_method_defined?(method_name)
-          return true if concerns.private_class_method_defined?(method_name)
-        end
-
-        false
-      end
-
-      private
-
-      ##
-      # Includes `concerns` into the mixing class.
-      # If `method` is still NOT defined, raises `NoMethodError`, otherwise - retries to call the `method`.
-      #
-      # @param method [Symbol]
-      # @param args [Array<Object>]
-      # @param kwargs [Hash{Symbol => Object}]
-      # @param block [Proc, nil]
-      # @return [void]
-      #
-      # @internal
-      #   IMPORTANT: `method_missing` MUST be thread-safe.
-      #
-      #   NOTE: `__send__` is used instead of `Support::SafeMethod` intentionally, since checking whether a method is defined is performed earlier by `Utils::Module.class_method_defined?`.
-      #
-      def method_missing(method, *args, **kwargs, &block)
-        commit_config!(trigger: Constants::Triggers::CLASS_METHOD_MISSING)
-
-        return super unless Utils::Module.class_method_defined?(self, method, private: true)
-
-        return super if middlewares(method, scope: :class).defined_without_super_method?
-
-        ConvenientService.logger.debug { "[Core] Committed config for `#{self}` | Triggered by `method_missing` | Method: `.#{method}`" }
-
-        __send__(method, *args, **kwargs, &block)
-      end
-    end
-  end
-end

data/lib/convenient_service/core/entities/classic_middleware.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Core
-    module Entities
-      class ClassicMiddleware
-        ##
-        # @param stack [#call<Hash>]
-        # @return [void]
-        #
-        def initialize(stack)
-          @stack = stack
-        end
-
-        ##
-        # @return [Object] Can be any type.
-        #
-        def call(env)
-          stack.call(env)
-        end
-
-        private
-
-        ##
-        # @!attribute [r] stack
-        #   @return [#call<Hash>]
-        #
-        attr_reader :stack
-      end
-    end
-  end
-end

data/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/chain.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Core
-    module Entities
-      class Config
-        module Entities
-          class MethodMiddlewares
-            module Entities
-              ##
-              # @internal
-              #   NOTE: Do NOT pollute the interface of this class until really needed.
-              #
-              class Chain
-                ##
-                # @param stack [#call<Hash>]
-                # @param env [Hash]
-                # @return [void]
-                #
-                def initialize(stack:, env: {})
-                  @stack = stack
-                  @env = env
-                end
-
-                ##
-                # @param args [Array<Object>]
-                # @param kwargs [Hash{Symbol => Object}]
-                # @param block [Proc, nil]
-                # @return [Object] Can be any type.
-                #
-                # @internal
-                #   TODO: Enforce to always pass args, kwargs, block.
-                #
-                def next(*args, **kwargs, &block)
-                  stack.call(env.merge(args: args, kwargs: kwargs, block: block))
-                end
-
-                ##
-                # @param other [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Chain, Object]
-                # @return [Boolean]
-                #
-                def ==(other)
-                  return unless other.instance_of?(self.class)
-
-                  return false if stack != other.stack
-                  return false if env != other.env
-
-                  true
-                end
-
-                protected
-
-                ##
-                # @!attribute [r] stack
-                #   @return [#call<Hash>]
-                #
-                attr_reader :stack
-
-                ##
-                # @!attribute [r] env
-                #   @return [Hash]
-                #
-                attr_reader :env
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/middleware.rb

@@ -1,131 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Core
-    module Entities
-      class Config
-        module Entities
-          class MethodMiddlewares
-            module Entities
-              ##
-              # @abstract Subclass and override `#next`.
-              #
-              # @internal
-              #   NOTE: Do NOT pollute the interface of this class until really needed.
-              #   Avoid even pollution of private methods.
-              #   This way there is a lower risk that a plugin developer accidentally overwrites an internal middleware behavior.
-              #   https://github.com/Ibsciss/ruby-middleware#a-basic-example
-              #
-              class Middleware
-                include Support::AbstractMethod
-
-                ##
-                # @return [Object] Can be any type.
-                # @raise [ConvenientService::Support::AbstractMethod::Errors::AbstractMethodNotOverridden] if NOT overridden in descendant.
-                #
-                # @example Subclass should call `value = chain.next(*args, **kwargs, &block)` to trigger next middleware in a stack.
-                #   def next(*args, **kwargs, &block)
-                #     # pre processing...
-                #
-                #     value = chain.next(*args, **kwargs, &block)
-                #
-                #     # post processing...
-                #
-                #     post_processed_value
-                #   end
-                #
-                # @see https://refactoring.guru/design-patterns/decorator
-                #
-                # @note But it completely OK, to omit `chain.next(*args, **kwargs, &block)` completely.
-                #   This way middleware stack is stopped in the "middle" and its "middle" value is returned.
-                # @see https://refactoring.guru/design-patterns/proxy
-                # @see https://refactoring.guru/design-patterns/chain-of-responsibility
-                #
-                abstract_method :next
-
-                class << self
-                  ##
-                  # @return [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::MiddlewareCreator]
-                  #
-                  def with(...)
-                    Entities::MiddlewareCreator.new(middleware: self, arguments: Support::Arguments.new(...))
-                  end
-                end
-
-                ##
-                # @param stack [#call<Hash>]
-                # @return [void]
-                #
-                def initialize(stack, env: {}, arguments: Support::Arguments.null_arguments)
-                  @__stack__ = stack
-                  @__env__ = env
-                  @__arguments__ = arguments
-                end
-
-                ##
-                # @param env [Hash]
-                # @return [Object] Can be any type.
-                #
-                def call(env)
-                  @__env__ = env
-
-                  ##
-                  # IMPORTANT: This is a library code. Do NOT do things like this in your application code.
-                  #
-                  chain.instance_variable_set(:@env, env)
-
-                  ##
-                  # NOTE: `__send__` is used since `next` is ruby keyword.
-                  # https://ruby-doc.org/core-2.7.0/doc/keywords_rdoc.html
-                  #
-                  # TODO: Enforce to always pass args, kwargs, block.
-                  #
-                  __send__(:next, *env[:args], **env[:kwargs], &env[:block])
-                end
-
-                ##
-                # @return [Class, Object]
-                #
-                # @internal
-                #   NOTE: `@__env__` is set inside `call`.
-                #
-                def entity
-                  @__env__[:entity]
-                end
-
-                ##
-                # @return [Symbol]
-                #
-                # @note Try to avoid `if` conditions based on `method` value when possible, prefer to create separate middlewares instead.
-                #
-                # @internal
-                #   NOTE: `@__env__` is set inside `call`.
-                #
-                def method
-                  @__env__[:method]
-                end
-
-                ##
-                # @return [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Chain]
-                #
-                # @internal
-                #   NOTE: `@__env__` is set inside `call`.
-                #
-                def chain
-                  @__chain__ ||= Entities::Chain.new(stack: @__stack__)
-                end
-
-                ##
-                # @return [ConvenientService::Support::Arguments]
-                #
-                def arguments
-                  @__arguments__
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/middleware_creator.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Core
-    module Entities
-      class Config
-        module Entities
-          class MethodMiddlewares
-            module Entities
-              class MiddlewareCreator
-                ##
-                # @!attribute [r] middleware
-                #   @return [Class]
-                #
-                attr_reader :middleware
-
-                ##
-                # @!attribute [r] arguments
-                #   @return [ConvenientService::Support::Arguments]
-                #
-                attr_reader :arguments
-
-                ##
-                # @param middleware [Class]
-                # @param arguments [ConvenientService::Support::Arguments]
-                # @return [void]
-                #
-                def initialize(middleware:, arguments:)
-                  @middleware = middleware
-                  @arguments = arguments
-                end
-
-                ##
-                # @param other [Object]
-                # @return [Boolean, nil]
-                #
-                def ==(other)
-                  return unless other.instance_of?(self.class)
-
-                  return false if middleware != other.middleware
-                  return false if arguments != other.arguments
-
-                  true
-                end
-
-                ##
-                # @param stack [#call<Hash>]
-                # @param env [Hash]
-                # @param arguments [ConvenientService::Support::Arguments]
-                # @return [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Middleware]
-                #
-                def new(stack, env: {}, arguments: self.arguments)
-                  middleware.new(stack, env: env, arguments: arguments)
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/core/instance_methods.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Core
-    module InstanceMethods
-      ##
-      # @see https://thoughtbot.com/blog/always-define-respond-to-missing-when-overriding
-      # @see https://stackoverflow.com/a/3304683/12201472
-      #
-      # @param method_name [Symbol, String]
-      # @param include_private [Boolean]
-      # @return [Boolean]
-      #
-      def respond_to_missing?(method_name, include_private = false)
-        return true if self.class.method_defined?(method_name)
-        return true if self.class.concerns.instance_method_defined?(method_name)
-
-        if include_private
-          return true if self.class.private_method_defined?(method_name)
-          return true if self.class.concerns.private_instance_method_defined?(method_name)
-        end
-
-        false
-      end
-
-      private
-
-      ##
-      # Includes `concerns` into the mixing class.
-      # If `method` is still NOT defined, raises `NoMethodError`, otherwise - retries to call the `method`.
-      #
-      # @param method [Symbol]
-      # @param args [Array<Object>]
-      # @param kwargs [Hash{Symbol => Object}]
-      # @param block [Proc, nil]
-      # @return [void]
-      #
-      # @internal
-      #   IMPORTANT: `method_missing` MUST be thread-safe.
-      #
-      #   NOTE: `__send__` is used instead of `Support::SafeMethod` intentionally, since checking whether a method is defined is performed earlier by `Utils::Module.instance_method_defined?`.
-      #
-      def method_missing(method, *args, **kwargs, &block)
-        self.class.commit_config!(trigger: Constants::Triggers::INSTANCE_METHOD_MISSING)
-
-        return super unless Utils::Module.instance_method_defined?(self.class, method, private: true)
-
-        return super if self.class.middlewares(method, scope: :instance).defined_without_super_method?
-
-        ConvenientService.logger.debug { "[Core] Committed config for `#{self.class}` | Triggered by `method_missing` | Method: `##{method}`" }
-
-        __send__(method, *args, **kwargs, &block)
-      end
-    end
-  end
-end

data/lib/convenient_service/error.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Base class for all `ConvenientService` errors.
-# Can be used as a catch-all solution, for example:
-#
-#   begin
-#     any_service.result
-#   rescue ConvenientService::Error => error
-#     puts error.message
-#   end
-#
-module ConvenientService
-  class Error < ::StandardError
-  end
-end

data/lib/convenient_service/rspec/helpers/custom/ignoring_error.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module RSpec
-    module Helpers
-      module Custom
-        ##
-        # TODO: Specs.
-        #
-        class IgnoringError < Support::Command
-          attr_reader :errors, :block
-
-          def initialize(*errors, &block)
-            @errors = errors
-            @block = block
-          end
-
-          def call
-            block.call
-          rescue *errors
-            nil
-          else
-            ##
-            # TODO: Raise self-explanatory exception.
-            #
-            raise
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/rspec/matchers/custom/results/base/commands/find_result_method_step.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module RSpec
-    module Matchers
-      module Custom
-        module Results
-          class Base
-            module Commands
-              class FindResultMethodStep < Support::Command
-                ##
-                # @!attribute result [r]
-                #   @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
-                #
-                attr_reader :result
-
-                ##
-                # @!attribute method_name [r]
-                #   @return [Symbol]
-                #
-                attr_reader :method_name
-
-                ##
-                # @param result [ConvenientService::Service::Plugins::HasResult::Entities::Result]
-                # @param method_name [Symbol]
-                # @return [void]
-                #
-                def initialize(result:, method_name:)
-                  @result = result
-                  @method_name = method_name
-                end
-
-                ##
-                # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
-                #
-                def call
-                  return nil unless result.step
-
-                  result.step.inputs.find { |input| match_service_class?(input) && match_key?(input) && match_value?(input) }
-                end
-
-                private
-
-                ##
-                # @param input [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
-                # @return [Boolean]
-                #
-                def match_service_class?(input)
-                  result.step.service_class == Services::RunMethodInOrganizer
-                end
-
-                ##
-                # @param input [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
-                # @return [Boolean]
-                #
-                def match_key?(input)
-                  input.key.to_sym == :method_name
-                end
-
-                ##
-                # @param input [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
-                # @return [Boolean]
-                #
-                def match_value?(input)
-                  input.value.to_sym == method_name
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end