Add a comment for dirname vs __dir__ usage

rails · Jun 24, 2024 · 85630de · 85630de
1 parent 69cee18
commit 85630de
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/actioncable/lib/action_cable.rb b/actioncable/lib/action_cable.rb
@@ -27,7 +27,11 @@
 require "active_support/rails"
 require "zeitwerk"
 
+# We compute lib this way instead of using __dir__ because __dir__ gives a real
+# path, while __FILE__ honors symlinks. If the gem is stored under a symlinked
+# directory, this matters.
 lib = File.dirname(__FILE__)
+
 Zeitwerk::Loader.for_gem.tap do |loader|
  loader.ignore(
  "#{lib}/rails", # Contains generators, templates, docs, etc.