Module: Puppet::Pops::Types::TypeFactory

Defined in:
lib/puppet/pops/types/type_factory.rb

Class Method Summary collapse

Class Method Details

.all_callables ⇒ Object

Produces a CallableType matching all callables



221
222
223
 
# File 'lib/puppet/pops/types/type_factory.rb', line 221

def self.all_callables
  return PCallableType::DEFAULT
end

.any ⇒ Object

Produces the Any type



165
166
167
 
# File 'lib/puppet/pops/types/type_factory.rb', line 165

def self.any
  PAnyType::DEFAULT
end

.array_of(o, size_type = nil) ⇒ Object

Produces a type for Array where o is either a type, or an instance for which a type is inferred.



332
333
334
 
# File 'lib/puppet/pops/types/type_factory.rb', line 332

def self.array_of(o, size_type = nil)
  PArrayType.new(type_of(o), size_type)
end

.array_of_data ⇒ Object

Produces a type for Array



347
348
349
 
# File 'lib/puppet/pops/types/type_factory.rb', line 347

def self.array_of_data
  PArrayType::DATA
end

.boolean ⇒ Object

Produces the Boolean type



158
159
160
 
# File 'lib/puppet/pops/types/type_factory.rb', line 158

def self.boolean
  PBooleanType::DEFAULT
end

.callable(*params) ⇒ Object

Produces a Callable type with one signature without support for a block Use #with_block, or #with_optional_block to add a block to the callable If no parameters are given, the Callable will describe a signature that does not accept parameters. To create a Callable that matches all callables use #all_callables.

The params is a list of types, where the three last entries may be optionally followed by min, max count, and a Callable which is taken as the block_type. If neither min or max are specified the parameters must match exactly. A min < params.size means that the difference are optional. If max > params.size means that the last type repeats. if max is :default, the max value is unbound (infinity).

Params are given as a sequence of arguments to #type_of.



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
 
# File 'lib/puppet/pops/types/type_factory.rb', line 241

def self.callable(*params)
  last_callable = TypeCalculator.is_kind_of_callable?(params.last)
  block_t = last_callable ? params.pop : nil

  # compute a size_type for the signature based on the two last parameters
  if is_range_parameter?(params[-2]) && is_range_parameter?(params[-1])
    size_type = range(params[-2], params[-1])
    params = params[0, params.size - 2]
  elsif is_range_parameter?(params[-1])
    size_type = range(params[-1], :default)
    params = params[0, params.size - 1]
  else
    size_type = nil
  end

  types = params.map {|p| type_of(p) }

  # If the specification requires types, and none were given, a Unit type is used
  if types.empty? && !size_type.nil? && size_type.range[1] > 0
    types << PUnitType::DEFAULT
  end
  # create a signature
  tuple_t = tuple(types, size_type)
  PCallableType.new(tuple_t, block_t)
end

.catalog_entry ⇒ Object

Produces an instance of the abstract type PCatalogEntryType



294
295
296
 
# File 'lib/puppet/pops/types/type_factory.rb', line 294

def self.catalog_entry
  PCatalogEntryType::DEFAULT
end

.collection(size_type = nil) ⇒ Object

Produces the abstract type Collection



270
271
272
 
# File 'lib/puppet/pops/types/type_factory.rb', line 270

def self.collection(size_type = nil)
  size_type.nil? ? PCollectionType::DEFAULT : PCollectionType.new(nil, size_type)
end

.data ⇒ Object

Produces the Data type



277
278
279
 
# File 'lib/puppet/pops/types/type_factory.rb', line 277

def self.data
  PDataType::DEFAULT
end

.default ⇒ Object

Creates an instance of the Default type



289
290
291
 
# File 'lib/puppet/pops/types/type_factory.rb', line 289

def self.default
  PDefaultType::DEFAULT
end

.enum(*values) ⇒ Object

Produces the Enum type, optionally with specific string values



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

def self.enum(*values)
  PEnumType.new(values)
end

.float ⇒ Object

Produces the Float type



39
40
41
 
# File 'lib/puppet/pops/types/type_factory.rb', line 39

def self.float
  PFloatType::DEFAULT
end

.float_range(from, to) ⇒ Object

Produces a Float range type



29
30
31
32
33
34
 
# File 'lib/puppet/pops/types/type_factory.rb', line 29

