convenient_service 0.18.0 → 0.19.0

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/can_be_from_exception/concern.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module CanBeFromException
+                module Concern
+                  include Support::Concern
+
+                  instance_methods do
+                    ##
+                    # @api public
+                    #
+                    # @return [Boolean]
+                    #
+                    def from_exception?
+                      Utils.to_bool(extra_kwargs[:from_exception])
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/can_be_from_exception.rb

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

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/can_have_step/concern.rb

@@ -12,6 +12,13 @@ module ConvenientService
                   include Support::Concern
 
                   instance_methods do
+                    ##
+                    # @return [Boolean]
+                    #
+                    def from_step?
+                      Utils.to_bool(step)
+                    end
+
                     ##
                     # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step, nil]
                     #

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_amazing_print_inspect/concern.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module HasAmazingPrintInspect
+                module Concern
+                  include Support::Concern
+
+                  instance_methods do
+                    ##
+                    # @return [String]
+                    #
+                    def inspect
+                      metadata = {
+                        ConvenientService: {
+                          entity: "Result",
+                          service: service.inspect_values[:name],
+                          status: status.to_sym
+                        }
+                      }
+
+                      metadata[:ConvenientService][:data_keys] = unsafe_data.keys if unsafe_data.keys.any?
+                      metadata[:ConvenientService][:message] = unsafe_message.to_s unless unsafe_message.empty?
+
+                      metadata.ai
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_amazing_print_inspect.rb

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

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_awesome_print_inspect/concern.rb

@@ -24,8 +24,8 @@ module ConvenientService
                         }
                       }
 
-                      metadata[:data_keys] = unsafe_data.keys if unsafe_data.keys.any?
-                      metadata[:message] = unsafe_message unless unsafe_message.empty?
+                      metadata[:ConvenientService][:data_keys] = unsafe_data.keys if unsafe_data.keys.any?
+                      metadata[:ConvenientService][:message] = unsafe_message.to_s unless unsafe_message.empty?
 
                       metadata.ai
                     end

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

@@ -165,146 +165,6 @@ module ConvenientService
                         **extra_kwargs
                       )
                     end
