Class: Docwright::Extractors::ModelExtractor

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

Instance Method Summary collapse

Instance Method Details

#generateObject



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

def generate
  unless defined?(ActiveRecord)
    puts "DocWright: skipped models.md — ActiveRecord is not loaded."
    return
  end

  begin
    Rails.application.eager_load!
  rescue NameError => e
    puts "DocWright: warning — could not eager load all files: #{e.message}"
  end

  models = find_models
  FileUtils.mkdir_p("docs")

  models.each do |model|
    lines = []
    lines << "## #{model.name}"
    lines << "**Table:** #{model.table_name}\n"

    lines << "### Associations"
    associations = model.reflect_on_all_associations
    if associations.empty?
      lines << "- None"
    else
      associations.each do |a|
        lines << "- #{a.macro} :#{a.name}"
      end
    end

    lines << "\n### Validations"
    validations = model.validators
    if validations.empty?
      lines << "- None"
    else
      validations.each do |v|
        lines << "- #{v.class.name} on : #{v.attributes.join(", ")}"
      end
    end

    notes = "### Notes for #{model.name}\n<!-- Add your notes about #{model.name} here -->"
    Docwright::Merger.write_named("docs/models.md", model.name, lines.join("\n"), notes)
  end

  puts "DocWright: wrote docs/models.md"
end