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

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

Overview

Helper module that makes creation of type objects simpler.

Constant Summary collapse

Types = 
Puppet::Pops::Types

Class Method Summary collapse

Class Method Details

.all_callables ⇒ Object

Produces a CallableType matching all callables



226
227
228
 
# File 'lib/puppet/pops/types/type_factory.rb', line 226

def self.all_callables()
  return Puppet::Pops::Types::PCallableType.new
end

.any ⇒ Object

Produces the Any type



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

def self.any()
  Types::PAnyType.new()
end

.array_of(o) ⇒ Object

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



355
356
357
358
359
 
# File 'lib/puppet/pops/types/type_factory.rb', line 355

def self.array_of(o)
  type = Types::PArrayType.new()
  type.element_type = type_of(o)
  type
end

.array_of_data ⇒ Object

Produces a type for Array



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

def self.array_of_data()
  type = Types::PArrayType.new()
  type.element_type = data()
  type
end

.boolean ⇒ Object

Produces the Boolean type



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

def self.boolean()
  Types::PBooleanType.new()
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.



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

def self.callable(*params)
  if Puppet::Pops::Types::TypeCalculator.is_kind_of_callable?(params.last)
    last_callable = true
  end
  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]
  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 << Types::PUnitType.new
  end
  # create a signature
  callable_t = Types::PCallableType.new()
  tuple_t = tuple(*types)
  tuple_t.size_type = size_type unless size_type.nil?
  callable_t.param_types = tuple_t

  callable_t.block_type = block_t
  callable_t
end

.catalog_entry ⇒ Object

Produces an instance of the abstract type PCatalogEntryType



314
315
316
 
# File 'lib/puppet/pops/types/type_factory.rb', line 314

def self.catalog_entry()
  Types::PCatalogEntryType.new()
end

.collection ⇒ Object

Produces the abstract type Collection



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

def self.collection()
  Types::PCollectionType.new()
end

.constrain_size(collection_t, from, to) ⇒ Object

Sets the accepted size range of a collection if something other than the default 0 to Infinity is wanted. The semantics for from/to are the same as for #range



474
475
476
477
 
# File 'lib/puppet/pops/types/type_factory.rb', line 474

def self.constrain_size(collection_t, from, to)
  collection_t.size_type = range(from, to)
  collection_t
end

.data ⇒ Object

Produces the Data type



297
298
299
 
# File 'lib/puppet/pops/types/type_factory.rb', line 297

def self.data()
  Types::PDataType.new()
end

.default ⇒ Object

Creates an instance of the Default type



309
310
311
 
# File 'lib/puppet/pops/types/type_factory.rb', line 309

def self.default()
  Types::PDefaultType.new()
end

.enum(*values) ⇒ Object

Produces the Enum type, optionally with specific string values



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

def self.enum(*values)
  t = Types::PEnumType.new()
  values.each {|v| t.addValues(v) }
  t
end

.float ⇒ Object

Produces the Float type



41
42
43
 
# File 'lib/puppet/pops/types/type_factory.rb', line 41

def self.float()
  Types::PFloatType.new()
end

.float_range(from, to) ⇒ Object

Produces a Float range type



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

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

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

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



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

def self.hash_of(value, key = scalar())
  type = Types::PHashType.new()
  type.key_type = type_of(key)
  type.element_type = type_of(value)
  type
end

.hash_of_data ⇒ Object

Produces a type for Hash[Scalar, Data]



384
385
386
387
388
389
 
# File 'lib/puppet/pops/types/type_factory.rb', line 384

def self.hash_of_data()
  type = Types::PHashType.new()
  type.key_type = scalar()
  type.element_type = data()
  type
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.



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

def self.host_class(class_name = nil)
  type = Types::PHostClassType.new()
  unless class_name.nil?
    type.class_name = class_name.sub(/^::/, '')
  end
  type
end

.integer ⇒ Object

Produces the Integer type



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

def self.integer()
  Types::PIntegerType.new()
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) 


481
482
483
 
# File 'lib/puppet/pops/types/type_factory.rb', line 481

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

.label(t) ⇒ Object

Produces a string representation of the type



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

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

.not_undef(inst_type = nil) ⇒ Puppet::Pops::Types::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:



400
401
402
403
404
405
 
# File 'lib/puppet/pops/types/type_factory.rb', line 400

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

.numeric ⇒ Object

Produces the Numeric type



48
49
50
 
# File 'lib/puppet/pops/types/type_factory.rb', line 48

def self.numeric()
  Types::PNumericType.new()
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:



77
78
79
80
81
 
# File 'lib/puppet/pops/types/type_factory.rb', line 77

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

.pattern(*regular_expressions) ⇒ Object 



183
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
210
211
212
213
214
 
# File 'lib/puppet/pops/types/type_factory.rb', line 183

