convenient_service 0.12.0 → 0.13.0

data/lib/convenient_service/rspec/matchers/custom/delegate_to/entities/matcher/entities/chainings_collection.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "chainings_collection/errors"
+require_relative "chainings_collection/exceptions"
 
 module ConvenientService
   module RSpec
@@ -107,56 +107,56 @@ module ConvenientService
                   # @return [Boolean]
                   #
                   def should_call_original?
-                    Utils::Bool.to_bool(call_original&.value)
+                    Utils.to_bool(call_original&.value)
                   end
 
                   ##
                   # @return [Boolean]
                   #
                   def has_call_original?
-                    Utils::Bool.to_bool(call_original)
+                    Utils.to_bool(call_original)
                   end
 
                   ##
                   # @return [Boolean]
                   #
                   def has_arguments?
-                    Utils::Bool.to_bool(arguments)
+                    Utils.to_bool(arguments)
                   end
 
                   ##
                   # @return [Boolean]
                   #
                   def has_return_its_value?
-                    Utils::Bool.to_bool(return_its_value)
+                    Utils.to_bool(return_its_value)
                   end
 
                   ##
                   # @param chaining [ConvenientService::RSpec::Matchers::Custom::DelegateTo::Entities::Matcher::Entities::Chainings::Values::Base]
-                  # @raise [ConvenientService::RSpec::Matchers::Custom::DelegateTo::Errors::ReturnItsValueChainingIsAlreadySet]
+                  # @raise [ConvenientService::RSpec::Matchers::Custom::DelegateTo::Exceptions::ReturnItsValueChainingIsAlreadySet]
                   #
                   def call_original=(chaining)
-                    raise Errors::CallOriginalChainingIsAlreadySet.new if @call_original
+                    raise Exceptions::CallOriginalChainingIsAlreadySet.new if @call_original
 
                     @call_original = chaining
                   end
 
                   ##
                   # @param chaining [ConvenientService::RSpec::Matchers::Custom::DelegateTo::Entities::Matcher::Entities::Chainings::SubMatchers::Base]
-                  # @raise [ConvenientService::RSpec::Matchers::Custom::DelegateTo::Errors::ArgumentsChainingIsAlreadySet]
+                  # @raise [ConvenientService::RSpec::Matchers::Custom::DelegateTo::Exceptions::ArgumentsChainingIsAlreadySet]
                   #
                   def arguments=(chaining)
-                    raise Errors::ArgumentsChainingIsAlreadySet.new if @arguments
+                    raise Exceptions::ArgumentsChainingIsAlreadySet.new if @arguments
 
                     @arguments = chaining
                   end
 
                   ##
                   # @param chaining [ConvenientService::RSpec::Matchers::Custom::DelegateTo::Entities::Matcher::Entities::Chainings::SubMatchers::Base]
-                  # @raise [ConvenientService::RSpec::Matchers::Custom::DelegateTo::Errors::ReturnItsValueChainingIsAlreadySet]
+                  # @raise [ConvenientService::RSpec::Matchers::Custom::DelegateTo::Exceptions::ReturnItsValueChainingIsAlreadySet]
                   #
                   def return_its_value=(chaining)
-                    raise Errors::ReturnItsValueChainingIsAlreadySet.new if @return_its_value
+                    raise Exceptions::ReturnItsValueChainingIsAlreadySet.new if @return_its_value
 
                     @return_its_value = chaining
                   end

data/lib/convenient_service/rspec/matchers/custom/delegate_to/entities/matcher.rb

@@ -129,7 +129,7 @@ module ConvenientService
 
               ##
               # @return [ConvenientService::RSpec::Matchers::Custom::DelegateTo]
-              # @raise [ConvenientService::RSpec::Matchers::Custom::DelegateTo::Errors::ArgumentsChainingIsAlreadySet]
+              # @raise [ConvenientService::RSpec::Matchers::Custom::DelegateTo::Exceptions::ArgumentsChainingIsAlreadySet]
               #
               def with_arguments(...)
                 self.expected_arguments = Support::Arguments.new(...)
@@ -141,7 +141,7 @@ module ConvenientService
 
               ##
               # @return [ConvenientService::RSpec::Matchers::Custom::DelegateTo]
