convenient_service 0.20.0 → 0.21.0

data/lib/convenient_service/dependencies/queries.rb

@@ -9,14 +9,6 @@ require_relative "queries/version"
 require_relative "queries/ruby"
 require_relative "queries/gems"
 
-##
-# `ConvenientService::Dependencies` can dynamically require plugins/extensions that have external dependencies.
-#
-# @internal
-#   - https://github.com/marian13/convenient_service/wiki/Docs:-Dependencies
-#
-#   TODO: Add `plugin`, `config` suffixes to `require` methods.
-#
 module ConvenientService
   module Dependencies
     ##
@@ -30,6 +22,39 @@ module ConvenientService
       #
       extend self
 
+      ##
+      # Returns `true` when Convenient Service is in debug mode. In other words `$CONVENIENT_SERVICE_DEBUG` env variable is set to `true`.
+      #
+      # @api private
+      # @since 1.0.0
+      # @return [Boolean]
+      #
+      def debug?
+        ::ENV["CONVENIENT_SERVICE_DEBUG"] == "true"
+      end
+
+      ##
+      # Returns `true` when Convenient Service is in benchmark mode. In other words `$CONVENIENT_SERVICE_BENCHMARK` env variable is set to `true`.
+      #
+      # @api private
+      # @since 1.0.0
+      # @return [Boolean]
+      #
+      def benchmark?
+        ::ENV["CONVENIENT_SERVICE_BENCHMARK"] == "true"
+      end
+
+      ##
+      # Returns `true` when Convenient Service is in CI mode. In other words `$CONVENIENT_SERVICE_CI` env variable is set to `true`.
+      #
+      # @api private
+      # @since 1.0.0
+      # @return [Boolean]
+      #
+      def ci?
+        ::ENV["CONVENIENT_SERVICE_CI"] == "true"
+      end
+
       ##
       # @api private
       #
@@ -38,7 +63,7 @@ module ConvenientService
       # @see https://github.com/deivid-rodriguez/byebug/issues/289
       #
       # @internal
-      #   NOTE: Ruby 3.5 does not ship with the `readline` by default. That is why `byebug` throws the following error:
+      #   NOTE: Ruby 4.0 does not ship with the `readline` by default. That is why `byebug` throws the following error:
       #     Sorry, you can't use byebug without Readline. To solve this, you need to
       #     rebuild Ruby with Readline support. If using Ubuntu, try `sudo apt-get
       #     install libreadline-dev` and then reinstall your Ruby.
@@ -50,7 +75,7 @@ module ConvenientService
       #   In other words, the full Docker image source should be copied, extended, and built locally.
       #
       def support_byebug?
-        ruby.mri? && ruby.version < 3.5
+        ruby.mri? && ruby.version < 4.0
       end
 
       ##
@@ -151,6 +176,7 @@ module ConvenientService
         require "convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/status/plugins/has_amazing_print_inspect"
         require "convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/code/plugins/has_amazing_print_inspect"
         require "convenient_service/service/plugins/can_have_steps/entities/step/plugins/has_amazing_print_inspect"
+        require "convenient_service/feature/plugins/has_amazing_print_inspect"
       end
 
       ##
@@ -257,6 +283,7 @@ module ConvenientService
         require "convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/status/plugins/has_awesome_print_inspect"
         require "convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/code/plugins/has_awesome_print_inspect"
         require "convenient_service/service/plugins/can_have_steps/entities/step/plugins/has_awesome_print_inspect"
+        require "convenient_service/feature/plugins/has_awesome_print_inspect"
       end
 
       ##
@@ -319,6 +346,11 @@ module ConvenientService
         require "convenient_service/service/plugins/has_j_send_result_params_validations/using_dry_validation"
       end
 
+      ##
+      # @api private
+      #
+      # @return [Boolean]
+      #
       def require_has_memoization_using_memo_wise_plugin
         ##
         # - https://github.com/panorama-ed/memo_wise
