convenient_service 0.17.0 → 0.18.0

data/lib/convenient_service/examples/standard/v1/request_params.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "request_params/constants"
-require_relative "request_params/entities"
-require_relative "request_params/services"
-require_relative "request_params/utils"
-
-##
-#
-# @internal
-#   Usage example:
-#
-#     http_string =
-#       <<~TEXT
-#         POST /rules/1000000.json HTTP/1.1
-#         User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36
-#         Host: code-review.com
-#         Content-Type: application/json; charset=utf-8
-#         Content-Length: 134
-#         Accept-Language: en-us
-#         Accept-Encoding: gzip, deflate
-#         Connection: Keep-Alive
-#
-#         {"title":"Avoid error shadowing","description":"Check the official User Docs","tags":["error-shadowing"]}
-#       TEXT
-#
-#     request = ConvenientService::Examples::Standard::V1::RequestParams::Entities::Request.new(http_string:)
-#
-#     ConvenientService::Examples::Standard::V1::RequestParams.prepare(request)
-#
-#   - https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types
-#   - https://www.whatismybrowser.com/guides/the-latest-user-agent/chrome
-#   - https://www.tutorialspoint.com/http/http_requests.htm
-#
-module ConvenientService
-  module Examples
-    module Standard
-      module V1
-        class RequestParams
-          include ConvenientService::Feature::Standard::Config
-
-          entry :prepare do |request|
-            Services::Prepare[request: request]
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module RSpec
-    module PrimitiveMatchers
-      module Classes
-        class DelegateTo
-          module Entities
-            class Matcher
-              module Commands
-                class GeneratePrintableMethod < Support::Command
-                  ##
-                  # @!attribute [r] object
-                  #   @return [Object] Can be any type.
-                  #
-                  attr_reader :object
-
-                  ##
-                  # @!attribute [r] method
-                  #   @return [Symbol, String]
-                  #
-                  attr_reader :method
-
-                  ##
-                  # @param object [Object] Can by any type.
-                  # @param method [Symbol, String]
-                  # @return [void]
-                  #
-                  def initialize(object:, method:)
-                    @object = object
-                    @method = method
-                  end
-
-                  def call
-                    case Utils::Object.resolve_type(object)
-                    when "class", "module"
-                      "#{object}.#{method}"
-                    when "instance"
-                      "#{object.class}##{method}"
-                    end
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/rspec/primitive_matchers/classes/delegate_to/entities/matcher/entities/chainings/sub_matchers/arguments/commands/apply_stub_to_track_delegations.rb

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module RSpec
-    module PrimitiveMatchers
-      module Classes
-        class DelegateTo
-          module Entities
-            class Matcher
-              module Entities
-                module Chainings
-                  module SubMatchers
-                    class Arguments < Chainings::SubMatchers::Base
-                      module Commands
-                        class ApplyStubToTrackDelegations < Support::Command
-                          ##
-                          # @internal
-                          #   NOTE: `include ::RSpec::Mocks::ExampleMethods`.
-                          #   - https://github.com/rspec/rspec-mocks/blob/v3.11.1/lib/rspec/mocks/example_methods.rb
-                          #   - https://github.com/rspec/rspec-mocks/blob/main/lib/rspec/mocks/example_methods.rb
-                          #
-                          include ::RSpec::Mocks::ExampleMethods
-
-                          ##
-                          # @return [ConvenientService::RSpec::PrimitiveMatchers::Classes::DelegateTo]
-                          #
-                          attr_reader :matcher
-
-                          ##
-                          # @param matcher [ConvenientService::RSpec::PrimitiveMatchers::Classes::DelegateTo]
-                          # @return [void]
-                          #
-                          def initialize(matcher:)
-                            @matcher = matcher
-                          end
-
-                          def call
-                            ##
-                            # NOTE: RSpec `allow(object).to receive(method).with(*args, **kwargs)` does NOT support block.
-                            # https://github.com/rspec/rspec-mocks/issues/1182#issuecomment-679820352
-                            #
-                            # NOTE: RSpec `allow(object).to receive(method) do` does NOT support `and_call_original`.
-                            # https://github.com/rspec/rspec-mocks/issues/774#issuecomment-54245277
-                            #
-                            # NOTE: That is why `and_wrap_original` is used.
-                            # https://relishapp.com/rspec/rspec-mocks/docs/configuring-responses/wrapping-the-original-implementation
-                            #
-                            # TODO: Check whether `matcher.object.frozen?` in order to show more explanatory exception instead of the following (provide an example of how to avoid it in the exception message):
-                            #   ArgumentError:
-                            #     Cannot proxy frozen objects, rspec-mocks relies on proxies for method stubbing and expectations
-                            #
-                            allow(matcher.object).to receive(matcher.method).and_wrap_original do |original, *actual_args, **actual_kwargs, &actual_block|
-                              ##
-                              # TODO: Add backtrace for easier reason tracing.
-                              #
-                              matcher.delegations << Entities::Delegation.new(
-                                object: matcher.object,
-                                method: matcher.method,
-                                args: actual_args,
-                                kwargs: actual_kwargs,
-                                block: actual_block
-                              )
-
-                              ##
-                              # NOTE: Imitates `and_call_original`.
-                              #
-                              original.call(*actual_args, **actual_kwargs, &actual_block) if matcher.should_call_original?
-                            end
-                          end
-                        end
-                      end
-                    end
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/rspec/primitive_matchers/classes/delegate_to/entities/matcher/entities/chainings/sub_matchers/arguments/commands/generate_printable_arguments.rb

