convenient_service 0.12.0 → 0.14.0

data/lib/convenient_service/rspec/matchers/custom/results/base/entities/validator.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require_relative "validator/commands"
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class Base
+            module Entities
+              class Validator
+                ##
+                # @api private
+                #
+                # @!attribute [r] matcher
+                #   @return [ConvenientService::RSpec::Matchers::Custom::Results::Base]
+                #
+                attr_reader :matcher
+
+                ##
+                # @api private
+                #
+                # @param matcher [ConvenientService::RSpec::Matchers::Custom::Results::Base]
+                # @return [void]
+                #
+                def initialize(matcher:)
+                  @matcher = matcher
+                end
+
+                ##
+                # @api private
+                #
+                # @return [Boolean]
+                #
+                def valid_result?
+                  Commands::ValidateResult[validator: self]
+                end
+
+                ##
+                # @api private
+                #
+                # @return [Boolean]
+                #
+                def valid_result_code?
+                  Commands::ValidateResultCode[validator: self]
+                end
+
+                ##
+                # @api private
+                #
+                # @return [Boolean]
+                #
+                def valid_result_data?
+                  Commands::ValidateResultData[validator: self]
+                end
+
+                ##
+                # @api private
+                #
+                # @return [Boolean]
+                #
+                def valid_result_message?
+                  Commands::ValidateResultMessage[validator: self]
+                end
+
+                ##
+                # @api private
+                #
+                # @return [Boolean]
+                #
+                def valid_result_service?
+                  Commands::ValidateResultService[validator: self]
+                end
+
+                ##
+                # @api private
+                #
+                # @return [Boolean]
+                #
+                def valid_result_status?
+                  Commands::ValidateResultStatus[validator: self]
+                end
+
+                ##
+                # @api private
+                #
+                # @return [Boolean]
+                #
+                def valid_result_step?
+                  Commands::ValidateResultStep[validator: self]
+                end
+
+                ##
+                # @api private
+                #
+                # @return [Boolean]
+                #
+                def valid_result_type?
+                  Commands::ValidateResultType[validator: self]
+                end
+
+                ##
+                # @api private
+                #
+                # @param other [Object] Can be any type.
+                # @return [Boolean, nil]
+                #
+                def ==(other)
+                  return nil unless other.instance_of?(self.class)
+
+                  return false if matcher != other.matcher
+
+                  true
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/matchers/custom/results/base/entities.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "entities/chain"
+require_relative "entities/printers"
+require_relative "entities/validator"

data/lib/convenient_service/rspec/matchers/custom/results/base/{errors.rb → exceptions.rb}

@@ -6,8 +6,14 @@ module ConvenientService
       module Custom
         module Results
           class Base
-            module Errors
-              class InvalidStep < ::ConvenientService::Error
+            module Exceptions
+              class InvalidStep < ::ConvenientService::Exception
+                ##
+                # @api private
+                #
+                # @param step [ConvenientService::Service, Symbol]
+                # @return [void]
+                #
                 def initialize(step:)
                   message = <<~TEXT
                     Step `#{step}` is NOT valid.

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "base/commands"
 require_relative "base/constants"
-require_relative "base/errors"
+require_relative "base/entities"
+require_relative "base/exceptions"
 
 module ConvenientService
   module RSpec
@@ -13,301 +13,264 @@ module ConvenientService
             include Support::AbstractMethod
 
             ##
+            # @api private
+            #
+            # @!attribute [r] result
+            #   @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+            #
+            attr_reader :result
+
+            ##
+            # @api private
+            #
             # @return [String, Symbol]
             #
             abstract_method :statuses
 
             ##
-            # @param result [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+            # @api private
+            #
+            # @return [void]
+            #
+            def initialize(statuses: self.statuses, result: nil)
+              chain.statuses = statuses
+
+              @result = result
+            end
+
+            ##
+            # @api public
+            #
+            # @param result [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
             # @return [Boolean]
             #
             def matches?(result)
               @result = result
 
-              rules = []
-
               ##
-              # IMPORTANT: Makes `result.class.include?` from the following line idempotent.
+              # IMPORTANT: Makes `result.class.include?` idempotent.
               #