@@ -356,6 +388,8 @@ module ConvenientService
       #   - https://github.com/deivid-rodriguez/byebug/issues/179#issuecomment-152727003
       #
       def require_development_tools(amazing_print: false, awesome_print: true)
+        return if ci?
+
         ##
         # - https://github.com/awesome-print/awesome_print
         #
@@ -400,7 +434,7 @@ module ConvenientService
         ##
         # - https://github.com/rouge-ruby/rouge
         #
-        require "rouge"
+        require "rouge" if support_byebug?
 
         ##
         # - https://ruby-doc.org/stdlib-2.7.0/libdoc/tempfile/rdoc/Tempfile.html
@@ -428,6 +462,11 @@ module ConvenientService
       # @note Expected to be called from `spec_helper.rb`.
       #
       def require_test_tools
+        ##
+        # - https://github.com/janlelis/paint
+        #
+        require "paint"
+
         ##
         # - https://github.com/faker-ruby/faker
         #
@@ -465,6 +504,9 @@ module ConvenientService
         require "rspec/matchers"
         require "rspec/mocks"
 
+        require "convenient_service/service/plugins/can_have_rspec_stubbed_results"
+        require "convenient_service/feature/plugins/can_have_rspec_stubbed_entries"
+
         require "convenient_service/rspec"
       end
 
@@ -575,7 +617,7 @@ module ConvenientService
       ##
       # @api private
       #
-      # @return [ConvenientService::Dependencies::Queries::Ruby]
+      # @return [Class<ConvenientService::Dependencies::Queries::Ruby>]
       #
       def ruby
         Ruby
@@ -584,7 +626,16 @@ module ConvenientService
       ##
       # @api private
       #
-      # @return [ConvenientService::Dependencies::Queries::RSpec]
+      # @return [Class<ConvenientService::Dependencies::Queries::Gems::Minitest>]
+      #
+      def minitest
+        Gems::Minitest
+      end
+
+      ##
+      # @api private
+      #
+      # @return [Class<ConvenientService::Dependencies::Queries::Gems::RSpec>]
       #
       def rspec
         Gems::RSpec
@@ -593,7 +644,7 @@ module ConvenientService
       ##
       # @api private
       #
-      # @return [ConvenientService::Dependencies::Queries::Gems::ActiveModel]
+      # @return [Class<ConvenientService::Dependencies::Queries::Gems::ActiveModel>]
       #
       def active_model
         Gems::ActiveModel
@@ -602,7 +653,7 @@ module ConvenientService
       ##
       # @api private
       #
-      # @return [ConvenientService::Dependencies::Queries::Gems::Logger]
+      # @return [Class<ConvenientService::Dependencies::Queries::Gems::Logger>]
       #
       def logger
         Gems::Logger
@@ -611,7 +662,7 @@ module ConvenientService
       ##
       # @api private
       #
-      # @return [ConvenientService::Dependencies::Queries::Gems::Paint]
+      # @return [Class<ConvenientService::Dependencies::Queries::Gems::Paint>]
       #
       def paint
         Gems::Paint

data/lib/convenient_service/dependencies.rb

@@ -9,13 +9,13 @@ require_relative "dependencies/built_in"
 require_relative "dependencies/extractions"
 require_relative "dependencies/queries"
 
-##
-# `ConvenientService::Dependencies` can dynamically require plugins/extensions that have external dependencies.
-#
-# @internal
-#   https://github.com/marian13/convenient_service/wiki/Docs:-Dependencies
-#
 module ConvenientService
+  ##
+  # `ConvenientService::Dependencies` can dynamically require plugins/extensions that have external dependencies.
+  #
+  # @internal
+  #   https://github.com/marian13/convenient_service/wiki/Docs:-Dependencies
+  #
   module Dependencies
     extend Queries
   end

data/lib/convenient_service/extras/alias.rb

@@ -18,7 +18,10 @@ require "convenient_service"
 ConvenientService::Dependencies.require_alias
 
 ##
-# `CS` is just an alias for `ConvenientService`. It becames available by `require "convenient_service/alias"`.
+# `CS` is just an alias for `ConvenientService`. It becames available by `require "convenient_service/extra/alias"`.
+#
+# @api public
+# @since 1.0.0
 #
 # @internal
 #   NOTE: Added for visibility in YARD docs.

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

