Class: Puppet::Pops::Types::TypeParser

Inherits:
Object
  • Object
show all
Defined in:
lib/puppet/pops/types/type_parser.rb

Overview

This class provides parsing of Type Specification from a string into the Type Model that is produced by the Puppet::Pops::Types::TypeFactory.

The Type Specifications that are parsed are the same as the stringified forms of types produced by the TypeCalculator.

Constant Summary collapse

TYPES =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

Puppet::Pops::Types::TypeFactory

Instance Method Summary collapse

Constructor Details

#initialize ⇒ TypeParser

Returns a new instance of TypeParser.



13
14
15
16
 
# File 'lib/puppet/pops/types/type_parser.rb', line 13

def initialize
  @parser = Puppet::Pops::Parser::Parser.new
  @type_transformer = Puppet::Pops::Visitor.new(nil, 'interpret', 0, 0)
end

Instance Method Details

#interpret(ast) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



47
48
49
50
51
52
 
# File 'lib/puppet/pops/types/type_parser.rb', line 47

def interpret(ast)
  result = @type_transformer.visit_this_0(self, ast)
  result = result.body if result.is_a?(Puppet::Pops::Model::Program)
  raise_invalid_type_specification_error unless result.is_a?(Puppet::Pops::Types::PAnyType)
  result
end

#interpret_AccessExpression(parameterized_ast) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/puppet/pops/types/type_parser.rb', line 203

