dry-system 0.18.1 → 0.19.0

data/lib/dry/system/component_dir.rb

@@ -0,0 +1,128 @@
+require "pathname"
+require_relative "constants"
+require_relative "identifier"
+require_relative "magic_comments_parser"
+
+module Dry
+  module System
+    # A configured component directory within the container's root. Provides access to the
+    # component directory's configuration, as well as methods for locating component files
+    # within the directory
+    #
+    # @see Dry::System::Config::ComponentDir
+    # @api private
+    class ComponentDir
+      # @!attribute [r] config
+      #   @return [Dry::System::Config::ComponentDir] the component directory configuration
+      #   @api private
+      attr_reader :config
+
+      # @!attribute [r] container
+      #   @return [Dry::System::Container] the container managing the component directory
+      #   @api private
+      attr_reader :container
+
+      # @api private
+      def initialize(config:, container:)
+        @config = config
+        @container = container
+      end
+
+      # Returns a component for a given identifier if a matching component file could be
+      # found within the component dir
+      #
+      # This will search within the component dir's configured default_namespace first,
+      # then fall back to searching for a non-namespaced file
+      #
+      # @param identifier [String] the identifier string
+      # @return [Dry::System::Component, nil] the component, if found
+      #
+      # @api private
+      def component_for_identifier(identifier)
+        identifier = Identifier.new(
+          identifier,
+          namespace: default_namespace,
+          separator: container.config.namespace_separator
+        )
+
+        if (file_path = find_component_file(identifier.path))
+          return build_component(identifier, file_path)
+        end
+
+        identifier = identifier.with(namespace: nil)
+        if (file_path = find_component_file(identifier.path))
+          build_component(identifier, file_path)
+        end
+      end
+
+      # Returns a component for a full path to a Ruby source file within the component dir
+      #
+      # @param path [String] the full path to the file
+      # @return [Dry::System::Component] the component
+      #
+      # @api private
+      def component_for_path(path)
+        separator = container.config.namespace_separator
+
+        key = Pathname(path).relative_path_from(full_path).to_s
+          .sub(RB_EXT, EMPTY_STRING)
+          .scan(WORD_REGEX)
+          .join(separator)
+
+        identifier = Identifier.new(key, separator: separator)
+
+        if identifier.start_with?(default_namespace)
+          identifier = identifier.dequalified(default_namespace, namespace: default_namespace)
+        end
+
+        build_component(identifier, path)
+      end
+
+      # Returns the full path of the component directory
+      #
+      # @return [Pathname]
+      # @api private
+      def full_path
+        container.root.join(path)
+      end
+
+      # @api private
+      def component_options
+        {
+          auto_register: auto_register,
+          loader: loader,
+          memoize: memoize
+        }
+      end
+
+      private
+
+      def build_component(identifier, file_path)
+        options = {
+          inflector: container.config.inflector,
+          **component_options,
+          **MagicCommentsParser.(file_path)
+        }
+
+        Component.new(identifier, file_path: file_path, **options)
+      end
+
+      def find_component_file(component_path)
+        component_file = full_path.join("#{component_path}#{RB_EXT}")
+        component_file if component_file.exist?
+      end
+
+      def method_missing(name, *args, &block)
+        if config.respond_to?(name)
+          config.public_send(name, *args, &block)
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(name, include_all = false)
+        config.respond_to?(name) || super
+      end
+    end
+  end
+end

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

