convenient_service 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d49bd8a8f45539edd750ba5388d4cd0dc7ab2e442380a24f38879f17c405944
-  data.tar.gz: 63adf6692c4989970e4fe1fa2b0c28bfa2c29020f33e9567d3fabbd9284f1944
+  metadata.gz: d53f96dab5d2b97b26168f4859dc0daefe41c8768e83e607d13234c2c7d77101
+  data.tar.gz: c6d5a9d30e5c3c768f556eb7d84b558099fcbeb96dbff655b7bd2b553435a26a
 SHA512:
-  metadata.gz: 199c1e80a8dfeedc2a8d1873f8f75008d510fb48374ab116f7c51f49ef44cf034454280279a5fda2bdc16ccd69e6010cb70291bdf0f10295d3eabddfcc391a6e
-  data.tar.gz: 2f03ad73249e0f61ee1d2f2b3fde41c82d9bd2089ebcd95f01390df206f6dded8ee5c4880d409065f6df01ba63eec1cbf26caabaf94c4e4a962752bb1f9d967f
+  metadata.gz: 9f3fb867003d44c6786446fdb2baac4550bd6ac8f34ee9196ee310912c4eb2084f40dc731dce8a2af7ac8a963d6a3579c6e886ad28251c4bf5a9a08ca290a6d2
+  data.tar.gz: e24704e463ac31d3f65a4c9a5777617157bdebb62ab785e92f3f18125d8968e5c3a6d44368553c706c9f8bab0ce7bd8f938ce53ebc1df68585493738533ef2cb

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## [0.8.0](https://github.com/marian13/convenient_service/compare/v0.7.0...v0.8.0) (2023-02-20)
+
+
+### Features
+
+* **aliases:** expose middlewares ([aacb6fd](https://github.com/marian13/convenient_service/commit/aacb6fda4c63e1d82e33c523885bd61397cfb583))
+* **configs:** introduce Minimal config ([70b0ca8](https://github.com/marian13/convenient_service/commit/70b0ca82679fc89099aee733d91807e371bbed39))
+* **rescues_result_unhandled_exceptions:** introduce rescues_result_unhandled_exceptions ([fd0b444](https://github.com/marian13/convenient_service/commit/fd0b4447e5abf81d971cd93a8333a89b363ef1ff))
+* **rescues_result_unhandled_exceptions:** return original exception in data + formatted exception as message ([45bc55e](https://github.com/marian13/convenient_service/commit/45bc55ec245df1b95769be761337a3cb2558a878))
+* **undefined:** introduce undefined ([2f93bdc](https://github.com/marian13/convenient_service/commit/2f93bdc86d81c9a819bbc1c4a76a0ef291a59b17))
+* **wrap_method:** introduce WrappedMethod#chain_exception ([1db33af](https://github.com/marian13/convenient_service/commit/1db33afc3a0e0713700b0bf5385900085af0a2df))
+
+
+### Bug Fixes
+
+* **wrapped_method:** define chain value even if chain.next raises an exception ([8c4cf95](https://github.com/marian13/convenient_service/commit/8c4cf9534a07e9614fdc73f0d0c019f9c3f0ea54))
+* **wrapped_method:** reraise rescued exception ([31f7ab6](https://github.com/marian13/convenient_service/commit/31f7ab6df0b34980656942992d3ecf7a67461d06))
+
 ## [0.7.0](https://github.com/marian13/convenient_service/compare/v0.6.0...v0.7.0) (2023-02-13)
 
 

data/ROADMAP.md

@@ -75,5 +75,7 @@
 | Low | 🚧 | Rubocop cop that complains when a service name does NOT start with a verb | |
 | Low | 🚧 | Generator to create a spec default structure | |
 | Low | 🚧 | Rubocop cop that complains when a service does NOT have its own suite of specs | |
+| High | 🚧 | Add specs for `WrappedMethod#call` | |
+| High | 🚧 | Check whether ignoring error was used properly | |
 
 Search for `TODO`s in the codebase for more tasks.

data/lib/convenient_service/aliases.rb

@@ -1,7 +1,16 @@
 # frozen_string_literal: true
 
+##
+# @internal
+#   NOTE: Aliases hide the full constants path from the end-users in order to increase DX.
+#   - https://en.wikipedia.org/wiki/User_experience#Developer_experience
+#
 module ConvenientService
   Command = ::ConvenientService::Support::Command
   Concern = ::ConvenientService::Support::Concern
   DependencyContainer = ::ConvenientService::Support::DependencyContainer
+
+  ClassicMiddleware = ::ConvenientService::Core::Entities::ClassicMiddleware
+  ConcernMiddleware = ::ConvenientService::Core::Entities::Config::Entities::Concerns::Entities::Middleware
+  MethodChainMiddleware = ::ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Middleware
 end

data/lib/convenient_service/common/plugins/has_constructor_without_initialize/concern.rb

@@ -13,6 +13,25 @@ module ConvenientService
             # @since 0.2.0
             #
             # @internal
+            #   NOTE: `allocate` creates an uninitialized object and allocates memory for it.
+            #
+            #   NOTE: Pseudocode for default `new` implementation.
+            #     def new
+            #       instance = allocate
+            #
+            #       instance.send(:initialize)
+            #
+            #       instance
+            #     end
+            #
+            #   NOTE: Code for `new_without_initialize`.
+            #     def new_without_initialize
+            #       allocate
+            #     end
+            #
+            #   NOTE: `create` is used instead of `new` in order to avoid the accidental feeling that `new_without_initialize` is Ruby's built-in method.
+            #
+            #   NOTE: Check the following links for more info.
             #   - https://ruby-doc.org/core-2.5.0/Class.html#method-i-allocate
             #   - https://frontdeveloper.pl/2018/11/ruby-allocate-method/
             #

data/lib/convenient_service/configs/minimal.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Configs
+    ##
+    # Defines minimal configuration that adds a constructor, JSend-inspired result, steps, basic inspects, and internals to services.
+    #
+    # @note: This config is NOT intented for the end-user usage. Use `Standard` instead.
+    #
+    # @internal
+    #   Heavily used in specs to test concerns and middlewares in isolation.
+    #
+    module Minimal
+      include Support::Concern
+
+      ##
+      # @internal
+      #   IMPORTANT: Order of plugins matters.
+      #
+      #   NOTE: `class_exec` (that is used under the hood by `included`) defines `class Result` in the global namespace.
+      #   That is why `class self::Result` is used.
+      #   - https://stackoverflow.com/a/51965126/12201472
+      #
+      # rubocop:disable Lint/ConstantDefinitionInBlock
+      included do
+        include Core
+
+        concerns do
+          use Plugins::Common::HasInternals::Concern
+
+          use Plugins::Service::HasInspect::Concern
+
+          use Plugins::Common::HasConstructor::Concern
+          use Plugins::Common::HasConstructorWithoutInitialize::Concern
+
+          use Plugins::Service::HasResult::Concern
+          use Plugins::Service::HasResultSteps::Concern
+        end
+
+        middlewares :initialize do
+          use Plugins::Common::NormalizesEnv::Middleware
+        end
+
+        middlewares :result do
+          use Plugins::Common::NormalizesEnv::Middleware
+
+          use Plugins::Service::HasResult::Middleware
+          use Plugins::Service::HasResultSteps::Middleware
+        end
+
+        middlewares :step do
+          use Plugins::Common::NormalizesEnv::Middleware
+        end
+
+        middlewares :success do
+          use Plugins::Common::NormalizesEnv::Middleware
+        end
+
+        middlewares :failure do
+          use Plugins::Common::NormalizesEnv::Middleware
+        end
+
+        middlewares :error do
+          use Plugins::Common::NormalizesEnv::Middleware
+        end
+
+        middlewares :result, scope: :class do
+          use Plugins::Common::NormalizesEnv::Middleware
+        end
+
+        middlewares :step, scope: :class do
+          use Plugins::Common::NormalizesEnv::Middleware
+        end
+
+        class self::Internals
+          include Core
+
+          concerns do
+            use Plugins::Internals::HasCache::Concern
+          end
+        end
+
+        class self::Result
+          include Core
+
+          concerns do
+            use Plugins::Common::HasInternals::Concern
+
+            use Plugins::Result::HasInspect::Concern
+
+            use Plugins::Common::HasConstructor::Concern
+
+            use Plugins::Result::HasJsendStatusAndAttributes::Concern
+          end
+
+          middlewares :initialize do
+            use Plugins::Common::NormalizesEnv::Middleware
+
+            use Plugins::Result::HasJsendStatusAndAttributes::Middleware
+          end
+
+          middlewares :success? do
+            use Plugins::Common::NormalizesEnv::Middleware
+          end
+
+          middlewares :failure? do
+            use Plugins::Common::NormalizesEnv::Middleware
+          end
+
+          middlewares :error? do
+            use Plugins::Common::NormalizesEnv::Middleware
+          end
+
+          middlewares :not_success? do
+            use Plugins::Common::NormalizesEnv::Middleware
+          end
+
+          middlewares :not_failure? do
+            use Plugins::Common::NormalizesEnv::Middleware
+          end
+
+          middlewares :not_error? do
+            use Plugins::Common::NormalizesEnv::Middleware
+          end
+
+          middlewares :data do
+            use Plugins::Common::NormalizesEnv::Middleware
+          end
+
+          middlewares :message do
+            use Plugins::Common::NormalizesEnv::Middleware
+          end
+
+          middlewares :code do
+            use Plugins::Common::NormalizesEnv::Middleware
+          end
+
+          middlewares :to_kwargs do
+            use Plugins::Common::NormalizesEnv::Middleware
+          end
+
+          class self::Internals
+            include Core
+
+            concerns do
+              use Plugins::Internals::HasCache::Concern
+            end
+          end
+        end
+
+        class self::Step
+          include Core
+
+          concerns do
+            use Plugins::Common::HasInternals::Concern
+
+            use Plugins::Step::HasInspect::Concern
+          end
+
+          middlewares :calculate_result do
+            use Plugins::Common::NormalizesEnv::Middleware
+          end
+
+          class self::Internals
+            include Core
+
+            concerns do
+              use Plugins::Internals::HasCache::Concern
+            end
+          end
+        end
+      end
+      # rubocop:enable Lint/ConstantDefinitionInBlock
+    end
+  end
+end

data/lib/convenient_service/configs/standard.rb

@@ -2,54 +2,47 @@
 
 module ConvenientService
   module Configs
+    ##
+    # Default configuration for the user-defined services.
+    #
     module Standard
       include Support::Concern
 
       ##
-      # IMPORTANT: Order of plugins matters.
+      # @internal
+      #   IMPORTANT: Order of plugins matters.
       #
-      # NOTE: `class_exec` (that is used under the hood by `included`) defines `class Result` in the global namespace.
-      # That is why `class self::Result` is used.
-      #
-      # https://stackoverflow.com/a/51965126/12201472
+      #   NOTE: `class_exec` (that is used under the hood by `included`) defines `class Result` in the global namespace.
+      #   That is why `class self::Result` is used.
+      #   - https://stackoverflow.com/a/51965126/12201472
       #
       # rubocop:disable Lint/ConstantDefinitionInBlock
       included do
-        include Core
+        include Configs::Minimal
 
         concerns do
-          use Plugins::Common::HasInternals::Concern
-          use Plugins::Common::HasConstructor::Concern
-          use Plugins::Common::HasConstructorWithoutInitialize::Concern
-
           use Plugins::Common::CachesConstructorParams::Concern
           use Plugins::Common::CanBeCopied::Concern
-          use Plugins::Service::HasResult::Concern
-          use Plugins::Service::HasResultShortSyntax::Concern
-          use Plugins::Service::HasResultSteps::Concern
           use Plugins::Service::CanRecalculateResult::Concern
+          use Plugins::Service::HasResultShortSyntax::Concern
           use Plugins::Service::HasResultStatusCheckShortSyntax::Concern
 
           use Plugins::Common::HasCallbacks::Concern
           use Plugins::Common::HasAroundCallbacks::Concern
-
-          use Plugins::Service::HasInspect::Concern
         end
 
         middlewares :initialize do
-          use Plugins::Common::NormalizesEnv::Middleware
-
           use Plugins::Common::CachesConstructorParams::Middleware
         end
 
         middlewares :result do
-          use Plugins::Common::NormalizesEnv::Middleware
+          insert_before \
+            Plugins::Service::HasResult::Middleware,
+            Plugins::Common::HasCallbacks::Middleware
 
-          use Plugins::Common::HasCallbacks::Middleware
-          use Plugins::Common::HasAroundCallbacks::Middleware
-
-          use Plugins::Service::HasResult::Middleware
-          use Plugins::Service::HasResultSteps::Middleware
+          insert_after \
+            Plugins::Common::HasCallbacks::Middleware,
+            Plugins::Common::HasAroundCallbacks::Middleware
 
           use Plugins::Service::RaisesOnDoubleResult::Middleware
 
@@ -57,167 +50,86 @@ module ConvenientService
         end
 
         middlewares :step do
-          use Plugins::Common::NormalizesEnv::Middleware
-
           use Plugins::Common::HasCallbacks::Middleware
           use Plugins::Common::HasAroundCallbacks::Middleware
         end
 
         middlewares :success do
-          use Plugins::Common::NormalizesEnv::Middleware
-
           use Plugins::Service::HasResultShortSyntax::Success::Middleware
         end
 
         middlewares :failure do
-          use Plugins::Common::NormalizesEnv::Middleware
-
           use Plugins::Service::HasResultShortSyntax::Failure::Middleware
         end
 
         middlewares :error do
-          use Plugins::Common::NormalizesEnv::Middleware
-
           use Plugins::Service::HasResultShortSyntax::Error::Middleware
         end
 
-        middlewares :result, scope: :class do
-          use Plugins::Common::NormalizesEnv::Middleware
-        end
-
         middlewares :step, scope: :class do
-          use Plugins::Common::NormalizesEnv::Middleware
-
           use Plugins::Service::HasResultMethodSteps::Middleware
         end
 
-        class self::Internals
-          include Core
-
-          concerns do
-            use Plugins::Internals::HasCache::Concern
-          end
-        end
-
         class self::Result
-          include Core
-
           concerns do
-            use Plugins::Common::HasInternals::Concern
-            use Plugins::Common::HasConstructor::Concern
-
-            use Plugins::Result::HasJsendStatusAndAttributes::Concern
-
             use Plugins::Result::HasResultShortSyntax::Concern
             use Plugins::Result::CanRecalculateResult::Concern
 
             use Plugins::Result::HasStep::Concern
             use Plugins::Result::CanHaveParentResult::Concern
-
-            use Plugins::Result::HasInspect::Concern
           end
 
           middlewares :initialize do
-            use Plugins::Common::NormalizesEnv::Middleware
-
-            use Plugins::Result::HasJsendStatusAndAttributes::Middleware
-
             use Plugins::Result::HasStep::Initialize::Middleware
             use Plugins::Result::CanHaveParentResult::Initialize::Middleware
           end
 
           middlewares :success? do
-            use Plugins::Common::NormalizesEnv::Middleware
-
             use Plugins::Result::MarksResultStatusAsChecked::Middleware
           end
 
           middlewares :failure? do
-            use Plugins::Common::NormalizesEnv::Middleware
-
             use Plugins::Result::MarksResultStatusAsChecked::Middleware
           end
 
           middlewares :error? do
-            use Plugins::Common::NormalizesEnv::Middleware
-
             use Plugins::Result::MarksResultStatusAsChecked::Middleware
           end
 
           middlewares :not_success? do
-            use Plugins::Common::NormalizesEnv::Middleware
-
             use Plugins::Result::MarksResultStatusAsChecked::Middleware
           end
 
           middlewares :not_failure? do
-            use Plugins::Common::NormalizesEnv::Middleware
-
             use Plugins::Result::MarksResultStatusAsChecked::Middleware
           end
 
           middlewares :not_error? do
-            use Plugins::Common::NormalizesEnv::Middleware
-
             use Plugins::Result::MarksResultStatusAsChecked::Middleware
           end
 
           middlewares :data do
-            use Plugins::Common::NormalizesEnv::Middleware
-
             use Plugins::Result::RaisesOnNotCheckedResultStatus::Middleware
           end
 
           middlewares :message do
-            use Plugins::Common::NormalizesEnv::Middleware
-
             use Plugins::Result::RaisesOnNotCheckedResultStatus::Middleware
           end
 
           middlewares :code do
-            use Plugins::Common::NormalizesEnv::Middleware
-
             use Plugins::Result::RaisesOnNotCheckedResultStatus::Middleware
           end
 
           middlewares :to_kwargs do
-            use Plugins::Common::NormalizesEnv::Middleware
-
             use Plugins::Result::HasStep::ToKwargs::Middleware
             use Plugins::Result::CanHaveParentResult::ToKwargs::Middleware
           end
-
-          class self::Internals
-            include Core
-
-            concerns do
-              use Plugins::Internals::HasCache::Concern
-            end
-          end
         end
 
         class self::Step
-          include Core
-
-          concerns do
-            use Plugins::Common::HasInternals::Concern
-
-            use Plugins::Step::HasInspect::Concern
-          end
-
           middlewares :calculate_result do
-            use Plugins::Common::NormalizesEnv::Middleware
-
             use Plugins::Step::CanHaveParentResult::Middleware
           end
-
-          class self::Internals
-            include Core
-
-            concerns do
-              use Plugins::Internals::HasCache::Concern
-            end
-          end
         end
 
         if Dependencies.rspec.loaded?

data/lib/convenient_service/configs.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "configs/minimal"
 require_relative "configs/standard"
 
 require_relative "configs/aliases"

data/lib/convenient_service/dependencies.rb

@@ -75,6 +75,14 @@ module ConvenientService
         require_relative "service/plugins/has_result_params_validations/using_dry_validation"
       end
 
+      ##
+      # @return [Boolean]
+      # @note Expected to be called from app entry points like `initializers` in Rails.
+      #
+      def require_rescues_result_unhandled_exceptions
+        require_relative "service/plugins/rescues_result_unhandled_exceptions"
+      end
+
       ##
       # @return [Boolean]
       # @note Expected to be called from `irb`, `pry`, `spec_helper.rb`, etc.

data/lib/convenient_service/examples/dry/gemfile/dry_service/config.rb

@@ -16,26 +16,26 @@ module ConvenientService
 
             included do |service_class|
               service_class.class_exec do
-                include Configs::Standard
+                include ConvenientService::Standard::Config
 
                 ##
                 # NOTE: `AssignsAttributesInConstructor::UsingDryInitializer` plugin.
                 #
                 concerns do
-                  use Plugins::Common::AssignsAttributesInConstructor::UsingDryInitializer::Concern
+                  use ConvenientService::Plugins::Common::AssignsAttributesInConstructor::UsingDryInitializer::Concern
                 end
 
                 ##
                 # NOTE: `HasResultParamsValidations::UsingDryValidation` plugin.
                 #
                 concerns do
-                  use Plugins::Service::HasResultParamsValidations::UsingDryValidation::Concern
+                  use ConvenientService::Plugins::Service::HasResultParamsValidations::UsingDryValidation::Concern
                 end
 
                 middlewares :result do
                   insert_before \
-                    Plugins::Service::HasResult::Middleware,
-                    Plugins::Service::HasResultParamsValidations::UsingDryValidation::Middleware
+                    ConvenientService::Plugins::Service::HasResult::Middleware,
+                    ConvenientService::Plugins::Service::HasResultParamsValidations::UsingDryValidation::Middleware
                 end
               end
             end

data/lib/convenient_service/examples/rails/gemfile/rails_service/config.rb

@@ -16,37 +16,37 @@ module ConvenientService
 
             included do |service_class|
               service_class.class_exec do
-                include Configs::Standard
+                include ConvenientService::Standard::Config
 
                 ##
                 # NOTE: `AssignsAttributesInConstructor::UsingActiveModelAttributeAssignment` plugin.
                 #
                 concerns do
-                  use Plugins::Common::AssignsAttributesInConstructor::UsingActiveModelAttributeAssignment::Concern
+                  use ConvenientService::Plugins::Common::AssignsAttributesInConstructor::UsingActiveModelAttributeAssignment::Concern
                 end
 
                 middlewares :initialize do
-                  use Plugins::Common::AssignsAttributesInConstructor::UsingActiveModelAttributeAssignment::Middleware
+                  use ConvenientService::Plugins::Common::AssignsAttributesInConstructor::UsingActiveModelAttributeAssignment::Middleware
                 end
 
                 ##
                 # NOTE: `HasAttributes::UsingActiveModelAttributes` plugin.
                 #
                 concerns do
-                  use Plugins::Common::HasAttributes::UsingActiveModelAttributes::Concern
+                  use ConvenientService::Plugins::Common::HasAttributes::UsingActiveModelAttributes::Concern
                 end
 
                 ##
                 # NOTE: `HasResultParamsValidations::UsingActiveModelValidations` plugin.
                 #
                 concerns do
-                  use Plugins::Service::HasResultParamsValidations::UsingActiveModelValidations::Concern
+                  use ConvenientService::Plugins::Service::HasResultParamsValidations::UsingActiveModelValidations::Concern
                 end
 
                 middlewares :result do
                   insert_before \
-                    Plugins::Service::HasResult::Middleware,
-                    Plugins::Service::HasResultParamsValidations::UsingActiveModelValidations::Middleware
+                    ConvenientService::Plugins::Service::HasResult::Middleware,
+                    ConvenientService::Plugins::Service::HasResultParamsValidations::UsingActiveModelValidations::Middleware
                 end
               end
             end

data/lib/convenient_service/rspec/helpers/custom/ignoring_error.rb

@@ -20,6 +20,9 @@ module ConvenientService
           rescue *errors
             nil
           else
+            ##
+            # TODO: Raise self-explanatory exception.
+            #
             raise
           end
         end

data/lib/convenient_service/rspec/helpers/custom/wrap_method/entities/wrapped_method.rb

@@ -35,9 +35,25 @@ module ConvenientService
                   #
                   stack.use(
                     proc do |env|
-                      entity.__send__(method, *env[:args], **env[:kwargs], &env[:block])
-                        .tap { |value| @chain_value = value }
-                        .tap { @chain_arguments = {args: env[:args], kwargs: env[:kwargs], block: env[:block]} }
+                      @chain_arguments = {args: env[:args], kwargs: env[:kwargs], block: env[:block]}
+
+                      ##
+                      # IMPORTANT: Forces Ruby to define `@chain_value` instance variable.
+                      #
+                      # NOTE: If `@chain_value` is still set to `Support::UNDEFINED` after running the begin block - an exception was raised by `chain.next`. See `chain_called?` for more info.
+                      #
+                      @chain_value = Support::UNDEFINED
+
+                      begin
+                        @chain_value = entity.__send__(method, *env[:args], **env[:kwargs], &env[:block])
+                      rescue => exception
+                        @chain_exception = exception
+
+                        ##
+                        # NOTE: `raise` with no args inside `rescue` reraises rescued exception.
+                        #
+                        raise
+                      end
                     end
                   )
                 end
@@ -107,6 +123,16 @@ module ConvenientService
 
                 @chain_arguments[:block]
               end
+
+              ##
+              # @return [StandardError, nil]
+              # @raise [ConvenientService::RSpec::Helpers::Custom::WrapMethod::Errors::ChainAttributePreliminaryAccess]
+              #
+              def chain_exception
+                raise Errors::ChainAttributePreliminaryAccess.new(attribute: :exception) unless chain_called?
+
+                @chain_exception
+              end
             end
           end
         end

data/lib/convenient_service/rspec/matchers/custom/results/base.rb

@@ -26,7 +26,12 @@ module ConvenientService
               rules = []
 
               rules << ->(result) { result.class.include?(Service::Plugins::HasResult::Entities::Result::Concern) }
+
+              ##
+              # IMPORTANT: Result status is NOT marked as checked intentionally, since it is a mutable operation.
+              #
               rules << ->(result) { result.status.in?(statuses) }
+
               rules << ->(result) { result.service.instance_of?(service_class) } if used_of_service?
               rules << ->(result) { Commands::MatchResultStep.call(result: result, step: step) } if used_of_step?
               rules << ->(result) { result.unsafe_data == data } if used_data?