Class: PuppetLint::CheckPlugin

Inherits:
Object
  • Object
show all
Defined in:
lib/puppet-lint/checkplugin.rb

Overview

Public: A class that contains and provides information for the puppet-lint checks.

This class should not be used directly, but instead should be inherited.

Examples

class PuppetLint::Plugin::CheckFoo < PuppetLint::CheckPlugin
end

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CheckPlugin

Internal: Initialise a new PuppetLint::CheckPlugin.



12
13
14
 
# File 'lib/puppet-lint/checkplugin.rb', line 12

def initialize
  @problems = []
end

Instance Method Details

#fix_problems ⇒ Object

Internal: Fix any problems the check plugin has detected.

Returns an Array of problem Hashes.



37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/puppet-lint/checkplugin.rb', line 37

def fix_problems
  @problems.reject { |problem| problem[:kind] == :ignored || problem[:check] == :syntax }.each do |problem|
    next unless respond_to?(:fix)

    begin
      fix(problem)
      problem[:kind] = :fixed
    rescue PuppetLint::NoFix # rubocop:disable Lint/HandleExceptions
      # noop
    end
  end

  @problems
end

#run ⇒ Object

Internal: Check the manifest for problems and filter out any problems that should be ignored.

Returns an Array of problem Hashes.



20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/puppet-lint/checkplugin.rb', line 20

def run
  check

  @problems.each do |problem|
    next if problem[:check] == :syntax
    next unless PuppetLint::Data.ignore_overrides[problem[:check]].key?(problem[:line])

    problem[:kind] = :ignored
    problem[:reason] = PuppetLint::Data.ignore_overrides[problem[:check]][problem[:line]]
  end

  @problems
end