-
-                    ##
-                    # Returns a boolean representation of `result`.
-                    # `success` may be considered as `true`.
-                    # `failure` may be considered as `false`.
-                    # `error` may be considered as `raise exception`.
-                    #
-                    # @api public
-                    # @return [Boolean]
-                    # @raise [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Status::Exceptions::ErrorHasNoOtherTypeRepresentation]
-                    #
-                    # @note This method is useful for learning purposes, to show similarities with Ruby's booleans. Please, do NOT depend on it in production.
-                    #
-                    # @internal
-                    #   NOTE: When `value` is NOT `:success`, `:failure` or `:error`, then something fatal has happened.
-                    #
-                    def to_bool
-                      case status.value
-                      when :success
-                        true
-                      when :failure
-                        false
-                      when :error
-                        raise ::ConvenientService.raise Exceptions::ErrorHasNoOtherTypeRepresentation.new(type: :boolean)
-                      else
-                        raise ::ConvenientService.raise Support::NeverReachHere.new(extra_message: "Unknown result status `#{status.value}`.")
-                      end
-                    end
-
-                    ##
-                    # Returns a boolean representation of `result`.
-                    # `success` may be considered as `object`.
-                    # `failure` may be considered as `nil` (or null object).
-                    # `error` may be considered as `raise exception`.
-                    #
-                    # @api public
-                    # @return [ConvenientService::Support::Value]
-                    # @raise [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Status::Exceptions::ErrorHasNoOtherTypeRepresentation]
-                    #
-                    # @note This method is useful for learning purposes, to show similarities with Ruby's objects. Please, do NOT depend on it in production.
-                    #
-                    # @internal
-                    #   NOTE: When `value` is NOT `:success`, `:failure` or `:error`, then something fatal has happened.
-                    #
-                    def to_object
-                      case status.value
-                      when :success
-                        Support::Value.new("object")
-                      when :failure
-                        nil
-                      when :error
-                        raise ::ConvenientService.raise Exceptions::ErrorHasNoOtherTypeRepresentation.new(type: :object)
-                      else
-                        raise ::ConvenientService.raise Support::NeverReachHere.new(extra_message: "Unknown result status `#{status.value}`.")
-                      end
-                    end
-
-                    ##
-                    # Returns an array representation of `result`.
-                    # `success` may be considered as array with items.
-                    # `failure` may be considered as empty array.
-                    # `error` may be considered as `raise exception`.
-                    #
-                    # @api public
-                    # @return [Array<ConvenientService::Support::Value>]
-                    # @raise [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Status::Exceptions::ErrorHasNoOtherTypeRepresentation]
-                    #
-                    # @note This method is useful for learning purposes, to show similarities with Ruby's objects. Please, do NOT depend on it in production.
-                    #
-                    # @internal
-                    #   NOTE: When `value` is NOT `:success`, `:failure` or `:error`, then something fatal has happened.
-                    #
-                    def to_a
-                      case status.value
-                      when :success
-                        [Support::Value.new("item")]
-                      when :failure
-                        []
-                      when :error
-                        raise ::ConvenientService.raise Exceptions::ErrorHasNoOtherTypeRepresentation.new(type: :array)
-                      else
-                        raise ::ConvenientService.raise Support::NeverReachHere.new(extra_message: "Unknown result status `#{status.value}`.")
-                      end
-                    end
-
-                    ##
-                    # Returns a hash representation of `result`.
-                    # `success` may be considered as hash with items.
-                    # `failure` may be considered as empty hash.
-                    # `error` may be considered as `raise exception`.
-                    #
-                    # @api public
-                    # @return [Hash{ConvenientService::Support::Value => ConvenientService::Support::Value}]
-                    # @raise [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Status::Exceptions::ErrorHasNoOtherTypeRepresentation]
-                    #
-                    # @note This method is useful for learning purposes, to show similarities with Ruby's objects. Please, do NOT depend on it in production.
-                    #
-                    # @internal
-                    #   NOTE: When `value` is NOT `:success`, `:failure` or `:error`, then something fatal has happened.
-                    #
-                    def to_h
-                      case status.value
-                      when :success
-                        {Support::Value.new("key") => Support::Value.new("value")}
-                      when :failure
-                        {}
-                      when :error
-                        raise ::ConvenientService.raise Exceptions::ErrorHasNoOtherTypeRepresentation.new(type: :hash)
-                      else
-                        raise ::ConvenientService.raise Support::NeverReachHere.new(extra_message: "Unknown result status `#{status.value}`.")
-                      end
-                    end
-
-                    ##
-                    # Returns a string representation of `result`.
-                    # `success` may be considered as string with content.
-                    # `failure` may be considered as empty string.
-                    # `error` may be considered as `raise exception`.
-                    #
-                    # @api public
-                    # @return [String]
-                    # @raise [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Status::Exceptions::ErrorHasNoOtherTypeRepresentation]
-                    #
-                    # @note This method is useful for learning purposes, to show similarities with Ruby's objects. Please, do NOT depend on it in production.
-                    #
-                    # @internal
-                    #   NOTE: When `value` is NOT `:success`, `:failure` or `:error`, then something fatal has happened.
-                    #
-                    def to_s
-                      case status.value
-                      when :success
-                        "string"
-                      when :failure
-                        ""
-                      when :error
-                        raise ::ConvenientService.raise Exceptions::ErrorHasNoOtherTypeRepresentation.new(type: :string)
-                      else
-                        raise ::ConvenientService.raise Support::NeverReachHere.new(extra_message: "Unknown result status `#{status.value}`.")
-                      end
-                    end
                   end
                 end
               end

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/code/plugins/has_amazing_print_inspect/concern.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJSendStatusAndAttributes
+                module Entities
+                  class Code
+                    module Plugins
+                      module HasAmazingPrintInspect
+                        module Concern
+                          include Support::Concern
+
+                          instance_methods do
+                            ##
+                            # @return [String]
+                            #
+                            def inspect
+                              metadata = {
+                                ConvenientService: {
+                                  entity: "Code",
+                                  result: result.class.name,
+                                  value: to_sym
+                                }
+                              }
+
+                              metadata.ai
+                            end
+                          end
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/code/plugins/has_amazing_print_inspect.rb

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

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/data/plugins/has_amazing_print_inspect/concern.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJSendStatusAndAttributes
+                module Entities
+                  class Data
+                    module Plugins
+                      module HasAmazingPrintInspect
+                        module Concern
+                          include Support::Concern
+
+                          instance_methods do
+                            ##
+                            # @return [String]
+                            #
+                            def inspect
+                              metadata = {
+                                ConvenientService: {
+                                  entity: "Data",
+                                  result: result.class.name,
+                                  values: to_h
+                                }
+                              }
+
+                              metadata.ai
+                            end
+                          end
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/data/plugins/has_amazing_print_inspect.rb

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

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/message/plugins/has_amazing_print_inspect/concern.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJSendStatusAndAttributes
+                module Entities
+                  class Message
+                    module Plugins
+                      module HasAmazingPrintInspect
+                        module Concern
+                          include Support::Concern
+
+                          instance_methods do
+                            ##
+                            # @return [String]
+                            #
+                            def inspect
+                              metadata = {
+                                ConvenientService: {
+                                  entity: "Message",
+                                  result: result.class.name,
+                                  text: to_s
+                                }
+                              }
+
+                              metadata.ai
+                            end
+                          end
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/status/plugins/has_amazing_print_inspect/concern.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJSendStatusAndAttributes
+                module Entities
+                  class Status
+                    module Plugins
+                      module HasAmazingPrintInspect
+                        module Concern
+                          include Support::Concern
+
+                          instance_methods do
+                            ##
+                            # @return [String]
+                            #
+                            def inspect
+                              metadata = {
+                                ConvenientService: {
+                                  entity: "Status",
+                                  result: result.class.name,
+                                  type: to_sym
+                                }
+                              }
+
+                              metadata.ai
+                            end
+                          end
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/helps_to_learn_similarities_with_common_objects/concern/instance_methods.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module HelpsToLearnSimilaritiesWithCommonObjects
+                module Concern
+                  module InstanceMethods
+                    ##
+                    # Returns a boolean representation of `result`.
+                    # `success` may be considered as `true`.
+                    # `failure` may be considered as `false`.
+                    # `error` may be considered as `raise exception`.
+                    #
+                    # @api public
+                    # @return [Boolean]
+                    # @raise [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Status::Exceptions::ErrorHasNoOtherTypeRepresentation]
+                    #
+                    # @note This method is useful for learning purposes, to show similarities with Ruby's booleans. Please, do NOT depend on it in production.
+                    #
+                    # @internal
+                    #   NOTE: When `value` is NOT `:success`, `:failure` or `:error`, then something fatal has happened.
+                    #
+                    def to_bool
+                      case status.value
+                      when :success
+                        true
+                      when :failure
+                        false
+                      when :error
+                        raise ::ConvenientService.raise Exceptions::ErrorHasNoOtherTypeRepresentation.new(type: :boolean)
+                      else
+                        raise ::ConvenientService.raise Support::NeverReachHere.new(extra_message: "Unknown result status `#{status.value}`.")
+                      end
+                    end
+
+                    ##
+                    # Returns a boolean representation of `result`.
+                    # `success` may be considered as `object`.
+                    # `failure` may be considered as `nil` (or null object).
+                    # `error` may be considered as `raise exception`.
+                    #
+                    # @api public
+                    # @return [ConvenientService::Support::Value]
+                    # @raise [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Status::Exceptions::ErrorHasNoOtherTypeRepresentation]
+                    #
+                    # @note This method is useful for learning purposes, to show similarities with Ruby's objects. Please, do NOT depend on it in production.
+                    #
+                    # @internal
+                    #   NOTE: When `value` is NOT `:success`, `:failure` or `:error`, then something fatal has happened.
+                    #
+                    def to_object
+                      case status.value
+                      when :success
+                        Support::Value.new("object")
+                      when :failure
+                        nil
+                      when :error
+                        raise ::ConvenientService.raise Exceptions::ErrorHasNoOtherTypeRepresentation.new(type: :object)
+                      else
+                        raise ::ConvenientService.raise Support::NeverReachHere.new(extra_message: "Unknown result status `#{status.value}`.")
+                      end
+                    end
+
+                    ##
+                    # Returns an array representation of `result`.
+                    # `success` may be considered as array with items.
+                    # `failure` may be considered as empty array.
+                    # `error` may be considered as `raise exception`.
+                    #
+                    # @api public
+                    # @return [Array<ConvenientService::Support::Value>]
+                    # @raise [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Status::Exceptions::ErrorHasNoOtherTypeRepresentation]
+                    #
+                    # @note This method is useful for learning purposes, to show similarities with Ruby's objects. Please, do NOT depend on it in production.
+                    #
+                    # @internal
+                    #   NOTE: When `value` is NOT `:success`, `:failure` or `:error`, then something fatal has happened.
+                    #
+                    def to_a
+                      case status.value
+                      when :success
+                        [Support::Value.new("item")]
+                      when :failure
+                        []
+                      when :error
+                        raise ::ConvenientService.raise Exceptions::ErrorHasNoOtherTypeRepresentation.new(type: :array)
+                      else
+                        raise ::ConvenientService.raise Support::NeverReachHere.new(extra_message: "Unknown result status `#{status.value}`.")
+                      end
+                    end
+
+                    ##
+                    # Returns a hash representation of `result`.
+                    # `success` may be considered as hash with items.
+                    # `failure` may be considered as empty hash.
+                    # `error` may be considered as `raise exception`.
+                    #
+                    # @api public
+                    # @return [Hash{ConvenientService::Support::Value => ConvenientService::Support::Value}]
+                    # @raise [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Status::Exceptions::ErrorHasNoOtherTypeRepresentation]
+                    #
+                    # @note This method is useful for learning purposes, to show similarities with Ruby's objects. Please, do NOT depend on it in production.
+                    #
+                    # @internal
+                    #   NOTE: When `value` is NOT `:success`, `:failure` or `:error`, then something fatal has happened.
+                    #
+                    def to_h
+                      case status.value
+                      when :success
+                        {Support::Value.new("key") => Support::Value.new("value")}
+                      when :failure
+                        {}
+                      when :error
+                        raise ::ConvenientService.raise Exceptions::ErrorHasNoOtherTypeRepresentation.new(type: :hash)
+                      else
+                        raise ::ConvenientService.raise Support::NeverReachHere.new(extra_message: "Unknown result status `#{status.value}`.")
+                      end
+                    end
+
+                    ##
+                    # Returns a string representation of `result`.
+                    # `success` may be considered as string with content.
+                    # `failure` may be considered as empty string.
+                    # `error` may be considered as `raise exception`.
+                    #
+                    # @api public
+                    # @return [String]
+                    # @raise [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Status::Exceptions::ErrorHasNoOtherTypeRepresentation]
+                    #
+                    # @note This method is useful for learning purposes, to show similarities with Ruby's objects. Please, do NOT depend on it in production.
+                    #
+                    # @internal
+                    #   NOTE: When `value` is NOT `:success`, `:failure` or `:error`, then something fatal has happened.
+                    #
+                    def to_s
+                      case status.value
+                      when :success
+                        "string"
+                      when :failure
+                        ""
+                      when :error
+                        raise ::ConvenientService.raise Exceptions::ErrorHasNoOtherTypeRepresentation.new(type: :string)
+                      else
+                        raise ::ConvenientService.raise Support::NeverReachHere.new(extra_message: "Unknown result status `#{status.value}`.")
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/helps_to_learn_similarities_with_common_objects/concern.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "concern/instance_methods"
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module HelpsToLearnSimilaritiesWithCommonObjects
+                module Concern
+                  include Support::Concern
+
+                  included do |result_class|
+                    result_class.include InstanceMethods
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end