convenient_service 0.14.0 → 0.16.0

data/lib/convenient_service/feature/configs/aliases.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Feature
+    module Standard
+      Config = ::ConvenientService::Feature::Configs::Standard
+    end
+  end
+end

data/lib/convenient_service/feature/configs/standard.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Feature
+    module Configs
+      ##
+      # Default configuration for the user-defined features.
+      #
+      module Standard
+        include Support::Concern
+
+        included do
+          include Core
+
+          concerns do
+            use ConvenientService::Plugins::Feature::CanHaveEntries::Concern
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/feature/configs.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "configs/standard"
+
+require_relative "configs/aliases"

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Plugins
+    Feature = ::ConvenientService::Feature::Plugins
+  end
+end

data/lib/convenient_service/feature/plugins/can_have_entries/commands/define_entry.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Feature
+    module Plugins
+      module CanHaveEntries
+        module Commands
+          class DefineEntry < Support::Command
+            ##
+            # @!attribute [r] feature_class
+            #   @return [Class]
+            #
+            attr_reader :feature_class
+
+            ##
+            # @!attribute [r] name
+            #   @return [String, Symbol]
+            #
+            attr_reader :name
+
+            ##
+            # @!attribute [r] body
+            #   @return [Proc]
+            #
+            attr_reader :body
+
+            ##
+            # @param feature_class [Class]
+            # @param name [String, Symbol]
+            # @param body [Proc]
+            #
+            def initialize(feature_class:, name:, body:)
+              @feature_class = feature_class
+              @name = name
+              @body = body
+            end
+
+            ##
+            # @return [String, Symbol]
+            #
+            def call
+              ##
+              # NOTE: Just `feature_class.define_singleton_method` does NOT create a closure for `name`.
+              # That is why `feature_class.class_exec` wrapper is required.
+              #
+              feature_class.class_exec(name) do |name|
+                define_singleton_method(name) { |*args, **kwargs, &block| new.public_send(name, *args, **kwargs, &block) }
+              end
+
+              if body
+                feature_class.define_method(name, &body)
+              else
+                feature_class.define_method(name) { raise ::ConvenientService::Feature::Plugins::CanHaveEntries::Exceptions::NotDefinedEntryMethod.new(name: __method__, feature: self) }
+              end
+
+              name
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "commands/define_entry"

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Feature
+    module Plugins
+      module CanHaveEntries
+        module Concern
+          include Support::Concern
+
+          class_methods do
+            ##
+            # @param name [String, Symbol]
+            # @param body [Proc, nil]
+            # @return [String, Symbol]
+            #
+            def entry(name, &body)
+              Commands::DefineEntry.call(feature_class: self, name: name, body: body)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Feature
+    module Plugins
+      module CanHaveEntries
+        module Exceptions
+          class NotDefinedEntryMethod < ::ConvenientService::Exception
+            def initialize(name:, feature:)
+              message = <<~TEXT
+                Entry for `#{name}` is registered inside `#{feature.class}` feature, but its corresponding method is NOT defined.
+
+                Did you forget to define it? For example:
+
+                class #{feature.class}
+                  entry :#{name}
+
+                  # ...
+
+                  def #{name}
+                    # ...
+                  end
+
+                  # ...
+                end
+              TEXT
+
+              super(message)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

data/lib/convenient_service/feature/plugins.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "plugins/can_have_entries"
+
+require_relative "plugins/aliases"

data/lib/convenient_service/feature.rb

@@ -1,11 +1,4 @@
 # frozen_string_literal: true
 
-module ConvenientService
-  module Feature
-    include Support::Concern
-
-    included do
-      include Support::DependencyContainer::Entry
-    end
-  end
-end
+require_relative "feature/plugins"
+require_relative "feature/configs"

data/lib/convenient_service/rspec/helpers/{custom → classes}/stub_service/constants.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module RSpec
     module Helpers
-      module Custom
+      module Classes
         class StubService < Support::Command
           module Constants
             module Triggers

data/lib/convenient_service/rspec/helpers/{custom → classes}/stub_service/entities/result_spec.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module RSpec
     module Helpers
-      module Custom
+      module Classes
         ##
         # @internal
         #   TODO: Specs.
@@ -26,7 +26,7 @@ module ConvenientService
 
               ##
               # @param service_class [Class]
-              # @return [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::ResultSpec]
+              # @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::ResultSpec]
               # @since 0.1.0
               #
               def for(service_class)
@@ -35,7 +35,7 @@ module ConvenientService
 
               ##
               # @param data [Hash]
