dry-system 0.15.0 → 0.19.1

data/lib/dry/system/errors.rb

@@ -2,13 +2,22 @@
 
 module Dry
   module System
+    # Error raised when a component dir is added to configuration more than once
+    #
+    # @api public
+    ComponentDirAlreadyAddedError = Class.new(StandardError) do
+      def initialize(dir)
+        super("Component directory #{dir.inspect} already added")
+      end
+    end
+
     # Error raised when the container tries to load a component with missing
     # file
     #
     # @api public
     FileNotFoundError = Class.new(StandardError) do
       def initialize(component)
-        super("could not resolve require file for #{component.identifier}")
+        super("could not resolve require file for component '#{component.identifier}'")
       end
     end
 
@@ -17,25 +26,12 @@ module Dry
     # @api public
     ComponentFileMismatchError = Class.new(StandardError) do
       def initialize(component)
-        path = component.boot_path
-        files = component.container_boot_files
-
         super(<<-STR)
-          Boot file for component #{component.identifier.inspect} not found.
-          Container boot files under #{path}: #{files.inspect}")
+          Bootable component '#{component.identifier}' not found
         STR
       end
     end
 
-    # Error raised when a resolved component couldn't be found
-    #
-    # @api public
-    ComponentLoadError = Class.new(StandardError) do
-      def initialize(component)
-        super("could not load component #{component.inspect}")
-      end
-    end
-
     # Error raised when resolved component couldn't be loaded
     #
     # @api public
@@ -85,8 +81,17 @@ module Dry
       end
     end
 
-    ComponentsDirMissing = Class.new(StandardError)
+    # Error raised when a configured component directory could not be found
+    #
+    # @api public
+    ComponentDirNotFoundError = Class.new(StandardError) do
+      def initialize(dir)
+        super("Component dir '#{dir}' not found")
+      end
+    end
+
     DuplicatedComponentKeyError = Class.new(ArgumentError)
+
     InvalidSettingsError = Class.new(ArgumentError) do
       # @api private
       def initialize(attributes)

data/lib/dry/system/identifier.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require "dry/core/equalizer"
+require_relative "constants"
+
+module Dry
+  module System
+    # An identifier representing a component to be registered.
+    #
+    # Components are eventually registered in the container using plain string
+    # identifiers, available as the `identifier` or `key` attribute here. Additional
+    # methods are provided to make it easier to evaluate or manipulate these identifiers.
+    #
+    # @api public
+    class Identifier
+      include Dry::Equalizer(:identifier, :namespace, :separator)
+
+      # @return [String] the identifier string
+      # @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
+
+      # @api private
+      def initialize(identifier, namespace: nil, separator: DEFAULT_SEPARATOR)
+        @identifier = identifier.to_s
+        @namespace = namespace
+        @separator = separator
+      end
+
+      # @!method key
+      #   Returns the identifier string
+      #
+      #   @return [String]
+      #   @see #identifier
+      #   @api public
+      alias_method :key, :identifier
+
+      # @!method to_s
+      #   Returns the identifier string
+      #
+      #   @return [String]
+      #   @see #identifier
+      #   @api public
+      alias_method :to_s, :identifier
+
+      # Returns the root namespace segment of the identifier string, as a symbol
+      #
+      # @example
+      #   identifier.key # => "articles.operations.create"
+      #   identifier.root_key # => :articles
+      #
+      # @return [Symbol] the root key
+      # @api public
+      def root_key
+        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.
+      #
+      # @example
+      #   identifier.key # => "articles.operations.create"
+      #   identifier.namespace # => "admin"
+      #
+      #   identifier.path # => "admin/articles/operations/create"
+      #
+      # @return [String] the path
+      # @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
+        }
+      end
+
+      # Returns true if the given namespace prefix is part of the identifier's leading
+      # namespaces
+      #
+      # @example
+      #   identifier.key # => "articles.operations.create"
+      #
+      #   identifier.start_with?("articles.operations") # => true
+      #   identifier.start_with?("articles") # => true
+      #   identifier.start_with?("article") # => false
+      #
+      # @param leading_namespaces [String] the one or more leading namespaces to check
+      # @return [Boolean]
+      # @api public
+      def start_with?(leading_namespaces)
+        identifier.start_with?("#{leading_namespaces}#{separator}")
+      end
+
+      # Returns a copy of the identifier with the given leading namespaces removed from
+      # the identifier string.
+      #
+      # Additional options may be provided, which are passed to #initialize when
+      # constructing the new copy of the identifier
+      #
+      # @param leading_namespace [String] the one or more leading namespaces to remove
+      # @param options [Hash] additional options for initialization
+      #
+      # @return [Dry::System::Identifier] the copy of the identifier
+      #
+      # @see #initialize
+      # @api private
+      def dequalified(leading_namespaces, **options)
+        new_identifier = identifier.gsub(
+          /^#{Regexp.escape(leading_namespaces)}#{Regexp.escape(separator)}/,
+          EMPTY_STRING
+        )
+
+        return self if new_identifier == identifier
+
+        self.class.new(
+          new_identifier,
+          namespace: namespace,
+          separator: separator,
+          **options
+        )
+      end
+
+      # Returns a copy of the identifier with the given options applied
+      #
+      # @param namespace [String, nil] a new namespace to be used
+      #
+      # @return [Dry::System::Identifier] the copy of the identifier
+      #
+      # @see #initialize
+      # @api private
+      def with(namespace:)
+        self.class.new(
+          identifier,
+          namespace: namespace,
+          separator: separator
+        )
+      end
+
+      private
+
+      def segments
+        @segments ||= identifier.split(separator)
+      end
+    end
+  end
+end

