Class: Zeitwerk::Loader

Inherits:
Object
  • Object
show all
Extended by:
Internal, RealModName
Includes:
Callbacks, Config, EagerLoad, Helpers, RealModName
Defined in:
lib/zeitwerk/loader.rb

Direct Known Subclasses

GemLoader

Defined Under Namespace

Modules: Callbacks, Config, EagerLoad, Helpers

Class Attribute Summary collapse

Instance Attribute Summary collapse

Attributes included from Config

#inflector, #logger, #roots

Class Method Summary collapse

Instance Method Summary collapse

Methods included from RealModName

real_mod_name

Methods included from Internal

internal

Methods included from EagerLoad

#eager_load, #eager_load_dir, #eager_load_namespace, #load_file

Methods included from Config

#collapse, #dirs, #do_not_eager_load, #enable_reloading, #ignore, #log!, #on_load, #on_setup, #on_unload, #push_dir, #reloading_enabled?, #tag, #tag=

Methods included from Callbacks

#on_namespace_loaded

Constructor Details

#initialize ⇒ Loader

Returns a new instance of Loader.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/zeitwerk/loader.rb', line 99

def initialize
  super

  @autoloads       = {}
  @autoloaded_dirs = []
  @to_unload       = {}
  @namespace_dirs  = Hash.new { |h, cpath| h[cpath] = [] }
  @shadowed_files  = Set.new
  @setup           = false
  @eager_loaded    = false

  @mutex = Mutex.new
  @dirs_autoload_monitor = Monitor.new

  Registry.register_loader(self)
end

Class Attribute Details

.default_logger ⇒ Object

Returns the value of attribute default_logger.



354
355
356
 
# File 'lib/zeitwerk/loader.rb', line 354

def default_logger
  @default_logger
end

Instance Attribute Details

#autoloaded_dirs ⇒ Object (readonly)

We keep track of autoloaded directories to remove them from the registry at the end of eager loading.

