convenient_service 0.1.0

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require_relative "status/class_methods"
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Entities
+              class Status
+                include Support::Castable
+
+                extend ClassMethods
+
+                attr_reader :value
+
+                def initialize(value:)
+                  @value = value
+                end
+
+                def ==(other)
+                  casted = cast(other)
+
+                  return unless casted
+
+                  value == casted.value
+                end
+
+                def success?
+                  value == :success
+                end
+
+                def failure?
+                  value == :failure
+                end
+
+                def error?
+                  value == :error
+                end
+
+                def not_success?
+                  !success?
+                end
+
+                def not_failure?
+                  !failure?
+                end
+
+                def not_error?
+                  !error?
+                end
+
+                def to_s
+                  @to_s ||= value.to_s
+                end
+
+                def to_sym
+                  @to_sym ||= value.to_sym
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative "entities/data"
+require_relative "entities/code"
+require_relative "entities/message"
+require_relative "entities/status"

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Errors
+              class NotExistingAttribute < ConvenientService::Error
+                def initialize(attribute:)
+                  message = <<~TEXT
+                    Data attribute `#{attribute}` does NOT exist. Make sure the corresponding result returns it.
+                  TEXT
+
+                  super(message)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/can_recalculate_result/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 CanRecalculateResult
+                module Concern
+                  include Support::Concern
+
+                  instance_methods do
+                    def recalculate
+                      service.recalculate_result
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasResultShortSyntax
+                module Concern
+                  module InstanceMethods
+                    ##
+                    # NOTE: `Support::Delegate` is NOT used intentionally in order to NOT pollute the public interface.
+                    #
+                    def [](key)
+                      data[key]
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasResultShortSyntax
+                module Concern
+                  include Support::Concern
+
+                  instance_methods do
+                    ##
+                    # NOTE: `Support::Delegate` is NOT used intentionally in order to NOT pollute the public interface.
+                    #
+                    def [](key)
+                      data[key]
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/marks_result_status_as_checked/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 MarksResultStatusAsChecked
+                class Middleware < Core::MethodChainMiddleware
+                  def next(...)
+                    entity.internals.cache[:has_checked_status] = true
+
+                    chain.next(...)
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/raises_on_not_checked_result_status/errors.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module RaisesOnNotCheckedResultStatus
+                module Errors
+                  class StatusIsNotChecked < ConvenientService::Error
+                    def initialize(attribute:)
+                      message = <<~TEXT
+                        Attribute `#{attribute}` is accessed before result status is checked.
+
+                        Did you forget to call `success?`, `failure?`, or `error?` on result?
+                      TEXT
+
+                      super(message)
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module RaisesOnNotCheckedResultStatus
+                class Middleware < Core::MethodChainMiddleware
+                  def next(...)
+                    assert_has_checked_status!
+
+                    chain.next(...)
+                  end
+
+                  private
+
+                  def assert_has_checked_status!
+                    return if entity.internals.cache.exist?(:has_checked_status)
+
+                    raise Errors::StatusIsNotChecked.new(attribute: method)
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "raises_on_not_checked_result_status/errors"
+require_relative "raises_on_not_checked_result_status/middleware"

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative "plugins/can_recalculate_result"
+require_relative "plugins/has_result_short_syntax"
+require_relative "plugins/marks_result_status_as_checked"
+require_relative "plugins/raises_on_not_checked_result_status"

data/lib/convenient_service/service/plugins/has_result/entities/result/structs/result_params.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Structs
+              ResultParams = ::Struct.new(:service, :status, :data, :message, :code, keyword_init: true)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "structs/result_params"

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "result/commands"
+require_relative "result/concern"
+require_relative "result/entities"
+require_relative "result/errors"
+require_relative "result/plugins"
+require_relative "result/structs"
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            include Concern
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "entities/result"

