Module: SimpleCov::Formatter

Defined in:
lib/simplecov/formatter.rb,
lib/simplecov/formatter/base.rb,
lib/simplecov/formatter/html_formatter.rb,
lib/simplecov/formatter/json_formatter.rb,
lib/simplecov/formatter/multi_formatter.rb,
lib/simplecov/formatter/simple_formatter.rb,
lib/simplecov/formatter/baseline_formatter.rb,
lib/simplecov/formatter/coverage_json_writer.rb,
lib/simplecov/formatter/json_formatter/errors_formatter.rb,
lib/simplecov/formatter/html_formatter/viewer_data_validator.rb,
lib/simplecov/formatter/json_formatter/result_hash_formatter.rb,
lib/simplecov/formatter/json_formatter/source_file_formatter.rb,
lib/simplecov/formatter/json_formatter/production_section_formatter.rb,
sig/simplecov.rbs,
sig/simplecov.rbs,
sig/simplecov.rbs,
sig/simplecov.rbs,
sig/simplecov.rbs,
sig/simplecov.rbs,
sig/simplecov.rbs,
sig/simplecov.rbs

Defined Under Namespace

Modules: CoverageJSONWriter, _Formatter Classes: Base, BaselineFormatter, HTMLFormatter, JSONFormatter, MultiFormatter, SimpleFormatter

Class Method Summary collapse

Class Method Details

.format(formatter, result) ⇒ Object

Parameters:

Returns:

  • (Object)


21
22
23
# File 'lib/simplecov/formatter.rb', line 21

def self.format(formatter, result)
  instance_for(formatter).format(result)
end

.instance_for(formatter) ⇒ Object

Formatters are configured either as classes, instantiated fresh for every report, or as ready-built instances, the only way to reach constructor options like HTMLFormatter.new(silent: true) (#1240).

Parameters:

  • formatter (Object)

Returns:

  • (Object)


8
9
10
# File 'lib/simplecov/formatter.rb', line 8

def self.instance_for(formatter)
  instantiable?(formatter) ? formatter.new : formatter
end