dry-system 1.0.1 → 1.1.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d867a0c8708ea863edb44b5f93453c5d986925c921af51d747b605d6f4d3bbb
-  data.tar.gz: 1ee2e7a02c48bd9feb02a018aea1c81f59a5bda1ca7351d62a008162a62d1471
+  metadata.gz: 0772f1a642fb7e44cdafda2659b417fec6f8d583c14098751a94d1163c9c5571
+  data.tar.gz: 37a2e8c32bff3b24b1ff47f7bdb5095057dc5d7283327a3eab7c1424964c9f08
 SHA512:
-  metadata.gz: 75e76f0ff522306b18b38c17c4bdfdae39280cbf4507beff3233bfc7cd10af752de605d0af619b6528a237f6860a4baee3754afedd890d66d50ac54a2880b4bf
-  data.tar.gz: aa31996c109cee9a6b05f61b127d7b9a6ec04cc30fe2e10ecf3f14f8948b2c34be7e687ec6ba6565bd06b9874816cf33d150a5b7499c9e125540e920159a7531
+  metadata.gz: bb137a83e1fa1eba5578255c6535282edfee7608faf4dbe9771d4dfda4cafbeeef167bb970c986b86e5a1e34162275ca63d796bf1d53148148df2dc835f2db80
+  data.tar.gz: 42c3050148a8de2e63376642ca4be35f6726b8462d708935ecb206d353ff0f6bf3b45a47e38b8440c368a88592933973705756de81cfd5be7066e0b41ff6d785

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 <!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
 
