Skip to content

Commit b05603f

Browse files
committed
Let Action Cable's autoloader ignore the version file
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 setting an autoload for VERSION in ActionCable makes you think too much about the interactions between these two files and the autoloads triggered by the existing require_relative, which eager loads anyway. I believe this simplification is easier to understand.
1 parent cc9d0b9 commit b05603f

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

actioncable/lib/action_cable.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
loader.ignore(
3232
"#{__dir__}/rails", # Contains generators, templates, docs, etc.
3333
"#{__dir__}/action_cable/gem_version.rb",
34+
"#{__dir__}/action_cable/version.rb",
3435
"#{__dir__}/action_cable/deprecator.rb",
3536
)
3637

0 commit comments

Comments
 (0)