convenient_service 0.10.1 → 0.12.0

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

@@ -0,0 +1,94 @@
+# 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 Concern
+                      module InstanceMethods
+                        ##
+                        # @!attribute [r] value
+                        #   @return [Hash]
+                        #
+                        attr_reader :value
+
+                        ##
+                        # @param value [Hash]
+                        # @return [void]
+                        #
+                        # @internal
+                        #   NOTE: Ruby hashes enumerate their values in the order that the corresponding keys were inserted.
+                        #   That is why the end-user can be 100% sure that the failure message is always generated from the first key/value pair.
+                        #   - https://ruby-doc.org/core-2.7.0/Hash.html
+                        #
+                        #   TODO: A test that crashes when such behaviour is broken.
+                        #
+                        #   NOTE: As a result, there is NO need to use any custom `OrderedHash` implementations.
+                        #   - https://api.rubyonrails.org/v5.1/classes/ActiveSupport/OrderedHash.html
+                        #   - https://github.com/rails/rails/issues/22681
+                        #   - https://api.rubyonrails.org/classes/ActiveSupport/OrderedOptions.html
+                        #
+                        def initialize(value:)
+                          @value = value
+                        end
+
+                        ##
+                        # @param key [String, Symbol]
+                        # @return [Boolean]
+                        #
+                        def has_attribute?(key)
+                          value.has_key?(key.to_sym)
+                        end
+
+                        ##
+                        # @param other [Object] Can be any type.
+                        # @return [Boolean, nil]
+                        #
+                        def ==(other)
+                          casted = cast(other)
+
+                          return unless casted
+
+                          value == casted.value
+                        end
+
+                        ##
+                        # @param key [String, Symbol]
+                        # @return [Object] Can be any type.
+                        # @raise [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Errors::NotExistingAttribute]
+                        #
+                        def [](key)
+                          value.fetch(key.to_sym) { raise Errors::NotExistingAttribute.new(attribute: key) }
+                        end
+
+                        ##
+                        # @return [Hash]
+                        #
+                        def to_h
+                          @to_h ||= value.to_h
+                        end
+
+                        ##
+                        # @return [String]
+                        #
+                        def to_s
+                          @to_s ||= to_h.to_s
+                        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_j_send_status_and_attributes/entities/data/concern.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "concern/class_methods"
+require_relative "concern/instance_methods"
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJSendStatusAndAttributes
+                module Entities
+                  class Data
+                    module Concern
+                      include Support::Concern
+
+                      included do |code_class|
+                        code_class.include Support::Castable
+
+                        code_class.include InstanceMethods
+
+                        code_class.extend ClassMethods
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "data/concern"
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJSendStatusAndAttributes
+                module Entities
+                  class Data
+                    include Concern
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_j_send_status_and_attributes/entities/message/concern/class_methods.rb

@@ -0,0 +1,40 @@
+# 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 Concern
+                      module ClassMethods
+                        ##
+                        # @param other [Object] Can be any type.
+                        # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Message, nil]
+                        #
+                        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
+end

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

@@ -0,0 +1,58 @@
+# 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 Concern
+                      module InstanceMethods
+                        ##
+                        # @!attribute [r] value
+                        #   @return [String]
+                        #
+                        attr_reader :value
+
+                        ##
+                        # @param value [String]
+                        # @return [void]
+                        #
+                        def initialize(value:)
+                          @value = value
+                        end
+
+                        ##
+                        # @param other [Object] Can be any type.
+                        # @return [Boolean, nil]
+                        #
+                        def ==(other)
+                          casted = cast(other)
+
+                          return unless casted
+
+                          value == casted.value
+                        end
+
+                        ##
+                        # @return [String]
+                        #
+                        def to_s
+                          @to_s ||= value.to_s
+                        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_j_send_status_and_attributes/entities/message/concern.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "concern/class_methods"
+require_relative "concern/instance_methods"
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJSendStatusAndAttributes
+                module Entities
+                  class Message
+                    module Concern
+                      include Support::Concern
+
+                      included do |code_class|
+                        code_class.include Support::Castable
+
+                        code_class.include InstanceMethods
+
+                        code_class.extend ClassMethods
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "message/concern"
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJSendStatusAndAttributes
+                module Entities
+                  class Message
+                    include Concern
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# 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 Concern
+                      module ClassMethods
+                        ##
+                        # @param other [Object] Can be any type.
+                        # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Status, nil]
+                        #
+                        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
+end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_j_send_status_and_attributes/entities/status/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 Entities
+                  class Status
+                    module Concern
+                      module InstanceMethods
+                        ##
+                        # @!attribute [r] value
+                        #   @return [String]
+                        #
+                        attr_reader :value
+
+                        ##
+                        # @param value [String]
+                        # @return [void]
+                        #
+                        def initialize(value:)
+                          @value = value
+                        end
+
+                        ##
+                        # @param other [Object] Can be any type.
+                        # @return [Boolean, nil]
+                        #
+                        def ==(other)
+                          casted = cast(other)
+
+                          return unless casted
+
+                          value == casted.value
+                        end
+
+                        ##
+                        # @return [Boolean]
+                        #
+                        def success?
+                          value == :success
+                        end
+
+                        ##
+                        # @return [Boolean]
+                        #
+                        def failure?
+                          value == :failure
+                        end
+
+                        ##
+                        # @return [Boolean]
+                        #
+                        def error?
+                          value == :error
+                        end
+
+                        ##
+                        # @return [Boolean]
+                        #
+                        def not_success?
+                          !success?
+                        end
+
+                        ##
+                        # @return [Boolean]
+                        #
+                        def not_failure?
+                          !failure?
+                        end
+
+                        ##
+                        # @return [Boolean]
+                        #
+                        def not_error?
+                          !error?
+                        end
+
+                        ##
+                        # @param statuses [Array<Symbol, String, ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Status>]
+                        # @return [Boolean]
+                        #
+                        def in?(statuses)
+                          statuses.any? { |status| self == status }
+                        end
+
+                        ##
+                        # @return [String]
+                        #
+                        def to_s
+                          @to_s ||= value.to_s
+                        end
+
+                        ##
+                        # @return [Symbol]
+                        #
+                        def to_sym
+                          @to_sym ||= value.to_sym
+                        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_j_send_status_and_attributes/entities/status/concern.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "concern/class_methods"
+require_relative "concern/instance_methods"
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJSendStatusAndAttributes
+                module Entities
+                  class Status
+                    module Concern
+                      include Support::Concern
+
+                      included do |code_class|
+                        code_class.include Support::Castable
+
+                        code_class.include InstanceMethods
+
+                        code_class.extend ClassMethods
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "status/concern"
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJSendStatusAndAttributes
+                module Entities
+                  class Status
+                    include Concern
+                  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 → has_j_send_status_and_attributes}/errors.rb

