dry-rails 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3503a4784fff4602afd40a4617ec013c95a69b71308dabd5c2e8daf90901337
-  data.tar.gz: 271597c911b36d298bc741350abf4ae8c8f78e2c41f6ae2a0bfe467fb2666eba
+  metadata.gz: b88e2e95f728750240e49d73821d025555aed6cc31d5d39174f6c57aebf6ce27
+  data.tar.gz: cabcb4d3fd5d5cf9501fe7949c7c909f40da0ca6a5603673785ae9b40ba04e00
 SHA512:
-  metadata.gz: 801d04d9a2d3860c790ff3a5e7f8f0573bb9432c7d26ba62e833915b85f46021930ad08821c04271c51ee2c1cd82a8fe7031fbe27053e15c8df81fe4d84e4232
-  data.tar.gz: 9bbb63b8b0f50ceef021dd2dbc5a0d65dae979c9f239a39e68215619c85cf18a6445db8f0f618c8c2c7f48b1de2a344a547e763009dc9ebf32e1c3c411c5b904
+  metadata.gz: 175953e3194700744fb405d10684492e7986bbf163fd14cf95d9763ba03155ad97f5dba1998a192430b1b348e7a663ee5a46bc9e4b75a689feda72984be9b555
+  data.tar.gz: a6751d7aca04c9c6e4806e0f6cdaf2e0881c2ef88b7a9796650da2ee0408ba05d955324af704a96d17b5318e294e2de0e34c56d9727523ab2d90945502af533d

data/CHANGELOG.md

