convenient_service 0.12.0 → 0.14.0

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

@@ -4,7 +4,13 @@ module ConvenientService
   module Common
     module Plugins
       module HasCallbacks
-        class Middleware < Core::MethodChainMiddleware
+        class Middleware < MethodChainMiddleware
+          intended_for any_method, scope: any_scope, entity: any_entity
+
+          ##
+          # @internal
+          #   TODO: Move to command.
+          #
           def next(*args, **kwargs, &block)
             ##
             # class Service

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

@@ -17,11 +17,10 @@ module ConvenientService
 
           class_methods do
             ##
-            # @return [Object]
-            # @since 0.2.0
+            # @return [Object] Can be any type.
             #
-            def create(...)
-              new(...)
+            def new(...)
+              new_without_commit_config(...)
             end
           end
         end

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

@@ -10,7 +10,6 @@ module ConvenientService
           class_methods do
             ##
             # @return [Object]
-            # @since 0.2.0
             #
             # @internal
             #   NOTE: `allocate` creates an uninitialized object and allocates memory for it.
@@ -24,18 +23,11 @@ module ConvenientService
             #       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/
             #
-            def create_without_initialize
+            def new_without_initialize
               allocate
             end
           end

data/lib/convenient_service/common/plugins/has_internals/entities/internals/plugins/has_cache/concern.rb

@@ -20,7 +20,7 @@ module ConvenientService
                     # @return [ConvenientService::Support::Cache]
                     #
                     def cache
-                      @cache ||= Support::Cache.new
+                      @cache ||= Support::Cache.create(backend: :hash)
                     end
                   end
                 end

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Common
+    module Plugins
+      module HasJSendResultDuckShortSyntax
+        module Concern
+          include Support::Concern
+
+          instance_methods do
+            ##
+            # @param key [String, Symbol]
+            # @return [Object] Can be any type.
+            #
+            # @internal
+            #   NOTE: Delegates to `data` instead of aliasing in order to have an ability
+            #   to use the same RSpec stubs for short and usual syntax.
+            #
+            #   For example:
+            #
+            #     allow(result).to receive(:data).with(:foo).and_call_original
+            #
+            #   works for both `result.data[:foo]` and `result[:foo]`.
+            #
+            def [](key)
+              data[key]
+            end
+
+            ##
+            # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Data]
+            #
+            def ud
+              unsafe_data
+            end
+
+            ##
+            # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Message]
+            #
+            def um
+              unsafe_message
+            end
+
+            ##
+            # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Code]
+            #
+            def uc
+              unsafe_code
+            end
+
+            ##
+            # @return [Boolean]
+            #
+            def ok?
+              success?
+            end
+
+            ##
+            # @return [Boolean]
+            #
+            def not_ok?
+              not_success?
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -15,7 +15,9 @@ module ConvenientService
         # Check the following link for more details:
         # - https://bugs.ruby-lang.org/issues/8507
         #
-        class Middleware < Core::ClassicMiddleware
+        class Middleware < MethodClassicMiddleware
+          intended_for any_method, scope: any_scope, entity: any_entity
+
           def call(env = nil)
             env = env.to_h
             env = env.merge(args: env[:args].to_a, kwargs: env[:kwargs].to_h, block: env[:block])

data/lib/convenient_service/common/plugins.rb

@@ -5,7 +5,7 @@
 #
 require_relative "plugins/normalizes_env"
 
-require_relative "plugins/caches_constructor_params"
+require_relative "plugins/caches_constructor_arguments"
 require_relative "plugins/caches_return_value"
 require_relative "plugins/can_be_copied"
 require_relative "plugins/can_have_user_provided_entity"
@@ -14,5 +14,6 @@ require_relative "plugins/has_around_callbacks"
 require_relative "plugins/has_constructor"
 require_relative "plugins/has_constructor_without_initialize"
 require_relative "plugins/has_internals"
+require_relative "plugins/has_j_send_result_duck_short_syntax"
 
 require_relative "plugins/aliases"

