Module: Zeitwerk::Loader::Config

Included in:
Zeitwerk::Loader
Defined in:
lib/zeitwerk/loader/config.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#collapse_dirs ⇒ Object (readonly)

The actual collection of absolute directory names at the time the collapse glob patterns were expanded. Computed on setup, and recomputed on reload.



51
52
53
 
# File 'lib/zeitwerk/loader/config.rb', line 51

def collapse_dirs
  @collapse_dirs
end

#collapse_glob_patterns ⇒ Object (readonly)

Absolute paths of directories or glob patterns to be collapsed.



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

def collapse_glob_patterns
  @collapse_glob_patterns
end

#eager_load_exclusions ⇒ Object (readonly)

Absolute paths of files or directories not to be eager loaded.



57
58
59
 
# File 'lib/zeitwerk/loader/config.rb', line 57

def eager_load_exclusions
  @eager_load_exclusions
end

#ignored_glob_patterns ⇒ Object (readonly)

Absolute paths of files, directories, or glob patterns to be totally ignored.



30
31
32
 
# File 'lib/zeitwerk/loader/config.rb', line 30

def ignored_glob_patterns
  @ignored_glob_patterns
end

#ignored_paths ⇒ Object (readonly)

The actual collection of absolute file and directory names at the time the ignored glob patterns were expanded. Computed on setup, and recomputed on reload.



38
39
40
 
# File 'lib/zeitwerk/loader/config.rb', line 38

def ignored_paths
  @ignored_paths
end

#inflector ⇒ Object

Returns the value of attribute inflector.



23
24
25
 
# File 'lib/zeitwerk/loader/config.rb', line 23

def inflector
  @inflector
end

#logger ⇒ Object

Returns the value of attribute logger.



80
81
82
 
# File 'lib/zeitwerk/loader/config.rb', line 80

def logger
  @logger
end

#on_load_callbacks ⇒ Object (readonly)

User-oriented callbacks to be fired when a constant is loaded.



70
71
72
 
# File 'lib/zeitwerk/loader/config.rb', line 70

def on_load_callbacks
  @on_load_callbacks
end

#on_setup_callbacks ⇒ Object (readonly)

User-oriented callbacks to be fired on setup and on reload.



63
64
65
 
# File 'lib/zeitwerk/loader/config.rb', line 63

def on_setup_callbacks
  @on_setup_callbacks
end

#on_unload_callbacks ⇒ Object (readonly)

User-oriented callbacks to be fired before constants are removed.



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

def on_unload_callbacks
  @on_unload_callbacks
end

#root_dirs ⇒ Object (readonly)

Absolute paths of the root directories. Stored in a hash to preserve order, easily handle duplicates, have a fast lookup needed for detecting nested paths, and store namespaces as values.

"/Users/fxn/blog/app/channels" => Object,
"/Users/fxn/blog/app/adapters" => ActiveJob::QueueAdapters,
...

This is a private collection maintained by the loader. The public interface for it is `push_dir` and `dirs`.



20
21
22
 
# File 'lib/zeitwerk/loader/config.rb', line 20

def root_dirs
  @root_dirs
end

Instance Method Details

#collapse(*glob_patterns) ⇒ Object

Configure directories or glob patterns to be collapsed.



199
200
201
202
203
204
205
 
# File 'lib/zeitwerk/loader/config.rb', line 199

def collapse(*glob_patterns)
  glob_patterns = expand_paths(glob_patterns)
  mutex.synchronize do
    collapse_glob_patterns.merge(glob_patterns)
    collapse_dirs.merge(expand_glob_patterns(glob_patterns))
  end
end

#dirs(namespaces: false) ⇒ Object

If `namespaces` is falsey (default), returns an array with the absolute paths of the root directories as strings. If truthy, returns a hash table instead. Keys are the absolute paths of the root directories as strings, values are their corresponding namespaces, class or module objects.

These are read-only collections, please add to them with `push_dir`.



147
148
149
150
151
152
153
 
# File 'lib/zeitwerk/loader/config.rb', line 147

def dirs(namespaces: false)
  if namespaces
    root_dirs.clone
  else
    root_dirs.keys
  end.freeze
end

#do_not_eager_load(*paths) ⇒ Object

Let eager load ignore the given files or directories. The constants defined in those files are still autoloadable.



181
182
183
 
# File 'lib/zeitwerk/loader/config.rb', line 181

def do_not_eager_load(*paths)
  mutex.synchronize { eager_load_exclusions.merge(expand_paths(paths)) }
end

#enable_reloading ⇒ Object

You need to call this method before setup in order to be able to reload. There is no way to undo this, either you want to reload or you don't.

Raises:



160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/zeitwerk/loader/config.rb', line 160

def enable_reloading
  mutex.synchronize do
    break if @reloading_enabled

    if @setup
      raise Zeitwerk::Error, "cannot enable reloading after setup"
    else
      @reloading_enabled = true
    end
  end
end