def self.pattern(*regular_expressions)
  t = Types::PPatternType.new()
  regular_expressions.each do |re|
    case re
    when String
      re_T = Types::PRegexpType.new()
      re_T.pattern = re
      re_T.regexp()  # compile it to catch errors
      t.addPatterns(re_T)

    when Regexp
      re_T = Types::PRegexpType.new()
      # 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 //
      re_T.pattern = re.inspect[1..-2]
      t.addPatterns(re_T)

    when Types::PRegexpType
      t.addPatterns(re.copy)

    when Types::PPatternType
      re.patterns.each do |p|
        t.addPatterns(p.copy)
      end

   else
     raise ArgumentError, "Only String, Regexp, Pattern-Type, and Regexp-Type are allowed: got '#{re.class}"
    end
  end
  t
end

.range(from, to) ⇒ Object

Produces an Integer range type



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

def self.range(from, to)
  t = Types::PIntegerType.new()
  # optimize eq with symbol (faster when it is left)
  t.from = from unless (:default == from || from == 'default')
  t.to = to unless (:default == to || to == 'default')
  t
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
 
# File 'lib/puppet/pops/types/type_factory.rb', line 174

def self.regexp(pattern = nil)
  t = Types::PRegexpType.new()
  if pattern
    t.pattern = pattern.is_a?(Regexp) ? pattern.inspect[1..-2] : pattern
  end
  t.regexp() unless pattern.nil? # compile pattern to catch errors
  t
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)).



323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/puppet/pops/types/type_factory.rb', line 323

def self.resource(type_name = nil, title = nil)
  type = Types::PResourceType.new()
  type_name = type_name.type_name if type_name.is_a?(Types::PResourceType)
  type_name = type_name.downcase unless type_name.nil?
  type.type_name = type_name
  unless type_name.nil? || type_name =~ Puppet::Pops::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
  type.title = title
  type
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)



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

def self.ruby(o)
  if o.is_a?(Class)
    @type_calculator.type(o)
  else
    Types::PRuntimeType.new(:runtime => :ruby, :runtime_type_name => 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.



458
459
460
 
# File 'lib/puppet/pops/types/type_factory.rb', line 458

def self.ruby_type(class_name = nil)
  Types::PRuntimeType.new(:runtime => :ruby, :runtime_type_name => 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).



465
466
467
468
 
# File 'lib/puppet/pops/types/type_factory.rb', line 465

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

.scalar ⇒ Object

Produces the Literal type



219
220
221
 
# File 'lib/puppet/pops/types/type_factory.rb', line 219

def self.scalar()
  Types::PScalarType.new()
end

.string(*values) ⇒ Object

Produces the String type, optionally with specific string values



62
63
64
65
66
 
# File 'lib/puppet/pops/types/type_factory.rb', line 62

def self.string(*values)
  t = Types::PStringType.new()
  values.each {|v| t.addValues(v) }
  t
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:



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/puppet/pops/types/type_factory.rb', line 112

def self.struct(hash = {})
  tc = @type_calculator
  t = Types::PStructType.new
  t.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?(Types::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(key_type)
      # Must make key optional if the value can be Undef
      key_type = optional(key_type) if tc.assignable?(value_type, @undef_t)
    else
      # assert that the key type is one of String[1], NotUndef[String[1]] and Optional[String[1]]
      case key_type
      when Types::PNotUndefType
        # We can loose the NotUndef wrapper here since String[1] isn't optional anyway
        key_type = key_type.type
        s = key_type
      when Types::POptionalType
        s = key_type.optional_type
      else
        s = key_type
      end
      unless (s.is_a?(Puppet::Pops::Types::PStringType) || s.is_a?(Puppet::Pops::Types::PEnumType)) && s.values.size == 1 && !s.values[0].empty?
        raise ArgumentError, 'Unable to extract a non-empty literal string from Struct member key type' if key_type.empty?
      end
    end
    elem = Types::PStructElement.new
    elem.key_type = key_type
    elem.value_type = value_type
    elem
  end
  t
end

.tuple(*types) ⇒ Object 



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

def self.tuple(*types)
  t = Types::PTupleType.new
  types.each {|elem| t.addTypes(type_of(elem)) }
  t
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.



420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/puppet/pops/types/type_factory.rb', line 420

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

.type_type(inst_type = nil) ⇒ Object

Produces a type for Type



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

def self.type_type(inst_type = nil)
  type = Types::PType.new()
  type.type = inst_type
  type
end

.undef ⇒ Object

Creates an instance of the Undef type



303
304
305
 
# File 'lib/puppet/pops/types/type_factory.rb', line 303

def self.undef()
  Types::PUndefType.new()
end

.variant(*types) ⇒ Object

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



95
96
97
98
99
 
# File 'lib/puppet/pops/types/type_factory.rb', line 95

def self.variant(*types)
  t = Types::PVariantType.new()
  types.each {|v| t.addTypes(type_of(v)) }
  t
end

.with_block(callable, *block_params) ⇒ Object 



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

def self.with_block(callable, *block_params)
  callable.block_type = callable(*block_params)
  callable
end

.with_optional_block(callable, *block_params) ⇒ Object 



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

def self.with_optional_block(callable, *block_params)
  callable.block_type = optional(callable(*block_params))
  callable
end