-              # @raise [ConvenientService::RSpec::Matchers::Custom::DelegateTo::Errors::ArgumentsChainingIsAlreadySet]
+              # @raise [ConvenientService::RSpec::Matchers::Custom::DelegateTo::Exceptions::ArgumentsChainingIsAlreadySet]
               #
               def with_any_arguments
                 chainings.arguments = Entities::Chainings::SubMatchers::WithAnyArguments.new(matcher: self)
@@ -151,7 +151,7 @@ module ConvenientService
 
               ##
               # @return [ConvenientService::RSpec::Matchers::Custom::DelegateTo]
-              # @raise [ConvenientService::RSpec::Matchers::Custom::DelegateTo::Errors::ArgumentsChainingIsAlreadySet]
+              # @raise [ConvenientService::RSpec::Matchers::Custom::DelegateTo::Exceptions::ArgumentsChainingIsAlreadySet]
               #
               def without_arguments
                 chainings.arguments = Entities::Chainings::SubMatchers::WithoutArguments.new(matcher: self)
@@ -161,7 +161,7 @@ module ConvenientService
 
               ##
               # @return [ConvenientService::RSpec::Matchers::Custom::DelegateTo]
-              # @raise [ConvenientService::RSpec::Matchers::Custom::DelegateTo::Errors::ReturnItsValueChainingIsAlreadySet]
+              # @raise [ConvenientService::RSpec::Matchers::Custom::DelegateTo::Exceptions::ReturnItsValueChainingIsAlreadySet]
               #
               def and_return_its_value
                 chainings.return_its_value = Entities::Chainings::SubMatchers::ReturnItsValue.new(matcher: self)
@@ -211,7 +211,7 @@ module ConvenientService
               #   IMPORTANT: Must be refreshed when `expected_arguments` are reset.
               #
               def delegation_value
