dry-system 0.21.0 → 0.24.0

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

@@ -9,6 +9,7 @@ require_relative "namespaces"
 module Dry
   module System
     module Config
+      # @api public
       class ComponentDir
         include Dry::Configurable
 
@@ -19,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`.
@@ -37,6 +38,7 @@ module Dry
         #
         #   @see auto_register
         #   @see Component
+        #   @api public
         #
         # @!method auto_register
         #
@@ -45,30 +47,51 @@ module Dry
         #   @return [Boolean, Proc] the configured policy
         #
         #   @see auto_register=
+        #   @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`.
         #
-        # @!method add_to_load_path
+        #   @param instance_proc [Proc, nil]
+        #   @return [Proc]
         #
-        #   Returns the configured value.
+        #   @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
         #
-        #   @return [Boolean]
+        #   @see Component, Loader
+        #   @api public
         #
-        #   @see add_to_load_path=
-        setting :add_to_load_path, default: true
+        # @!method instance
+        #
+        #   Returns the configured instance proc.
+        #
+        #   @return [Proc, nil]
+        #
+        #   @see instance=
+        #   @api public
+        setting :instance
 
         # @!method loader=(loader)
         #
@@ -77,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
@@ -85,6 +109,7 @@ module Dry
         #   @see loader
         #   @see Loader
         #   @see Loader::Autoloading
+        #   @api public
         #
         # @!method loader
         #
@@ -93,6 +118,7 @@ module Dry
         #   @return [#call]
         #
         #   @see loader=
+        #   @api public
         setting :loader, default: Dry::System::Loader
 
         # @!method memoize=(policy)
@@ -119,6 +145,7 @@ module Dry
         #
         #   @see memoize
         #   @see Component
+        #   @api public
         #
         # @!method memoize
         #
@@ -127,6 +154,7 @@ module Dry
         #   @return [Boolean, Proc] the configured memoization policy
         #
         #   @see memoize=
+        #   @api public
         setting :memoize, default: false
 
         # @!method namespaces
@@ -135,11 +163,38 @@ module Dry
         #
         #   Allows namespaces to added on the returned object via {Namespaces#add}.
         #
-        #   @see Namespaces#add
-        #
         #   @return [Namespaces] the namespaces
+        #
+        #   @see Namespaces#add
+        #   @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(
             "Dry::System::Config::ComponentDir#default_namespace=",
@@ -157,6 +212,7 @@ module Dry
           namespaces.add namespace_path, key: nil
         end
 
