convenient_service 0.10.1 → 0.12.0

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/delegate_to/entities/matcher.rb

@@ -16,7 +16,7 @@ module ConvenientService
         # @internal
         #   specify {
         #     expect { method_class.cast(other, **options) }
-        #       .to delegate_to(ConvenientService::Service::Plugins::HasResultSteps::Entities::Method::Commands::CastMethod, :call)
+        #       .to delegate_to(ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Commands::CastMethod, :call)
         #       .with_arguments(other: other, options: options)
         #       .and_return_its_value
         #   }
@@ -24,7 +24,7 @@ module ConvenientService
         #   { method_class.cast(other, **options) }
         #   # => block_expectation
         #
-        #   ConvenientService::Service::Plugins::HasResultSteps::Entities::Method::Commands::CastMethod
+        #   ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Commands::CastMethod
         #   # => object
         #
         #   :call

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/commands/find_result_method_step.rb

@@ -31,7 +31,7 @@ module ConvenientService
                 end
 
                 ##
-                # @return [ConvenientService::Service::Plugins::HasResultSteps::Entities::Method]
+                # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
                 #
                 def call
                   return nil unless result.step
@@ -42,7 +42,7 @@ module ConvenientService
                 private
 
                 ##
-                # @param input [ConvenientService::Service::Plugins::HasResultSteps::Entities::Method]
+                # @param input [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
                 # @return [Boolean]
                 #
                 def match_service_class?(input)
@@ -50,7 +50,7 @@ module ConvenientService
                 end
 
                 ##
-                # @param input [ConvenientService::Service::Plugins::HasResultSteps::Entities::Method]
+                # @param input [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
                 # @return [Boolean]
                 #
                 def match_key?(input)
@@ -58,7 +58,7 @@ module ConvenientService
                 end
 
                 ##
-                # @param input [ConvenientService::Service::Plugins::HasResultSteps::Entities::Method]
+                # @param input [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
                 # @return [Boolean]
                 #
                 def match_value?(input)

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

@@ -23,7 +23,7 @@ module ConvenientService
                 end
 
                 ##
-                # @return [ConvenientService::Service::Plugins::HasResultSteps::Entities::Method]
+                # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
                 #
                 def call
                   return nil unless result.step
@@ -34,7 +34,7 @@ module ConvenientService
                 private
 
                 ##
-                # @param input [ConvenientService::Service::Plugins::HasResultSteps::Entities::Method]
+                # @param input [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
                 # @return [Boolean]
                 #
                 def match_service_class?(input)
@@ -42,7 +42,7 @@ module ConvenientService
                 end
 
                 ##
-                # @param input [ConvenientService::Service::Plugins::HasResultSteps::Entities::Method]
+                # @param input [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
                 # @return [Boolean]
                 #
                 def match_key?(input)
@@ -50,7 +50,7 @@ module ConvenientService
                 end
 
                 ##
-                # @param input [ConvenientService::Service::Plugins::HasResultSteps::Entities::Method]
+                # @param input [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
                 # @return [Boolean]
                 #
                 def match_value?(input)

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

@@ -31,7 +31,7 @@ module ConvenientService
                 end
 
                 ##
-                # @return [ConvenientService::Service::Plugins::HasResultSteps::Entities::Method]
+                # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
                 #
                 def call
                   return nil unless result.step

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::HasResultSteps::Entities::Step::Plugins
   end
 end

data/lib/convenient_service/service/plugins/{has_result_method_steps → can_have_method_steps}/middleware.rb

@@ -3,9 +3,14 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultMethodSteps
+      module CanHaveMethodSteps
         class Middleware < Core::MethodChainMiddleware
           ##
+          # @param args [Array<Object>]
+          # @param kwargs [Hash{Symbol => Object}]
+          # @param block [Proc, nil]
+          # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+          #
           # @internal
           #   NOTE: It is okish to assign to next method arguments here,
           #   since splat for `args` and double splat for `kwargs`
@@ -14,16 +19,21 @@ module ConvenientService
           #
           def next(*args, **kwargs, &block)
             return chain.next(*args, **kwargs, &block) unless args.first.instance_of?(::Symbol)
+            return chain.next(*args, **kwargs, &block) if args.first == :result
 
             kwargs[:in] = Utils::Array.wrap(kwargs[:in]) + [{method_name: raw(args.first)}, {organizer: :itself}]
 
