convenient_service 0.20.0 → 0.21.0

data/lib/convenient_service/feature/plugins/can_have_stubbed_entries/entities/feature_stub.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
+module ConvenientService
+  module Feature
+    module Plugins
+      module CanHaveStubbedEntries
+        module Entities
+          class FeatureStub
+            ##
+            # @param feature_class [Class<ConvenientService::Feature>]
+            # @param entry_name [Symbol, String]
+            # @return [void]
+            #
+            # @internal
+            #   NOTE: `@arguments = nil` means "match any arguments".
+            #
+            def initialize(feature_class:, entry_name:)
+              @feature_class = feature_class
+              @entry_name = entry_name
+              @arguments = nil
+            end
+
+            ##
+            # @return [ConvenientService::Feature::Plugins::CanHaveStubbedEntries::Entities::FeatureStub]
+            #
+            def with_arguments(...)
+              @arguments = Support::Arguments.new(...)
+
+              self
+            end
+
+            ##
+            # @return [ConvenientService::Feature::Plugins::CanHaveStubbedEntries::Entities::FeatureStub]
+            #
+            # @internal
+            #   NOTE: `@arguments = nil` means "match any arguments".
+            #
+            def with_any_arguments(...)
+              @arguments = nil
+
+              self
+            end
+
+            ##
+            # @return [ConvenientService::Feature::Plugins::CanHaveStubbedEntries::Entities::FeatureStub]
+            #
+            def without_arguments
+              @arguments = Support::Arguments.null_arguments
+
+              self
+            end
+
+            ##
+            # @param value_mock [ConvenientService::Feature::Plugins::CanHaveStubbedEntries::Entities::ValueMock]
+            # @return [ConvenientService::Feature::Plugins::CanHaveStubbedEntries::Entities::FeatureStub]
+            #
+            def to(value_mock)
+              @value_mock = value_mock.for(feature_class, entry_name, arguments)
+
+              @value_mock.register
+
+              self
+            end
+
+            ##
+            # @param value [Object] Can be any type.
+            # @return [ConvenientService::Feature::Plugins::CanHaveStubbedEntries::Entities::ValueMock]
+            #
+            def to_return_value(value)
+              @value_mock = Entities::ValueMock.new(value: value, feature_class: feature_class, entry_name: entry_name, arguments: arguments)
+            end
+
+            ##
+            # @param other [Object] Can be any type.
+            # @return [Boolean, nil]
+            #
+            def ==(other)
+              return unless other.instance_of?(self.class)
+
+              return false if feature_class != other.feature_class
+              return false if entry_name != other.entry_name
+              return false if arguments != other.arguments
+              return false if value_mock != other.value_mock
+
+              true
+            end
+
+            protected
+
+            ##
+            # @!attribute [r] feature_class
+            #   @return [Class<ConvenientService::Feature>]
+            #
+            attr_reader :feature_class
+
+            ##
+            # @!attribute [r] entry_name
+            #   @return [Symbol, String]
+            #
+            attr_reader :entry_name
+
+            ##
+            # @!attribute [r] arguments
+            #   @return [ConvenientService::Support::Arguments]
+            #
+            attr_reader :arguments
+
+            ##
+            # @!attribute [r] value_mock
+            #   @return [ConvenientService::RSpec::Helpers::Classes::StubEntry::Entities::ValueMock]
+            #
+            attr_reader :value_mock
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/feature/plugins/can_have_stubbed_entries/entities/feature_unstub.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
+module ConvenientService
+  module Feature
+    module Plugins
+      module CanHaveStubbedEntries
+        module Entities
+          class FeatureUnstub
+            ##
+            # @param feature_class [Class<ConvenientService::Feature>]
+            # @param entry_name [Symbol, String]
+            # @return [void]
+            #
+            # @internal
+            #   NOTE: `@arguments = nil` means "match any arguments".
+            #
+            def initialize(feature_class:, entry_name:)
+              @feature_class = feature_class
+              @entry_name = entry_name
+              @arguments = nil
+            end
+
+            ##
+            # @return [ConvenientService::Feature::Plugins::CanHaveStubbedEntries::Entities::FeatureUnstub]
+            #
+            def with_arguments(...)
+              @arguments = Support::Arguments.new(...)
+
+              self
+            end
+
+            ##
+            # @return [ConvenientService::Feature::Plugins::CanHaveStubbedEntries::Entities::FeatureUnstub]
+            #
+            # @internal
+            #   NOTE: `@arguments = nil` means "match any arguments".
+            #
+            def with_any_arguments(...)
+              @arguments = nil
+
+              self
+            end
+
+            ##
+            # @return [ConvenientService::Feature::Plugins::CanHaveStubbedEntries::Entities::FeatureUnstub]
+            #
+            def without_arguments
+              @arguments = Support::Arguments.null_arguments
+
+              self
+            end
+
+            ##
+            # @param value_unmock [ConvenientService::Feature::Plugins::CanHaveStubbedEntries::Entities::ValueUnmock]
+            # @return [ConvenientService::Feature::Plugins::CanHaveStubbedEntries::Entities::FeatureUnstub]
+            #
+            def to(value_unmock)
+              @value_unmock = value_unmock.for(feature_class, entry_name, arguments)
+
+              @value_unmock.register
+
+              self
+            end
+
+            ##
+            # @return [ConvenientService::Feature::Plugins::CanHaveStubbedEntries::Entities::ValueUnmock]
+            #
+            def to_return_value_mock
+              @value_unmock = Entities::ValueUnmock.new(feature_class: feature_class, entry_name: entry_name, arguments: arguments)
+            end
+
+            ##
+            # @param other [Object] Can be any type.
+            # @return [Boolean, nil]
+            #
+            def ==(other)
+              return unless other.instance_of?(self.class)
+
+              return false if feature_class != other.feature_class
+              return false if entry_name != other.entry_name
+              return false if arguments != other.arguments
+              return false if value_unmock != other.value_unmock
+
+              true
+            end
+
+            protected
+
+            ##
+            # @!attribute [r] feature_class
+            #   @return [Class<ConvenientService::Feature>]
+            #
+            attr_reader :feature_class
+
+            ##
+            # @!attribute [r] entry_name
+            #   @return [Symbol, String]
+            #
+            attr_reader :entry_name
+
+            ##
+            # @!attribute [r] arguments
+            #   @return [ConvenientService::Support::Arguments]
+            #
+            attr_reader :arguments
+
+            ##
+            # @!attribute [r] value_unmock
+            #   @return [ConvenientService::RSpec::Helpers::Classes::StubEntry::Entities::ValueMock]
+            #
+            attr_reader :value_unmock
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/feature/plugins/can_have_stubbed_entries/entities/value_mock.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
+module ConvenientService
+  module Feature
+    module Plugins
+      module CanHaveStubbedEntries
+        module Entities
+          class ValueMock
+            ##
+            # @!attribute [r] value
+            #   @return [Object] Can be any type.
+            #
+            attr_reader :value
+
+            ##
+            # @param value [Object] Can be any type.
+            # @param feature_class [Class<ConvenientService::Feature>]
+            # @param entry_name [Symbol, String]
+            # @param arguments [ConvenientService::Support::Arguments]
+            # @return [void]
+            #
+            def initialize(value:, feature_class: nil, entry_name: nil, arguments: nil)
+              @value = value
+              @feature_class = feature_class
+              @entry_name = entry_name
+              @arguments = arguments
+            end
+
+            ##
+            # @param feature_class [Class<ConvenientService::Feature>]
+            # @param entry_name [Symbol, String]
+            # @param arguments [ConvenientService::Support::Arguments]
+            # @return [ConvenientService::Feature::Plugins::CanHaveStubbedEntries::Entities::ValueMock]
+            #
+            def for(feature_class, entry_name, arguments)
+              self.class.new(value: value, feature_class: feature_class, entry_name: entry_name, arguments: arguments)
+            end
+
+            ##
+            # @param block [Proc, nil]
+            # @return [ConvenientService::Feature::Plugins::CanHaveStubbedEntries::Entities::ValueMock]
+            #
+            def register(&block)
+              Commands::SetFeatureStubbedEntry[feature: feature_class, entry: entry_name, arguments: arguments, value: value]
+
+              return self unless block
+
+              begin
+                yield
+              ensure
+                Commands::DeleteFeatureStubbedEntry[feature: feature_class, entry: entry_name, arguments: arguments]
+              end
+            end
+
+            ##
+            # @return [ConvenientService::Feature::Plugins::CanHaveStubbedEntries::Entities::ValueMock]
+            #
+            alias_method :apply, :register
+
+            ##
+            # @return [ConvenientService::Feature::Plugins::CanHaveStubbedEntries::Entities::ValueMock]
+            #
+            def unregister
+              Commands::DeleteFeatureStubbedEntry[feature: feature_class, entry: entry_name, arguments: arguments]
+
+              self
+            end
+
+            ##
+            # @return [ConvenientService::Feature::Plugins::CanHaveStubbedEntries::Entities::ValueMock]
+            #
+            alias_method :revert, :unregister
+
+            ##
+            # @param other [Object] Can be any type.
+            # @return [Boolean, nil]
+            #
+            def ==(other)
+              return unless other.instance_of?(self.class)
+
+              return false if value != other.value
+              return false if feature_class != other.feature_class
+              return false if entry_name != other.entry_name
+              return false if arguments != other.arguments
+
+              true
+            end
+
+            protected
+
+            ##
+            # @!attribute [r] feature_class
+            #   @return [Class<ConvenientService::Feature>]
+            #
+            attr_reader :feature_class
+
+            ##
+            # @!attribute [r] entry_name
+            #   @return [Symbol, String]
+            #
+            attr_reader :entry_name
+
+            ##
+            # @!attribute [r] arguments
+            #   @return [ConvenientService::Support::Arguments]
+            #
+            attr_reader :arguments
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/feature/plugins/can_have_stubbed_entries/entities/value_unmock.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
+module ConvenientService
+  module Feature
+    module Plugins
+      module CanHaveStubbedEntries
+        module Entities
+          class ValueUnmock
+            ##
+            # @param feature_class [Class<ConvenientService::Feature>]
+            # @param entry_name [Symbol, String]
+            # @param arguments [ConvenientService::Support::Arguments]
+            # @return [void]
+            #
+            def initialize(feature_class: nil, entry_name: nil, arguments: nil)
+              @feature_class = feature_class
+              @entry_name = entry_name
+              @arguments = arguments
+            end
+
+            ##
+            # @param feature_class [Class<ConvenientService::Feature>]
+            # @param entry_name [Symbol, String]
+            # @param arguments [ConvenientService::Support::Arguments]
+            # @return [ConvenientService::Feature::Plugins::CanHaveStubbedEntries::Entities::ValueUnmock]
+            #
+            def for(feature_class, entry_name, arguments)
+              self.class.new(feature_class: feature_class, entry_name: entry_name, arguments: arguments)
+            end
+
+            ##
+            # @return [ConvenientService::Feature::Plugins::CanHaveStubbedEntries::Entities::ValueUnmock]
+            #
+            def register
+              Commands::DeleteFeatureStubbedEntry[feature: feature_class, entry: entry_name, arguments: arguments]
+
+              self
+            end
+
+            ##
+            # @return [ConvenientService::Feature::Plugins::CanHaveStubbedEntries::Entities::ValueUnmock]
+            #
+            alias_method :apply, :register
+
+            ##
+            # @param other [Object] Can be any type.
+            # @return [Boolean, nil]
+            #
+            def ==(other)
+              return unless other.instance_of?(self.class)
+
+              return false if feature_class != other.feature_class
+              return false if entry_name != other.entry_name
+              return false if arguments != other.arguments
+
+              true
+            end
+
+            protected
+
+            ##
+            # @!attribute [r] feature_class
+            #   @return [Class<ConvenientService::Feature>]
+            #
+            attr_reader :feature_class
+
+            ##
+            # @!attribute [r] entry_name
+            #   @return [Symbol, String]
+            #
+            attr_reader :entry_name
+
+            ##
+            # @!attribute [r] arguments
+            #   @return [ConvenientService::Support::Arguments]
+            #
+            attr_reader :arguments
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
+require_relative "entities/feature_stub"
+require_relative "entities/feature_unstub"
+
+require_relative "entities/value_mock"
+require_relative "entities/value_unmock"

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

