convenient_service 0.11.0 → 0.12.0

data/lib/convenient_service/examples/standard/request_params/services/extract_params_from_path.rb

@@ -8,16 +8,6 @@ module ConvenientService
           class ExtractParamsFromPath
             include ConvenientService::Standard::Config
 
-            ##
-            # IMPORTANT:
-            #   - `CanHaveMethodSteps` is disabled in the Standard config since it causes race conditions in combination with `CanHaveStubbedResult`.
-            #   - It will be reenabled after the introduction of thread-safety specs.
-            #   - Do not use it in production yet.
-            #
-            middlewares :step, scope: :class do
-              use ConvenientService::Plugins::Service::CanHaveMethodSteps::Middleware
-            end
-
             attr_reader :request, :pattern
 
             step :parse_path, in: :request, out: :path

data/lib/convenient_service/examples/standard/request_params/services/validate_casted_params.rb

@@ -8,16 +8,6 @@ module ConvenientService
           class ValidateCastedParams
             include ConvenientService::Standard::Config
 
-            ##
-            # IMPORTANT:
-            #   - `CanHaveMethodSteps` is disabled in the Standard config since it causes race conditions in combination with `CanHaveStubbedResult`.
-            #   - It will be reenabled after the introduction of thread-safety specs.
-            #   - Do not use it in production yet.
-            #
-            middlewares :step, scope: :class do
-              use ConvenientService::Plugins::Service::CanHaveMethodSteps::Middleware
-            end
-
             attr_reader \
               :original_id,
               :original_format,

data/lib/convenient_service/examples/standard/request_params/services/validate_uncasted_params.rb

@@ -8,16 +8,6 @@ module ConvenientService
           class ValidateUncastedParams
             include ConvenientService::Standard::Config
 
-            ##
-            # IMPORTANT:
-            #   - `CanHaveMethodSteps` is disabled in the Standard config since it causes race conditions in combination with `CanHaveStubbedResult`.
-            #   - It will be reenabled after the introduction of thread-safety specs.
-            #   - Do not use it in production yet.
-            #
-            middlewares :step, scope: :class do
-              use ConvenientService::Plugins::Service::CanHaveMethodSteps::Middleware
-            end
-
             attr_reader :id, :format, :title, :description, :tags, :sources
 
             step :validate_id, in: :id

data/lib/convenient_service/examples/standard/request_params.rb

@@ -37,10 +37,10 @@ module ConvenientService
   module Examples
     module Standard
       module RequestParams
-        class << self
-          def prepare(request)
-            Services::Prepare[request: request]
-          end
+        include ConvenientService::Feature
+
+        entry :prepare do |request|
+          Services::Prepare[request: request]
         end
       end
     end

data/lib/convenient_service/feature.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Feature
+    include Support::Concern
+
+    included do
+      include Support::DependencyContainer::Entry
+      include Support::DependencyContainer::Export
+    end
+  end
+end

data/lib/convenient_service/logger.rb

@@ -23,15 +23,16 @@ module ConvenientService
       private
 
       ##
-      # NOTE: `super` is `Logger.new`.
-      # https://ruby-doc.org/stdlib-3.1.0/libdoc/logger/rdoc/Logger.html#method-c-new
+      # @internal
+      #   NOTE: `super` is `Logger.new`.
+      #   - https://ruby-doc.org/stdlib-3.1.0/libdoc/logger/rdoc/Logger.html#method-c-new
       #
       # rubocop:disable Style/GlobalStdStream
       def new
-        super(STDOUT).tap do |logger|
-          logger.level = ENV["ACTIVE_SERVICE_LOGGER_LEVEL"] || "INFO"
+        super(::STDOUT).tap do |logger|
+          logger.level = ::ENV["CONVENIENT_SERVICE_LOGGER_LEVEL"] || "INFO"
 
