dry-system 0.22.0 → 0.23.0

data/lib/dry/system/config/component_dir.rb

@@ -20,7 +20,7 @@ module Dry
         #   Sets the auto-registration policy for the component dir.
         #
         #   This may be a simple boolean to enable or disable auto-registration for all
-        #   components, or a proc accepting a `Dry::Sytem::Component` and returning a
+        #   components, or a proc accepting a {Dry::System::Component} and returning a
         #   boolean to configure auto-registration on a per-component basis
         #
         #   Defaults to `true`.
@@ -50,30 +50,48 @@ module Dry
         #   @api public
         setting :auto_register, default: true
 
-        # @!method add_to_load_path=(policy)
+        # @!method instance=(instance_proc)
         #
-        #   Sets whether the dir should be added to the `$LOAD_PATH` after the container
-        #   is configured.
+        #   Sets a proc used to return the instance of any component within the component
+        #   dir.
         #
-        #   Defaults to `true`. This may need to be set to `false` when using a class
-        #   autoloading system.
+        #   This proc should accept a {Dry::System::Component} and return the object to
+        #   serve as the component's instance.
         #
-        #   @param policy [Boolean]
-        #   @return [Boolean]
+        #   When you provide an instance proc, it will be used in preference to the
+        #   {loader} (either the default loader or an explicitly configured one). Provide
+        #   an instance proc when you want a simple way to customize the instance for
+        #   certain components. For complete control, provide a replacement loader via
+        #   {loader=}.
         #
-        #   @see add_to_load_path
-        #   @see Container.configure
+        #   Defaults to `nil`.
+        #
+        #   @param instance_proc [Proc, nil]
+        #   @return [Proc]
+        #
+        #   @example
+        #     dir.instance = proc do |component|
+        #       if component.key.match?(/workers\./)
+        #         # Register classes for jobs
+        #         component.loader.constant(component)
+        #       else
+        #         # Otherwise register regular instances per default loader
+        #         component.loader.call(component)
+        #       end
+        #     end
+        #
+        #   @see Component, Loader
         #   @api public
         #
-        # @!method add_to_load_path
+        # @!method instance
         #
-        #   Returns the configured value.
+        #   Returns the configured instance proc.
         #
-        #   @return [Boolean]
+        #   @return [Proc, nil]
         #
-        #   @see add_to_load_path=
+        #   @see instance=
         #   @api public
-        setting :add_to_load_path, default: true
+        setting :instance
 
         # @!method loader=(loader)
         #
@@ -82,7 +100,8 @@ module Dry
         #
         #   Defaults to `Dry::System::Loader`.
         #
-        #   When using a class autoloader, consider using `Dry::System::Loader::Autoloading`
+        #   When using an autoloader like Zeitwerk, consider using
+        #   `Dry::System::Loader::Autoloading`
         #
         #   @param loader [#call] the loader
         #   @return [#call] the configured loader
@@ -150,6 +169,31 @@ module Dry
         #   @api public
         setting :namespaces, default: Namespaces.new, cloneable: true
 
+        # @!method add_to_load_path=(policy)
+        #
+        #   Sets whether the dir should be added to the `$LOAD_PATH` after the container
+        #   is configured.
+        #
+        #   Defaults to `true`. This may need to be set to `false` when using a class
+        #   autoloading system.
+        #
+        #   @param policy [Boolean]
+        #   @return [Boolean]
+        #
+        #   @see add_to_load_path
+        #   @see Container.configure
+        #   @api public
+        #
+        # @!method add_to_load_path
+        #
+        #   Returns the configured value.
+        #
+        #   @return [Boolean]
+        #
+        #   @see add_to_load_path=
+        #   @api public
+        setting :add_to_load_path, default: true
+
         # @api public
         def default_namespace=(namespace)
           Dry::Core::Deprecations.announce(

data/lib/dry/system/config/component_dirs.rb

@@ -17,7 +17,7 @@ module Dry
         #
         #   Sets a default `auto_register` for all added component dirs
         #
-        #   @see ComponentDir.auto_register
+        #   @see ComponentDir.auto_register=
         #   @see auto_register
         #
         # @!method auto_register
@@ -26,24 +26,24 @@ module Dry
         #
         #   @see auto_register=
 
-        # @!method add_to_load_path=(value)
+        # @!method instance=(value)
         #
-        #   Sets a default `add_to_load_path` value for all added component dirs
+        #   Sets a default `instance` for all added component dirs
         #
-        #   @see ComponentDir.add_to_load_path
-        #   @see add_to_load_path
+        #   @see ComponentDir.instance=
+        #   @see auto_register
         #
-        # @!method add_to_load_path
+        # @!method auto_register
         #
-        #   Returns the configured default `add_to_load_path`
+        #   Returns the configured default `instance`
         #
-        #   @see add_to_load_path=
+        #   @see instance=
 
         # @!method loader=(value)
         #
         #   Sets a default `loader` value for all added component dirs
         #
-        #   @see ComponentDir.loader
+        #   @see ComponentDir.loader=
         #   @see loader
         #
         # @!method loader
@@ -56,7 +56,7 @@ module Dry
         #
         #   Sets a default `memoize` value for all added component dirs
         #
-        #   @see ComponentDir.memoize
+        #   @see ComponentDir.memoize=
         #   @see memoize
         #
         # @!method memoize
@@ -77,6 +77,19 @@ module Dry
         #
         #   @return [Namespaces] the namespaces
 
+        # @!method add_to_load_path=(value)
+        #
+        #   Sets a default `add_to_load_path` value for all added component dirs
+        #
+        #   @see ComponentDir.add_to_load_path=
+        #   @see add_to_load_path
+        #
+        # @!method add_to_load_path
+        #
+        #   Returns the configured default `add_to_load_path`
+        #
+        #   @see add_to_load_path=
+
         # rubocop:enable Layout/LineLength
 
         # @!endgroup

data/lib/dry/system/config/namespace.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "dry/core/equalizer"
+require "dry/system/constants"
 
 module Dry
   module System
@@ -54,7 +55,9 @@ module Dry
         # @api private
         def initialize(path:, key:, const:)
           @path = path
-          @key = key
+          # Default keys (i.e. when the user does not explicitly provide one) for non-root
+          # paths will include path separators, which we must convert into key separators
+          @key = key && key == path ? key.gsub(PATH_SEPARATOR, KEY_SEPARATOR) : key
           @const = const
         end
 
@@ -67,11 +70,6 @@ module Dry
         def path?
           !root?
         end
-
-        # @api private
-        def default_key?
-          key == path
-        end
       end
     end
   end

data/lib/dry/system/constants.rb

@@ -9,7 +9,7 @@ module Dry
     RB_EXT = ".rb"
     RB_GLOB = "*.rb"
     PATH_SEPARATOR = File::SEPARATOR
-    DEFAULT_SEPARATOR = "."
+    KEY_SEPARATOR = "."
     WORD_REGEX = /\w+/.freeze
   end
 end