convenient_service 0.17.0 → 0.19.0

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,13 +165,6 @@ module ConvenientService
                         **extra_kwargs
                       )
                     end
-
-                    ##
-                    # @return [Boolean, nil]
-                    #
-                    def to_bool
-                      status.to_bool
-                    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/concern/instance_methods.rb

@@ -70,25 +70,67 @@ module ConvenientService
                           value == :error
                         end
 
+                        ##
+                        # @return [Boolean]
+                        #
+                        def unsafe_success?
+                          value == :success
+                        end
+
+                        ##
+                        # @return [Boolean]
+                        #
+                        def unsafe_failure?
+                          value == :failure
+                        end
+
+                        ##
+                        # @return [Boolean]
+                        #
+                        def unsafe_error?
+                          value == :error
+                        end
+
                         ##
                         # @return [Boolean]
                         #
                         def not_success?
-                          !success?
+                          value != :success
                         end
 
                         ##
                         # @return [Boolean]
                         #
                         def not_failure?
-                          !failure?
+                          value != :failure
                         end
 
                         ##
                         # @return [Boolean]
                         #
                         def not_error?
-                          !error?
+                          value != :error
+                        end
+
+                        ##
+                        # @return [Boolean]
+                        #
+                        def unsafe_not_success?
+                          value != :success
+                        end
+
+                        ##
+                        # @return [Boolean]
+                        #
+                        def unsafe_not_failure?
+                          value != :failure
+                        end
+
+                        ##
+                        # @return [Boolean]
+                        #
+                        def unsafe_not_error?
+                          value != :error
                         end
 
                         ##
@@ -126,20 +168,6 @@ module ConvenientService
                         def to_sym
                           @to_sym ||= value.to_sym
                         end
-
-                        ##
-                        # @return [Boolean, nil]
-                        #
-                        def to_bool
-                          return @to_bool if defined? @to_bool
-
-                          @to_bool =
-                            case value
-                            when :success then true
-                            when :failure then false
-                            when :error then nil
-                            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/can_be_checked/concern.rb

@@ -0,0 +1,38 @@
+# 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 CanBeChecked
+                        module Concern
+                          include Support::Concern
+
+                          instance_methods do
+                            ##
+                            # @return [Boolean]
+                            #
+                            def checked?
+                              Utils.to_bool(internals.cache[:checked])
+                            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/can_be_checked/middleware.rb

@@ -0,0 +1,51 @@
+# 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 CanBeChecked
+                        class Middleware < MethodChainMiddleware
+                          intended_for [
+                            :success?,
+                            :failure?,
+                            :error?,
+                            :not_success?,
+                            :not_failure?,
+                            :not_error?
+                          ],
+                            entity: :result
+
+                          ##
+                          # @param args [Array<Object>]
+                          # @param kwargs [Hash{Symbol => Object}]
+                          # @param block [Proc, nil]
+                          # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+                          #
+                          def next(*args, **kwargs, &block)
+                            mark_as_checked = kwargs.fetch(:mark_as_checked) { true }
+
+                            entity.internals.cache[:checked] = true if mark_as_checked
+
+                            chain.next(*args, **Utils::Hash.except(kwargs, [:mark_as_checked]), &block)
+                          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/can_be_checked.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "can_be_checked/concern"
+require_relative "can_be_checked/middleware"

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/has_j_send_status_and_attributes/entities/status/plugins.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "plugins/can_be_checked"
 require_relative "plugins/has_inspect"
 
 require_relative "plugins/aliases"

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

@@ -22,6 +22,21 @@ module ConvenientService
                       initialize(message)
                     end
                   end
+
+                  class ErrorHasNoOtherTypeRepresentation < ::ConvenientService::Exception
+                    ##
+                    # @return [void]
+                    #
+                    def initialize_with_kwargs(type:)
+                      message = <<~TEXT
+                        Error results have no `#{type}` representation.
+
+                        They are semantically similar to exceptions.
+                      TEXT
+
+                      initialize(message)
+                    end
+                  end
                 end
               end
             end

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module HasNegatedResult
+                module Concern
+                  include Support::Concern
+
+                  instance_methods do
+                    ##
+                    # @return [Boolean]
+                    #
+                    def negated?
+                      Utils.to_bool(extra_kwargs[:negated])
+                    end
+
+                    ##
+                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+                    #
+                    # @internal
+                    #   NOTE: `original_result = result` is used to cache `result` independently, without relying on `CachesReturnValue` plugin.
+                    #
+                    #   TODO: `Utils::String.concat_if`? How?
+                    #   - https://stackoverflow.com/a/28648594/12201472
+                    #
+                    #   IMPORTNANT: `copy` is used instead of `service.success`, or `service.failure` in order to reuse the original result extra kwargs, like `step`, `parent`, etc.
+                    #
+                    #   TODO: A simple way to get constant without referencing other plugin.
+                    #
+                    def negated_result
+                      case status.to_sym
+                      when :success
+                        copy(
+                          overrides: {
+                            kwargs: {
+                              status: :failure,
+                              data: unsafe_data,
+                              message: "Original `result` is `success`#{" with `message` - #{unsafe_message}" unless unsafe_message.empty?}",
+                              code: "negated_#{unsafe_code}"
+                            }
+                          }
+                        )
+                      when :failure
+                        copy(
+                          overrides: {
+                            kwargs: {
+                              status: :success,
+                              data: unsafe_data,
+                              message: "Original `result` is `failure`#{" with `message` - #{unsafe_message}" unless unsafe_message.empty?}",
+                              code: "negated_#{unsafe_code}"
+                            }
+                          }
+                        )
+                      when :error
+                        copy
+                      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_negated_result.rb

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