class Puppet::SyntaxCheckers::PP

Public Instance Methods

check(text, syntax, acceptor, source_pos) click to toggle source

Checks the text for Puppet Language syntax issues and reports them to the given acceptor.

Error messages from the checker are capped at 100 chars from the source text.

@param text [String] The text to check @param syntax [String] The syntax identifier in mime style (only accepts 'pp') @param acceptor [#accept] A Diagnostic acceptor @param source_pos [Puppet::Pops::Adapters::SourcePosAdapter] A source pos adapter with location information @api public

   # File lib/puppet/syntax_checkers/pp.rb
16 def check(text, syntax, acceptor, source_pos)
17   raise ArgumentError.new(_("PP syntax checker: the text to check must be a String.")) unless text.is_a?(String)
18   raise ArgumentError.new(_("PP syntax checker: the syntax identifier must be a String, e.g. pp")) unless syntax == 'pp'
19   raise ArgumentError.new(_("PP syntax checker: invalid Acceptor, got: '%{klass}'.") % { klass: acceptor.class.name }) unless acceptor.is_a?(Puppet::Pops::Validation::Acceptor)
20 
21   begin
22     Puppet::Pops::Parser::EvaluatingParser.singleton.parse_string(text)
23   rescue => e
24     # Cap the message to 100 chars and replace newlines
25     msg = _("PP syntax checker: \"%{message}\"") % { message: e.message().slice(0,500).gsub(/\r?\n/, "\\n") }
26 
27     # TODO: improve the pops API to allow simpler diagnostic creation while still maintaining capabilities
28     # and the issue code. (In this case especially, where there is only a single error message being issued).
29     #
30     issue = Puppet::Pops::Issues::issue(:ILLEGAL_PP) { msg }
31     acceptor.accept(Puppet::Pops::Validation::Diagnostic.new(:error, issue, source_pos.file, source_pos, {}))
32   end
33 end