convenient_service 0.25.0 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a077e3ef95d8ad18dbc79399c5513f29a17491111557cfad7b446eda2bec5a8
-  data.tar.gz: 07e8481191d8a8fe51b7995d5507147755ee2676cfe51b9c5a5b11e42f5a47e2
+  metadata.gz: 31bdaa61be77d7c69da22c3baaf05b545d60606fbf45e9a7baac33929e845544
+  data.tar.gz: 7fa4432c8ce4b57a43b3bbcc9c8ea18d5002b69fc00db81da0cba78c9ac8ba54
 SHA512:
-  metadata.gz: 268d3a56e8ea1e0161dde099762d3d91dcb8c85b005d2fc45e6ab9e8e622a7da15b4c6d70c45809dd8cd83787cbb042ffe71f4aaef369be4562f18d2b6b22340
-  data.tar.gz: deeb6b2c67a294a98fee2fdb409d653b4674c83c22f9e8ef413014ef42d1dfe8127e3aaecc85d020a206350607f2276e1f09575f5bb9e0888e4927a73697e513
+  metadata.gz: 8195321c43354288cd9d99a74a3384dbc552ca4845d0fa58ef347a34e21cab420c284a4bed10ea62d71885c02cff5e3999b9956facd50d8ea58928eb74e7cf67
+  data.tar.gz: 9d4007218ddf5eb3061a57f6038af8596c7e98bf8dc4791acf7e0ef66e1a0b9987d36689e508747eeef54c3fa7f4291374a500b032a5944e03c677a26feb0110

data/lib/convenient_service/common/plugins/tries_to_convert_result_duck_to_result/middleware.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
+module ConvenientService
+  module Common
+    module Plugins
+      module TriesToConvertResultDuckToResult
+        class Middleware < MethodChainMiddleware
+          intended_for :result, entity: any_entity
+
+          ##
+          # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+          #
+          # @internal
+          #   NOTE: When original result is a result duck and it has `NoMethodError` exception, that exception should be raised just like any other exception. See specs for details.
+          #
+          #   NOTE: `exception.receiver` is available on `NameError` descendants (like `NoMethodError`), but NOT on `StandardError`.
+          #   - https://ruby-doc.org/core-2.7.1/NoMethodError.html
+          #   - https://ruby-doc.org/core-2.7.1/NameError.html#method-i-receiver
+          #   - https://ruby-doc.org/core-2.7.1/StandardError.html
+          #
+          def next(...)
+            original_object = chain.next(...)
+
+            result_duck, result = try_convert(original_object)
+
+            result_duck ? result : original_object
+          end
+
+          private
+
+          ##
+          # @param original_object [Object] Can be any type.
+          # @return [Array]
+          # @raise [NoMethodError]
+          #
+          def try_convert(original_object)
+            result = original_object.result
+
+            [true, result]
+          rescue ::NoMethodError => exception
+            raise exception if original_object.respond_to?(:result)
+
+            [false, nil]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/common/plugins/tries_to_convert_result_duck_to_result.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
+require_relative "tries_to_convert_result_duck_to_result/middleware"

data/lib/convenient_service/common/plugins.rb

@@ -14,6 +14,7 @@ require_relative "plugins/caches_return_value"
 require_relative "plugins/can_be_copied"
 require_relative "plugins/can_have_user_provided_entity"
 require_relative "plugins/ensures_negated_j_send_result"
+require_relative "plugins/tries_to_convert_result_duck_to_result"
 require_relative "plugins/can_have_callbacks"
 require_relative "plugins/can_have_not_passed_arguments"
 require_relative "plugins/can_utilize_finite_loop"

data/lib/convenient_service/service/configs/standard.rb

@@ -29,6 +29,7 @@ module ConvenientService
             :result_parents_trace,
             :code_review_automation,
             :short_syntax,
+            :duck_typing,
             :type_safety,
             :exception_services_trace,
             :per_instance_caching,
@@ -58,6 +59,7 @@ module ConvenientService
             :result_parents_trace,
             :code_review_automation,
             :short_syntax,
+            :duck_typing,
             :type_safety,
             :exception_services_trace,
             :per_instance_caching,