@@ -7,18 +7,5 @@
 
 require_relative "can_have_stubbed_entries/commands"
 require_relative "can_have_stubbed_entries/concern"
+require_relative "can_have_stubbed_entries/entities"
 require_relative "can_have_stubbed_entries/middleware"
-
-module ConvenientService
-  module Feature
-    module Plugins
-      module CanHaveStubbedEntries
-        class << self
-          def set_feature_stubbed_entry(feature, entry, arguments, value)
-            Commands::SetFeatureStubbedEntry[feature: feature, entry: entry, arguments: arguments, value: value]
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
+module ConvenientService
+  module Feature
+    module Plugins
+      module HasAmazingPrintInspect
+        module Concern
+          include Support::Concern
+
+          instance_methods do
+            ##
+            # @return [String]
+            #
+            def inspect
+              metadata = {
+                ConvenientService: {
+                  entity: "Feature",
+                  name: Utils::Class.display_name(self.class)
+                }
+              }
+
+              metadata.ai
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/feature/{configs/standard/commands.rb → plugins/has_amazing_print_inspect.rb}

@@ -5,5 +5,4 @@
 # @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
 ##
 
-require_relative "commands/is_feature_class"
-require_relative "commands/is_feature"
+require_relative "has_amazing_print_inspect/concern"

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
+module ConvenientService
+  module Feature
+    module Plugins
+      module HasAwesomePrintInspect
+        module Concern
+          include Support::Concern
+
+          instance_methods do
+            ##
+            # @return [String]
+            #
+            def inspect
+              metadata = {
+                ConvenientService: {
+                  entity: "Feature",
+                  name: Utils::Class.display_name(self.class)
+                }
+              }
+
+              metadata.ai
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/{rspec/helpers/classes/stub_service/entities.rb → feature/plugins/has_awesome_print_inspect.rb}