@@ -7,9 +7,13 @@ module ConvenientService
         module Entities
           class Result
             module Plugins
-              module HasJsendStatusAndAttributes
+              module HasJSendStatusAndAttributes
                 module Errors
-                  class NotExistingAttribute < ConvenientService::Error
+                  class NotExistingAttribute < ::ConvenientService::Error
+                    ##
+                    # @param attribute [Symbol]
+                    # @return [void]
+                    #
                     def initialize(attribute:)
                       message = <<~TEXT
                         Data attribute `#{attribute}` does NOT exist. Make sure the corresponding result returns it.

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/{has_jsend_status_and_attributes → has_j_send_status_and_attributes}/middleware.rb

@@ -7,12 +7,12 @@ module ConvenientService
         module Entities
           class Result
             module Plugins
-              module HasJsendStatusAndAttributes
+              module HasJSendStatusAndAttributes
                 class Middleware < Core::MethodChainMiddleware
                   ##
-                  # @param args [Array]
-                  # @param kwargs [Hash]
-                  # @param block [Proc]
+                  # @param args [Array<Object>]
+                  # @param kwargs [Hash{Symbol => Object}]
+                  # @param block [Proc, nil]
                   # @return [void]
                   #
                   def next(*args, **kwargs, &block)

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/{has_jsend_status_and_attributes/structs/jsend_attributes.rb → has_j_send_status_and_attributes/structs/j_send_attributes.rb}

@@ -7,7 +7,7 @@ module ConvenientService
         module Entities
           class Result
             module Plugins
-              module HasJsendStatusAndAttributes
+              module HasJSendStatusAndAttributes
                 module Structs
                   JSendAttributes = ::Struct.new(:service, :status, :data, :message, :code, keyword_init: true)
                 end

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

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

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

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

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

@@ -31,21 +31,21 @@ module ConvenientService
                     end
 
                     ##
-                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Data]
+                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Data]
                     #
                     def ud
                       unsafe_data
                     end
 
                     ##
-                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Message]
+                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Message]
                     #
                     def um
                       unsafe_message
                     end
 
                     ##
-                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Code]
+                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Code]
                     #
                     def uc
                       unsafe_code

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

@@ -9,7 +9,7 @@ module ConvenientService
             module Plugins
               module RaisesOnNotCheckedResultStatus
                 module Errors
-                  class StatusIsNotChecked < ConvenientService::Error
+                  class StatusIsNotChecked < ::ConvenientService::Error
                     def initialize(attribute:)
                       message = <<~TEXT
                         Attribute `#{attribute}` is accessed before result status is checked.

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

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
 require_relative "plugins/can_recalculate_result"
-require_relative "plugins/has_jsend_status_and_attributes"
+require_relative "plugins/has_j_send_status_and_attributes"
 require_relative "plugins/has_inspect"
 require_relative "plugins/has_step"
 require_relative "plugins/can_have_parent_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"
+
+require_relative "plugins/aliases"

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

@@ -5,7 +5,7 @@ module ConvenientService
     module Plugins
       module HasResult
         module Errors
-          class ResultIsNotOverridden < ConvenientService::Error
+          class ResultIsNotOverridden < ::ConvenientService::Error
             def initialize(service:)
               message = <<~TEXT
                 Result method (#result) of `#{service.class}` is NOT overridden.
@@ -15,7 +15,7 @@ module ConvenientService
             end
           end
 
-          class ServiceReturnValueNotKindOfResult < ConvenientService::Error
+          class ServiceReturnValueNotKindOfResult < ::ConvenientService::Error
             def initialize(service:, result:)
               message = <<~TEXT
                 Return value of service `#{service.class}` is NOT a `Result`.