def interpret_AccessExpression(parameterized_ast)
  parameters = parameterized_ast.keys.collect { |param| interpret_any(param) }

  unless parameterized_ast.left_expr.is_a?(Puppet::Pops::Model::QualifiedReference)
    raise_invalid_type_specification_error
  end

  case parameterized_ast.left_expr.value
  when 'array'
    case parameters.size
    when 1
    when 2
      size_type =
        if parameters[1].is_a?(Puppet::Pops::Types::PIntegerType)
          parameters[1]
        else
          assert_range_parameter(parameters[1])
          TYPES.range(parameters[1], :default)
        end
    when 3
      assert_range_parameter(parameters[1])
      assert_range_parameter(parameters[2])
      size_type = TYPES.range(parameters[1], parameters[2])
    else
      raise_invalid_parameters_error('Array', '1 to 3', parameters.size)
    end
    assert_type(parameters[0])
    TYPES.array_of(parameters[0], size_type)

  when 'hash'
    case parameters.size
    when 2
      assert_type(parameters[0])
      assert_type(parameters[1])
      TYPES.hash_of(parameters[1], parameters[0])
    when 3
      size_type =
        if parameters[2].is_a?(Puppet::Pops::Types::PIntegerType)
          parameters[2]
        else
          assert_range_parameter(parameters[2])
          TYPES.range(parameters[2], :default)
        end
      assert_type(parameters[0])
      assert_type(parameters[1])
      TYPES.hash_of(parameters[1], parameters[0], size_type)
    when 4
      assert_range_parameter(parameters[2])
      assert_range_parameter(parameters[3])
      assert_type(parameters[0])
      assert_type(parameters[1])
      TYPES.hash_of(parameters[1], parameters[0], TYPES.range(parameters[2], parameters[3]))
    else
      raise_invalid_parameters_error('Hash', '2 to 4', parameters.size)
    end

  when 'collection'
    size_type = case parameters.size
      when 1
        if parameters[0].is_a?(Puppet::Pops::Types::PIntegerType)
          parameters[0]
        else
          assert_range_parameter(parameters[0])
          TYPES.range(parameters[0], :default)
        end
      when 2
        assert_range_parameter(parameters[0])
        assert_range_parameter(parameters[1])
        TYPES.range(parameters[0], parameters[1])
      else
        raise_invalid_parameters_error('Collection', '1 to 2', parameters.size)
      end
    TYPES.collection(size_type)

  when 'class'
    if parameters.size != 1
      raise_invalid_parameters_error('Class', 1, parameters.size)
    end
    TYPES.host_class(parameters[0])

  when 'resource'
    if parameters.size == 1
      TYPES.resource(parameters[0])
    elsif parameters.size != 2
      raise_invalid_parameters_error('Resource', '1 or 2', parameters.size)
    else
      TYPES.resource(parameters[0], parameters[1])
    end

  when 'regexp'
    # 1 parameter being a string, or regular expression
    raise_invalid_parameters_error('Regexp', '1', parameters.size) unless parameters.size == 1
    TYPES.regexp(parameters[0])

  when 'enum'
    # 1..m parameters being strings
    raise_invalid_parameters_error('Enum', '1 or more', parameters.size) unless parameters.size >= 1
    TYPES.enum(*parameters)

  when 'pattern'
    # 1..m parameters being strings or regular expressions
    raise_invalid_parameters_error('Pattern', '1 or more', parameters.size) unless parameters.size >= 1
    TYPES.pattern(*parameters)

  when 'variant'
    # 1..m parameters being strings or regular expressions
    raise_invalid_parameters_error('Variant', '1 or more', parameters.size) unless parameters.size >= 1
    TYPES.variant(*parameters)

  when 'tuple'
    # 1..m parameters being types (last two optionally integer or literal default
    raise_invalid_parameters_error('Tuple', '1 or more', parameters.size) unless parameters.size >= 1
    length = parameters.size
    size_type = nil
    if TYPES.is_range_parameter?(parameters[-2])
      # min, max specification
      min = parameters[-2]
      min = (min == :default || min == 'default') ? 0 : min
      assert_range_parameter(parameters[-1])
      max = parameters[-1]
      max = max == :default ? nil : max
      parameters = parameters[0, length-2]
      size_type = TYPES.range(min, max)
    elsif TYPES.is_range_parameter?(parameters[-1])
      min = parameters[-1]
      min = (min == :default || min == 'default') ? 0 : min
      max = nil
      parameters = parameters[0, length-1]
      size_type = TYPES.range(min, max)
    end
    TYPES.tuple(parameters, size_type)

  when 'callable'
    # 1..m parameters being types (last three optionally integer or literal default, and a callable)
    TYPES.callable(*parameters)

  when 'struct'
    # 1..m parameters being types (last two optionally integer or literal default
    raise_invalid_parameters_error('Struct', '1', parameters.size) unless parameters.size == 1
    h = parameters[0]
    raise_invalid_type_specification_error unless h.is_a?(Hash)
    TYPES.struct(h)

  when 'integer'
    if parameters.size == 1
      case parameters[0]
      when Integer
        TYPES.range(parameters[0], :default)
      when :default
        TYPES.integer # unbound
      end
    elsif parameters.size != 2
      raise_invalid_parameters_error('Integer', '1 or 2', parameters.size)
   else
     TYPES.range(parameters[0] == :default ? nil : parameters[0], parameters[1] == :default ? nil : parameters[1])
   end

  when 'float'
    if parameters.size == 1
      case parameters[0]
      when Integer, Float
        TYPES.float_range(parameters[0], :default)
      when :default
        TYPES.float # unbound
      end
    elsif parameters.size != 2
      raise_invalid_parameters_error('Float', '1 or 2', parameters.size)
   else
     TYPES.float_range(parameters[0] == :default ? nil : parameters[0], parameters[1] == :default ? nil : parameters[1])
   end

  when 'string'
    size_type =
    case parameters.size
    when 1
      if parameters[0].is_a?(Puppet::Pops::Types::PIntegerType)
        parameters[0]
      else
        assert_range_parameter(parameters[0])
        TYPES.range(parameters[0], :default)
      end
    when 2
      assert_range_parameter(parameters[0])
      assert_range_parameter(parameters[1])
      TYPES.range(parameters[0], parameters[1])
    else
      raise_invalid_parameters_error('String', '1 to 2', parameters.size)
    end
    TYPES.string(size_type)

  when 'optional'
    if parameters.size != 1
      raise_invalid_parameters_error('Optional', 1, parameters.size)
    end
    param = parameters[0]
    assert_type(param) unless param.is_a?(String)
    TYPES.optional(param)

  when 'any', 'data', 'catalogentry', 'boolean', 'scalar', 'undef', 'numeric', 'default'
    raise_unparameterized_type_error(parameterized_ast.left_expr)

  when 'notundef'
    case parameters.size
    when 0
      TYPES.not_undef
    when 1
      param = parameters[0]
      assert_type(param) unless param.is_a?(String)
      TYPES.not_undef(param)
    else
      raise_invalid_parameters_error("NotUndef", "0 to 1", parameters.size)
    end

  when 'type'
    if parameters.size != 1
      raise_invalid_parameters_error('Type', 1, parameters.size)
    end
    assert_type(parameters[0])
    TYPES.type_type(parameters[0])

  when 'runtime'
    raise_invalid_parameters_error('Runtime', '2', parameters.size) unless parameters.size == 2
    TYPES.runtime(*parameters)

  else
    # It is a resource such a File['/tmp/foo']
    type_name = parameterized_ast.left_expr.value
    if parameters.size != 1
      raise_invalid_parameters_error(type_name.capitalize, 1, parameters.size)
    end
    TYPES.resource(type_name, parameters[0])
  end
