dry-system 0.20.0 → 0.21.0

data/lib/dry/system/identifier.rb

@@ -13,42 +13,29 @@ module Dry
     #
     # @api public
     class Identifier
-      include Dry::Equalizer(:identifier, :namespace, :separator)
+      include Dry::Equalizer(:key, :separator)
 
-      # @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
+      attr_reader :key
 
       # @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
+      def initialize(key, separator: DEFAULT_SEPARATOR)
+        @key = key.to_s
         @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
+      #   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,31 +49,11 @@ 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.
-      #
-      # @example
-      #   identifier.key # => "articles.operations.create"
-      #   identifier.namespace # => "admin"
+      # Returns true if the given leading namespaces are a leading part of the
+      # identifier's key
       #
-      #   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
+      # Also returns true if nil is given (technically, from nothing everything is
+      # wrought)
       #
       # @example
       #   identifier.key # => "articles.operations.create"
@@ -94,64 +61,74 @@ module Dry
       #   identifier.start_with?("articles.operations") # => true
       #   identifier.start_with?("articles") # => true
       #   identifier.start_with?("article") # => false
+      #   identifier.start_with?(nil) # => true
       #
       # @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}") ||
-          identifier.eql?(leading_namespaces)
+        leading_namespaces.nil? ||
+          key.start_with?("#{leading_namespaces}#{separator}") ||
+          key.eql?(leading_namespaces)
       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
+      # Returns the key with its segments separated by the given separator
       #
-      # @return [Dry::System::Identifier] the copy of the identifier
+      # @example
+      #   identifier.key # => "articles.operations.create"
+      #   identifier.key_with_separator("/") # => "articles/operations/create"
       #
-      # @see #initialize
+      # @return [String] the key using the separator
       # @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
-        )
+      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
+      #
+      # @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"
       #
-      # @param namespace [String, nil] a new namespace to be used
+      # @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}#{separator}" if to
+
+        new_key =
+          if from.nil?
+            "#{separated_to}#{key}"
+          else
+            key.sub(
+              /^#{Regexp.escape(from.to_s)}#{Regexp.escape(separator)}/,
+              separated_to || EMPTY_STRING
+            )
+          end
+
+        return self if new_key == key
+
+        self.class.new(new_key, separator: separator)
       end
 
       private
 
       def segments
-        @segments ||= identifier.split(separator)
+        @segments ||= key.split(separator)
       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 manual registration 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

@@ -28,7 +28,7 @@ module Dry
         #
         # @api public
         def require!(component)
-          require(component.path) if component.file_exists?
+          require(component.require_path)
           self
         end
 
@@ -61,8 +61,7 @@ module Dry
         # @api public
         def constant(component)
           inflector = component.inflector
-
-          inflector.constantize(inflector.camelize(component.path))
+          inflector.constantize(inflector.camelize(component.const_path))
         end
 
         private

data/lib/dry/system/manual_registrar.rb

@@ -30,16 +30,12 @@ module Dry
       end
 
       # @api private
-      def call(name)
-        name = name.respond_to?(:root_key) ? name.root_key.to_s : name
-
-        require(root.join(config.registrations_dir, name))
+      def call(component)
+        require(root.join(config.registrations_dir, component.root_key.to_s))
       end
 
-      def file_exists?(name)
-        name = name.respond_to?(:root_key) ? name.root_key.to_s : name
-
-        File.exist?(File.join(registrations_dir, "#{name}#{RB_EXT}"))
+      def file_exists?(component)
+        File.exist?(File.join(registrations_dir, "#{component.root_key}#{RB_EXT}"))
       end
 
       private

data/lib/dry/system/plugins.rb

@@ -84,9 +84,7 @@ module Dry
       # Enables a plugin if not already enabled.
       # Raises error if plugin cannot be found in the plugin registry.
       #
-      # Plugin identifier
-      #
-      # @param [Symbol] name The plugin identifier
+      # @param [Symbol] name The plugin name
       # @param [Hash] options Plugin options
       #
       # @return [self]

data/lib/dry/system/provider.rb

@@ -7,14 +7,14 @@ require "dry/system/components/bootable"
 module Dry
   module System
     class Provider
-      attr_reader :identifier
+      attr_reader :name
 
       attr_reader :options
 
       attr_reader :components
 
-      def initialize(identifier, options)
-        @identifier = identifier
+      def initialize(name, options)
+        @name = name
         @options = options
         @components = Concurrent::Map.new
       end
@@ -35,9 +35,9 @@ module Dry
         boot_files.detect { |path| Pathname(path).basename(RB_EXT).to_s == name.to_s }
       end
 
-      def component(name, options = {})
-        identifier = options[:key] || name
-        components.fetch(identifier).new(name, options)
+      def component(component_name, options = {})
+        component_key = options[:key] || component_name
+        components.fetch(component_key).new(component_name, options)
       end
 
       def load_components

data/lib/dry/system/provider_registry.rb

@@ -15,12 +15,12 @@ module Dry
         items.each(&block)
       end
 
-      def register(identifier, options)
-        items << Provider.new(identifier, options)
+      def register(name, options)
+        items << Provider.new(name, options)
       end
 
-      def [](identifier)
-        detect { |provider| provider.identifier == identifier }
+      def [](name)
+        detect { |provider| provider.name == name }
       end
     end
   end

data/lib/dry/system/settings.rb

@@ -11,12 +11,9 @@ module Dry
   module System
     module Settings
       class DSL < BasicObject
-        attr_reader :identifier
-
         attr_reader :schema
 
-        def initialize(identifier, &block)
-          @identifier = identifier
+        def initialize(&block)
           @schema = {}
           instance_eval(&block)
         end

data/lib/dry/system/version.rb

@@ -2,6 +2,6 @@
 
 module Dry
   module System
-    VERSION = "0.20.0"
+    VERSION = "0.21.0"
   end
 end

data/lib/dry/system.rb

@@ -8,17 +8,17 @@ module Dry
     # Register external component provider
     #
     # @api public
-    def self.register_provider(identifier, options)
-      providers.register(identifier, options)
-      providers[identifier].load_components
+    def self.register_provider(name, options)
+      providers.register(name, options)
+      providers[name].load_components
       self
     end
 
     # Register an external component that can be booted within other systems
     #
     # @api public
-    def self.register_component(identifier, provider:, &block)
-      providers[provider].register_component(identifier, block)
+    def self.register_component(name, provider:, &block)
+      providers[provider].register_component(name, block)
       self
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-system
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-12 00:00:00.000000000 Z
+date: 2021-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -197,11 +197,14 @@ files:
 - lib/dry/system/components/config.rb
 - lib/dry/system/config/component_dir.rb
 - lib/dry/system/config/component_dirs.rb
+- lib/dry/system/config/namespace.rb
+- lib/dry/system/config/namespaces.rb
 - lib/dry/system/constants.rb
 - lib/dry/system/container.rb
 - lib/dry/system/errors.rb
 - lib/dry/system/identifier.rb
 - lib/dry/system/importer.rb
+- lib/dry/system/indirect_component.rb
 - lib/dry/system/lifecycle.rb
 - lib/dry/system/loader.rb
 - lib/dry/system/loader/autoloading.rb