Module: Puppet::Interface::ActionManager

Included in:
Puppet::Interface, Puppet::Interface
Defined in:
lib/puppet/interface/action_manager.rb

Overview

This class is not actually public API, but the method action is public when used as part of the Faces DSL (i.e. from within a define block).

Instance Method Summary collapse

Instance Method Details

#action(name, {|| block}) ⇒ void

This method returns an undefined value.

Defines a new action. This takes a block to build the action using the methods on Puppet::Interface::ActionBuilder.



18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/puppet/interface/action_manager.rb', line 18

def action(name, &block)
  @actions ||= {}
  Puppet.warning "Redefining action #{name} for #{self}" if action?(name)

  action = Puppet::Interface::ActionBuilder.build(self, name, &block)

  # REVISIT: (#18042) doesn't this mean we can't redefine the default action? -- josh
  if action.default and current = get_default_action
    raise "Actions #{current.name} and #{name} cannot both be default"
  end

  @actions[action.name] = action
end

#action?(name) ⇒ Boolean

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. 



98
99
100
 
# File 'lib/puppet/interface/action_manager.rb', line 98

def action?(name)
  actions.include?(name.to_sym)
end

#actions ⇒ Array<Symbol>

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 list of available actions for this face.



47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/puppet/interface/action_manager.rb', line 47

def actions
  @actions ||= {}
  result = @actions.keys

  if self.is_a?(Class) and superclass.respond_to?(:actions)
    result += superclass.actions
  elsif self.class.respond_to?(:actions)
    result += self.class.actions
  end
  # We need to uniq the result, because we duplicate actions when they are
  # fetched to ensure that they have the correct bindings; they shadow the
  # parent, and uniq implements that. --daniel 2011-06-01
  result.uniq.sort
end

#get_action(name) ⇒ Puppet::Interface::Action

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.

Retrieves a named action



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/puppet/interface/action_manager.rb', line 66

def get_action(name)
  @actions ||= {}
  result = @actions[name.to_sym]
  if result.nil?
    if self.is_a?(Class) and superclass.respond_to?(:get_action)
      found = superclass.get_action(name)
    elsif self.class.respond_to?(:get_action)
      found = self.class.get_action(name)
    end

    if found then
      # This is not the nicest way to make action equivalent to the Ruby
      # Method object, rather than UnboundMethod, but it will do for now,
      # and we only have to make this change in *one* place. --daniel 2011-04-12
      result = @actions[name.to_sym] = found.__dup_and_rebind_to(self)
    end
  end
  return result
end

#get_default_action ⇒ Puppet::Interface::Action

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.

Retrieves the default action for the face



89
90
91
92
93
94
95
 
# File 'lib/puppet/interface/action_manager.rb', line 89

def get_default_action
  default = actions.map {|x| get_action(x) }.select {|x| x.default }
  if default.length > 1
    raise "The actions #{default.map(&:name).join(", ")} cannot all be default"
  end
  default.first
end

#script(name, &block) ⇒ Object

Deprecated.

Defines an action without using ActionBuilder. The block given is the code that will be executed when the action is invoked.



36
37
38
39
40
41
42
 
# File 'lib/puppet/interface/action_manager.rb', line 36

def script(name, &block)
  @actions ||= {}
  Puppet.warning "Redefining action #{name} for #{self}" if action?(name)

  # REVISIT: (#18048) it's possible to create multiple default actions
  @actions[name] = Puppet::Interface::Action.new(self, name, :when_invoked => block)
end