convenient_service 0.5.0 → 0.7.0

data/lib/convenient_service/rspec/matchers/custom/results/base/commands/match_result_step.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class Base
+            module Commands
+              class MatchResultStep < Support::Command
+                ##
+                # @!attribute result [r]
+                #   @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+                #
+                attr_reader :result
+
+                ##
+                # @!attribute step [r]
+                #   @return [Class, Symbol]
+                #
+                attr_reader :step
+
+                ##
+                # @param result [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+                # @param step [Class, Symbol]
+                # @return [void]
+                #
+                def initialize(result:, step:)
+                  @result = result
+                  @step = step
+                end
+
+                ##
+                # @return [Boolean]
+                # @raise [ConvenientService::RSpec::Matchers::Custom::Results::Base::Errors::InvalidStep]
+                #
+                def call
+                  case step
+                  when ::Class then match_service_step?
+                  when :result then match_result_method_step?
+                  when ::Symbol then match_method_step?
+                  when nil then match_without_step?
+                  else raise Errors::InvalidStep.new(step: step)
+                  end
+                end
+
+                private
+
+                ##
+                # @return [Boolean]
+                #
+                def match_service_step?
+                  service_step = Commands::FindResultServiceStep.call(result: result, service_class: step)
+
+                  Utils::Bool.to_bool(service_step)
+                end
+
+                ##
+                # @return [Boolean]
+                #
+                def match_result_method_step?
+                  result_method_step = Commands::FindResultResultMethodStep.call(result: result)
+
+                  Utils::Bool.to_bool(result_method_step)
+                end
+
+                ##
+                # @return [Boolean]
+                #
+                def match_method_step?
+                  method_step = Commands::FindResultMethodStep.call(result: result, method_name: step)
+
+                  Utils::Bool.to_bool(method_step)
+                end
+
+                ##
+                # @return [Boolean]
+                #
+                def match_without_step?
+                  result.step.nil?
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "commands/find_result_method_step"
+require_relative "commands/find_result_result_method_step"
+require_relative "commands/find_result_service_step"
+
+require_relative "commands/generate_expected_step_part"
+require_relative "commands/generate_got_step_part"
+
+require_relative "commands/match_result_step"

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class Base
+            module Errors
+              class InvalidStep < ConvenientService::Error
+                def initialize(step:)
+                  message = <<~TEXT
+                    Step `#{step}` is NOT valid.
+
+                    `of_step` only accepts a Class or a Symbol. For example:
+
+                    be_success.of_step(ReadFileContent)
+                    be_success.of_step(:validate_path)
+                    be_success.of_step(:result)
+
+                    If you need to confirm that `result` has NO step - use `without_step` instead.
+
+                    be_success.without_step
+                  TEXT
+
+                  super(message)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require_relative "base/commands"
+require_relative "base/errors"
+
 module ConvenientService
   module RSpec
     module Matchers
@@ -24,7 +27,8 @@ module ConvenientService
 
               rules << ->(result) { result.class.include?(Service::Plugins::HasResult::Entities::Result::Concern) }
               rules << ->(result) { result.status.in?(statuses) }
-              rules << ->(result) { result.service.instance_of?(service_class) } if used_of?
+              rules << ->(result) { result.service.instance_of?(service_class) } if used_of_service?
+              rules << ->(result) { Commands::MatchResultStep.call(result: result, step: step) } if used_of_step?
               rules << ->(result) { result.unsafe_data == data } if used_data?
               rules << ->(result) { result.unsafe_message == message } if used_message?
               rules << ->(result) { result.unsafe_code == code } if used_code?
@@ -38,14 +42,14 @@ module ConvenientService
             # @return [String]
             #
             def description
-              default_text
+              expected_parts
             end
 
             ##
             # @return [String]
             #
             def failure_message
-              "expected that `#{result}` would #{default_text}"
+              "expected that `#{result.service.class}` result would #{default_text}"
             end
 
             ##
@@ -55,7 +59,7 @@ module ConvenientService
             #   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
-              "expected that #{result} would NOT #{default_text}"
+              "expected that `#{result.service.class}` result would NOT #{default_text}"
             end
 
             ##
@@ -131,12 +135,31 @@ module ConvenientService
             # @param service_class [Class]
             # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base]
             #
-            def of(service_class)
+            def of_service(service_class)
               chain[:service_class] = service_class
 
               self
             end
 
+            ##
+            # @param step [Class, Symbol]
+            # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base]
+            #
+            def of_step(step)
+              chain[:step] = step
+
+              self
+            end
+
+            ##
+            # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base]
+            #
+            def without_step
+              chain[:step] = nil
+
+              self
+            end
+
             private
 
             ##
