dry-system 0.19.2 → 0.23.0

data/lib/dry/system/provider_sources/settings/config.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require "dry/configurable"
+require "dry/core/deprecations"
+require_relative "loader"
+
+module Dry
+  module System
+    module ProviderSources
+      # @api private
+      module Settings
+        InvalidSettingsError = Class.new(ArgumentError) do
+          # @api private
+          def initialize(errors)
+            message = <<~STR
+              Could not load settings. The following settings were invalid:
+
+              #{setting_errors(errors).join("\n")}
+            STR
+
+            super(message)
+          end
+
+          private
+
+          def setting_errors(errors)
+            errors.sort_by { |k, _| k }.map { |key, error| "#{key}: #{error}" }
+          end
+        end
+
+        # @api private
+        class Config
+          # @api private
+          def self.load(root:, env:, loader: Loader)
+            loader = loader.new(root: root, env: env)
+
+            new.tap do |settings_obj|
+              errors = {}
+
+              settings.to_a.each do |setting_name|
+                value = loader[setting_name.to_s.upcase]
+
+                begin
+                  settings_obj.config.public_send(:"#{setting_name}=", value) if value
+                rescue => e # rubocop:disable Style/RescueStandardError
+                  errors[setting_name] = e
+                end
+              end
+
+              raise InvalidSettingsError, errors unless errors.empty?
+            end
+          end
+
+          # rubocop:disable Layout/LineLength
+          def self.key(name, type)
+            Dry::Core::Deprecations.announce(
+              "Dry::System :settings provider source setting definition using `key`",
+              "Use `setting` instead, with dry-configurable `setting` options, e.g. `setting :my_setting, default: \"hello\", constructor: Types::String.constrained(min_length: 3)`",
+              tag: "dry-system",
+              uplevel: 1
+            )
+
+            setting(name, constructor: type)
+          end
+          # rubocop:enable Layout/LineLength
+
+          include Dry::Configurable
+
+          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, include_all) || super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/system/provider_sources/settings/loader.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "dry/configurable"
+require "dry/core/deprecations"
+
+module Dry
+  module System
+    module ProviderSources
+      module Settings
+        # @api private
+        class Loader
+          # @api private
+          attr_reader :store
+
+          # @api private
+          def initialize(root:, env:, store: ENV)
+            @store = store
+            load_dotenv(root, env.to_sym)
+          end
+
+          # @api private
+          def [](key)
+            store[key]
+          end
+
+          private
+
+          def load_dotenv(root, env)
+            require "dotenv"
+            Dotenv.load(*dotenv_files(root, env)) if defined?(Dotenv)
+          rescue LoadError
+            Dry::Core::Deprecations.announce(
+              "Dry::System :settings provider now requires dotenv to to load settings from .env files`", # rubocop:disable Layout/LineLength
+              "Add `gem \"dotenv\"` to your application's `Gemfile`",
+              tag: "dry-system",
+              uplevel: 3
+            )
+            # Do nothing if dotenv is unavailable
+          end
+
+          def dotenv_files(root, env)
+            [
+              File.join(root, ".env.#{env}.local"),
+              (File.join(root, ".env.local") unless env == :test),
+              File.join(root, ".env.#{env}"),
+              File.join(root, ".env")
+            ].compact
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/system/provider_sources/settings.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Dry
+  module System
+    module ProviderSources
+      module Settings
+        class Source < Dry::System::Provider::Source
+          setting :store
+
+          def prepare
+            require "dry/system/provider_sources/settings/config"
+          end
+
+          def start
+            register(:settings, settings.load(root: target.root, env: target.config.env))
+          end
+
+          def settings(&block)
+            # Save the block and evaluate it lazily to allow a provider with this source
+            # to `require` any necessary files for the block to evaluate correctly (e.g.
+            # requiring an app-specific types module for setting constructors)
+            if block
+              @settings_block = block
+            elsif @settings_class
+              @settings_class
+            elsif @settings_block
+              @settings_class = Class.new(Settings::Config, &@settings_block)
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+Dry::System.register_provider_source(
+  :settings,
+  group: :dry_system,
+  source: Dry::System::ProviderSources::Settings::Source
+)

data/lib/dry/system/provider_sources.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "dry/system"
+
+Dry::System.register_provider_sources Pathname(__dir__).join("provider_sources").realpath

data/lib/dry/system/stubs.rb

@@ -7,7 +7,7 @@ module Dry
     class Container
       # @api private
       module Stubs
-        def finalize!(&block)
+        def finalize!(freeze: true, &block)
           super(freeze: false, &block)
         end
       end

data/lib/dry/system/version.rb

@@ -2,6 +2,6 @@
 
 module Dry
   module System
-    VERSION = "0.19.2"
+    VERSION = "0.23.0"
   end
 end

data/lib/dry/system.rb

