convenient_service 0.19.1 → 0.20.0

data/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/middlewares/classic.rb

@@ -1,5 +1,10 @@
 # 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

data/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/middlewares.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 require_relative "middlewares/base"
 
 require_relative "middlewares/classic"

data/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/stack.rb

@@ -1,5 +1,10 @@
 # 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
@@ -13,18 +18,34 @@ module ConvenientService
               #
               class Stack
                 ##
-                # @overload initialize(name:)
+                # @!attribute [r] klass
+                #   @return [ConvenientService::Service]
+                #
+                attr_reader :klass
+
+                ##
+                # @overload initialize(klass:, name:)
+                #   @param klass [Class]
                 #   @param name [String]
                 #   @return [void]
                 #
-                # @overload initialize(plain_stack:)
+                # @overload initialize(klass:, plain_stack:)
+                #   @param klass [Class]
                 #   @param name [ConvenientService::Support::Middleware::StackBuilder]
                 #   @return [void]
                 #
-                def initialize(name: nil, plain_stack: nil)
+                def initialize(klass:, name: nil, plain_stack: nil)
+                  @klass = klass
                   @plain_stack = plain_stack || Support::Middleware::StackBuilder.new(name: name)
                 end
 
+                ##
+                # @return [Set]
+                #
+                def options
+                  klass.options
+                end
+
                 ##
                 # @return [String]
                 #
@@ -36,27 +57,26 @@ module ConvenientService
                 # @return [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Stack]
                 #
                 def dup
-                  self.class.new(plain_stack: plain_stack.dup)
+                  self.class.new(klass: klass, plain_stack: plain_stack.dup)
                 end
 
                 ##
                 # @param env [Hash]
+                # @param original [Proc]
                 # @return [Object] Can be any type.
                 #
                 # @see https://github.com/marian13/ruby-middleware/blob/v0.4.2/lib/middleware/builder.rb#L132
                 #
-                def call(env)
-                  plain_stack.call(env)
+                def call_with_original(env, original)
+                  plain_stack.call_with_original(env, original)
                 end
 
                 ##
                 # @param middleware [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Middlewares::Base]
-                # @param args [Array<Object>]
-                # @param block [Proc, nil]
                 # @return [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Stack]
                 #
-                def unshift(middleware, *args, &block)
-                  plain_stack.unshift(middleware, *args, &block)
+                def unshift(middleware)
+                  plain_stack.unshift(middleware)
 
                   self
                 end
@@ -69,14 +89,12 @@ module ConvenientService
                 ##
                 # @param index_or_middleware [Integer, ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Middlewares::Base]
                 # @param middleware [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Middlewares::Base]
-                # @param args [Array<Object>]
-                # @param block [Proc, nil]
                 # @return [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Stack]
                 #
                 # @see https://github.com/marian13/ruby-middleware/blob/v0.4.2/lib/middleware/builder.rb#L88
                 #
-                def insert(index_or_middleware, middleware, *args, &block)
-                  plain_stack.insert(index_or_middleware, middleware, *args, &block)
+                def insert(index_or_middleware, middleware)
+                  plain_stack.insert(index_or_middleware, middleware)
 
                   self
                 end
@@ -90,42 +108,36 @@ module ConvenientService
                 ##
                 # @param index_or_middleware [Integer, ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Middlewares::Base]
                 # @param middleware [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Middlewares::Base]
-                # @param args [Array<Object>]
-                # @param block [Proc, nil]
                 # @return [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Stack]
                 #
                 # @see https://github.com/marian13/ruby-middleware/blob/v0.4.2/lib/middleware/builder.rb#L97
                 #
-                def insert_after(index_or_middleware, middleware, *args, &block)
-                  plain_stack.insert_after(index_or_middleware, middleware, *args, &block)
+                def insert_after(index_or_middleware, middleware)
+                  plain_stack.insert_after(index_or_middleware, middleware)
 
                   self
                 end
 
                 ##
                 # @param middleware [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Middlewares::Base]
-                # @param args [Array<Object>]
-                # @param block [Proc, nil]
                 # @return [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Stack]
                 #
                 # @see https://github.com/marian13/ruby-middleware/blob/v0.4.2/lib/middleware/builder.rb#L104
                 #
-                def insert_before_each(middleware, *args, &block)
-                  plain_stack.insert_before_each(middleware, *args, &block)
+                def insert_before_each(middleware)
+                  plain_stack.insert_before_each(middleware)
 
                   self
                 end
 
                 ##
                 # @param middleware [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Middlewares::Base]