def self.float_range(from, to)
  # optimize eq with symbol (faster when it is left)
  from = Float(from) unless :default == from || from.nil?
  to = Float(to) unless :default == to || to.nil?
  PFloatType.new(from, to)
end

.hash_of(value, key = scalar, size_type = nil) ⇒ Object

Produces a type for Hash[Scalar, o] where o is either a type, or an instance for which a type is inferred.



340
341
342
 
# File 'lib/puppet/pops/types/type_factory.rb', line 340

def self.hash_of(value, key = scalar, size_type = nil)
  PHashType.new(type_of(key), type_of(value), size_type)
end

.hash_of_data ⇒ Object

Produces a type for Hash[Scalar, Data]



354
355
356
 
# File 'lib/puppet/pops/types/type_factory.rb', line 354

def self.hash_of_data
  PHashType::DATA
end

.host_class(class_name = nil) ⇒ Object

Produces PHostClassType with a string class_name. A PHostClassType with nil or empty name is compatible with any other PHostClassType. A PHostClassType with a given name is only compatible with a PHostClassType with the same name.



320
321
322
323
324
325
326
 
# File 'lib/puppet/pops/types/type_factory.rb', line 320

def self.host_class(class_name = nil)
  if class_name.nil?
    PHostClassType::DEFAULT
  else
    PHostClassType.new(class_name.sub(/^::/, ''))
  end
end

.integer ⇒ Object

Produces the Integer type



12
13
14
 
# File 'lib/puppet/pops/types/type_factory.rb', line 12

def self.integer
  PIntegerType::DEFAULT
end

.is_range_parameter?(t) ⇒ Boolean

Returns true if the given type t is of valid range parameter type (integer or literal default).

Returns:

  • (Boolean) 


452
453
454
 
# File 'lib/puppet/pops/types/type_factory.rb', line 452

def self.is_range_parameter?(t)
  t.is_a?(Integer) || t == 'default' || :default == t
end

.iterable(elem_type = nil) ⇒ Object

Produces the Iterable type



53
54
55
 
# File 'lib/puppet/pops/types/type_factory.rb', line 53

def self.iterable(elem_type = nil)
  elem_type.nil? ? PIterableType::DEFAULT : PIterableType.new(elem_type)
end

.iterator(elem_type = nil) ⇒ Object

Produces the Iterator type



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

def self.iterator(elem_type = nil)
  elem_type.nil? ? PIteratorType::DEFAULT : PIteratorType.new(elem_type)
end

.label(t) ⇒ Object

Produces a string representation of the type



67
68
69
 
# File 'lib/puppet/pops/types/type_factory.rb', line 67

def self.label(t)
  @type_calculator.string(t)
end

.not_undef(inst_type = nil) ⇒ PNotUndefType

Produces a type for NotUndef The given ‘inst_type’ can be a string in which case it will be converted into the type String.

Parameters:

  • inst_type (Type, String) (defaults to: nil) —

    the type to qualify

Returns:



367
368
369
370
 
# File 'lib/puppet/pops/types/type_factory.rb', line 367

def self.not_undef(inst_type = nil)
  inst_type = string(nil, inst_type) if inst_type.is_a?(String)
  PNotUndefType.new(inst_type)
end

.numeric ⇒ Object

Produces the Numeric type



46
47
48
 
# File 'lib/puppet/pops/types/type_factory.rb', line 46

def self.numeric
  PNumericType::DEFAULT
end

.optional(optional_type = nil) ⇒ POptionalType

Produces the Optional type, i.e. a short hand for Variant[T, Undef] If the given ‘optional_type’ argument is a String, then it will be converted into a String type that represents that string.

Parameters:

  • optional_type (String, PAnyType, nil) (defaults to: nil) —

    the optional type

Returns:



87
88
89
 
# File 'lib/puppet/pops/types/type_factory.rb', line 87

def self.optional(optional_type = nil)
  POptionalType.new(type_of(optional_type.is_a?(String) ? string(nil, optional_type) : type_of(optional_type)))
end

.pattern(*regular_expressions) ⇒ Object 



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/puppet/pops/types/type_factory.rb', line 184

def self.pattern(*regular_expressions)
  patterns = regular_expressions.map do |re|
    case re
    when String
      re_t = PRegexpType.new(re)
      re_t.regexp  # compile it to catch errors
      re_t

    when Regexp
      # Regep.to_s includes options user did not enter and does not escape source
      # to work either as a string or as a // regexp. The inspect method does a better
      # job, but includes the //
      PRegexpType.new(re.inspect[1..-2])

    when PRegexpType
      re

    when PPatternType
      re.patterns

   else
     raise ArgumentError, "Only String, Regexp, Pattern-Type, and Regexp-Type are allowed: got '#{re.class}"
    end
  end.flatten.uniq
  PPatternType.new(patterns)
