convenient_service 0.25.0 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a077e3ef95d8ad18dbc79399c5513f29a17491111557cfad7b446eda2bec5a8
-  data.tar.gz: 07e8481191d8a8fe51b7995d5507147755ee2676cfe51b9c5a5b11e42f5a47e2
+  metadata.gz: 2720d14bda6c640d8c9e951311f89352f93b8b02018dd6bda721741b2148d542
+  data.tar.gz: 443f18f104077ddd7c6a2c87d30ff77c6f34cc267afcbf814a8de3d3f2aff1a7
 SHA512:
-  metadata.gz: 268d3a56e8ea1e0161dde099762d3d91dcb8c85b005d2fc45e6ab9e8e622a7da15b4c6d70c45809dd8cd83787cbb042ffe71f4aaef369be4562f18d2b6b22340
-  data.tar.gz: deeb6b2c67a294a98fee2fdb409d653b4674c83c22f9e8ef413014ef42d1dfe8127e3aaecc85d020a206350607f2276e1f09575f5bb9e0888e4927a73697e513
+  metadata.gz: 27b25614536893aba9bc8f785b5360ba514bc0a23c0dafcf5f8e56df27d698f00a7791595e5fc4b8c0df9e4822fbc9520444d94caebf61926cd8e6644922705b
+  data.tar.gz: 90ab1ac704bd5094b6b4b947fe0d73be1dc45da6dc19432ebbe388782027b0cc025325e07f29bdc8d0379dd78411d206c021b090729cbd568353f8de006ba4c8

data/lib/convenient_service/aliases.rb

@@ -62,17 +62,6 @@ module ConvenientService
   #
   Command = ::ConvenientService::Support::Command
 
-  ##
-  # Convenient Service concern (Like Rails concern, but with some customizations).
-  #
-  # @api public
-  # @since 1.0.0
-  # @return [Module]
-  #
-  # @note Expected to be used from Convenient Service plugins.
-  #
-  Concern = ::ConvenientService::Support::Concern
-
   ##
   # Convenient Service dependency container.
   #

data/lib/convenient_service/common/plugins/assigns_attributes_in_constructor/using_active_model_attribute_assignment/concern.rb

@@ -11,7 +11,7 @@ module ConvenientService
       module AssignsAttributesInConstructor
         module UsingActiveModelAttributeAssignment
           module Concern
-            include Support::Concern
+            include ::ConvenientService::Concern
 
             included do |service_class|
               service_class.include ::ActiveModel::AttributeAssignment

data/lib/convenient_service/common/plugins/assigns_attributes_in_constructor/using_dry_initializer/concern.rb

@@ -11,7 +11,7 @@ module ConvenientService
       module AssignsAttributesInConstructor
         module UsingDryInitializer
           module Concern
-            include Support::Concern
+            include ::ConvenientService::Concern
 
             included do |service_class|
               service_class.extend ::Dry::Initializer

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

@@ -10,7 +10,7 @@ module ConvenientService
     module Plugins
       module CachesConstructorArguments
         module Concern
-          include Support::Concern
+          include ::ConvenientService::Concern
 
           instance_methods do
             ##

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

@@ -10,7 +10,7 @@ module ConvenientService
     module Plugins
       module CanBeCopied
         module Concern
-          include Support::Concern
+          include ::ConvenientService::Concern
 
           ##
           # @internal

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

@@ -10,7 +10,7 @@ module ConvenientService
     module Plugins
       module CanHaveCallbacks
         module Concern
-          include Support::Concern
+          include ::ConvenientService::Concern
 
           class_methods do
             ##

data/lib/convenient_service/common/plugins/can_have_callbacks/entities/type/concern.rb

@@ -12,7 +12,7 @@ module ConvenientService
         module Entities
           class Type
             module Concern
-              include Support::Concern
+              include ::ConvenientService::Concern
 
               class_methods do
                 ##

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

@@ -10,7 +10,7 @@ module ConvenientService
     module Plugins
       module CanHaveNotPassedArguments
         module Concern
