convenient_service 0.12.0 → 0.13.0

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

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+require_relative "base/commands"
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class Base
+            module Entities
+              module Printers
+                ##
+                # @internal
+                #   IMPORTANT: Do NOT forget to update the `Null` printer every time when the public interface is changed.
+                #
+                class Base
+                  include Support::Delegate
+                  include Support::AbstractMethod
+
+                  ##
+                  # @api private
+                  #
+                  # @!attribute [r] matcher
+                  #   @return [ConvenientService::RSpec::Matchers::Custom::Results::Base]
+                  #
+                  attr_reader :matcher
+
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  abstract_method :got_jsend_attributes_part
+
+                  ##
+                  # @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
+                  #
+                  # @param matcher [ConvenientService::RSpec::Matchers::Custom::Results::Base]
+                  # @return [void]
+                  #
+                  def initialize(matcher:)
+                    @matcher = matcher
+                  end
+
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def description
+                    expected_parts
+                  end
+
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def failure_message
+                    "expected result to be\n#{default_text}"
+                  end
+
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def failure_message_when_negated
+                    "expected result NOT to be\n#{default_text}"
+                  end
+
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def expected_parts
+                    Commands::GenerateExpectedParts[printer: self]
+                  end
+
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def got_parts
+                    Commands::GenerateGotParts[printer: self]
+                  end
+
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def expected_code_part
+                    Commands::GenerateExpectedCodePart[printer: self]
+                  end
+
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def expected_data_part
+                    Commands::GenerateExpectedDataPart[printer: self]
+                  end
+
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def expected_message_part
+                    Commands::GenerateExpectedMessagePart[printer: self]
+                  end
+
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def expected_service_part
+                    Commands::GenerateExpectedServicePart[printer: self]
+                  end
+
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def expected_status_part
+                    Commands::GenerateExpectedStatusPart[printer: self]
+                  end
+
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def expected_step_part
+                    Commands::GenerateExpectedStepPart[printer: self]
+                  end
+
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def got_step_part
+                    Commands::GenerateGotStepPart[printer: self]
+                  end
+
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def got_service_part
+                    Commands::GenerateGotServicePart[printer: self]
+                  end
+
+                  ##
+                  # @api private
+                  #
+                  # @param other [Object] Can be any type.
+                  # @return [Boolean, nil]
+                  #
+                  def ==(other)
+                    return unless other.instance_of?(self.class)
+
+                    return false if matcher != other.matcher
+
+                    true
+                  end
+
+                  private
+
+                  ##
+                  # @return [String]
+                  #
+                  def default_text
+                    "#{expected_parts}\n\n#{got_parts}"
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/matchers/custom/results/base/entities/printers/error/commands/generate_got_jsend_attributes_part.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class Base
+            module Entities
+              module Printers
+                class Error < Printers::Base
+                  module Commands
+                    class GenerateGotJsendAttributesPart < Support::Command
+                      include Support::Delegate
+                      include Support::DependencyContainer::Import
+
+                      ##
+                      # @api private
+                      #
+                      # @!attribute printer [r]
+                      #   @return [ConvenientService::RSpec::Matchers::Custom::Results::Base::Entities::Printers::Error]
+                      #
+                      attr_reader :printer
+
+                      ##
+                      # @api private
+                      #
+                      # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base::Entities::Chain]
+                      #
+                      delegate :chain, to: :printer
+
+                      ##
+                      # @api private
+                      #
+                      # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+                      #
+                      delegate :result, to: :printer
+
+                      ##
+                      # @api private
+                      #
+                      # @return [Symbol]
+                      #
+                      import :"constants.DEFAULT_ERROR_CODE", from: Service::Plugins::HasJSendResult::Container
+
+                      ##
+                      # @api private
+                      #
+                      # @param printer [ConvenientService::RSpec::Matchers::Custom::Results::Base::Entities::Printers::Base]
+                      # @return [void]
+                      #
+                      def initialize(printer:)
+                        @printer = printer
+                      end
+
+                      ##
+                      # @api private
+                      #
+                      # @return [String]
+                      #
+                      def call
+                        return "" unless result
+
+                        return status_part if [chain.used_data?, chain.used_message?, chain.used_code?].none?
+
+                        [status_part, message_part, code_part].reject(&:empty?).join("\n")
+                      end
+
+                      private
+
+                      ##
+                      # @return [String]
+                      #
+                      def status_part
+                        "with `error` status"
+                      end
+
+                      ##
+                      # @return [String]
+                      #
+                      def message_part
+                        message.empty? ? "with empty message" : "with message `#{message}`"
+                      end
+
+                      ##
+                      # @return [String]
+                      #
+                      def code_part
+                        ##
+                        # NOTE: `return "" if result.has_custom_code?`.
+                        #
+                        return "" if code == constants.DEFAULT_ERROR_CODE
+
+                        "with code `#{code}`"
+                      end
+
+                      ##
+                      # @return [String]
+                      #
+                      def message
+                        @message ||= result.unsafe_message.to_s
+                      end
+
+                      ##
+                      # @return [Symbol]
+                      #
+                      def code
+                        @code ||= result.unsafe_code.to_sym
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "error/commands"
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class Base
+            module Entities
+              module Printers
+                ##
+                # @internal
+                #   IMPORTANT: Do NOT forget to update the `Null` printer every time when the public interface is changed.
+                #
+                class Error < Printers::Base
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def got_jsend_attributes_part
+                    Commands::GenerateGotJsendAttributesPart[printer: self]
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/matchers/custom/results/base/entities/printers/failure/commands/generate_got_jsend_attributes_part.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class Base
+            module Entities
+              module Printers
+                class Failure < Printers::Base
+                  module Commands
+                    class GenerateGotJsendAttributesPart < Support::Command
+                      include Support::Delegate
+
+                      ##
+                      # @api private
+                      #
+                      # @!attribute printer [r]
+                      #   @return [ConvenientService::RSpec::Matchers::Custom::Results::Base::Entities::Printers::Failure]
+                      #
+                      attr_reader :printer
+
+                      ##
+                      # @api private
+                      #
+                      # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base::Entities::Chain]
+                      #
+                      delegate :chain, to: :printer
+
+                      ##
+                      # @api private
+                      #
+                      # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+                      #
+                      delegate :result, to: :printer
+
+                      ##
+                      # @api private
+                      #
+                      # @param printer [ConvenientService::RSpec::Matchers::Custom::Results::Base::Entities::Printers::Base]
+                      # @return [void]
+                      #
+                      def initialize(printer:)
+                        @printer = printer
+                      end
+
+                      ##
+                      # @api private
+                      #
+                      # @return [String]
+                      #
+                      def call
+                        return "" unless result
+
+                        return status_part if [chain.used_data?, chain.used_message?, chain.used_code?].none?
+
+                        [status_part, data_part, message_part].reject(&:empty?).join("\n")
+                      end
+
+                      private
+
+                      ##
+                      # @return [String]
+                      #
+                      def status_part
+                        "with `failure` status"
+                      end
+
+                      ##
+                      # @return [String]
+                      #
+                      def data_part
+                        data.empty? ? "with empty data" : "with data `#{data}`"
+                      end
+
+                      ##
+                      # @return [String]
+                      #
+                      # @internal
+                      #   TODO: Duplicated in `HasJSendResult::ClassMethods`.
+                      #
+                      #   NOTE: `message` and `data.first.to_a.join(" ")` are NOT equal only when:
+                      #   - Only `with_message` is used.
+                      #   - `with_data` and `with_message` are used together.
+                      #
+                      #   NOTE: This method is responsible for the `got` part, that is why it compares `message` and `data.first.to_a.join(" ")`.
+                      #
+                      def message_part
+                        ##
+                        # TODO: `return "" if result.has_custom_message?`.
+                        #
+                        return "" if message == data.first.to_a.join(" ")
+
+                        message.empty? ? "with empty message" : "with message `#{message}`"
+                      end
+
+                      ##
+                      # @return [Hash{Symbol => Object}]
+                      #
+                      def data
+                        @data ||= result.unsafe_data.to_h
+                      end
+
+                      ##
+                      # @return [String]
+                      #
+                      def message
+                        @message ||= result.unsafe_message.to_s
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "failure/commands"
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class Base
+            module Entities
+              module Printers
+                ##
+                # @internal
+                #   IMPORTANT: Do NOT forget to update the `Null` printer every time when the public interface is changed.
+                #
+                class Failure < Printers::Base
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def got_jsend_attributes_part
+                    Commands::GenerateGotJsendAttributesPart[printer: self]
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+require_relative "failure/commands"
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class Base
+            module Entities
+              module Printers
+                class Null < Printers::Base
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def description
+                    ""
+                  end
+
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def failure_message
+                    ""
+                  end
+
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def failure_message_when_negated
+                    ""
+                  end
+
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def expected_parts
+                    ""
+                  end
+
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def got_parts
+                    ""
+                  end
+
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def expected_code_part
+                    ""
+                  end
+
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def expected_data_part
+                    ""
+                  end
+
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def expected_message_part
+                    ""
+                  end
+
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def expected_service_part
+                    ""
+                  end
+
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def expected_status_part
+                    ""
+                  end
+
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def expected_step_part
+                    ""
+                  end
+
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def got_step_part
+                    ""
+                  end
+
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def got_service_part
+                    ""
+                  end
+
+                  ##
+                  # @api private
+                  #
+                  # @return [String]
+                  #
+                  def got_jsend_attributes_part
+                    ""
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end