Skip to content

Commit

Permalink
Let Action Cable's autoloader ignore the version file
Browse files Browse the repository at this point in the history
Rails components version files are organized in a particular way.

On one hand, ActionCable::VERSION is defined in action_cable/gem_version.rb, but
that file does not follow Zeitwerk conventions, so we ignore it.

Addtionally, action_cable/gem_version.rb defines ActionCable.gem_version, and we
need to eager load it to have that method available for client code.

On the other hand, there is also action_cable/version.rb, which loads
action_cable/gem_version.rb. That file follows the conventions because by
loading it, the expected constant gets defined as a side-effect, but it does so
in an unusual indirect way.

All in all, the setup that we had technically works, but I setting an autoload
for VERSION in ActionCable makes you think too much about the interactions
between these two files and the autoloads being triggered by the existing
require_relative, which eager loads anyway.

I believe this simplification is easier to understand.
  • Loading branch information
fxn committed Apr 22, 2024
1 parent cc9d0b9 commit 538dc85
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions actioncable/lib/action_cable.rb
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
loader.ignore(
"#{__dir__}/rails", # Contains generators, templates, docs, etc.
"#{__dir__}/action_cable/gem_version.rb",
"#{__dir__}/action_cable/version.rb",
"#{__dir__}/action_cable/deprecator.rb",
)

Expand Down

0 comments on commit 538dc85

Please sign in to comment.