@@ -1,4 +1,57 @@
-## unreleased 
+<!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
+
+## 0.5.0 2022-02-11
+
+
+### Changed
+
+- dry-system dependency was bumped to >= 0.23 (via #52) (@solnic)
+
+[Compare v0.4.0...v0.5.0](https://github.com/dry-rb/dry-rails/compare/v0.4.0...v0.5.0)
+
+## 0.4.0 2021-12-23
+
+This is a big update - please also read dry-system [CHANGELOG](https://github.com/dry-rb/dry-system/blob/master/CHANGELOG.md) versions 0.20 and 0.21.
+
+### Added
+
+- It's now possible to configure container constant name via `config.constainer_const_name` (issue #21 closed via #41) (@diegotoral)
+
+### Fixed
+
+- `config.auto_inject_constant` is now cleared during code reloading (see #40 for more info) (@diegotoral)
+
+### Changed
+
+- Updated to work with dry-system 0.21 (via #48 and #50) (@zlw + @solnic)
+- dry-system dependency was bumped to >= 0.23 (via #52) (@solnic)
+
+[Compare v0.3.0...v0.4.0](https://github.com/dry-rb/dry-rails/compare/v0.3.0...v0.4.0)
+
+## 0.3.0 2020-08-26
+
+
+### Changed
+
+- Use dry-system 0.18.0 and configure new `bootable_dirs` setting appropriately (@timriley in #38)
+
+[Compare v0.2.1...v0.3.0](https://github.com/dry-rb/dry-rails/compare/v0.2.1...v0.3.0)
+
+## 0.2.1 2020-08-26
+
+
+### Added
+
+- Controller features now support `ActionControll::API` too (issue #35 closed via #36) (@rinaldifonseca)
+
+### Fixed
+
+- Fix dry-system dependency to 0.17.0, to avoid incompatibilities with 0.18.0 (@timriley)
+
+
+[Compare v0.2.0...v0.2.1](https://github.com/dry-rb/dry-rails/compare/v0.2.0...v0.2.1)
+
+## 0.2.0 2020-07-21
 
 
 ### Added
@@ -14,7 +67,7 @@
 
 - The `:env` dry-system plugin is now enabled by default (fixes #28 via #30) (@solnic)
 
-[Compare v0.1.0...master](https://github.com/dry-rb/dry-rails/compare/v0.1.0...master)
+[Compare v0.1.0...v0.2.0](https://github.com/dry-rb/dry-rails/compare/v0.1.0...v0.2.0)
 
 ## 0.1.0 2020-03-30
 

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2020 dry-rb team
+Copyright (c) 2015-2022 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,3 +1,4 @@
+<!--- this file is synced from dry-rb/template-gem project -->
 [gem]: https://rubygems.org/gems/dry-rails
 [actions]: https://github.com/dry-rb/dry-rails/actions
 [codacy]: https://www.codacy.com/gh/dry-rb/dry-rails
@@ -12,18 +13,17 @@
 [![Codacy Badge](https://api.codacy.com/project/badge/Coverage/d4677ea0c4c2497bb1af1b3ac31552f4)][codacy]
 [![Inline docs](http://inch-ci.org/github/dry-rb/dry-rails.svg?branch=master)][inchpages]
 
-dry-rails provides the official integration of dry-rb gems with Ruby on Rails framework.
 ## Links
 
-* [User documentation](http://dry-rb.org/gems/dry-rails)
+* [User documentation](https://dry-rb.org/gems/dry-rails)
 * [API documentation](http://rubydoc.info/gems/dry-rails)
 
 ## Supported Ruby versions
 
 This library officially supports the following Ruby versions:
 
-* MRI >= `2.4`
-* jruby >= `9.2`
+* MRI `>= 2.7.0`
+* jruby `>= 9.3` (postponed until 2.7 is supported)
 
 ## License
 

data/dry-rails.gemspec

@@ -1,35 +1,36 @@
 # frozen_string_literal: true
-# this file is managed by dry-rb/devtools project
 
-lib = File.expand_path('lib', __dir__)
+# this file is synced from dry-rb/template-gem project
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'dry/rails/version'
+require "dry/rails/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'dry-rails'
+  spec.name          = "dry-rails"
   spec.authors       = ["Piotr Solnica"]
   spec.email         = ["piotr.solnica@gmail.com"]
-  spec.license       = 'MIT'
+  spec.license       = "MIT"
   spec.version       = Dry::Rails::VERSION.dup
 
   spec.summary       = "The official dry-rb railtie for Ruby on Rails"
   spec.description   = "dry-rails provides the official integration of dry-rb gems with Ruby on Rails framework."
-  spec.homepage      = 'https://dry-rb.org/gems/dry-rails'
+  spec.homepage      = "https://dry-rb.org/gems/dry-rails"
   spec.files         = Dir["CHANGELOG.md", "LICENSE", "README.md", "dry-rails.gemspec", "lib/**/*"]
-  spec.bindir        = 'bin'
+  spec.bindir        = "bin"
   spec.executables   = []
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-  spec.metadata['changelog_uri']     = 'https://github.com/dry-rb/dry-rails/blob/master/CHANGELOG.md'
-  spec.metadata['source_code_uri']   = 'https://github.com/dry-rb/dry-rails'
-  spec.metadata['bug_tracker_uri']   = 'https://github.com/dry-rb/dry-rails/issues'
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["changelog_uri"]     = "https://github.com/dry-rb/dry-rails/blob/master/CHANGELOG.md"
+  spec.metadata["source_code_uri"]   = "https://github.com/dry-rb/dry-rails"
+  spec.metadata["bug_tracker_uri"]   = "https://github.com/dry-rb/dry-rails/issues"
 
-  spec.required_ruby_version = ">= 2.4.0"
+  spec.required_ruby_version = ">= 2.7.0"
 
   # to update dependencies edit project.yml
-  spec.add_runtime_dependency "dry-schema", "~> 1.5"
-  spec.add_runtime_dependency "dry-system", "~> 0.17"
+  spec.add_runtime_dependency "dry-schema", "~> 1.7"
+  spec.add_runtime_dependency "dry-system", "~> 0.23", ">= 0.23"
   spec.add_runtime_dependency "dry-validation", "~> 1.5"
 
   spec.add_development_dependency "bundler"

data/lib/dry/rails/boot/application_contract.rb

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
 
-Dry::System.register_component(:application_contract, provider: :rails) do
-  init do
+Dry::System.register_provider_source(:application_contract, group: :rails) do
+  prepare do
     require "dry/rails/features/application_contract"
+    @railtie = target_container[:railtie]
   end
 
   start do
-    railtie.set_or_reload(
+    @railtie.set_or_reload(
       :ApplicationContract,
-      Class.new(Dry::Rails::Features::ApplicationContract).finalize!(railtie)
+      Class.new(Dry::Rails::Features::ApplicationContract).finalize!(@railtie)
     )
   end
 
   stop do
-    railtie.remove_constant(:ApplicationContract)
+    @railtie.remove_constant(:ApplicationContract)
   end
 end

data/lib/dry/rails/boot/controller_helpers.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
-Dry::System.register_component(:controller_helpers, provider: :rails) do
-  init do
+Dry::System.register_provider_source(:controller_helpers, group: :rails) do
+  prepare do
     require "dry/rails/features/controller_helpers"
   end
 
   start do
     ApplicationController.include(Dry::Rails::Features::ControllerHelpers)
+
+    if defined?(ActionController::API)
+      ActionController::API.include(Dry::Rails::Features::ControllerHelpers)
+    end
   end
 end

data/lib/dry/rails/boot/safe_params.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
-Dry::System.register_component(:safe_params, provider: :rails) do
-  init do
+Dry::System.register_provider_source(:safe_params, group: :rails) do
+  prepare do
     require "dry/rails/features/safe_params"
   end
 
   start do
     ApplicationController.include(Dry::Rails::Features::SafeParams)
+
+    if defined?(ActionController::API)
+      ActionController::API.include(Dry::Rails::Features::SafeParams)
+    end
   end
 end

data/lib/dry/rails/container.rb

@@ -3,7 +3,7 @@
 require "rails/version"
 
 require "dry/system/container"
-require "dry/system/components"
+require "dry/system/provider_sources"
 
 require "dry/rails/auto_registrars/app"
 
@@ -27,28 +27,31 @@ module Dry
       #
       #   @api public
       # @!scope class
-      setting :features, %i[application_contract safe_params controller_helpers], reader: true
+      setting :features,
+              default: %i[application_contract safe_params controller_helpers],
+              reader: true
 
-      # @overload config.auto_register_paths=(paths)
-      #   Set an array of path/block pairs for auto-registration
-      #
-      #   This is a low-level setting that typically should not be set explicitly,
-      #   use `auto_register!` instead.
+      # @overload config.auto_inject_constant=(auto_inject_constant)
+      #   Set a custom import constant name
       #
-      #   @param paths [Array<Array>]
+      #   @param auto_inject_constant [String]
       #
       #   @api public
       # @!scope class
-      setting :auto_register_paths, [].freeze, reader: true
+      setting :auto_inject_constant,
+              default: "Deps",
+              reader: true
 
-      # @overload config.auto_inject_constant=(auto_inject_constant)
-      #   Set a custom import constant name
+      # @overload config.container_constant=(container_constant)
+      #   Set a custom container constant
       #
-      #   @param auto_inject_constant [String]
+      #   @param container_constant [String]
       #
       #   @api public
       # @!scope class
-      setting :auto_inject_constant, "Deps", reader: true
+      setting :container_constant,
+              default: "Container",
+              reader: true
 
       # @!endgroup
 
@@ -56,91 +59,13 @@ module Dry
       config.auto_registrar = Rails::AutoRegistrars::App
 
       class << self
-        # Set up auto-registration paths and optional a configuration block
-        #
-        # @example set up a single path
-        #   Dry::Rails.container do
-        #     auto_register!("app/operations")
-        #   end
-        #
-        # @example set up a single path with a configuration block
-        #   Dry::Rails.container do
-        #     auto_register!("app/operations") do |config|
-        #       config.exclude do |component|
-        #         component.path.start_with?("concerns")
-        #       end
-        #     end
-        #   end
-        #
-        # @example set up multiple paths
-        #   Dry::Rails.container do
-        #     auto_register!("lib", "app/operations")
-        #   end
-        #
-        # @example set up multiple paths with a configuration block
-        #   Dry::Rails.container do
-        #     # in this case the config block will be applied to all paths
-        #     auto_register!("lib", "app/operations") do |config|
-        #       config.exclude do |component|
-        #         component.path.start_with?("concerns")
-        #       end
-        #     end
-        #   end
-        #
-        # @param paths [Array<String>] One or more paths relative to the root
-        # @param set_load_paths [Boolean] Whether the paths should be added to $LOAD_PATH
-        # @param load_files [Boolean] Whether files should be `required`-ed already
-        #
-        # @return [self]
-        #
-        # @api public
-        #
-        # TODO: this should be moved to dry-system
-        def auto_register!(*paths, set_load_paths: true, load_files: false, &block)
-          load_paths!(*paths) if set_load_paths
-
-          if load_files
-            paths.each { |path| super(path, &block) }
-          else
-            config.auto_register_paths.concat(paths.product([block]))
-          end
-
-          self
-        end
-
-        # Finalize the container
-        #
-        # This is called automatically via the railtie, so typically you won't be using this method
-        # directly
-        #
-        # @param freeze [Boolean] Whether the container should be frozen upon finalization
-        #
-        # @return [self]
-        #
-        # @api public
-        #
-        # TODO: just like auto_register!, this should be moved to dry-system
-        def finalize!(freeze: false, &block)
-          features.each do |feature|
-            start(feature)
-          end
-
-          auto_register_paths.each do |(path, path_block)|
-            auto_register!(path, set_load_paths: false, load_files: true, &path_block)
-          end
-
-          super
-        end
-
-        # Return if a given component was booted
+        # Return if a given component was started
         #
         # @return [Boolean]
         #
         # @api private
-        #
-        # TODO: this should be moved to dry-system
-        def booted?(name)
-          booter.booted.map(&:identifier).include?(name)
+        def started?(name)
+          providers[name].started?
         end
 
         # TODO: confirm that this is really needed
@@ -156,9 +81,9 @@ module Dry
         # @return [self]
         #
         # @api private
-        def refresh_boot_files
-          booter.boot_files.each do |boot_file|
-            load(boot_file)
+        def refresh_provider_files
+          providers.provider_files.each do |boot_file|
+            ::Kernel.load(boot_file)
           end
           self
         end

data/lib/dry/rails/railtie.rb

@@ -8,6 +8,8 @@ module Dry
     #
     # @api public
     class Railtie < ::Rails::Railtie
+      attr_reader :container_const_name
+
       # This is needed because `finalize!` can reload code and this hook is called every-time
       # in development env upon a request (in production it's called just once during booting)
       config.to_prepare do
@@ -23,16 +25,16 @@ module Dry
       #
       # rubocop:disable Metrics/AbcSize
       def finalize!
+        @container_const_name ||= Dry::Rails::Container.container_constant
+
         stop_features if reloading?
 
         root_path = ::Rails.root
 
         container = Dry::Rails.create_container(
           root: root_path,
-          name: name,
-          default_namespace: name.to_s,
           inflector: default_inflector,
-          system_dir: root_path.join("config/system")
+          provider_dirs: [root_path.join("config/system/boot")]
         )
 
         # Enable :env plugin by default because it is a very common requirement
@@ -41,17 +43,23 @@ module Dry
         container.register(:railtie, self)
         container.register(:inflector, default_inflector)
 
-        set_or_reload(:Container, container)
+        # Remove previously defined constants, if any, so we don't end up with
+        # unsused constants in app's namespace when a name change happens.
+        remove_constant(container.auto_inject_constant)
+        remove_constant(container.container_constant)
 
         Dry::Rails.evaluate_initializer(container)
 
+        @container_const_name = container.container_constant
+
+        set_or_reload(container.container_constant, container)
         set_or_reload(container.auto_inject_constant, container.injector)
 
         container.features.each do |feature|
-          container.boot(feature, from: :rails)
+          container.register_provider(feature, from: :rails)
         end
 
-        container.refresh_boot_files if reloading?
+        container.refresh_provider_files if reloading?
 
         container.finalize!(freeze: !::Rails.env.test?)
       end
@@ -67,7 +75,7 @@ module Dry
       # @api public
       def stop_features
         container.features.each do |feature|
-          container.stop(feature) if container.booted?(feature)
+          container.stop(feature) if container.started?(feature)
         end
       end
 
@@ -77,14 +85,14 @@ module Dry
       #
       # @api public
       def container
-        app_namespace.const_get(:Container, false)
+        app_namespace.const_get(container_const_name, false)
       end
 
       # Return true if we're in code-reloading mode
       #
       # @api private
       def reloading?
-        app_namespace.const_defined?(:Container, false)
+        app_namespace.const_defined?(container_const_name, false)
       end
 
       # Return the default system name
@@ -125,16 +133,15 @@ module Dry
 
       # @api private
       def set_or_reload(const_name, const)
-        if app_namespace.const_defined?(const_name, false)
-          app_namespace.__send__(:remove_const, const_name)
-        end
-
+        remove_constant(const_name)
         app_namespace.const_set(const_name, const)
       end
 
       # @api private
       def remove_constant(const_name)
-        app_namespace.__send__(:remove_const, const_name)
+        if app_namespace.const_defined?(const_name, false)
+          app_namespace.__send__(:remove_const, const_name)
+        end
       end
     end
   end

data/lib/dry/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Dry
   module Rails
-    VERSION = "0.2.0"
+    VERSION = "0.5.0"
   end
 end

data/lib/dry/rails.rb

@@ -1,20 +1,24 @@
 # frozen_string_literal: true
 
+require "dry/system"
 require "dry/rails/railtie"
 require "dry/rails/container"
-require "dry/rails/components"
 
 module Dry
+  Dry::System.register_provider_sources(Pathname(__dir__).join("rails/boot").realpath)
+
   # Initializer interface
   #
   # @example set up a container with auto-registration paths
   #   # config/initializer/system.rb
   #
   #   Dry::Rails.container do
-  #     auto_register!("lib", "app/operations")
-  #   end
+  #     config.component_dirs.add "lib" do |dir|
+  #       dir.namespaces.add "my_super_cool_app", key: nil
+  #     end
   #
-  # @see Dry::Rails::Container.auto_register!
+  #     config.component_dirs.add "app/operations"
+  #   end
   #
   # @api public
   module Rails

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-21 00:00:00.000000000 Z
+date: 2022-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-schema
@@ -16,28 +16,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: dry-system
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.23'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.23'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.23'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.23'
 - !ruby/object:Gem::Dependency
   name: dry-validation
   requirement: !ruby/object:Gem::Requirement
@@ -112,7 +118,6 @@ files:
 - lib/dry/rails/boot/application_contract.rb
 - lib/dry/rails/boot/controller_helpers.rb
 - lib/dry/rails/boot/safe_params.rb
-- lib/dry/rails/components.rb
 - lib/dry/rails/container.rb
 - lib/dry/rails/features/application_contract.rb
 - lib/dry/rails/features/controller_helpers.rb
@@ -135,14 +140,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: The official dry-rb railtie for Ruby on Rails

data/lib/dry/rails/components.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require "dry/system"
-
-Dry::System.register_provider(
-  :rails,
-  boot_path: Pathname(__dir__).join("boot").realpath
-)