dry-system 0.15.0 → 0.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f029366a9ef603592adb0566dc7d7d1afb13b4e0a5ea86d70d6560a4e80b80f0
-  data.tar.gz: 96b625962372b8e0a00a4cb99a449f8a5ed550c3328b887ef65c47a314628092
+  metadata.gz: bd9ff0c5114ab780f7fc44ea9cb2b963ed980e75a0aefa248232363955cb8e8d
+  data.tar.gz: 94c666638d7a2786ee1cd34f77a1594ea6ffeb5a49951e4412ba0539bb3d7947
 SHA512:
-  metadata.gz: 1ef15338eb9e108b6e489a59ce10f0e8e57608cb6882ae7f8b89680786752b68e00b12a15238f61af63c03382b160dadfe59457ef0d35516fe9defcfe69cb4f9
-  data.tar.gz: 4db3b188698061f78f23a8647d6145dc4466da9ac867c7c561f4aecd59434a18493b98b22d60c92f619f19f5fc177a723a8f2b4050be16f00d9151cadf7fdef2
+  metadata.gz: e778ff07b49f0e2e670d253263a110b5a81145d6e9149f6c12d6684a1a3b10fe3963f8d0b085fab0e9e8e4c8cc099289feb36c3ad154644ab8af9d0ef13c887c
+  data.tar.gz: 6b94ff8beab87af8621ee6e7e33e0360c4bf9e367f79bb5c5242d5ba09f60906e0c8a30e0e7e49b77b6ce17aa80ea4e82da5d310ba425d6c9a7801b94b4cabd3

data/CHANGELOG.md