data/lib/convenient_service/configs/awesome_print_inspect/aliases.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module AwesomePrintInspect
+    Config = ::ConvenientService::Configs::AwesomePrintInspect
+  end
+end

data/lib/convenient_service/configs/awesome_print_inspect.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Configs
+    module AwesomePrintInspect
+      include Support::Concern
+
+      # rubocop:disable Lint/ConstantDefinitionInBlock
+      included do
+        include Configs::Minimal
+
+        ##
+        # @internal
+        #   TODO: Plugin groups for autoreplacement of plugins with same purpose.
+        #
+        concerns do
+          use Plugins::Service::HasAwesomePrintInspect::Concern
+        end
+
+        class self::Result
+          concerns do
+            use Plugins::Result::HasAwesomePrintInspect::Concern
+          end
+
+          class self::Data
+            concerns do
+              use Plugins::Data::HasAwesomePrintInspect::Concern
+            end
+          end
+
+          class self::Message
+            concerns do
+              use Plugins::Message::HasAwesomePrintInspect::Concern
+            end
+          end
+
+          class self::Code
+            concerns do
+              use Plugins::Code::HasAwesomePrintInspect::Concern
+            end
+          end
+
+          class self::Status
+            concerns do
+              use Plugins::Status::HasAwesomePrintInspect::Concern
+            end
+          end
+        end
+
+        class self::Step
+          concerns do
+            use Plugins::Step::HasAwesomePrintInspect::Concern
+          end
+        end
+      end
+      # rubocop:enable Lint/ConstantDefinitionInBlock
+    end
+  end
+end

data/lib/convenient_service/configs/minimal.rb

@@ -5,10 +5,30 @@ module ConvenientService
     ##
     # 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.
+    # @note This config is NOT intented for the end-user usage. Use `Standard` instead.
+    #
+    # @note
+    #   `use Plugins::Common::NormalizesEnv::Middleware` should be used in a config that has the first `concern` that introduces a method.
+    #   For example, `:result` is added by `use Plugins::Service::HasJSendResult::Concern` in `Minimal`.
+    #   That is why the following code is written in the `Minimal` config.
+    #
+    #     middlewares :result do
+    #       use Plugins::Common::NormalizesEnv::Middleware
+    #
+    #       # ...
+    #     end
+    #
+    #   In turn, `:fallback_result` is added by `use Plugins::Service::CanHaveFallbacks::Concern` in `Standard`.
+    #   That is why it is the responsibility of the `Standard` config, to define:
+    #
+    #     middlewares :fallback_result do
+    #       use Plugins::Common::NormalizesEnv::Middleware
+    #
+    #       # ...
+    #     end
     #
     # @internal
-    #   Heavily used in specs to test concerns and middlewares in isolation.
+    #   NOTE: Heavily used in specs to test concerns and middlewares in isolation.
     #
     module Minimal
       include Support::Concern
@@ -34,6 +54,7 @@ module ConvenientService
           use Plugins::Common::HasConstructorWithoutInitialize::Concern
 
           use Plugins::Service::HasResult::Concern
+          use Plugins::Service::HasJSendResult::Concern
           use Plugins::Service::CanHaveSteps::Concern
         end
 
@@ -43,8 +64,10 @@ module ConvenientService
 
         middlewares :result do
           use Plugins::Common::NormalizesEnv::Middleware
+          use Plugins::Common::CachesReturnValue::Middleware
+
+          use Plugins::Service::RaisesOnNotResultReturnValue::Middleware
 
-          use Plugins::Service::HasResult::Middleware
           use Plugins::Service::CanHaveSteps::Middleware
         end
 
@@ -72,7 +95,6 @@ module ConvenientService
           use Plugins::Common::NormalizesEnv::Middleware
 
           use Plugins::Service::CanHaveMethodSteps::Middleware
-          use Plugins::Service::CanHaveResultStep::Middleware
         end
 
         class self::Internals