+## 1.1.0.beta1 2024-07-03
+
+
+### Added
+
+- Add `Dry::System::ProviderRegistrar#target_container`, to be passed when initializing
+providers. By default this is an alias of `#container`. This allows for custom provider
+registrars to override `#target_container` to provide a custom `#target` within providers.
+An overridden value **MUST** still wrap the original `#target_container` to ensure components
+are registered in the right place. (via #270) (@timriley)
+
+### Changed
+
+- Make `Dry::System::ProviderRegistrar` public API (via #270) (@timriley)
+- When registering a provider source, you can now provide a `provider_options:` hash of default
+options for providers to be registered using that source. The one provider option currently
+supported is `namespace:`. (via #271) (@timriley)
+- Load providers when accessing them via `Dry::System::ProviderRegistrar#[]`. The previous,
+behavior of `#[]` returning `nil` if a provider had not been explicitly loaded was a
+potential source of confusion. Now `#[]` can serve as the one and only interface for fetching
+a provider. (via #273) (@timriley)
+
+[Compare v1.0.1...v1.1.0.beta1](https://github.com/dry-rb/dry-system/compare/v1.0.1...v1.1.0.beta1)
+
 ## 1.0.1 2022-11-18
 
 

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2022 dry-rb team
+Copyright (c) 2015-2023 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

@@ -1,29 +1,22 @@
 <!--- this file is synced from dry-rb/template-gem project -->
+
 [gem]: https://rubygems.org/gems/dry-system
 [actions]: https://github.com/dry-rb/dry-system/actions
-[codacy]: https://www.codacy.com/gh/dry-rb/dry-system
-[chat]: https://dry-rb.zulipchat.com
-[inchpages]: http://inch-ci.org/github/dry-rb/dry-system
-
-# dry-system [![Join the chat at https://dry-rb.zulipchat.com](https://img.shields.io/badge/dry--rb-join%20chat-%23346b7a.svg)][chat]
 
-[![Gem Version](https://badge.fury.io/rb/dry-system.svg)][gem]
-[![CI Status](https://github.com/dry-rb/dry-system/workflows/ci/badge.svg)][actions]
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/3a0e30d0ae2542c7ba047ba5f923c0bb)][codacy]
-[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/3a0e30d0ae2542c7ba047ba5f923c0bb)][codacy]
-[![Inline docs](http://inch-ci.org/github/dry-rb/dry-system.svg?branch=main)][inchpages]
+# dry-system [![Gem Version](https://badge.fury.io/rb/dry-system.svg)][gem] [![CI Status](https://github.com/dry-rb/dry-system/workflows/CI/badge.svg)][actions]
 
 ## Links
 
 * [User documentation](https://dry-rb.org/gems/dry-system)
 * [API documentation](http://rubydoc.info/gems/dry-system)
+* [Forum](https://discourse.dry-rb.org)
 
 ## Supported Ruby versions
 
 This library officially supports the following Ruby versions:
 
-* MRI `>= 2.7.0`
-* jruby `>= 9.3` (postponed until 2.7 is supported)
+* MRI `>= 3.0`
+* jruby `>= 9.4` (not tested on CI)
 
 ## License
 

data/dry-system.gemspec

@@ -26,13 +26,13 @@ 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.7.0"
+  spec.required_ruby_version = ">= 3.0"
 
   # to update dependencies edit project.yml
-  spec.add_runtime_dependency "dry-auto_inject", "~> 1.0", "< 2"
-  spec.add_runtime_dependency "dry-configurable", "~> 1.0", "< 2"
-  spec.add_runtime_dependency "dry-core", "~> 1.0", "< 2"
-  spec.add_runtime_dependency "dry-inflector", "~> 1.0", "< 2"
+  spec.add_runtime_dependency "dry-auto_inject", "~> 1.0"
+  spec.add_runtime_dependency "dry-configurable", "~> 1.0"
+  spec.add_runtime_dependency "dry-core", "~> 1.0"
+  spec.add_runtime_dependency "dry-inflector", "~> 1.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"

data/lib/dry/system/constants.rb

@@ -8,6 +8,6 @@ module Dry
     RB_GLOB = "*.rb"
     PATH_SEPARATOR = File::SEPARATOR
     KEY_SEPARATOR = "."
-    WORD_REGEX = /\w+/.freeze
+    WORD_REGEX = /\w+/
   end
 end

data/lib/dry/system/container.rb

@@ -148,7 +148,7 @@ module Dry
         #
         # @example
         #   # system/container.rb
-        #   require "dry/system/container"
+        #   require "dry/system"
         #   require "logger"
         #
         #   class Core < Dry::System::Container
@@ -608,14 +608,14 @@ module Dry
         def load_component(key)
           return self if registered?(key)
 
-          if (provider = providers.find_and_load_provider(key))
+          if (provider = providers[key])
             provider.start
             return self
           end
 
           component = find_component(key)
 
-          providers.start_provider_dependency(component)
+          providers[component.root_key]&.start
           return self if registered?(key)
 
           if component.loadable?

data/lib/dry/system/loader.rb

@@ -67,7 +67,7 @@ module Dry
           inflector.constantize(const_name)
         rescue NameError => e
           # Ensure it's this component's constant, not any other NameError within the component
-          if e.message =~ /#{const_name}( |\n)/
+          if e.message =~ /#{const_name}( |\n|$)/
             raise ComponentNotLoadableError.new(component, e)
           else
             raise e

data/lib/dry/system/magic_comments_parser.rb

@@ -3,8 +3,8 @@
 module Dry
   module System
     class MagicCommentsParser
-      VALID_LINE_RE = /^(#.*)?$/.freeze
-      COMMENT_RE = /^#\s+(?<name>[A-Za-z]{1}[A-Za-z0-9_]+):\s+(?<value>.+?)$/.freeze
+      VALID_LINE_RE = /^(#.*)?$/
+      COMMENT_RE = /^#\s+(?<name>[A-Za-z]{1}[A-Za-z0-9_]+):\s+(?<value>.+?)$/
 
       COERCIONS = {
         "true" => true,

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

@@ -36,7 +36,7 @@ module Dry
               end
             end
 
-            decorate(key, with: -> target { proxy.new(target, notifications) })
+            decorate(key, with: -> tgt { proxy.new(tgt, notifications) })
           end
         end
       end

data/lib/dry/system/provider_registrar.rb

@@ -13,7 +13,8 @@ module Dry
     # provider registrar is responsible for loading provider files and exposing an API for
     # running the provider lifecycle steps.
     #
-    # @api private
+    # @api public
+    # @since 1.1.0
     class ProviderRegistrar
       # @api private
       attr_reader :providers
@@ -21,6 +22,14 @@ module Dry
       # @api private
       attr_reader :container
 
+      # Returns the container exposed to providers as `target_container`.
+      #
+      # @return [Dry::System::Container]
+      #
+      # @api public
+      # @since 1.1.0
+      alias_method :target_container, :container
+
       # @api private
       def initialize(container)
         @providers = {}
@@ -37,7 +46,7 @@ module Dry
 
       # @see Container.register_provider
       # @api private
-      def register_provider(name, namespace: nil, from: nil, source: nil, if: true, &block)
+      def register_provider(name, from: nil, source: nil, if: true, **provider_options, &block)
         raise ProviderAlreadyRegisteredError, name if providers.key?(name)
 
         if from && source.is_a?(Class)
@@ -54,13 +63,18 @@ module Dry
           if from
             build_provider_from_source(
               name,
-              namespace: namespace,
               source: source || name,
               group: from,
+              options: provider_options,
               &block
             )
           else
-            build_provider(name, namespace: namespace, source: source, &block)
+            build_provider(
+              name,
+              source: source,
+              options: provider_options,
+              &block
+            )
           end
 
         providers[provider.name] = provider
@@ -70,43 +84,28 @@ module Dry
 
       # rubocop:enable Metrics/PerceivedComplexity
 
-      # Returns a provider for the given name, if it has already been loaded
-      #
-      # @api public
-      def [](provider_name)
-        providers[provider_name]
-      end
-      alias_method :provider, :[]
-
-      # @api private
-      def key?(provider_name)
-        providers.key?(provider_name)
-      end
-
       # Returns a provider if it can be found or loaded, otherwise nil
       #
       # @return [Dry::System::Provider, nil]
       #
-      # @api private
-      def find_and_load_provider(name)
-        name = name.to_sym
+      # @api public
+      def [](provider_name)
+        provider_name = provider_name.to_sym
 
-        if (provider = providers[name])
+        if (provider = providers[provider_name])
           return provider
         end
 
         return if finalized?
 
-        require_provider_file(name)
+        require_provider_file(provider_name)
 
-        providers[name]
+        providers[provider_name]
       end
 
       # @api private
-      def start_provider_dependency(component)
-        if (provider = find_and_load_provider(component.root_key))
-          provider.start
-        end
+      def key?(provider_name)
+        providers.key?(provider_name)
       end
 
       # Returns all provider files within the configured provider_paths.
@@ -196,25 +195,26 @@ module Dry
         }
       end
 
-      def build_provider(name, namespace:, source: nil, &block)
+      def build_provider(name, options:, source: nil, &block)
         source_class = source || Provider::Source.for(name: name, &block)
 
         Provider.new(
+          **options,
           name: name,
-          namespace: namespace,
-          target_container: container,
+          target_container: target_container,
           source_class: source_class
         )
       end
 
-      def build_provider_from_source(name, source:, group:, namespace:, &block)
-        source_class = System.provider_sources.resolve(name: source, group: group)
+      def build_provider_from_source(name, source:, group:, options:, &block)
+        provider_source = System.provider_sources.resolve(name: source, group: group)
 
         Provider.new(
+          **provider_source.provider_options,
+          **options,
           name: name,
-          namespace: namespace,
-          target_container: container,
-          source_class: source_class,
+          target_container: target_container,
+          source_class: provider_source.source,
           &block
         )
       end

data/lib/dry/system/provider_source_registry.rb

@@ -6,6 +6,17 @@ module Dry
   module System
     # @api private
     class ProviderSourceRegistry
+      # @api private
+      class Registration
+        attr_reader :source
+        attr_reader :provider_options
+
+        def initialize(source:, provider_options:)
+          @source = source
+          @provider_options = provider_options
+        end
+      end
+
       attr_reader :sources
 
       def initialize
@@ -18,19 +29,19 @@ module Dry
         end
       end
 
-      def register(name:, group:, source:)
-        sources[key(name, group)] = source
+      def register(name:, group:, source:, provider_options:)
+        sources[key(name, group)] = Registration.new(
+          source: source,
+          provider_options: provider_options
+        )
       end
 
-      def register_from_block(name:, group:, &block)
+      def register_from_block(name:, group:, provider_options:, &block)
         register(
           name: name,
           group: group,
-          source: Provider::Source.for(
-            name: name,
-            group: group,
-            &block
-          )
+          source: Provider::Source.for(name: name, group: group, &block),
+          provider_options: provider_options
         )
       end
 

data/lib/dry/system/provider_sources.rb

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

data/lib/dry/system/version.rb

@@ -2,6 +2,6 @@
 
 module Dry
   module System
-    VERSION = "1.0.1"
+    VERSION = "1.1.0.beta1"
   end
 end

data/lib/dry/system.rb

@@ -30,15 +30,25 @@ module Dry
     # Registers a provider source, which can be used as the basis for other providers
     #
     # @api public
-    def self.register_provider_source(name, group:, source: nil, &block)
+    def self.register_provider_source(name, group:, source: nil, provider_options: {}, &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)
+        provider_sources.register(
+          name: name,
+          group: group,
+          source: source,
+          provider_options: provider_options
+        )
       else
-        provider_sources.register_from_block(name: name, group: group, &block)
+        provider_sources.register_from_block(
+          name: name,
+          group: group,
+          provider_options: provider_options,
+          &block
+        )
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-system
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0.beta1
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-18 00:00:00.000000000 Z
+date: 2024-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-auto_inject
@@ -17,9 +17,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
 - !ruby/object:Gem::Dependency
   name: dry-configurable
   requirement: !ruby/object:Gem::Requirement
@@ -37,9 +31,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -47,9 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
 - !ruby/object:Gem::Dependency
   name: dry-core
   requirement: !ruby/object:Gem::Requirement
@@ -57,9 +45,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -67,9 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
 - !ruby/object:Gem::Dependency
   name: dry-inflector
   requirement: !ruby/object:Gem::Requirement
@@ -77,9 +59,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -87,9 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -201,14 +177,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: Organize your code into reusable components