@@ -149,21 +172,45 @@ module ConvenientService
             # @return [String]
             #
             def default_text
+              expected_parts << "\n\n" << got_parts
+            end
+
+            ##
+            # @return [String]
+            #
+            # @internal
+            #   TODO: Align for easier visual comparison.
+            #   TODO: New line for each attribute.
+            #
+            def expected_parts
               parts = []
 
               parts << "be #{printable_statuses}"
-              parts << "of `#{service_class}`" if used_of?
+              parts << "of service `#{service_class}`" if used_of_service?
+              parts << Commands::GenerateExpectedStepPart.call(step: step) if used_of_step?
               parts << "with data `#{data}`" if used_data?
               parts << "with message `#{message}`" if used_message?
               parts << "with code `#{code}`" if used_code?
 
-              parts << "\n\n"
+              parts.join(" ")
+            end
+
+            ##
+            # @return [String]
+            #
+            # @internal
+            #   TODO: Align for easier visual comparison.
+            #   TODO: New line for each attribute.
+            #
+            def got_parts
+              parts = []
 
               parts << "got `#{result.status}`"
-              parts << "of `#{result.service.class}`" if used_of?
-              parts << "with data `#{result.data}`" if used_data?
-              parts << "with message `#{result.message}`" if used_message?
-              parts << "with code `#{result.code}`" if used_code?
+              parts << "of service `#{result.service.class}`" if used_of_service?
+              parts << Commands::GenerateGotStepPart.call(result: result) if used_of_step?
+              parts << "with data `#{result.unsafe_data}`" if used_data?
+              parts << "with message `#{result.unsafe_message}`" if used_message?
+              parts << "with code `#{result.unsafe_code}`" if used_code?
 
               parts.join(" ")
             end
@@ -192,10 +239,17 @@ module ConvenientService
             ##
             # @return [Boolean]
             #
-            def used_of?
+            def used_of_service?
               chain.key?(:service_class)
             end
 
+            ##
+            # @return [Boolean]
+            #
+            def used_of_step?
+              chain.key?(:step)
+            end
+
             ##
             # @return [Hash]
             #
@@ -224,6 +278,13 @@ module ConvenientService
               Utils::Object.instance_variable_fetch(self, :@service_class) { chain[:service_class] }
             end
 
+            ##
+            # @return [Class]
+            #
+            def step
+              Utils::Object.instance_variable_fetch(self, :@step) { chain[:step] }
+            end
+
             ##
             # @return [Hash]
             #

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        ##
+        # @internal
+        #   class User
+        #     include InstanceMethods
+        #
+        #     singleton_class.include ClassMethods # or more common `extend ClassMethods`.
+        #
+        #     prepend InstanceMethods
+        #
+        #     singleton_class.prepend ClassMethods # no short form like `extend`.
+        #   end
+        #
+        class SingletonPrependModule
+          ##
+          # @param mod [Module]
+          # @return [void]
+          #
+          # @internal
+          #   NOTE: `mod` since `module` is a keyword.
+          #
+          def initialize(mod)
+            @mod = mod
+          end
+
+          ##
+          # @param klass [Class, Module]
+          # @return [Boolean]
+          #
+          def matches?(klass)
+            @klass = klass
+
+            klass.singleton_class.ancestors.take_while { |ancestor| ancestor != klass }.include?(mod)
+          end
+
+          ##
+          # @return [String]
+          #
+          def description
+            "`singleton_class.prepend` module `#{mod}`"
+          end
+
+          ##
+          # @return [String]
+          #
+          def failure_message
+            "expected `#{klass}` to `singleton_class.prepend` module `#{mod}`"
+          end
+
+          ##
+          # @return [String]
+          #
+          def failure_message_when_negated
+            "expected `#{klass}` NOT to `singleton_class.prepend` module `#{mod}`"
+          end
+
+          private
+
+          ##
+          # @!attribute [r] klass
+          #   @return [Class, Module]
+          #
+          attr_reader :klass
+
+          ##
+          # @!attribute [r] mod
+          #   @return [Module]
+          #
+          attr_reader :mod
+        end
+      end
+    end
+  end
+end

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

@@ -14,3 +14,4 @@ require_relative "custom/have_attr_writer"
 require_relative "custom/include_module"
 require_relative "custom/prepend_module"
 require_relative "custom/results"
+require_relative "custom/singleton_prepend_module"

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

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

data/lib/convenient_service/rspec/matchers.rb

@@ -16,6 +16,7 @@ require_relative "matchers/have_attr_writer"
 require_relative "matchers/include_module"
 require_relative "matchers/prepend_module"
 require_relative "matchers/results"
