convenient_service 0.1.0

data/lib/convenient_service/rspec/helpers/custom/wrap_method.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "wrap_method/entities"
+require_relative "wrap_method/errors"
+
+module ConvenientService
+  module RSpec
+    module Helpers
+      module Custom
+        ##
+        # TODO: Specs.
+        #
+        class WrapMethod < Support::Command
+          def initialize(entity, method, middlewares:)
+            @entity = entity
+            @method = method
+            @middlewares = Utils::Array.wrap(middlewares)
+          end
+
+          def call
+            Entities::WrappedMethod.new(entity: @entity, method: @method, middlewares: @middlewares)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/helpers/custom.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "custom/ignoring_error"
+require_relative "custom/stub_service"
+require_relative "custom/wrap_method"

data/lib/convenient_service/rspec/helpers/ignoring_error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Helpers
+      module IgnoringError
+        def ignoring_error(...)
+          Custom::IgnoringError.call(...)
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/helpers/stub_service.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Helpers
+      module StubService
+        def stub_service(...)
+          Custom::StubService.call(...)
+        end
+
+        def return_result(status)
+          Custom::StubService::Entities::ResultSpec.new(status: status)
+        end
+
+        def return_success
+          Custom::StubService::Entities::ResultSpec.new(status: :success)
+        end
+
+        def return_failure
+          Custom::StubService::Entities::ResultSpec.new(status: :failure)
+        end
+
+        def return_error
+          Custom::StubService::Entities::ResultSpec.new(status: :error)
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/helpers/wrap_method.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Helpers
+      module WrapMethod
+        def wrap_method(...)
+          Custom::WrapMethod.call(...)
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/helpers.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "helpers/custom"
+
+require_relative "helpers/ignoring_error"
+require_relative "helpers/stub_service"
+require_relative "helpers/wrap_method"
+
+module ConvenientService
+  module RSpec
+    module Helpers
+      include Support::Concern
+
+      included do
+        include Helpers::IgnoringError
+        include Helpers::StubService
+        include Helpers::WrapMethod
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/matchers/be_descendant_of.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module BeDescendantOf
+        def be_descendant_of(...)
+          Custom::BeDescendantOf.new(...)
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/matchers/be_direct_descendant_of.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module BeDirectDescendantOf
+        def be_direct_descendant_of(...)
+          Custom::BeDirectDescendantOf.new(...)
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/matchers/cache_its_value.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module CacheItsValue
+        def cache_its_value(...)
+          Custom::CacheItsValue.new(...)
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/matchers/call_chain_next.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module CallChainNext
+        def call_chain_next(...)
+          Custom::CallChainNext.new(...)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        ##
+        # NOTE: Navigate to the link below and `Ctrl + F` for "Custom Matcher from scratch"
+        # for a guide of how to define a complex custom matcher.
+        # https://rubydoc.info/github/rspec/rspec-expectations/RSpec/Matchers
+        #
+        # More info:
+        # - https://relishapp.com/rspec/rspec-expectations/v/3-11/docs/custom-matchers/define-a-custom-matcher
+        # - http://rspec.info/documentation/3.9/rspec-expectations/RSpec/Matchers/MatcherProtocol.html
+        # - https://makandracards.com/makandra/662-write-custom-rspec-matchers
+        #
+        class BeDescendantOf
+          def initialize(base_klass)
+            @base_klass = base_klass
+          end
+
+          def matches?(klass)
+            @klass = klass
+
+            Utils::Bool.to_bool(klass < base_klass)
+          end
+
+          def description
+            "be a descendant of `#{base_klass}`"
+          end
+
+          ##
+          # NOTE: `failure_message` is only called when `mathces?` returns `false`.
+          # https://rubydoc.info/github/rspec/rspec-expectations/RSpec/Matchers/MatcherProtocol#failure_message-instance_method
+          #
+          def failure_message
+            "expected #{klass} to be a descendant of `#{base_klass}`"
+          end
+
+          ##
+          # NOTE: `failure_message_when_negated` is only called when `mathces?` returns `false`.
+          # https://rubydoc.info/github/rspec/rspec-expectations/RSpec/Matchers/MatcherProtocol#failure_message-instance_method
+          #
+          def failure_message_when_negated
+            "expected #{klass} NOT to be a descendant of `#{base_klass}`"
+          end
+
+          private
+
+          attr_reader :klass, :base_klass
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        ##
+        # NOTE: Navigate to the link below and `Ctrl + F` for "Custom Matcher from scratch"
+        # for a guide of how to define a complex custom matcher.
+        # https://rubydoc.info/github/rspec/rspec-expectations/RSpec/Matchers
+        #
+        # More info:
+        # - https://relishapp.com/rspec/rspec-expectations/v/3-11/docs/custom-matchers/define-a-custom-matcher
+        # - http://rspec.info/documentation/3.9/rspec-expectations/RSpec/Matchers/MatcherProtocol.html
+        # - https://makandracards.com/makandra/662-write-custom-rspec-matchers
+        #
+        class BeDirectDescendantOf
+          def initialize(base_klass)
+            @base_klass = base_klass
+          end
+
+          def matches?(klass)
+            @klass = klass
+
+            klass.superclass == base_klass
+          end
+
+          def description
+            "be a direct descendant of `#{base_klass}`"
+          end
+
+          ##
+          # NOTE: `failure_message` is only called when `mathces?` returns `false`.
+          # https://rubydoc.info/github/rspec/rspec-expectations/RSpec/Matchers/MatcherProtocol#failure_message-instance_method
+          #
+          def failure_message
+            "expected #{klass} to be a direct descendant of `#{base_klass}`"
+          end
+
+          ##
+          # NOTE: `failure_message_when_negated` is only called when `mathces?` returns `false`.
+          # https://rubydoc.info/github/rspec/rspec-expectations/RSpec/Matchers/MatcherProtocol#failure_message-instance_method
+          #
+          def failure_message_when_negated
+            "expected #{klass} NOT to be a direct descendant of `#{base_klass}`"
+          end
+
+          private
+
+          attr_reader :klass, :base_klass
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        class CacheItsValue
+          def matches?(block_expectation)
+            @block_expectation = block_expectation
+
+            ##
+            # NOTE: Identical to `block_expectation.call.object_id == block_expectation.call.object_id`.
+            #
+            block_expectation.call.equal?(block_expectation.call)
+          end
+
+          def supports_block_expectations?
+            true
+          end
+
+          def description
+            "cache its value"
+          end
+
+          def failure_message
+            "expected #{printable_block} to cache its value"
+          end
+
+          def failure_message_when_negated
+            "expected #{printable_block} NOT to cache its value"
+          end
+
+          ##
+          # NOTE: An example of how RSpec extracts block source, but they marked it as private.
+          # https://github.com/rspec/rspec-expectations/blob/311aaf245f2c5493572bf683b8c441cb5f7e44c8/lib/rspec/matchers/built_in/change.rb#L437
+          #
+          # TODO: `printable_block` when `method_source` is available.
+          # https://github.com/banister/method_source
+          #
+          # def printable_block
+          #   @printable_block ||= block_expectation.source
+          # end
+          #
+          def printable_block
+            @printable_block ||= "{ ... }"
+          end
+
+          private
+
+          attr_reader :block_expectation
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        ##
+        #   expect { method.call }
+        #     .to call_chain_next.on(method)
+        #     .with_arguments(*args, **kwargs, &block)
+        #     .and_return_its_value
+        #
+        class CallChainNext
+          include ::RSpec::Expectations
+          include ::RSpec::Matchers
+          include ::RSpec::Mocks::ExampleMethods
+
+          def matches?(block_expectation)
+            @block_expectation = block_expectation
+
+            value = nil
+
+            expect { value = block_expectation.call }.to change(method, :chain_called?).from(false).to(true)
+
+            if used_with_arguments?
+              expect(method.chain_args).to eq(expected_args)
+              expect(method.chain_kwargs).to eq(expected_kwargs)
+              expect(method.chain_block).to eq(expected_block)
+            end
+
+            if used_and_return_its_value?
+              expect(value).to eq(method.chain_value)
+            end
+
+            true
+          end
+
+          ##
+          # https://github.com/rspec/rspec-expectations/blob/main/lib/rspec/matchers/built_in/change.rb#L50
+          #
+          def does_not_match?(block_expectation)
+            @block_expectation = block_expectation
+
+            value = nil
+
+            ##
+            # NOTE: `expect { value = block_expectation.call }.not_to change(method, :chain_called?).from(false).to(true)` raises the following error:
+            #
+            #   NotImplementedError:
+            #     `expect { }.not_to change { }.to()` is not supported
+            #
+            # That is why `expect(method.chain_called?).to eq(false)` is introduced.
+            #
+            expect(method.chain_called?).to eq(false)
+            expect { value = block_expectation.call }.not_to change(method, :chain_called?)
+
+            if used_with_arguments?
+              expect(method.chain_args).not_to eq(expected_args)
+              expect(method.chain_kwargs).not_to eq(expected_kwargs)
+              expect(method.chain_block).not_to eq(expected_block)
+            end
+
+            if used_and_return_its_value?
+              expect(value).not_to eq(method.chain_value)
+            end
+
+            true
+          end
+
+          def supports_block_expectations?
+            true
+          end
+
+          def description
+            "call `chain.next`"
+          end
+
+          def failure_message
+            "expected to call `chain.next`"
+          end
+
+          def failure_message_when_negated
+            "expected NOT to call `chain.next`"
+          end
+
+          def on(method)
+            chain[:method] = method
+
+            self
+          end
+
+          def with_arguments(*args, **kwargs, &block)
+            chain[:with_arguments] = {args: args, kwargs: kwargs, block: block}
+
+            self
+          end
+
+          def and_return_its_value
+            chain[:and_return_its_value] = true
+
+            self
+          end
+
+          private
+
+          attr_reader :block_expectation
+
+          def used_with_arguments?
+            chain.key?(:with_arguments)
+          end
+
+          def used_and_return_its_value?
+            chain.key?(:and_return_its_value)
+          end
+
+          def chain
+            @chain ||= {}
+          end
+
+          def method
+            @method ||= chain[:method]
+          end
+
+          def args
+            @args ||= chain.dig(:with_arguments, :args) || []
+          end
+
+          alias_method :expected_args, :args
+
+          def kwargs
+            @kwargs ||= chain.dig(:with_arguments, :kwargs) || {}
+          end
+
+          alias_method :expected_kwargs, :kwargs
+
+          ##
+          # NOTE: `if defined?` is used in order to cache `nil` if needed.
+          #
+          def block
+            return @block if defined? @block
+
+            @block = chain.dig(:with_arguments, :block)
+          end
+
+          alias_method :expected_block, :block
+        end
+      end
+    end
+  end
+end