dry-system 0.19.2 → 0.23.0

data/lib/dry/system/errors.rb

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
+require "dry/core/deprecations"
+
 module Dry
   module System
+    extend Dry::Core::Deprecations["dry-system"]
+
     # Error raised when a component dir is added to configuration more than once
     #
     # @api public
@@ -11,64 +15,61 @@ module Dry
       end
     end
 
-    # Error raised when the container tries to load a component with missing
-    # file
+    # Error raised when a configured component directory could not be found
     #
     # @api public
-    FileNotFoundError = Class.new(StandardError) do
-      def initialize(component)
-        super("could not resolve require file for component '#{component.identifier}'")
+    ComponentDirNotFoundError = Class.new(StandardError) do
+      def initialize(dir)
+        super("Component dir '#{dir}' not found")
       end
     end
 
-    # Error raised when booter file do not match with register component
+    # Error raised when a namespace for a component dir is added to configuration more
+    # than once
     #
     # @api public
-    ComponentFileMismatchError = Class.new(StandardError) do
-      def initialize(component)
-        super(<<-STR)
-          Bootable component '#{component.identifier}' not found
-        STR
-      end
-    end
+    NamespaceAlreadyAddedError = Class.new(StandardError) do
+      def initialize(path)
+        path_label = path ? "path #{path.inspect}" : "root path"
 
-    # Error raised when resolved component couldn't be loaded
-    #
-    # @api public
-    InvalidComponentError = Class.new(ArgumentError) do
-      def initialize(name, reason = nil)
-        super(
-          "Tried to create an invalid #{name.inspect} component - #{reason}"
-        )
+        super("Namespace for #{path_label} already added")
       end
     end
 
-    # Error raised when component's identifier is not valid
+    # Error raised when attempting to register provider using a name that has already been
+    # registered
     #
     # @api public
-    InvalidComponentIdentifierError = Class.new(ArgumentError) do
-      def initialize(name)
-        super(
-          "component identifier +#{name}+ is invalid or boot file is missing"
-        )
+    ProviderAlreadyRegisteredError = Class.new(ArgumentError) do
+      def initialize(provider_name)
+        super("Provider #{provider_name.inspect} has already been registered")
       end
     end
+    DuplicatedComponentKeyError = ProviderAlreadyRegisteredError
+    deprecate_constant :DuplicatedComponentKeyError
 
-    # Error raised when component's identifier for booting is not a symbol
+    # Error raised when a named provider could not be found
     #
     # @api public
-    InvalidComponentIdentifierTypeError = Class.new(ArgumentError) do
+    ProviderNotFoundError = Class.new(ArgumentError) do
       def initialize(name)
-        super("component identifier #{name.inspect} must be a symbol")
+        super("Provider #{name.inspect} not found")
       end
     end
+    InvalidComponentError = ProviderNotFoundError
+    deprecate_constant :InvalidComponentError
 
-    # Error raised when trying to stop a component that hasn't started yet
+    # Error raised when a named provider source could not be found
     #
     # @api public
-    ComponentNotStartedError = Class.new(StandardError) do
-      def initialize(component_name)
-        super("component +#{component_name}+ has not been started")
+    ProviderSourceNotFoundError = Class.new(StandardError) do
+      def initialize(name:, group:, keys:)
+        msg = "Provider source not found: #{name.inspect}, group: #{group.inspect}"
+
+        key_list = keys.map { |key| "- #{key[:name].inspect}, group: #{key[:group].inspect}" }
+        msg += "Available provider sources:\n\n#{key_list}"
+
+        super(msg)
       end
     end
 
@@ -81,43 +82,53 @@ module Dry
       end
     end
 
-    # Error raised when a configured component directory could not be found
+    # Exception raise when a plugin dependency failed to load
     #
     # @api public
