convenient_service 0.1.0

data/lib/convenient_service/rspec/matchers/custom/results/be_error.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class BeError
+            def matches?(result)
+              @result = result
+
+              rules = []
+
+              rules << ->(result) { result.class.include?(ConvenientService::Service::Plugins::HasResult::Entities::Result::Concern) }
+              rules << ->(result) { result.error? }
+              rules << ->(result) { result.service.instance_of?(service_class) } if used_of?
+              rules << ->(result) { result.message == message } if used_message?
+              rules << ->(result) { result.code == code } if used_code?
+
+              condition = ConvenientService::Utils::Proc.conjunct(rules)
+
+              condition.call(result)
+            end
+
+            def with_message(message)
+              chain[:message] = message
+
+              self
+            end
+
+            def and_message(message)
+              chain[:message] = message
+
+              self
+            end
+
+            def with_code(code)
+              chain[:code] = code
+
+              self
+            end
+
+            def and_code(code)
+              chain[:code] = code
+
+              self
+            end
+
+            def of(service_class)
+              chain[:service_class] = service_class
+
+              self
+            end
+
+            def description
+              ##
+              # TODO: of
+              #
+              parts = []
+
+              parts << "be an `error`"
+              parts << "of `#{service_class}`" if used_of?
+              parts << "with message `#{message}`" if used_message?
+              parts << "with code `#{code}`" if used_code?
+              parts << "\n\n"
+              parts << "got `#{result.status}`"
+              parts << "of `#{result.service.class}`" if used_of?
+              parts << "with message `#{result.message}`" if used_message?
+              parts << "with code `#{result.code}`" if used_code?
+
+              parts.join(" ")
+            end
+
+            def failure_message
+              ##
+              # TODO: got text after expect text.
+              #
+              parts = []
+
+              parts << "expected that `#{result}` would be an `error`"
+              parts << "of `#{service_class}`" if used_of?
+              parts << "with message `#{message}`" if used_message?
+              parts << "with code `#{code}`" if used_code?
+              parts << "\n\n"
+              parts << "got `#{result.status}`"
+              parts << "of `#{result.service.class}`" if used_of?
+              parts << "with message `#{result.message}`" if used_message?
+              parts << "with code `#{result.code}`" if used_code?
+
+              parts.join(" ")
+            end
+
+            ##
+            # https://relishapp.com/rspec/rspec-expectations/v/3-11/docs/custom-matchers/define-a-custom-matcher#overriding-the-failure-message-when-negated
+            #
+            def failure_message_when_negated
+              ##
+              # TODO: got text after expect text.
+              #
+              parts = []
+
+              parts << "expected that #{result} would NOT be an `error`"
+              parts << "of `#{service_class}`" if used_of?
+              parts << "with message `#{message}`" if used_message?
+              parts << "with code `#{code}`" if used_code?
+              parts << "\n\n"
+              parts << "got `#{result.status}`"
+              parts << "of `#{result.service.class}`" if used_of?
+              parts << "with message `#{result.message}`" if used_message?
+              parts << "with code `#{result.code}`" if used_code?
+
+              parts.join(" ")
+            end
+
+            private
+
+            attr_reader :result
+
+            def used_message?
+              chain.key?(:message)
+            end
+
+            def used_code?
+              chain.key?(:code)
+            end
+
+            def used_of?
+              chain.key?(:service_class)
+            end
+
+            def chain
+              @chain ||= {}
+            end
+
+            def message
+              @message ||= chain[:message] || ""
+            end
+
+            def code
+              @code ||= chain[:code] || ""
+            end
+
+            def service_class
+              return @service_class if defined? @service_class
+
+              @service_class = chain[:service_class]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/matchers/custom/results/be_failure.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class BeFailure
+            def matches?(result)
+              @result = result
+
+              rules = []
+
+              rules << ->(result) { result.class.include?(ConvenientService::Service::Plugins::HasResult::Entities::Result::Concern) }
+              rules << ->(result) { result.failure? }
+              rules << ->(result) { result.service.instance_of?(service_class) } if used_of?
+              rules << ->(result) { result.data == data } if used_data?
+
+              condition = ConvenientService::Utils::Proc.conjunct(rules)
+
+              condition.call(result)
+            end
+
+            def with_data(data)
+              chain[:data] = data
+
+              self
+            end
+
+            def of(service_class)
+              chain[:service_class] = service_class
+
+              self
+            end
+
+            def description
+              ##
+              # TODO: of
+              #
+              parts = []
+
+              parts << "be a `failure`"
+              parts << "of `#{service_class}`" if used_of?
+              parts << "with data `#{data}`" if used_data?
+              parts << "\n\n"
+              parts << "got `#{result.status}`"
+              parts << "of `#{result.service.class}`" if used_of?
+              parts << "with data `#{result.data.to_h}`" if used_data?
+
+              parts.join(" ")
+            end
+
+            def failure_message
+              ##
+              # TODO: got text after expect text.
+              #
+              parts = []
+
+              parts << "expected that `#{result}` would be a `failure`"
+              parts << "of `#{service_class}`" if used_of?
+              parts << "with data `#{data}`" if used_data?
+              parts << "\n\n"
+              parts << "got `#{result.status}`"
+              parts << "of `#{result.service.class}`" if used_of?
+              parts << "with data `#{result.data.to_h}`" if used_data?
+
+              parts.join(" ")
+            end
+
+            ##
+            # https://relishapp.com/rspec/rspec-expectations/v/3-11/docs/custom-matchers/define-a-custom-matcher#overriding-the-failure-message-when-negated
+            #
+            def failure_message_when_negated
+              ##
+              # TODO: got text after expect text.
+              #
+              parts = []
+
+              parts << "expected that #{result} would NOT be a `failure`"
+              parts << "of `#{service_class}`" if used_of?
+              parts << "with data `#{data}`" if used_data?
+              parts << "\n\n"
+              parts << "got `#{result.status}`"
+              parts << "of `#{result.service.class}`" if used_of?
+              parts << "with data `#{result.data.to_h}`" if used_data?
+
+              parts.join(" ")
+            end
+
+            private
+
+            attr_reader :result
+
+            def used_data?
+              chain.key?(:data)
+            end
+
+            def used_of?
+              chain.key?(:service_class)
+            end
+
+            def chain
+              @chain ||= {}
+            end
+
+            def data
+              @data ||= chain[:data] || {}
+            end
+
+            def service_class
+              return @service_class if defined? @service_class
+
+              @service_class = chain[:service_class]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/matchers/custom/results/be_success.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class BeSuccess
+            def matches?(result)
+              @result = result
+
+              rules = []
+
+              rules << ->(result) { result.class.include?(ConvenientService::Service::Plugins::HasResult::Entities::Result::Concern) }
+              rules << ->(result) { result.success? }
+              rules << ->(result) { result.service.instance_of?(service_class) } if used_of?
+              rules << ->(result) { result.data == data } if used_data?
+
+              condition = ConvenientService::Utils::Proc.conjunct(rules)
+
+              condition.call(result)
+            end
+
+            def with_data(data)
+              chain[:data] = data
+
+              self
+            end
+
+            def of(service_class)
+              chain[:service_class] = service_class
+
+              self
+            end
+
+            def description
+              ##
+              # TODO: of
+              #
+              parts = []
+
+              parts << "be a `success`"
+              parts << "of `#{service_class}`" if used_of?
+              parts << "with data `#{data}`" if used_data?
+              parts << "\n\n"
+              parts << "got `#{result.status}`"
+              parts << "of `#{result.service.class}`" if used_of?
+              parts << "with data `#{result.data.to_h}`" if used_data?
+
+              parts.join(" ")
+            end
+
+            def failure_message
+              ##
+              # TODO: got text after expect text.
+              #
+              parts = []
+
+              parts << "expected that `#{result}` would be a `success`"
+              parts << "of `#{service_class}`" if used_of?
+              parts << "with data `#{data}`" if used_data?
+              parts << "\n\n"
+              parts << "got `#{result.status}`"
+              parts << "of `#{result.service.class}`" if used_of?
+              parts << "with data `#{result.data.to_h}`" if used_data?
+
+              parts.join(" ")
+            end
+
+            ##
+            # https://relishapp.com/rspec/rspec-expectations/v/3-11/docs/custom-matchers/define-a-custom-matcher#overriding-the-failure-message-when-negated
+            #
+            def failure_message_when_negated
+              ##
+              # TODO: got text after expect text.
+              #
+              parts = []
+
+              parts << "expected that #{result} would NOT be a `success`"
+              parts << "of `#{service_class}`" if used_of?
+              parts << "with data `#{data}`" if used_data?
+              parts << "\n\n"
+              parts << "got `#{result.status}`"
+              parts << "of `#{result.service.class}`" if used_of?
+              parts << "with data `#{result.data.to_h}`" if used_data?
+
+              parts.join(" ")
+            end
+
+            private
+
+            attr_reader :result
+
+            def used_data?
+              chain.key?(:data)
+            end
+
+            def used_of?
+              chain.key?(:service_class)
+            end
+
+            def chain
+              @chain ||= {}
+            end
+
+            def data
+              @data ||= chain[:data] || {}
+            end
+
+            def service_class
+              return @service_class if defined? @service_class
+
+              @service_class = chain[:service_class]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "results/be_error"
+require_relative "results/be_failure"
+require_relative "results/be_success"

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "custom/be_descendant_of"
+require_relative "custom/be_direct_descendant_of"
+require_relative "custom/cache_its_value"
+require_relative "custom/call_chain_next"
+require_relative "custom/delegate_to"
+require_relative "custom/extend_module"
+require_relative "custom/have_abstract_method"
+require_relative "custom/have_alias_method"
+require_relative "custom/have_attr_accessor"
+require_relative "custom/have_attr_reader"
+require_relative "custom/have_attr_writer"
+require_relative "custom/include_module"
+require_relative "custom/prepend_module"
+require_relative "custom/results"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

