convenient_service 0.17.0 → 0.19.0

data/lib/convenient_service/rspec/primitive_matchers/classes/delegate_to/entities/matcher.rb

@@ -1,276 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "matcher/commands"
-require_relative "matcher/entities"
-
-##
-# @internal
-#   IMPORTANT: This matcher has a dedicated end-user doc. Do NOT forget to update it when needed.
-#   https://github.com/marian13/convenient_service_docs/blob/main/docs/api/tests/rspec/matchers/delegate_to.mdx
-#
-module ConvenientService
-  module RSpec
-    module PrimitiveMatchers
-      module Classes
-        ##
-        # @internal
-        #   specify {
-        #     expect { method_class.cast(other, **options) }
-        #       .to delegate_to(ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Commands::CastMethod, :call)
-        #       .with_arguments(other: other, options: options)
-        #       .and_return_its_value
-        #   }
-        #
-        #   { method_class.cast(other, **options) }
-        #   # => block_expectation
-        #
-        #   ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Commands::CastMethod
-        #   # => object
-        #
-        #   :call
-        #   #=> method
-        #
-        #   (other: other, options: options)
-        #   # => expected_arguments
-        #
-        #   and_return_its_value
-        #   # => return_its_value_chaining
-        #
-        #   NOTE: A similar (with different behaviour) matcher exists in `saharspec`.
-        #   https://github.com/zverok/saharspec#send_messageobject-method-matcher
-        #
-        class DelegateTo
-          module Entities
-            class Matcher
-              include Support::Delegate
-
-              ##
-              # @!attribute [r] object
-              #   @return [Object] Can be any type.
-              #
-              attr_reader :object
-
-              ##
-              # @!attribute [r] method
-              #   @return [String, Symbol]
-              #
-              attr_reader :method
-
-              ##
-              # @!attribute [r] block_expectation
-              #   @return [Proc]
-              #
-              attr_reader :block_expectation
-
-              ##
-              # @return [Boolean]
-              #
-              delegate :should_call_original?, to: :chainings
-
-              ##
-              # @param object [Object]
-              # @param method [String, Symbol]
-              # @param block_expectation [Proc]
-              # @return [void]
-              #
-              def initialize(object, method, block_expectation = nil)
-                ##
-                # TODO: `raise unless object.respond_to?(method)`.
-                # TODO: `any_block`.
-                # TODO: `with_warmup`.
-                #
-                @object = object
-                @method = method
-                @block_expectation = block_expectation
-              end
-
-              ##
-              # @param block_expectation [Proc]
-              # @return [Boolean]
-              #
-              def matches?(block_expectation)
-                @block_expectation = block_expectation
-
-                chainings.arguments = Entities::Chainings::SubMatchers::WithAnyArguments.new(matcher: self) unless chainings.has_arguments?
-                chainings.call_original = Entities::Chainings::Values::WithCallingOriginal.new(matcher: self) unless chainings.has_call_original?
-
-                chainings.sub_matchers_match?(block_expectation)
-              end
-
-              ##
-              # @internal
-              #   NOTE: Required by RSpec.
-              #   https://relishapp.com/rspec/rspec-expectations/v/3-8/docs/custom-matchers/define-a-matcher-supporting-block-expectations
-              #
-              def supports_block_expectations?
-                true
-              end
-
-              ##
-              # @return [String]
-              #
-              def description
-                "delegate to `#{printable_method}`"
-              end
-
-              ##
-              # @return [String]
-              #
-              def failure_message
-                chainings.failure_message
-              end
-
-              ##
-              # @return [String]
-              #
-              def failure_message_when_negated
-                chainings.failure_message_when_negated
-              end
-
-              ##
-              # @return [ConvenientService::RSpec::PrimitiveMatchers::Classes::DelegateTo]
-              # @raise [ConvenientService::RSpec::PrimitiveMatchers::Classes::DelegateTo::Exceptions::ArgumentsChainingIsAlreadySet]
-              #
-              def with_arguments(...)
-                self.expected_arguments = Support::Arguments.new(...)
-
-                chainings.arguments = Entities::Chainings::SubMatchers::WithConcreteArguments.new(matcher: self)
-
-                self
-              end
-
-              ##
-              # @return [ConvenientService::RSpec::PrimitiveMatchers::Classes::DelegateTo]
-              # @raise [ConvenientService::RSpec::PrimitiveMatchers::Classes::DelegateTo::Exceptions::ArgumentsChainingIsAlreadySet]
-              #
-              def with_any_arguments
-                chainings.arguments = Entities::Chainings::SubMatchers::WithAnyArguments.new(matcher: self)
-
-                self
-              end
-
-              ##
-              # @return [ConvenientService::RSpec::PrimitiveMatchers::Classes::DelegateTo]
-              # @raise [ConvenientService::RSpec::PrimitiveMatchers::Classes::DelegateTo::Exceptions::ArgumentsChainingIsAlreadySet]
-              #
-              def without_arguments
-                chainings.arguments = Entities::Chainings::SubMatchers::WithoutArguments.new(matcher: self)
-
-                self
-              end
-
-              ##
-              # @return [ConvenientService::RSpec::PrimitiveMatchers::Classes::DelegateTo]
-              # @raise [ConvenientService::RSpec::PrimitiveMatchers::Classes::DelegateTo::Exceptions::ReturnItsValueChainingIsAlreadySet]
-              #
-              def and_return_its_value
-                chainings.return_its_value = Entities::Chainings::SubMatchers::ReturnItsValue.new(matcher: self)
-
-                self
-              end
-
-              ##
-              # @return [ConvenientService::RSpec::PrimitiveMatchers::Classes::DelegateTo]
-              #
-              def with_calling_original
-                chainings.call_original = Entities::Chainings::Values::WithCallingOriginal.new(matcher: self)
-
-                self
-              end
-
-              ##
-              # @return [ConvenientService::RSpec::PrimitiveMatchers::Classes::DelegateTo]
-              #
-              def without_calling_original
-                chainings.call_original = Entities::Chainings::Values::WithoutCallingOriginal.new(matcher: self)
-
-                self
-              end
-
-              ##
-              # @return [ConvenientService::Support::Arguments]
-              #
-              def expected_arguments
-                @expected_arguments ||= Support::Arguments.null_arguments
-              end
-
-              ##
-              # @param arguments [ConvenientService::Support::Arguments]
-              # @return [ConvenientService::Support::Arguments]
-              #
-              def expected_arguments=(arguments)
-                Utils::Object.instance_variable_delete(self, :@delegation_value)
-
-                @expected_arguments = arguments
-              end
-
-              ##
-              # @return [Object] Can be any type.
-              #
-              # @internal
-              #   IMPORTANT: Must be refreshed when `expected_arguments` are reset.
-              #
-              def delegation_value
-                Utils::Object.memoize_including_falsy_values(self, :@delegation_value) do
-                  object.__send__(
-                    method,
-                    *expected_arguments.args,
-                    **expected_arguments.kwargs,
-                    &expected_arguments.block
-                  )
-                end
-              end
-
-              ##
-              # @return [ConvenientService::RSpec::PrimitiveMatchers::Classes::DelegateTo::Entities::Matcher::Entities::Chainings]
-              # @api private
-              #
-              def chainings
-                @chainings ||= Entities::ChainingsCollection.new(matcher: self)
-              end
-
-              ##
-              # @return [Array]
-              # @api private
-              #
-              def delegations
-                @delegations ||= []
-              end
-
-              ##
-              # @return [String]
-              #
-              def printable_method
-                @printable_method ||= Commands::GeneratePrintableMethod.call(object: object, method: method)
-              end
-
-              ##
-              # @return [String]
-              #
-              def printable_block_expectation
-                @printable_block_expectation ||= Utils::Proc.display(block_expectation)
-              end
-
-              ##
-              # @param other [Object] Can be any type.
-              # @return [Boolean, nil]
-              #
-              # @internal
-              #   TODO: Unify ==(other) YARD tags.
-              #
-              def ==(other)
-                return unless other.instance_of?(self.class)
-
-                return false if object != other.object
-                return false if method != other.method
-                return false if block_expectation != other.block_expectation
-
-                true
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/can_have_steps/entities/method/entities/callers/reassignment/commands/define_method_in_container.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module CanHaveSteps
-        module Entities
-          class Method
-            module Entities
-              module Callers
-                class Reassignment < Callers::Base
-                  module Commands
-                    class DefineMethodInContainer < Support::Command
-                      include Support::Delegate
-
-                      attr_reader :method, :container, :index
-
-                      delegate :key, :name, to: :method
-
-                      def initialize(method:, container:, index:)
-                        @method = method
-                        @container = container
-                        @index = index
-                      end
-
-                      ##
-                      # @return [Boolean]
-                      #
-                      def call
-                        ##
-                        # NOTE: `prepend` is thread-safe.
-                        #
-                        container.klass.prepend reassigned_methods
-
-                        return false if Utils::Module.instance_method_defined?(reassigned_methods, method, private: true)
-
-                        <<~RUBY.tap { |code| reassigned_methods.module_eval(code, __FILE__, __LINE__ + 1) }
-                          def #{name}
-                            step =
-                              steps
-                                .select { |step| step.has_reassignment?(__method__) }
-                                .select(&:completed?)
-                                .last
-
-                            return super unless step
-
-                            key = step.reassignment(__method__).key.to_sym
-
-                            step.result.unsafe_data[key]
-                          end
-                        RUBY
-
-                        true
-                      end
-
-                      private
-
-                      ##
-                      # @return [Module]
-                      #
-                      def reassigned_methods
-                        @reassigned_methods ||= Utils::Module.fetch_own_const(container.klass, :ReassignedMethods) { ::Module.new }
-                      end
-                    end
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/can_have_steps/entities/method/entities/callers/reassignment/commands.rb

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

