convenient_service 0.1.0 → 0.2.0

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

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJsendStatusAndAttributes
+                module Concern
+                  ##
+                  # TODO: How to use concern outside?
+                  #
+                  module InstanceMethods
+                    include Support::Delegate
+                    include Support::Copyable
+
+                    ##
+                    # @return [Boolean]
+                    #
+                    delegate :success?, to: :status
+
+                    ##
+                    # @return [Boolean]
+                    #
+                    delegate :failure?, to: :status
+
+                    ##
+                    # @return [Boolean]
+                    #
+                    delegate :error?, to: :status
+
+                    ##
+                    # @return [Boolean]
+                    #
+                    delegate :not_success?, to: :status
+
+                    ##
+                    # @return [Boolean]
+                    #
+                    delegate :not_failure?, to: :status
+
+                    ##
+                    # @return [Boolean]
+                    #
+                    delegate :not_error?, to: :status
+
+                    ##
+                    # @return [Class]
+                    #
+                    def service
+                      internals.cache[:jsend_attributes].service
+                    end
+
+                    ##
+                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Status]
+                    #
+                    def status
+                      internals.cache[:jsend_attributes].status
+                    end
+
+                    ##
+                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Data]
+                    #
+                    def data
+                      internals.cache[:jsend_attributes].data
+                    end
+
+                    ##
+                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Message]
+                    #
+                    def message
+                      internals.cache[:jsend_attributes].message
+                    end
+
+                    ##
+                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Code]
+                    #
+                    def code
+                      internals.cache[:jsend_attributes].code
+                    end
+
+                    ##
+                    # @param other [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+                    # @return [Boolean, nil]
+                    #
+                    def ==(other)
+                      return unless other.instance_of?(self.class)
+
+                      return false if service.class != other.service.class
+                      return false if status != other.status
+                      return false if data != other.data
+                      return false if message != other.message
+                      return false if code != other.code
+
+                      true
+                    end
+
+                    ##
+                    # @return [Hash]
+                    #
+                    def to_kwargs
+                      {service: service, status: status, data: data, message: message, code: code}
+                    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/concern.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "concern/instance_methods"
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJsendStatusAndAttributes
+                module Concern
+                  include Support::Concern
+
+                  included do |result_class|
+                    result_class.include InstanceMethods
+                  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/code/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 Code
+                    module ClassMethods
+                      def cast(other)
+                        case other
+                        when ::String
+                          new(value: other.to_sym)
+                        when ::Symbol
+                          new(value: other)
+                        when Code
+                          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/code.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative "code/class_methods"
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJsendStatusAndAttributes
+                module Entities
+                  class Code
+                    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
+
+                    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/entities/data/class_methods.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJsendStatusAndAttributes
+                module Entities
+                  class Data
+                    module ClassMethods
+                      def cast(other)
+                        case other
+                        when ::Hash
+                          new(value: other.transform_keys(&:to_sym))
+                        when Data
+                          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/data.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative "data/class_methods"
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJsendStatusAndAttributes
+                module Entities
+                  class Data
+                    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 [](key)
+                      value.fetch(key.to_sym) { raise Errors::NotExistingAttribute.new(attribute: key) }
+                    end
+
+                    def to_h
+                      @to_h ||= value.to_h
+                    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/message/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 Message
+                    module ClassMethods
+                      def cast(other)
+                        case other
+                        when ::String
+                          new(value: other)
+                        when ::Symbol
+                          new(value: other.to_s)
+                        when Message
+                          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/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