Class: Puppet::Pops::Types::PObjectType::PAnnotatedMember Abstract

Inherits:
Object
  • Object
show all
Includes:
Annotatable, InvocableMember
Defined in:
lib/puppet/pops/types/p_object_type.rb

Overview

This class is abstract.

Encapsulates behavior common to PAttribute and PFunction

Direct Known Subclasses

PAttribute, PFunction

Constant Summary

Constants included from Annotatable

Annotatable::TYPE_ANNOTATIONS

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Annotatable

#annotatable_accept, #annotations, #init_annotatable

Constructor Details

#initialize(name, container, init_hash) ⇒ PAnnotatedMember

Returns a new instance of PAnnotatedMember.

Parameters:

  • name (String) —

    The name of the member

  • container (PObjectType) —

    The containing object type

  • init_hash (Hash{String=>Object}) —

    Hash containing feature options

Options Hash (init_hash):

  • 'type' (PAnyType) —

    The member type (required)

  • 'override' (Boolean) —

    ‘true` if this feature must override an inherited feature. Default is `false`.

  • 'final' (Boolean) —

    ‘true` if this feature cannot be overridden. Default is `false`.

  • 'annotations' (Hash{PTypeType => Hash}) —

    Annotations hash. Default is ‘nil`.



117
118
119
120
121
122
123
124
125
126
 
# File 'lib/puppet/pops/types/p_object_type.rb', line 117

def initialize(name, container, init_hash)
  @name = name
  @container = container
  @type = init_hash[KEY_TYPE]
  @override = init_hash[KEY_OVERRIDE]
  @override = false if @override.nil?
  @final = init_hash[KEY_FINAL]
  @final = false if @final.nil?
  init_annotatable(init_hash)
end

Instance Attribute Details

#container ⇒ PObjectType (readonly)

Returns the object type containing this member.

Returns:

  • (PObjectType) —

    the object type containing this member



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

def container
  @container
end

#name ⇒ String (readonly)

Returns the name of this member.

Returns:

  • (String) —

    the name of this member



103
104
105
 
# File 'lib/puppet/pops/types/p_object_type.rb', line 103

def name
  @name
end

#type ⇒ PAnyType (readonly)

Returns the type of this member.

Returns:

  • (PAnyType) —

    the type of this member



107
108
109
 
# File 'lib/puppet/pops/types/p_object_type.rb', line 107

def type
  @type
end

Class Method Details

.feature_type ⇒ 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.

Raises:

  • (NotImplementedError) 


263
264
265
 
# File 'lib/puppet/pops/types/p_object_type.rb', line 263

def self.feature_type
  raise NotImplementedError, "'#{self.class.name}' should implement #feature_type"
end

.label(container, name) ⇒ Object 



267
268
269
 
# File 'lib/puppet/pops/types/p_object_type.rb', line 267

def self.label(container, name)
  "#{feature_type} #{container.label}[#{name}]"
end

Instance Method Details

#==(o) ⇒ Object 



207
208
209
 
# File 'lib/puppet/pops/types/p_object_type.rb', line 207

def ==(o)
  eql?(o)
end

#_pcore_init_hash ⇒ Hash{String=>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 member as a hash suitable as an argument for constructor. Name is excluded

Returns:

  • (Hash{String=>Object}) —

    the initialization hash



214
215
216
217
218
219
220
 
# File 'lib/puppet/pops/types/p_object_type.rb', line 214

def _pcore_init_hash
  hash = { KEY_TYPE => @type }
  hash[KEY_FINAL] = true if @final
  hash[KEY_OVERRIDE] = true if @override
  hash[KEY_ANNOTATIONS] = @annotations unless @annotations.nil?
  hash
end

#accept(visitor, guard) ⇒ Object

Delegates to the contained type

Parameters:



132
133
134
135
 
# File 'lib/puppet/pops/types/p_object_type.rb', line 132

def accept(visitor, guard)
  annotatable_accept(visitor, guard)
  @type.accept(visitor, guard)
end

#assert_can_be_overridden(member) ⇒ PAnnotatedMember

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 given member can override this member.

Parameters:

Returns:



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/puppet/pops/types/p_object_type.rb', line 163

def assert_can_be_overridden(member)
  unless self.class == member.class
    raise Puppet::ParseError, _("%{member} attempts to override %{label}") % { member: member.label, label: label }
  end
  if @final && !(constant? && member.constant?)
    raise Puppet::ParseError, _("%{member} attempts to override final %{label}") % { member: member.label, label: label }
  end
  unless member.override?
    #TRANSLATOR 'override => true' is a puppet syntax and should not be translated
    raise Puppet::ParseError, _("%{member} attempts to override %{label} without having override => true") % { member: member.label, label: label }
  end
  unless @type.assignable?(member.type)
    raise Puppet::ParseError, _("%{member} attempts to override %{label} with a type that does not match") % { member: member.label, label: label }
  end
  member
end

#assert_override(parent_members) ⇒ PAnnotatedMember

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 this member overrides an inherited member, and if so, that this member is declared with override = true and that the inherited member accepts to be overridden by this member.

Parameters:

  • parent_members (Hash{String=>PAnnotatedMember}) —

    the hash of inherited members

Returns:



144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/puppet/pops/types/p_object_type.rb', line 144

def assert_override(parent_members)
  parent_member = parent_members[@name]
  if parent_member.nil?
    if @override
      raise Puppet::ParseError, _("expected %{label} to override an inherited %{feature_type}, but no such %{feature_type} was found") %
          { label: label, feature_type: feature_type }
    end
    self
  else
    parent_member.assert_can_be_overridden(self)
  end
end

#constant? ⇒ Boolean

Returns:

  • (Boolean) 


180
181
182
 
# File 'lib/puppet/pops/types/p_object_type.rb', line 180

def constant?
  false
end

#create_dispatch(instance) ⇒ 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. 



251
252
253
254
255
256
257
258
259
260
 
# File 'lib/puppet/pops/types/p_object_type.rb', line 251

def create_dispatch(instance)
  # TODO: Assumes Ruby implementation for now
  if(callable_type.is_a?(PVariantType))
    callable_type.types.map do |ct|
      Functions::Dispatch.new(ct, RubyGenerator.protect_reserved_name(name), [], false, ct.block_type.nil? ? nil : 'block')
    end
  else
    [Functions::Dispatch.new(callable_type, RubyGenerator.protect_reserved_name(name), [], false, callable_type.block_type.nil? ? nil : 'block')]
  end
end

#eql?(o) ⇒ Boolean

Returns:

  • (Boolean) 


202
203
204
 
# File 'lib/puppet/pops/types/p_object_type.rb', line 202

def eql?(o)
  self.class == o.class && @name == o.name && @type == o.type && @override == o.override? && @final == o.final?
end

#feature_type ⇒ 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. 



223
224
225
 
# File 'lib/puppet/pops/types/p_object_type.rb', line 223

def feature_type
  self.class.feature_type
end

#final? ⇒ Boolean

Returns ‘true` if this feature cannot be overridden.