data/lib/convenient_service/service/plugins/can_have_steps/entities/step/plugins/can_be_result_step/can_be_executed/middleware.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module CanHaveSteps
-        module Entities
-          class Step
-            module Plugins
-              module CanBeResultStep
-                module CanBeExecuted
-                  class Middleware < MethodChainMiddleware
-                    intended_for :service_result, entity: :step
-
-                    ##
-                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
-                    # @raise [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step::Plugins::CanBeResultStep::CanBeExecuted::Exceptions::MethodForStepIsNotDefined]
-                    #
-                    # @internal
-                    #   NOTE: `kwargs` are intentionally NOT passed to `own_method.call`, since all the corresponding methods are available inside `own_method` body.
-                    #
-                    def next(...)
-                      return chain.next(...) unless entity.result_step?
-
-                      return own_method.call if own_method
-
-                      ::ConvenientService.raise Exceptions::MethodForStepIsNotDefined.new(service_class: organizer.class, method_name: method_name)
-                    end
-
-                    private
-
-                    ##
-                    # @return [Method, nil]
-                    #
-                    # @internal
-                    #   TODO: A possible bottleneck. Should be removed if receives negative feedback.
-                    #
-                    #   NOTE: `own_method.bind(organizer).call` is logically the same as `own_method.bind_call(organizer)`.
-                    #   - https://ruby-doc.org/core-2.7.1/UnboundMethod.html#method-i-bind_call
-                    #   - https://blog.saeloun.com/2019/10/17/ruby-2-7-adds-unboundmethod-bind_call-method.html
-                    #
-                    def own_method
-                      method = Utils::Module.get_own_instance_method(organizer.class, method_name, private: true)
-
-                      return unless method
-
-                      method.bind(organizer)
-                    end
-
-                    ##
-                    # @return [ConvenientService::Service]
-                    #
-                    def organizer
-                      @organizer ||= entity.organizer
-                    end
-
-                    ##
-                    # @return [Symbol]
-                    #
-                    def method_name
-                      @method_name ||= entity.method
-                    end
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/can_have_steps/entities/step/plugins/can_be_result_step/can_be_executed.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "can_be_executed/exceptions"
-require_relative "can_be_executed/middleware"