-          include Support::Concern
+          include ::ConvenientService::Concern
 
           class_methods do
             private

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

@@ -10,7 +10,7 @@ module ConvenientService
     module Plugins
       module CanUtilizeFiniteLoop
         module Concern
-          include Support::Concern
+          include ::ConvenientService::Concern
 
           instance_methods do
             private

data/lib/convenient_service/common/plugins/has_attributes/using_active_model_attributes/concern.rb

@@ -11,7 +11,7 @@ module ConvenientService
       module HasAttributes
         module UsingActiveModelAttributes
           module Concern
-            include Support::Concern
+            include ::ConvenientService::Concern
 
             included do |service_class|
               service_class.include Patches::ActiveModelAttributes

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

@@ -10,7 +10,7 @@ module ConvenientService
     module Plugins
       module HasConstructor
         module Concern
-          include Support::Concern
+          include ::ConvenientService::Concern
 
           instance_methods do
             ##

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

@@ -10,7 +10,7 @@ module ConvenientService
     module Plugins
       module HasConstructorWithoutInitialize
         module Concern
-          include Support::Concern
+          include ::ConvenientService::Concern
 
           class_methods do
             ##

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

@@ -10,7 +10,7 @@ module ConvenientService
     module Plugins
       module HasInstanceProxy
         module Concern
-          include Support::Concern
+          include ::ConvenientService::Concern
 
           class_methods do
             ##

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

@@ -10,7 +10,7 @@ module ConvenientService
     module Plugins
       module HasInternals
         module Concern
-          include Support::Concern
+          include ::ConvenientService::Concern
 
           instance_methods do
             def internals

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

@@ -12,7 +12,7 @@ module ConvenientService
         module Entities
           class Internals
             module Concern
-              include Support::Concern
+              include ::ConvenientService::Concern
 
               instance_methods do
                 def ==(other)

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

@@ -18,7 +18,7 @@ module ConvenientService
               #
               module HasCache
                 module Concern
-                  include Support::Concern
+                  include ::ConvenientService::Concern
 
                   class_methods do
                     ##

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

@@ -10,7 +10,7 @@ module ConvenientService
     module Plugins
       module HasJSendResultDuckShortSyntax
         module Concern
-          include Support::Concern
+          include ::ConvenientService::Concern
 
           instance_methods do
             ##

data/lib/convenient_service/common/plugins/has_memoization/using_memo_wise/concern.rb

@@ -11,7 +11,7 @@ module ConvenientService
       module HasMemoization
         module UsingMemoWise
           module Concern
-            include Support::Concern
+            include ::ConvenientService::Concern
 
             included do
               prepend ::MemoWise

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/config/entities/option.rb

@@ -16,21 +16,26 @@ module ConvenientService
         attr_reader :name
 
         ##
-        # @!attribute [r] data
+        # @!attribute [r] details
         #   @return [Hash{Symbol => Object}]
         #
-        attr_reader :data
+        attr_reader :details
+
+        ##
+        # @return [Hash{Symbol => Object}]
+        #
+        alias_method :data, :details
 
         ##
         # @param name [Symbol]
         # @param enabled [Object] Can be any type.
-        # @param data [Hash{Symbol => Object}]
+        # @param details [Hash{Symbol => Object}]
         # @return [void]
         #
-        def initialize(name:, enabled: false, **data)
+        def initialize(name:, enabled: false, **details)
           @name = name
           @enabled = Utils.to_bool(enabled)
-          @data = data
+          @details = details
         end
 
         ##
@@ -44,15 +49,12 @@ module ConvenientService
         # @param other [Object] Can be any type.
         # @return [Boolean, nil]
         #
-        # @internal
-        #   TODO: Tests.
-        #
         def ==(other)
           return unless other.instance_of?(self.class)
 
           return false if name != other.name
           return false if enabled != other.enabled
-          return false if data != other.data
+          return false if details != other.details
 
           true
         end

data/lib/convenient_service/config/entities/option_collection.rb

@@ -8,10 +8,6 @@
 module ConvenientService
   module Config
     module Entities