+        # @api public
         def default_namespace
           Dry::Core::Deprecations.announce(
             "Dry::System::Config::ComponentDir#default_namespace",
@@ -179,7 +235,7 @@ module Dry
         # @return [String] the path
         attr_reader :path
 
-        # @api private
+        # @api public
         def initialize(path)
           super()
           @path = path

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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "concurrent/map"
 require "dry/system/constants"
 require "dry/system/errors"
 require_relative "component_dir"
@@ -8,6 +7,9 @@ require_relative "component_dir"
 module Dry
   module System
     module Config
+      # The configured component dirs for a container
+      #
+      # @api public
       class ComponentDirs
         # @!group Settings
 
@@ -15,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
@@ -24,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
@@ -54,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
@@ -63,71 +65,154 @@ module Dry
         #
         #   @see memoize=
 
+        # rubocop:disable Layout/LineLength
+
         # @!method namespaces
         #
         #   Returns the default configured namespaces for all added component dirs
         #
-        #   Allows namespaces to added on the returned object via {Namespaces#add}.
+        #   Allows namespaces to added on the returned object via {Dry::System::Config::Namespaces#add}.
         #
-        #   @see Namespaces#add
+        #   @see Dry::System::Config::Namespaces#add
         #
         #   @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
 
         # A ComponentDir for configuring the default values to apply to all added
         # component dirs
         #
+        # @see #method_missing
         # @api private
         attr_reader :defaults
 
+        # Creates a new component dirs
+        #
         # @api private
         def initialize
-          @dirs = Concurrent::Map.new
+          @dirs = {}
           @defaults = ComponentDir.new(nil)
         end
 
         # @api private
         def initialize_copy(source)
-          @dirs = source.dirs.dup
+          @dirs = source.dirs.map { |path, dir| [path, dir.dup] }.to_h
           @defaults = source.defaults.dup
         end
 
-        # Adds and configures a component dir
+        # Returns and optionally yields a previously added component dir
+        #
+        # @param path [String] the path for the component dir
+        # @yieldparam dir [ComponentDir] the component dir
+        #
+        # @return [ComponentDir] the component dir
+        #
+        # @api public
+        def dir(path)
+          dirs[path].tap do |dir|
+            # Defaults can be (re-)applied first, since the dir has already been added
+            apply_defaults_to_dir(dir) if dir
+            yield dir if block_given?
+          end
+        end
+        alias_method :[], :dir
+
+        # @overload add(path)
+        #   Adds and configures a component dir for the given path
+        #
+        #   @param path [String] the path for the component dir, relative to the configured
+        #     container root
+        #   @yieldparam dir [ComponentDir] the component dir to configure
+        #
+        #   @return [ComponentDir] the added component dir
         #
-        # @param path [String] the path for the component dir, relative to the configured
-        #   container root
+        #   @example
+        #     component_dirs.add "lib" do |dir|
+        #       dir.default_namespace = "my_app"
+        #     end
         #
-        # @yieldparam dir [ComponentDir] the component dir to configure
+        #   @see ComponentDir
+        #   @api public
         #
-        # @return [ComponentDir] the added component dir
+        # @overload add(dir)
+        #   Adds a configured component dir
         #
-        # @example
-        #   component_dirs.add "lib" do |dir|
-        #     dir.default_namespace = "my_app"
-        #   end
+        #   @param dir [ComponentDir] the configured component dir
         #
-        # @see ComponentDir
-        def add(path)
+        #   @return [ComponentDir] the added component dir
+        #
+        #   @example
+        #     dir = Dry::System::ComponentDir.new("lib")
+        #     component_dirs.add dir
+        #
+        #   @see ComponentDir
+        #   @api public
+        def add(path_or_dir)
+          path, dir_to_add = path_and_dir(path_or_dir)
+
           raise ComponentDirAlreadyAddedError, path if dirs.key?(path)
 
-          dirs[path] = ComponentDir.new(path).tap do |dir|
-            yield dir if block_given?
+          dirs[path] = dir_to_add.tap do |dir|
+            # Defaults must be applied after yielding, since the dir is being newly added,
+            # and must have its configuration fully in place before we can know which
+            # defaults to apply
+            yield dir if path_or_dir == path && block_given?
             apply_defaults_to_dir(dir)
           end
         end
 
-        # Returns the added component dirs, with default settings applied
+        # Deletes and returns a previously added component dir
+        #
+        # @param path [String] the path for the component dir
+        #
+        # @return [ComponentDir] the removed component dir
+        #
+        # @api public
+        def delete(path)
+          dirs.delete(path)
+        end
+
+        # Returns the paths of the component dirs
+        #
+        # @return [Array<String>] the component dir paths
+        #
+        # @api public
+        def paths
+          dirs.keys
+        end
+
+        # Returns the count of component dirs
         #
-        # @return [Hash<String, ComponentDir>] the component dirs as a hash, keyed by path
-        def dirs
-          @dirs.each { |_, dir| apply_defaults_to_dir(dir) }
+        # @return [Integer]
+        #
+        # @api public
+        def length
+          dirs.length
         end
+        alias_method :size, :length
 
         # Returns the added component dirs, with default settings applied
         #
         # @return [Array<ComponentDir>]
+        #
+        # @api public
         def to_a
+          dirs.each { |_, dir| apply_defaults_to_dir(dir) }
           dirs.values
         end
 
@@ -135,12 +220,46 @@ module Dry
         # argument.
         #
         # @yieldparam dir [ComponentDir] the yielded component dir
+        #
+        # @api public
         def each(&block)
           to_a.each(&block)
         end
 
+        protected
+
+        # Returns the hash of component dirs, keyed by their paths
+        #
+        # Recently changed default configuration may not be applied to these dirs. Use
+        # #to_a or #each to access dirs with default configuration fully applied.
+        #
+        # This method exists to encapsulate the instance variable and to serve the needs
+        # of #initialize_copy
+        #
+        # @return [Hash{String => ComponentDir}]
+        #
+        # @api private
+        attr_reader :dirs
+
         private
 
+        # Converts a path string or pre-built component dir into a path and dir tuple
+        #
+        # @param path_or_dir [String,ComponentDir]
+        #
+        # @return [Array<(String, ComponentDir)>]
+        #
+        # @see #add
+        def path_and_dir(path_or_dir)
+          if path_or_dir.is_a?(ComponentDir)
+            dir = path_or_dir
+            [dir.path, dir]
+          else
+            path = path_or_dir
+            [path, ComponentDir.new(path)]
+          end
+        end
+
         # Applies default settings to a component dir. This is run every time the dirs are
         # accessed to ensure defaults are applied regardless of when new component dirs
         # are added. This method must be idempotent.

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
@@ -21,16 +22,19 @@ module Dry
       #
       # @see Namespaces#add
       #
-      # @api private
+      # @api public
       class Namespace
         ROOT_PATH = nil
 
         include Dry::Equalizer(:path, :key, :const)
 
+        # @api public
         attr_reader :path
 
+        # @api public
         attr_reader :key
 
+        # @api public
         attr_reader :const
 
         # Returns a namespace configured to serve as the default root namespace for a
@@ -48,23 +52,24 @@ module Dry
           )
         end
 