-              result.commit_config!(trigger: Constants::Triggers::BE_RESULT) if result.respond_to?(:commit_config!)
-
-              rules << ->(result) { result.class.include?(Service::Plugins::HasResult::Entities::Result::Concern) }
-
-              ##
-              # IMPORTANT: Result status is NOT marked as checked intentionally, since it is a mutable operation.
+              # TODO: Explainer when `result.class.commit_config!` is required. It was introduced in panic when the first thread-safety issues occurred. Looks like it is an outdated operation now. It is probably useful only when a config has almost zero plugins.
               #
-              rules << ->(result) { result.status.in?(statuses) }
-
-              rules << ->(result) { result.service.instance_of?(service_class) } if used_of_service?
-              rules << ->(result) { Commands::MatchResultStep.call(result: result, step: step) } if used_of_step?
-              rules << ->(result) { result.unsafe_data == data } if used_data?
-              rules << ->(result) { result.unsafe_message == message } if used_message?
-              rules << ->(result) { result.unsafe_code == code } if used_code?
-
-              condition = Utils::Proc.conjunct(rules)
+              # TODO: Resolve a bug in `delegate_to`. It makes `respond_to?` always return `true`, even for classes that do NOT have the `commit_config!` method. See specs for details.
+              #
+              #   let(:result) { "foo" }
+              #
+              #   specify do
+              #     expect { matcher.matches?(result) }
+              #       .not_to delegate_to(result.class, :commit_config!)
+              #       .with_any_arguments
+              #       .without_calling_original
+              #   end
+              #
+              #   `result.class.method(:commit_config!)`
+              #   # => <Method: String.commit_config!(*args, &block) /usr/local/bundle/gems/rspec-mocks-3.11.2/lib/rspec/mocks/method_double.rb:63>
+              #
+              result.class.commit_config!(trigger: Constants::Triggers::BE_RESULT) if result.class.respond_to?(:commit_config!)
 
-              condition.call(result)
+              validator.valid_result?
             end
 
             ##
+            # @api public
+            #
             # @return [String]
             #
             def description
-              expected_parts
+              printer.description
             end
 
             ##
+            # @api public
+            #
             # @return [String]
             #
             def failure_message
-              "expected that `#{result.service.class}` result would #{default_text}"
+              printer.failure_message
             end
 
             ##
+            # @api public
+            #
             # @return [String]
             #
             # @internal
-            #   https://relishapp.com/rspec/rspec-expectations/v/3-11/docs/custom-matchers/define-a-custom-matcher#overriding-the-failure-message-when-negated
+            #   - https://relishapp.com/rspec/rspec-expectations/v/3-11/docs/custom-matchers/define-a-custom-matcher#overriding-the-failure-message-when-negated
             #
             def failure_message_when_negated
-              "expected that `#{result.service.class}` result would NOT #{default_text}"
+              printer.failure_message_when_negated
             end
 
             ##
+            # @api public
+            #
             # @param data [Hash]
             # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base]
             #
             def with_data(data)
-              chain[:data] = data
+              chain.data = data
 
               self
             end
 
             ##
+            # @api public
+            #
             # @param data [Hash]
             # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base]
             #
             def and_data(data)
-              chain[:data] = data
+              chain.data = data
 
               self
             end
 
             ##
+            # @api public
+            #
             # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base]
             #
             def without_data
-              chain[:data] = {}
+              chain.data = {}
 
               self
             end
 
             ##
+            # @api public
+            #
             # @param message [String]
             # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base]
             #
             def with_message(message)
-              chain[:message] = message
+              chain.message = message
 
               self
             end
 
             ##
+            # @api public
+            #
             # @param message [String]
             # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base]
             #
             def and_message(message)
-              chain[:message] = message
+              chain.message = message
 
               self
             end
 
             ##
+            # @api public
+            #
             # @return [String, Symbol]
             # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base]
             #
             def with_code(code)
-              chain[:code] = code
+              chain.code = code
 
               self
             end
 
             ##
+            # @api public
+            #
             # @return [String, Symbol]
             # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base]
             #
             def and_code(code)
-              chain[:code] = code
+              chain.code = code
 
               self
             end
 
             ##