@@ -134,6 +136,7 @@ module ConvenientService
             use ConvenientService::Plugins::Service::RaisesOnNotResultReturnValue::Middleware if options.enabled?(:type_safety)
             use ConvenientService::Plugins::Service::RescuesResultUnhandledExceptions::Middleware if options.enabled?(:fault_tolerance)
             use ConvenientService::Plugins::Common::CleansExceptionBacktrace::Middleware if options.enabled?(:backtrace_cleaner)
+            use ConvenientService::Plugins::Common::TriesToConvertResultDuckToResult::Middleware if options.enabled?(:duck_typing)
             use ConvenientService::Plugins::Service::HasJSendResultParamsValidations::UsingActiveModelValidations::Middleware if options.enabled?(:active_model_validations)
             use ConvenientService::Plugins::Service::HasJSendResultParamsValidations::UsingDryValidation::Middleware if options.enabled?(:dry_validation)
             use ConvenientService::Plugins::Service::CanHaveConnectedSteps::Middleware if options.enabled?(:essential)
@@ -146,6 +149,7 @@ module ConvenientService
             use ConvenientService::Plugins::Service::RaisesOnNotResultReturnValue::Middleware if options.enabled?(:type_safety)
             use ConvenientService::Plugins::Service::RescuesResultUnhandledExceptions::Middleware if options.enabled?(:fault_tolerance)
             use ConvenientService::Plugins::Common::CleansExceptionBacktrace::Middleware if options.enabled?(:backtrace_cleaner)
+            use ConvenientService::Plugins::Common::TriesToConvertResultDuckToResult::Middleware if options.enabled?(:duck_typing)
           end
 
           middlewares :regular_result do
@@ -160,27 +164,30 @@ module ConvenientService
             use ConvenientService::Plugins::Common::CachesReturnValue::Middleware if options.enabled?(:per_instance_caching)
             use ConvenientService::Plugins::Service::CollectsServicesInException::Middleware if options.enabled?(:exception_services_trace)
             use ConvenientService::Plugins::Service::RaisesOnNotResultReturnValue::Middleware if options.enabled?(:type_safety)
-            # use ConvenientService::Plugins::Service::RescuesResultUnhandledExceptions::Middleware if options.enabled?(:fault_tolerance) # TODO: Dedicted `rescue`?
+            # use ConvenientService::Plugins::Service::RescuesResultUnhandledExceptions::Middleware if options.enabled?(:fault_tolerance) # TODO: Dedicated `rescue`?
             use ConvenientService::Plugins::Common::CleansExceptionBacktrace::Middleware if options.enabled?(:backtrace_cleaner)
             use ConvenientService::Plugins::Service::CanHaveFallbacks::Middleware.with(status: :failure) if options.enabled?(:fallbacks)
+            use ConvenientService::Plugins::Common::TriesToConvertResultDuckToResult::Middleware if options.enabled?(:duck_typing)
           end
 
           middlewares :fallback_error_result do
             use ConvenientService::Plugins::Common::CachesReturnValue::Middleware if options.enabled?(:per_instance_caching)
             use ConvenientService::Plugins::Service::CollectsServicesInException::Middleware if options.enabled?(:exception_services_trace)
             use ConvenientService::Plugins::Service::RaisesOnNotResultReturnValue::Middleware if options.enabled?(:type_safety)
-            # use ConvenientService::Plugins::Service::RescuesResultUnhandledExceptions::Middleware if options.enabled?(:fault_tolerance) # TODO: Dedicted `rescue`?
+            # use ConvenientService::Plugins::Service::RescuesResultUnhandledExceptions::Middleware if options.enabled?(:fault_tolerance) # TODO: Dedicated `rescue`?
             use ConvenientService::Plugins::Common::CleansExceptionBacktrace::Middleware if options.enabled?(:backtrace_cleaner)
             use ConvenientService::Plugins::Service::CanHaveFallbacks::Middleware.with(status: :error) if options.enabled?(:fallbacks)
