convenient_service 0.1.0 → 0.2.1

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "message/class_methods"
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJsendStatusAndAttributes
+                module Entities
+                  class Message
+                    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 to_s
+                      @to_s ||= value.to_s
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJsendStatusAndAttributes
+                module Entities
+                  class Status
+                    module ClassMethods
+                      def cast(other)
+                        case other
+                        when ::String
+                          new(value: other.to_sym)
+                        when ::Symbol
+                          new(value: other)
+                        when Status
+                          new(value: other.value)
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative "status/class_methods"
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJsendStatusAndAttributes
+                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
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJsendStatusAndAttributes
+                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
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJsendStatusAndAttributes
+                class Middleware < Core::MethodChainMiddleware
+                  ##
+                  # @param args [Array]
+                  # @param kwargs [Hash]
+                  # @param block [Proc]
+                  # @return [void]
+                  #
+                  def next(*args, **kwargs, &block)
+                    entity.internals.cache[:jsend_attributes] = Commands::CastJSendAttributes.call(attributes: kwargs)
+
+                    chain.next(*args, **kwargs, &block)
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

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

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

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

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

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require_relative "plugins/can_recalculate_result"
+require_relative "plugins/has_jsend_status_and_attributes"
+require_relative "plugins/has_inspect"
 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.rb

@@ -1,11 +1,7 @@
 # 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

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

@@ -17,7 +17,7 @@ module ConvenientService
 
             kwargs[:in] = Utils::Array.wrap(kwargs[:in]) + [{method_name: raw(args.first)}, {organizer: :itself}]
 
-            args[0] = args.first == :result ? Services::RunOwnMethodInOrganizer : Services::RunMethodInOrganizer
+            args[0] = (args.first == :result) ? Services::RunOwnMethodInOrganizer : Services::RunMethodInOrganizer
 
             chain.next(*args, **kwargs, &block)
           end

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

@@ -8,19 +8,45 @@ module ConvenientService
           module MethodStepConfig
             include Support::Concern
 
+            # rubocop:disable Lint/ConstantDefinitionInBlock
             included do
-              include Core
+              include ConvenientService::Core
 
               concerns do
-                use Service::Plugins::HasResult::Concern
+                use ConvenientService::Service::Plugins::HasResult::Concern
               end
 
               middlewares :result do
-                use Common::Plugins::NormalizesEnv::Middleware
+                use ConvenientService::Common::Plugins::NormalizesEnv::Middleware
 
-                use Service::Plugins::HasResult::Middleware
+                use ConvenientService::Service::Plugins::HasResult::Middleware
+              end
+
+              class self::Result
+                include ConvenientService::Core
+
+                concerns do
+                  use ConvenientService::Common::Plugins::HasInternals::Concern
+                  use ConvenientService::Common::Plugins::HasConstructor::Concern
+                  use ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Concern
+                end
+
+                middlewares :initialize do
+                  use ConvenientService::Common::Plugins::NormalizesEnv::Middleware
+
+                  use ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Middleware
+                end
+
+                class self::Internals
+                  include ConvenientService::Core
+
+                  concerns do
+                    use ConvenientService::Common::Plugins::HasInternals::Entities::Internals::Plugins::HasCache::Concern
+                  end
+                end
               end
             end
+            # rubocop:enable Lint/ConstantDefinitionInBlock
           end
         end
       end

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

@@ -21,15 +21,25 @@ module ConvenientService
             # TODO: Return one or all errors?
             #
             def errors
-              @errors ||=
-                entity
-                  .class
-                  .contract
-                  .new
-                  .call(**entity.constructor_params.kwargs)
-                  .errors
-                  .to_h
-                  .transform_values(&:first)
+              @errors ||= resolve_errors
+            end
+
+            def constructor_kwargs
+              @constructor_kwargs ||= entity.constructor_params.kwargs
+            end
+
+            def contract
+              @contract ||= entity.class.contract
+            end
+
+            def resolve_errors
+              return {} unless contract.schema
+
+              contract.new
+                .call(constructor_kwargs)
+                .errors
+                .to_h
+                .transform_values(&:first)
             end
           end
         end

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResultStatusCheckShortSyntax
+        module Concern
+          include Support::Concern
+
+          class_methods do
+            ##
+            # @return [Boolean]
+            # @since 0.2.0
+            #
+            def success?(...)
+              result(...).success?
+            end
+
+            ##
+            # @return [Boolean]
+            # @since 0.2.0
+            #
+            def error?(...)
+              result(...).error?
+            end
+
+            ##
+            # @return [Boolean]
+            # @since 0.2.0
+            #
+            def failure?(...)
+              result(...).failure?
+            end
+
+            ##
+            # @return [Boolean]
+            # @since 0.2.0
+            #
+            def not_success?(...)
+              result(...).not_success?
+            end
+
+            ##
+            # @return [Boolean]
+            # @since 0.2.0
+            #
+            def not_error?(...)
+              result(...).not_error?
+            end
+
+            ##
+            # @return [Boolean]
+            # @since 0.2.0
+            #
+            def not_failure?(...)
+              result(...).not_failure?
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -9,11 +9,12 @@ module ConvenientService
 
           instance_methods do
             def steps
