Class: Puppet::Pops::Parser::EvaluatingParser

Inherits:
Object
  • Object
show all
Defined in:
lib/puppet/pops/parser/evaluating_parser.rb

Overview

Does not support “import” and parsing ruby files

Direct Known Subclasses

EvaluatingEppParser

Defined Under Namespace

Classes: EvaluatingEppParser

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ EvaluatingParser

Returns a new instance of EvaluatingParser.



8
9
10
 
# File 'lib/puppet/pops/parser/evaluating_parser.rb', line 8

def initialize()
  @parser = Puppet::Pops::Parser::Parser.new()
end

Instance Attribute Details

#parser ⇒ Object (readonly) 



6
7
8
 
# File 'lib/puppet/pops/parser/evaluating_parser.rb', line 6

def parser
  @parser
end

Class Method Details

.quote(x) ⇒ String

Translates an already parsed string that contains control characters, quotes and backslashes into a quoted string where all such constructs have been escaped. Parsing the return value of this method using the puppet parser should yield exactly the same string as the argument passed to this method

The method makes an exception for the two character sequences $ and s. They will not be escaped since they have a special meaning in puppet syntax.

TODO: Handle uXXXX characters ??

Parameters:

  • x (String) —

    The string to quote and “unparse”

Returns:

  • (String) —

    The quoted string



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/puppet/pops/parser/evaluating_parser.rb', line 110

def self.quote(x)
  escaped = '"'
  p = nil
  x.each_char do |c|
    case p
    when nil
      # do nothing
    when "\t"
      escaped << '\\t'
    when "\n"
      escaped << '\\n'
    when "\f"
      escaped << '\\f'
    # TODO: \cx is a range of characters - skip for now
    #      when "\c"
    #        escaped << '\\c'
    when '"'
      escaped << '\\"'
    when '\\'
      escaped << if c == '$' || c == 's'; p; else '\\\\'; end # don't escape \ when followed by s or $
    else
      escaped << p
    end
    p = c
  end
  escaped << p unless p.nil?
  escaped << '"'
end

Instance Method Details

#acceptor ⇒ Object 



73
74
75
 
# File 'lib/puppet/pops/parser/evaluating_parser.rb', line 73

def acceptor()
  Puppet::Pops::Validation::Acceptor.new
end

#assert_and_report(parse_result) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/puppet/pops/parser/evaluating_parser.rb', line 81

def assert_and_report(parse_result)
  return nil unless parse_result
  if parse_result.source_ref.nil? or parse_result.source_ref == ''
    parse_result.source_ref = @file_source
  end
  validation_result = validate(parse_result)

  Puppet::Pops::IssueReporter.assert_and_report(validation_result,
                                        :emit_warnings => true)
  parse_result
end

#clear ⇒ Object 



44
45
46
 
# File 'lib/puppet/pops/parser/evaluating_parser.rb', line 44

def clear()
  @acceptor = nil
end

#closure(model, scope) ⇒ Object

Create a closure that can be called in the given scope



49
50
51
 
# File 'lib/puppet/pops/parser/evaluating_parser.rb', line 49

def closure(model, scope)
  Puppet::Pops::Evaluator::Closure.new(evaluator, model, scope)
end

#convert_to_3x(object, scope) ⇒ Object 



63
64
65
 
# File 'lib/puppet/pops/parser/evaluating_parser.rb', line 63

def convert_to_3x(object, scope)
  val = @@evaluator.convert(object, scope, nil)
end

#evaluate(scope, model) ⇒ Object 



53
54
55
56
 
# File 'lib/puppet/pops/parser/evaluating_parser.rb', line 53

def evaluate(scope, model)
  return nil unless model
  evaluator.evaluate(model, scope)
end

#evaluate_file(file) ⇒ Object 



40
41
42
 
# File 'lib/puppet/pops/parser/evaluating_parser.rb', line 40

def evaluate_file(file)
  evaluate(parse_file(file))
end

#evaluate_string(scope, s, file_source = 'unknown') ⇒ Object 



36
37
38
 
# File 'lib/puppet/pops/parser/evaluating_parser.rb', line 36

def evaluate_string(scope, s, file_source='unknown')
  evaluate(scope, parse_string(s, file_source))
end

#evaluator ⇒ Object 



58
59
60
61
 
# File 'lib/puppet/pops/parser/evaluating_parser.rb', line 58

def evaluator
  @@evaluator ||= Puppet::Pops::Evaluator::EvaluatorImpl.new()
  @@evaluator
end

#parse_file(file) ⇒ Object 



30
31
32
33
34
 
# File 'lib/puppet/pops/parser/evaluating_parser.rb', line 30

def parse_file(file)
  @file_source = file
  clear()
  assert_and_report(parser.parse_file(file))
end

#parse_string(s, file_source = 'unknown') ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/puppet/pops/parser/evaluating_parser.rb', line 12

def parse_string(s, file_source = 'unknown')
  @file_source = file_source
  clear()
  # Handling of syntax error can be much improved (in general), now it bails out of the parser
  # and does not have as rich information (when parsing a string), need to update it with the file source
  # (ideally, a syntax error should be entered as an issue, and not just thrown - but that is a general problem
  # and an improvement that can be made in the eparser (rather than here).
  # Also a possible improvement (if the YAML parser returns positions) is to provide correct output of position.
  #
  begin
    assert_and_report(parser.parse_string(s))
  rescue Puppet::ParseError => e
    # TODO: This is not quite right, why does not the exception have the correct file?
    e.file = @file_source unless e.file.is_a?(String) && !e.file.empty?
    raise e
  end
end

#quote(x) ⇒ Object 



93
94
95
 
# File 'lib/puppet/pops/parser/evaluating_parser.rb', line 93

def quote(x)
  self.class.quote(x)
end

#validate(parse_result) ⇒ Object 



67
68
69
70
71
 
# File 'lib/puppet/pops/parser/evaluating_parser.rb', line 67

def validate(parse_result)
  resulting_acceptor = acceptor()
  validator(resulting_acceptor).validate(parse_result)
  resulting_acceptor
end

#validator(acceptor) ⇒ Object 



77
78
79
 
# File 'lib/puppet/pops/parser/evaluating_parser.rb', line 77

def validator(acceptor)
  Puppet::Pops::Validation::ValidatorFactory_4_0.new().validator(acceptor)
end