-              # @return [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::ResultSpec]
+              # @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::ResultSpec]
               # @since 0.1.0
               #
               def with_data(data)
@@ -46,7 +46,7 @@ module ConvenientService
 
               ##
               # @param message [String]
-              # @return [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::ResultSpec]
+              # @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::ResultSpec]
               # @since 0.1.0
               #
               def with_message(message)
@@ -57,7 +57,7 @@ module ConvenientService
 
               ##
               # @param code [String]
-              # @return [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::ResultSpec]
+              # @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::ResultSpec]
               # @since 0.1.0
               #
               def with_code(code)
@@ -68,7 +68,7 @@ module ConvenientService
 
               ##
               # @param data [Hash]
-              # @return [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::ResultSpec]
+              # @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::ResultSpec]
               # @since 0.1.0
               #
               def and_data(data)
@@ -79,7 +79,7 @@ module ConvenientService
 
               ##
               # @param message [String]
-              # @return [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::ResultSpec]
+              # @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::ResultSpec]
               # @since 0.1.0
               #
               def and_message(message)
@@ -90,7 +90,7 @@ module ConvenientService
 
               ##
               # @param code [String]
-              # @return [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::ResultSpec]
+              # @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::ResultSpec]
               # @since 0.1.0
               #
               def and_code(code)

data/lib/convenient_service/rspec/helpers/{custom → classes}/stub_service/entities/stubbed_service.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module RSpec
     module Helpers
-      module Custom
+      module Classes
         class StubService < Support::Command
           module Entities
             class StubbedService
@@ -31,7 +31,7 @@ module ConvenientService
               end
 
               ##
-              # @return [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::StubService]
+              # @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::StubService]
               #
               def with_arguments(...)
                 @arguments = Support::Arguments.new(...)
@@ -40,7 +40,7 @@ module ConvenientService
               end
 
               ##
-              # @return [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::StubService]
+              # @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::StubService]
               #
               def without_arguments
                 @arguments = Support::Arguments.null_arguments
@@ -49,8 +49,8 @@ module ConvenientService
               end
 
               ##
-              # @param result_spec [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::ResultSpec]
-              # @return [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::StubService]
+              # @param result_spec [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::ResultSpec]
+              # @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::StubService]
               #
               def to(result_spec)
                 @result_spec = result_spec
@@ -78,7 +78,7 @@ module ConvenientService
 
               ##
               # @!attribute [r] result_spec
-              #   @return [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::ResultSpec]
+              #   @return [ConvenientService::RSpec::Helpers::Classes::StubService::Entities::ResultSpec]
               #
               attr_reader :result_spec
 

data/lib/convenient_service/rspec/helpers/{custom → classes}/stub_service.rb

@@ -6,7 +6,7 @@ require_relative "stub_service/entities"
 module ConvenientService
   module RSpec
     module Helpers
-      module Custom
+      module Classes
         ##
         # TODO: Specs.
         #

data/lib/convenient_service/rspec/helpers/{custom → classes}/wrap_method/entities/wrapped_method.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module RSpec
     module Helpers
-      module Custom
+      module Classes
         class WrapMethod < Support::Command
           module Entities
             ##
@@ -129,7 +129,7 @@ module ConvenientService
 
               ##
               # @return [Object] Can be any type.
-              # @raise [ConvenientService::RSpec::Helpers::Custom::WrapMethod::Exceptions::ChainAttributePreliminaryAccess]
+              # @raise [ConvenientService::RSpec::Helpers::Classes::WrapMethod::Exceptions::ChainAttributePreliminaryAccess]
               #
               def chain_value
                 raise Exceptions::ChainAttributePreliminaryAccess.new(attribute: :value) unless chain_called?
@@ -139,7 +139,7 @@ module ConvenientService
 
               ##
               # @return [Array]
-              # @raise [ConvenientService::RSpec::Helpers::Custom::WrapMethod::Exceptions::ChainAttributePreliminaryAccess]
+              # @raise [ConvenientService::RSpec::Helpers::Classes::WrapMethod::Exceptions::ChainAttributePreliminaryAccess]
               #
               def chain_args
                 raise Exceptions::ChainAttributePreliminaryAccess.new(attribute: :args) unless chain_called?
@@ -149,7 +149,7 @@ module ConvenientService
 
               ##
               # @return [Hash]
-              # @raise [ConvenientService::RSpec::Helpers::Custom::WrapMethod::Exceptions::ChainAttributePreliminaryAccess]
+              # @raise [ConvenientService::RSpec::Helpers::Classes::WrapMethod::Exceptions::ChainAttributePreliminaryAccess]
               #
               def chain_kwargs
                 raise Exceptions::ChainAttributePreliminaryAccess.new(attribute: :kwargs) unless chain_called?