-              @steps ||=
+              internals.cache.fetch(:steps) do
                 self.class
                   .steps
                   .tap(&:commit!)
                   .map { |step| step.copy(overrides: {kwargs: {organizer: self}}) }
+              end
             end
 
             ##

data/lib/convenient_service/service/plugins/has_result_steps/entities/step/plugins/has_inspect/concern.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResultSteps
+        module Entities
+          class Step
+            module Plugins
+              module HasInspect
+                module Concern
+                  include Support::Concern
+
+                  instance_methods do
+                    ##
+                    # @return [String]
+                    # @since 0.2.0
+                    #
+                    def inspect
+                      "<#{container.klass.name}::Step service: #{service.klass.name}>"
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_result_steps/entities/step/plugins/has_inspect.rb

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

data/lib/convenient_service/service/plugins/has_result_steps/entities/step/plugins.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "plugins/has_inspect"

data/lib/convenient_service/service/plugins/has_result_steps/entities/step.rb

@@ -3,6 +3,7 @@
 require_relative "step/commands"
 require_relative "step/concern"
 require_relative "step/errors"
+require_relative "step/plugins"
 require_relative "step/structs"
 
 module ConvenientService

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

@@ -8,7 +8,7 @@ module ConvenientService
           def next(...)
             return chain.next(...) if entity.steps.none?
 
-            last_step.result
+            last_step.result.copy
           end
 
           private

data/lib/convenient_service/service/plugins.rb

@@ -4,11 +4,13 @@
 # NOTE: Order matters.
 #
 require_relative "plugins/can_recalculate_result"
+require_relative "plugins/has_inspect"
 require_relative "plugins/has_result"
 require_relative "plugins/has_result_method_steps"
 require_relative "plugins/has_result_short_syntax"
 require_relative "plugins/has_result_steps"
 require_relative "plugins/raises_on_double_result"
 require_relative "plugins/wraps_result_in_db_transaction"
+require_relative "plugins/has_result_status_check_short_syntax"
 
 require_relative "plugins/aliases"

data/lib/convenient_service/support/cache/key.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Support
+    class Cache
+      class Key
+        ##
+        # @param args [Array]
+        # @param kwargs [Hash]
+        # @param block [Proc]
+        # @return [void]
+        #
+        def initialize(*args, **kwargs, &block)
+          @args = args
+          @kwargs = kwargs
+          @block = block
+        end
+
+        ##
+        # @param other [Object] Can be any type.
+        # @return [Boolean]
+        #
+        def ==(other)
+          return unless other.instance_of?(self.class)
+
+          return false if args != other.args
+          return false if kwargs != other.kwargs
+          return false if block&.source_location != other.block&.source_location
+
+          true
+        end
+
+        ##
+        # @param other [Object] Can be any type.
+        # @return [Boolean]
+        #
+        # @internal
+        #   IMPORTANT: `Key` instances are used as Ruby hash keys.
+        #
+        #   This method is overridden in order to avoid the following case:
+        #
+        #   hash = {}
+        #
+        #   ##
+        #   # Two equal keys in terms of `==`.
+        #   #
+        #   first_key = ConvenientService::Common::Plugins::CachesReturnValue::Entities::Key.new(method: :result, args: [], kwargs: {}, block: nil)
+        #   second_key = ConvenientService::Common::Plugins::CachesReturnValue::Entities::Key.new(method: :result, args: [], kwargs: {}, block: nil)
+        #
+        #   first_key == second_key
+        #   # => true
+        #
+        #   hash[first_key] = "value"
+        #
+        #   hash[second_key]
+        #   # => nil # This happens since keys are not equal in terms of `eql?`.
+        #
+        #   NOTE: Ruby hash and Object#hash are not the same things.
+        #   - https://ruby-doc.org/core-3.1.2/Object.html#method-i-hash
+        #   - https://belighted.com/blog/overriding-equals-equals/
+        #
+        def eql?(other)
+          return unless other.instance_of?(self.class)
+
+          hash == other.hash
+        end
+
+        ##
+        # @internal
+        #   NOTE: hash is overridden to treat blocks that were defined at the same location as equal.
+        #   - https://ruby-doc.org/core-3.1.2/Proc.html#method-i-source_location
+        #   - https://ruby-doc.org/core-3.1.2/Object.html#method-i-hash
+        #
+        def hash
+          [args, kwargs, block&.source_location].hash
+        end
+
+        protected
+
+        ##
+        # @!attribute [r] args
+        #   @return [Array]
+        #
+        attr_reader :args
+
+        ##
+        # @!attribute [r] kwargs
+        #   @return [Hash]
+        #
+        attr_reader :kwargs
+
+        ##
+        # @!attribute [r] block
+        #   @return [Proc]
+        #
+        attr_reader :block
+      end
+    end
+  end
+end