@@ -1,30 +1,62 @@
 # frozen_string_literal: true
 
-require "dry/system/provider"
-require "dry/system/provider_registry"
+require "dry/core/deprecations"
+require_relative "system/provider_source_registry"
 
 module Dry
   module System
-    # Register external component provider
+    # Registers the provider sources in the files under the given path
     #
     # @api public
-    def self.register_provider(identifier, options)
-      providers.register(identifier, options)
-      providers[identifier].load_components
-      self
+    def self.register_provider_sources(path)
+      provider_sources.load_sources(path)
     end
 
-    # Register an external component that can be booted within other systems
+    def self.register_provider(_name, options)
+      Dry::Core::Deprecations.announce(
+        "Dry::System.register_provider",
+        "Use `Dry::System.register_provider_sources` instead",
+        tag: "dry-system",
+        uplevel: 1
+      )
+
+      register_provider_sources(options.fetch(:path))
+    end
+
+    # Registers a provider source, which can be used as the basis for other providers
     #
     # @api public
-    def self.register_component(identifier, provider:, &block)
-      providers[provider].register_component(identifier, block)
-      self
+    def self.register_provider_source(name, group:, source: nil, &block)
+      if source && block
+        raise ArgumentError, "You must supply only a `source:` option or a block, not both"
+      end
+
+      if source
+        provider_sources.register(name: name, group: group, source: source)
+      else
+        provider_sources.register_from_block(
+          name: name,
+          group: group,
+          target_container: self,
+          &block
+        )
+      end
+    end
+
+    def self.register_component(name, provider:, &block)
+      Dry::Core::Deprecations.announce(
+        "Dry::System.register_component",
+        "Use `Dry::System.register_provider_source` instead",
+        tag: "dry-system",
+        uplevel: 1
+      )
+
+      register_provider_source(name, group: provider, &block)
     end
 
     # @api private
-    def self.providers
-      @providers ||= ProviderRegistry.new
+    def self.provider_sources
+      @provider_sources ||= ProviderSourceRegistry.new
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-system
 version: !ruby/object:Gem::Version
-  version: 0.19.2
+  version: 0.23.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-30 00:00:00.000000000 Z
+date: 2022-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -44,40 +44,40 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.14'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.12.1
+        version: 0.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.14'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.12.1
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: dry-container
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: dry-core
   requirement: !ruby/object:Gem::Requirement
@@ -188,25 +188,23 @@ files:
 - lib/dry-system.rb
 - lib/dry/system.rb
 - lib/dry/system/auto_registrar.rb
-- lib/dry/system/booter.rb
-- lib/dry/system/booter/component_registry.rb
 - lib/dry/system/component.rb
 - lib/dry/system/component_dir.rb
 - lib/dry/system/components.rb
-- lib/dry/system/components/bootable.rb
-- 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/lifecycle.rb
+- lib/dry/system/indirect_component.rb
 - lib/dry/system/loader.rb
 - lib/dry/system/loader/autoloading.rb
 - lib/dry/system/magic_comments_parser.rb
-- lib/dry/system/manual_registrar.rb
+- lib/dry/system/manifest_registrar.rb
 - lib/dry/system/plugins.rb
 - lib/dry/system/plugins/bootsnap.rb
 - lib/dry/system/plugins/dependency_graph.rb
@@ -216,13 +214,18 @@ files:
 - lib/dry/system/plugins/monitoring.rb
 - lib/dry/system/plugins/monitoring/proxy.rb
 - lib/dry/system/plugins/notifications.rb
+- lib/dry/system/plugins/zeitwerk.rb
+- lib/dry/system/plugins/zeitwerk/compat_inflector.rb
 - lib/dry/system/provider.rb
-- lib/dry/system/provider_registry.rb
-- lib/dry/system/settings.rb
-- lib/dry/system/settings/file_loader.rb
-- lib/dry/system/settings/file_parser.rb
+- lib/dry/system/provider/source.rb
+- lib/dry/system/provider/source_dsl.rb
+- lib/dry/system/provider_registrar.rb
+- lib/dry/system/provider_source_registry.rb
+- lib/dry/system/provider_sources.rb
+- lib/dry/system/provider_sources/settings.rb
+- lib/dry/system/provider_sources/settings/config.rb
+- lib/dry/system/provider_sources/settings/loader.rb
 - lib/dry/system/stubs.rb
-- lib/dry/system/system_components/settings.rb
 - lib/dry/system/version.rb
 homepage: https://dry-rb.org/gems/dry-system
 licenses:
