Sha256: f70ff7550931c8caa34d58ad237ae02d311eb06928a435378ffc5092265f08d5

Contents?: true

Size: 1.8 KB

Versions: 59

Compression:

Stored size: 1.8 KB

Contents

# 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 following directories will only be checked if you configure
    them to be 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 [\w:]+/
        abort $&.sub(/expected file #{Regexp.escape(Rails.root.to_s)}./, "expected file ")
      else
        raise
      end
    end

    require "active_support/core_ext/object/try"
    eager_load_paths = Rails.configuration.eager_load_namespaces.map do |eln|
      # Quick regression fix for 6.0.3 to support namespaces that do not have
      # eager load paths, like the recently added i18n. I'll rewrite this task.
      eln.try(:config).try(:eager_load_paths)
    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

Version data entries

59 entries across 59 versions & 4 rubygems

Version Path
railties-6.1.7.10 lib/rails/tasks/zeitwerk.rake
railties-6.1.7.9 lib/rails/tasks/zeitwerk.rake
railties-6.1.7.8 lib/rails/tasks/zeitwerk.rake
railties-6.1.7.7 lib/rails/tasks/zeitwerk.rake
scrapbook-0.3.2 vendor/ruby/2.7.0/gems/railties-6.1.6.1/lib/rails/tasks/zeitwerk.rake
railties-6.1.7.6 lib/rails/tasks/zeitwerk.rake
railties-6.1.7.5 lib/rails/tasks/zeitwerk.rake
railties-6.1.7.4 lib/rails/tasks/zeitwerk.rake
scrapbook-0.3.1 vendor/ruby/2.7.0/gems/railties-6.1.6.1/lib/rails/tasks/zeitwerk.rake
railties-6.1.7.3 lib/rails/tasks/zeitwerk.rake
railties-6.1.7.2 lib/rails/tasks/zeitwerk.rake
railties-6.1.7.1 lib/rails/tasks/zeitwerk.rake
railties-6.0.6.1 lib/rails/tasks/zeitwerk.rake
railties-6.1.7 lib/rails/tasks/zeitwerk.rake
railties-6.0.6 lib/rails/tasks/zeitwerk.rake
railties-6.1.6.1 lib/rails/tasks/zeitwerk.rake
railties-6.0.5.1 lib/rails/tasks/zeitwerk.rake
railties-6.0.5 lib/rails/tasks/zeitwerk.rake
railties-6.1.6 lib/rails/tasks/zeitwerk.rake
railties-6.1.5.1 lib/rails/tasks/zeitwerk.rake