end

#interpret_any(ast) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



55
56
57
 
# File 'lib/puppet/pops/types/type_parser.rb', line 55

def interpret_any(ast)
  @type_transformer.visit_this_0(self, ast)
end

#interpret_LiteralDefault(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



89
90
91
 
# File 'lib/puppet/pops/types/type_parser.rb', line 89

def interpret_LiteralDefault(o)
  :default
end

#interpret_LiteralFloat(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



99
100
101
 
# File 'lib/puppet/pops/types/type_parser.rb', line 99

def interpret_LiteralFloat(o)
  o.value
end

#interpret_LiteralHash(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



104
105
106
107
108
109
110
 
# File 'lib/puppet/pops/types/type_parser.rb', line 104

def interpret_LiteralHash(o)
  result = {}
  o.entries.each do |entry|
    result[@type_transformer.visit_this_0(self, entry.key)] = @type_transformer.visit_this_0(self, entry.value)
  end
  result
end

#interpret_LiteralInteger(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



94
95
96
 
# File 'lib/puppet/pops/types/type_parser.rb', line 94

def interpret_LiteralInteger(o)
  o.value
end

#interpret_LiteralRegularExpression(o) ⇒ Object 



79
80
81
 
# File 'lib/puppet/pops/types/type_parser.rb', line 79

def interpret_LiteralRegularExpression(o)
  o.value
end

#interpret_LiteralString(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



75
76
77
 
# File 'lib/puppet/pops/types/type_parser.rb', line 75

def interpret_LiteralString(o)
  o.value
end

#interpret_Object(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



60
61
62
 
# File 'lib/puppet/pops/types/type_parser.rb', line 60

def interpret_Object(o)
  raise_invalid_type_specification_error
end

#interpret_Program(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



65
66
67
 
# File 'lib/puppet/pops/types/type_parser.rb', line 65

def interpret_Program(o)
  interpret(o.body)
end

#interpret_QualifiedName(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



70
71
72
 
# File 'lib/puppet/pops/types/type_parser.rb', line 70

def interpret_QualifiedName(o)
  o.value
end

#interpret_QualifiedReference(name_ast) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/puppet/pops/types/type_parser.rb', line 113

def interpret_QualifiedReference(name_ast)
  case name_ast.value
  when 'integer'
    TYPES.integer

  when 'float'
    TYPES.float

  when 'numeric'
      TYPES.numeric

  when 'string'
    TYPES.string

  when 'enum'
    TYPES.enum

  when 'boolean'
    TYPES.boolean

  when 'pattern'
    TYPES.pattern

  when 'regexp'
    TYPES.regexp

  when 'data'
    TYPES.data

  when 'array'
    TYPES.array_of_data

  when 'hash'
    TYPES.hash_of_data

  when 'class'
    TYPES.host_class

  when 'resource'
    TYPES.resource

  when 'collection'
    TYPES.collection

  when 'scalar'
    TYPES.scalar

  when 'catalogentry'
    TYPES.catalog_entry

  when 'undef'
    TYPES.undef

  when 'notundef'
    TYPES.not_undef()

  when 'default'
    TYPES.default()
 
  when 'any'
    TYPES.any

  when 'variant'
    TYPES.variant

  when 'optional'
    TYPES.optional

  when 'runtime'
    TYPES.runtime

  when 'type'
    TYPES.type_type

  when 'tuple'
    TYPES.tuple

  when 'struct'
    TYPES.struct

  when 'callable'
    # A generic callable as opposed to one that does not accept arguments
    TYPES.all_callables

  else
    TYPES.resource(name_ast.value)
  end
end

#interpret_String(o) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



84
85
86
 
# File 'lib/puppet/pops/types/type_parser.rb', line 84

def interpret_String(o)
  o
end

#parse(string) ⇒ Puppet::Pops::Types::PAnyType

Produces a *puppet type* based on the given string.

Examples:

parser.parse('Integer')
parser.parse('Array[String]')
parser.parse('Hash[Integer, Array[String]]')

Parameters:

  • string (String) —

    a string with the type expressed in stringified form as produced by the TypeCalculator#string method.

Returns:



31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/puppet/pops/types/type_parser.rb', line 31

def parse(string)
  # TODO: This state (@string) can be removed since the parse result of newer future parser
  # contains a Locator in its SourcePosAdapter and the Locator keeps the string.
  # This way, there is no difference between a parsed "string" and something that has been parsed
  # earlier and fed to 'interpret'
  #
  @string = string
  model = @parser.parse_string(@string)
  if model
    interpret(model.current)
  else
    raise_invalid_type_specification_error
  end
end