Class: Puppet::Pops::Validation::Checker4_0 Private

Inherits:
Evaluator::LiteralEvaluator show all
Defined in:
lib/puppet/pops/validation/checker4_0.rb

Overview

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

This is however mostly valuable when validating model to model transformations, and is therefore T.B.D

Constant Summary collapse

RESERVED_TYPE_NAMES =

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.

{
  'type' => true,
  'any' => true,
  'unit' => true,
  'scalar' => true,
  'boolean' => true,
  'numeric' => true,
  'integer' => true,
  'float' => true,
  'collection' => true,
  'array' => true,
  'hash' => true,
  'tuple' => true,
  'struct' => true,
  'variant' => true,
  'optional' => true,
  'enum' => true,
  'regexp' => true,
  'pattern' => true,
  'runtime' => true,
}
FUTURE_RESERVED_WORDS =

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.

{
  'application' => true,
  'produces' => true,
  'consumes' => true
}
RESERVED_PARAMETERS =

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.

{
  'name' => true,
  'title' => true,
}

Constants inherited from Evaluator::LiteralEvaluator

Evaluator::LiteralEvaluator::COMMA_SEPARATOR

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Evaluator::LiteralEvaluator

#literal, #literal_ConcatenatedString, #literal_Factory, #literal_LiteralBoolean, #literal_LiteralDefault, #literal_LiteralHash, #literal_LiteralList, #literal_LiteralNumber, #literal_LiteralRegularExpression, #literal_LiteralString, #literal_LiteralUndef, #literal_Object, #literal_Program, #literal_QualifiedName

Constructor Details

#initialize(diagnostics_producer) ⇒ Checker4_0

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.