-                Utils::Object.instance_variable_fetch(self, :@delegation_value) do
+                Utils::Object.memoize_including_falsy_values(self, :@delegation_value) do
                   object.__send__(
                     method,
                     *expected_arguments.args,

data/lib/convenient_service/rspec/matchers/custom/delegate_to.rb

@@ -66,7 +66,7 @@ module ConvenientService
 
           ##
           # @return [ConvenientService::RSpec::Matchers::Custom::DelegateTo]
-          # @raise [ConvenientService::RSpec::Matchers::Custom::DelegateTo::Errors::ArgumentsChainingIsAlreadySet]
+          # @raise [ConvenientService::RSpec::Matchers::Custom::DelegateTo::Exceptions::ArgumentsChainingIsAlreadySet]
           #
           def with_arguments(...)
             matcher.with_arguments(...)
@@ -76,7 +76,17 @@ module ConvenientService
 
           ##
           # @return [ConvenientService::RSpec::Matchers::Custom::DelegateTo]
-          # @raise [ConvenientService::RSpec::Matchers::Custom::DelegateTo::Errors::ArgumentsChainingIsAlreadySet]
+          # @raise [ConvenientService::RSpec::Matchers::Custom::DelegateTo::Exceptions::ArgumentsChainingIsAlreadySet]
+          #
+          def with_any_arguments
+            matcher.with_any_arguments
+
+            self
+          end
+
+          ##
+          # @return [ConvenientService::RSpec::Matchers::Custom::DelegateTo]
+          # @raise [ConvenientService::RSpec::Matchers::Custom::DelegateTo::Exceptions::ArgumentsChainingIsAlreadySet]
           #
           def without_arguments
             matcher.without_arguments
@@ -86,7 +96,7 @@ module ConvenientService
 
           ##
           # @return [ConvenientService::RSpec::Matchers::Custom::DelegateTo]
-          # @raise [ConvenientService::RSpec::Matchers::Custom::DelegateTo::Errors::ReturnItsValueChainingIsAlreadySet]
+          # @raise [ConvenientService::RSpec::Matchers::Custom::DelegateTo::Exceptions::ReturnItsValueChainingIsAlreadySet]
           #
           def and_return_its_value
             matcher.and_return_its_value

data/lib/convenient_service/rspec/matchers/custom/export.rb

@@ -12,12 +12,12 @@ module ConvenientService
           import :"commands.AssertValidScope", from: ConvenientService::Support::DependencyContainer::Container
 
           ##
-          # @param full_name [Symbol, String]
+          # @param slug [Symbol, String]
           # @param scope [Symbol]
           # @return [void]
           #
-          def initialize(full_name, scope: constants.DEFAULT_SCOPE)
-            @full_name = full_name
+          def initialize(slug, scope: constants.DEFAULT_SCOPE)
+            @slug = slug
             @scope = scope
           end
 
@@ -32,37 +32,37 @@ module ConvenientService
 
             commands.AssertValidScope.call(scope: scope)
 
-            Utils::Bool.to_bool(container.exported_methods.find_by(full_name: full_name, scope: scope))
+            Utils.to_bool(container.exported_methods.find_by(slug: slug, scope: scope))
           end
 
           ##
           # @return [String]
           #
           def description
-            "export `#{full_name}` with scope `#{scope}`"
+            "export `#{slug}` with scope `#{scope}`"
           end
 
           ##
           # @return [String]
           #
           def failure_message
-            "expected `#{container}` to export `#{full_name}` with scope `#{scope}`"
+            "expected `#{container}` to export `#{slug}` with scope `#{scope}`"
           end
 
           ##
           # @return [String]
           #
           def failure_message_when_negated
-            "expected `#{container}` NOT to export `#{full_name}` with scope `#{scope}`"
+            "expected `#{container}` NOT to export `#{slug}` with scope `#{scope}`"
           end
 
           private
 
           ##
-          # @!attribute [r] full_name
+          # @!attribute [r] slug
           #   @return [Symbol, String]
           #
-          attr_reader :full_name
+          attr_reader :slug
 
           ##
           # @!attribute [r] scope

data/lib/convenient_service/rspec/matchers/custom/have_abstract_method.rb

@@ -16,7 +16,7 @@ module ConvenientService
               object.__send__(method_name)
 
               false
-            rescue ConvenientService::Support::AbstractMethod::Errors::AbstractMethodNotOverridden
+            rescue ConvenientService::Support::AbstractMethod::Exceptions::AbstractMethodNotOverridden
               true
             rescue
               false

data/lib/convenient_service/rspec/matchers/custom/have_alias_method.rb

@@ -13,6 +13,9 @@ module ConvenientService
           def matches?(object)
             @object = object
 
+            ##
+            # TODO: Use `Utils::Object.duck_class` to support `have_alias_method` for classes.
+            #
             return false unless Utils::Method.defined?(original_name, object.class, private: true)
 
             return false unless Utils::Method.defined?(alias_name, object.class, private: true)

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

@@ -9,10 +9,19 @@ module ConvenientService
             module Constants
               module Triggers
                 ##
+                # @api private
+                #
                 # @return [ConvenientService::Support::UniqueValue]
                 #
                 BE_RESULT = Support::UniqueValue.new("BE_RESULT")
               end
+
+              ##
+              # @api private
+              #
+              # @return [Symbol]
+              #
+              DEFAULT_COMPARISON_METHOD = :==
             end
           end
         end

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

@@ -0,0 +1,226 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class Base
+            module Entities
+              class Chain
+                ##
+                # @api private
+                #
+                # @return [void]
+                #
+                def initialize
+                  @hash = {}
+                end
+
+                ##
+                # @api private
+                #
+                # @return [Boolean]
+                #
+                def used_data?
+                  hash.key?(:data)
+                end
+
+                ##
+                # @api private
+                #
+                # @return [Boolean]
+                #
+                def used_message?
+                  hash.key?(:message)
+                end
+
+                ##
+                # @api private
+                #
+                # @return [Boolean]
+                #
+                def used_code?
+                  hash.key?(:code)
+                end
+
+                ##
+                # @api private
+                #
+                # @return [Boolean]
+                #
+                def used_service?
+                  hash.key?(:service)
+                end
+
+                ##
+                # @api private
+                #
+                # @return [Boolean]
+                #
+                def used_step?
+                  hash.key?(:step)
+                end
+
+                ##
+                # @api private
+                #
+                # @return [Array<Symbol>]
+                #
+                def statuses
+                  hash[:statuses] || []
+                end
+
+                ##
+                # @api private
+                #
+                # @return [Hash{Symbol => Object}]
+                #
+                def data
+                  hash[:data] || {}
+                end
+
+                ##
+                # @api private
+                #
+                # @return [String]
+                #
+                def message
+                  hash[:message] || ""
+                end
+
+                ##
+                # @api private
+                #
+                # @return [String, Symbol]
+                #
+                def code
+                  hash[:code]
+                end
+
+                ##
+                # @api private
+                #
+                # @return [Symbol, Symbol]
+                #
+                def comparison_method
+                  hash[:comparison_method] || Constants::DEFAULT_COMPARISON_METHOD
+                end
+
+                ##
+                # @api private
+                #
+                # @return [ConvenientService::Service]
+                #
+                def service
+                  hash[:service]
+                end
+
+                ##
+                # @api private
+                #
+                # @return [ConvenientService::Service, Symbol]
+                #
+                def step
+                  hash[:step]
+                end
+
+                ##
+                # @api private
+                #
+                # @param other_statuses [Array<Symbol>]
+                # @return [Array<Symbol>]
+                #
+                def statuses=(other_statuses)
+                  hash[:statuses] = other_statuses
+                end
+
+                ##
+                # @api private
+                #
+                # @param other_comparison_method [Symbol, Symbol]
+                # @return [Symbol, Symbol]
+                #
+                def comparison_method=(other_comparison_method)
+                  hash[:comparison_method] = other_comparison_method
+                end
+
+                ##
+                # @api private
+                #
+                # @param other_data [Hash{Symbol => Object}]
+                # @return [Hash{Symbol => Object}]
+                #
+                def data=(other_data)
+                  hash[:data] = other_data
+                end
+
+                ##
+                # @api private
+                #
+                # @param other_message [String]
+                # @return [String]
+                #
+                def message=(other_message)
+                  hash[:message] = other_message
+                end
+
+                ##
+                # @api private
+                #
+                # @param other_code [Symbol]
+                # @return [Symbol]
+                #
+                def code=(other_code)
+                  hash[:code] = other_code
+                end
+
+                ##
+                # @api private
+                #
+                # @param other_service [ConvenientService::Service]
+                # @return [ConvenientService::Service]
+                #
+                def service=(other_service)
+                  hash[:service] = other_service
+                end
+
+                ##
+                # @api private
+                #
+                # @param other_step [ConvenientService::Service, Symbol]
+                # @return [ConvenientService::Service, Symbol]
+                #
+                def step=(other_step)
+                  hash[:step] = other_step
+                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 hash != other.hash
+
+                  true
+                end
+
+                protected
+
+                ##
+                # @!attribute hash [r]
+                #   @return [Hash{Symbol => Object}]
+                #
+                attr_reader :hash
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class Base
+            module Entities
+              module Printers
+                class Base
+                  module Commands
+                    class GenerateExpectedCodePart < Support::Command
+                      include Support::Delegate
+
+                      ##
+                      # @api private
+                      #
+                      # @!attribute printer [r]
+                      #   @return [ConvenientService::RSpec::Matchers::Custom::Results::Base::Entities::Printers::Base]
+                      #
+                      attr_reader :printer
+
+                      ##
+                      # @api private
+                      #
+                      # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base::Entities::Chain]
+                      #
+                      delegate :chain, 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 chain.used_code?
+
+                        "with code `#{chain.code}`"
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class Base
+            module Entities
+              module Printers
+                class Base
+                  module Commands
+                    class GenerateExpectedDataPart < Support::Command
+                      include Support::Delegate
+
+                      ##
+                      # @api private
+                      #
+                      # @!attribute printer [r]
+                      #   @return [ConvenientService::RSpec::Matchers::Custom::Results::Base::Entities::Printers::Base]
+                      #
+                      attr_reader :printer
+
+                      ##
+                      # @api private
+                      #
+                      # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base::Entities::Chain]
+                      #
+                      delegate :chain, 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 chain.used_data?
+
+                        "with data `#{chain.data}`"
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class Base
+            module Entities
+              module Printers
+                class Base
+                  module Commands
+                    class GenerateExpectedMessagePart < Support::Command
+                      include Support::Delegate
+
+                      ##
+                      # @api private
+                      #
+                      # @!attribute printer [r]
+                      #   @return [ConvenientService::RSpec::Matchers::Custom::Results::Base::Entities::Printers::Base]
+                      #
+                      attr_reader :printer
+
+                      ##
+                      # @api private
+                      #
+                      # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base::Entities::Chain]
+                      #
+                      delegate :chain, 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 chain.used_message?
+
+                        "with message `#{chain.message}`"
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end