Module: Poise::Helpers::Subresources::Child

Extended by:

ClassMethods

Defined in:

lib/poise/helpers/subresources/child.rb

Overview

A resource mixin for child subresources.

Since:

• 1.0.0

Defined Under Namespace

Modules: ClassMethods

Class Method Summary

• .parent_attribute(name, type: Chef::Resource, optional: false, auto: true, default: nil) extended from ClassMethods

  Create a new kind of parent link.

• .parent_attributes ⇒ Hash<Symbol, Class> extended from ClassMethods

  Return the name of all parent relationships on this class.

• .parent_auto(val = nil) ⇒ Object extended from ClassMethods
• .parent_default(*args) ⇒ Object extended from ClassMethods
• .parent_optional(val = nil) ⇒ Object extended from ClassMethods
• .parent_type(type = nil) ⇒ Object extended from ClassMethods

Instance Method Summary

• #parent(*args) ⇒ Object

Class Method Details

.parent_attribute(name, type: Chef::Resource, optional: false, auto: true, default: nil) Originally defined in module ClassMethods

This method returns an undefined value.

Create a new kind of parent link.

Parameters:

• name (Symbol) —

  Name of the relationship. This becomes a method name on the resource instance.

• type (Class) (defaults to: Chef::Resource) —

  Class of the parent.

• optional (Boolean) (defaults to: false) —

  If the parent is optional.

• auto (Boolean) (defaults to: true) —

  If the parent is auto-detected.

Since:

• 2.0.0

.parent_attributes ⇒ Hash<Symbol, Class> Originally defined in module ClassMethods

Return the name of all parent relationships on this class.

Returns:

• (Hash<Symbol, Class>)

Since:

• 2.0.0

#parent_auto ⇒ Boolean #parent_auto(val) ⇒ Boolean Originally defined in module ClassMethods

Overloads:

• #parent_auto ⇒ Boolean

  Get the auto-detect mode for the default parent link on this resource.

  Returns:

  • (Boolean)
• #parent_auto(val) ⇒ Boolean

  Set the auto-detect mode for the default parent link on this resource.

  Parameters:

  • val (Boolean) —

    Mode to set.

  Returns:

  • (Boolean)

Since:

• 1.0.0

#parent_default ⇒ Object, Chef::DelayedEvaluator #parent_default(val) ⇒ Object, Chef::DelayedEvaluator Originally defined in module ClassMethods

Overloads:

• #parent_default ⇒ Object, Chef::DelayedEvaluator

  Get the default value for the default parent link on this resource.

  Returns:

  • (Object, Chef::DelayedEvaluator)

  Since:

  • 2.3.0

• #parent_default(val) ⇒ Object, Chef::DelayedEvaluator

  Set the default value for the default parent link on this resource.

  Parameters:

  • val (Object, Chef::DelayedEvaluator) —

    Default value to set.

  Returns:

  • (Object, Chef::DelayedEvaluator)

  Since:

  • 2.3.0

Since:

• 1.0.0

#parent_optional ⇒ Boolean #parent_optional(val) ⇒ Boolean Originally defined in module ClassMethods

Overloads:

• #parent_optional ⇒ Boolean

  Get the optional mode for the default parent link on this resource.

  Returns:

  • (Boolean)
• #parent_optional(val) ⇒ Boolean

  Set the optional mode for the default parent link on this resource.

  Parameters:

  • val (Boolean) —

    Mode to set.

  Returns:

  • (Boolean)

Since:

• 1.0.0

#parent_type ⇒ Class, Symbol #parent_type(type) ⇒ Class, Symbol Originally defined in module ClassMethods

Overloads:

• #parent_type ⇒ Class, Symbol

  Get the class of the default parent link on this resource.

  Returns:

  • (Class, Symbol)
• #parent_type(type) ⇒ Class, Symbol

  Set the class of the default parent link on this resource.

  Parameters:

  • type (Class, Symbol) —

    Class to set.

  Returns:

  • (Class, Symbol)

Since:

• 1.0.0

Instance Method Details

#parent ⇒ Chef::Resource^? #parent(val) ⇒ Chef::Resource^?

Overloads:

• #parent ⇒ Chef::Resource^?

  Get the parent resource for this child. This may be nil if the resource is set to parent_optional = true.

  Returns:

  • (Chef::Resource, nil)
• #parent(val) ⇒ Chef::Resource^?

  Set the parent resource. The parent can be set as resource object, a string (either a bare resource name or a type[name] string), or a type:name hash.

  Parameters:

  • val (String, Hash, Chef::Resource) —

    Parent resource to set.

  Returns:

  • (Chef::Resource, nil)

Since:

• 1.0.0

# File 'lib/poise/helpers/subresources/child.rb', line 63

def parent(*args)
  # Lie about this method if the parent type is true.
  if self.class.parent_type == true
    raise NoMethodError.new("undefined method `parent' for #{self}")
  end
  _parent(:parent, self.class.parent_type, self.class.parent_optional, self.class.parent_auto, self.class.parent_default, *args)
end