-          logger.formatter = colored_formatter if ENV["ACTIVE_SERVICE_LOGGER_ENABLE_COLORS"] == "true"
+          logger.formatter = colored_formatter if ::ENV["CONVENIENT_SERVICE_LOGGER_ENABLE_COLORS"] == "true"
         end
       end
       # rubocop:enable Style/GlobalStdStream

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Helpers
+      module Custom
+        # @internal
+        #   TODO: Specs.
+        #
+        class InThreads < Support::Command
+          ##
+          # @!attribute [r] n
+          #   @return [Integer] Amount of threads.
+          #
+          attr_reader :n
+
+          ##
+          # @!attribute [r] args
+          #   @return [Array<Object>] Args passed to `Thread.new`.
+          #
+          # @internal
+          #   NOTE: More info about `args`.
+          #   - https://ruby-doc.org/core-2.7.0/Thread.html#method-c-new
+          #
+          attr_reader :args
+
+          ##
+          # @!attribute [r] block
+          #   @return [Proc] Block passed to `Thread.new`.
+          #
+          # @internal
+          #   NOTE: More info about `block`.
+          #   - https://ruby-doc.org/core-2.7.0/Thread.html#method-c-new
+          #
+          attr_reader :block
+
+          ##
+          # @param n [Integer] Amount of threads.
+          # @param args [Array<Object>] Args passed to `Thread.new`.
+          # @param block [Proc, nil] Block passed to `Thread.new`.
+          # @return [void]
+          #
+          def initialize(n, *args, &block)
+            @n = n
+            @args = args
+            @block = block
+          end
+
+          ##
+          # @return [Array<Object>] Thread values. Can be any type.
+          #
+          # @internal
+          #   NOTE: `thread.value` calls `thread.join` under the hood. That is why it is missed here.
+          #   - https://ruby-doc.org/core-2.7.0/Thread.html#method-i-value
+          #
+          #   TODO: Thread pool? Why?
+          #   - https://github.com/toy/in_threads/blob/master/lib/in_threads.rb
+          #
+          def call
+            threads = []
+
+            ##
+            # NOTE: CRuby has GIL, so the specs are almost always successful for simple cases.
+            # NOTE: JRuby or TruffleRuby use real threads, so NOT thread-safe code starts to fail even for the simplest cases.
+            #
+            n.times { threads << ::Thread.new(*args, &block) }
+
+            threads.map(&:value)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Helpers
+      module Custom
+        class StubService < Support::Command
+          module Constants
+            module Triggers
+              ##
+              # @return [ConvenientService::Support::UniqueValue]
+              #
+              STUB_SERVICE = Support::UniqueValue.new("STUB_SERVICE")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/helpers/custom/stub_service/entities/stubbed_service.rb

@@ -6,7 +6,7 @@ module ConvenientService
       module Custom
         class StubService < Support::Command
           module Entities
-            class StubbedService < Support::Command
+            class StubbedService
               ##
               # @param service_class [Class]
               # @return [void]
@@ -17,8 +17,8 @@ module ConvenientService
               end
 
               ##
-              # @param args [Array]
-              # @param kwargs [Hash]
+              # @param args [Array<Object>]
+              # @param kwargs [Hash{Symbol => Object}]
               # @param block [Block]
               # @return [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::StubService]
               #
@@ -44,7 +44,7 @@ module ConvenientService
               def to(result_spec)
                 @result_spec = result_spec
 
-                service_class.commit_config!
+                service_class.commit_config!(trigger: Constants::Triggers::STUB_SERVICE)
 
                 service_class.stubbed_results[key] = result_value
 

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "stub_service/constants"
 require_relative "stub_service/entities"
 
 module ConvenientService

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

@@ -60,9 +60,9 @@ module ConvenientService
               end
 
               ##
-              # @param args [Array]
-              # @param kwargs [Hash]
-              # @param block [Proc]
+              # @param args [Array<Object>]
+              # @param kwargs [Hash{Symbol => Object}]
+              # @param block [Proc, nil]
               # @return [Object] Can be any type.
               #
               def call(*args, **kwargs, &block)

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

@@ -6,7 +6,7 @@ module ConvenientService
       module Custom
         class WrapMethod < Support::Command
           module Errors
-            class ChainAttributePreliminaryAccess < ConvenientService::Error
+            class ChainAttributePreliminaryAccess < ::ConvenientService::Error
               ##
               # @param attribute [Symbol]
               # @return [void]

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

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

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Helpers
+      module InThreads
+        def in_threads(...)
+          Custom::InThreads.call(...)
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/helpers.rb

@@ -3,6 +3,7 @@
 require_relative "helpers/custom"
 
 require_relative "helpers/ignoring_error"
+require_relative "helpers/in_threads"
 require_relative "helpers/stub_service"
 require_relative "helpers/wrap_method"
 
@@ -13,6 +14,7 @@ module ConvenientService
 
       included do
         include Helpers::IgnoringError
+        include Helpers::InThreads
         include Helpers::StubService
         include Helpers::WrapMethod
       end

data/lib/convenient_service/rspec/matchers/custom/delegate_to/entities/matcher/entities/chainings_collection/errors.rb

@@ -10,7 +10,7 @@ module ConvenientService
               module Entities
                 class ChainingsCollection
                   module Errors
