convenient_service 0.11.0 → 0.12.0

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

@@ -7,7 +7,7 @@ module ConvenientService
         module Entities
           class Result
             module Plugins
-              module HasJsendStatusAndAttributes
+              module HasJSendStatusAndAttributes
                 module Concern
                   ##
                   # TODO: How to use concern outside?
@@ -52,42 +52,42 @@ module ConvenientService
                     delegate :service, to: :jsend_attributes
 
                     ##
-                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Status]
+                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Status]
                     #
                     delegate :status, to: :jsend_attributes
 
                     ##
-                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Data]
+                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Data]
                     #
                     delegate :data, to: :jsend_attributes
 
                     ##
-                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Data]
+                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Data]
                     #
                     alias_method :unsafe_data, :data
 
                     ##
-                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Message]
+                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Message]
                     #
                     delegate :message, to: :jsend_attributes
 
                     ##
-                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Message]
+                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Message]
                     #
                     alias_method :unsafe_message, :message
 
                     ##
-                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Code]
+                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Code]
                     #
                     delegate :code, to: :jsend_attributes
 
                     ##
-                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Code]
+                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Code]
                     #
                     alias_method :unsafe_code, :code
 
                     ##
-                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Structs::JSendAttributes]
+                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Structs::JSendAttributes]
                     #
                     def jsend_attributes
                       internals.cache[:jsend_attributes]

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

@@ -10,7 +10,7 @@ module ConvenientService
         module Entities
           class Result
             module Plugins
-              module HasJsendStatusAndAttributes
+              module HasJSendStatusAndAttributes
                 module Concern
                   include Support::Concern
 

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

@@ -7,14 +7,14 @@ module ConvenientService
         module Entities
           class Result
             module Plugins
-              module HasJsendStatusAndAttributes
+              module HasJSendStatusAndAttributes
                 module Entities
                   class Code
                     module Concern
                       module ClassMethods
                         ##
                         # @param other [Object] Can be any type.
-                        # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Code, nil]
+                        # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Code, nil]
                         #
                         def cast(other)
                           case other

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

@@ -7,13 +7,13 @@ module ConvenientService
         module Entities
           class Result
             module Plugins
-              module HasJsendStatusAndAttributes
+              module HasJSendStatusAndAttributes
                 module Entities
                   class Code
                     module Concern
                       module InstanceMethods
                         ##
-                        # @!attribute value [r]
+                        # @!attribute [r] value
                         #   @return [Symbol]
                         #
                         attr_reader :value
@@ -28,7 +28,7 @@ module ConvenientService
 
                         ##
                         # @param other [Object] Can be any type.
-                        # @return [Boolean]
+                        # @return [Boolean, nil]
                         #
                         def ==(other)
                           casted = cast(other)

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

@@ -10,7 +10,7 @@ module ConvenientService
         module Entities
           class Result
             module Plugins
-              module HasJsendStatusAndAttributes
+              module HasJSendStatusAndAttributes
                 module Entities
                   class Code
                     module Concern

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

@@ -9,7 +9,7 @@ module ConvenientService
         module Entities
           class Result
             module Plugins
-              module HasJsendStatusAndAttributes
+              module HasJSendStatusAndAttributes
                 module Entities
                   class Code
                     include Concern

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

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

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