convenient_service 0.13.0 → 0.15.0

data/lib/convenient_service/configs/minimal.rb

@@ -1,257 +0,0 @@
-# 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.
-    #
-    # @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::CanHaveFallback::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
-    #   NOTE: 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::HasJSendResult::Concern
-          use Plugins::Service::CanHaveSteps::Concern
-        end
-
-        middlewares :initialize do
-          use Plugins::Common::NormalizesEnv::Middleware
-        end
-
-        middlewares :result do
-          use Plugins::Common::NormalizesEnv::Middleware
-          use Plugins::Common::CachesReturnValue::Middleware
-
-          use Plugins::Service::RaisesOnNotResultReturnValue::Middleware
-
-          use Plugins::Service::CanHaveSteps::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
-
-          use Plugins::Service::CanHaveMethodSteps::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::Common::HasConstructorWithoutInitialize::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::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
-            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::CanBeCompleted::Concern
-
-            use Plugins::Step::CanBeMethodStep::Concern
-            use Plugins::Step::CanBeResultStep::Concern
-
-            use Plugins::Step::HasInspect::Concern
-          end
-
-          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
-            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

@@ -1,208 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Configs
-    ##
-    # Default configuration for the user-defined services.
-    #
-    module Standard
-      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::CanHaveFallback::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
-
-        ##
-        # @internal
-        #   NOTE: Check `Minimal` docs to understand why `use Plugins::Common::NormalizesEnv::Middleware` for `:fallback_result` is used in `Standard`, not in `Minimal` config.
-        #
-        middlewares :fallback_result do
-          use Plugins::Common::NormalizesEnv::Middleware
-          use Plugins::Service::CollectsServicesInException::Middleware
-          use Plugins::Common::CachesReturnValue::Middleware
-
-          use Plugins::Service::RaisesOnNotResultReturnValue::Middleware
-          use Plugins::Service::CanHaveFallback::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::CanHaveFallback::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
-            use Plugins::Step::CanHaveFallback::Concern
-          end
-
-          middlewares :result do
-            use Plugins::Step::CanHaveFallback::Middleware
-            use Plugins::Step::CanHaveParentResult::Middleware
-          end
-
-          middlewares :service_fallback_result do
-            use Plugins::Common::NormalizesEnv::Middleware
-            use Plugins::Common::CachesReturnValue::Middleware
-          end
-
-          middlewares :fallback_result do
-            use Plugins::Common::NormalizesEnv::Middleware
-            use Plugins::Common::CachesReturnValue::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

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

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "custom/ignoring_exception"
-require_relative "custom/in_threads"
-require_relative "custom/stub_service"
-require_relative "custom/wrap_method"

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

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "custom/be_descendant_of"
-require_relative "custom/be_direct_descendant_of"
-require_relative "custom/cache_its_value"
-require_relative "custom/call_chain_next"
-require_relative "custom/delegate_to"
-require_relative "custom/export"
-require_relative "custom/extend_module"
-require_relative "custom/have_abstract_method"
-require_relative "custom/have_alias_method"
-require_relative "custom/have_attr_accessor"
-require_relative "custom/have_attr_reader"
-require_relative "custom/have_attr_writer"
-require_relative "custom/include_module"
-require_relative "custom/prepend_module"
-require_relative "custom/results"
-require_relative "custom/singleton_prepend_module"

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

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module CanHaveFallback
-        class Middleware < MethodChainMiddleware
-          intended_for :fallback_result, entity: :service
-
-          ##
-          # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
-          #
-          # @note `fallback_result` is always successful, that is why its status is pre-checked.
-          #
-          # @internal
-          #   NOTE: Copy is returned to have a fresh status.
-          #
-          def next(...)
-            fallback_result = chain.next(...)
-
-            raise Exceptions::ServiceFallbackReturnValueNotSuccess.new(service: entity, result: fallback_result) unless fallback_result.success?
-
-            fallback_result.copy(overrides: {kwargs: {fallback_result: true}})
-              .tap { |result| result.success? }
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/can_have_fallback.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "can_have_fallback/concern"
-require_relative "can_have_fallback/exceptions"
-require_relative "can_have_fallback/middleware"

data/lib/convenient_service/service/plugins/can_have_steps/entities/step/plugins/can_have_fallback/concern.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module CanHaveSteps
-        module Entities
-          class Step
-            module Plugins
-              module CanHaveFallback
-                module Concern
-                  include Support::Concern
-
-                  instance_methods do
-                    ##
-                    # @return [Bool]
-                    #
-                    def fallback_step?
-                      Utils.to_bool(params.extra_kwargs[:fallback])
-                    end
-
-                    ##
-                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
-                    # @raise [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step::Exceptions::StepHasNoOrganizer]
-                    #
-                    # @note `service_fallback_result` has middlewares.
-                    #
-                    # @internal
-                    #   IMPORTANT: `service.klass.fallback_result(**input_values)` is the reason, why services should have only kwargs as arguments.
-                    #   TODO: Extract `StepDefinition`. This way `has_organizer?` check can be avoided completely.
-                    #
-                    def service_fallback_result
-                      service.klass.fallback_result(**input_values)
-                    end
-
-                    ##
-                    # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
-                    # @raise [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step::Exceptions::StepHasNoOrganizer]
-                    # @note `fallback_result` has middlewares.
-                    #
-                    def fallback_result
-                      convert_to_step_result(service_fallback_result)
-                    end
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/can_have_steps/entities/step/plugins/can_have_fallback/middleware.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module CanHaveSteps
-        module Entities
-          class Step
-            module Plugins
-              module CanHaveFallback
-                class Middleware < MethodChainMiddleware
-                  intended_for :result, entity: :step
-
-                  ##
-                  # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
-                  #
-                  def next(...)
-                    result = chain.next(...)
-
-                    return result unless entity.fallback_step?
-
-                    return result if result.success?(mark_status_as_checked: false)
-
-                    entity.fallback_result(...)
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/can_have_steps/entities/step/plugins/can_have_fallback.rb

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

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

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

data/lib/convenient_service/service/plugins/has_j_send_result_short_syntax/error/commands/assert_args_count_lower_than_three.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasJSendResultShortSyntax
-        module Error
-          module Commands
-            class AssertArgsCountLowerThanThree < Support::Command
-              attr_reader :args
-
-              def initialize(args:)
-                @args = args
-              end
-
-              def call
-                raise Exceptions::MoreThanTwoArgsArePassed.new if args.size > 2
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/has_j_send_result_short_syntax/error/commands/assert_either_args_or_kwargs_are_passed.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasJSendResultShortSyntax
-        module Error
-          module Commands
-            class AssertEitherArgsOrKwargsArePassed < Support::Command
-              attr_reader :args, :kwargs
-
-              def initialize(args:, kwargs:)
-                @args = args
-                @kwargs = kwargs
-              end
-
-              def call
-                raise Exceptions::BothArgsAndKwargsArePassed.new if args.any? && kwargs.any?
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/has_j_send_result_short_syntax/error/commands.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "commands/assert_args_count_lower_than_three"
-require_relative "commands/assert_either_args_or_kwargs_are_passed"