convenient_service 0.12.0 → 0.13.0

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

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class Base
+            module Entities
+              class Validator
+                module Commands
+                  class ValidateResultStatus < Support::Command
+                    include Support::Delegate
+
+                    ##
+                    # @api private
+                    #
+                    # @!attribute [r] validator
+                    #   @return [ConvenientService::RSpec::Matchers::Custom::Results::Base::Entities::Validator]
+                    #
+                    attr_reader :validator
+
+                    ##
+                    # @api private
+                    #
+                    # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base]
+                    #
+                    delegate :matcher, to: :validator
+
+                    ##
+                    # @api private
+                    #
+                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+                    #
+                    delegate :result, to: :matcher
+
+                    ##
+                    # @api private
+                    #
+                    # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base::Entities::Chain]
+                    #
+                    delegate :chain, to: :matcher
+
+                    ##
+                    # @api private
+                    #
+                    # @return [Array<Symbol>]
+                    #
+                    delegate :statuses, to: :chain
+
+                    ##
+                    # @api private
+                    #
+                    # @param validator [ConvenientService::RSpec::Matchers::Custom::Results::Base::Entities::Validator]
+                    # @return [void]
+                    #
+                    def initialize(validator:)
+                      @validator = validator
+                    end
+
+                    ##
+                    # @api private
+                    #
+                    # @return [Boolean]
+                    #
+                    # @internal
+                    #   IMPORTANT: Result status is NOT marked as checked intentionally, since it is a mutable operation.
+                    #
+                    def call
+                      return false unless matcher.result
+
+                      result.status.in?(casted_statuses)
+                    end
+
+                    private
+
+                    ##
+                    # @return [Array<ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Status>]
+                    #
+                    def casted_statuses
+                      statuses.map { |status| result.create_status(status) }
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class Base
+            module Entities
+              class Validator
+                module Commands
+                  class ValidateResultStep < Support::Command
+                    include Support::Delegate
+
+                    ##
+                    # @api private
+                    #
+                    # @!attribute [r] validator
+                    #   @return [ConvenientService::RSpec::Matchers::Custom::Results::Base::Entities::Validator]
+                    #
+                    attr_reader :validator
+
+                    ##
+                    # @api private
+                    #
+                    # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base]
+                    #
+                    delegate :matcher, to: :validator
+
+                    ##
+                    # @api private
+                    #
+                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+                    #
+                    delegate :result, to: :matcher
+
+                    ##
+                    # @api private
+                    #
+                    # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base::Entities::Chain]
+                    #
+                    delegate :chain, to: :matcher
+
+                    ##
+                    # @api private
+                    #
+                    # @return [ConvenientService::Service, Symbol]
+                    #
+                    delegate :step, to: :chain
+
+                    ##
+                    # @api private
+                    #
+                    # @param validator [ConvenientService::RSpec::Matchers::Custom::Results::Base::Entities::Validator]
+                    # @return [void]
+                    #
+                    def initialize(validator:)
+                      @validator = validator
+                    end
+
+                    ##
+                    # @api private
+                    #
+                    # @return [Boolean]
+                    # @raise [ConvenientService::RSpec::Matchers::Custom::Results::Base::Exceptions::InvalidStep]
+                    #
+                    # @internal
+                    #   TODO: Import via commands.
+                    #
+                    def call
+                      return false unless matcher.result
+                      return true unless chain.used_step?
+
+                      case step
+                      when ::Class then match_service_step?
+                      when :result then match_result_method_step?
+                      when ::Symbol then match_method_step?
+                      when nil then match_without_step?
+                      else raise Exceptions::InvalidStep.new(step: step)
+                      end
+                    end
+
+                    private
+
+                    ##
+                    # @return [Boolean]
+                    #
+                    def match_service_step?
+                      return false unless result.step
+
+                      result.step.service_class == step
+                    end
+
+                    ##
+                    # @return [Boolean]
+                    #
+                    def match_result_method_step?
+                      return false unless result.step
+
+                      result.step.result_step?
+                    end
+
+                    ##
+                    # @return [Boolean]
+                    #
+                    def match_method_step?
+                      return false unless result.step&.method_step?
+
+                      result.step.method.to_sym == step
+                    end
+
+                    ##
+                    # @return [Boolean]
+                    #
+                    def match_without_step?
+                      result.step.nil?
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class Base
+            module Entities
+              class Validator
+                module Commands
+                  class ValidateResultType < Support::Command
+                    include Support::Delegate
+                    include Support::DependencyContainer::Import
+
+                    ##
+                    # @api private
+                    #
+                    # @!attribute [r] validator
+                    #   @return [ConvenientService::RSpec::Matchers::Custom::Results::Base::Entities::Validator]
+                    #
+                    attr_reader :validator
+
+                    ##
+                    # @api private
+                    #
+                    # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base]
+                    #
+                    delegate :matcher, to: :validator
+
+                    ##
+                    # @api private
+                    #
+                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+                    #
+                    delegate :result, to: :matcher
+
+                    ##
+                    # @api private
+                    #
+                    # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base::Entities::Chain]
+                    #
+                    delegate :chain, to: :matcher
+
+                    ##
+                    # @api private
+                    #
+                    # @return [ConvenientService::Service, Symbol]
+                    #
+                    delegate :step, to: :chain
+
+                    ##
+                    # @return [Boolean]
+                    #
+                    import :"commands.is_result?", from: Service::Plugins::HasJSendResult::Container
+
+                    ##
+                    # @api private
+                    #
+                    # @param validator [ConvenientService::RSpec::Matchers::Custom::Results::Base::Entities::Validator]
+                    # @return [void]
+                    #
+                    def initialize(validator:)
+                      @validator = validator
+                    end
+
+                    ##
+                    # @api private
+                    #
+                    # @return [Boolean]
+                    #
+                    # @internal
+                    #   TODO: `commands.IsResult`.
+                    #
+                    def call
+                      return false unless matcher.result
+
+                      commands.is_result?(result)
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "commands/validate_result_code"
+require_relative "commands/validate_result_data"
+require_relative "commands/validate_result_message"
+require_relative "commands/validate_result_service"
+require_relative "commands/validate_result_status"
+require_relative "commands/validate_result_step"
+require_relative "commands/validate_result_type"
+require_relative "commands/validate_result"

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.