-            # @param service_class [Class]
+            # @api public
+            #
+            # @param service [ConvenientService::Service]
             # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base]
             #
-            def of_service(service_class)
-              chain[:service_class] = service_class
+            def of_service(service)
+              chain.service = service
 
               self
             end
 
             ##
+            # @api public
+            #
             # @param step [Class, Symbol]
             # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base]
             #
             def of_step(step)
-              chain[:step] = step
+              chain.step = step
 
               self
             end
 
             ##
+            # @api public
+            #
             # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base]
             #
             def without_step
-              chain[:step] = nil
+              chain.step = nil
 
               self
             end
 
-            private
-
-            ##
-            # @!attribute [r] result
-            #   @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
-            #
-            attr_reader :result
-
             ##
-            # @return [String]
-            #
-            def default_text
-              expected_parts << "\n\n" << got_parts
-            end
-
-            ##
-            # @return [String]
+            # @api public
             #
-            # @internal
-            #   TODO: Align for easier visual comparison.
-            #   TODO: New line for each attribute.
-            #
-            def expected_parts
-              parts = []
-
-              parts << "be #{printable_statuses}"
-              parts << "of service `#{service_class}`" if used_of_service?
-              parts << Commands::GenerateExpectedStepPart.call(step: step) if used_of_step?
-              parts << "with data `#{data}`" if used_data?
-              parts << "with message `#{message}`" if used_message?
-              parts << "with code `#{code}`" if used_code?
-
-              parts.join(" ")
-            end
-
-            ##
-            # @return [String]
-            #
-            # @internal
-            #   TODO: Align for easier visual comparison.
-            #   TODO: New line for each attribute.
+            # @param comparison_method [Symbo, String]
+            # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base]
             #
-            def got_parts
-              parts = []
-
-              parts << "got `#{result.status}`"
-              parts << "of service `#{result.service.class}`" if used_of_service?
-              parts << Commands::GenerateGotStepPart.call(result: result) if used_of_step?
-              parts << "with data `#{result.unsafe_data}`" if used_data?
-              parts << "with message `#{result.unsafe_message}`" if used_message?
-              parts << "with code `#{result.unsafe_code}`" if used_code?
+            def comparing_by(comparison_method)
+              chain.comparison_method = comparison_method
 
-              parts.join(" ")
-            end
-
-            ##
-            # @return [Boolean]
-            #
-            def used_data?
-              chain.key?(:data)
+              self
             end
 
             ##
-            # @return [Boolean]
+            # @api private
             #
-            def used_message?
-              chain.key?(:message)
-            end
-
-            ##
-            # @return [Boolean]
+            # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base::Entities::Chain]
             #
-            def used_code?
-              chain.key?(:code)
-            end
-
-            ##
-            # @return [Boolean]
-            #
-            def used_of_service?
-              chain.key?(:service_class)
+            def chain
+              @chain ||= Entities::Chain.new
             end
 
             ##
-            # @return [Boolean]
+            # @api private
             #
-            def used_of_step?
-              chain.key?(:step)
-            end
-
-            ##
-            # @return [Hash]
+            # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base::Entities::Printers::Base]
             #
-            def data
-              @data ||= chain[:data] || {}
+            def printer
+              @printer ||= Entities::Printers.create(matcher: self)
             end
 
             ##
-            # @return [String]
+            # @api private
             #
-            def message
-              @message ||= chain[:message] || ""
-            end
-
-            ##
-            # @return [String, Symbol]
+            # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base::Entities::Validator]
             #
-            def code
-              @code ||= chain[:code] || ""
+            def validator
+              @validator ||= Entities::Validator.new(matcher: self)
             end
 
             ##
-            # @return [Class]
+            # @api private
             #
-            def service_class
-              Utils::Object.instance_variable_fetch(self, :@service_class) { chain[:service_class] }
-            end
-
-            ##
-            # @return [Class]
+            # @param other [Object] Can be any type.
+            # @return [Boolean, nil]
             #
-            def step
-              Utils::Object.instance_variable_fetch(self, :@step) { chain[:step] }
-            end
+            def ==(other)
+              return unless other.instance_of?(self.class)
 