@@ -240,7 +243,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/dry/system/booter/component_registry.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module Dry
-  module System
-    class Booter
-      class ComponentRegistry
-        include Enumerable
-
-        attr_reader :components
-
-        def initialize
-          @components = []
-        end
-
-        def each(&block)
-          components.each(&block)
-        end
-
-        def register(component)
-          @components << component
-        end
-
-        def exists?(name)
-          components.any? { |component| component.identifier == name }
-        end
-
-        def [](name)
-          component = components.detect { |component| component.identifier == name }
-
-          component || raise(InvalidComponentIdentifierError, name)
-        end
-      end
-    end
-  end
-end

data/lib/dry/system/booter.rb

@@ -1,200 +0,0 @@
-# frozen_string_literal: true
-
-require "dry/system/components/bootable"
-require "dry/system/errors"
-require "dry/system/constants"
-require "dry/system/lifecycle"
-require "dry/system/booter/component_registry"
-require "pathname"
-
-module Dry
-  module System
-    # Default booter implementation
-    #
-    # This is currently configured by default for every System::Container.
-    # Booter objects are responsible for loading system/boot files and expose
-    # an API for calling lifecycle triggers.
-    #
-    # @api private
-    class Booter
-      attr_reader :paths
-
-      attr_reader :booted
-
-      attr_reader :components
-
-      # @api private
-      def initialize(paths)
-        @paths = paths
-        @booted = []
-        @components = ComponentRegistry.new
-      end
-
-      # @api private
-      def register_component(component)
-        components.register(component)
-        self
-      end
-
-      # Returns a bootable component if it can be found or loaded, otherwise nil
-      #
-      # @return [Dry::System::Components::Bootable, nil]
-      # @api private
-      def find_component(name)
-        name = name.to_sym
-
-        return components[name] if components.exists?(name)
-
-        return if finalized?
-
-        require_boot_file(name)
-
-        components[name] if components.exists?(name)
-      end
-
-      # @api private
-      def finalize!
-        boot_files.each do |path|
-          load_component(path)
-        end
-
-        components.each do |component|
-          start(component)
-        end
-
-        freeze
-      end
-
-      # @!method finalized?
-      #   Returns true if the booter has been finalized
-      #
-      #   @return [Boolean]
-      #   @api private
-      alias_method :finalized?, :frozen?
-
-      # @api private
-      def shutdown
-        components.each do |component|
-          next unless booted.include?(component)
-
-          stop(component)
-        end
-      end
-
-      # @api private
-      def init(name_or_component)
-        with_component(name_or_component) do |component|
-          call(component) do
-            component.init.finalize
-            yield if block_given?
-          end
-
-          self
-        end
-      end
-
-      # @api private
-      def start(name_or_component)
-        with_component(name_or_component) do |component|
-          return self if booted.include?(component)
-
-          init(name_or_component) do
-            component.start
-          end
-
-          booted << component.finalize
-
-          self
-        end
-      end
-
-      # @api private
-      def stop(name_or_component)
-        call(name_or_component) do |component|
-          raise ComponentNotStartedError, name_or_component unless booted.include?(component)
-
-          component.stop
-          booted.delete(component)
-
-          yield if block_given?
-        end
-      end
-
-      # @api private
-      def call(name_or_component)
-        with_component(name_or_component) do |component|
-          raise ComponentFileMismatchError, name unless component
-
-          yield(component) if block_given?
-
-          component
-        end
-      end
-
-      # @api private
-      def boot_dependency(component)
-        if (component = find_component(component.root_key))
-          start(component)
-        end
-      end
-
-      # Returns all boot files within the configured paths
-      #
-      # Searches for files in the order of the configured paths. In the case of multiple
-      # identically-named boot files within different paths, the file found first will be
-      # returned, and other matching files will be discarded.
-      #
-      # @return [Array<Pathname>]
-      # @api public
-      def boot_files
-        @boot_files ||= paths.each_with_object([[], []]) { |path, (boot_files, loaded)|
-          files = Dir["#{path}/#{RB_GLOB}"].sort
-
-          files.each do |file|
-            basename = File.basename(file)
-
-            unless loaded.include?(basename)
-              boot_files << Pathname(file)
-              loaded << basename
-            end
-          end
-        }.first
-      end
-
-      private
-
-      def with_component(id_or_component)
-        component =
-          case id_or_component
-          when Symbol
-            require_boot_file(id_or_component) unless components.exists?(id_or_component)
-            components[id_or_component]
-          when Components::Bootable
-            id_or_component
-          end
-
-        raise InvalidComponentError, id_or_component unless component
-
-        yield(component)
-      end
-
-      def load_component(path)
-        identifier = Pathname(path).basename(RB_EXT).to_s.to_sym
-
-        Kernel.require path unless components.exists?(identifier)
-
-        self
-      end
-
-      def require_boot_file(identifier)
-        boot_file = find_boot_file(identifier)
-
-        Kernel.require boot_file if boot_file
-      end
-
-      def find_boot_file(name)
-        boot_files.detect { |file| File.basename(file, RB_EXT) == name.to_s }
-      end
-    end
-  end
-end