Files are removed as they are autoloaded, but directories need to wait due to concurrency (see why in Zeitwerk::Loader::Callbacks#on_dir_autoloaded).



43
44
45
 
# File 'lib/zeitwerk/loader.rb', line 43

def autoloaded_dirs
  @autoloaded_dirs
end

#autoloads ⇒ Object (readonly)

Maps absolute paths for which an autoload has been set —and not executed— to their corresponding parent class or module and constant name.

"/Users/fxn/blog/app/models/user.rb"          => [Object, :User],
"/Users/fxn/blog/app/models/hotel/pricing.rb" => [Hotel, :Pricing]
...



33
34
35
 
# File 'lib/zeitwerk/loader.rb', line 33

def autoloads
  @autoloads
end

#namespace_dirs ⇒ Object (readonly)

Maps namespace constant paths to their respective directories.

For example, given this mapping:

"Admin" => [
  "/Users/fxn/blog/app/controllers/admin",
  "/Users/fxn/blog/app/models/admin",
  ...
]

when ‘Admin` gets defined we know that it plays the role of a namespace and that its children are spread over those directories. We’ll visit them to set up the corresponding autoloads.



77
78
79
 
# File 'lib/zeitwerk/loader.rb', line 77

def namespace_dirs
  @namespace_dirs
end

#shadowed_files ⇒ Object (readonly)

A shadowed file is a file managed by this loader that is ignored when setting autoloads because its matching constant is already taken.

This private set is populated as we descend. For example, if the loader has only scanned the top-level, ‘shadowed_files` does not have shadowed files that may exist deep in the project tree yet.



88
89
90
 
# File 'lib/zeitwerk/loader.rb', line 88

def shadowed_files
  @shadowed_files
end

#to_unload ⇒ Object (readonly)

Stores metadata needed for unloading. Its entries look like this:

"Admin::Role" => [".../admin/role.rb", [Admin, :Role]]

The cpath as key helps implementing unloadable_cpath? The file name is stored in order to be able to delete it from $LOADED_FEATURES, and the pair [Module, Symbol] is used to remove_const the constant from the class or module object.

If reloading is enabled, this hash is filled as constants are autoloaded or eager loaded. Otherwise, the collection remains empty.



59
60
61
 
# File 'lib/zeitwerk/loader.rb', line 59

def to_unload
  @to_unload
end

Class Method Details

.all_dirs ⇒ Object

Returns an array with the absolute paths of the root directories of all registered loaders. This is a read-only collection.



438
439
440
 
# File 'lib/zeitwerk/loader.rb', line 438

def all_dirs
  Registry.loaders.flat_map(&:dirs).freeze
end

.eager_load_all ⇒ Object

Broadcasts ‘eager_load` to all loaders. Those that have not been setup are skipped.



410
411
412
413
414
415
416
417
418
 
# File 'lib/zeitwerk/loader.rb', line 410

def eager_load_all
  Registry.loaders.each do |loader|
    begin
      loader.eager_load
    rescue SetupRequired
      # This is fine, we eager load what can be eager loaded.
    end
  end
end

.eager_load_namespace(mod) ⇒ Object

Broadcasts ‘eager_load_namespace` to all loaders. Those that have not been setup are skipped.



424
425
426
427
428
429
430
431
432
 
# File 'lib/zeitwerk/loader.rb', line 424

def eager_load_namespace(mod)
  Registry.loaders.each do |loader|
    begin
      loader.eager_load_namespace(mod)
    rescue SetupRequired
      # This is fine, we eager load what can be eager loaded.
    end
  end
end

.for_gem(warn_on_extra_files: true) ⇒ Object

This is a shortcut for

require "zeitwerk"

loader = Zeitwerk::Loader.new
loader.tag = File.basename(__FILE__, ".rb")
loader.inflector = Zeitwerk::GemInflector.new(__FILE__)
loader.push_dir(__dir__)

except that this method returns the same object in subsequent calls from the same file, in the unlikely case the gem wants to be able to reload.

This method returns a subclass of Zeitwerk::Loader, but the exact type is private, client code can only rely on the interface.



372
373
374
375
 
# File 'lib/zeitwerk/loader.rb', line 372

def for_gem(warn_on_extra_files: true)
  called_from = caller_locations(1, 1).first.path
  Registry.loader_for_gem(called_from, namespace: Object, warn_on_extra_files: warn_on_extra_files)
end

.for_gem_extension(namespace) ⇒ Object

This is a shortcut for

require "zeitwerk"

loader = Zeitwerk::Loader.new
loader.tag = namespace.name + "-" + File.basename(__FILE__, ".rb")
loader.inflector = Zeitwerk::GemInflector.new(__FILE__)
loader.push_dir(__dir__, namespace: namespace)

except that this method returns the same object in subsequent calls from the same file, in the unlikely case the gem wants to be able to reload.

This method returns a subclass of Zeitwerk::Loader, but the exact type is private, client code can only rely on the interface.



393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/zeitwerk/loader.rb', line 393

def for_gem_extension(namespace)
  unless namespace.is_a?(Module) # Note that Class < Module.
    raise Zeitwerk::Error, "#{namespace.inspect} is not a class or module object, should be"
  end

  unless real_mod_name(namespace)
    raise Zeitwerk::Error, "extending anonymous namespaces is unsupported"
  end

  called_from = caller_locations(1, 1).first.path
  Registry.loader_for_gem(called_from, namespace: namespace, warn_on_extra_files: false)
end

Instance Method Details

#all_expected_cpaths ⇒ Object

Returns a hash that maps the absolute paths of the managed files and directories to their respective expected constant paths.



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/zeitwerk/loader.rb', line 237

def all_expected_cpaths
  result = {}

  actual_roots.each do |root_dir, root_namespace|
    queue = [[root_dir, real_mod_name(root_namespace)]]

    until queue.empty?
      dir, cpath = queue.shift
      result[dir] = cpath

      prefix = cpath == "Object" ? "" : cpath + "::"

      ls(dir) do |basename, abspath, ftype|
        if ftype == :file
          basename.delete_suffix!(".rb")
          result[abspath] = prefix + inflector.camelize(basename, abspath)
        else
          if collapse?(abspath)
            queue << [abspath, cpath]
          else
            queue << [abspath, prefix + inflector.camelize(basename, abspath)]
          end
        end
      end
    end
  end

  result
end

#cpath_expected_at(path) ⇒ Object

Raises:



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/zeitwerk/loader.rb', line 268

def cpath_expected_at(path)
  abspath = File.expand_path(path)

  raise Zeitwerk::Error.new("#{abspath} does not exist") unless File.exist?(abspath)

  return unless dir?(abspath) || ruby?(abspath)
  return if ignored_path?(abspath)

  paths = []

  if ruby?(abspath)
    basename = File.basename(abspath, ".rb")
    return if hidden?(basename)

    paths << [basename, abspath]
    walk_up_from = File.dirname(abspath)
  else
    walk_up_from = abspath
  end

  root_namespace = nil

  walk_up(walk_up_from) do |dir|
    break if root_namespace = roots[dir]
    return if ignored_path?(dir)

    basename = File.basename(dir)
    return if hidden?(basename)

    paths << [basename, abspath] unless collapse?(dir)
  end

  return unless root_namespace

  if paths.empty?
    real_mod_name(root_namespace)
  else
    cnames = paths.reverse_each.map { |b, a| cname_for(b, a) }

    if root_namespace == Object
      cnames.join("::")
    else
      "#{real_mod_name(root_namespace)}::#{cnames.join("::")}"
    end
  end
end

#reload ⇒ Object

Unloads all loaded code, and calls setup again so that the loader is able to pick any changes in the file system.

This method is not thread-safe, please see how this can be achieved by client code in the README of the project.

Raises:



223
224
225
226
227
228
229
230
231
 
# File 'lib/zeitwerk/loader.rb', line 223

def reload
  raise ReloadingDisabledError unless reloading_enabled?
  raise SetupRequired unless @setup

  unload
  recompute_ignored_paths
  recompute_collapse_dirs
  setup
end

#setup ⇒ Object

Sets autoloads in the root namespaces.



119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/zeitwerk/loader.rb', line 119

def setup
  mutex.synchronize do
    break if @setup

    actual_roots.each do |root_dir, root_namespace|
      define_autoloads_for_dir(root_dir, root_namespace)
    end

    on_setup_callbacks.each(&:call)

    @setup = true
  end
end

#unload ⇒ Object

Removes loaded constants and configured autoloads.

The objects the constants stored are no longer reachable through them. In addition, since said objects are normally not referenced from anywhere else, they are eligible for garbage collection, which would effectively unload them.

This method is public but undocumented. Main interface is ‘reload`, which means `unload` + `setup`. This one is available to be used together with `unregister`, which is undocumented too.



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/zeitwerk/loader.rb', line 145

def unload
  mutex.synchronize do
    raise SetupRequired unless @setup

    # We are going to keep track of the files that were required by our
    # autoloads to later remove them from $LOADED_FEATURES, thus making them
    # loadable by Kernel#require again.
    #
    # Directories are not stored in $LOADED_FEATURES, keeping track of files
    # is enough.
    unloaded_files = Set.new

    autoloads.each do |abspath, (parent, cname)|
      if parent.autoload?(cname)
        unload_autoload(parent, cname)
      else
        # Could happen if loaded with require_relative. That is unsupported,
        # and the constant path would escape unloadable_cpath? This is just
        # defensive code to clean things up as much as we are able to.
        unload_cref(parent, cname)
        unloaded_files.add(abspath) if ruby?(abspath)
      end
    end

    to_unload.each do |cpath, (abspath, (parent, cname))|
      unless on_unload_callbacks.empty?
        begin
          value = cget(parent, cname)
        rescue ::NameError
          # Perhaps the user deleted the constant by hand, or perhaps an
          # autoload failed to define the expected constant but the user
          # rescued the exception.
        else
          run_on_unload_callbacks(cpath, value, abspath)
        end
      end

      unload_cref(parent, cname)
      unloaded_files.add(abspath) if ruby?(abspath)
    end

    unless unloaded_files.empty?
      # Bootsnap decorates Kernel#require to speed it up using a cache and
      # this optimization does not check if $LOADED_FEATURES has the file.
      #
      # To make it aware of changes, the gem defines singleton methods in
      # $LOADED_FEATURES:
      #
      #   https://github.com/Shopify/bootsnap/blob/master/lib/bootsnap/load_path_cache/core_ext/loaded_features.rb
      #
      # Rails applications may depend on bootsnap, so for unloading to work
      # in that setting it is preferable that we restrict our API choice to
      # one of those methods.
      $LOADED_FEATURES.reject! { |file| unloaded_files.member?(file) }
    end

    autoloads.clear
    autoloaded_dirs.clear
    to_unload.clear
    namespace_dirs.clear
    shadowed_files.clear

    Registry.on_unload(self)
    ExplicitNamespace.__unregister_loader(self)

    @setup        = false
    @eager_loaded = false
  end
end

#unloadable_cpath?(cpath) ⇒ Boolean

Says if the given constant path would be unloaded on reload. This predicate returns ‘false` if reloading is disabled.

Returns:

  • (Boolean) 


319
320
321
 
# File 'lib/zeitwerk/loader.rb', line 319

def unloadable_cpath?(cpath)
  to_unload.key?(cpath)
end

#unloadable_cpaths ⇒ Object

Returns an array with the constant paths that would be unloaded on reload. This predicate returns an empty array if reloading is disabled.



327
328
329
 
# File 'lib/zeitwerk/loader.rb', line 327

def unloadable_cpaths
  to_unload.keys.freeze
end

#unregister ⇒ Object

This is a dangerous method.



335
336
337
338
 
# File 'lib/zeitwerk/loader.rb', line 335

def unregister
  Registry.unregister_loader(self)
  ExplicitNamespace.__unregister_loader(self)
end