-    ComponentDirNotFoundError = Class.new(StandardError) do
-      def initialize(dir)
-        super("Component dir '#{dir}' not found")
+    PluginDependencyMissing = Class.new(StandardError) do
+      # @api private
+      def initialize(plugin, message, gem = nil)
+        details = gem ? "#{message} - add #{gem} to your Gemfile" : message
+        super("dry-system plugin #{plugin.inspect} failed to load its dependencies: #{details}")
       end
     end
 
-    DuplicatedComponentKeyError = Class.new(ArgumentError)
-
-    InvalidSettingsError = Class.new(ArgumentError) do
+    # Exception raised when auto-registerable component is not loadable
+    #
+    # @api public
+    ComponentNotLoadableError = Class.new(NameError) do
       # @api private
-      def initialize(attributes)
-        message = <<~STR
-          Could not initialize settings. The following settings were invalid:
+      def initialize(component, error,
+                     corrections: DidYouMean::ClassNameChecker.new(error).corrections)
+        full_class_name = [error.receiver, error.name].join("::")
 
-          #{attributes_errors(attributes).join("\n")}
-        STR
-        super(message)
-      end
+        message = [
+          "Component '#{component.key}' is not loadable.",
+          "Looking for #{full_class_name}."
+        ]
 
-      private
+        if corrections.any?
+          case_correction = corrections.find { |correction| correction.casecmp?(full_class_name) }
+          if case_correction
+            acronyms_needed = case_correction.split("::").difference(full_class_name.split("::"))
+            stringified_acronyms_needed = acronyms_needed.map { |acronym|
+              "'#{acronym}'"
+            } .join(", ")
+            message <<
+              <<~ERROR_MESSAGE
 
-      def attributes_errors(attributes)
-        attributes.map { |key, error| "#{key.name}: #{error}" }
-      end
-    end
+                You likely need to add:
 