#ignore(*glob_patterns) ⇒ Object

Configure files, directories, or glob patterns to be totally ignored.



188
189
190
191
192
193
194
 
# File 'lib/zeitwerk/loader/config.rb', line 188

def ignore(*glob_patterns)
  glob_patterns = expand_paths(glob_patterns)
  mutex.synchronize do
    ignored_glob_patterns.merge(glob_patterns)
    ignored_paths.merge(expand_glob_patterns(glob_patterns))
  end
end

#ignores?(abspath) ⇒ Boolean

Returns true if the argument has been configured to be ignored, or is a descendant of an ignored directory.

Returns:

  • (Boolean) 


280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/zeitwerk/loader/config.rb', line 280

def ignores?(abspath)
  # Common use case.
  return false if ignored_paths.empty?

  walk_up(abspath) do |abspath|
    return true  if ignored_paths.member?(abspath)
    return false if root_dirs.key?(abspath)
  end

  false
end

#initialize ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/zeitwerk/loader/config.rb', line 82

def initialize
  @initialized_at         = Time.now
  @root_dirs              = {}
  @inflector              = Zeitwerk::Inflector.new
  @ignored_glob_patterns  = Set.new
  @ignored_paths          = Set.new
  @collapse_glob_patterns = Set.new
  @collapse_dirs          = Set.new
  @eager_load_exclusions  = Set.new
  @reloading_enabled      = false
  @on_setup_callbacks     = []
  @on_load_callbacks      = {}
  @on_unload_callbacks    = {}
  @logger                 = self.class.default_logger
  @tag                    = SecureRandom.hex(3)
end

#log! ⇒ Object

Logs to `$stdout`, handy shortcut for debugging.



271
272
273
 
# File 'lib/zeitwerk/loader/config.rb', line 271

def log!
  @logger = ->(msg) { puts msg }
end

#on_load(cpath = :ANY, &block) ⇒ Object

Configure a block to be invoked once a certain constant path is loaded. Supports multiple callbacks, and if there are many, they are executed in the order in which they were defined.

loader.on_load("SomeApiClient") do |klass, _abspath|
  klass.endpoint = "https://api.dev"
end

Can also be configured for any constant loaded:

loader.on_load do |cpath, value, abspath|
  # ...
end

Raises:

  • (TypeError) 


235
236
237
238
239
240
241
 
# File 'lib/zeitwerk/loader/config.rb', line 235

def on_load(cpath = :ANY, &block)
  raise TypeError, "on_load only accepts strings" unless cpath.is_a?(String) || cpath == :ANY

  mutex.synchronize do
    (on_load_callbacks[cpath] ||= []) << block
  end
end

#on_setup(&block) ⇒ Object

Configure a block to be called after setup and on each reload. If setup was already done, the block runs immediately.



211
212
213
214
215
216
 
# File 'lib/zeitwerk/loader/config.rb', line 211

def on_setup(&block)
  mutex.synchronize do
    on_setup_callbacks << block
    block.call if @setup
  end
end

#on_unload(cpath = :ANY, &block) ⇒ Object

Configure a block to be invoked right before a certain constant is removed. Supports multiple callbacks, and if there are many, they are executed in the order in which they were defined.

loader.on_unload("Country") do |klass, _abspath|
  klass.clear_cache
end

Can also be configured for any removed constant:

loader.on_unload do |cpath, value, abspath|
  # ...
end

Raises:

  • (TypeError) 


260
261
262
263
264
265
266
 
# File 'lib/zeitwerk/loader/config.rb', line 260

def on_unload(cpath = :ANY, &block)
  raise TypeError, "on_unload only accepts strings" unless cpath.is_a?(String) || cpath == :ANY

  mutex.synchronize do
    (on_unload_callbacks[cpath] ||= []) << block
  end
end

#push_dir(path, namespace: Object) ⇒ Object

Pushes `path` to the list of root directories.

Raises `Zeitwerk::Error` if `path` does not exist, or if another loader in the same process already manages that directory or one of its ascendants or descendants.

Raises:



107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/zeitwerk/loader/config.rb', line 107

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

  abspath = File.expand_path(path)
  if dir?(abspath)
    raise_if_conflicting_directory(abspath)
    root_dirs[abspath] = namespace
  else
    raise Zeitwerk::Error, "the root directory #{abspath} does not exist"
  end
end

#reloading_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


173
174
175
 
# File 'lib/zeitwerk/loader/config.rb', line 173

def reloading_enabled?
  @reloading_enabled
end

#tag ⇒ Object

Returns the loader's tag.

Implemented as a method instead of via attr_reader for symmetry with the writer below.



128
129
130
 
# File 'lib/zeitwerk/loader/config.rb', line 128

def tag
  @tag
end

#tag=(tag) ⇒ Object

Sets a tag for the loader, useful for logging.



135
136
137
 
# File 'lib/zeitwerk/loader/config.rb', line 135

def tag=(tag)
  @tag = tag.to_s
end