@@ -92,6 +114,7 @@ module ConvenientService
             use Plugins::Result::HasInspect::Concern
 
             use Plugins::Common::HasConstructor::Concern
+            use Plugins::Common::HasConstructorWithoutInitialize::Concern
 
             use Plugins::Result::HasJSendStatusAndAttributes::Concern
           end
@@ -144,18 +167,34 @@ module ConvenientService
 
           class self::Data
             include Core
+
+            concerns do
+              use Plugins::Data::HasInspect::Concern
+            end
           end
 
           class self::Message
             include Core
+
+            concerns do
+              use Plugins::Message::HasInspect::Concern
+            end
           end
 
           class self::Code
             include Core
+
+            concerns do
+              use Plugins::Code::HasInspect::Concern
+            end
           end
 
           class self::Status
             include Core
+
+            concerns do
+              use Plugins::Status::HasInspect::Concern
+            end
           end
 
           class self::Internals
@@ -173,11 +212,34 @@ module ConvenientService
           concerns do
             use Plugins::Common::HasInternals::Concern
 
+            use Plugins::Step::CanBeCompleted::Concern
+
+            use Plugins::Step::CanBeMethodStep::Concern
+            use Plugins::Step::CanBeResultStep::Concern
+
             use Plugins::Step::HasInspect::Concern
           end
 
-          middlewares :calculate_result do
+          middlewares :service_result do
+            use Plugins::Common::NormalizesEnv::Middleware
+            use Plugins::Common::CachesReturnValue::Middleware
+
+            use Plugins::Step::CanBeResultStep::CanBeExecuted::Middleware
+            use Plugins::Step::CanBeMethodStep::CanBeExecuted::Middleware
+          end
+
+          middlewares :result do
             use Plugins::Common::NormalizesEnv::Middleware
