convenient_service 0.11.0 → 0.13.0

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "plugins/can_recalculate_result"
+require_relative "plugins/can_be_own_result"
+require_relative "plugins/can_be_stubbed_result"
+require_relative "plugins/can_have_fallback"
+require_relative "plugins/has_j_send_status_and_attributes"
+require_relative "plugins/has_inspect"
+require_relative "plugins/has_stubbed_result_invocations_counter"
+require_relative "plugins/can_have_step"
+require_relative "plugins/can_have_parent_result"
+require_relative "plugins/can_have_checked_status"
+require_relative "plugins/raises_on_not_checked_result_status"
+
+require_relative "plugins/aliases"

data/lib/convenient_service/service/plugins/{has_result → has_j_send_result}/entities/result.rb

@@ -6,7 +6,7 @@ require_relative "result/plugins"
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Entities
           class Result
             include Concern

data/lib/convenient_service/service/plugins/has_j_send_result/exceptions.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Exceptions
+          class ResultIsNotOverridden < ::ConvenientService::Exception
+            def initialize(service:)
+              message = <<~TEXT
+                Result method (#result) of `#{service.class}` is NOT overridden.
+              TEXT
+
+              super(message)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "has_j_send_result/concern"
+require_relative "has_j_send_result/constants"
+require_relative "has_j_send_result/container"
+require_relative "has_j_send_result/commands"
+require_relative "has_j_send_result/entities"
+require_relative "has_j_send_result/exceptions"

data/lib/convenient_service/service/plugins/{has_result_params_validations → has_j_send_result_params_validations}/using_active_model_validations/concern.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultParamsValidations
+      module HasJSendResultParamsValidations
         module UsingActiveModelValidations
           module Concern
             include Support::Concern

data/lib/convenient_service/service/plugins/{has_result_params_validations → has_j_send_result_params_validations}/using_active_model_validations/middleware.rb

@@ -3,9 +3,11 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultParamsValidations
+      module HasJSendResultParamsValidations
         module UsingActiveModelValidations
-          class Middleware < Core::MethodChainMiddleware
+          class Middleware < MethodChainMiddleware
+            intended_for :result, entity: :service
+
             def next(...)
               return entity.failure(data: errors) if errors.any?
 

data/lib/convenient_service/service/plugins/{has_result_params_validations → has_j_send_result_params_validations}/using_dry_validation/concern.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultParamsValidations
+      module HasJSendResultParamsValidations
         module UsingDryValidation
           module Concern
             include Support::Concern

data/lib/convenient_service/service/plugins/{has_result_params_validations → has_j_send_result_params_validations}/using_dry_validation/middleware.rb

@@ -3,9 +3,11 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultParamsValidations
+      module HasJSendResultParamsValidations
         module UsingDryValidation
-          class Middleware < Core::MethodChainMiddleware
+          class Middleware < MethodChainMiddleware
+            intended_for :result, entity: :service
+
             def next(...)
               return entity.failure(data: errors) if errors.any?
 
@@ -25,7 +27,7 @@ module ConvenientService
             end
 
             def constructor_kwargs
-              @constructor_kwargs ||= entity.constructor_params.kwargs
+              @constructor_kwargs ||= entity.constructor_arguments.kwargs
             end
 
             def contract

data/lib/convenient_service/service/plugins/{has_result_short_syntax → has_j_send_result_short_syntax}/concern.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultShortSyntax
+      module HasJSendResultShortSyntax
         module Concern
           include Support::Concern
 

data/lib/convenient_service/service/plugins/{has_result_short_syntax → has_j_send_result_short_syntax}/error/commands/assert_args_count_lower_than_three.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultShortSyntax
+      module HasJSendResultShortSyntax
         module Error
           module Commands
             class AssertArgsCountLowerThanThree < Support::Command
@@ -14,7 +14,7 @@ module ConvenientService
               end
 
               def call
-                raise Errors::MoreThanTwoArgsArePassed.new if args.size > 2
+                raise Exceptions::MoreThanTwoArgsArePassed.new if args.size > 2
               end
             end
           end

data/lib/convenient_service/service/plugins/{has_result_short_syntax → has_j_send_result_short_syntax}/error/commands/assert_either_args_or_kwargs_are_passed.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultShortSyntax
+      module HasJSendResultShortSyntax
         module Error
           module Commands
             class AssertEitherArgsOrKwargsArePassed < Support::Command
@@ -15,7 +15,7 @@ module ConvenientService
               end
 
               def call
-                raise Errors::BothArgsAndKwargsArePassed.new if args.any? && kwargs.any?
+                raise Exceptions::BothArgsAndKwargsArePassed.new if args.any? && kwargs.any?
               end
             end
           end

data/lib/convenient_service/service/plugins/{has_result_short_syntax/error/errors.rb → has_j_send_result_short_syntax/error/exceptions.rb}

@@ -3,10 +3,10 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultShortSyntax
+      module HasJSendResultShortSyntax
         module Error
-          module Errors
-            class BothArgsAndKwargsArePassed < ::ConvenientService::Error
+          module Exceptions
+            class BothArgsAndKwargsArePassed < ::ConvenientService::Exception
               def initialize
                 message = <<~TEXT
                   Both `args` and `kwargs` are passed to the `error` method.
@@ -24,7 +24,7 @@ module ConvenientService
               end
             end
 
-            class MoreThanTwoArgsArePassed < ::ConvenientService::Error
+            class MoreThanTwoArgsArePassed < ::ConvenientService::Exception
               def initialize
                 message = <<~TEXT
                   More than two `args` are passed to the `error` method.

data/lib/convenient_service/service/plugins/{has_result_short_syntax → has_j_send_result_short_syntax}/error/middleware.rb

@@ -3,10 +3,12 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultShortSyntax
+      module HasJSendResultShortSyntax
         module Error
-          class Middleware < Core::MethodChainMiddleware
-            def next(*args, **kwargs)
+          class Middleware < MethodChainMiddleware
+            intended_for :error, entity: :service
+
+            def next(*args, **kwargs, &block)
               Commands::AssertEitherArgsOrKwargsArePassed.call(args: args, kwargs: kwargs)
 
               return chain.next(**kwargs) if kwargs.any?

data/lib/convenient_service/service/plugins/{has_result_short_syntax → has_j_send_result_short_syntax}/error.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 require_relative "error/commands"
-require_relative "error/errors"
+require_relative "error/exceptions"
 require_relative "error/middleware"

data/lib/convenient_service/service/plugins/has_j_send_result_short_syntax/failure/commands/assert_kwargs_contain_only_j_send_keys.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResultShortSyntax
+        module Failure
+          module Commands
+            class AssertKwargsContainOnlyJSendKeys < Support::Command
+              ##
+              # @!attribute [r] kwargs
+              #   @return [Hash{Symbol => Object}]
+              #
+              attr_reader :kwargs
+
+              ##
+              # @param kwargs [Hash{Symbol => Object}]
+              # @return [void]
+              #
+              def initialize(kwargs:)
+                @kwargs = kwargs
+              end
+
+              ##
+              # @return [void]
+              # @raise [ConvenientService::Service::Plugins::HasJSendResultShortSyntax::Failure::Exceptions::KwargsContainNonJSendKey]
+              #
+              def call
+                raise Exceptions::KwargsContainNonJSendKey.new(key: non_jsend_keys.first) if non_jsend_keys.any?
+              end
+
+              private
+
+              ##
+              # @return [Array<Symbol>]
+              #
+              def non_jsend_keys
+                kwargs.keys - valid_jsend_keys
+              end
+
+              ##
+              # @return [Array<Symbol>]
+              #
+              def valid_jsend_keys
+                [:data, :message]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_j_send_result_short_syntax/failure/commands.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "commands/assert_kwargs_contain_only_j_send_keys"

data/lib/convenient_service/service/plugins/has_j_send_result_short_syntax/failure/exceptions.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResultShortSyntax
+        module Failure
+          module Exceptions
+            class KwargsContainNonJSendKey < ::ConvenientService::Exception
+              def initialize(key:)
+                message = <<~TEXT
+                  When `kwargs` with `data` key are passed to `failure` method, they can NOT contain non JSend keys like `#{key.inspect}`.
+
+                  Please, consider something like:
+
+                  failure(foo: :bar) # short version does NOT support custom message
+                  failure(data: {foo: :bar}) # long version
+                  failure(data: {foo: :bar}, message: "foo") # long version with custom message
+                TEXT
+
+                super(message)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_j_send_result_short_syntax/failure/middleware.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResultShortSyntax
+        module Failure
+          class Middleware < MethodChainMiddleware
+            intended_for :failure, entity: :service
+
+            def next(*args, **kwargs, &block)
+              return chain.next(*args, data: kwargs, &block) unless kwargs.has_key?(:data)
+
+              Commands::AssertKwargsContainOnlyJSendKeys.call(kwargs: kwargs)
+
+              chain.next(*args, **kwargs, &block)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/{has_result_short_syntax → has_j_send_result_short_syntax}/failure.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 require_relative "failure/commands"
-require_relative "failure/errors"
+require_relative "failure/exceptions"
 require_relative "failure/middleware"

data/lib/convenient_service/service/plugins/{has_result_short_syntax → has_j_send_result_short_syntax}/success/commands/refute_kwargs_contain_data_and_extra_keys.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultShortSyntax
+      module HasJSendResultShortSyntax
         module Success
           module Commands
             class RefuteKwargsContainDataAndExtraKeys < Support::Command
@@ -18,7 +18,7 @@ module ConvenientService
 
                 return if kwargs.keys.one?
 
-                raise Errors::KwargsContainDataAndExtraKeys.new
+                raise Exceptions::KwargsContainDataAndExtraKeys.new
               end
             end
           end

data/lib/convenient_service/service/plugins/{has_result_short_syntax/success/errors.rb → has_j_send_result_short_syntax/success/exceptions.rb}

@@ -3,10 +3,10 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultShortSyntax
+      module HasJSendResultShortSyntax
         module Success
-          module Errors
-            class KwargsContainDataAndExtraKeys < ::ConvenientService::Error
+          module Exceptions
+            class KwargsContainDataAndExtraKeys < ::ConvenientService::Exception
               def initialize
                 message = <<~TEXT
                   `kwargs` passed to `success` method contain `data` and extra keys. That's NOT allowed.

data/lib/convenient_service/service/plugins/{has_result_short_syntax → has_j_send_result_short_syntax}/success/middleware.rb

@@ -3,10 +3,12 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultShortSyntax
+      module HasJSendResultShortSyntax
         module Success
-          class Middleware < Core::MethodChainMiddleware
-            def next(**kwargs)
+          class Middleware < MethodChainMiddleware
+            intended_for :success, entity: :service
+
+            def next(*args, **kwargs, &block)
               Commands::RefuteKwargsContainDataAndExtraKeys.call(kwargs: kwargs)
 
               kwargs.has_key?(:data) ? chain.next(**kwargs) : chain.next(data: kwargs)

data/lib/convenient_service/service/plugins/{has_result_short_syntax → has_j_send_result_short_syntax}/success.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 require_relative "success/commands"
-require_relative "success/errors"
+require_relative "success/exceptions"
 require_relative "success/middleware"

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative "has_j_send_result_short_syntax/concern"
+require_relative "has_j_send_result_short_syntax/success"
+require_relative "has_j_send_result_short_syntax/failure"
+require_relative "has_j_send_result_short_syntax/error"

data/lib/convenient_service/service/plugins/{has_result_status_check_short_syntax → has_j_send_result_status_check_short_syntax}/concern.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultStatusCheckShortSyntax
+      module HasJSendResultStatusCheckShortSyntax
         module Concern
           include Support::Concern
 
@@ -55,6 +55,22 @@ module ConvenientService
             def not_failure?(...)
               result(...).not_failure?
             end
+
+            ##
+            # @return [Boolean]
+            # @since 0.12.0
+            #
+            def ok?(...)
+              result(...).success?
+            end
+
+            ##
+            # @return [Boolean]
+            # @since 0.12.0
+            #
+            def not_ok?(...)
+              result(...).not_success?
+            end
           end
         end
       end

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

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "has_j_send_result_status_check_short_syntax/concern"

data/lib/convenient_service/service/plugins/has_mermaid_flowchart/concern.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasMermaidFlowchart
+        module Concern
+          include Support::Concern
+
+          class_methods do
+            ##
+            # @api public
+            #
+            # @return [ConvenientService::Service::Plugins::HasMermaidFlowchart::Entities::Flowchart]
+            #
+            def mermaid_flowchart
+              Entities::Flowchart.new(service: self)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_mermaid_flowchart/entities/flowchart/entities/code/commands/generate_lines.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasMermaidFlowchart
+        module Entities
+          class Flowchart
+            module Entities
+              class Code
+                module Commands
+                  class GenerateLines < Support::Command
+                    include Support::Delegate
+
+                    ##
+                    # @api private
+                    #
+                    # @!attribute code [r]
+                    #   @return [ConvenientService::Service::Plugins::HasMermaidFlowchart::Entities::Flowchart::Entities::Code]
+                    #
+                    attr_reader :code
+
+                    ##
+                    # @api private
+                    #
+                    # @return [ConvenientService::Service::Plugins::HasMermaidFlowchart::Entities::Flowchart]
+                    #
+                    delegate :flowchart, to: :code
+
+                    ##
+                    # @api private
+                    #
+                    # @return [ConvenientService::Service]
+                    #
+                    delegate :service, to: :flowchart
+
+                    ##
+                    # @api private
+                    #
+                    # @return [ConvenientService::Service::Plugins::HasMermaidFlowchart::Entities::Flowchart::Entities::Settings]
+                    #
+                    delegate :settings, to: :flowchart
+
+                    ##
+                    # @api private
+                    #
+                    # @param code [ConvenientService::Service::Plugins::HasMermaidFlowchart::Entities::Flowchart::Entities::Code]
+                    # @return [void]
+                    #
+                    def initialize(code:)
+                      @code = code
+                    end
+
+                    ##
+                    # @api private
+                    #
+                    # @return [Array<String>]
+                    #
+                    def call
+                      [first_line, *service_lines]
+                    end
+
+                    private
+
+                    ##
+                    # @return [String]
+                    #
+                    # @internal
+                    #   NOTE: Flowchart docs.
+                    #   - https://mermaid.js.org/syntax/flowchart.html
+                    #
+                    def first_line
+                      <<~MERMAID.chomp
+                        flowchart #{settings.direction}
+                      MERMAID
+                    end
+
+                    ##
+                    # @return [Array<String>]
+                    #
+                    def service_lines
+                      GenerateServiceLines[service: service, ids: [], settings: settings]
+                        .map { |line| "  #{line}" }
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end