@@ -5,5 +5,4 @@
 # @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
 ##
 
-require_relative "entities/stubbed_service"
-require_relative "entities/result_spec"
+require_relative "has_awesome_print_inspect/concern"

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
+module ConvenientService
+  module Feature
+    module Plugins
+      module HasInspect
+        module Concern
+          include Support::Concern
+
+          instance_methods do
+            ##
+            # @return [String]
+            #
+            def inspect
+              "<#{Utils::Class.display_name(self.class)}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/{service/configs/standard/commands.rb → feature/plugins/has_inspect.rb}

@@ -5,5 +5,4 @@
 # @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
 ##
 
-require_relative "commands/is_service_class"
-require_relative "commands/is_service"
+require_relative "has_inspect/concern"

data/lib/convenient_service/feature/plugins.rb

@@ -7,5 +7,6 @@
 
 require_relative "plugins/can_have_entries"
 require_relative "plugins/can_have_stubbed_entries"
+require_relative "plugins/has_inspect"
 
 require_relative "plugins/aliases"

data/lib/convenient_service/feature.rb

@@ -8,3 +8,19 @@
 require_relative "feature/core"
 require_relative "feature/plugins"
 require_relative "feature/configs"
+
+module ConvenientService
+  ##
+  # Intermediate module/namespace to access core, plugins and configs that can be applied only to features.
+  #
+  # @api public
+  # @since 1.0.0
+  # @return [Module]
+  #
+  # @note Feature core expected to be used via {ConvenientService::Feature::Core}.
+  # @note Feature configs expected to be used via {ConvenientService::Feature::Standard::Config} alias.
+  # @note Feature plugins expected to be used via {ConvenientService::Plugins::Feature} alias.
+  #
+  module Feature
+  end
+end