@@ -0,0 +1,202 @@
+require "dry/configurable"
+require "dry/system/loader"
+
+module Dry
+  module System
+    module Config
+      class ComponentDir
+        include Dry::Configurable
+
+        # @!group Settings
+
+        # @!method auto_register=(policy)
+        #
+        #   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
+        #   boolean to configure auto-registration on a per-component basis
+        #
+        #   Defaults to `true`.
+        #
+        #   @param policy [Boolean, Proc]
+        #   @return [Boolean, Proc]
+        #
+        #   @example
+        #     dir.auto_register = false
+        #
+        #   @example
+        #     dir.auto_register = proc do |component|
+        #       !component.start_with?("entities")
+        #     end
+        #
+        #   @see auto_register
+        #   @see Component
+        #
+        # @!method auto_register
+        #
+        #   Returns the configured auto-registration policy.
+        #
+        #   @return [Boolean, Proc] the configured policy
+        #
+        #   @see auto_register=
+        setting :auto_register, 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
+        #
+        # @!method add_to_load_path
+        #
+        #   Returns the configured value.
+        #
+        #   @return [Boolean]
+        #
+        #   @see add_to_load_path=
+        setting :add_to_load_path, true
+
+        # @!method default_namespace=(leading_namespace)
+        #
+        #   Sets the leading namespace segments to be stripped when registering components
+        #   from the dir in the container.
+        #
+        #   This is useful to configure when the dir contains components in a module
+        #   namespace that you don't want repeated in their identifiers.
+        #
+        #   Defaults to `nil`.
+        #
+        #   @param leading_namespace [String, nil]
+        #   @return [String, nil]
+        #
+        #   @example
+        #     dir.default_namespace = "my_app"
+        #
+        #   @example
+        #     dir.default_namespace = "my_app.admin"
+        #
+        #   @see default_namespace
+        #
+        # @!method default_namespace
+        #
+        #   Returns the configured value.
+        #
+        #   @return [String, nil]
+        #
+        #   @see default_namespace=
+        setting :default_namespace
+
+        # @!method loader=(loader)
+        #
+        #   Sets the loader to use when registering coponents from the dir in the container.
+        #
+        #   Defaults to `Dry::System::Loader`.
+        #
+        #   When using a class autoloader, consider using `Dry::System::Loader::Autoloading`
+        #
+        #   @param loader [#call] the loader
+        #   @return [#call] the configured loader
+        #
+        #   @see loader
+        #   @see Loader
+        #   @see Loader::Autoloading
+        #
+        # @!method loader
+        #
+        #   Returns the configured loader.
+        #
+        #   @return [#call]
+        #
+        #   @see loader=
+        setting :loader, Dry::System::Loader
+
+        # @!method memoize=(policy)
+        #
+        #   Sets whether to memoize components from the dir when registered in the
+        #   container.
+        #
+        #   This may be a simple boolean to enable or disable memoization for all
+        #   components, or a proc accepting a `Dry::Sytem::Component` and returning a
+        #   boolean to configure memoization on a per-component basis
+        #
+        #   Defaults to `false`.
+        #
+        #   @param policy [Boolean, Proc]
+        #   @return [Boolean, Proc] the configured memoization policy
+        #
+        #   @example
+        #     dir.memoize = true
+        #
+        #   @example
+        #     dir.memoize = proc do |component|
+        #       !component.start_with?("providers")
+        #     end
+        #
+        #   @see memoize
+        #   @see Component
+        #
+        # @!method memoize
+        #
+        #   Returns the configured memoization policy.
+        #
+        #   @return [Boolean, Proc] the configured memoization policy
+        #
+        #   @see memoize=
+        setting :memoize, false
+
+        # @!endgroup
+
+        # Returns the component dir path, relative to the configured container root
+        #
+        # @return [String] the path
+        attr_reader :path
+
+        # @api private
+        def initialize(path)
+          super()
+          @path = path
+          yield self if block_given?
+        end
+
+        # @api private
+        def auto_register?
+          !!config.auto_register
+        end
+
+        # Returns true if a setting has been explicitly configured and is not returning
+        # just a default value.
+        #
+        # This is used to determine which settings from `ComponentDirs` should be applied
+        # as additional defaults.
+        #
+        # @api private
+        def configured?(key)
+          config._settings[key].input_defined?
+        end
+
+        private
+
+        def method_missing(name, *args, &block)
+          if config.respond_to?(name)
+            config.public_send(name, *args, &block)
+          else
+            super
+          end
+        end
+
+        def respond_to_missing?(name, include_all = false)
+          config.respond_to?(name) || super
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,184 @@
+require "concurrent/map"
+require "dry/configurable"
+require "dry/system/constants"
+require "dry/system/errors"
+require_relative "component_dir"
+
+module Dry
+  module System
+    module Config
+      class ComponentDirs
+        include Dry::Configurable
+
+        # Settings from ComponentDir are configured here as defaults for all added dirs
+        ComponentDir._settings.each do |setting|
+          _settings << setting.dup
+        end
+
+        # @!group Settings
+
+        # @!method auto_register=(value)
+        #
+        #   Sets a default `auto_register` for all added component dirs
+        #
+        #   @see ComponentDir.auto_register
+        #   @see auto_register
+        #
+        # @!method auto_register
+        #
+        #   Returns the configured default `auto_register`
+        #
+        #   @see auto_register=
+
+        # @!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=
+
+        # @!method default_namespace=(value)
+        #
+        #   Sets a default `default_namespace` value for all added component dirs
+        #
+        #   @see ComponentDir.default_namespace
+        #   @see default_namespace
+        #
+        # @!method default_namespace
+        #
+        #   Returns the configured default `default_namespace`
+        #
+        #   @see default_namespace=
+
+        # @!method loader=(value)
+        #
+        #   Sets a default `loader` value for all added component dirs
+        #
+        #   @see ComponentDir.loader
+        #   @see loader
+        #
+        # @!method loader
+        #
+        #   Returns the configured default `loader`
+        #
+        #   @see loader=
+
+        # @!method memoize=(value)
+        #
+        #   Sets a default `memoize` value for all added component dirs
+        #
+        #   @see ComponentDir.memoize
+        #   @see memoize
+        #
+        # @!method memoize
+        #
+        #   Returns the configured default `memoize`
+        #
+        #   @see memoize=
+
+        # @!endgroup
+
+        # @api private
+        def initialize
+          @dirs = Concurrent::Map.new
+        end
+
+        # @api private
+        def initialize_copy(source)
+          super
+          @dirs = source.dirs.dup
+        end
+
+        # Adds and configures a component dir
+        #
+        # @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
+        #
+        # @example
+        #   component_dirs.add "lib" do |dir|
+        #     dir.default_namespace = "my_app"
+        #   end
+        #
+        # @see ComponentDir
+        def add(path)
+          raise ComponentDirAlreadyAddedError, path if dirs.key?(path)
+
+          dirs[path] = ComponentDir.new(path).tap do |dir|
+            apply_defaults_to_dir(dir)
+            yield dir if block_given?
+          end
+        end
+
+        # Returns the added component dirs, with default settings applied
+        #
+        # @return [Hash<String, ComponentDir>] the component dirs as a hash, keyed by path
+        def dirs
+          @dirs.each { |_, dir| apply_defaults_to_dir(dir) }
+        end
+
+        # Returns the added component dirs, with default settings applied
+        #
+        # @return [Array<ComponentDir>]
+        def to_a
+          dirs.values
+        end
+
+        # Calls the given block once for each added component dir, passing the dir as an
+        # argument.
+        #
+        # @yieldparam dir [ComponentDir] the yielded component dir
+        def each(&block)
+          to_a.each(&block)
+        end
+
+        private
+
+        # Apply 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.
+        #
+        # @return [void]
+        def apply_defaults_to_dir(dir)
+          dir.config.values.each do |key, _value|
+            if configured?(key) && !dir.configured?(key)
+              dir.public_send(:"#{key}=", public_send(key))
+            end
+          end
+        end
+
+        # Returns true if a setting has been explicitly configured and is not returning
+        # just a default value.
+        #
+        # This is used to determine which settings should be applied to added component
+        # dirs as additional defaults.
+        #
+        # @api private
+        def configured?(key)
+          config._settings[key].input_defined?
+        end
+
+        def method_missing(name, *args, &block)
+          if config.respond_to?(name)
+            config.public_send(name, *args, &block)
+          else
+            super
+          end
+        end
+
+        def respond_to_missing?(name, include_all = false)
+          config.respond_to?(name) || super
+        end
+      end
+    end
+  end
+end