@@ -5,8 +5,6 @@
 # @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
 ##
 
-require_relative "standard/commands"
-
 module ConvenientService
   module Feature
     module Configs
@@ -16,9 +14,22 @@ module ConvenientService
       module Standard
         include ConvenientService::Config
 
+        available_options do
+          [
+            :essential,
+            :inspect,
+            :amazing_print_inspect,
+            :awesome_print_inspect,
+            :test,
+            :rspec
+          ]
+        end
+
         default_options do
           [
             :essential,
+            :inspect,
+            test: Dependencies.rspec.loaded? || Dependencies.minitest.loaded?,
             rspec: Dependencies.rspec.loaded?
           ]
         end
@@ -29,7 +40,11 @@ module ConvenientService
           concerns do
             use ConvenientService::Plugins::Feature::CanHaveEntries::Concern if options.enabled?(:essential)
             use ConvenientService::Plugins::Common::HasInstanceProxy::Concern if options.enabled?(:essential)
-            use ConvenientService::Plugins::Feature::CanHaveStubbedEntries::Concern if options.enabled?(:rspec)
+            use ConvenientService::Plugins::Feature::CanHaveStubbedEntries::Concern if options.enabled?(:test) || options.enabled?(:rspec)
+            use ConvenientService::Plugins::Feature::CanHaveRSpecStubbedEntries::Concern if options.enabled?(:rspec)
+            use ConvenientService::Plugins::Feature::HasInspect::Concern if options.enabled?(:inspect)
+            use ConvenientService::Plugins::Feature::HasAwesomePrintInspect::Concern if options.enabled?(:awesome_print_inspect)
+            use ConvenientService::Plugins::Feature::HasAmazingPrintInspect::Concern if options.enabled?(:amazing_print_inspect)
           end
 
           middlewares :new, scope: :class do
@@ -37,11 +52,11 @@ module ConvenientService
           end
 
           middlewares :trigger, scope: :class do
-            use ConvenientService::Plugins::Feature::CanHaveStubbedEntries::Middleware if options.enabled?(:rspec)
+            use ConvenientService::Plugins::Feature::CanHaveStubbedEntries::Middleware if options.enabled?(:test) || options.enabled?(:rspec)
           end
 
           middlewares :trigger do
-            use ConvenientService::Plugins::Feature::CanHaveStubbedEntries::Middleware if options.enabled?(:rspec)
+            use ConvenientService::Plugins::Feature::CanHaveStubbedEntries::Middleware if options.enabled?(:test) || options.enabled?(:rspec)
           end
         end
 
@@ -65,14 +80,19 @@ module ConvenientService
           #     end
           #   end
           #
-          #    ConvenientService::Feature::Configs::Standard.feature_class?(Feature)
+          #   ConvenientService::Feature::Configs::Standard.feature_class?(Feature)
+          #   # => false
+          #
+          #   ConvenientService::Feature::Configs::Standard.feature_class?(Feature.new)
           #   # => true
           #
-          #    ConvenientService::Feature::Configs::Standard.feature_class?(42)
+          #   ConvenientService::Feature::Configs::Standard.feature_class?(42)
           #   # => false
           #
           def feature_class?(feature_class)
-            Commands::IsFeatureClass[feature_class: feature_class]
+            return false unless feature_class.instance_of?(::Class)
+
+            feature_class.include?(Feature::Core)
           end
 
           ##
@@ -94,16 +114,17 @@ module ConvenientService
           #     end
           #   end
           #
-          #   feature = Feature.new
-          #
-          #    ConvenientService::Feature::Configs::Standard.feature?(feature)
+          #   ConvenientService::Feature::Configs::Standard.feature?(Feature.new)
           #   # => true
           #
-          #    ConvenientService::Feature::Configs::Standard.feature?(42)
+          #   ConvenientService::Feature::Configs::Standard.feature?(Feature)
+          #   # => false
+          #
+          #   ConvenientService::Feature::Configs::Standard.feature?(42)
           #   # => false
           #
           def feature?(feature)