+        # @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
 
+        # @api public
         def root?
           path == ROOT_PATH
         end
 
+        # @api public
         def path?
           !root?
         end
-
-        def default_key?
-          key == path
-        end
       end
     end
   end

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "dry/core/deprecations"
 require "dry/system/errors"
 require_relative "namespace"
 
@@ -26,6 +27,39 @@ module Dry
           @namespaces = source.namespaces.dup
         end
 
+        # Returns the namespace configured for the path, or nil if no such namespace has
+        # been configured
+        #
+        # @return [Namespace, nil] the namespace, if configured
+        #
+        # @api public
+        def namespace(path)
+          namespaces[path]
+        end
+        alias_method :[], :namespace
+
+        # Returns the namespace configured for the root path, or nil if the root namespace
+        # has not been configured
+        #
+        # @return [Namespace, nil] the root namespace, if configured
+        #
+        # @api public
+        def root(**options)
+          if options.any?
+            Dry::Core::Deprecations.announce(
+              "Dry::System::Config::Namespaces#root (with arguments)",
+              "Use `#add_root(key: nil, const: nil)` instead",
+              tag: "dry-system",
+              uplevel: 1
+            )
+
+            add_root(**options)
+            return
+          end
+
+          namespaces[Namespace::ROOT_PATH]
+        end
+
         # rubocop:disable Layout/LineLength
 
         # Adds a component dir namespace
@@ -62,8 +96,8 @@ module Dry
         #
         # @param path [String] the path to the sub-directory of source files to which this
         #   namespace should apply, relative to the component dir
-        # @param identifier [String, nil] the leading namespace to apply to the registered
-        #   identifiers for the components. Set `nil` for the identifiers to be top-level.
+        # @param key [String, nil] the leading namespace to apply to the container keys
+        #   for the components. Set `nil` for the keys to be top-level.
         # @param const [String, nil] the Ruby constant namespace to expect for constants
         #   defined within the components. This should be provided in underscored string
         #   form, e.g. "hello_there/world" for a Ruby constant of `HelloThere::World`. Set
@@ -87,31 +121,84 @@ module Dry
         # @see #add
         #
         # @api public
-        def root(key: nil, const: nil)
+        def add_root(key: nil, const: nil)
           add(Namespace::ROOT_PATH, key: key, const: const)
         end
 
-        # @api private
+        # Deletes the configured namespace for the given path and returns the namespace
+        #
+        # If no namespace was previously configured for the given path, returns nil
+        #
+        # @param path [String] the path for the namespace
+        #
+        # @return [Namespace, nil]
+        #
+        # @api public
+        def delete(path)
+          namespaces.delete(path)
+        end
+
+        # Deletes the configured root namespace and returns the namespace
+        #
+        # If no root namespace was previously configured, returns nil
+        #
+        # @return [Namespace, nil]
+        #
+        # @api public
+        def delete_root
+          delete(Namespace::ROOT_PATH)
+        end
+
+        # Returns the paths of the configured namespaces
+        #
+        # @return [Array<String,nil>] the namespace paths, with nil representing the root
+        #   namespace
+        #
+        # @api public
+        def paths
+          namespaces.keys
+        end
+
+        # Returns the count of configured namespaces
+        #
+        # @return [Integer]
+        #
+        # @api public
+        def length
+          namespaces.length
+        end
+        alias_method :size, :length
+
+        # Returns true if there are no configured namespaces
+        #
+        # @return [Boolean]
+        #
+        # @api public
         def empty?
           namespaces.empty?
         end
 
         # Returns the configured namespaces as an array
         #
-        # This adds a root namespace to the end of the array if one was not configured
-        # manually. This fallback ensures that all components in the component dir can be
-        # loaded.
+        # Adds a default root namespace to the end of the array if one was not added
+        # explicitly. This fallback ensures that all components in the component dir can
+        # be loaded.
         #
         # @return [Array<Namespace>] the namespaces
         #
-        # @api private
+        # @api public
         def to_a
           namespaces.values.tap do |arr|
             arr << Namespace.default_root unless arr.any?(&:root?)
           end
         end
 
-        # @api private
+        # Calls the given block once for each configured namespace, passing the namespace
+        # as an argument.
+        #
+        # @yieldparam namespace [Namespace] the yielded namespace
+        #
+        # @api public
         def each(&block)
           to_a.each(&block)
         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