+            use Plugins::Common::CachesReturnValue::Middleware
+          end
+
+          ##
+          # TODO: Rename.
+          #
+          middlewares :printable_service do
+            use Plugins::Common::NormalizesEnv::Middleware
+
+            use Plugins::Step::CanBeMethodStep::CanBePrinted::Middleware
           end
 
           class self::Internals

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Standard
+    module V1
+      Config = ::ConvenientService::Configs::Standard::V1
+    end
+  end
+end

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

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Configs
+    ##
+    # Default configuration for the user-defined services.
+    #
+    module Standard
+      module V1
+        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 Configs::Minimal
+
+          concerns do
+            use Plugins::Common::CachesConstructorArguments::Concern
+            use Plugins::Common::CanBeCopied::Concern
+            use Plugins::Service::CanRecalculateResult::Concern
+            use Plugins::Service::HasJSendResultShortSyntax::Concern
+            use Plugins::Service::HasJSendResultStatusCheckShortSyntax::Concern
+
+            use Plugins::Common::HasCallbacks::Concern
+            use Plugins::Common::HasAroundCallbacks::Concern
+
+            use Plugins::Service::HasMermaidFlowchart::Concern
+          end
+
+          middlewares :initialize do
+            use Plugins::Service::CollectsServicesInException::Middleware
+            use Plugins::Common::CachesConstructorArguments::Middleware
+          end
+
+          middlewares :result do
+            insert_after \
+              Plugins::Common::NormalizesEnv::Middleware,
+              Plugins::Service::CollectsServicesInException::Middleware
+
+            insert_before \
+              Plugins::Service::RaisesOnNotResultReturnValue::Middleware,
+              Plugins::Common::HasCallbacks::Middleware
+
+            insert_after \
+              Plugins::Common::HasCallbacks::Middleware,
+              Plugins::Common::HasAroundCallbacks::Middleware
+
+            ##
+            # TODO: Rewrite. This plugin does NOT do what it states. Probably I was NOT with a clear mind while writing it (facepalm).
+            #
+            # use Plugins::Service::RaisesOnDoubleResult::Middleware
+
+            insert_before \
+              Plugins::Service::RaisesOnNotResultReturnValue::Middleware,
+              Plugins::Service::SetsParentToForeignResult::Middleware
+          end
+
+          middlewares :step do
+            use Plugins::Common::HasCallbacks::Middleware
+            use Plugins::Common::HasAroundCallbacks::Middleware
+          end
+
+          middlewares :success do
+            use Plugins::Service::HasJSendResultShortSyntax::Success::Middleware
+          end
+
+          middlewares :failure do
+            use Plugins::Service::HasJSendResultShortSyntax::Failure::Middleware
+          end
+
+          middlewares :error do
+            use Plugins::Service::HasJSendResultShortSyntax::Error::Middleware
+          end
+
+          class self::Result
+            concerns do
+              use Plugins::Common::HasJSendResultDuckShortSyntax::Concern
+              use Plugins::Result::CanRecalculateResult::Concern
+
+              use Plugins::Result::CanHaveStep::Concern
+              use Plugins::Result::CanBeOwnResult::Concern
+              use Plugins::Result::CanHaveParentResult::Concern
+              use Plugins::Result::CanHaveCheckedStatus::Concern
+            end
+
+            middlewares :success? do
+              use Plugins::Result::CanHaveCheckedStatus::Middleware
+            end
+
+            middlewares :failure? do
+              use Plugins::Result::CanHaveCheckedStatus::Middleware
+            end
+
+            middlewares :error? do
+              use Plugins::Result::CanHaveCheckedStatus::Middleware
+            end
+
+            middlewares :not_success? do
+              use Plugins::Result::CanHaveCheckedStatus::Middleware
+            end
+
+            middlewares :not_failure? do
+              use Plugins::Result::CanHaveCheckedStatus::Middleware
+            end
+
+            middlewares :not_error? do
+              use Plugins::Result::CanHaveCheckedStatus::Middleware
+            end
+
+            middlewares :data do
+              use Plugins::Result::RaisesOnNotCheckedResultStatus::Middleware
+            end
+
+            middlewares :message do
+              use Plugins::Result::RaisesOnNotCheckedResultStatus::Middleware
+            end
+
+            middlewares :code do
+              use Plugins::Result::RaisesOnNotCheckedResultStatus::Middleware
+            end
+          end
+
+          class self::Step
+            concerns do
+              use Plugins::Common::HasJSendResultDuckShortSyntax::Concern
+            end
+
+            middlewares :result do
+              use Plugins::Step::CanHaveParentResult::Middleware
+            end
+          end
+
+          if Dependencies.rspec.loaded?
+            concerns do
+              insert_before 0, Plugins::Service::CanHaveStubbedResults::Concern
+            end
+
+            middlewares :result do
+              insert_after \
+                Plugins::Common::NormalizesEnv::Middleware,
+                Plugins::Service::CanHaveStubbedResults::Middleware
+
+              insert_before \
+                Plugins::Service::CanHaveStubbedResults::Middleware,
+                Plugins::Service::CountsStubbedResultsInvocations::Middleware
+            end
+
+            middlewares :result, scope: :class do
+              insert_after \
+                Plugins::Common::NormalizesEnv::Middleware,
+                Plugins::Service::CanHaveStubbedResults::Middleware
+
+              insert_before \
+                Plugins::Service::CanHaveStubbedResults::Middleware,
+                Plugins::Service::CountsStubbedResultsInvocations::Middleware
+            end
+
+            class self::Result
+              concerns do
+                use Plugins::Result::CanBeStubbedResult::Concern
+                use Plugins::Result::HasStubbedResultInvocationsCounter::Concern
+              end
+
+              middlewares :initialize do
+                insert_before \
+                  Plugins::Result::HasJSendStatusAndAttributes::Middleware,
+                  Plugins::Result::HasStubbedResultInvocationsCounter::Middleware
+              end
+            end
+          end
+        end
+        # rubocop:enable Lint/ConstantDefinitionInBlock
+      end
+    end
+  end
+end