@@ -1,100 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module RSpec
-    module PrimitiveMatchers
-      module Classes
-        class DelegateTo
-          module Entities
-            class Matcher
-              module Entities
-                module Chainings
-                  module SubMatchers
-                    class Arguments < Chainings::SubMatchers::Base
-                      module Commands
-                        class GeneratePrintableArguments < Support::Command
-                          include Support::Delegate
-
-                          ##
-                          # @!attribute [r] arguments
-                          #   @return [ConvenientService::RSpec::PrimitiveMatchers::Classes::DelegateTo::Entities::Arguments]
-                          #
-                          attr_reader :arguments
-
-                          ##
-                          # @return [Array]
-                          #
-                          delegate :args, to: :arguments
-
-                          ##
-                          # @return [Hash]
-                          #
-                          delegate :kwargs, to: :arguments
-
-                          ##
-                          # @return [Proc]
-                          #
-                          delegate :block, to: :arguments
-
-                          ##
-                          # @param arguments [ConvenientService::RSpec::PrimitiveMatchers::Classes::DelegateTo::Entities::Arguments]
-                          #
-                          def initialize(arguments:)
-                            @arguments = arguments
-                          end
-
-                          ##
-                          # @return [String]
-                          #
-                          def call
-                            return "" if arguments.null_arguments?
-
-                            text =
-                              if args.any? && kwargs.any?
-                                "(#{printable_args}, #{printable_kwargs})"
-                              elsif args.any?
-                                "(#{printable_args})"
-                              elsif kwargs.any?
-                                "(#{printable_kwargs})"
-                              else
-                                "()"
-                              end
-
-                            text += " #{printable_block}" if block
-
-                            text
-                          end
-
-                          ##
-                          # @return [String]
-                          #
-                          def printable_args
-                            args.map(&:inspect).join(", ")
-                          end
-
-                          ##
-                          # @return [String]
-                          #
-                          def printable_kwargs
-                            kwargs.map { |key, value| "#{key}: #{value.inspect}" }.join(", ")
-                          end
-
-                          ##
-                          # @return [String]
-                          #
-                          def printable_block
-                            block ? Utils::Proc.display(block) : ""
-                          end
-                        end
-                      end
-                    end
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,95 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "arguments/commands"
-
-module ConvenientService
-  module RSpec
-    module PrimitiveMatchers
-      module Classes
-        class DelegateTo
-          module Entities
-            class Matcher
-              module Entities
-                module Chainings
-                  module SubMatchers
-                    class Arguments < Chainings::SubMatchers::Base
-                      ##
-                      # @return [void]
-                      #
-                      def apply_stubs!
-                        Commands::ApplyStubToTrackDelegations.call(matcher: matcher)
-                      end
-
-                      ##
-                      # @param block_expectation_value [Object]
-                      # @return [Boolean]
-                      #
-                      def matches?(block_expectation_value)
-                        super
-
-                        matcher.delegations.any? { |delegation| matches_arguments?(delegation.arguments) }
-                      end
-
-                      ##
-                      # @return [String]
-                      #
-                      # @internal
-                      #   TODO: Prettier message.
-                      #
-                      def failure_message
-                        <<~MESSAGE.chomp
-                          #{failure_message_expected_part}
-
-                          #{failure_message_got_part}
-                        MESSAGE
-                      end
-
-                      ##
-                      # @return [String]
-                      #
-                      def failure_message_when_negated
-                        "expected `#{matcher.printable_block_expectation}` NOT to delegate to `#{matcher.printable_method}` #{printable_expected_arguments} at least once, but it did."
-                      end
-
-                      ##
-                      # @return [String]
-                      #
-                      def printable_actual_arguments
-                        return "" if matcher.delegations.none?
-
-                        matcher.delegations
-                          .map { |delegation| Commands::GeneratePrintableArguments.call(arguments: delegation.arguments) }
-                          .join(", ")
-                          .prepend("with ")
-                      end
-
-                      private
-
-                      def failure_message_expected_part
-                        "expected `#{matcher.printable_block_expectation}` to delegate to `#{matcher.printable_method}` #{printable_expected_arguments} at least once, but it didn't."
-                      end
-
-                      ##
-                      # @return [String]
-                      #
-                      # @internal
-                      #   TODO: String diff.
-                      #
-                      def failure_message_got_part
-                        if matcher.delegations.any?
-                          "got delegated #{printable_actual_arguments}"
-                        else
-                          "got not delegated at all"
-                        end
-                      end
-                    end
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,87 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module RSpec
-    module PrimitiveMatchers
-      module Classes
-        class DelegateTo
-          module Entities
-            class Matcher
-              module Entities
-                module Chainings
-                  module SubMatchers
-                    class Base
-                      ##
-                      # @return [ConvenientService::RSpec::PrimitiveMatchers::Classes::DelegateTo]
-                      #
-                      attr_reader :matcher
-
-                      ##
-                      # @return [Object] Can be any type.
-                      #
-                      attr_reader :block_expectation_value
-
-                      ##
-                      # @overload initialize(matcher:)
-                      #   @param matcher [ConvenientService::RSpec::PrimitiveMatchers::Classes::DelegateTo]
-                      #   @return [void]
-                      #
-                      # @overload initialize(matcher:, block_expectation_value:)
-                      #   @param matcher [ConvenientService::RSpec::PrimitiveMatchers::Classes::DelegateTo]
-                      #   @param block_expectation_value [Object] Can be any type.
-                      #   @return [void]
-                      #   @api private
-                      #
-                      def initialize(matcher:, block_expectation_value: nil)
-                        @matcher = matcher
-                        @block_expectation_value = block_expectation_value
-                      end
-
-                      ##
-                      # @return [void]
-                      #
-                      def apply_stubs!
-                      end
-
-                      ##
-                      # @param block_expectation_value [Object] Can be any type.
-                      # @return [Boolean]
-                      #
-                      def matches?(block_expectation_value)
-                        @block_expectation_value = block_expectation_value
-
-                        false
-                      end
-
-                      ##
-                      # @param block_expectation_value [Object] Can be any type.
-                      # @return [Boolean]
-                      #
-                      def does_not_match?(block_expectation_value)
-                        !matches?(block_expectation_value)
-                      end
-
-                      ##
-                      # @return [String]
-                      #
-                      def failure_message
-                        ""
-                      end
-
-                      ##
-                      # @return [String]
-                      #
-                      def failure_message_when_negated
-                        ""
-                      end
-                    end
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,132 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module RSpec
-    module PrimitiveMatchers
-      module Classes
-        class DelegateTo
-          module Entities
-            class Matcher
-              module Entities
-                module Chainings
-                  module SubMatchers
-                    class ReturnItsValue < Chainings::SubMatchers::Base
-                      ##
-                      # @param block_expectation_value [Object]
-                      # @return [Boolean]
-                      #
-                      # @internal
-                      #   TODO: Proper explanatory message when `matcher.delegation_value` raises exception.
-                      #
-                      def matches?(block_expectation_value)
-                        super
-
-                        ##
-                        # TODO: `with_warmup`.
-                        #
-                        # IMPORTANT: `and_return_its_value` works only when `delegate_to` checks a pure function.
-                        #
-                        # For example (1):
-                        #   def require_dependencies_pure
-                        #     RequireDependenciesPure.call
-                        #   end
-                        #
-                        #   class RequireDependenciesPure
-                        #     def self.call
-                        #       dependencies.require!
-                        #
-                        #       true
-                        #     end
-                        #   end
-                        #
-                        #   # Works since `RequireDependenciesPure.call` always returns `true`.
-                        #   specify do
-                        #     expect { require_dependencies_pure }
-                        #       .to delegate_to(RequireDependenciesPure, :call)
-                        #       .and_return_its_value
-                        #   end
-                        #
-                        # Example (2):
-                        #   def require_dependencies_not_pure
-                        #     RequireDependenciesNotPure.call
-                        #   end
-                        #
-                        #   class RequireDependenciesNotPure
-                        #     def self.call
-                        #       return false if dependencies.required?
-                        #
-                        #       dependencies.require!
-                        #
-                        #       true
-                        #     end
-                        #   end
-                        #
-                        #   # Does NOT work since `RequireDependenciesNotPure.call` returns `true` for the first time and `false` for the subsequent call.
-                        #   specify do
-                        #     expect { require_dependencies_not_pure }
-                        #       .to delegate_to(RequireDependenciesNotPure, :call)
-                        #       .and_return_its_value
-                        #   end
-                        #
-                        block_expectation_value == matcher.delegation_value
-                      end
-
-                      ##
-                      # @return [String]
-                      #
-                      def failure_message
-                        [failure_message_permanent_part, same_visual_output_note].reject(&:empty?).join("\n\n")
-                      end
-
-                      ##
-                      # @return [String]
-                      #
-                      def failure_message_when_negated
-                        "expected `#{matcher.printable_block_expectation}` NOT to delegate to `#{matcher.printable_method}` and return its value, but it did."
-                      end
-
-                      private
-
-                      def failure_message_permanent_part
-                        <<~MESSAGE.chomp
-                          expected `#{matcher.printable_block_expectation}` to delegate to `#{matcher.printable_method}` and return its value, but it didn't.
-
-                          `#{matcher.printable_block_expectation}` returns `#{block_expectation_value.inspect}`, but delegation returns `#{matcher.delegation_value.inspect}`.
-                        MESSAGE
-                      end
-
-                      ##
-                      # @internal
-                      #   NOTE: Early return is harder to understand in this particular case, that is why a casual if is used.
-                      #
-                      #   def note
-                      #     return "" if block_expectation_value.inspect != matcher.delegation_value.inspect
-                      #     return "" if block_expectation_value == matcher.delegation_value
-                      #
-                      #     # ...
-                      #   end
-                      #
-                      def same_visual_output_note
-                        if block_expectation_value.inspect == matcher.delegation_value.inspect && block_expectation_value != matcher.delegation_value
-                          <<~MESSAGE.chomp
-                            NOTE: `#{block_expectation_value.inspect}` and `#{matcher.delegation_value.inspect}` have the same visual output, but they are different objects in terms of `#==`.
-
-                            If it is expected behavior, ignore this note.
-
-                            Otherwise, define a meaningful `#==` for `#{block_expectation_value.class}` or adjust its `#inspect` to generate different output.
-                          MESSAGE
-                        else
-                          ""
-                        end
-                      end
-                    end
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module RSpec
-    module PrimitiveMatchers
-      module Classes
-        class DelegateTo
-          module Entities
-            class Matcher
-              module Entities
-                module Chainings
-                  module SubMatchers
-                    class WithAnyArguments < Chainings::SubMatchers::Arguments
-                      ##
-                      # @return [Boolean]
-                      #
-                      def matches_arguments?(arguments)
-                        true
-                      end
-
-                      ##
-                      # @return [String]
-                      #
-                      def printable_expected_arguments
-                        "with any arguments (no arguments is also valid)"
-                      end
-                    end
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module RSpec
-    module PrimitiveMatchers
-      module Classes
-        class DelegateTo
-          module Entities
-            class Matcher
-              module Entities
-                module Chainings
-                  module SubMatchers
-                    class WithConcreteArguments < Chainings::SubMatchers::Arguments
-                      ##
-                      # @return [Boolean]
-                      #
-                      def matches_arguments?(arguments)
-                        Utils.to_bool(arguments == matcher.expected_arguments)
-                      end
-
-                      ##
-                      # @return [String]
-                      #
-                      def printable_expected_arguments
-                        "with `#{Arguments::Commands::GeneratePrintableArguments.call(arguments: matcher.expected_arguments)}`"
-                      end
-                    end
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end