Module: Poise::Resource

Includes:
Helpers::ChefspecMatchers, Helpers::DefinedIn, Helpers::LWRPPolyfill, Helpers::LazyDefault, Helpers::OptionCollector, Helpers::ResourceCloning, Helpers::ResourceName, Helpers::ResourceSubclass, Helpers::TemplateContent, Helpers::Win32User, Utils::ShellOut
Defined in:
lib/poise/resource.rb

Overview

Master resource mixin for Poise-based resources.

Examples:

Default helpers.

class MyResource < Chef::Resource
  include Poise::Resource
end

With optional helpers.

class MyResource < Chef::Resource
  include Poise::Resource
  poise_subresource(MyParent)
  poise_fused
end

Since:

  • 1.0.0

Class Method Summary collapse

Methods included from Utils::ShellOut

#poise_shell_out, #poise_shell_out!

Methods included from Helpers::TemplateContent

attribute

Methods included from Helpers::OptionCollector

attribute, option_collector_attribute

Methods included from Utils::ResourceProviderMixin

included

Methods included from Helpers::LazyDefault

lazy, #set_or_return

Methods included from Helpers::ResourceName

#initialize, provides, resource_name

Methods included from Helpers::DefinedIn

poise_defined!, poise_defined_in, poise_defined_in_cookbook

Methods included from Helpers::ChefspecMatchers

actions, provides

Methods included from Helpers::LWRPPolyfill::Resource

#initialize

Class Method Details

.poise_fused ⇒ Object

Since:

  • 1.0.0



64
65
66
 
# File 'lib/poise/resource.rb', line 64

def poise_fused
  include Poise::Helpers::Fused
end

.poise_inversion(options_resource = nil) ⇒ Object

Since:

  • 1.0.0



68
69
70
71
 
# File 'lib/poise/resource.rb', line 68

def poise_inversion(options_resource=nil)
  include Poise::Helpers::Inversion
  inversion_options_resource(true) unless options_resource == false
end

.poise_subresource(parent_type = nil, parent_optional = nil, parent_auto = nil) ⇒ Object

Since:

  • 1.0.0



57
58
59
60
61
62
 
# File 'lib/poise/resource.rb', line 57

def poise_subresource(parent_type=nil, parent_optional=nil, parent_auto=nil)
  include Poise::Helpers::Subresources::Child
  parent_type(parent_type) if parent_type
  parent_optional(parent_optional) unless parent_optional.nil?
  parent_auto(parent_auto) unless parent_auto.nil?
end

.poise_subresource_container(namespace = nil, default = nil) ⇒ Object

Since:

  • 1.0.0



50
51
52
53
54
55
 
# File 'lib/poise/resource.rb', line 50

def poise_subresource_container(namespace=nil, default=nil)
  include Poise::Helpers::Subresources::Container
  # false is a valid value.
  container_namespace(namespace) unless namespace.nil?
  container_default(default) unless default.nil?
end