Class: Diecut::ReportBuilders::UnusedDefault

Inherits:
Diecut::ReportBuilder show all
Defined in:
lib/diecut/report-builders/unused-default.rb

Instance Attribute Summary

Attributes inherited from Diecut::ReportBuilder

#mill

Instance Method Summary collapse

Methods inherited from Diecut::ReportBuilder

all_kinds, #build_report, #each_default, #each_option, #each_plugin, #each_template, #fail_advice, #fail_summary, #go, #initialize, #pass_advice, #pass_summary, register, #report, #review, #strict_sequence?, #unindent

Constructor Details

This class inherits a constructor from Diecut::ReportBuilder

Instance Method Details

#add(*args) ⇒ Object 



21
22
23
 
# File 'lib/diecut/report-builders/unused-default.rb', line 21

def add(*args)
  report.add(*args)
end

#collect ⇒ Object 



18
19
 
# File 'lib/diecut/report-builders/unused-default.rb', line 18

def collect
end

#other_advice ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/diecut/report-builders/unused-default.rb', line 29

def other_advice
  <<-EOA
  Plugins defined defaults for fields that don't appear in templates.

  It's possible that a plugin defined a default but it's template was
  overridden, so the fields disappeared. Diecut doesn't yet check for
  that case. In those cases, you can ignore this warning.

  The other possiblity is that the default path has a typo. This is
  especially likely if there's also a report about a missing output
  field.
  EOA
end

#other_summary ⇒ Object 



25
26
27
 
# File 'lib/diecut/report-builders/unused-default.rb', line 25

def other_summary
  "Defaults are defined for fields that don't exist in output templates"
end

#report_fields ⇒ Object 



10
11
12
 
# File 'lib/diecut/report-builders/unused-default.rb', line 10

def report_fields
  ["Output field name", "Plugin name"]
end

#report_name ⇒ Object 



6
7
8
 
# File 'lib/diecut/report-builders/unused-default.rb', line 6

def report_name
  "Defaults are declared but unused"
end

#report_status ⇒ Object 



14
15
16
 
# File 'lib/diecut/report-builders/unused-default.rb', line 14

def report_status
  report.empty? ? "OK" : "WARN"
end