Initializes the validator with a diagnostics producer. This object must respond to ‘:will_accept?` and `:accept`.



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# File 'lib/puppet/pops/validation/checker4_0.rb', line 21

def initialize(diagnostics_producer)
  super()
  @@check_visitor       ||= Visitor.new(nil, "check", 0, 0)
  @@rvalue_visitor      ||= Visitor.new(nil, "rvalue", 0, 0)
  @@hostname_visitor    ||= Visitor.new(nil, "hostname", 1, 2)
  @@assignment_visitor  ||= Visitor.new(nil, "assign", 0, 1)
  @@query_visitor       ||= Visitor.new(nil, "query", 0, 0)
  @@top_visitor         ||= Visitor.new(nil, "top", 1, 1)
  @@relation_visitor    ||= Visitor.new(nil, "relation", 0, 0)
  @@idem_visitor        ||= Visitor.new(self, "idem", 0, 0)

  @acceptor = diagnostics_producer

  # Use null migration checker unless given in context
  @migration_checker = (Puppet.lookup(:migration_checker) { Migration::MigrationChecker.new() })
end

Instance Attribute Details

#acceptorObject (readonly)

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.



15
16
17
# File 'lib/puppet/pops/validation/checker4_0.rb', line 15

def acceptor
  @acceptor
end

#migration_checkerObject (readonly)

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.



16
17
18
# File 'lib/puppet/pops/validation/checker4_0.rb', line 16

def migration_checker
  @migration_checker
end

Instance Method Details

#assign(o, via_index = false) ⇒ 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.

Checks the LHS of an assignment (is it assignable?). If args is true, assignment via index is checked.



82
83
84
# File 'lib/puppet/pops/validation/checker4_0.rb', line 82

def assign(o, via_index = false)
  @@assignment_visitor.visit_this_1(self, o, via_index)
end

#assign_AccessExpression(o, via_index) ⇒ 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.



123
124
125
126
127
128
129
130
131
# File 'lib/puppet/pops/validation/checker4_0.rb', line 123

def assign_AccessExpression(o, via_index)
  # Are indexed assignments allowed at all ? $x[x] = '...'
  if acceptor.will_accept? Issues::ILLEGAL_INDEXED_ASSIGNMENT
    acceptor.accept(Issues::ILLEGAL_INDEXED_ASSIGNMENT, o)
  else
    # Then the left expression must be assignable-via-index
    assign(o.left_expr, true)
  end
end

#assign_LiteralList(o, via_index) ⇒ 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.



133
134
135
# File 'lib/puppet/pops/validation/checker4_0.rb', line 133

def assign_LiteralList(o, via_index)
  o.values.each {|x| assign(x) }
end

#assign_Object(o, via_index) ⇒ 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.



137
138
139
140
141
142
# File 'lib/puppet/pops/validation/checker4_0.rb', line 137

def assign_Object(o, via_index)
  # Can not assign to anything else (differentiate if this is via index or not)
  # i.e. 10 = 'hello' vs. 10['x'] = 'hello' (the root is reported as being in error in both cases)
  #
  acceptor.accept(via_index ? Issues::ILLEGAL_ASSIGNMENT_VIA_INDEX : Issues::ILLEGAL_ASSIGNMENT, o)
end

#assign_VariableExpression(o, via_index) ⇒ 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.

—ASSIGNMENT CHECKS



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'lib/puppet/pops/validation/checker4_0.rb', line 107

def assign_VariableExpression(o, via_index)
  varname_string = varname_to_s(o.expr)
  if varname_string =~ Patterns::NUMERIC_VAR_NAME
    acceptor.accept(Issues::ILLEGAL_NUMERIC_ASSIGNMENT, o, :varname => varname_string)
  end
  # Can not assign to something in another namespace (i.e. a '::' in the name is not legal)
  if acceptor.will_accept? Issues::CROSS_SCOPE_ASSIGNMENT
    if varname_string =~ /::/
      acceptor.accept(Issues::CROSS_SCOPE_ASSIGNMENT, o, :name => varname_string)
    end
  end

  # TODO: Could scan for reassignment of the same variable if done earlier in the same container
  #       Or if assigning to a parameter (more work).
end

#check(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.

Performs regular validity check



49
50
51
# File 'lib/puppet/pops/validation/checker4_0.rb', line 49

def check(o)
  @@check_visitor.visit_this_0(self, o)
end

#check_AccessExpression(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.



153
154
155
156
157
158
159
# File 'lib/puppet/pops/validation/checker4_0.rb', line 153

def check_AccessExpression(o)
  # Only min range is checked, all other checks are RT checks as they depend on the resulting type
  # of the LHS.
  if o.keys.size < 1
    acceptor.accept(Issues::MISSING_INDEX, o)
  end
end

#check_AssignmentExpression(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.



161
162
163
164
165
166
167
168
169
170
171
# File 'lib/puppet/pops/validation/checker4_0.rb', line 161

def check_AssignmentExpression(o)
  case o.operator
  when :'='
    assign(o.left_expr)
    rvalue(o.right_expr)
  when :'+=', :'-='
    acceptor.accept(Issues::APPENDS_DELETES_NO_LONGER_SUPPORTED, o, {:operator => o.operator})
  else
    acceptor.accept(Issues::UNSUPPORTED_OPERATOR, o, {:operator => o.operator})
  end
end

#check_AttributeOperation(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.

Checks that operation with :+> is contained in a ResourceOverride or Collector.

Parent of an AttributeOperation can be one of:

  • CollectExpression

  • ResourceOverride

  • ResourceBody (ILLEGAL this is a regular resource expression)

  • ResourceDefaults (ILLEGAL)



181
182
183
184
185
186
187
188
189
190
# File 'lib/puppet/pops/validation/checker4_0.rb', line 181

def check_AttributeOperation(o)
  if o.operator == :'+>'
    # Append operator use is constrained
    parent = o.eContainer
    unless parent.is_a?(Model::CollectExpression) || parent.is_a?(Model::ResourceOverrideExpression)
      acceptor.accept(Issues::ILLEGAL_ATTRIBUTE_APPEND, o, {:name=>o.attribute_name, :parent=>parent})
    end
  end
  rvalue(o.value_expr)
end

#check_AttributesOperation(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.



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
# File 'lib/puppet/pops/validation/checker4_0.rb', line 192

def check_AttributesOperation(o)
  # Append operator use is constrained
  parent1 = o.eContainer
  case parent1
  when Model::AbstractResource
  when Model::CollectExpression
  when Model::CapabilityMapping
    acceptor.accept(Issues::UNSUPPORTED_OPERATOR_IN_CONTEXT, parent1, :operator=>'* =>')
  else
    # protect against just testing a snippet that has no parent, error message will be a bit strange
    # but it is not for a real program.
    parent2 = parent1.nil? ? o : parent1.eContainer
    unless parent2.is_a?(Model::AbstractResource)
      acceptor.accept(Issues::UNSUPPORTED_OPERATOR_IN_CONTEXT, parent2, :operator=>'* =>')
    end
  end
  rvalue(o.expr)
end

#check_BinaryExpression(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.



211
212
213
214
# File 'lib/puppet/pops/validation/checker4_0.rb', line 211

def check_BinaryExpression(o)
  rvalue(o.left_expr)
  rvalue(o.right_expr)
end

#check_BlockExpression(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.



225
226
227
228
229
230
231
232
233
234
235
236
# File 'lib/puppet/pops/validation/checker4_0.rb', line 225

def check_BlockExpression(o)
  if resource_without_title?(o)
    acceptor.accept(Issues::RESOURCE_WITHOUT_TITLE, o, :name => o.statements[0].value)
  else
    o.statements[0..-2].each do |statement|
      if idem(statement)
        acceptor.accept(Issues::IDEM_EXPRESSION_NOT_LAST, statement)
        break # only flag the first
      end
    end
  end
end

#check_CallNamedFunctionExpression(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.



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
# File 'lib/puppet/pops/validation/checker4_0.rb', line 238

def check_CallNamedFunctionExpression(o)
  functor = o.functor_expr
  if functor.is_a?(Model::QualifiedReference) || 
    functor.is_a?(Model::AccessExpression) && functor.left_expr.is_a?(Model::QualifiedReference)
    # ok (a call to a type)
    return nil
  end
  case functor
  when Model::QualifiedName
    # ok
    nil
  when Model::RenderStringExpression
    # helpful to point out this easy to make Epp error
    acceptor.accept(Issues::ILLEGAL_EPP_PARAMETERS, o)
  else
    acceptor.accept(Issues::ILLEGAL_EXPRESSION, o.functor_expr, {:feature=>'function name', :container => o})
  end
end

#check_CapabilityMapping(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.



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
# File 'lib/puppet/pops/validation/checker4_0.rb', line 257

def check_CapabilityMapping(o)
  ok =
  case o.component
  when Model::QualifiedName
    name = o.component.value
    acceptor.accept(Issues::ILLEGAL_CLASSREF, o.component, {:name=>name}) unless name =~ Patterns::CLASSREF_EXT
    true
  when Model::AccessExpression
    keys = o.component.keys
    expr = o.component.left_expr
    if expr.is_a?(Model::QualifiedReference) && keys.size == 1
      key = keys[0]
      key.is_a?(Model::LiteralString) || key.is_a?(Model::QualifiedName) || key.is_a?(Model::QualifiedReference)
    else
      false
    end
  else
    false
  end
  acceptor.accept(Issues::ILLEGAL_EXPRESSION, o.component, :feature=>'capability mapping', :container => o) unless ok

  if o.capability !~ Patterns::CLASSREF_EXT
    acceptor.accept(Issues::ILLEGAL_CLASSREF, o, {:name=>o.capability})
  end
end

#check_CaseExpression(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.



296
297
298
299
300
# File 'lib/puppet/pops/validation/checker4_0.rb', line 296

def check_CaseExpression(o)
  rvalue(o.test)
  # There should only be one LiteralDefault case option value
  # TODO: Implement this check
end

#check_CaseOption(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.



302
303
304
# File 'lib/puppet/pops/validation/checker4_0.rb', line 302

def check_CaseOption(o)
  o.values.each { |v| rvalue(v) }
end

#check_CollectExpression(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.



306
307
308
309
310
# File 'lib/puppet/pops/validation/checker4_0.rb', line 306

def check_CollectExpression(o)
  unless o.type_expr.is_a? Model::QualifiedReference
    acceptor.accept(Issues::ILLEGAL_EXPRESSION, o.type_expr, :feature=> 'type name', :container => o)
  end
end

#check_EppExpression(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.



283
284
285
286
287
288
# File 'lib/puppet/pops/validation/checker4_0.rb', line 283

def check_EppExpression(o)
  if o.eContainer.is_a?(Model::LambdaExpression)
    internal_check_no_capture(o.eContainer, o)
    internal_check_parameter_name_uniqueness(o.eContainer)
  end
end

#check_Factory(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.



149
150
151
# File 'lib/puppet/pops/validation/checker4_0.rb', line 149

def check_Factory(o)
  check(o.current)
end

#check_FunctionDefinition(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.



419
420
421
422
423
# File 'lib/puppet/pops/validation/checker4_0.rb', line 419

def check_FunctionDefinition(o)
  check_NamedDefinition(o)
  internal_check_return_type(o)
  internal_check_parameter_name_uniqueness(o)
end

#check_HostClassDefinition(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.



425
426
427
428
429
430
431
# File 'lib/puppet/pops/validation/checker4_0.rb', line 425

def check_HostClassDefinition(o)
  check_NamedDefinition(o)
  internal_check_no_capture(o)
  internal_check_parameter_name_uniqueness(o)
  internal_check_reserved_params(o)
  internal_check_no_idem_last(o)
end

#check_IfExpression(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.



511
512
513
# File 'lib/puppet/pops/validation/checker4_0.rb', line 511

def check_IfExpression(o)
  rvalue(o.test)
end

#check_KeyedEntry(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.



515
516
517
518
519
520
# File 'lib/puppet/pops/validation/checker4_0.rb', line 515

def check_KeyedEntry(o)
  rvalue(o.key)
  rvalue(o.value)
  # In case there are additional things to forbid than non-rvalues
  # acceptor.accept(Issues::ILLEGAL_EXPRESSION, o.key, :feature => 'hash key', :container => o.eContainer)
end

#check_LambdaExpression(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.



522
523
524
525
# File 'lib/puppet/pops/validation/checker4_0.rb', line 522

def check_LambdaExpression(o)
  internal_check_capture_last(o)
  internal_check_return_type(o)
end

#check_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.



531
532
533
534
535
536
537
538
539
540
# File 'lib/puppet/pops/validation/checker4_0.rb', line 531

def check_LiteralHash(o)
  # the keys of a literal hash may be non-literal expressions. They cannot be checked.
  unique = Set.new
  o.entries.each do |entry|
    catch(:not_literal) do
      literal_key = literal(entry.key)
      acceptor.accept(Issues::DUPLICATE_KEY, entry, {:key => literal_key}) if unique.add?(literal_key).nil?
    end
  end
end

#check_LiteralList(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.



527
528
529
# File 'lib/puppet/pops/validation/checker4_0.rb', line 527

def check_LiteralList(o)
  o.values.each {|v| rvalue(v) }
end

#check_MethodCallExpression(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.



290
291
292
293
294
# File 'lib/puppet/pops/validation/checker4_0.rb', line 290

def check_MethodCallExpression(o)
  unless o.functor_expr.is_a? Model::QualifiedName
    acceptor.accept(Issues::ILLEGAL_EXPRESSION, o.functor_expr, :feature => 'function name', :container => o)
  end
end

#check_NamedAccessExpression(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.

Only used for function names, grammar should not be able to produce something faulty, but check anyway if model is created programmatically (it will fail in transformation to AST for sure).



314
315
316
317
318
319
# File 'lib/puppet/pops/validation/checker4_0.rb', line 314

def check_NamedAccessExpression(o)
  name = o.right_expr
  unless name.is_a? Model::QualifiedName
    acceptor.accept(Issues::ILLEGAL_EXPRESSION, name, :feature=> 'function name', :container => o.eContainer)
  end
end

#check_NamedDefinition(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.

for ‘class’, ‘define’, and function



350
351
352
353
354
355
356
357
# File 'lib/puppet/pops/validation/checker4_0.rb', line 350

def check_NamedDefinition(o)
  top(o.eContainer, o)
  if o.name !~ Patterns::CLASSREF_DECL
    acceptor.accept(Issues::ILLEGAL_DEFINITION_NAME, o, {:name=>o.name})
  end
  internal_check_reserved_type_name(o, o.name)
  internal_check_future_reserved_word(o, o.name)
end

#check_NodeDefinition(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.



542
543
544
545
546
547
548
549
550
551
552
# File 'lib/puppet/pops/validation/checker4_0.rb', line 542

def check_NodeDefinition(o)
  # Check that hostnames are valid hostnames (or regular expressions)
  hostname(o.host_matches, o)
  top(o.eContainer, o)
  if violator = ends_with_idem(o.body)
    acceptor.accept(Issues::IDEM_NOT_ALLOWED_LAST, violator, {:container => o}) unless resource_without_title?(violator)
  end
  unless o.parent.nil?
    acceptor.accept(Issues::ILLEGAL_NODE_INHERITANCE, o.parent)
  end
end

#check_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.

—CHECKS



146
147
# File 'lib/puppet/pops/validation/checker4_0.rb', line 146

def check_Object(o)
end

#check_Parameter(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.



583
584
585
586
587
588
589
590
591
592
593
594
# File 'lib/puppet/pops/validation/checker4_0.rb', line 583

def check_Parameter(o)
  if o.name =~ /^(?:0x)?[0-9]+$/
    acceptor.accept(Issues::ILLEGAL_NUMERIC_PARAMETER, o, :name => o.name)
  end

  unless o.name =~ Patterns::PARAM_NAME
    acceptor.accept(Issues::ILLEGAL_PARAM_NAME, o, :name => o.name)
  end
  return unless o.value

  internal_check_illegal_assignment(o.value)
end

#check_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.

No checking takes place - all expressions using a QualifiedName need to check. This because the rules are slightly different depending on the container (A variable allows a numeric start, but not other names). This means that (if the lexer/parser so chooses) a QualifiedName can be anything when it represents a Bare Word and evaluates to a String.



559
560
# File 'lib/puppet/pops/validation/checker4_0.rb', line 559

def check_QualifiedName(o)
end

#check_QualifiedReference(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.

Checks that the value is a valid UpperCaseWord (a CLASSREF), and optionally if it contains a hypen. DOH: QualifiedReferences are created with LOWER CASE NAMES at parse time



564
565
566
567
568
569
# File 'lib/puppet/pops/validation/checker4_0.rb', line 564

def check_QualifiedReference(o)
  # Is this a valid qualified name?
  if o.cased_value !~ Patterns::CLASSREF_EXT
    acceptor.accept(Issues::ILLEGAL_CLASSREF, o, {:name=>o.cased_value})
  end
end

#check_QueryExpression(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.



571
572
573
# File 'lib/puppet/pops/validation/checker4_0.rb', line 571

def check_QueryExpression(o)
  query(o.expr) if o.expr  # is optional
end

#check_RelationshipExpression(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.

relationship_side: resource

| resourceref
| collection
| variable
| quotedtext
| selector
| casestatement
| hasharrayaccesses


615
616
617
618
# File 'lib/puppet/pops/validation/checker4_0.rb', line 615

def check_RelationshipExpression(o)
  relation(o.left_expr)
  relation(o.right_expr)
end

#check_ReservedWord(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.



652
653
654
655
656
657
658
# File 'lib/puppet/pops/validation/checker4_0.rb', line 652

def check_ReservedWord(o)
  if o.future
    acceptor.accept(Issues::FUTURE_RESERVED_WORD, o, :word => o.word)
  else
    acceptor.accept(Issues::RESERVED_WORD, o, :word => o.word)
  end
end

#check_ResourceBody(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.



627
628
629
630
631
632
633
634
635
636
637
638
# File 'lib/puppet/pops/validation/checker4_0.rb', line 627

def check_ResourceBody(o)
  seenUnfolding = false
  o.operations.each do |ao|
    if ao.is_a?(Model::AttributesOperation)
      if seenUnfolding
        acceptor.accept(Issues::MULTIPLE_ATTRIBUTES_UNFOLD, ao)
      else
        seenUnfolding = true
      end
    end
  end
end

#check_ResourceDefaultsExpression(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.



640
641
642
643
644
# File 'lib/puppet/pops/validation/checker4_0.rb', line 640

def check_ResourceDefaultsExpression(o)
  if o.form && o.form != :regular
    acceptor.accept(Issues::NOT_VIRTUALIZEABLE, o)
  end
end

#check_ResourceExpression(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.



620
621
622
623
624
625
# File 'lib/puppet/pops/validation/checker4_0.rb', line 620

def check_ResourceExpression(o)
  # The expression for type name cannot be statically checked - this is instead done at runtime
  # to enable better error message of the result of the expression rather than the static instruction.
  # (This can be revised as there are static constructs that are illegal, but require updating many
  # tests that expect the detailed reporting).
end

#check_ResourceOverrideExpression(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.



646
647
648
649
650
# File 'lib/puppet/pops/validation/checker4_0.rb', line 646

def check_ResourceOverrideExpression(o)
  if o.form && o.form != :regular
    acceptor.accept(Issues::NOT_VIRTUALIZEABLE, o)
  end
end

#check_ResourceTypeDefinition(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.



433
434
435
436
437
438
439
# File 'lib/puppet/pops/validation/checker4_0.rb', line 433

def check_ResourceTypeDefinition(o)
  check_NamedDefinition(o)
  internal_check_no_capture(o)
  internal_check_parameter_name_uniqueness(o)
  internal_check_reserved_params(o)
  internal_check_no_idem_last(o)
end

#check_SelectorEntry(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.



664
665
666
# File 'lib/puppet/pops/validation/checker4_0.rb', line 664

def check_SelectorEntry(o)
  rvalue(o.matching_expr)
end

#check_SelectorExpression(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.



660
661
662
# File 'lib/puppet/pops/validation/checker4_0.rb', line 660

def check_SelectorExpression(o)
  rvalue(o.left_expr)
end

#check_TypeAlias(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.



359
360
361
362
363
364
365
366
# File 'lib/puppet/pops/validation/checker4_0.rb', line 359

def check_TypeAlias(o)
  top(o.eContainer, o)
  if o.name !~ Patterns::CLASSREF_EXT_DECL
    acceptor.accept(Issues::ILLEGAL_DEFINITION_NAME, o, {:name=>o.name})
  end
  internal_check_reserved_type_name(o, o.name)
  internal_check_type_ref(o, o.type_expr)
end

#check_TypeDefinition(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.



412
413
414
415
416
417
# File 'lib/puppet/pops/validation/checker4_0.rb', line 412

def check_TypeDefinition(o)
  top(o.eContainer, o)
  internal_check_reserved_type_name(o, o.name)
  # TODO: Check TypeDefinition body. For now, just error out
  acceptor.accept(Issues::UNSUPPORTED_EXPRESSION, o)
end

#check_TypeMapping(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.



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
# File 'lib/puppet/pops/validation/checker4_0.rb', line 368

def check_TypeMapping(o)
  top(o.eContainer, o)
  lhs = o.type_expr
  lhs_type = 0 # Not Runtime
  if lhs.is_a?(Model::AccessExpression)
    left = lhs.left_expr
    if left.is_a?(Model::QualifiedReference) && left.cased_value == 'Runtime'
      lhs_type = 1 # Runtime
      keys = lhs.keys

      # Must be a literal string or pattern replacement
      lhs_type = 2 if keys.size == 2 && pattern_with_replacement?(keys[1])
    end
  end

  if lhs_type == 0
    # This is not a TypeMapping. Something other than Runtime[] on LHS
    acceptor.accept(Issues::UNSUPPORTED_EXPRESSION, o)
  else
    rhs = o.mapping_expr
    if pattern_with_replacement?(rhs)
      acceptor.accept(Issues::ILLEGAL_SINGLE_TYPE_MAPPING, o) if lhs_type == 1
    elsif type_ref?(rhs)
      acceptor.accept(Issues::ILLEGAL_REGEXP_TYPE_MAPPING, o) if lhs_type == 2
    else
      acceptor.accept(lhs_type == 1 ? Issues::ILLEGAL_SINGLE_TYPE_MAPPING : Issues::ILLEGAL_REGEXP_TYPE_MAPPING, o)
    end
  end
end

#check_UnaryExpression(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.



668
669
670
# File 'lib/puppet/pops/validation/checker4_0.rb', line 668

def check_UnaryExpression(o)
  rvalue(o.expr)
end

#check_UnlessExpression(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.



672
673
674
675
# File 'lib/puppet/pops/validation/checker4_0.rb', line 672

def check_UnlessExpression(o)
  rvalue(o.test)
  # TODO: Unless may not have an else part that is an IfExpression (grammar denies this though)
end

#check_VariableExpression(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.

Checks that variable is either strictly 0, or a non 0 starting decimal number, or a valid VAR_NAME



678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
# File 'lib/puppet/pops/validation/checker4_0.rb', line 678

def check_VariableExpression(o)
  # The expression must be a qualified name or an integer
  name_expr = o.expr
  return if name_expr.is_a?(Model::LiteralInteger)
  if !name_expr.is_a?(Model::QualifiedName)
    acceptor.accept(Issues::ILLEGAL_EXPRESSION, o, :feature => 'name', :container => o)
  else
    # name must be either a decimal string value, or a valid NAME
    name = o.expr.value
    if name[0,1] =~ /[0-9]/
      unless name =~ Patterns::NUMERIC_VAR_NAME
        acceptor.accept(Issues::ILLEGAL_NUMERIC_VAR_NAME, o, :name => name)
      end
    else
      unless name =~ Patterns::VAR_NAME
        acceptor.accept(Issues::ILLEGAL_VAR_NAME, o, :name => name)
      end
    end
  end
end

#ends_with_idem(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.

Returns the last expression in a block, or the expression, if that expression is idem



96
97
98
99
100
101
102
103
# File 'lib/puppet/pops/validation/checker4_0.rb', line 96

def ends_with_idem(o)
  if o.is_a?(Model::BlockExpression)
    last = o.statements[-1]
    idem(last) ? last : nil
  else
    idem(o) ? o : nil
  end
end

#hostname(o, semantic) ⇒ 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.

Performs check if this is a vaid hostname expression

Parameters:

  • single_feature_name (String, nil)

    the name of a single valued hostname feature of the value’s container. e.g. ‘parent’



55
56
57
# File 'lib/puppet/pops/validation/checker4_0.rb', line 55

def hostname(o, semantic)
  @@hostname_visitor.visit_this_1(self, o, semantic)
end

#hostname_Array(o, semantic) ⇒ 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.

Transforms Array of host matching expressions into a (Ruby) array of AST::HostName



702
703
704
# File 'lib/puppet/pops/validation/checker4_0.rb', line 702

def hostname_Array(o, semantic)
  o.each {|x| hostname(x, semantic) }
end

#hostname_ConcatenatedString(o, semantic) ⇒ 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.



720
721
722
723
724
725
726
727
728
729
730
731
732
# File 'lib/puppet/pops/validation/checker4_0.rb', line 720

def hostname_ConcatenatedString(o, semantic)
  # Puppet 3.1. only accepts a concatenated string without interpolated expressions
  if the_expr = o.segments.index {|s| s.is_a?(Model::TextExpression) }
    acceptor.accept(Issues::ILLEGAL_HOSTNAME_INTERPOLATION, o.segments[the_expr].expr)
  elsif o.segments.size() != 1
    # corner case, bad model, concatenation of several plain strings
    acceptor.accept(Issues::ILLEGAL_HOSTNAME_INTERPOLATION, o)
  else
    # corner case, may be ok, but lexer may have replaced with plain string, this is
    # here if it does not
    hostname_String(o.segments[0], o.segments[0])
  end
end

#hostname_LiteralDefault(o, semantic) ⇒ 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.



746
747
748
# File 'lib/puppet/pops/validation/checker4_0.rb', line 746

def hostname_LiteralDefault(o, semantic)
  # always ok
end

#hostname_LiteralNumber(o, semantic) ⇒ 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.



742
743
744
# File 'lib/puppet/pops/validation/checker4_0.rb', line 742

def hostname_LiteralNumber(o, semantic)
  # always ok
end

#hostname_LiteralRegularExpression(o, semantic) ⇒ 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.



750
751
752
# File 'lib/puppet/pops/validation/checker4_0.rb', line 750

def hostname_LiteralRegularExpression(o, semantic)
  # always ok
end

#hostname_LiteralValue(o, semantic) ⇒ 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.



716
717
718
# File 'lib/puppet/pops/validation/checker4_0.rb', line 716

def hostname_LiteralValue(o, semantic)
  hostname_String(o.value.to_s, o)
end

#hostname_Object(o, semantic) ⇒ 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.



754
755
756
# File 'lib/puppet/pops/validation/checker4_0.rb', line 754

def hostname_Object(o, semantic)
  acceptor.accept(Issues::ILLEGAL_EXPRESSION, o, {:feature => 'hostname', :container => semantic})
end

#hostname_QualifiedName(o, semantic) ⇒ 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.



734
735
736
# File 'lib/puppet/pops/validation/checker4_0.rb', line 734

def hostname_QualifiedName(o, semantic)
  hostname_String(o.value.to_s, o)
end

#hostname_QualifiedReference(o, semantic) ⇒ 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.



738
739
740
# File 'lib/puppet/pops/validation/checker4_0.rb', line 738

def hostname_QualifiedReference(o, semantic)
  hostname_String(o.value.to_s, o)
end

#hostname_String(o, semantic) ⇒ 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.



706
707
708
709
710
711
712
713
714
# File 'lib/puppet/pops/validation/checker4_0.rb', line 706

def hostname_String(o, semantic)
  # The 3.x checker only checks for illegal characters - if matching /[^-\w.]/ the name is invalid,
  # but this allows pathological names like "a..b......c", "----"
  # TODO: Investigate if more illegal hostnames should be flagged.
  #
  if o =~ Patterns::ILLEGAL_HOSTNAME_CHARS
    acceptor.accept(Issues::ILLEGAL_HOSTNAME_CHARS, semantic, :hostname => o)
  end
end

#idem(o) ⇒ Boolean

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.

Checks if the expression has side effect (‘idem’ is latin for ‘the same’, here meaning that the evaluation state is known to be unchanged after the expression has been evaluated). The result is not 100% authoritative for negative answers since analysis of function behavior is not possible.

Returns:

  • (Boolean)

    true if expression is known to have no effect on evaluation state



91
92
93
# File 'lib/puppet/pops/validation/checker4_0.rb', line 91

def idem(o)
  @@idem_visitor.visit_this_0(self, o)
end

#idem_AccessExpression(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.



875
876
877
# File 'lib/puppet/pops/validation/checker4_0.rb', line 875

def idem_AccessExpression(o)
  true
end

#idem_AssignmentExpression(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.



888
889
890
891
# File 'lib/puppet/pops/validation/checker4_0.rb', line 888

def idem_AssignmentExpression(o)
  # Always side effect
  false
end

#idem_BinaryExpression(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.



879
880
881
# File 'lib/puppet/pops/validation/checker4_0.rb', line 879

def idem_BinaryExpression(o)
  true
end

#idem_BlockExpression(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.



911
912
913
914
# File 'lib/puppet/pops/validation/checker4_0.rb', line 911

def idem_BlockExpression(o)
  # productive if there is at least one productive expression
  ! o.statements.any? {|expr| !idem(expr) }
end

#idem_CaseExpression(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.

Case expression is idem, if test, and all options are idem



939
940
941
942
# File 'lib/puppet/pops/validation/checker4_0.rb', line 939

def idem_CaseExpression(o)
  return false if !idem(o.test)
  ! o.options.any? {|opt| !idem(opt) }
end

#idem_CaseOption(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.

An option is idem if values and the then_expression are idem



945
946
947
948
# File 'lib/puppet/pops/validation/checker4_0.rb', line 945

def idem_CaseOption(o)
  return false if o.values.any? { |value| !idem(value) }
  idem(o.then_expr)
end

#idem_ConcatenatedString(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.

Returns true even though there may be interpolated expressions that have side effect. Report as idem anyway, as it is very bad design to evaluate an interpolated string for its side effect only.



919
920
921
# File 'lib/puppet/pops/validation/checker4_0.rb', line 919

def idem_ConcatenatedString(o)
  true
end

#idem_Factory(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.



871
872
873
# File 'lib/puppet/pops/validation/checker4_0.rb', line 871

def idem_Factory(o)
  idem(o.current)
end

#idem_HeredocExpression(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.

Heredoc is just a string, but may contain interpolated string (which may have side effects). This is still bad design and should be reported as idem.



925
926
927
# File 'lib/puppet/pops/validation/checker4_0.rb', line 925

def idem_HeredocExpression(o)
  true
end

#idem_IfExpression(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.



934
935
936
# File 'lib/puppet/pops/validation/checker4_0.rb', line 934

def idem_IfExpression(o)
  [o.test, o.then_expr, o.else_expr].all? {|e| idem(e) }
end

#idem_Literal(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.



859
860
861
# File 'lib/puppet/pops/validation/checker4_0.rb', line 859

def idem_Literal(o)
  true
end

#idem_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.



867
868
869
# File 'lib/puppet/pops/validation/checker4_0.rb', line 867

def idem_LiteralHash(o)
  true
end

#idem_LiteralList(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.



863
864
865
# File 'lib/puppet/pops/validation/checker4_0.rb', line 863

def idem_LiteralList(o)
  true
end

#idem_NilClass(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.



855
856
857
# File 'lib/puppet/pops/validation/checker4_0.rb', line 855

def idem_NilClass(o)
  true
end

#idem_Nop(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.



851
852
853
# File 'lib/puppet/pops/validation/checker4_0.rb', line 851

def idem_Nop(o)
  true
end

#idem_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.

–IDEM CHECK



847
848
849
# File 'lib/puppet/pops/validation/checker4_0.rb', line 847

def idem_Object(o)
  false
end

#idem_ParenthesizedExpression(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.

Allow (no-effect parentheses) to be used around a productive expression



899
900
901
# File 'lib/puppet/pops/validation/checker4_0.rb', line 899

def idem_ParenthesizedExpression(o)
  idem(o.expr)
end

#idem_RelationshipExpression(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.



883
884
885
886
# File 'lib/puppet/pops/validation/checker4_0.rb', line 883

def idem_RelationshipExpression(o)
  # Always side effect
  false
end

#idem_RenderExpression(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.



903
904
905
# File 'lib/puppet/pops/validation/checker4_0.rb', line 903

def idem_RenderExpression(o)
  false
end

#idem_RenderStringExpression(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.



907
908
909
# File 'lib/puppet/pops/validation/checker4_0.rb', line 907

def idem_RenderStringExpression(o)
  false
end

#idem_SelectorExpression(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.

May technically have side effects inside the Selector, but this is bad design - treat as idem



930
931
932
# File 'lib/puppet/pops/validation/checker4_0.rb', line 930

def idem_SelectorExpression(o)
  true
end

#idem_UnaryExpression(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.

Handles UnaryMinusExpression, NotExpression, VariableExpression



894
895
896
# File 'lib/puppet/pops/validation/checker4_0.rb', line 894

def idem_UnaryExpression(o)
  true
end

#internal_check_capture_last(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.



461
462
463
464
465
466
467
468
# File 'lib/puppet/pops/validation/checker4_0.rb', line 461

def internal_check_capture_last(o)
  accepted_index = o.parameters.size() -1
  o.parameters.each_with_index do |p, index|
    if p.captures_rest && index != accepted_index
      acceptor.accept(Issues::CAPTURES_REST_NOT_LAST, p, {:param_name => p.name})
    end
  end
end

#internal_check_future_reserved_word(o, name) ⇒ 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.



484
485
486
487
488
# File 'lib/puppet/pops/validation/checker4_0.rb', line 484

def internal_check_future_reserved_word(o, name)
  if FUTURE_RESERVED_WORDS[name]
    acceptor.accept(Issues::FUTURE_RESERVED_WORD, o, {:word => name})
  end
end

#internal_check_illegal_assignment(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.



596
597
598
599
600
601
602
603
604
# File 'lib/puppet/pops/validation/checker4_0.rb', line 596

def internal_check_illegal_assignment(o)
  if o.is_a?(Model::AssignmentExpression)
    acceptor.accept(Issues::ILLEGAL_ASSIGNMENT_CONTEXT, o)
  else
    # recursively check all contents unless it's a lambda expression. A lambda may contain
    # local assignments
    o.eContents.each {|model| internal_check_illegal_assignment(model) } unless o.is_a?(Model::LambdaExpression)
  end
end

#internal_check_no_capture(o, container = 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.



470
471
472
473
474
475
476
# File 'lib/puppet/pops/validation/checker4_0.rb', line 470

def internal_check_no_capture(o, container = o)
  o.parameters.each do |p|
    if p.captures_rest
      acceptor.accept(Issues::CAPTURES_REST_NOT_SUPPORTED, p, {:container => container, :param_name => p.name})
    end
  end
end

#internal_check_no_idem_last(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.



455
456
457
458
459
# File 'lib/puppet/pops/validation/checker4_0.rb', line 455

def internal_check_no_idem_last(o)
  if violator = ends_with_idem(o.body)
    acceptor.accept(Issues::IDEM_NOT_ALLOWED_LAST, violator, {:container => o}) unless resource_without_title?(violator)
  end
end

#internal_check_parameter_name_uniqueness(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.



504
505
506
507
508
509
# File 'lib/puppet/pops/validation/checker4_0.rb', line 504

def internal_check_parameter_name_uniqueness(o)
  unique = Set.new
  o.parameters.each do |p|
    acceptor.accept(Issues::DUPLICATE_PARAMETER, p, {:param_name => p.name}) unless unique.add?(p.name)
  end
end

#internal_check_reserved_params(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.



496
497
498
499
500
501
502
# File 'lib/puppet/pops/validation/checker4_0.rb', line 496

def internal_check_reserved_params(o)
  o.parameters.each do |p|
    if RESERVED_PARAMETERS[p.name]
      acceptor.accept(Issues::RESERVED_PARAMETER, p, {:container => o, :param_name => p.name})
    end
  end
end

#internal_check_reserved_type_name(o, name) ⇒ 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.



478
479
480
481
482
# File 'lib/puppet/pops/validation/checker4_0.rb', line 478

def internal_check_reserved_type_name(o, name)
  if RESERVED_TYPE_NAMES[name]
    acceptor.accept(Issues::RESERVED_TYPE_NAME, o, {:name => name})
  end
end

#internal_check_return_type(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.



441
442
443
444
# File 'lib/puppet/pops/validation/checker4_0.rb', line 441

def internal_check_return_type(o)
  r = o.return_type
  internal_check_type_ref(o, r) unless r.nil?
end

#internal_check_type_ref(o, r) ⇒ 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.



446
447
448
449
450
451
452
453
# File 'lib/puppet/pops/validation/checker4_0.rb', line 446

def internal_check_type_ref(o, r)
  n = r.is_a?(Model::AccessExpression) ? r.left_expr : r
  if n.is_a? Model::QualifiedReference
    internal_check_future_reserved_word(r, n.value)
  else
    acceptor.accept(Issues::ILLEGAL_EXPRESSION, r, :feature => 'a type reference', :container => o)
  end
end

#pattern_with_replacement?(o) ⇒ Boolean

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.

Returns:

  • (Boolean)


398
399
400
401
402
403
404
405
# File 'lib/puppet/pops/validation/checker4_0.rb', line 398

def pattern_with_replacement?(o)
  if o.is_a?(Model::LiteralList)
    v = o.values
    v.size == 2 && v[0].is_a?(Model::LiteralRegularExpression) && v[1].is_a?(Model::LiteralString)
  else
    false
  end
end

#query(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.

Performs check if this is valid as a query



60
61
62
# File 'lib/puppet/pops/validation/checker4_0.rb', line 60

def query(o)
  @@query_visitor.visit_this_0(self, o)
end

#query_BooleanExpression(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.

Allows AND, OR, and checks if left/right are allowed in query.



772
773
774
775
# File 'lib/puppet/pops/validation/checker4_0.rb', line 772

def query_BooleanExpression(o)
  query o.left_expr
  query o.right_expr
end

#query_ComparisonExpression(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.

Puppet AST only allows == and !=



767
768
769
# File 'lib/puppet/pops/validation/checker4_0.rb', line 767

def query_ComparisonExpression(o)
  acceptor.accept(Issues::ILLEGAL_QUERY_EXPRESSION, o) unless [:'==', :'!='].include? o.operator
end

#query_LiteralBoolean(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.



789
# File 'lib/puppet/pops/validation/checker4_0.rb', line 789

def query_LiteralBoolean(o); end

#query_LiteralNumber(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.



785
# File 'lib/puppet/pops/validation/checker4_0.rb', line 785

def query_LiteralNumber(o); end

#query_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.



787
# File 'lib/puppet/pops/validation/checker4_0.rb', line 787

def query_LiteralString(o); end

#query_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.

Anything not explicitly allowed is flagged as error.



761
762
763
# File 'lib/puppet/pops/validation/checker4_0.rb', line 761

def query_Object(o)
  acceptor.accept(Issues::ILLEGAL_QUERY_EXPRESSION, o)
end

#query_ParenthesizedExpression(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.



777
778
779
# File 'lib/puppet/pops/validation/checker4_0.rb', line 777

def query_ParenthesizedExpression(o)
  query(o.expr)
end

#query_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.



783
# File 'lib/puppet/pops/validation/checker4_0.rb', line 783

def query_QualifiedName(o); end

#query_VariableExpression(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.



781
# File 'lib/puppet/pops/validation/checker4_0.rb', line 781

def query_VariableExpression(o); end

#relation(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.

Performs check if this is valid as a relationship side



65
66
67
# File 'lib/puppet/pops/validation/checker4_0.rb', line 65

def relation(o)
  @@relation_visitor.visit_this_0(self, o)
end

#relation_CollectExpression(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.



579
# File 'lib/puppet/pops/validation/checker4_0.rb', line 579

def relation_CollectExpression(o); end

#relation_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.



575
576
577
# File 'lib/puppet/pops/validation/checker4_0.rb', line 575

def relation_Object(o)
  rvalue(o)
end

#relation_RelationshipExpression(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.



581
# File 'lib/puppet/pops/validation/checker4_0.rb', line 581

def relation_RelationshipExpression(o); end

#resource_without_title?(o) ⇒ Boolean

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.

Returns:

  • (Boolean)


216
217
218
219
220
221
222
223
# File 'lib/puppet/pops/validation/checker4_0.rb', line 216

def resource_without_title?(o)
  if o.instance_of?(Model::BlockExpression)
    statements = o.statements
    statements.length == 2 && statements[0].instance_of?(Model::QualifiedName) && statements[1].instance_of?(Model::LiteralHash)
  else
    false
  end
end

#rvalue(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.

Performs check if this is valid as a rvalue



70
71
72
# File 'lib/puppet/pops/validation/checker4_0.rb', line 70

def rvalue(o)
  @@rvalue_visitor.visit_this_0(self, o)
end

#rvalue_CollectExpression(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.



798
# File 'lib/puppet/pops/validation/checker4_0.rb', line 798

def rvalue_CollectExpression(o)         ; acceptor.accept(Issues::NOT_RVALUE, o) ; end

#rvalue_Definition(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.



800
# File 'lib/puppet/pops/validation/checker4_0.rb', line 800

def rvalue_Definition(o)                ; acceptor.accept(Issues::NOT_RVALUE, o) ; end

#rvalue_Expression(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.

By default, all expressions are reported as being rvalues Implement specific rvalue checks for those that are not.



796
# File 'lib/puppet/pops/validation/checker4_0.rb', line 796

def rvalue_Expression(o); end

#rvalue_NodeDefinition(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.



802
# File 'lib/puppet/pops/validation/checker4_0.rb', line 802

def rvalue_NodeDefinition(o)            ; acceptor.accept(Issues::NOT_RVALUE, o) ; end

#rvalue_UnaryExpression(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.



804
# File 'lib/puppet/pops/validation/checker4_0.rb', line 804

def rvalue_UnaryExpression(o)           ; rvalue o.expr                 ; end

#top(o, definition) ⇒ 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.

Performs check if this is valid as a container of a definition (class, define, node)



75
76
77
# File 'lib/puppet/pops/validation/checker4_0.rb', line 75

def top(o, definition)
  @@top_visitor.visit_this_1(self, o, definition)
end

#top_BlockExpression(o, definition) ⇒ 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.



817
818
819
820
821
822
823
824
825
826
827
# File 'lib/puppet/pops/validation/checker4_0.rb', line 817

def top_BlockExpression(o, definition)
  if !o.eContainer.is_a?(Model::Program) &&
    (definition.is_a?(Model::FunctionDefinition) || definition.is_a?(Model::TypeAlias) || definition.is_a?(Model::TypeDefinition))

    # not ok. These can never be nested in a block
    acceptor.accept(Issues::NOT_ABSOLUTE_TOP_LEVEL, definition)
  else
    # ok, if this is a block representing the body of a class, or is top level
    top o.eContainer, definition
  end
end

#top_HostClassDefinition(o, definition) ⇒ 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.



829
830
831
# File 'lib/puppet/pops/validation/checker4_0.rb', line 829

def top_HostClassDefinition(o, definition)
  # ok, stop scanning parents
end

#top_LambdaExpression(o, definition) ⇒ 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.

A LambdaExpression is a BlockExpression, and this method is needed to prevent the polymorph method for BlockExpression to accept a lambda. A lambda can not iteratively create classes, nodes or defines as the lambda does not have a closure.



841
842
843
844
# File 'lib/puppet/pops/validation/checker4_0.rb', line 841

def top_LambdaExpression(o, definition)
  # fail, stop scanning parents
  acceptor.accept(Issues::NOT_TOP_LEVEL, definition)
end

#top_NilClass(o, definition) ⇒ 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.

—TOP CHECK



808
809
810
# File 'lib/puppet/pops/validation/checker4_0.rb', line 808

def top_NilClass(o, definition)
  # ok, reached the top, no more parents
end

#top_Object(o, definition) ⇒ 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.



812
813
814
815
# File 'lib/puppet/pops/validation/checker4_0.rb', line 812

def top_Object(o, definition)
  # fail, reached a container that is not top level
  acceptor.accept(Issues::NOT_TOP_LEVEL, definition)
end

#top_Program(o, definition) ⇒ 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.



833
834
835
# File 'lib/puppet/pops/validation/checker4_0.rb', line 833

def top_Program(o, definition)
  # ok
end

#type_ref?(o) ⇒ Boolean

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.

Returns:

  • (Boolean)


407
408
409
410
# File 'lib/puppet/pops/validation/checker4_0.rb', line 407

def type_ref?(o)
  o = o.left_expr if o.is_a?(Model::AccessExpression)
  o.is_a?(Model::QualifiedReference)
end

#validate(model) ⇒ 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.

Validates the entire model by visiting each model element and calling ‘check`. The result is collected (or acted on immediately) by the configured diagnostic provider/acceptor given when creating this Checker.



42
43
44
45
46
# File 'lib/puppet/pops/validation/checker4_0.rb', line 42

def validate(model)
  # tree iterate the model, and call check for each element
  check(model)
  model.eAllContents.each {|m| check(m) }
end

#varname_to_s(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.

Produces string part of something named, or nil if not a QualifiedName or QualifiedReference



954
955
956
957
958
959
960
961
962
963
# File 'lib/puppet/pops/validation/checker4_0.rb', line 954

def varname_to_s(o)
  case o
  when Model::QualifiedName
    o.value
  when Model::QualifiedReference
    o.value
  else
    nil
  end
end