Class: Greener::Formatter::BaseFormatter

Inherits:
Object
  • Object
show all
Defined in:
lib/greener/formatter/base_formatter.rb

Overview

Abstract base class for formatter, implements all public API methods.

## Method Invocation Order

For example, when Greener inspects 2 files, the invocation order should be like this:

  • ‘#initialize`

  • ‘#started`

  • ‘#file_started`

  • ‘#file_finished`

  • ‘#file_started`

  • ‘#file_finished`

  • ‘#finished`

Direct Known Subclasses

Progress, SimpleText, Summary

Instance Method Summary collapse

Constructor Details

#initialize(files) ⇒ BaseFormatter

Returns a new instance of BaseFormatter.



18
19
20
 
# File 'lib/greener/formatter/base_formatter.rb', line 18

def initialize(files)
  @files = files
end

Instance Method Details

#file_finished(_violations) ⇒ Object 



28
29
 
# File 'lib/greener/formatter/base_formatter.rb', line 28

def file_finished(_violations)
end

#file_started ⇒ Object 



25
26
 
# File 'lib/greener/formatter/base_formatter.rb', line 25

def file_started
end

#finished(_violations) ⇒ Object 



31
32
 
# File 'lib/greener/formatter/base_formatter.rb', line 31

def finished(_violations)
end

#started ⇒ Object 



22
23
 
# File 'lib/greener/formatter/base_formatter.rb', line 22

def started
end