-            args[0] = (args.first == :result) ? Services::RunOwnMethodInOrganizer : Services::RunMethodInOrganizer
+            args[0] = Services::RunMethodInOrganizer
 
             chain.next(*args, **kwargs, &block)
           end
 
           private
 
+          ##
+          # @param object [Object] Can be any type.
+          # @return [ConvenientService::Support::RawValue]
+          #
           def raw(object)
             Support::RawValue.wrap(object)
           end

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

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "can_have_method_steps/middleware"

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module CanHaveResultStep
+        class Middleware < Core::MethodChainMiddleware
+          ##
+          # @param args [Array<Object>]
+          # @param kwargs [Hash{Symbol => Object}]
+          # @param block [Proc, nil]
+          # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+          #
+          # @internal
+          #   NOTE: It is okish to assign to next method arguments here,
+          #   since splat for `args` and double splat for `kwargs`
+          #   always create new arrays and hashes respectively.
+          #   https://github.com/ruby/spec/blob/c7ed8478a031d0df346d222495f4b4bbb298523b/language/keyword_arguments_spec.rb#L100
+          #
+          def next(*args, **kwargs, &block)
+            return chain.next(*args, **kwargs, &block) if args.first != :result
+
+            kwargs[:in] = Utils::Array.wrap(kwargs[:in]) + [{method_name: raw(:result)}, {organizer: :itself}]
+
+            args[0] = Services::RunOwnMethodInOrganizer
+
+            chain.next(*args, **kwargs, &block)
+          end
+
+          private
+
+          ##
+          # @param object [Object] Can be any type.
+          # @return [ConvenientService::Support::RawValue]
+          #
+          def raw(object)
+            Support::RawValue.wrap(object)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "can_have_result_step/middleware"

data/lib/convenient_service/service/plugins/{has_result_steps → can_have_steps}/commands/create_step_class.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultSteps
+      module CanHaveSteps
         module Commands
           class CreateStepClass < Support::Command
             include Support::DependencyContainer::Import

data/lib/convenient_service/service/plugins/{has_result_steps → can_have_steps}/concern.rb

@@ -3,13 +3,13 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultSteps
+      module CanHaveSteps
         module Concern
           include Support::Concern
 
           instance_methods do
             ##
-            # @return [Array<ConvenientService::Service::Plugins::HasResultSteps::Entities::Step>]
+            # @return [Array<ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step>]
             #
             def steps
               internals.cache.fetch(:steps) do
@@ -25,10 +25,10 @@ module ConvenientService
             # Returns `nil` when index is out of range.
             #
             # @param index [Integer]
-            # @return [ConvenientService::Service::Plugins::HasResultSteps::Entities::Step]
+            # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step]
             #
             # @note This method was initially designed as a hook (callback trigger).
-            # @see ConvenientService::Service::Plugins::HasResultSteps::Middleware#next
+            # @see ConvenientService::Service::Plugins::CanHaveSteps::Middleware#next
             #
             def step(index)
               steps[index]
@@ -39,9 +39,9 @@ module ConvenientService
             ##
             # Registers a step (step definition).
             #
-            # @param args [Array]
-            # @param kwargs [Hash]
-            # @return [ConvenientService::Service::Plugins::HasResultSteps::Entities::Step]
+            # @param args [Array<Object>]
+            # @param kwargs [Hash{Symbol => Object}]
+            # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step]
             #
             def step(*args, **kwargs)
               step_class.new(*args, **kwargs.merge(container: self))
@@ -69,21 +69,21 @@ module ConvenientService
 
             ##
             # @param method_name [String, Symbol]
-            # @return [ConvenientService::Service::Plugins::HasResultSteps::Entities::Method::Entities::Values::Reassignment]
+            # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Values::Reassignment]
             #
             def reassign(method_name)
               Entities::Method::Entities::Values::Reassignment.new(method_name)
             end
 
             ##
-            # @return [ConvenientService::Service::Plugins::HasResultSteps::Entities::StepCollection]
+            # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::StepCollection]
             #
             def steps
               @steps ||= Entities::StepCollection.new
             end
 
             ##
-            # @return [ConvenientService::Service::Plugins::HasResultSteps::Entities::Step]
+            # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step]
             #
             def step_class
               @step_class ||= Commands::CreateStepClass.call(service_class: self)