+require_relative "matchers/singleton_prepend_module"
 
 module ConvenientService
   module RSpec
@@ -37,6 +38,7 @@ module ConvenientService
         include Matchers::IncludeModule
         include Matchers::PrependModule
         include Matchers::Results
+        include Matchers::SingletonPrependModule
       end
     end
   end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/can_have_parent_result/concern.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module CanHaveParentResult
+                module Concern
+                  include Support::Concern
+
+                  instance_methods do
+                    ##
+                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result, nil]
+                    #
+                    def parent
+                      @parent ||= internals.cache[:parent]
+                    end
+
+                    ##
+                    # @param include_self [Boolean]
+                    # @return [Array<ConvenientService::Service::Plugins::HasResult::Entities::Result>]
+                    #
+                    # @internal
+                    #   Without enumerator `parents` method is roughly equivalent to the following code:
+                    #
+                    #   def parents(include_self: false)
+                    #     parents = []
+                    #
+                    #     parents << self if include_self
+                    #
+                    #     ##
+                    #     # NOTE: Empty parentheses are used to force a method call
+                    #     # https://docs.ruby-lang.org/en/2.7.0/syntax/assignment_rdoc.html#label-Local+Variables+and+Methods
+                    #     #
+                    #     parent = parent()
+                    #
+                    #     while parent
+                    #       parents << parent
+                    #
+                    #       parent = parent.parent
+                    #     end
+                    #
+                    #     parents
+                    #   end
+                    #
+                    def parents(include_self: false)
+                      parents_enum(include_self: include_self).to_a
+                    end
+
+                    ##
+                    # @param include_self [Boolean]
+                    # @return [Enumerator<ConvenientService::Service::Plugins::HasResult::Entities::Result>]
+                    #
+                    # @see https://ruby-doc.org/core-2.7.0/Enumerator.html
+                    #
+                    def parents_enum(include_self: false)
+                      ::Enumerator.new do |yielder|
+                        yielder.yield(self) if include_self
+
+                        ##
+                        # NOTE: Empty parentheses are used to force a method call
+                        # https://docs.ruby-lang.org/en/2.7.0/syntax/assignment_rdoc.html#label-Local+Variables+and+Methods
+                        #
+                        parent = parent()
+
+                        while parent
+                          yielder.yield(parent)
+
+                          parent = parent.parent
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/can_have_parent_result/initialize/middleware.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module CanHaveParentResult
+                module Initialize
+                  class Middleware < Core::MethodChainMiddleware
+                    def next(*args, **kwargs, &block)
+                      entity.internals.cache[:parent] = kwargs[:parent]
+
+                      chain.next(*args, **kwargs, &block)
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/can_have_parent_result/initialize.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "initialize/middleware"

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/can_have_parent_result/to_kwargs/middleware.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module CanHaveParentResult
+                module ToKwargs
+                  class Middleware < Core::MethodChainMiddleware
+                    def next(...)
+                      chain.next(...).merge(parent: entity.parent)
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/can_have_parent_result/to_kwargs.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "to_kwargs/middleware"

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/can_have_parent_result.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "can_have_parent_result/concern"
+require_relative "can_have_parent_result/initialize"
+require_relative "can_have_parent_result/to_kwargs"

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/concern/instance_methods.rb

@@ -113,7 +113,13 @@ module ConvenientService
                     # @return [Hash]
                     #
                     def to_kwargs
-                      {service: service, status: status, data: data, message: message, code: code}
+                      {
+                        service: service,
+                        status: status,
+                        data: unsafe_data,
+                        message: unsafe_message,
+                        code: unsafe_code
+                      }
                     end
                   end
                 end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities/data.rb

@@ -45,6 +45,10 @@ module ConvenientService
                     def to_h
                       @to_h ||= value.to_h
                     end
+
+                    def to_s
+                      @to_s ||= to_h.to_s
+                    end
                   end
                 end
               end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_step/concern.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasStep
+                module Concern
+                  include Support::Concern
+
+                  instance_methods do
+                    def step
+                      @step ||= internals.cache[:step]
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_step/initialize/middleware.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasStep
+                module Initialize
+                  class Middleware < Core::MethodChainMiddleware
+                    def next(*args, **kwargs, &block)
+                      entity.internals.cache[:step] = kwargs[:step]
+
+                      chain.next(*args, **kwargs, &block)
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_step/initialize.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "initialize/middleware"

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_step/to_kwargs/middleware.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasStep
+                module ToKwargs
+                  class Middleware < Core::MethodChainMiddleware
+                    def next(...)
+                      chain.next(...).merge(step: entity.step)
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end