data/lib/convenient_service/rspec/matchers/results/be_error.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Results
+        module BeError
+          def be_error(...)
+            Custom::Results::BeError.new(...)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/matchers/results/be_failure.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Results
+        module BeFailure
+          def be_failure(...)
+            Custom::Results::BeFailure.new(...)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/matchers/results/be_success.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Results
+        module BeSuccess
+          def be_success(...)
+            Custom::Results::BeSuccess.new(...)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "results/be_error"
+require_relative "results/be_failure"
+require_relative "results/be_success"
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Results
+        include Support::Concern
+
+        included do
+          include Results::BeError
+          include Results::BeFailure
+          include Results::BeSuccess
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/matchers.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "matchers/custom"
+
+require_relative "matchers/be_descendant_of"
+require_relative "matchers/be_direct_descendant_of"
+require_relative "matchers/cache_its_value"
+require_relative "matchers/call_chain_next"
+require_relative "matchers/delegate_to"
+require_relative "matchers/extend_module"
+require_relative "matchers/have_abstract_method"
+require_relative "matchers/have_alias_method"
+require_relative "matchers/have_attr_accessor"
+require_relative "matchers/have_attr_reader"
+require_relative "matchers/have_attr_writer"
+require_relative "matchers/include_module"
+require_relative "matchers/prepend_module"
+require_relative "matchers/results"
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      include Support::Concern
+
+      included do
+        include Matchers::BeDescendantOf
+        include Matchers::BeDirectDescendantOf
+        include Matchers::CacheItsValue
+        include Matchers::CallChainNext
+        include Matchers::DelegateTo
+        include Matchers::ExtendModule
+        include Matchers::HaveAbstractMethod
+        include Matchers::HaveAliasMethod
+        include Matchers::HaveAttrAccessor
+        include Matchers::HaveAttrReader
+        include Matchers::HaveAttrWriter
+        include Matchers::IncludeModule
+        include Matchers::PrependModule
+        include Matchers::Results
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "rspec/helpers"
+require_relative "rspec/matchers"

data/lib/convenient_service/service/plugins/aliases.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Plugins
+    Result = ::ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins
+    Service = ::ConvenientService::Service::Plugins
+  end
+end