class Puppet::Interface::ActionBuilder

This class is used to build {Puppet::Interface::Action actions}. When an action is defined with {Puppet::Interface::ActionManager#action} the block is evaluated within the context of a new instance of this class. @api public

Attributes

action[R]

The action under construction @return [Puppet::Interface::Action] @api private

Public Class Methods

build(face, name, &block) click to toggle source

Builds a new action. @return [Puppet::Interface::Action] @api private

   # File lib/puppet/interface/action_builder.rb
16 def self.build(face, name, &block)
17   raise "Action #{name.inspect} must specify a block" unless block
18   new(face, name, &block).action
19 end

new(face, name, &block) click to toggle source

    # File lib/puppet/interface/action_builder.rb
158 def initialize(face, name, &block)
159   @face   = face
160   @action = Puppet::Interface::Action.new(face, name)
161   instance_eval(&block)
162   unless @action.when_invoked
163     #TRANSLATORS 'when_invoked' is a method name and should not be translated and 'block' is a Ruby code block
164     raise ArgumentError, _("actions need to know what to do when_invoked; please add the block")
165   end
166 end

Public Instance Methods

default(value = true) click to toggle source

Set this as the default action for the face. @api public @dsl Faces @return [void]

    # File lib/puppet/interface/action_builder.rb
112 def default(value = true)
113   @action.default = !!value
114 end

deprecate() click to toggle source

Deprecates the action @return [void] @api private @dsl Faces

   # File lib/puppet/interface/action_builder.rb
25 def deprecate
26   @action.deprecate
27 end

display_global_option(*args)

Alias for: display_global_options

display_global_options(*args) click to toggle source

@api private

    # File lib/puppet/interface/action_builder.rb
117 def display_global_options(*args)
118   @action.add_display_global_options args
119 end

Also aliased as: display_global_option

option(*declaration, &block) click to toggle source

Declare that this action can take a specific option, and provide the code to do so. One or more strings are given, in the style of OptionParser (see example). These strings are parsed to derive a name for the option. Any `-` characters within the option name (ie excluding the initial `-` or `–` for an option) will be translated to `_`.The first long option will be used as the name, and the rest are retained as aliases. The original form of the option is used when invoking the face, the translated form is used internally.

When the action is invoked the value of the option is available in a hash passed to the {Puppet::Interface::ActionBuilder#when_invoked when_invoked} block, using the option name in symbol form as the hash key.

The block to this method is used to set attributes for the option (see {Puppet::Interface::OptionBuilder}).

@param declaration [String] Option declarations, as described above

and in the example.

@example Say hi

action :say_hi do
  option "-u USER", "--user-name USER" do
    summary "Who to say hi to"
  end

  when_invoked do |options|
    "Hi, #{options[:user_name]}"
  end
end

@api public @dsl Faces

    # File lib/puppet/interface/action_builder.rb
103 def option(*declaration, &block)
104   option = Puppet::Interface::OptionBuilder.build(@action, *declaration, &block)
105   @action.add_option(option)
106 end

render_as(value = nil) click to toggle source

Sets the default rendering format @api private

    # File lib/puppet/interface/action_builder.rb
124 def render_as(value = nil)
125   if value.nil?
126     #TRANSLATORS 'render_as' is a method name and should not be translated
127     raise ArgumentError, _("You must give a rendering format to render_as")
128   end
129 
130   formats = Puppet::Network::FormatHandler.formats
131   unless formats.include? value
132     raise ArgumentError, _("%{value} is not a valid rendering format: %{formats_list}") %
133         { value: value.inspect, formats_list: formats.sort.join(", ")}
134   end
135 
136   @action.render_as = value
137 end

when_invoked(&block) click to toggle source

Sets what the action does when it is invoked. This takes a block which will be called when the action is invoked. The action will accept arguments based on the arity of the block. It should always take at least one argument for options. Options will be the last argument.

@overload when_invoked({|options| … })

An action with no arguments

@overload when_invoked({|arg1, arg2, options| … })

An action with two arguments

@return [void] @api public @dsl Faces

   # File lib/puppet/interface/action_builder.rb
46 def when_invoked(&block)
47   @action.when_invoked = block
48 end

when_rendering(type = nil, &block) click to toggle source

Sets a block to be run at the rendering stage, for a specific rendering type (eg JSON, YAML, console), after the block for when_invoked gets run. This manipulates the value returned by the action. It makes it possible to work around limitations in the underlying object returned, and should be avoided in favor of returning a more capable object. @api private @todo this needs more @dsl Faces

   # File lib/puppet/interface/action_builder.rb
59 def when_rendering(type = nil, &block)
60   if type.nil? then           # the default error message sucks --daniel 2011-04-18
61     #TRANSLATORS 'when_rendering' is a method name and should not be translated
62     raise ArgumentError, _('You must give a rendering format to when_rendering')
63   end
64   if block.nil? then
65     #TRANSLATORS 'when_rendering' is a method name and should not be translated
66     raise ArgumentError, _('You must give a block to when_rendering')
67   end
68   @action.set_rendering_method_for(type, block)
69 end