dry-rails 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80646821bfa562f0f6f1bfde095e604c2075658ecfdebb939f61882a1ace17aa
-  data.tar.gz: 5acb65998a0bce73d51501c9849616edf088f0e9e7ace755002bf934d283bee0
+  metadata.gz: 315efa0b4975c1afe8c02e36ad325eda687c505cbeec76329eaf330f229d21f2
+  data.tar.gz: 0ee2ec74bafce16a2cee710fb90c10bb483b672f1178fbd76a4518c7d12d98ea
 SHA512:
-  metadata.gz: 76bf9e8a90ee53fe74ba0a04a16449c1c7689c35535b23489e85c7a77a001b493d60e299bf888efbc383188e79e9b1571e120a792cb06530b64060ccc467bc94
-  data.tar.gz: 3c6313b60d8142a73ec41772eab42f12bc53d89293c7d3031b43c8e9ba79f592bb25b4f9524878d1edecebeb5d2b1dc8f36d99d1d2e769f577d2fd318918bd34
+  metadata.gz: acd9f6bda792c65ee94b92d6e62ba286f33c2f3b4d7c01fa7f2b7818954fa61c52705686fa919091174ef6de8172d2dfb9b68077bf6f8a866a8fd19e10129290
+  data.tar.gz: 8001793ca368b1dc0388cacd2610441082a22163ec209169194be1d84aaa1ad5b83b8b6d3d45ea395eac29b5e1bb532296a425dac1664de91675f74a47794a7b

data/CHANGELOG.md

@@ -1,26 +1,71 @@
-## unreleased 
+<!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
 
-Initial port of dry-system-rails with a couple of new features
+## 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
 