-                # @param args [Array<Object>]
-                # @param block [Proc, nil]
                 # @return [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Stack]
                 #
                 # @see https://github.com/marian13/ruby-middleware/blob/v0.4.2/lib/middleware/builder.rb#L111
                 #
-                def insert_after_each(middleware, *args, &block)
-                  plain_stack.insert_after_each(middleware, *args, &block)
+                def insert_after_each(middleware)
+                  plain_stack.insert_after_each(middleware)
 
                   self
                 end
@@ -133,14 +145,12 @@ module ConvenientService
                 ##
                 # @param index_or_middleware [Integer, ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Middlewares::Base]
                 # @param middleware [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Middlewares::Base]
-                # @param args [Array<Object>]
-                # @param block [Proc, nil]
                 # @return [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Stack]
                 #
                 # @see https://github.com/marian13/ruby-middleware/blob/v0.4.2/lib/middleware/builder.rb#L118
                 #
-                def replace(index_or_middleware, middleware, *args, &block)
-                  plain_stack.replace(index_or_middleware, middleware, *args, &block)
+                def replace(index_or_middleware, middleware)
+                  plain_stack.replace(index_or_middleware, middleware)
 
                   self
                 end
@@ -164,22 +174,23 @@ module ConvenientService
 
                 ##
                 # @param middleware [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Middlewares::Base]
-                # @param args [Array<Object>]
-                # @param block [Proc, nil]
                 # @return [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Stack]
                 #
                 # @see https://github.com/marian13/ruby-middleware/blob/v0.4.2/lib/middleware/builder.rb#L76
                 #
-                def use(middleware, *args, &block)
-                  plain_stack.use(middleware, *args, &block)
+                def use(middleware)
+                  plain_stack.use(middleware)
 
                   self
                 end
 
+                ##
+                # @return [ConvenientService::Core::Entities::Config::Entities::Concerns::Entities::Stack]
+                #
+                alias_method :append, :use
+
                 ##
                 # @param middleware [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Middlewares::Base]
-                # @param args [Array<Object>]
-                # @param block [Proc, nil]
                 # @return [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Stack]
                 #
                 # @note `observe` exists only for testing purposes. Do NOT use it in production code.
@@ -187,22 +198,20 @@ module ConvenientService
                 # @internal
                 #   TODO: Raise if middleware is NOT used yet.
                 #
-                def observe(middleware, *args, &block)
-                  plain_stack.replace(middleware, middleware.observable, *args, &block)
+                def observe(middleware)
+                  plain_stack.replace(middleware, middleware.observable)
 
                   self
                 end
 
                 ##
                 # @param middleware [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Middlewares::Base]
-                # @param args [Array<Object>]
-                # @param block [Proc, nil]
                 # @return [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Stack]
                 #
                 # @note `use_and_observe` exists only for testing purposes. Do NOT use it in production code.
                 #
-                def use_and_observe(middleware, *args, &block)
-                  plain_stack.use(middleware.observable, *args, &block)
+                def use_and_observe(middleware)
+                  plain_stack.use(middleware.observable)
 
                   self
                 end
@@ -211,7 +220,15 @@ module ConvenientService
                 # @return [Boolean]
                 #
                 def empty?
-                  to_a.empty?
+                  plain_stack.empty?
+                end
+
+                ##
+                # @param middleware [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Middlewares::Base]
+                # @return [Boolean]
+                #
+                def has?(middleware)
+                  plain_stack.has?(middleware)
                 end
 
                 ##
@@ -221,6 +238,7 @@ module ConvenientService
                 def ==(other)
                   return unless other.instance_of?(self.class)
 
+                  return false if klass != other.klass
                   return false if plain_stack != other.plain_stack
 
                   true

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

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 require_relative "entities/caller"
 require_relative "entities/container"
 require_relative "entities/middleware_creators"

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

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 require_relative "method_middlewares/commands"
 require_relative "method_middlewares/entities"
 
@@ -52,6 +57,20 @@ module ConvenientService
               self.defined? && !super_method_defined?
             end
 
+            ##
+            # @return [Boolean]
+            #
+            def any?
+              !stack.empty?
+            end
+
+            ##
+            # @return [Boolean]
+            #
+            def none?
+              stack.empty?
+            end
+
             ##
             # @param configuration_block [Proc]
             # @return [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares]
