Module: Packwerk::OffensesFormatter Abstract

Included in:
Formatters::DefaultOffensesFormatter
Defined in:
lib/packwerk/offenses_formatter.rb

Overview

This module is abstract.

Defined Under Namespace

Classes: DuplicateFormatterError

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.all ⇒ Object

Signature:

  • -> Array[OffensesFormatter]



21
22
23
24
 
# File 'lib/packwerk/offenses_formatter.rb', line 21

def all
  load_defaults
  offenses_formatters.map(&:new) #: as Array[OffensesFormatter]
end

.find(identifier) ⇒ Object

Signature:

  • (String identifier) -> OffensesFormatter



27
28
29
 
# File 'lib/packwerk/offenses_formatter.rb', line 27

def find(identifier)
  formatter_by_identifier(identifier)
end

.included(base) ⇒ Object

Signature:

  • (Class[top] base) -> void



16
17
18
 
# File 'lib/packwerk/offenses_formatter.rb', line 16

def included(base)
  offenses_formatters << base
end

Instance Method Details

#identifier ⇒ Object

This method is abstract.

Signature:

  • -> String

Raises:

  • (NotImplementedError) 


72
 
# File 'lib/packwerk/offenses_formatter.rb', line 72

def identifier = raise NotImplementedError, "Abstract method called"

#show_offenses(offenses) ⇒ Object

This method is abstract.

Signature:

  • (Array[Offense?] offenses) -> String

Raises:

  • (NotImplementedError) 


64
 
# File 'lib/packwerk/offenses_formatter.rb', line 64

def show_offenses(offenses) = raise NotImplementedError, "Abstract method called"

#show_stale_violations(offense_collection, for_files) ⇒ Object

This method is abstract.

Signature:

  • (OffenseCollection offense_collection, Set[String] for_files) -> String

Raises:

  • (NotImplementedError) 


68
 
# File 'lib/packwerk/offenses_formatter.rb', line 68

def show_stale_violations(offense_collection, for_files) = raise NotImplementedError, "Abstract method called"

#show_strict_mode_violations(strict_mode_violations) ⇒ Object

This method is abstract.

Signature:

  • (Array[ReferenceOffense] strict_mode_violations) -> String

Raises:

  • (NotImplementedError) 


76
 
# File 'lib/packwerk/offenses_formatter.rb', line 76

def show_strict_mode_violations(strict_mode_violations) = raise NotImplementedError, "Abstract method called"