Skip to content

Commit

Permalink
Revise the autoloading guide for middleware and friends
Browse files Browse the repository at this point in the history
  • Loading branch information
fxn committed May 7, 2024
1 parent 39ce8a4 commit 0e14713
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion guides/source/autoloading_and_reloading_constants.md
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,21 @@ That adds a module object to the ancestor chain of `ActiveRecord::Base`. Changes

Corollary: Those classes or modules **cannot be reloadable**.

The easiest way to refer to those classes or modules during boot is to have them defined in a directory which does not belong to the autoload paths. For instance, `lib` is an idiomatic choice. It does not belong to the autoload paths by default, but it does belong to `$LOAD_PATH`. Just perform a regular `require` to load it.
An idiomatic way to organize these files is to put them in the `lib` directory and load them with `require` where needed. For example, if the application has custom middleware in `lib/middleware`, issue a regular `require` call before configuring it:

```ruby
require "middleware/my_middleware"
config.middleware.use MyMiddleware
```

Additionally, if `lib` is in the autoload paths, configure the autoloader to ignore that subdirectory:

```ruby
# config/application.rb
config.autoload_lib(ignore: %w(assets tasks ... middleware))
```

since you are loading those files yourself.

As noted above, another option is to have the directory that defines them in the autoload once paths and autoload. Please check the [section about config.autoload_once_paths](#config-autoload-once-paths) for details.

Expand Down

0 comments on commit 0e14713

Please sign in to comment.