Class: Docwright::Extractors::BackgroundJobsExtractor

Inherits:
Object
  • Object
show all
Defined in:
lib/docwright/extractors/background_jobs_extractor.rb

Constant Summary collapse

INTERNAL_JOBS =
%w[ApplicationJob].freeze

Instance Method Summary collapse

Instance Method Details

#generateObject



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
# File 'lib/docwright/extractors/background_jobs_extractor.rb', line 8

def generate
  unless defined?(ActiveJob)
    puts "DocWright: skipped background_jobs.md — ActiveJob is not loaded."
    puts "  To enable: uncomment 'require \"active_job/railtie\"' in config/application.rb"
    return
  end
  
  begin
    Rails.application.eager_load!
  rescue NameError => e
    puts "DocWright: warning — could not eager load all files: #{e.message}"
  end

  jobs = find_jobs
  if jobs.empty?
    puts "DocWright: no background jobs found — skipping background_jobs.md"
    return
  end

  priorities = load_queue_priorities
  schedules = load_schedules

  FileUtils.mkdir_p("docs")

  jobs.each do |job|
    lines = build_job_lines(job, priorities, schedules)
    notes = "#### Notes for #{job.name}\n<!-- Describe what triggers this job, retry behavior, dependencies -->"
    Docwright::Merger.write_named("docs/background_jobs.md", job.name, lines.join("\n"), notes)
  end

  summary_lines = build_summary_lines(jobs, priorities, schedules)
  Docwright::Merger.write_named("docs/background_jobs.md", "_summary", summary_lines.join("\n"), "")

  puts "DocWright: wrote docs/background_jobs.md"
rescue NameError => e
  raise unless e.message.include?("ActiveJob")

  puts "DocWright: skipped background_jobs.md — ActiveJob is not loaded."
  puts "  To enable: uncomment 'require \"active_job/railtie\"' in config/application.rb"
end