-            ##
-            # @return [Hash]
-            #
-            def chain
-              @chain ||= {}
-            end
+              return false if chain != other.chain
+              return false if result != other.result
 
-            ##
-            # @return [String]
-            #
-            def printable_statuses
-              statuses.map { |status| "`#{status}`" }.join(" or ")
+              true
             end
           end
         end

data/lib/convenient_service/rspec/matchers/custom/results/be_error.rb

@@ -6,8 +6,13 @@ module ConvenientService
       module Custom
         module Results
           class BeError < Results::Base
+            ##
+            # @api private
+            #
+            # @return [Array<Symbol>]
+            #
             def statuses
-              [Service::Plugins::HasResult::Constants::ERROR_STATUS]
+              [Service::Plugins::HasJSendResult::Constants::ERROR_STATUS]
             end
           end
         end

data/lib/convenient_service/rspec/matchers/custom/results/be_failure.rb

@@ -6,8 +6,13 @@ module ConvenientService
       module Custom
         module Results
           class BeFailure < Results::Base
+            ##
+            # @api private
+            #
+            # @return [Array<Symbol>]
+            #
             def statuses
-              [Service::Plugins::HasResult::Constants::FAILURE_STATUS]
+              [Service::Plugins::HasJSendResult::Constants::FAILURE_STATUS]
             end
           end
         end

data/lib/convenient_service/rspec/matchers/custom/results/be_not_error.rb

@@ -6,10 +6,15 @@ module ConvenientService
       module Custom
         module Results
           class BeNotError < Results::Base
+            ##
+            # @api private
+            #
+            # @return [Array<Symbol>]
+            #
             def statuses
               [
-                Service::Plugins::HasResult::Constants::FAILURE_STATUS,
-                Service::Plugins::HasResult::Constants::SUCCESS_STATUS
+                Service::Plugins::HasJSendResult::Constants::SUCCESS_STATUS,
+                Service::Plugins::HasJSendResult::Constants::FAILURE_STATUS
               ]
             end
           end

data/lib/convenient_service/rspec/matchers/custom/results/be_not_failure.rb

@@ -6,10 +6,15 @@ module ConvenientService
       module Custom
         module Results
           class BeNotFailure < Results::Base
+            ##
+            # @api private
+            #
+            # @return [Array<Symbol>]
+            #
             def statuses
               [
-                Service::Plugins::HasResult::Constants::ERROR_STATUS,
-                Service::Plugins::HasResult::Constants::SUCCESS_STATUS
+                Service::Plugins::HasJSendResult::Constants::SUCCESS_STATUS,
+                Service::Plugins::HasJSendResult::Constants::ERROR_STATUS
               ]
             end
           end

data/lib/convenient_service/rspec/matchers/custom/results/be_not_success.rb

@@ -6,10 +6,15 @@ module ConvenientService
       module Custom
         module Results
           class BeNotSuccess < Results::Base
+            ##
+            # @api private
+            #
+            # @return [Array<Symbol>]
+            #
             def statuses
               [
-                Service::Plugins::HasResult::Constants::ERROR_STATUS,
-                Service::Plugins::HasResult::Constants::FAILURE_STATUS
+                Service::Plugins::HasJSendResult::Constants::FAILURE_STATUS,
+                Service::Plugins::HasJSendResult::Constants::ERROR_STATUS
               ]
             end
           end

data/lib/convenient_service/rspec/matchers/custom/results/be_success.rb

@@ -6,8 +6,13 @@ module ConvenientService
       module Custom
         module Results
           class BeSuccess < Results::Base
+            ##
+            # @api private
+            #
+            # @return [Array<Symbol>]
+            #
             def statuses
-              [Service::Plugins::HasResult::Constants::SUCCESS_STATUS]
+              [Service::Plugins::HasJSendResult::Constants::SUCCESS_STATUS]
             end
           end
         end

data/lib/convenient_service/rspec/matchers/results/be_error.rb

@@ -5,6 +5,9 @@ module ConvenientService
     module Matchers
       module Results
         module BeError
+          ##
+          # @api public
+          #
           def be_error(...)
             Custom::Results::BeError.new(...)
           end