-- `:rails` system component provider, which uses standard bootable components, aka "features", to manage application state (@solnic)
-- `config.features` setting which is an array with feature identifiers that you want the railtie to boot (@solnic)
-- `:application_contract` feature which defines `ApplicationContract` within the application namespace and configured to work with `I18n` (@solnic)
-- `:safe_params` feature which extends `ApplicationController` with `schema` DSL and exposes `safe_params` controller helper (@solnic)
-- `:controller_helper` feature which adds `ApplicationController#{resolve,container}` shortcuts (@solnic)
+- 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)
+
+[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
+
+- You can now configure auto_inject constant name via `config.auto_inject_constant` - previously it was hardcoded as `"Import"`, now it's configured as `"Deps"` by default (issue #18 closed via #29) (@diegotoral)
+
+### Fixed
+
+- Resolving `Container` constant looks it up only within the application namespace (see #22 for more information) (@jandudulski)
+- [safe_params] defining multiple schemas works as expected (issue #23 fixed via 24) (@gotar)
+
+### Changed
 
+- The `:env` dry-system plugin is now enabled by default (fixes #28 via #30) (@solnic)
 
-[Compare vunreleased...master](https://github.com/dry-rb/dry-rails/compare/vunreleased...master)
+[Compare v0.1.0...v0.2.0](https://github.com/dry-rb/dry-rails/compare/v0.1.0...v0.2.0)
 
-## unreleased 
+## 0.1.0 2020-03-30
 
-Initial port of dry-system-rails with a couple of new features
+This is based on dry-system-rails that dry-rails replaces.
 
 ### Added
 
-- `:rails` system component provider, which uses standard bootable components, aka "features", to manage application state (@solnic)
 - `config.features` setting which is an array with feature identifiers that you want the railtie to boot (@solnic)
 - `:application_contract` feature which defines `ApplicationContract` within the application namespace and configured to work with `I18n` (@solnic)
 - `:safe_params` feature which extends `ApplicationController` with `schema` DSL and exposes `safe_params` controller helper (@solnic)
-- `:controller_helper` feature which adds `ApplicationController#{resolve,container}` shortcuts (@solnic)
+- `:controller_helpers` feature which adds `ApplicationController#{resolve,container}` shortcuts (@solnic)

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

@@ -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
@@ -7,23 +8,22 @@
 # dry-rails [![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-rails.svg)][gem]
-[![CI Status](https://github.com/dry-rb/dry-rails/workflows/ci/badge.svg)][actions]
+[![CI Status](https://github.com/dry-rb/dry-rails/workflows/CI/badge.svg)][actions]
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/d4677ea0c4c2497bb1af1b3ac31552f4)][codacy]
 [![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.6.0`
+* jruby `>= 9.3`
 
 ## 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.6.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.21"
   spec.add_runtime_dependency "dry-validation", "~> 1.5"
 
   spec.add_development_dependency "bundler"

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

@@ -7,5 +7,9 @@ Dry::System.register_component(:controller_helpers, provider: :rails) do
 
   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

@@ -7,5 +7,9 @@ Dry::System.register_component(:safe_params, provider: :rails) do
 
   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

@@ -27,19 +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
+      # @overload config.auto_inject_constant=(auto_inject_constant)
+      #   Set a custom import constant name
       #
-      #   This is a low-level setting that typically should not be set explicitly,
-      #   use `auto_register!` instead.
+      #   @param auto_inject_constant [String]
       #
-      #   @param paths [Array<Array>]
+      #   @api public
+      # @!scope class
+      setting :auto_inject_constant,
+              default: "Deps",
+              reader: true
+
+      # @overload config.container_constant=(container_constant)
+      #   Set a custom container constant
+      #
+      #   @param container_constant [String]
       #
       #   @api public
       # @!scope class
-      setting :auto_register_paths, [].freeze, reader: true
+      setting :container_constant,
+              default: "Container",
+              reader: true
 
       # @!endgroup
 
@@ -47,82 +59,6 @@ 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 [Boolean]
@@ -131,7 +67,7 @@ module Dry
         #
         # TODO: this should be moved to dry-system
         def booted?(name)
-          booter.booted.map(&:identifier).include?(name)
+          booter.booted.map(&:name).include?(name)
         end
 
         # TODO: confirm that this is really needed

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

@@ -13,6 +13,10 @@ module Dry
         def self.included(klass)
           super
           klass.extend(ClassMethods)
+
+          klass.class_eval do
+            before_action(:set_safe_params, prepend: true)
+          end
         end
 
         # ApplicationController methods
@@ -33,8 +37,6 @@ module Dry
               schemas[name] = schema
             end
 
-            before_action(:set_safe_params, only: actions)
-
             self
           end
 
@@ -68,7 +70,11 @@ module Dry
 
         # @api private
         def set_safe_params
-          @safe_params = schemas[action_name.to_sym].(request.params)
+          schema = schemas[action_name.to_sym]
+
+          return unless schema
+
+          @safe_params = schema.(request.params)
         end
       end
     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
@@ -16,31 +18,44 @@ module Dry
 
       # Code-reloading-aware finalization process
       #
-      # This sets up `Container` and `Import` constants, reloads them if this is in reloading mode,
+      # This sets up `Container` and `Deps` constants, reloads them if this is in reloading mode,
       # and registers default components like the railtie itself or the inflector
       #
       # @api public
+      #
+      # 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")
+          system_dir: root_path.join("config/system"),
+          bootable_dirs: [root_path.join("config/system/boot")]
         )
 
+        # Enable :env plugin by default because it is a very common requirement
+        container.use :env, inferrer: -> { ::Rails.env }
+
         container.register(:railtie, self)
         container.register(:inflector, default_inflector)
 
-        set_or_reload(:Container, container)
-        set_or_reload(:Import, container.injector)
+        # 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)
         end
@@ -49,6 +64,7 @@ module Dry
 
         container.finalize!(freeze: !::Rails.env.test?)
       end
+      # rubocop:enable Metrics/AbcSize
       alias_method :reload, :finalize!
 
       # Stops all configured features (bootable components)
@@ -70,14 +86,14 @@ module Dry
       #
       # @api public
       def container
-        app_namespace.const_get(:Container)
+        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)
+        app_namespace.const_defined?(container_const_name, false)
       end
 
       # Return the default system name
@@ -118,16 +134,15 @@ module Dry
 
       # @api private
       def set_or_reload(const_name, const)
-        if app_namespace.const_defined?(const_name)
-          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.1.0"
+    VERSION = "0.4.0"
   end
 end

data/lib/dry/rails.rb

@@ -11,10 +11,12 @@ module Dry
   #   # 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.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-30 00:00:00.000000000 Z
+date: 2021-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-schema
@@ -16,28 +16,28 @@ 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.21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.21'
 - !ruby/object:Gem::Dependency
   name: dry-validation
   requirement: !ruby/object:Gem::Requirement
@@ -135,14 +135,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.6.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