data/lib/dry/system/lifecycle.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'concurrent/map'
+require "concurrent/map"
 
-require 'dry/system/settings'
+require "dry/system/settings"
 
 module Dry
   module System

data/lib/dry/system/loader.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'dry/inflector'
-
 module Dry
   module System
     # Default component loader implementation
@@ -25,52 +23,53 @@ module Dry
     #
     # @api public
     class Loader
-      # @!attribute [r] path
-      #   @return [String] Path to component's file
-      attr_reader :path
+      class << self
+        # Requires the component's source file
+        #
+        # @api public
+        def require!(component)
+          require(component.path) if component.file_exists?
+          self
+        end
 
-      # @!attribute [r] inflector
-      #   @return [Object] Inflector backend
-      attr_reader :inflector
+        # Returns an instance of the component
+        #
+        # Provided optional args are passed to object's constructor
+        #
+        # @param [Array] args Optional constructor args
+        #
+        # @return [Object]
+        #
+        # @api public
+        def call(component, *args)
+          require!(component)
 
-      # @api private
-      def initialize(path, inflector = Dry::Inflector.new)
-        @path = path
-        @inflector = inflector
-      end
+          constant = self.constant(component)
 
-      # Returns component's instance
-      #
-      # Provided optional args are passed to object's constructor
-      #
-      # @param [Array] args Optional constructor args
-      #
-      # @return [Object]
-      #
-      # @api public
-      def call(*args)
-        if singleton?(constant)
-          constant.instance(*args)
-        else
-          constant.new(*args)
+          if singleton?(constant)
+            constant.instance(*args)
+          else
+            constant.new(*args)
+          end
         end
-      end
-      ruby2_keywords(:call) if respond_to?(:ruby2_keywords, true)
+        ruby2_keywords(:call) if respond_to?(:ruby2_keywords, true)
 
-      # Return component's class constant
-      #
-      # @return [Class]
-      #
-      # @api public
-      def constant
-        inflector.constantize(inflector.camelize(path))
-      end
+        # Returns the component's class constant
+        #
+        # @return [Class]
+        #
+        # @api public
+        def constant(component)
+          inflector = component.inflector
+
+          inflector.constantize(inflector.camelize(component.path))
+        end
 
-      private
+        private
 
-      # @api private
-      def singleton?(constant)
-        constant.respond_to?(:instance) && !constant.respond_to?(:new)
+        def singleton?(constant)
+          constant.respond_to?(:instance) && !constant.respond_to?(:new)
+        end
       end
     end
   end

data/lib/dry/system/loader/autoloading.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "../loader"
+
+module Dry
+  module System
+    class Loader
+      # Component loader for autoloading-enabled applications
+      #
+      # This behaves like the default loader, except instead of requiring the given path,
+      # it loads the respective constant, allowing the autoloader to load the
+      # corresponding file per its own configuration.
+      #
+      # @see Loader
+      # @api public
+      class Autoloading < Loader
+        class << self
+          def require!(component)
+            constant(component)
+            self
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/system/magic_comments_parser.rb

@@ -7,8 +7,8 @@ module Dry
       COMMENT_RE = /^#\s+(?<name>[A-Za-z]{1}[A-Za-z0-9_]+):\s+(?<value>.+?)$/.freeze
 
       COERCIONS = {
-        'true' => true,
-        'false' => false
+        "true" => true,
+        "false" => false
       }.freeze
 
       def self.call(file_name)

data/lib/dry/system/manual_registrar.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry/system/constants'
+require "dry/system/constants"
 
 module Dry
   module System

data/lib/dry/system/plugins.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry/system/constants'
+require "dry/system/constants"
 
 module Dry
   module System
@@ -116,22 +116,22 @@ module Dry
         @enabled_plugins ||= []
       end
 
-      require 'dry/system/plugins/bootsnap'
+      require "dry/system/plugins/bootsnap"
       register(:bootsnap, Plugins::Bootsnap)
 
-      require 'dry/system/plugins/logging'
+      require "dry/system/plugins/logging"
       register(:logging, Plugins::Logging)
 
-      require 'dry/system/plugins/env'
+      require "dry/system/plugins/env"
       register(:env, Plugins::Env)
 
-      require 'dry/system/plugins/notifications'
+      require "dry/system/plugins/notifications"
       register(:notifications, Plugins::Notifications)
 
-      require 'dry/system/plugins/monitoring'
+      require "dry/system/plugins/monitoring"
       register(:monitoring, Plugins::Monitoring)
 
-      require 'dry/system/plugins/dependency_graph'
+      require "dry/system/plugins/dependency_graph"
       register(:dependency_graph, Plugins::DependencyGraph)
     end
   end

data/lib/dry/system/plugins/bootsnap.rb

@@ -22,7 +22,7 @@ module Dry
 
         # @api private
         def self.dependencies
-          { bootsnap: 'bootsnap' }
+          {bootsnap: "bootsnap"}
         end
 
         # Set up bootsnap for faster booting
@@ -31,12 +31,12 @@ module Dry
         def setup_bootsnap
           return unless bootsnap_available?
 
-          ::Bootsnap.setup(config.bootsnap.merge(cache_dir: root.join('tmp/cache').to_s))
+          ::Bootsnap.setup(config.bootsnap.merge(cache_dir: root.join("tmp/cache").to_s))
         end
 
         # @api private
         def bootsnap_available?
-          RUBY_ENGINE == 'ruby' && RUBY_VERSION >= '2.3.0' && RUBY_VERSION < '2.5.0'
+          RUBY_ENGINE == "ruby" && RUBY_VERSION >= "2.3.0" && RUBY_VERSION < "2.5.0"
         end
       end
     end