-      ##
-      # @internal
-      #   TODO: Specs.
-      #
       class OptionCollection
         ##
         # @!attribute [r] options
@@ -65,6 +61,14 @@ module ConvenientService
           options[name].enabled?
         end
 
+        ##
+        # @param names [Array<Symbol>]
+        # @return [Boolean]
+        #
+        def any_enabled?(*names)
+          names.any? { |name| enabled?(name) }
+        end
+
         ##
         # @param name [Symbol]
         # @return [Boolean]

data/lib/convenient_service/core/aliases.rb

@@ -6,6 +6,17 @@
 ##
 
 module ConvenientService
+  ##
+  # Convenient Service concern (Like Rails concern, but with some customizations).
+  #
+  # @api public
+  # @since 1.0.0
+  # @return [Module]
+  #
+  # @note Expected to be used from Convenient Service plugins.
+  #
+  Concern = ::ConvenientService::Core::Entities::Config::Entities::Concerns::Usual
+
   ##
   # Base class for concern middlewares.
   #
@@ -94,4 +105,43 @@ module ConvenientService
   #   # => <Service::Result status: :success>
   #
   MethodChainMiddleware = ::ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Middlewares::Chain
+
+  ##
+  # Alias to base class for method middlewares using `chain.next`.
+  #
+  # @api public
+  # @since 1.0.0
+  # @return [Class]
+  #
+  # @example Common usage.
+  #   class Middleware < ConvenientService::MethodMiddleware
+  #     def next(*args, **kwargs, &block)
+  #       p [args, kwargs, block]
+  #
+  #       value = chain.next(*args, **kwargs, &block)
+  #
+  #       p value
+  #
+  #       value
+  #     end
+  #   end
+  #
+  #   class Service
+  #     include ConvenientService::Standard::Config
+  #
+  #     middlewares :result do
+  #       insert_before 0, Middleware
+  #     end
+  #
+  #     def result
+  #       success
+  #     end
+  #   end
+  #
+  #   Service.result
+  #   # {args: [], kwargs: {}, block: nil, entity: <Service>, method: :result}
+  #   # <Service::Result status: :success>
+  #   # => <Service::Result status: :success>
+  #
+  Middleware = MethodChainMiddleware
 end

data/lib/convenient_service/core/entities/config/commands/build_entity_from_config_option.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
+module ConvenientService
+  module Core
+    module Entities
+      class Config
+        module Commands
+          class BuildEntityFromConfigOption < Support::Command
+            ##
+            # @!attribute [r] base_entity
+            #   @return [#with]
+            #
+            attr_reader :base_entity
+
+            ##
+            # @!attribute [r] config
+            #   @return [ConvenientService::Config::Entities::Option]
+            #
+            attr_reader :option
+
+            ##
+            # @!attribute [r] detail_keys
+            #   @return [Array<Symbol>]
+            #
+            attr_reader :detail_keys
+
+            ##
+            # @param base_entity [#with]
+            # @param option [ConvenientService::Config::Entities::Option]
+            # @param detail_keys [Array<Symbol>]
+            # @return [void]
+            #
+            def initialize(base_entity:, option:, detail_keys:)
+              @base_entity = base_entity
+              @option = option
+              @detail_keys = detail_keys
+            end
+
+            ##
+            # @return [Object] Can be any type.
+            #
+            def call
+              return base_entity unless option
+              return base_entity if option.data.empty?
+              return base_entity if detail_keys.empty?
+
+              data_values = option.data.slice(*detail_keys)
+
+              return base_entity if data_values.empty?
+
+              base_entity.with(**data_values)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/core/entities/config/commands.rb

@@ -5,6 +5,7 @@
 # @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
 ##
 
+require_relative "commands/build_entity_from_config_option"
 require_relative "commands/create_entity_class"
 require_relative "commands/find_entity_class"
 require_relative "commands/find_or_create_entity_class"