data/lib/convenient_service/service/plugins/has_result/errors.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Errors
+          class ResultIsNotOverridden < ConvenientService::Error
+            def initialize(service:)
+              message = <<~TEXT
+                Result method (#result) of `#{service.class}` is NOT overridden.
+              TEXT
+
+              super(message)
+            end
+          end
+
+          class ServiceReturnValueNotKindOfResult < ConvenientService::Error
+            def initialize(service:, result:)
+              message = <<~TEXT
+                Return value of service `#{service.class}` is NOT a `Result`.
+                It is a `#{result.class}`.
+
+                Did you forget to call `success`, `failure`, or `error` from the `result` method?
+              TEXT
+
+              super(message)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_result/middleware.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        class Middleware < Core::MethodChainMiddleware
+          def next(...)
+            original_result = chain.next(...)
+
+            return original_result if original_result.class.include?(Entities::Result::Concern)
+
+            raise Errors::ServiceReturnValueNotKindOfResult.new(service: entity, result: original_result)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "has_result/concern"
+require_relative "has_result/constants"
+require_relative "has_result/commands"
+require_relative "has_result/entities"
+require_relative "has_result/errors"
+require_relative "has_result/middleware"

data/lib/convenient_service/service/plugins/has_result_method_steps/errors.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResultMethodSteps
+        module Errors
+          class MethodForStepIsNotDefined < ConvenientService::Error
+            def initialize(service_class:, method_name:)
+              message = <<~TEXT
+                Service #{service_class} tries to use `#{method_name}` method in a step, but it NOT defined.
+
+                Did you forget to define it?
+              TEXT
+
+              super(message)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_result_method_steps/middleware.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResultMethodSteps
+        class Middleware < Core::MethodChainMiddleware
+          ##
+          # @internal
+          #   NOTE: It is okish to assign to next method arguments here,
+          #   since splat for `args` and double splat for `kwargs`
+          #   always create new arrays and hashes respectively.
+          #   https://github.com/ruby/spec/blob/c7ed8478a031d0df346d222495f4b4bbb298523b/language/keyword_arguments_spec.rb#L100
+          #
+          def next(*args, **kwargs, &block)
+            return chain.next(*args, **kwargs, &block) unless args.first.instance_of?(::Symbol)
+
+            kwargs[:in] = Utils::Array.wrap(kwargs[:in]) + [{method_name: raw(args.first)}, {organizer: :itself}]
+
+            args[0] = args.first == :result ? Services::RunOwnMethodInOrganizer : Services::RunMethodInOrganizer
+
+            chain.next(*args, **kwargs, &block)
+          end
+
+          private
+
+          ##
+          # TODO: `Plugins::HasResultSteps::Entities::Method.raw_value`.
+          #
+          def raw(object)
+            Plugins::HasResultSteps::Entities::Method::Entities::Values::Raw.wrap(object)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_result_method_steps/services/method_step_config.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResultMethodSteps
+        module Services
+          module MethodStepConfig
+            include Support::Concern
+
+            included do
+              include Core
+
+              concerns do
+                use Service::Plugins::HasResult::Concern
+              end
+
+              middlewares :result do
+                use Common::Plugins::NormalizesEnv::Middleware
+
+                use Service::Plugins::HasResult::Middleware
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_result_method_steps/services/run_method_in_organizer.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResultMethodSteps
+        module Services
+          class RunMethodInOrganizer
+            include MethodStepConfig
+
+            attr_reader :method_name, :organizer, :kwargs
+
+            def initialize(method_name:, organizer:, **kwargs)
+              @method_name = method_name
+              @organizer = organizer
+              @kwargs = kwargs
+            end
+
+            def result
+              ##
+              # NOTE: `kwargs` are intentionally NOT passed, since all the corresponding methods are available inside `organizer.__send__(method_name)` body.
+              #
+              organizer.__send__(method_name)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_result_method_steps/services/run_own_method_in_organizer.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResultMethodSteps
+        module Services
+          class RunOwnMethodInOrganizer
+            include MethodStepConfig
+
+            attr_reader :method_name, :organizer, :kwargs
+
+            def initialize(method_name:, organizer:, **kwargs)
+              @method_name = method_name
+              @organizer = organizer
+              @kwargs = kwargs
+            end
+
+            def result
+              raise Errors::MethodForStepIsNotDefined.new(service_class: organizer.class, method_name: method_name) unless own_method
+
+              ##
+              # NOTE: `kwargs` are intentionally NOT passed, since all the corresponding methods are available inside `own_method` body.
+              #
+              own_method.call
+            end
+
+            private
+
+            ##
+            # @return [Method, nil]
+            #
+            # @internal
+            #   TODO: A possible bottleneck. Should be removed if receives negative feedback.
+            #
+            #   NOTE: `own_method.bind(organizer).call` is logically the same as `own_method.bind_call(organizer)`.
+            #   - https://ruby-doc.org/core-2.7.1/UnboundMethod.html#method-i-bind_call
+            #   - https://blog.saeloun.com/2019/10/17/ruby-2-7-adds-unboundmethod-bind_call-method.html
+            #
+            def own_method
+              method = Utils::Module.get_own_instance_method(organizer.class, method_name, private: true)
+
+              return unless method
+
+              method.bind(organizer)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_result_method_steps/services.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "services/method_step_config"
+require_relative "services/run_own_method_in_organizer"
+require_relative "services/run_method_in_organizer"

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "has_result_method_steps/errors"
+require_relative "has_result_method_steps/middleware"
+require_relative "has_result_method_steps/services"

data/lib/convenient_service/service/plugins/has_result_params_validations/using_active_model_validations/concern.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResultParamsValidations
+        module UsingActiveModelValidations
+          module Concern
+            include Support::Concern
+
+            included do |service_class|
+              service_class.include ::ActiveModel::Validations
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_result_params_validations/using_active_model_validations/middleware.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResultParamsValidations
+        module UsingActiveModelValidations
+          class Middleware < Core::MethodChainMiddleware
+            def next(...)
+              return entity.failure(data: errors) if errors.any?
+
+              chain.next(...)
+            end
+
+            private
+
+            ##
+            # NOTE: errors method (from Active Model Validations) does NOT trigger validations
+            # that is why valid? is called here.
+            #
+            # Check the following link for more info:
+            # https://guides.rubyonrails.org/active_record_validations.html#validations-overview-errors
+            #
+            # Quote (this method - errors):
+            # > This method is only useful after validations have been run, because it only inspects the errors collection and does not trigger validations itself.
+            #
+            def errors
+              @errors ||= entity.tap(&:valid?).errors.messages.transform_values(&:first)
+            end
+          end
+        end
+      end
+    end
+  end
+end