@@ -68,7 +87,16 @@ module ConvenientService
             # @return [Boolean]
             #
             def define!
-              caller.define_method_middlewares_caller!(scope, method, container)
+              caller.define_method_callers!(scope, method, container)
+            end
+
+            ##
+            # @note Works in a similar way as `Kernel.require`.
+            #
+            # @return [Boolean]
+            #
+            def undefine!
+              caller.undefine_method_callers!(scope, method, container)
             end
 
             ##
@@ -82,7 +110,7 @@ module ConvenientService
             #   TODO: Measure before any rewrite.
             #
             def call(env, original_method)
-              stack.dup.use(original_method).call(env.merge(method: method))
+              stack.call_with_original(env.merge(method: method), original_method)
             end
 
             ##
@@ -117,7 +145,7 @@ module ConvenientService
             # @return [Array<ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Middleware>]
             #
             def to_a
-              stack.to_a.map(&:first)
+              stack.to_a
             end
 
             protected
@@ -144,7 +172,7 @@ module ConvenientService
             # @return [ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Stack]
             #
             def stack
-              @stack ||= Entities::Stack.new(name: stack_name)
+              @stack ||= Entities::Stack.new(name: stack_name, klass: klass)
             end
 
             private

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

@@ -1,4 +1,9 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 require_relative "entities/concerns"
 require_relative "entities/method_middlewares"

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

@@ -1,5 +1,10 @@
 # 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

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

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 require_relative "config/commands"
 require_relative "config/entities"
 require_relative "config/exceptions"
@@ -14,12 +19,23 @@ module ConvenientService
         #
         attr_reader :klass
 
+        ##
+        # @!attribute [r] lock
+        #   @return [Mutex]
+        #
+        attr_reader :lock
+
         ##
         # @param klass [Class]
         # @return [void]
         #
         def initialize(klass:)
           @klass = klass
+
+          ##
+          # IMPORTANT: Intentionally initializes `lock` in constructor to ensure thread-safety.
+          #
+          @lock = ::Mutex.new
         end
 
         ##
@@ -92,18 +108,59 @@ module ConvenientService
         #   middlewares(:result, scope: :class, &configuration_block)
         #
         def middlewares(method, scope: :instance, &configuration_block)
-          @middlewares ||= {}
-          @middlewares[scope] ||= {}
+          @middlewares ||= Support::Cache.backed_by(:hash).new
 
-          if configuration_block
-            assert_not_committed!
+          scoped_middlewares = @middlewares.scope(scope)
+          method_middlewares = scoped_middlewares.get(method) || Entities::MethodMiddlewares.new(scope: scope, method: method, klass: klass)
 
-            @middlewares[scope][method] ||= Entities::MethodMiddlewares.new(scope: scope, method: method, klass: klass)
-            @middlewares[scope][method].configure(&configuration_block)
-            @middlewares[scope][method].define!
+          return method_middlewares unless configuration_block
+
+          assert_not_committed!
+
+          method_middlewares.configure(&configuration_block)
+
+          if method_middlewares.any?
+            method_middlewares.define!
+
+            scoped_middlewares.set(method, method_middlewares)
+          else
+            method_middlewares.undefine!
+
+            scoped_middlewares.delete(method)
           end
 
-          @middlewares[scope][method] || Entities::MethodMiddlewares.new(scope: scope, method: method, klass: klass)
+          method_middlewares
+        end
+
+        ##
+        # This method is intended to be used only inside config `included` blocks.
+        #
+        # @return [ConvenientService::Config::Entities::OptionCollection]
+        #
+        # @internal
+        #   NOTE: `namespace` is defined only for classes that were created by `Config#entity`.
+        #
+        def options
+          @options ||= Utils.safe_send(klass, :namespace)&.__convenient_service_config__&.options || ConvenientService::Config.empty_options
+        end
+
+        ##
+        # This method is intended to be used only inside config `included` blocks.
+        #
+        # @param name [Symbol]
+        # @param configuration_block [Proc, nil]
+        # @return [Class, nil]
+        #
+        def entity(name, &configuration_block)
+          return Commands::FindEntityClass.call(config: self, name: name) unless configuration_block
+
+          assert_not_committed!
+
+          entity_class = Commands::FindOrCreateEntityClass.call(config: self, name: name)
+
+          entity_class.class_exec(&configuration_block)
+
+          entity_class
         end
 
         ##

