class Puppet::Pops::Validation::DiagnosticProducer

A producer of diagnostics. An producer of diagnostics is given each issue occurrence as they are found by a diagnostician/validator. It then produces a Diagnostic, which it passes on to a configured Acceptor.

This class exists to aid a diagnostician/validator which will typically first check if a particular issue will be accepted at all (before checking for an occurrence of the issue; i.e. to perform check avoidance for expensive checks). A validator passes an instance of Issue, the semantic object (the “culprit”), a hash with arguments, and an optional exception. The semantic object is used to determine the location of the occurrence of the issue (file/line), and it sets keys in the given argument hash that may be used in the formatting of the issue message.

Attributes

label_provider[R]

A producer of labels for objects involved in the issue @return [LabelProvider]

severity_producer[R]

A producer of severity for a given issue @return [SeverityProducer]

Public Instance Methods

accept(issue, semantic, arguments={}, except=nil) click to toggle source

# File lib/puppet/pops/validation.rb, line 191
def accept(issue, semantic, arguments={}, except=nil)
  return unless will_accept? issue

  # Set label provider unless caller provided a special label provider
  arguments[:label]    ||= @label_provider
  arguments[:semantic] ||= semantic

  # A detail message is always provided, but is blank by default.
  # TODO: this support is questionable, it requires knowledge that :detail is special
  arguments[:detail] ||= ''

  source_pos = Puppet::Pops::Utils.find_closest_positioned(semantic)
  file = source_pos ? source_pos.locator.file : nil

  severity = @severity_producer.severity(issue)
  @acceptor.accept(Diagnostic.new(severity, issue, file, source_pos, arguments, except))
end

will_accept?(issue) click to toggle source

# File lib/puppet/pops/validation.rb, line 209
def will_accept? issue
  @severity_producer.should_report? issue
end

Public Class Methods

new(acceptor, severity_producer, label_provider) click to toggle source

Initializes this producer.

@param acceptor [Acceptor] a sink/collector of diagnostic results @param #severity_producer [SeverityProducer] the severity producer to use to determine severity of a given issue @param #label_provider [LabelProvider] a provider of model element type to human readable label

# File lib/puppet/pops/validation.rb, line 185
def initialize(acceptor, severity_producer, label_provider)
  @acceptor           = acceptor
  @severity_producer  = severity_producer
  @label_provider     = label_provider
end