data/lib/convenient_service/core/entities/config/entities/concerns/usual.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
+module ConvenientService
+  module Core
+    module Entities
+      class Config
+        module Entities
+          class Concerns
+            module Usual
+              class << self
+                ##
+                # @param mod [Module]
+                # @return [void]
+                #
+                def included(mod)
+                  mod.extend Dependencies::Extractions::ActiveSupportConcern::Concern
+
+                  mod.module_exec do
+                    class << self
+                      ##
+                      # @param option [ConvenientService::Config::Entities::Option]
+                      # @param detail_keys [Array<Symbol>]
+                      # @return [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Middlewares::Base]
+                      #
+                      def from(option, *detail_keys)
+                        ::ConvenientService::Core::Entities::Config::Commands::BuildEntityFromConfigOption.call(base_entity: self, option: option, detail_keys: detail_keys)
+                      end
+
+                      ##
+                      # @return [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::MiddlewareCreators::With]
+                      #
+                      def with(...)
+                        self
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/core/entities/config/entities/concerns.rb

@@ -7,6 +7,8 @@
 
 require_relative "concerns/entities"
 
+require_relative "concerns/usual"
+
 module ConvenientService
   module Core
     module Entities

data/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/middlewares/base/concern/class_methods.rb

@@ -25,6 +25,15 @@ module ConvenientService
                 class Base
                   module Concern
                     module ClassMethods
+                      ##
+                      # @param option [ConvenientService::Config::Entities::Option]
+                      # @param detail_keys [Array<Symbol>]
+                      # @return [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Middlewares::Base]
+                      #
+                      def from(option, *detail_keys)
+                        ::ConvenientService::Core::Entities::Config::Commands::BuildEntityFromConfigOption.call(base_entity: self, option: option, detail_keys: detail_keys)
+                      end
+
                       ##
                       # @return [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::MiddlewareCreators::With]
                       #

data/lib/convenient_service/feature/plugins/can_have_entries/concern.rb

@@ -10,7 +10,7 @@ module ConvenientService
     module Plugins
       module CanHaveEntries
         module Concern
-          include Support::Concern
+          include ::ConvenientService::Concern
 
           instance_methods do
             ##

data/lib/convenient_service/feature/plugins/can_have_rspec_stubbed_entries/concern.rb

@@ -10,7 +10,7 @@ module ConvenientService
     module Plugins
       module CanHaveRSpecStubbedEntries
         module Concern
-          include Support::Concern
+          include ::ConvenientService::Concern
 
           class_methods do
             ##

data/lib/convenient_service/feature/plugins/can_have_stubbed_entries/concern.rb

@@ -10,7 +10,7 @@ module ConvenientService
     module Plugins
       module CanHaveStubbedEntries
         module Concern
-          include Support::Concern
+          include ::ConvenientService::Concern
 
           included do
             extend ClassMethods

data/lib/convenient_service/feature/plugins/has_amazing_print_inspect/concern.rb

@@ -10,7 +10,7 @@ module ConvenientService
     module Plugins
       module HasAmazingPrintInspect
         module Concern
-          include Support::Concern
+          include ::ConvenientService::Concern
 
           instance_methods do
             ##

data/lib/convenient_service/feature/plugins/has_awesome_print_inspect/concern.rb

@@ -10,7 +10,7 @@ module ConvenientService
     module Plugins
       module HasAwesomePrintInspect
         module Concern
-          include Support::Concern
+          include ::ConvenientService::Concern
 
           instance_methods do
             ##

data/lib/convenient_service/feature/plugins/has_inspect/concern.rb

@@ -10,7 +10,7 @@ module ConvenientService
     module Plugins
       module HasInspect
         module Concern
-          include Support::Concern
+          include ::ConvenientService::Concern
 
           instance_methods do
             ##

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

@@ -19,6 +19,7 @@ module ConvenientService
             [
               :essential,
               :callbacks,
+              :strictness,
               :inspect,
               :recalculation,
               :result_parents_trace,
@@ -36,6 +37,7 @@ module ConvenientService
             [
               :essential,
               :callbacks,
+              :strictness,
               :inspect,
               :recalculation,
               :result_parents_trace,