Module: Puppet::Pops::Pcore

Defined in:
lib/puppet/pops/pcore.rb

Constant Summary collapse

TYPE_URI_RX = 
Types::TypeFactory.regexp(URI.regexp)
TYPE_URI = 
Types::TypeFactory.pattern(TYPE_URI_RX)
TYPE_SIMPLE_TYPE_NAME = 
Types::TypeFactory.pattern(/\A[A-Z]\w*\z/)
TYPE_QUALIFIED_REFERENCE = 
Types::TypeFactory.pattern(/\A[A-Z][\w]*(?:::[A-Z][\w]*)*\z/)
KEY_PCORE_URI = 
'pcore_uri'.freeze
KEY_PCORE_VERSION = 
'pcore_version'.freeze
PCORE_URI = 
'http://puppet.com/2016.1/pcore'
PCORE_VERSION = 
Semantic::Version.new(1,0,0)
PARSABLE_PCORE_VERSIONS = 
Semantic::VersionRange.parse('1.x')
RUNTIME_NAME_AUTHORITY = 
'http://puppet.com/2016.1/runtime'

Class Method Summary collapse

Class Method Details

.add_alias(name, type, loader, name_authority = RUNTIME_NAME_AUTHORITY) ⇒ Object 



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

def self.add_alias(name, type, loader, name_authority = RUNTIME_NAME_AUTHORITY)
  add_type(Types::PTypeAliasType.new(name, nil, type), loader, name_authority)
end

.add_object_type(name, body, loader) ⇒ Object 



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

def self.add_object_type(name, body, loader)
  add_type(Types::PObjectType.new(name, Parser::EvaluatingParser.new.parse_string(body).current.body), loader)
end

.add_type(type, loader, name_authority = RUNTIME_NAME_AUTHORITY) ⇒ Object 



71
72
73
74
 
# File 'lib/puppet/pops/pcore.rb', line 71

def self.add_type(type, loader, name_authority = RUNTIME_NAME_AUTHORITY)
  loader.set_entry(Loader::TypedName.new(:type, type.name.downcase, name_authority), type)
  type
end

.create_object_type(loader, ir, impl_class, type_name, parent_name, attributes_hash = EMPTY_HASH, functions_hash = EMPTY_HASH, equality = nil) ⇒ PObjectType

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.

Create and register a new ‘Object` type in the Puppet Type System and map it to an implementation class

Parameters:

  • loader (Loader::Loader) —

    The loader where the new type will be registered

  • ir (ImplementationRegistry) —

    The implementation registry that maps this class to the new type

  • impl_class (Class) —

    The class that is the implementation of the type

  • type_name (String) —

    The fully qualified name of the new type

  • parent_name (String, nil) —

    The fully qualified name of the parent type

  • attributes_hash (Hash{String => Object}) (defaults to: EMPTY_HASH) —

    A hash of attribute definitions for the new type

  • functions_hash (Hash{String => Object}) (defaults to: EMPTY_HASH) —

    A hash of function definitions for the new type

  • equality (Array<String>) (defaults to: nil) —

    An array with names of attributes that participate in equality comparison

Returns:

  • (PObjectType) —

    the created type. Not yet resolved



53
54
55
56
57
58
59
60
61
 
# File 'lib/puppet/pops/pcore.rb', line 53

def self.create_object_type(loader, ir, impl_class, type_name, parent_name, attributes_hash = EMPTY_HASH, functions_hash = EMPTY_HASH, equality = nil)
  i12n_hash = {}
  i12n_hash[Types::KEY_PARENT] = Types::PTypeReferenceType.new(parent_name) unless parent_name.nil?
  i12n_hash[Types::KEY_ATTRIBUTES] = attributes_hash unless attributes_hash.empty?
  i12n_hash[Types::KEY_FUNCTIONS] = functions_hash unless functions_hash.empty?
  i12n_hash[Types::KEY_EQUALITY] = equality unless equality.nil?
  ir.register_implementation(type_name, impl_class, loader)
  add_type(Types::PObjectType.new(type_name, i12n_hash), loader)
end

.init(loader, ir) ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/puppet/pops/pcore.rb', line 19

def self.init(loader, ir)
  add_alias('Pcore::URI_RX', TYPE_URI_RX, loader)
  add_alias('Pcore::URI', TYPE_URI, loader)
  add_alias('Pcore::SimpleTypeName', TYPE_SIMPLE_TYPE_NAME, loader)
  add_alias('Pcore::TypeName', TYPE_QUALIFIED_REFERENCE, loader)
  add_alias('Pcore::QRef', TYPE_QUALIFIED_REFERENCE, loader)
  Types::TypedModelObject.register_ptypes(loader, ir)

  ir.register_implementation_namespace('Pcore', 'Puppet::Pops::Pcore', loader)
  ir.register_implementation_namespace('Puppet::AST', 'Puppet::Pops::Model', loader)
  ast_type_set = Serialization::RGen::TypeGenerator.new.generate_type_set('Puppet::AST', Puppet::Pops::Model, loader)

  # Extend the Puppet::AST type set with the Locator (it's not an RGen class, but nevertheless, used in the model)
  ast_ts_i12n = ast_type_set.i12n_hash
  ast_ts_i12n['types'] = ast_ts_i12n['types'].merge('Locator' => Parser::Locator::Locator19.register_ptype(loader, ir))
  add_type(Types::PTypeSetType.new(ast_ts_i12n), loader)

  Resource.register_ptypes(loader, ir)
  Lookup::Context.register_ptype(loader, ir);
end

.register_aliases(aliases, name_authority = RUNTIME_NAME_AUTHORITY) ⇒ Object 



80
81
82
83
84
85
 
# File 'lib/puppet/pops/pcore.rb', line 80

def self.register_aliases(aliases, name_authority = RUNTIME_NAME_AUTHORITY)
  loader = Loaders.loaders.private_environment_loader
  aliases.each do |name, type_string|
    add_type(Types::PTypeAliasType.new(name, Types::TypeFactory.type_reference(type_string), nil), loader, name_authority)
  end
end

.register_implementations(impls, name_authority = RUNTIME_NAME_AUTHORITY) ⇒ Object 



76
77
78
 
# File 'lib/puppet/pops/pcore.rb', line 76

def self.register_implementations(impls, name_authority = RUNTIME_NAME_AUTHORITY)
  Loaders.loaders.register_implementations(impls, name_authority = RUNTIME_NAME_AUTHORITY)
end