-    # Exception raise when a plugin dependency failed to load
-    #
-    # @api public
-    PluginDependencyMissing = Class.new(StandardError) do
-      # @api private
-      def initialize(plugin, message, gem = nil)
-        details = gem ? "#{message} - add #{gem} to your Gemfile" : message
-        super("dry-system plugin #{plugin.inspect} failed to load its dependencies: #{details}")
+                    acronym(#{stringified_acronyms_needed})
+
+                to your container's inflector, since we found a #{case_correction} class.
+              ERROR_MESSAGE
+          else
+            message << DidYouMean.formatter.message_for(corrections)
+          end
+        end
+
+        super message.join("\n")
       end
     end
   end

data/lib/dry/system/identifier.rb

@@ -13,42 +13,24 @@ module Dry
     #
     # @api public
     class Identifier
-      include Dry::Equalizer(:identifier, :namespace, :separator)
+      include Dry::Equalizer(:key)
 
-      # @return [String] the identifier string
+      # @return [String] the identifier's string key
       # @api public
-      attr_reader :identifier
-
-      # @return [String, nil] the namespace for the component
-      # @api public
-      attr_reader :namespace
-
-      # @return [String] the configured namespace separator
-      # @api public
-      attr_reader :separator
+      attr_reader :key
 
       # @api private
-      def initialize(identifier, namespace: nil, separator: DEFAULT_SEPARATOR)
-        @identifier = identifier.to_s
-        @namespace = namespace
-        @separator = separator
+      def initialize(key)
+        @key = key.to_s
       end
 
-      # @!method key
-      #   Returns the identifier string
-      #
-      #   @return [String]
-      #   @see #identifier
-      #   @api public
-      alias_method :key, :identifier
-
       # @!method to_s
-      #   Returns the identifier string
+      #   Returns the identifier string key
       #
       #   @return [String]
-      #   @see #identifier
+      #   @see #key
       #   @api public
-      alias_method :to_s, :identifier
+      alias_method :to_s, :key
 
       # Returns the root namespace segment of the identifier string, as a symbol
       #
@@ -62,95 +44,133 @@ module Dry
         segments.first.to_sym
       end
 
-      # Returns a path-delimited representation of the identifier, with the namespace
-      # incorporated. This path is intended for usage when requiring the component's
-      # source file.
+      # Returns true if the given leading segments string is a leading part of the {key}.
+      #
+      # Also returns true if nil or an empty string is given.
       #
       # @example
       #   identifier.key # => "articles.operations.create"
-      #   identifier.namespace # => "admin"
       #
-      #   identifier.path # => "admin/articles/operations/create"
+      #   identifier.start_with?("articles.operations") # => true
+      #   identifier.start_with?("articles") # => true
+      #   identifier.start_with?("article") # => false
+      #   identifier.start_with?(nil) # => true
       #
-      # @return [String] the path
+      # @param leading_segments [String] the one or more leading segments to check
+      # @return [Boolean]
       # @api public
-      def path
-        @require_path ||= identifier.gsub(separator, PATH_SEPARATOR).yield_self { |path|
-          if namespace
-            namespace_path = namespace.to_s.gsub(separator, PATH_SEPARATOR)
-            "#{namespace_path}#{PATH_SEPARATOR}#{path}"
-          else
-            path
-          end
-        }
+      def start_with?(leading_segments)
+        leading_segments.to_s.empty? ||
+          key.start_with?("#{leading_segments}#{KEY_SEPARATOR}") ||
+          key.eql?(leading_segments)
       end
 
-      # Returns true if the given namespace prefix is part of the identifier's leading
-      # namespaces
+      # Returns true if the given trailing segments string is the end part of the {key}.
+      #
+      # Also returns true if nil or an empty string is given.
       #
       # @example
       #   identifier.key # => "articles.operations.create"
       #
-      #   identifier.start_with?("articles.operations") # => true
-      #   identifier.start_with?("articles") # => true
-      #   identifier.start_with?("article") # => false
+      #   identifier.end_with?("create") # => true
+      #   identifier.end_with?("operations.create") # => true
+      #   identifier.end_with?("ate") # => false, not a whole segment
+      #   identifier.end_with?("nup") # => false, not in key at all
       #
-      # @param leading_namespaces [String] the one or more leading namespaces to check
+      # @param trailing_segments [String] the one or more trailing key segments to check
       # @return [Boolean]
       # @api public
-      def start_with?(leading_namespaces)
-        identifier.start_with?("#{leading_namespaces}#{separator}")
+      def end_with?(trailing_segments)
+        trailing_segments.to_s.empty? ||
+          key.end_with?("#{KEY_SEPARATOR}#{trailing_segments}") ||
+          key.eql?(trailing_segments)
       end
 
-      # Returns a copy of the identifier with the given leading namespaces removed from
-      # the identifier string.
+      # Returns true if the given segments string matches whole segments within the {key}.
       #
-      # Additional options may be provided, which are passed to #initialize when
-      # constructing the new copy of the identifier
+      # @example
+      #   identifier.key # => "articles.operations.create"
       #
-      # @param leading_namespace [String] the one or more leading namespaces to remove
-      # @param options [Hash] additional options for initialization
+      #   identifier.include?("operations") # => true
+      #   identifier.include?("articles.operations") # => true
+      #   identifier.include?("operations.create") # => true
       #
-      # @return [Dry::System::Identifier] the copy of the identifier
+      #   identifier.include?("article") # => false, not a whole segment
+      #   identifier.include?("update") # => false, not in key at all
       #
-      # @see #initialize
-      # @api private
-      def dequalified(leading_namespaces, **options)
-        new_identifier = identifier.gsub(
-          /^#{Regexp.escape(leading_namespaces)}#{Regexp.escape(separator)}/,
-          EMPTY_STRING
+      # @param segments [String] the one of more key segments to check
+      # @return [Boolean]
+      # @api public
+      def include?(segments)
+        return false if segments.to_s.empty?
+
+        sep_re = Regexp.escape(KEY_SEPARATOR)
+        key.match?(
+          /
+            (\A|#{sep_re})
+            #{Regexp.escape(segments)}
+            (\Z|#{sep_re})
+          /x
         )
+      end
 
-        return self if new_identifier == identifier
-
-        self.class.new(
-          new_identifier,
-          namespace: namespace,
-          separator: separator,
-          **options
-        )
+      # Returns the key with its segments separated by the given separator
+      #
+      # @example
+      #   identifier.key # => "articles.operations.create"
+      #   identifier.key_with_separator("/") # => "articles/operations/create"
+      #
+      # @return [String] the key using the separator
+      # @api private
+      def key_with_separator(separator)
+        segments.join(separator)
       end
 
-      # Returns a copy of the identifier with the given options applied
+      # Returns a copy of the identifier with the key's leading namespace(s) replaced
       #
-      # @param namespace [String, nil] a new namespace to be used
+      # @example Changing a namespace
+      #   identifier.key # => "articles.operations.create"
+      #   identifier.namespaced(from: "articles", to: "posts").key # => "posts.commands.create"
+      #
+      # @example Removing a namespace
+      #   identifier.key # => "articles.operations.create"
+      #   identifier.namespaced(from: "articles", to: nil).key # => "operations.create"
+      #
+      # @example Adding a namespace
+      #   identifier.key # => "articles.operations.create"
+      #   identifier.namespaced(from: nil, to: "admin").key # => "admin.articles.operations.create"
+      #
+      # @param from [String, nil] the leading namespace(s) to replace
+      # @param to [String, nil] the replacement for the leading namespace
       #
       # @return [Dry::System::Identifier] the copy of the identifier
       #
       # @see #initialize
       # @api private
-      def with(namespace:)
-        self.class.new(
-          identifier,
-          namespace: namespace,
-          separator: separator
-        )
+      def namespaced(from:, to:)
+        return self if from == to
+
+        separated_to = "#{to}#{KEY_SEPARATOR}" if to
+
+        new_key =
+          if from.nil?
+            "#{separated_to}#{key}"
+          else
+            key.sub(
+              /^#{Regexp.escape(from.to_s)}#{Regexp.escape(KEY_SEPARATOR)}/,
+              separated_to || EMPTY_STRING
+            )
+          end
+
+        return self if new_key == key
+
+        self.class.new(new_key)
       end
 
       private
 
       def segments
-        @segments ||= identifier.split(separator)
+        @segments ||= key.split(KEY_SEPARATOR)
       end
     end
   end

data/lib/dry/system/importer.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require "dry/container"
+require_relative "constants"
+
 module Dry
   module System
     # Default importer implementation
@@ -11,25 +14,34 @@ module Dry
     #
     # @api private
     class Importer
-      attr_reader :container
+      # @api private
+      class Item
+        attr_reader :namespace, :container, :import_keys
+
+        def initialize(namespace:, container:, import_keys:)
+          @namespace = namespace
+          @container = container
+          @import_keys = import_keys
+        end
+      end
 
-      attr_reader :separator
+      attr_reader :container
 
       attr_reader :registry
 
       # @api private
       def initialize(container)
         @container = container
-        @separator = container.config.namespace_separator
         @registry = {}
       end
 
       # @api private
-      def finalize!
-        registry.each do |name, container|
-          call(name, container.finalize!)
-        end
-        self
+      def register(namespace:, container:, keys: nil)
+        registry[namespace] = Item.new(
+          namespace: namespace,
+          container: container,
+          import_keys: keys
+        )
       end
 
       # @api private
@@ -41,15 +53,74 @@ module Dry
       def key?(name)
         registry.key?(name)
       end
+      alias_method :namespace?, :key?
 
       # @api private
-      def call(ns, other)
-        container.merge(other, namespace: ns)
+      def finalize!
+        registry.each_key { import(_1) }
+        self
       end
 
       # @api private
-      def register(other)
-        registry.update(other)
+      def import(namespace, keys: Undefined)
+        item = self[namespace]
+        keys = Undefined.default(keys, item.import_keys)
+
+        if keys
+          import_keys(item.container, namespace, keys_to_import(keys, item))
+        else
+          import_all(item.container, namespace)
+        end
+
+        self
+      end
+
+      private
+
+      def keys_to_import(keys, item)
+        keys
+          .then { (arr = item.import_keys) ? _1 & arr : _1 }
+          .then { (arr = item.container.exports) ? _1 & arr : _1 }
+      end
+
+      def import_keys(other, namespace, keys)
+        container.merge(build_merge_container(other, keys), namespace: namespace)
+      end
+
+      def import_all(other, namespace)
+        merge_container =
+          if other.exports
+            build_merge_container(other, other.exports)
+          else
+            build_merge_container(other.finalize!, other.keys)
+          end
+
+        container.merge(merge_container, namespace: namespace)
+      end
+
+      def build_merge_container(other, keys)
+        keys.each_with_object(Dry::Container.new) { |key, ic|
+          next unless other.key?(key)
+
+          # Access the other container's items directly so that we can preserve all their
+          # options when we merge them with the target container (e.g. if a component in
+          # the provider container was registered with a block, we want block registration
+          # behavior to be exhibited when later resolving that component from the target
+          # container). TODO: Make this part of dry-system's public API.
+          item = other._container[key]
+
+          # By default, we "protect" components that were themselves imported into the
+          # other container from being implicitly exported; imported components are
+          # considered "private" and must be explicitly included in `exports` to be
+          # exported.
+          next if item.options[:imported] && !other.exports
+
+          if item.callable?
+            ic.register(key, **item.options, imported: true, &item.item)
+          else
+            ic.register(key, item.item, **item.options, imported: true)
+          end
+        }
       end
     end
   end

data/lib/dry/system/indirect_component.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "dry/core/equalizer"
+
+module Dry
+  module System
+    # An indirect component is a component that cannot be directly from a source file
+    # directly managed by the container. It may be component that needs to be loaded
+    # indirectly, either via a registration manifest file or an imported container
+    #
+    # Indirect components are an internal abstraction and, unlike ordinary components, are
+    # not exposed to users via component dir configuration hooks.
+    #
+    # @see Container#load_component
+    # @see Container#find_component
+    #
+    # @api private
+    class IndirectComponent
+      include Dry::Equalizer(:identifier)
+
+      # @!attribute [r] identifier
+      #   @return [String] the component's unique identifier
+      attr_reader :identifier
+
+      # @api private
+      def initialize(identifier)
+        @identifier = identifier
+      end
+
+      # Returns false, indicating that the component is not directly loadable from the
+      # files managed by the container
+      #
+      # This is the inverse of {Component#loadable?}
+      #
+      # @return [FalseClass]
+      #
+      # @api private
+      def loadable?
+        false
+      end
+
+      # Returns the component's unique key
+      #
+      # @return [String] the key
+      #
+      # @see Identifier#key
+      #
+      # @api private
+      def key
+        identifier.to_s
+      end
+
+      # Returns the root namespace segment of the component's key, as a symbol
+      #
+      # @see Identifier#root_key
+      #
+      # @return [Symbol] the root key
+      #
+      # @api private
+      def root_key
+        identifier.root_key
+      end
+    end
+  end
+end

data/lib/dry/system/loader.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "dry/system/errors"
+
 module Dry
   module System
     # Default component loader implementation
@@ -17,7 +19,7 @@ module Dry
     #   class MyApp < Dry::System::Container
     #     configure do |config|
     #       # ...
-    #       config.loader MyLoader
+    #       config.component_dirs.loader = MyLoader
     #     end
     #   end
     #
@@ -28,7 +30,7 @@ module Dry
         #
         # @api public
         def require!(component)
-          require(component.path) if component.file_exists?
+          require(component.require_path)
           self
         end
 
@@ -61,8 +63,10 @@ module Dry
         # @api public
         def constant(component)
           inflector = component.inflector
-
-          inflector.constantize(inflector.camelize(component.path))
+          const_name = inflector.camelize(component.const_path)
+          inflector.constantize(const_name)
+        rescue NameError => e
+          raise ComponentNotLoadableError.new(component, e)
         end
 
         private