+            use ConvenientService::Plugins::Common::TriesToConvertResultDuckToResult::Middleware if options.enabled?(:duck_typing)
           end
 
           middlewares :fallback_result do
             use ConvenientService::Plugins::Common::CachesReturnValue::Middleware if options.enabled?(:per_instance_caching)
             use ConvenientService::Plugins::Service::CollectsServicesInException::Middleware if options.enabled?(:exception_services_trace)
             use ConvenientService::Plugins::Service::RaisesOnNotResultReturnValue::Middleware if options.enabled?(:type_safety)
-            # use ConvenientService::Plugins::Service::RescuesResultUnhandledExceptions::Middleware if options.enabled?(:fault_tolerance) # TODO: Dedicted `rescue`?
+            # use ConvenientService::Plugins::Service::RescuesResultUnhandledExceptions::Middleware if options.enabled?(:fault_tolerance) # TODO: Dedicated `rescue`?
             use ConvenientService::Plugins::Common::CleansExceptionBacktrace::Middleware if options.enabled?(:backtrace_cleaner)
             use ConvenientService::Plugins::Service::CanHaveFallbacks::Middleware.with(status: nil) if options.enabled?(:fallbacks)
+            use ConvenientService::Plugins::Common::TriesToConvertResultDuckToResult::Middleware if options.enabled?(:duck_typing)
           end
 
           middlewares :success do

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

@@ -35,8 +35,13 @@ module ConvenientService
                       extra_kwargs.dig(:exceptions, :handled)
                     end
 
+                    ##
+                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+                    # @raise [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::CanBeFromHandledException::Exceptions::FromExceptionOnNotErrorResult]
+                    #
                     def from_exception(exception, **kwargs)
                       ::ConvenientService.raise Exceptions::FromExceptionOnNotErrorResult.new(result: self) unless status.unsafe_error?
+
                       data =
                         if Service::Plugins::HasJSendResult.default_error_data == unsafe_data.to_h
                           {handled_exception: exception}

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

@@ -103,6 +103,13 @@ module ConvenientService
                       internals.cache[:jsend_attributes]
                     end
 
+                    ##
+                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+                    #
+                    def result
+                      self
+                    end
+
                     ##
                     # @param status [Symbol]
                     # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Status]

data/lib/convenient_service/service/plugins/raises_on_not_result_return_value/middleware.rb

@@ -12,12 +12,16 @@ module ConvenientService
         class Middleware < MethodChainMiddleware
           intended_for any_method, entity: :service
 
+          ##
+          # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+          # @raise [ConvenientService::Service::Plugins::RaisesOnNotResultReturnValue::Exceptions::ReturnValueNotKindOfResult]
+          #
           def next(...)
-            original_result = chain.next(...)
+            result = chain.next(...)
 
-            return original_result if Service::Plugins::HasJSendResult.result?(original_result)
+            return result if Service::Plugins::HasJSendResult.result?(result)
 
-            ::ConvenientService.raise Exceptions::ReturnValueNotKindOfResult.new(service: entity, result: original_result, method: method)
+            ::ConvenientService.raise Exceptions::ReturnValueNotKindOfResult.new(service: entity, result: result, method: method)
           end
         end
       end

data/lib/convenient_service/version.rb

@@ -13,5 +13,5 @@ module ConvenientService
   # @since 1.0.0
   # @return [String]
   #
-  VERSION = "0.25.0"
+  VERSION = "0.26.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: convenient_service
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.26.0
 platform: ruby
 authors:
 - Marian Kostyk
@@ -108,6 +108,8 @@ files:
 - lib/convenient_service/common/plugins/has_j_send_result_duck_short_syntax/concern.rb
 - lib/convenient_service/common/plugins/has_memoization/using_memo_wise.rb
 - lib/convenient_service/common/plugins/has_memoization/using_memo_wise/concern.rb
+- lib/convenient_service/common/plugins/tries_to_convert_result_duck_to_result.rb
+- lib/convenient_service/common/plugins/tries_to_convert_result_duck_to_result/middleware.rb
 - lib/convenient_service/config.rb
 - lib/convenient_service/config/commands.rb
 - lib/convenient_service/config/commands/normalize_options.rb
@@ -912,7 +914,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Ruby Service Objects with Steps and more.
 test_files: []