@@ -159,7 +159,7 @@ module ConvenientService
 
               ##
               # @return [Proc, nil]
-              # @raise [ConvenientService::RSpec::Helpers::Custom::WrapMethod::Exceptions::ChainAttributePreliminaryAccess]
+              # @raise [ConvenientService::RSpec::Helpers::Classes::WrapMethod::Exceptions::ChainAttributePreliminaryAccess]
               #
               def chain_block
                 raise Exceptions::ChainAttributePreliminaryAccess.new(attribute: :block) unless chain_called?
@@ -169,7 +169,7 @@ module ConvenientService
 
               ##
               # @return [StandardError, nil]
-              # @raise [ConvenientService::RSpec::Helpers::Custom::WrapMethod::Exceptions::ChainAttributePreliminaryAccess]
+              # @raise [ConvenientService::RSpec::Helpers::Classes::WrapMethod::Exceptions::ChainAttributePreliminaryAccess]
               #
               def chain_exception
                 raise Exceptions::ChainAttributePreliminaryAccess.new(attribute: :exception) unless chain_called?

data/lib/convenient_service/rspec/helpers/{custom → classes}/wrap_method/exceptions.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module RSpec
     module Helpers
-      module Custom
+      module Classes
         class WrapMethod < Support::Command
           module Exceptions
             class ChainAttributePreliminaryAccess < ::ConvenientService::Exception

data/lib/convenient_service/rspec/helpers/{custom → classes}/wrap_method.rb

@@ -6,7 +6,7 @@ require_relative "wrap_method/exceptions"
 module ConvenientService
   module RSpec
     module Helpers
-      module Custom
+      module Classes
         class WrapMethod < Support::Command
           ##
           # @!attribute [r] entity
@@ -39,7 +39,7 @@ module ConvenientService
           end
 
           ##
-          # @return [ConvenientService::RSpec::Helpers::Custom::Entities::WrappedMethod]
+          # @return [ConvenientService::RSpec::Helpers::Classes::Entities::WrappedMethod]
           #
           def call
             Entities::WrappedMethod.new(entity: entity, method: method, observe_middleware: observe_middleware)

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

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "classes/stub_service"
+require_relative "classes/wrap_method"

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

@@ -5,7 +5,7 @@ module ConvenientService
     module Helpers
       module IgnoringException
         def ignoring_exception(...)
-          Custom::IgnoringException.call(...)
+          RSpec::PrimitiveHelpers::Classes::IgnoringException.call(...)
         end
       end
     end

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

@@ -5,23 +5,23 @@ module ConvenientService
     module Helpers
       module StubService
         def stub_service(...)
-          Custom::StubService.call(...)
+          Classes::StubService.call(...)
         end
 
         def return_result(status)
-          Custom::StubService::Entities::ResultSpec.new(status: status)
+          Classes::StubService::Entities::ResultSpec.new(status: status)
         end
 
         def return_success
-          Custom::StubService::Entities::ResultSpec.new(status: :success)
+          Classes::StubService::Entities::ResultSpec.new(status: :success)
         end
 
         def return_failure
-          Custom::StubService::Entities::ResultSpec.new(status: :failure)
+          Classes::StubService::Entities::ResultSpec.new(status: :failure)
         end
 
         def return_error
-          Custom::StubService::Entities::ResultSpec.new(status: :error)
+          Classes::StubService::Entities::ResultSpec.new(status: :error)
         end
       end
     end

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

@@ -5,7 +5,7 @@ module ConvenientService
     module Helpers
       module WrapMethod
         def wrap_method(...)
-          Custom::WrapMethod.call(...)
+          Classes::WrapMethod.call(...)
         end
       end
     end

data/lib/convenient_service/rspec/helpers.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "helpers/custom"
+require_relative "helpers/classes"
 
 require_relative "helpers/ignoring_exception"
-require_relative "helpers/in_threads"
 require_relative "helpers/stub_service"
 require_relative "helpers/wrap_method"
 
@@ -13,10 +12,9 @@ module ConvenientService
       include Support::Concern
 
       included do
-        include Helpers::IgnoringException
-        include Helpers::InThreads
-        include Helpers::StubService
-        include Helpers::WrapMethod
+        include IgnoringException
+        include StubService
+        include WrapMethod
       end
     end
   end

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

@@ -5,7 +5,7 @@ module ConvenientService
     module Matchers
       module CallChainNext
         def call_chain_next(...)
