blob: 5421af6e8b6f54424b991bf713cd4f016e365ef7 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
# frozen_string_literal: true
ensure_zeitwerk_mode = ->() do
unless Rails.autoloaders.zeitwerk_enabled?
abort "Please, enable :zeitwerk mode in config/application.rb and try again."
end
end
eager_load = ->() do
puts "Hold on, I am eager loading the application."
Zeitwerk::Loader.eager_load_all
end
report_not_checked = ->(not_checked) do
puts
puts <<~EOS
WARNING: The files in these directories cannot be checked because they
are not eager loaded:
EOS
puts
not_checked.each { |dir| puts " #{dir}" }
puts
puts <<~EOS
You may verify them manually, or add them to config.eager_load_paths
in config/application.rb and run zeitwerk:check again.
EOS
puts
end
report = ->(not_checked) do
if not_checked.any?
report_not_checked[not_checked]
puts "Otherwise, all is good!"
else
puts "All is good!"
end
end
namespace :zeitwerk do
desc "Checks project structure for Zeitwerk compatibility"
task check: :environment do
ensure_zeitwerk_mode[]
begin
eager_load[]
rescue NameError => e
if e.message =~ /expected file .*? to define constant \S+/
abort $&.sub(/#{Regexp.escape(Rails.root.to_s)}./, "")
else
raise
end
end
eager_load_paths = Rails.configuration.eager_load_namespaces.map do |eln|
eln.config.eager_load_paths if eln.respond_to?(:config)
end.compact.flatten
not_checked = ActiveSupport::Dependencies.autoload_paths - eager_load_paths
not_checked.select! { |dir| Dir.exist?(dir) }
not_checked.reject! { |dir| Dir.empty?(dir) }
report[not_checked]
end
end
|