-            Commands::IsFeature[feature: feature]
+            feature_class?(feature.class)
           end
         end
       end

data/lib/convenient_service/feature/core.rb

@@ -13,6 +13,47 @@ module ConvenientService
       included do
         include ::ConvenientService::Core
       end
+
+      instance_methods do
+        ##
+        # Returns string representation of feature.
+        #
+        # @api public
+        # @since 1.0.0
+        #
+        # @param format [Symbol]
+        # @return [String]
+        #
+        # @note Intended to be used for debugging purposes.
+        #
+        # @example Common usage.
+        #   class Feature
+        #     include ConvenientFeature::Feature::Standard::Config
+        #
+        #     entry :main
+        #
+        #     def main
+        #       :main_entry_value
+        #     end
+        #   end
+        #
+        #   puts Feature.new
+        #   # <Feature>
+        #   # => nil
+        #
+        #   Feature.new.to_s
+        #   # => "<Feature>"
+        #
+        #   Feature.new.to_s(format: :inspect)
+        #   # => "<Feature>"
+        #
+        #   Feature.new.to_s(format: :original)
+        #   # => "#<Feature:0x00005639cd363000>"
+        #
+        def to_s(format: :inspect)
+          (format == :inspect) ? inspect : super()
+        end
+      end
     end
   end
 end

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

@@ -7,6 +7,35 @@
 
 module ConvenientService
   module Plugins
+    ##
+    # Intermediate module/namespace to access plugins that can be applied only to features.
+    #
+    # @api public
+    # @since 1.0.0
+    # @return [Module]
+    #
+    # @example Feature plugin `CanHaveEntries` is used for features.
+    #   ##
+    #   # Since the `CanHaveEntries` feature plugin is included by default by the feature standard config,
+    #   # the example below shows how to remove it instead of adding it.
+    #   #
+    #   class Feature
+    #     include ConvenientService::Feature::Standard::Config
+    #
+    #     concerns do
+    #       delete ConvenientService::Plugins::Feature::CanHaveEntries::Concern
+    #     end
+    #
+    #     ##
+    #     # Raises since `CanHaveEntries` is removed.
+    #     #
+    #     entry :main
+    #
+    #     def main
+    #       :main_entry_value
+    #     end
+    #   end
+    #
     Feature = ::ConvenientService::Feature::Plugins
   end
 end

data/lib/convenient_service/feature/plugins/can_have_rspec_stubbed_entries/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 CanHaveRSpecStubbedEntries
+        module Concern
+          include Support::Concern
+
+          class_methods do
+            ##
+            # @return [RSpec::Core::Example, nil]
+            #
+            # @internal
+            #   NOTE: `::RSpec.current_example` docs.
+            #   - https://www.rubydoc.info/github/rspec/rspec-core/RSpec.current_example
+            #   - https://github.com/rspec/rspec-core/blob/v3.12.0/lib/rspec/core.rb#L122
+            #   - https://github.com/rspec/rspec-support/blob/v3.12.0/lib/rspec/support.rb#L92
+            #   - https://relishapp.com/rspec/rspec-core/docs/metadata/current-example
+            #
+            def stubbed_entries_store
+              Dependencies.rspec.current_example
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/{rspec/helpers/classes/stub_entry/entities.rb → feature/plugins/can_have_rspec_stubbed_entries.rb}

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

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

