Class: Mago::Cli::Formatter

Inherits:

Object

• Object
• Mago::Cli::Formatter

Includes:

Colorize

Defined in:

lib/mago/cli/formatter.rb

Overview

Formats report to be printed

Direct Known Subclasses

SourceFormatter

Instance Method Summary

• #format ⇒ String

  Format report.

• #initialize(report, opts = {}) ⇒ Formatter constructor

  A new instance of Formatter.

Methods included from Colorize

#colorize, #green, #pink, #red, #yellow

Constructor Details

#initialize(report, opts = {}) ⇒ Formatter

Returns a new instance of Formatter.

Parameters:

• report (Mago::Report)
• opts (Hash) (defaults to: {})

Options Hash (opts):

• :color (Boolean) —

  whether colorize output or no

# File 'lib/mago/cli/formatter.rb', line 11

def initialize(report, opts = {})
  @report = report
  @color  = opts[:color]
end

Instance Method Details

#format ⇒ String

Format report.

Returns:

• (String) —

  formated report

# File 'lib/mago/cli/formatter.rb', line 19

def format
  out = ''

  @report.files.each do |file|
    format_file(file, out)
  end

  @report.errors.each do |error|
    format_error(error, out)
  end

  out
end