-          Custom::CallChainNext.new(...)
+          Classes::CallChainNext.new(...)
         end
       end
     end

data/lib/convenient_service/rspec/matchers/{custom → classes}/call_chain_next.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module RSpec
     module Matchers
-      module Custom
+      module Classes
         ##
         # @example Common usage.
         #   expect { method.call }
@@ -120,8 +120,8 @@ module ConvenientService
           end
 
           ##
-          # @param method [ConvenientService::RSpec::Helpers::Custom::Entities::WrappedMethod]
-          # @return [ConvenientService::RSpec::Matchers::Custom::CallChainNext]
+          # @param method [ConvenientService::RSpec::Helpers::Classes::Entities::WrappedMethod]
+          # @return [ConvenientService::RSpec::Matchers::Classes::CallChainNext]
           #
           def on(method)
             method.reset!
@@ -135,7 +135,7 @@ module ConvenientService
           # @param args[Array<Object>]
           # @param kwargs [Hash{Symbol => Object}]
           # @param block [Proc, nil]
-          # @return [ConvenientService::RSpec::Matchers::Custom::CallChainNext]
+          # @return [ConvenientService::RSpec::Matchers::Classes::CallChainNext]
           #
           def with_arguments(*args, **kwargs, &block)
             chain[:with_arguments] = {args: args, kwargs: kwargs, block: block}
@@ -144,7 +144,7 @@ module ConvenientService
           end
 
           ##
-          # @return [ConvenientService::RSpec::Matchers::Custom::CallChainNext]
+          # @return [ConvenientService::RSpec::Matchers::Classes::CallChainNext]
           #
           def with_any_arguments
             chain.delete(:with_arguments)
@@ -153,7 +153,7 @@ module ConvenientService
           end
 
           ##
-          # @return [ConvenientService::RSpec::Matchers::Custom::CallChainNext]
+          # @return [ConvenientService::RSpec::Matchers::Classes::CallChainNext]
           #
           def without_arguments
             chain[:with_arguments] = {args: [], kwargs: {}, block: nil}
@@ -162,7 +162,7 @@ module ConvenientService
           end
 
           ##
-          # @return [ConvenientService::RSpec::Matchers::Custom::CallChainNext]
+          # @return [ConvenientService::RSpec::Matchers::Classes::CallChainNext]
           #
           def and_return_its_value
             chain[:and_return_its_value] = true
@@ -200,7 +200,7 @@ module ConvenientService
           end
 
           ##
-          # @return [ConvenientService::RSpec::Helpers::Custom::Entities::WrappedMethod]
+          # @return [ConvenientService::RSpec::Helpers::Classes::Entities::WrappedMethod]
           #
           def method
             @method ||= chain[:method]

data/lib/convenient_service/rspec/matchers/{custom → classes}/export.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module RSpec
     module Matchers
-      module Custom
+      module Classes
         class Export
           include ConvenientService::DependencyContainer::Import
 

data/lib/convenient_service/rspec/matchers/{custom → classes}/results/base/constants.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module RSpec
     module Matchers
-      module Custom
+      module Classes
         module Results
           class Base
             module Constants

data/lib/convenient_service/rspec/matchers/{custom → classes}/results/base/entities/chain.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module RSpec
     module Matchers
-      module Custom
+      module Classes
         module Results
           class Base
             module Entities

data/lib/convenient_service/rspec/matchers/{custom → classes}/results/base/entities/printers/base/commands/generate_expected_code_part.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module RSpec
     module Matchers
-      module Custom
+      module Classes
         module Results
           class Base
             module Entities
@@ -17,21 +17,21 @@ module ConvenientService
                       # @api private
                       #
                       # @!attribute printer [r]
-                      #   @return [ConvenientService::RSpec::Matchers::Custom::Results::Base::Entities::Printers::Base]
+                      #   @return [ConvenientService::RSpec::Matchers::Classes::Results::Base::Entities::Printers::Base]
                       #
                       attr_reader :printer
 
                       ##
                       # @api private
                       #
-                      # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base::Entities::Chain]
+                      # @return [ConvenientService::RSpec::Matchers::Classes::Results::Base::Entities::Chain]
                       #
                       delegate :chain, to: :printer
 
                       ##
                       # @api private
                       #
-                      # @param printer [ConvenientService::RSpec::Matchers::Custom::Results::Base::Entities::Printers::Base]
+                      # @param printer [ConvenientService::RSpec::Matchers::Classes::Results::Base::Entities::Printers::Base]
                       # @return [void]
                       #
                       def initialize(printer:)