data/lib/convenient_service/core/entities.rb

@@ -1,3 +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 "entities/config"

data/lib/convenient_service/core.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 require_relative "core/concern"
 
 require_relative "core/constants"
@@ -15,8 +20,81 @@ module ConvenientService
     # @internal
     #   TODO: Allow to include `Core` only to classes?
     #
-    included do |entity_class|
-      entity_class.include Concern
+    included do
+      include Concern
+
+      ##
+      # IMPORTANT: Intentionally initializes config (and its mutex) to ensure thread-safety.
+      #
+      __convenient_service_config__
+    end
+
+    class << self
+      ##
+      # Checks whether an object is a Convenient Service entity class.
+      #
+      # @api public
+      #
+      # @param entity_class [Object] Can be any type.
+      # @return [Boolean]
+      #
+      # @example Simple usage.
+      #   class Service
+      #     include ConvenientService::Standard::Config
+      #
+      #     def result
+      #       success
+      #     end
+      #   end
+      #
+      #   service = Service.new
+      #
+      #   ConvenientService::Core.entity_class?(Service)
+      #   # => true
+      #
+      #   ConvenientService::Core.entity_class?(service)
+      #   # => false
+      #
+      #   ConvenientService::Core.entity_class?(42)
+      #   # => false
+      #
+      def entity_class?(entity_class)
+        return false unless entity_class.instance_of?(::Class)
+
+        entity_class.include?(::ConvenientService::Core)
+      end
+
+      ##
+      # Checks whether an object is a Convenient Service entity instance.
+      #
+      # @api public
+      #
+      # @param entity [Object] Can be any type.
+      # @return [Boolean]
+      #
+      # @example Simple usage.
+      #   class Service
+      #     include ConvenientService::Standard::Config
+      #
+      #     def result
+      #       success
+      #     end
+      #   end
+      #
+      #   service = Service.new
+      #
+      #   ConvenientService::Core.entity?(service)
+      #   # => true
+      #
+      #   ConvenientService::Core.entity?(Service)
+      #   # => false
+      #
+      #   ConvenientService::Core.entity?(42)
+      #   # => false
+      #
+      def entity?(entity)
+        entity_class?(entity.class)
+      end
     end
   end
 end

data/lib/convenient_service/dependencies/built_in.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 ##
 # This file loads built-in dependencies (from Ruby standard library).
 #
@@ -9,23 +14,29 @@
 
 ##
 # @internal
-#   - https://ruby-doc.org/stdlib-2.7.0/libdoc/forwardable/rdoc/Forwardable.html
-#   - https://github.com/ruby/forwardable
+#   - https://ruby-doc.org/stdlib-2.7.0/libdoc/pathname/rdoc/Pathname.html
+#   - https://github.com/ruby/pathname
 #
-require "forwardable"
+# @!visibility private
+#
+require "pathname"
 
 ##
 # @internal
-#   - https://ruby-doc.org/stdlib-2.7.0/libdoc/erb/rdoc/ERB.html
-#   - https://github.com/ruby/erb
+#   - https://ruby-doc.org/stdlib-2.7.0/libdoc/forwardable/rdoc/Forwardable.html
+#   - https://github.com/ruby/forwardable
+#
+# @!visibility private
 #
-require "erb"
+require "forwardable"
 
 ##
 # @internal
 #   - https://ruby-doc.org/stdlib-2.7.0/libdoc/logger/rdoc/Logger.html
 #   - https://github.com/ruby/logger
 #
+# @!visibility private
+#
 require "logger"
 
 ##
@@ -34,6 +45,8 @@ require "logger"
 #   - https://github.com/rubygems/rubygems
 #   - https://github.com/rubygems/rubygems/blob/master/lib/rubygems/version.rb
 #
+# @!visibility private
+#
 require "rubygems"
 
 ##
@@ -41,6 +54,8 @@ require "rubygems"
 #   - https://ruby-doc.org/stdlib-2.7.0/libdoc/singleton/rdoc/Singleton.html
 #   - https://github.com/ruby/singleton
 #
+# @!visibility private
+#
 require "singleton"
 
 ##
@@ -48,4 +63,6 @@ require "singleton"
 #   - https://ruby-doc.org/core-2.7.0/Mutex.html
 #   - https://docs.ruby-lang.org/en/2.1.0/Mutex.html
 #
+# @!visibility private
+#
 require "thread"