Class: Puppet::Pops::Types::PObjectType::PAnnotatedMember Abstract
- Includes:
- Annotatable, InvocableMember
- Defined in:
- lib/puppet/pops/types/p_object_type.rb
Overview
Encapsulates behavior common to PAttribute and PFunction
Direct Known Subclasses
Constant Summary
Constants included from Annotatable
Instance Attribute Summary collapse
-
#container ⇒ PObjectType
readonly
The object type containing this member.
-
#name ⇒ String
readonly
The name of this member.
-
#type ⇒ PAnyType
readonly
The type of this member.
Class Method Summary collapse
Instance Method Summary collapse
- #==(o) ⇒ Object
-
#_pcore_init_hash ⇒ Hash{String=>Object}
private
Returns the member as a hash suitable as an argument for constructor.
-
#accept(visitor, guard) ⇒ Object
Delegates to the contained type.
-
#assert_can_be_overridden(member) ⇒ PAnnotatedMember
private
Checks if the given member can override this member.
-
#assert_override(parent_members) ⇒ PAnnotatedMember
private
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.
- #constant? ⇒ Boolean
- #create_dispatch(instance) ⇒ Object private
- #eql?(o) ⇒ Boolean
- #feature_type ⇒ Object private
-
#final? ⇒ Boolean
‘true` if this feature cannot be overridden.
- #hash ⇒ Object
-
#initialize(name, container, init_hash) ⇒ PAnnotatedMember
constructor
A new instance of PAnnotatedMember.
-
#invoke(receiver, scope, args, &block) ⇒ Object
private
Performs type checking of arguments and invokes the method that corresponds to this method.
- #label ⇒ Object private
-
#override? ⇒ Boolean
‘true` if this feature must override an inherited feature.
Methods included from Annotatable
#annotatable_accept, #annotations, #init_annotatable
Constructor Details
#initialize(name, container, init_hash) ⇒ PAnnotatedMember
Returns a new instance of PAnnotatedMember.
116 117 118 119 120 121 122 123 124 125 |
# File 'lib/puppet/pops/types/p_object_type.rb', line 116 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.
98 99 100 |
# File 'lib/puppet/pops/types/p_object_type.rb', line 98 def container @container end |
#name ⇒ String (readonly)
Returns the name of this member.
102 103 104 |
# File 'lib/puppet/pops/types/p_object_type.rb', line 102 def name @name end |
#type ⇒ PAnyType (readonly)
Returns the type of this member.
106 107 108 |
# File 'lib/puppet/pops/types/p_object_type.rb', line 106 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.
262 263 264 |
# File 'lib/puppet/pops/types/p_object_type.rb', line 262 def self.feature_type raise NotImplementedError, "'#{self.class.name}' should implement #feature_type" end |
.label(container, name) ⇒ Object
266 267 268 |
# File 'lib/puppet/pops/types/p_object_type.rb', line 266 def self.label(container, name) "#{feature_type} #{container.label}[#{name}]" end |
Instance Method Details
#==(o) ⇒ Object
206 207 208 |
# File 'lib/puppet/pops/types/p_object_type.rb', line 206 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
213 214 215 216 217 218 219 |
# File 'lib/puppet/pops/types/p_object_type.rb', line 213 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
131 132 133 134 |
# File 'lib/puppet/pops/types/p_object_type.rb', line 131 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.
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 |
# File 'lib/puppet/pops/types/p_object_type.rb', line 162 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.
143 144 145 146 147 148 149 150 151 152 153 154 |
# File 'lib/puppet/pops/types/p_object_type.rb', line 143 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
179 180 181 |
# File 'lib/puppet/pops/types/p_object_type.rb', line 179 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.
250 251 252 253 254 255 256 257 258 259 |
# File 'lib/puppet/pops/types/p_object_type.rb', line 250 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
201 202 203 |
# File 'lib/puppet/pops/types/p_object_type.rb', line 201 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.
222 223 224 |
# File 'lib/puppet/pops/types/p_object_type.rb', line 222 def feature_type self.class.feature_type end |
#final? ⇒ Boolean
Returns ‘true` if this feature cannot be overridden.
185 186 187 |
# File 'lib/puppet/pops/types/p_object_type.rb', line 185 def final? @final end |
#hash ⇒ Object
196 197 198 |
# File 'lib/puppet/pops/types/p_object_type.rb', line 196 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
240 241 242 243 244 245 246 247 |
# File 'lib/puppet/pops/types/p_object_type.rb', line 240 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.
227 228 229 |
# File 'lib/puppet/pops/types/p_object_type.rb', line 227 def label self.class.label(@container, @name) end |
#override? ⇒ Boolean
Returns ‘true` if this feature must override an inherited feature.
191 192 193 |
# File 'lib/puppet/pops/types/p_object_type.rb', line 191 def override? @override end |