end

.range(from, to) ⇒ Object

Produces an Integer range type



19
20
21
22
23
24
 
# File 'lib/puppet/pops/types/type_factory.rb', line 19

def self.range(from, to)
  # optimize eq with symbol (faster when it is left)
  from = :default == from if from == 'default'
  to = :default if to == 'default'
  PIntegerType.new(from, to)
end

.regexp(pattern = nil) ⇒ Object

Produces the Regexp type

Parameters:

  • pattern (Regexp, String, nil) (defaults to: nil) —

    (nil) The regular expression object or a regexp source string, or nil for bare type



174
175
176
177
178
179
180
181
182
 
# File 'lib/puppet/pops/types/type_factory.rb', line 174

def self.regexp(pattern = nil)
  if pattern
    t = PRegexpType.new(pattern.is_a?(Regexp) ? pattern.inspect[1..-2] : pattern)
    t.regexp unless pattern.nil? # compile pattern to catch errors
    t
  else
    PRegexpType::DEFAULT
  end
end

.resource(type_name = nil, title = nil) ⇒ Object

Produces a PResourceType with a String type_name A PResourceType with a nil or empty name is compatible with any other PResourceType. A PResourceType with a given name is only compatible with a PResourceType with the same name. (There is no resource-type subtyping in Puppet (yet)).



303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/puppet/pops/types/type_factory.rb', line 303

def self.resource(type_name = nil, title = nil)
  type_name = type_name.type_name if type_name.is_a?(PResourceType)
  type_name = type_name.downcase unless type_name.nil?
  unless type_name.nil? || type_name =~ Patterns::CLASSREF
    raise ArgumentError, "Illegal type name '#{type.type_name}'"
  end
  if type_name.nil? && !title.nil?
    raise ArgumentError, 'The type name cannot be nil, if title is given'
  end
  PResourceType.new(type_name, title)
end

.ruby(o) ⇒ Object .ruby(o) ⇒ Object

Note:

To get the type for the class’ class use ‘TypeCalculator.infer©`

Produces a type for a class or infers a type for something that is not a class

Overloads:

  • .ruby(o) ⇒ Object

    Parameters:

    • o (Class) —

      produces the type corresponding to the class (e.g. Integer becomes PIntegerType)

  • .ruby(o) ⇒ Object

    Parameters:

    • o (Object) —

      produces the type corresponding to the instance class (e.g. 3 becomes PIntegerType)



409
410
411
412
413
414
415
 
# File 'lib/puppet/pops/types/type_factory.rb', line 409

def self.ruby(o)
  if o.is_a?(Class)
    @type_calculator.type(o)
  else
    PRuntimeType.new(:ruby, o.class.name)
  end
end

.ruby_type(class_name = nil) ⇒ Object

Generic creator of a RuntimeType - allows creating the Ruby type with nil name, or String name. Also see ruby(o) which performs inference, or mapps a Ruby Class to its name.



421
422
423
 
# File 'lib/puppet/pops/types/type_factory.rb', line 421

def self.ruby_type(class_name = nil)
  PRuntimeType.new(:ruby, class_name)
end

.runtime(runtime = nil, runtime_type_name = nil) ⇒ Object

Generic creator of a RuntimeType - allows creating the type with nil or String runtime_type_name. Also see ruby_type(o) and ruby(o).



428
429
430
431
 
# File 'lib/puppet/pops/types/type_factory.rb', line 428

def self.runtime(runtime=nil, runtime_type_name = nil)
  runtime = runtime.to_sym if runtime.is_a?(String)
  PRuntimeType.new(runtime, runtime_type_name)
end

.scalar ⇒ Object

Produces the Literal type



214
215
216
 
# File 'lib/puppet/pops/types/type_factory.rb', line 214

def self.scalar
  PScalarType::DEFAULT
end

.string(size_type = nil, *values) ⇒ Object

Produces the String type, optionally with specific string values



74
75
76
 
# File 'lib/puppet/pops/types/type_factory.rb', line 74

def self.string(size_type = nil, *values)
  PStringType.new(size_type, values)
end

.struct(hash = {}) ⇒ PStructType

Produces the Struct type, either a non parameterized instance representing all structs (i.e. all hashes) or a hash with entries where the key is either a literal String, an Enum with one entry, or a String representing exactly one value. The key type may also be wrapped in a NotUndef or an Optional.

The value can be a ruby class, a String (interpreted as the name of a ruby class) or a Type.

Parameters:

Returns:



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
 
# File 'lib/puppet/pops/types/type_factory.rb', line 116

def self.struct(hash = {})
  tc = @type_calculator
  elements = hash.map do |key_type, value_type|
    value_type = type_of(value_type)
    raise ArgumentError, 'Struct element value_type must be a Type' unless value_type.is_a?(PAnyType)

    # TODO: Should have stricter name rule
    if key_type.is_a?(String)
      raise ArgumentError, 'Struct element key cannot be an empty String' if key_type.empty?
      key_type = string(nil, key_type)
      # Must make key optional if the value can be Undef
      key_type = optional(key_type) if tc.assignable?(value_type, PUndefType::DEFAULT)
    else
      # assert that the key type is one of String[1], NotUndef[String[1]] and Optional[String[1]]
      case key_type
      when PNotUndefType
        # We can loose the NotUndef wrapper here since String[1] isn't optional anyway
        key_type = key_type.type
        s = key_type
      when POptionalType
        s = key_type.optional_type
      when PStringType, PEnumType
        s = key_type
      else
        raise ArgumentError, "Illegal Struct member key type. Expected NotUndef, Optional, String, or Enum. Got: #{key_type.class.name}"
      end
      unless (s.is_a?(PStringType) || s.is_a?(PEnumType)) && s.values.size == 1 && !s.values[0].empty?
        raise ArgumentError, "Unable to extract a non-empty literal string from Struct member key type #{tc.string(key_type)}"
      end
    end
    PStructElement.new(key_type, value_type)
  end
  PStructType.new(elements)
end

.tuple(types = [], size_type = nil) ⇒ Object 



151
152
153
 
# File 'lib/puppet/pops/types/type_factory.rb', line 151

def self.tuple(types = [], size_type = nil)
  PTupleType.new(types.map {|elem| type_of(elem) }, size_type)
end

.type_alias(name, expression) ⇒ PTypeAliasType

Returns the type alias for the given expression

Parameters:

  • name (String) —

    the name of the unresolved type

  • expression (Model::Expression) —

    an expression that will evaluate to a type

Returns:



437
438
439
 
# File 'lib/puppet/pops/types/type_factory.rb', line 437

def self.type_alias(name, expression)
  PTypeAliasType.new(name, expression)
end

.type_of(o) ⇒ Object

Produce a type corresponding to the class of given unless given is a String, Class or a PAnyType. When a String is given this is taken as a classname.



383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/puppet/pops/types/type_factory.rb', line 383

def self.type_of(o)
  if o.is_a?(Class)
    @type_calculator.type(o)
  elsif o.is_a?(PAnyType)
    o
  elsif o.is_a?(String)
    PRuntimeType.new(:ruby, o)
  else
    @type_calculator.infer_generic(o)
  end
end

.type_reference(name, parameters = nil) ⇒ PTypeReferenceType

Returns the type that represents a type reference with a given name and optional parameters.

Parameters:

  • name (String) —

    the name of the type

  • parameters (Array) (defaults to: nil) —

    the parameters

Returns:



446
447
448
 
# File 'lib/puppet/pops/types/type_factory.rb', line 446

def self.type_reference(name, parameters = nil)
  PTypeReferenceType.new(name, parameters)
end

.type_type(inst_type = nil) ⇒ Object

Produces a type for Type



375
376
377
 
# File 'lib/puppet/pops/types/type_factory.rb', line 375

def self.type_type(inst_type = nil)
  inst_type.nil? ? PType::DEFAULT : PType.new(inst_type)
end

.undef ⇒ Object

Creates an instance of the Undef type



283
284
285
 
# File 'lib/puppet/pops/types/type_factory.rb', line 283

def self.undef
  PUndefType::DEFAULT
end

.variant(*types) ⇒ Object

Produces the Variant type, optionally with the “one of” types



101
102
103
 
# File 'lib/puppet/pops/types/type_factory.rb', line 101

def self.variant(*types)
  PVariantType.new(types.map {|v| type_of(v) })
end