-                    class CallOriginalChainingIsAlreadySet < ConvenientService::Error
+                    class CallOriginalChainingIsAlreadySet < ::ConvenientService::Error
                       def initialize
                         message = <<~TEXT
                           Call original chaining is already set.
@@ -22,7 +22,7 @@ module ConvenientService
                       end
                     end
 
-                    class ArgumentsChainingIsAlreadySet < ConvenientService::Error
+                    class ArgumentsChainingIsAlreadySet < ::ConvenientService::Error
                       def initialize
                         message = <<~TEXT
                           Arguments chaining is already set.
@@ -34,7 +34,7 @@ module ConvenientService
                       end
                     end
 
-                    class ReturnItsValueChainingIsAlreadySet < ConvenientService::Error
+                    class ReturnItsValueChainingIsAlreadySet < ::ConvenientService::Error
                       def initialize
                         message = <<~TEXT
                           Returns its value chaining is already set.

data/lib/convenient_service/rspec/matchers/custom/delegate_to/entities/matcher/entities/delegation.rb

@@ -30,9 +30,9 @@ module ConvenientService
                   ##
                   # @param object [Object] Can be any type.
                   # @param method [Symbol]
-                  # @param args [Array]
-                  # @param kwargs [Hash]
-                  # @param block [Proc]
+                  # @param args [Array<Object>]
+                  # @param kwargs [Hash{Symbol => Object}]
+                  # @param block [Proc, nil]
                   # @return [void]
                   #
                   def initialize(object:, method:, args:, kwargs:, block:)

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        class Export
+          include ConvenientService::DependencyContainer::Import
+
+          import :"constants.DEFAULT_SCOPE", from: ConvenientService::Support::DependencyContainer::Container
+          import :"commands.AssertValidContainer", from: ConvenientService::Support::DependencyContainer::Container
+          import :"commands.AssertValidScope", from: ConvenientService::Support::DependencyContainer::Container
+
+          ##
+          # @param full_name [Symbol, String]
+          # @param scope [Symbol]
+          # @return [void]
+          #
+          def initialize(full_name, scope: constants.DEFAULT_SCOPE)
+            @full_name = full_name
+            @scope = scope
+          end
+
+          ##
+          # @param container [Module]
+          # @return [Boolean]
+          #
+          def matches?(container)
+            @container = container
+
+            commands.AssertValidContainer.call(container: container)
+
+            commands.AssertValidScope.call(scope: scope)
+
+            Utils::Bool.to_bool(container.exported_methods.find_by(full_name: full_name, scope: scope))
+          end
+
+          ##
+          # @return [String]
+          #
+          def description
+            "export `#{full_name}` with scope `#{scope}`"
+          end
+
+          ##
+          # @return [String]
+          #
+          def failure_message
+            "expected `#{container}` to export `#{full_name}` with scope `#{scope}`"
+          end
+
+          ##
+          # @return [String]
+          #
+          def failure_message_when_negated
+            "expected `#{container}` NOT to export `#{full_name}` with scope `#{scope}`"
+          end
+
+          private
+
+          ##
+          # @!attribute [r] full_name
+          #   @return [Symbol, String]
+          #
+          attr_reader :full_name
+
+          ##
+          # @!attribute [r] scope
+          #   @return [Symbol]
+          #
+          attr_reader :scope
+
+          ##
+          # @!attribute [r] container
+          #   @return [Module]
+          #
+          attr_reader :container
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class Base
+            module Constants
+              module Triggers
+                ##
+                # @return [ConvenientService::Support::UniqueValue]
+                #
+                BE_RESULT = Support::UniqueValue.new("BE_RESULT")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,7 +7,7 @@ module ConvenientService
         module Results
           class Base
             module Errors
-              class InvalidStep < ConvenientService::Error
+              class InvalidStep < ::ConvenientService::Error
                 def initialize(step:)
                   message = <<~TEXT
                     Step `#{step}` is NOT valid.

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "base/commands"
+require_relative "base/constants"
 require_relative "base/errors"
 
 module ConvenientService
@@ -28,7 +29,7 @@ module ConvenientService
               ##
               # IMPORTANT: Makes `result.class.include?` from the following line idempotent.
               #
-              result.commit_config! if result.respond_to?(:commit_config!)
+              result.commit_config!(trigger: Constants::Triggers::BE_RESULT) if result.respond_to?(:commit_config!)
 
               rules << ->(result) { result.class.include?(Service::Plugins::HasResult::Entities::Result::Concern) }
 

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

@@ -5,6 +5,7 @@ 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"

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Export
+        def export(...)
+          Custom::Export.new(...)
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/matchers.rb