data/lib/convenient_service/service/plugins/can_have_steps/entities/step/plugins/can_be_result_step.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "can_be_result_step/concern"
-
-require_relative "can_be_result_step/can_be_executed"

data/lib/convenient_service/service/plugins/can_have_steps/entities/step/plugins/can_have_fallbacks/result.rb

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

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

@@ -1,43 +0,0 @@
-# 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/services.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "services/run_own_method_in_organizer"
-require_relative "services/run_method_in_organizer"

data/lib/convenient_service/support/gems/active_model.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Support
-    module Gems
-      ##
-      # @api private
-      #
-      class ActiveModel
-        class << self
-          ##
-          # @return [Boolean]
-          #
-          # @internal
-          #   `Style/TernaryParentheses` is disabled since `defined?` has too low priority without parentheses.
-          #
-          # rubocop:disable Style/TernaryParentheses
-          def loaded?
-            (defined? ::ActiveModel) ? true : false
-          end
-          # rubocop:enable Style/TernaryParentheses
-
-          ##
-          # @return [ConvenientService::Support::Version]
-          #
-          # @internal
-          #   https://github.com/rails/rails/blob/main/activemodel/lib/active_model/version.rb
-          #
-          def version
-            loaded? ? Support::Version.new(::ActiveModel.version) : Support::Version.null_version
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/support/gems/logger.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Support
-    module Gems
-      class Logger
-        class << self
-          ##
-          # @api private
-          #
-          # @return [Boolean]
-          #
-          # @internal
-          #   `Style/TernaryParentheses` is disabled since `defined?` has too low priority without parentheses.
-          #
-          # rubocop:disable Style/TernaryParentheses
-          def loaded?
-            (defined? ::Logger) ? true : false
-          end
-          # rubocop:enable Style/TernaryParentheses
-
-          ##
-          # @api private
-          #
-          # @return [ConvenientService::Support::Version]
-          #
-          # @internal
-          #   - https://github.com/ruby/logger/blob/v1.5.3/lib/logger/version.rb
-          #
-          def version
-            loaded? ? Support::Version.new(::Logger::VERSION) : Support::Version.null_version
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/support/gems/paint.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Support
-    module Gems
-      class Paint
-        class << self
-          ##
-          # @api private
-          #
-          # @return [Boolean]
-          #
-          # @internal
-          #   `Style/TernaryParentheses` is disabled since `defined?` has too low priority without parentheses.
-          #
-          # rubocop:disable Style/TernaryParentheses
-          def loaded?
-            (defined? ::Paint) ? true : false
-          end
-          # rubocop:enable Style/TernaryParentheses
-
-          ##
-          # @api private
-          #
-          # @return [ConvenientService::Support::Version]
-          #
-          # @internal
-          #   - https://github.com/janlelis/paint/blob/v2.2.1/lib/paint/version.rb
-          #
-          def version
-            loaded? ? Support::Version.new(::Paint::VERSION) : Support::Version.null_version
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/support/gems/rspec.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Support
-    module Gems
-      ##
-      # @api private
-      #
-      class RSpec
-        class << self
-          ##
-          # @return [Boolean]
-          #
-          # @internal
-          #   `Style/TernaryParentheses` is disabled since `defined?` has too low priority without parentheses.
-          #
-          # rubocop:disable Style/TernaryParentheses
-          def loaded?
-            (defined? ::RSpec) ? true : false
-          end
-          # rubocop:enable Style/TernaryParentheses
-
-          ##
-          # @return [ConvenientService::Support::Version]
-          #
-          # @internal
-          #   https://github.com/rspec/rspec-core/blob/main/lib/rspec/core/version.rb
-          #
-          def version
-            loaded? ? Support::Version.new(::RSpec::Core::Version::STRING) : Support::Version.null_version
-          end
-
-          ##
-          # @return [RSpec::Core::Example, nil]
-          #
-          # @internal
-          #   NOTE: Returns `nil` in environments where RSpec is NOT fully loaded, e.g: irb, rails console, etc.
-          #
-          #   `::RSpec.current_example` docs:
-          #   - https://www.rubydoc.info/github/rspec/rspec-core/RSpec.current_example
-          #   - https://github.com/rspec/rspec-core/blob/v3.12.0/lib/rspec/core.rb#L122
-          #   - https://relishapp.com/rspec/rspec-core/docs/metadata/current-example
-          #
-          def current_example
-            return unless loaded?
-
-            ##
-            # NOTE: This happens in Ruby-only projects where RSpec is loaded by `Bundler.require`, not by `bundle exec rspec`.
-            #
-            return unless ::RSpec.respond_to?(:current_example)
-
-            ::RSpec.current_example
-          end
-        end
-      end
-    end
-  end
-end