@@ -0,0 +1,71 @@
+# 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 Commands
+          class DeleteFeatureStubbedEntry < Support::Command
+            ##
+            # @!attribute [r] feature
+            #   @return [ConvenientService::Feature]
+            #
+            attr_reader :feature
+
+            ##
+            # @!attribute [r] entry
+            #   @return [Symbol, String]
+            #
+            attr_reader :entry
+
+            ##
+            # @!attribute [r] arguments
+            #   @return [ConvenientService::Support::Arguments]
+            #
+            attr_reader :arguments
+
+            ##
+            # @param feature [ConvenientService::Feature]
+            # @param entry [Symbol, String]
+            # @param arguments [ConvenientService::Support::Arguments]
+            # @return [void]
+            #
+            def initialize(feature:, entry:, arguments:)
+              @feature = feature
+              @entry = entry
+              @arguments = arguments
+            end
+
+            ##
+            # @return [Object] Can be any type.
+            #
+            # @internal
+            #   NOTE: `arguments.nil?` means "match any arguments".
+            #
+            def call
+              if arguments.nil?
+                cache.default = nil
+              else
+                cache.delete(cache.keygen(*arguments.args, **arguments.kwargs, &arguments.block))
+              end
+            end
+
+            private
+
+            ##
+            # @return [ConvenientService::Support::Cache]
+            #
+            def cache
+              @cache ||= Commands::FetchFeatureStubbedEntriesCache.call(feature: feature).scope(entry.to_sym, backed_by: :thread_safe_array)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -11,6 +11,20 @@ module ConvenientService
       module CanHaveStubbedEntries
         module Commands
           class FetchAllFeaturesStubbedEntriesCache < Support::Command
+            ##
+            # @!attribute [r] feature
+            #   @return [ConvenientService::Feature]
+            #
+            attr_reader :feature
+
+            ##
+            # @param feature [ConvenientService::Feature]
+            # @return [void]
+            #
+            def initialize(feature:)
+              @feature = feature
+            end
+
             ##
             # @return [ConvenientService::Support::Cache]
             #
@@ -21,8 +35,8 @@ module ConvenientService
             #   - https://relishapp.com/rspec/rspec-core/docs/metadata/current-example
             #
             def call
-              if Dependencies.rspec.current_example
-                Utils::Object.memoize_including_falsy_values(Dependencies.rspec.current_example, :@__convenient_service_stubbed_entries__) { Support::Cache.backed_by(:thread_safe_hash).new }
+              if feature.stubbed_entries_store
+                Utils::Object.memoize_including_falsy_values(feature.stubbed_entries_store, :@__convenient_service_stubbed_entries__) { Support::Cache.backed_by(:thread_safe_hash).new }
               else
                 Support::Cache.backed_by(:thread_safe_hash).new
               end

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

@@ -38,7 +38,7 @@ module ConvenientService
             # @return [ConvenientService::Support::Cache]
             #
             def cache
-              @cache ||= Commands::FetchAllFeaturesStubbedEntriesCache.call
+              @cache ||= Commands::FetchAllFeaturesStubbedEntriesCache.call(feature: feature)
             end
           end
         end

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

@@ -7,4 +7,6 @@
 
 require_relative "commands/fetch_all_features_stubbed_entries_cache"
 require_relative "commands/fetch_feature_stubbed_entries_cache"
+
+require_relative "commands/delete_feature_stubbed_entry"
 require_relative "commands/set_feature_stubbed_entry"

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

@@ -26,6 +26,13 @@ module ConvenientService
           end
 
           class_methods do
+            ##
+            # @return [Thread]
+            #
+            def stubbed_entries_store
+              ::Thread.current
+            end
+
             ##
             # @return [ConvenientService::Support::Cache]
             #
@@ -43,6 +50,22 @@ module ConvenientService
             def stubbed_entries
               Commands::FetchFeatureStubbedEntriesCache.call(feature: self)
             end
+
+            ##
+            # @param entry_name [Symbol, String]
+            # @return [ConvenientService::Feature::Plugins::CanHaveStubbedEntries::Entities::FeatureStub]
+            #
+            def stub_entry(entry_name)
+              Entities::FeatureStub.new(feature_class: self, entry_name: entry_name)
+            end
+
+            ##
+            # @param entry_name [Symbol, String]
+            # @return [ConvenientService::Feature::Plugins::CanHaveStubbedEntries::Entities::FeatureUnstub]
+            #
+            def unstub_entry(entry_name)
+              Entities::FeatureUnstub.new(feature_class: self, entry_name: entry_name)
+            end
           end
         end
       end