Class: SuppressionsPopulator

Inherits:

Object

• Object
• SuppressionsPopulator

Defined in:

lib/suppressions_populator.rb

Overview

Populates a string with the suppression xml, given a list of tokens

Constant Summary

HEADER =

<<~HEADER
  <?xml version="1.0"?>
  <!DOCTYPE suppressions PUBLIC "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
        "https://checkstyle.org/dtds/suppressions_1_2.dtd">

  <suppressions>
HEADER

FOOTER =

<<~FOOTER
  </suppressions>
FOOTER

Instance Method Summary

• #initialize(tokens) ⇒ SuppressionsPopulator constructor

  A new instance of SuppressionsPopulator.

• #populate ⇒ Object

Constructor Details

#initialize(tokens) ⇒ SuppressionsPopulator

Returns a new instance of SuppressionsPopulator.

# File 'lib/suppressions_populator.rb', line 17

def initialize(tokens)
  @tokens = tokens
end

Instance Method Details

#populate ⇒ Object

# File 'lib/suppressions_populator.rb', line 21

def populate
  "#{HEADER}\n#{@tokens.uniq do |token|
                  [token.file_name, token.offense]
                end.map(&:to_suppression).join("\n")}\n\n#{FOOTER}"
end