Returns:

  • (Boolean) —

    ‘true` if this feature cannot be overridden



186
187
188
 
# File 'lib/puppet/pops/types/p_object_type.rb', line 186

def final?
  @final
end

#hash ⇒ Object 



197
198
199
 
# File 'lib/puppet/pops/types/p_object_type.rb', line 197

def hash
  @name.hash ^ @type.hash
end

#invoke(receiver, scope, args, &block) ⇒ 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 type checking of arguments and invokes the method that corresponds to this method. The result of the invocation is returned

Parameters:

  • receiver (Object) —

    The receiver of the call

  • scope (Puppet::Parser::Scope) —

    The caller scope

  • args (Array) —

    Array of arguments.

Returns:

  • (Object) —

    The result returned by the member function or attribute

Raises:

  • (ArgumentError) 


241
242
243
244
245
246
247
248
 
# File 'lib/puppet/pops/types/p_object_type.rb', line 241

def invoke(receiver, scope, args, &block)
  @dispatch ||= create_dispatch(receiver)

  args_type = TypeCalculator.infer_set(block_given? ? args + [block] : args)
  found = @dispatch.find { |d| d.type.callable?(args_type) }
  raise ArgumentError, TypeMismatchDescriber.describe_signatures(label, @dispatch, args_type) if found.nil?
  found.invoke(receiver, scope, args, &block)
end

#label ⇒ 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. 



228
229
230
 
# File 'lib/puppet/pops/types/p_object_type.rb', line 228

def label
  self.class.label(@container, @name)
end

#override? ⇒ Boolean

Returns ‘true` if this feature must override an inherited feature.

Returns:

  • (Boolean) —

    ‘true` if this feature must override an inherited feature



192
193
194
 
# File 'lib/puppet/pops/types/p_object_type.rb', line 192

def override?
  @override
end