data/lib/convenient_service/logger.rb

@@ -5,18 +5,17 @@
 # @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
 ##
 
-##
-# @example Usage.
-#
-#   ConvenientService::Logger.instance
-#   ConvenientService::Logger.instance.level = ::Logger::WARN
-#   ConvenientService::Logger.instance.warn { "log message" }
-#
-# @see https://ruby-doc.org/stdlib-2.7.0/libdoc/logger/rdoc/Logger.html
-# @see https://newbedev.com/ruby-create-singleton-with-parameters
-#
 module ConvenientService
   ##
+  # @example Usage.
+  #
+  #   ConvenientService::Logger.instance
+  #   ConvenientService::Logger.instance.level = ::Logger::WARN
+  #   ConvenientService::Logger.instance.warn { "log message" }
+  #
+  # @see https://ruby-doc.org/stdlib-2.7.0/libdoc/logger/rdoc/Logger.html
+  # @see https://newbedev.com/ruby-create-singleton-with-parameters
+  #
   # @internal
   #   TODO: Custom matcher to track log messages.
   #   TODO: Fallback for logging methods. Just like with `#clean` in backtrace cleaner.
@@ -115,9 +114,9 @@ module ConvenientService
     #
     def level=(severity)
       if Dependencies.support_logger_non_integer_levels?
-        super(severity)
+        super
       elsif severity.instance_of?(::Integer)
-        super(severity)
+        super
       else
         ::Warning.warn <<~MESSAGE
           `ConvenientService.logger.level` is reset from `#{severity}` to `Logger::INFO`.

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

@@ -8,6 +8,4 @@
 require_relative "classes/in_threads"
 
 require_relative "classes/ignoring_exception"
-require_relative "classes/stub_service"
-require_relative "classes/stub_entry"
 require_relative "classes/wrap_method"