@@ -7,6 +7,7 @@ require_relative "matchers/be_direct_descendant_of"
 require_relative "matchers/cache_its_value"
 require_relative "matchers/call_chain_next"
 require_relative "matchers/delegate_to"
+require_relative "matchers/export"
 require_relative "matchers/extend_module"
 require_relative "matchers/have_abstract_method"
 require_relative "matchers/have_alias_method"
@@ -29,6 +30,7 @@ module ConvenientService
         include Matchers::CacheItsValue
         include Matchers::CallChainNext
         include Matchers::DelegateTo
+        include Matchers::Export
         include Matchers::ExtendModule
         include Matchers::HaveAbstractMethod
         include Matchers::HaveAliasMethod

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

@@ -2,8 +2,6 @@
 
 module ConvenientService
   module Plugins
-    Result = ::ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins
     Service = ::ConvenientService::Service::Plugins
-    Step = ::ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step::Plugins
   end
 end

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

@@ -6,8 +6,8 @@ module ConvenientService
       module CanHaveMethodSteps
         class Middleware < Core::MethodChainMiddleware
           ##
-          # @param args [Array]
-          # @param kwargs [Hash]
+          # @param args [Array<Object>]
+          # @param kwargs [Hash{Symbol => Object}]
           # @param block [Proc, nil]
           # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
           #

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

@@ -6,8 +6,8 @@ module ConvenientService
       module CanHaveResultStep
         class Middleware < Core::MethodChainMiddleware
           ##
-          # @param args [Array]
-          # @param kwargs [Hash]
+          # @param args [Array<Object>]
+          # @param kwargs [Hash{Symbol => Object}]
           # @param block [Proc, nil]
           # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
           #

data/lib/convenient_service/service/plugins/can_have_steps/concern.rb

@@ -39,8 +39,8 @@ module ConvenientService
             ##
             # Registers a step (step definition).
             #
-            # @param args [Array]
-            # @param kwargs [Hash]
+            # @param args [Array<Object>]
+            # @param kwargs [Hash{Symbol => Object}]
             # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step]
             #
             def step(*args, **kwargs)

data/lib/convenient_service/service/plugins/can_have_steps/entities/method/commands/cast_method.rb

@@ -7,45 +7,80 @@ module ConvenientService
         module Entities
           class Method
             module Commands
-              ##
-              # TODO: Abstract factory.
-              #
               class CastMethod < Support::Command
-                attr_reader :other, :options
+                ##
+                # @!attribute [r] options
+                #   @return [Object] Can be any type.
+                #
+                attr_reader :other
 
+                ##
+                # @!attribute [r] options
+                #   @return [Hash]
+                #
+                attr_reader :options
+
+                ##
+                # @param other [Object] Can be any type.
+                # @param options [Hash]
+                #
                 def initialize(other:, options:)
                   @other = other
                   @options = options
                 end
 
+                ##
+                # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method, nil]
+                #
+                # @internal
+                #   NOTE: Read more about Composition over Inheritance.
+                #   - https://en.wikipedia.org/wiki/Composition_over_inheritance
+                #
                 def call
+                  return unless factory
                   return unless key
                   return unless name
                   return unless caller
                   return unless direction
 
-                  ##
-                  # https://en.wikipedia.org/wiki/Composition_over_inheritance
-                  #
                   Method.new(key: key, name: name, caller: caller, direction: direction)
                 end
 
                 private
 
+                ##
+                # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Factories::Base]
+                #
+                def factory
+                  Utils::Object.memoize_including_falsy_values(self, :@factory) { Commands::CastMethodFactory.call(other: other) }
+                end
+
+                ##
+                # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Key]
+                #
                 def key
-                  @key ||= Commands::CastMethodKey.call(other: other, options: options)
+                  Utils::Object.memoize_including_falsy_values(self, :@key) { factory&.create_key }
                 end
 
+                ##
+                # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Name]
+                #
                 def name
-                  @name ||= Commands::CastMethodName.call(other: other, options: options)
+                  Utils::Object.memoize_including_falsy_values(self, :@name) { factory&.create_name }
                 end
 
+                ##
+                # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Callers::Base]
+                #
                 def caller
-                  @caller ||= Commands::CastMethodCaller.call(other: other, options: options)
+                  Utils::Object.memoize_including_falsy_values(self, :@caller) { factory&.create_caller }
                 end
 
+                ##
+                # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Direction::Base]
+                #
                 def direction
-                  @direction ||= Commands::CastMethodDirection.call(other: other, options: options)
+                  Utils::Object.memoize_including_falsy_values(self, :@direction) { Commands::CastMethodDirection.call(other: other, options: options) }
                 end
               end
             end