Module: Reek::Report

Defined in:
lib/reek/report.rb,
lib/reek/report/xml_report.rb,
lib/reek/report/base_report.rb,
lib/reek/report/html_report.rb,
lib/reek/report/json_report.rb,
lib/reek/report/text_report.rb,
lib/reek/report/yaml_report.rb,
lib/reek/report/github_report.rb,
lib/reek/report/heading_formatter.rb,
lib/reek/report/location_formatter.rb,
lib/reek/report/progress_formatter.rb,
lib/reek/report/simple_warning_formatter.rb,
lib/reek/report/documentation_link_warning_formatter.rb

Defined Under Namespace

Modules: BlankLocationFormatter, DefaultLocationFormatter, ProgressFormatter, SingleLineLocationFormatter Classes: BaseReport, DocumentationLinkWarningFormatter, GithubReport, HTMLReport, HeadingFormatterBase, JSONReport, QuietHeadingFormatter, SimpleWarningFormatter, TextReport, VerboseHeadingFormatter, XMLReport, YAMLReport

Constant Summary collapse

REPORT_CLASSES = 
{
  yaml:   YAMLReport,
  json:   JSONReport,
  html:   HTMLReport,
  xml:    XMLReport,
  text:   TextReport,
  github: GithubReport
}.freeze
LOCATION_FORMATTERS = 
{
  single_line: SingleLineLocationFormatter,
  plain:       BlankLocationFormatter,
  numbers:     DefaultLocationFormatter
}.freeze
HEADING_FORMATTERS = 
{
  verbose: VerboseHeadingFormatter,
  quiet:   QuietHeadingFormatter
}.freeze
PROGRESS_FORMATTERS = 
{
  dots:  ProgressFormatter::Dots,
  quiet: ProgressFormatter::Quiet
}.freeze
WARNING_FORMATTER_CLASSES = 
{
  documentation_links: DocumentationLinkWarningFormatter,
  simple:              SimpleWarningFormatter
}.freeze

Class Method Summary collapse

Class Method Details

.heading_formatter(heading_format) ⇒ Object

Map heading format symbol to a report class.

Parameters:

  • heading_format (Symbol) —

    The format to map

Returns:

  • The mapped heading class



75
76
77
 
# File 'lib/reek/report.rb', line 75

def self.heading_formatter(heading_format)
  HEADING_FORMATTERS.fetch(heading_format)
end

.location_formatter(location_format) ⇒ Object

Map location format symbol to a report class.

Parameters:

  • location_format (Symbol) —

    The format to map

Returns:

  • The mapped location class



65
66
67
 
# File 'lib/reek/report.rb', line 65

def self.location_formatter(location_format)
  LOCATION_FORMATTERS.fetch(location_format)
end

.progress_formatter(progress_format) ⇒ Object

Map progress format symbol to a report class.

Parameters:

  • progress_format (Symbol) —

    The format to map

Returns:

  • The mapped progress class



85
86
87
 
# File 'lib/reek/report.rb', line 85

def self.progress_formatter(progress_format)
  PROGRESS_FORMATTERS.fetch(progress_format)
end

.report_class(report_format) ⇒ Object

Map report format symbol to a report class.

Parameters:

  • report_format (Symbol) —

    The format to map

Returns:

  • The mapped report class



55
56
57
 
# File 'lib/reek/report.rb', line 55

def self.report_class(report_format)
  REPORT_CLASSES.fetch(report_format)
end

.warning_formatter_class(warning_format) ⇒ Object

Map warning format symbol to a report class.

Parameters:

  • warning_format (Symbol) —

    The format to map

Returns:

  • The mapped warning class



95
96
97
 
# File 'lib/reek/report.rb', line 95

def self.warning_formatter_class(warning_format)
  WARNING_FORMATTER_CLASSES.fetch(warning_format)
end