@@ -1,4 +1,144 @@
-## v0.15.0 2020-01-30
+<!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
+
+## 0.19.0 2021-04-22
+
+This release marks a huge step forward for dry-system, bringing support for Zeitwerk and other autoloaders, plus clearer configuration and improved consistency around component resolution for both finalized and lazy loading containers. [Read the announcement post](https://dry-rb.org/news/2021/04/22/dry-system-0-19-released-with-zeitwerk-support-and-more-leading-the-way-for-hanami-2-0/) for a high-level tour of the new features.
+
+### Added
+
+- New `component_dirs` setting on `Dry::System::Container`, which must be used for specifying the directories which dry-system will search for component source files.
+
+  Each added component dir is relative to the container's `root`, and can have its own set of settings configured:
+
+  ```ruby
+  class MyApp::Container < Dry::System::Container
+    configure do |config|
+      config.root = __dir__
+
+      # Defaults for all component dirs can be configured separately
+      config.component_dirs.auto_register = true # default is already true
+
+      # Component dirs can be added and configured independently
+      config.component_dirs.add "lib" do |dir|
+        dir.add_to_load_path = true # defaults to true
+        dir.default_namespace = "my_app"
+      end
+
+      # All component dir settings are optional. Component dirs relying on default
+      # settings can be added like so:
+      config.component_dirs.add "custom_components"
+    end
+  end
+  ```
+
+  The following settings are available for configuring added `component_dirs`:
+
+  - `auto_register`, a boolean, or a proc accepting a `Dry::System::Component` instance and returning a truthy or falsey value. Providing a proc allows an auto-registration policy to apply on a per-component basis
+  - `add_to_load_path`, a boolean
+  - `default_namespace`, a string representing the leading namespace segments to be stripped from the component's identifier (given the identifier is derived from the component's fully qualified class name)
+  - `loader`, a custom replacement for the default `Dry::System::Loader` to be used for the component dir
+  - `memoize`, a boolean, to enable/disable memoizing all components in the directory, or a proc accepting a `Dry::System::Component` instance and returning a truthy or falsey value. Providing a proc allows a memoization policy to apply on a per-component basis
+
+  _All component dir settings are optional._
+
+  (@timriley in #155, #157, and #162)
+- A new autoloading-friendly `Dry::System::Loader::Autoloading` is available, which is tested to work with [Zeitwerk](https://github.com/fxn/zeitwerk) 🎉
+
+  Configure this on the container (via a component dir `loader` setting), and the loader will no longer `require` any components, instead allowing missing constant resolution to trigger the loading of the required file.
+
+  This loader presumes an autoloading system like Zeitwerk has already been enabled and appropriately configured.
+
+  A recommended setup is as follows:
+
+  ```ruby
+  require "dry/system/container"
+  require "dry/system/loader/autoloading"
+  require "zeitwerk"
+
+  class MyApp::Container < Dry::System::Container
+    configure do |config|
+      config.root = __dir__
+
+      config.component_dirs.loader = Dry::System::Loader::Autoloading
+      config.component_dirs.add_to_load_path = false
+
+      config.component_dirs.add "lib" do |dir|
+        # ...
+      end
+    end
+  end
+
+  loader = Zeitwerk::Loader.new
+  loader.push_dir MyApp::Container.config.root.join("lib").realpath
+  loader.setup
+  ```
+
+  (@timriley in #153)
+- [BREAKING] `Dry::System::Component` instances (which users of dry-system will interact with via custom loaders, as well as via the `auto_register` and `memoize` component dir settings described above) now return a `Dry::System::Identifier` from their `#identifier` method. The raw identifier string may be accessed via the identifier's own `#key` or `#to_s` methods. `Identifier` also provides a helpful namespace-aware `#start_with?` method for returning whether the identifier begins with the provided namespace(s) (@timriley in #158)
+
+### Changed
+
+- Components with `# auto_register: false` magic comments in their source files are now properly ignored when lazy loading (@timriley in #155)
+- `# memoize: true` and `# memoize: false` magic comments at top of component files are now respected (@timriley in #155)
+- [BREAKING] `Dry::System::Container.load_paths!` has been renamed to `.add_to_load_path!`. This method now exists as a mere convenience only. Calling this method is no longer required for any configured `component_dirs`; these are now added to the load path automatically (@timriley in #153 and #155)
+- [BREAKING] `auto_register` container setting has been removed. Configured directories to be auto-registered by adding `component_dirs` instead (@timriley in #155)
+- [BREAKING] `default_namespace` container setting has been removed. Set it when adding `component_dirs` instead (@timriley in #155)
+- [BREAKING] `loader` container setting has been nested under `component_dirs`, now available as `component_dirs.loader` to configure a default loader for all component dirs, as well as on individual component dirs when being added (@timriley in #162)
+- [BREAKING] `Dry::System::ComponentLoadError` is no longer raised when a component could not be lazy loaded; this was only raised in a single specific failure condition. Instead, a `Dry::Container::Error` is raised in all cases of components failing to load (@timriley in #155)
+- [BREAKING] `Dry::System::Container.auto_register!` has been removed. Configure `component_dirs` instead. (@timriley in #157)
+- [BREAKING] The `Dry::System::Loader` interface has changed. It is now a static interface, no longer initialized with a component. The component is instead passed to each method as an argument: `.require!(component)`, `.call(component, *args)`, `.constant(component)` (@timriley in #157)
+- [BREAKING] `Dry::System::Container.require_path` has been removed. Provide custom require behavior by configuring your own `loader` (@timriley in #153)
+
+[Compare v0.18.1...v0.19.0](https://github.com/dry-rb/dry-system/compare/v0.18.1...v0.19.0)
+
+## 0.18.1 2020-08-26
+
+
+### Fixed
+
+- Made `Booter#boot_files` a public method again, since it was required by dry-rails (@timriley)
+
+
+[Compare v0.18.0...v0.18.1](https://github.com/dry-rb/dry-system/compare/v0.18.0...v0.18.1)
+
+## 0.18.0 2020-08-24
+
+
+### Added
+
+- New `bootable_dirs` setting on `Dry::System::Container`, which accepts paths to multiple directories for looking up bootable component files. (@timriley in PR #151)
+
+  For each entry in the `bootable_dirs` array, relative directories will be appended to the container's `root`, and absolute directories will be left unchanged.
+
+  When searching for bootable files, the first match will win, and any subsequent same-named files will not be loaded. In this way, the `bootable_dirs` act similarly to the `$PATH` in a shell environment.
+
+
+[Compare v0.17.0...v0.18.0](https://github.com/dry-rb/dry-system/compare/v0.17.0...v0.18.0)
+
+## 0.17.0 2020-02-19
+
+
+### Fixed
+
+- Works with the latest dry-configurable version (issue #141) (@solnic)
+
+### Changed
+
+- Depends on dry-configurable `=> 0.11.1` now (@solnic)
+
+[Compare v0.16.0...v0.17.0](https://github.com/dry-rb/dry-system/compare/v0.16.0...v0.17.0)
+
+## 0.16.0 2020-02-15
+
+
+### Changed
+
+- Plugins can now define their own settings which are available in the `before(:configure)` hook (@solnic)
+- Dependency on dry-configurable was bumped to `~> 0.11` (@solnic)
+
+[Compare v0.15.0...v0.16.0](https://github.com/dry-rb/dry-system/compare/v0.15.0...v0.16.0)
+
+## 0.15.0 2020-01-30
 
 
 ### Added
@@ -18,7 +158,7 @@ after(:configure) { config.my_new_setting = "awesome" }
 - Centralize error definitions in `lib/dry/system/errors.rb` (@cgeorgii)
 - All built-in plugins use `before(:configure)` now to declare their settings (@solnic)
 
-[Compare v0.14.1...vv0.15.0](https://github.com/dry-rb/dry-system/compare/v0.14.1...vv0.15.0)
+[Compare v0.14.1...v0.15.0](https://github.com/dry-rb/dry-system/compare/v0.14.1...v0.15.0)
 
 ## 0.14.1 2020-01-22
 

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2020 dry-rb team
+Copyright (c) 2015-2021 dry-rb team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/README.md

@@ -21,7 +21,7 @@
 
 This library officially supports the following Ruby versions:
 
-* MRI >= `2.4`
+* MRI >= `2.5`
 * jruby >= `9.2`
 
 ## License

data/dry-system.gemspec

@@ -16,6 +16,8 @@ Gem::Specification.new do |spec|
   spec.description   = spec.summary
   spec.homepage      = 'https://dry-rb.org/gems/dry-system'
   spec.files         = Dir["CHANGELOG.md", "LICENSE", "README.md", "dry-system.gemspec", "lib/**/*"]
+  spec.bindir        = 'bin'
+  spec.executables   = []
   spec.require_paths = ['lib']
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
@@ -23,15 +25,14 @@ Gem::Specification.new do |spec|
   spec.metadata['source_code_uri']   = 'https://github.com/dry-rb/dry-system'
   spec.metadata['bug_tracker_uri']   = 'https://github.com/dry-rb/dry-system/issues'
 
-  spec.required_ruby_version = ">= 2.4.0"
+  spec.required_ruby_version = ">= 2.5.0"
 
   # to update dependencies edit project.yml
   spec.add_runtime_dependency "concurrent-ruby", "~> 1.0"
   spec.add_runtime_dependency "dry-auto_inject", ">= 0.4.0"
-  spec.add_runtime_dependency "dry-configurable", "~> 0.7"
+  spec.add_runtime_dependency "dry-configurable", "~> 0.12", ">= 0.12.1"
   spec.add_runtime_dependency "dry-container", "~> 0.7", ">= 0.7.2"
-  spec.add_runtime_dependency "dry-core", "~> 0.3", ">= 0.3.1"
-  spec.add_runtime_dependency "dry-equalizer", "~> 0.2"
+  spec.add_runtime_dependency "dry-core", "~> 0.5", ">= 0.5"
   spec.add_runtime_dependency "dry-inflector", "~> 0.1", ">= 0.1.2"
   spec.add_runtime_dependency "dry-struct", "~> 1.0"
 

data/lib/dry-system.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require 'dry/system'
+require "dry/system"

data/lib/dry/system.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'dry/system/provider'
-require 'dry/system/provider_registry'
+require "dry/system/provider"
+require "dry/system/provider_registry"
 
 module Dry
   module System

data/lib/dry/system/auto_registrar.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
-require 'dry/system/constants'
-require 'dry/system/magic_comments_parser'
-require 'dry/system/auto_registrar/configuration'
+require "dry/system/constants"
+require_relative "component"
 
 module Dry
   module System
@@ -17,83 +16,42 @@ module Dry
     class AutoRegistrar
       attr_reader :container
 
-      attr_reader :config
-
       def initialize(container)
         @container = container
-        @config = container.config
       end
 
       # @api private
       def finalize!
-        Array(config.auto_register).each { |dir| call(dir) }
+        container.component_dirs.each do |component_dir|
+          call(component_dir) if component_dir.auto_register?
+        end
       end
 
       # @api private
-      def call(dir)
-        registration_config = Configuration.new
-        yield(registration_config) if block_given?
-        components(dir).each do |component|
-          next if !component.auto_register? || registration_config.exclude.(component)
+      def call(component_dir)
+        components(component_dir).each do |component|
+          next unless register_component?(component)
 
-          container.require_component(component) do
-            register(component.identifier, memoize: registration_config.memoize) {
-              registration_config.instance.(component)
-            }
-          end
+          container.register(component.key, memoize: component.memoize?) { component.instance }
         end
       end
 
       private
 
-      # @api private
-      def components(dir)
-        files(dir)
-          .map { |file_name| [file_name, file_options(file_name)] }
-          .map { |file_name, options| component(relative_path(dir, file_name), **options) }
-          .reject { |component| registered?(component.identifier) }
+      def components(component_dir)
+        files(component_dir.full_path).map { |file_path|
+          component_dir.component_for_path(file_path)
+        }
       end
 
-      # @api private
       def files(dir)
-        components_dir = File.join(root, dir)
-
-        unless ::Dir.exist?(components_dir)
-          raise ComponentsDirMissing, "Components dir '#{components_dir}' not found"
-        end
-
-        ::Dir["#{components_dir}/**/#{RB_GLOB}"].sort
-      end
-
-      # @api private
-      def relative_path(dir, file_path)
-        dir_root = root.join(dir.to_s.split('/')[0])
-        file_path.to_s.sub("#{dir_root}/", '').sub(RB_EXT, EMPTY_STRING)
-      end
+        raise ComponentDirNotFoundError, dir unless Dir.exist?(dir)
 
-      # @api private
-      def file_options(file_name)
-        MagicCommentsParser.(file_name)
-      end
-
-      # @api private
-      def component(path, **options)
-        container.component(path, **options)
+        Dir["#{dir}/**/#{RB_GLOB}"].sort
       end
 
-      # @api private
-      def root
-        container.root
-      end
-
-      # @api private
-      def registered?(name)
-        container.registered?(name)
-      end
-
-      # @api private
-      def register(*args, &block)
-        container.register(*args, &block)
+      def register_component?(component)
+        !container.registered?(component.key) && component.auto_register?
       end
     end
   end

data/lib/dry/system/booter.rb

@@ -1,10 +1,11 @@
 # 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 "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
@@ -16,44 +17,39 @@ module Dry
     #
     # @api private
     class Booter
-      attr_reader :path
+      attr_reader :paths
 
       attr_reader :booted
 
       attr_reader :components
 
       # @api private
-      def initialize(path)
-        @path = path
+      def initialize(paths)
+        @paths = paths
         @booted = []
         @components = ComponentRegistry.new
       end
 
-      # @api private
-      def bootable?(component)
-        boot_file(component).exist?
-      end
-
-      # @api private
-      def boot_file(name)
-        name = name.respond_to?(:root_key) ? name.root_key.to_s : name
-
-        path.join("#{name}#{RB_EXT}")
-      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 load_component(path)
-        identifier = Pathname(path).basename(RB_EXT).to_s.to_sym
+      def find_component(name)
+        name = name.to_sym
 
-        Kernel.require path unless components.exists?(identifier)
+        return components[name] if components.exists?(name)
 
-        self
+        return if finalized?
+
+        require_boot_file(name)
+
+        components[name] if components.exists?(name)
       end
 
       # @api private
@@ -69,6 +65,13 @@ module Dry
         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|
@@ -120,7 +123,7 @@ module Dry
       # @api private
       def call(name_or_component)
         with_component(name_or_component) do |component|
-          raise ComponentFileMismatchError.new(name, registered_booted_keys) unless component
+          raise ComponentFileMismatchError, name unless component
 
           yield(component) if block_given?
 
@@ -129,11 +132,37 @@ module Dry
       end
 
       # @api private
-      def lifecycle_container(container)
-        LifecycleContainer.new(container)
+      def boot_dependency(component)
+        if (component = find_component(component.root_key))
+          start(component)
+        end
       end
 
-      # @api private
+      # 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
@@ -149,24 +178,22 @@ module Dry
         yield(component)
       end
 
-      # @api private
-      def require_boot_file(identifier)
-        boot_file = boot_files.detect { |path|
-          Pathname(path).basename(RB_EXT).to_s == identifier.to_s
-        }
+      def load_component(path)
+        identifier = Pathname(path).basename(RB_EXT).to_s.to_sym
 
-        Kernel.require boot_file if boot_file
+        Kernel.require path unless components.exists?(identifier)
+
+        self
       end
 
-      # @api private
-      def boot_files
-        ::Dir["#{path}/**/#{RB_GLOB}"].sort
+      def require_boot_file(identifier)
+        boot_file = find_boot_file(identifier)
+
+        Kernel.require boot_file if boot_file
       end
 
-      # @api private
-      def boot_dependency(component)
-        boot_file = boot_file(component)
-        start(boot_file.basename('.*').to_s.to_sym) if boot_file.exist?
+      def find_boot_file(name)
+        boot_files.detect { |file| File.basename(file, RB_EXT) == name.to_s }
       end
     end
   end