Included Modules

Files

Class/Module Index [+]

Quicksearch

Chef::Resource::Template

Attributes

inline_helper_blocks[R]
inline_helper_modules[R]

Public Class Methods

new(name, run_context=nil) click to toggle source
# File lib/chef/resource/template.rb, line 35
def initialize(name, run_context=nil)
  super
  @resource_name = :template
  @action = "create"
  @source = "#{::File.basename(name)}.erb"
  @cookbook = nil
  @local = false
  @variables = Hash.new
  @provider = Chef::Provider::Template
  @inline_helper_blocks = {}
  @inline_helper_modules = []
  @helper_modules = []
end

Public Instance Methods

cookbook(args=nil) click to toggle source
# File lib/chef/resource/template.rb, line 65
def cookbook(args=nil)
  set_or_return(
    :cookbook,
    args,
    :kind_of => [ String ]
  )
end
helper(method_name, &block) click to toggle source

Declares a helper method to be defined in the template context when rendering.

Example:

Basic usage:

Given the following helper:

helper(:static_value) { "hello from helper" }

A template with the following code:

<%= static_value %>

Will render as;

hello from helper

Referencing Instance Variables:

Any instance variables available to the template can be referenced in the method body. For example, you can simplify accessing app-specific node attributes like this:

helper(:app) { @node[:my_app_attributes] }

And use it in a template like this:

<%= app[:listen_ports] %>

This is equivalent to the non-helper template code:

<%= @node[:my_app_attributes][:listen_ports] %>

Method Arguments:

Helper methods can also take arguments. The syntax available for argument specification will be dependent on ruby version. Ruby 1.8 only supports a subset of the argument specification syntax available for method definition, whereas 1.9 supports the full syntax.

Continuing the above example of simplifying attribute access, we can define a helper to look up app-specific attributes like this:

helper(:app) { |setting| @node[:my_app_attributes][setting] }

The template can then look up attributes like this:

<%= app(:listen_ports) %>
# File lib/chef/resource/template.rb, line 115
def helper(method_name, &block)
  unless block_given?
    raise Exceptions::ValidationFailed,
      "`helper(:method)` requires a block argument (e.g., `helper(:method) { code }`)"
  end

  unless method_name.kind_of?(Symbol)
    raise Exceptions::ValidationFailed,
      "method_name argument to `helper(method_name)` must be a symbol (e.g., `helper(:method) { code }`)"
  end

  @inline_helper_blocks[method_name] = block
end
helper_modules() click to toggle source

Compiles all helpers from inline method definitions, inline module definitions, and external modules into an Array of Modules. The context object for the template is extended with these modules to provide per-resource template logic.

# File lib/chef/resource/template.rb, line 192
def helper_modules
  compiled_helper_methods + compiled_helper_modules + @helper_modules
end
helpers(module_name=nil,&block) click to toggle source

Declares a module to define helper methods in the template’s context when rendering. There are two primary forms.

Inline Module Definition

When a block is given, the block is used to define a module which is then mixed in to the template context w/ `extend`.

Inline Module Example

Given the following code in the template resource:

helpers do
  # Add "syntax sugar" for referencing app-specific attributes
  def app(attribute)
    @node[:my_app_attributes][attribute]
  end
end

You can use it in the template like so:

<%= app(:listen_ports) %>

Which is equivalent to:

<%= @node[:my_app_attributes][:listen_ports] %>

External Module Form

When a module name is given, the template context will be extended with that module. This is the recommended way to customize template contexts when you need to define more than an handful of helper functions (but also try to keep your template helpers from getting out of hand–if you have very complex logic in your template helpers, you should further extract your code into separate libraries).

External Module Example

To extract the above inline module code to a library, you’d create a library file like this:

module MyTemplateHelper
  # Add "syntax sugar" for referencing app-specific attributes
  def app(attribute)
    @node[:my_app_attributes][attribute]
  end
end

And in the template resource:

helpers(MyTemplateHelper)

The template code in the above example will work unmodified.

# File lib/chef/resource/template.rb, line 169
def helpers(module_name=nil,&block)
  if block_given? and !module_name.nil?
    raise Exceptions::ValidationFailed,
      "Passing both a module and block to #helpers is not supported. Call #helpers multiple times instead"
  elsif block_given?
    @inline_helper_modules << block
  elsif module_name.kind_of?(::Module)
    @helper_modules << module_name
  elsif module_name.nil?
    raise Exceptions::ValidationFailed,
      "#helpers requires either a module name or inline module code as a block.\n" +
      "e.g.: helpers do; helper_code; end;\n" +
      "OR: helpers(MyHelpersModule)"
  else
    raise Exceptions::ValidationFailed,
      "Argument to #helpers must be a module. You gave #{module_name.inspect} (#{module_name.class})"
  end
end
local(args=nil) click to toggle source
# File lib/chef/resource/template.rb, line 73
def local(args=nil)
  set_or_return(
    :local,
    args,
    :kind_of => [ TrueClass, FalseClass ]
  )
end
source(file=nil) click to toggle source
# File lib/chef/resource/template.rb, line 49
def source(file=nil)
  set_or_return(
    :source,
    file,
    :kind_of => [ String ]
  )
end
variables(args=nil) click to toggle source
# File lib/chef/resource/template.rb, line 57
def variables(args=nil)
  set_or_return(
    :variables,
    args,
    :kind_of => [ Hash ]
  )
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.