1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
# frozen_string_literal: true
# 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
class Puppet::Interface::ActionBuilder
extend Forwardable
# The action under construction
# @return [Puppet::Interface::Action]
# @api private
attr_reader :action
# Builds a new action.
# @return [Puppet::Interface::Action]
# @api private
def self.build(face, name, &block)
raise "Action #{name.inspect} must specify a block" unless block
new(face, name, &block).action
end
# Deprecates the action
# @return [void]
# @api private
# @dsl Faces
def deprecate
@action.deprecate
end
# Ideally the method we're defining here would be added to the action, and a
# method on the face would defer to it, but we can't get scope correct, so
# we stick with this. --daniel 2011-03-24
# 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
def when_invoked(&block)
@action.when_invoked = block
end
# 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
def when_rendering(type = nil, &block)
if type.nil? then # the default error message sucks --daniel 2011-04-18
# TRANSLATORS 'when_rendering' is a method name and should not be translated
raise ArgumentError, _('You must give a rendering format to when_rendering')
end
if block.nil? then
# TRANSLATORS 'when_rendering' is a method name and should not be translated
raise ArgumentError, _('You must give a block to when_rendering')
end
@action.set_rendering_method_for(type, block)
end
# 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
def option(*declaration, &block)
option = Puppet::Interface::OptionBuilder.build(@action, *declaration, &block)
@action.add_option(option)
end
# Set this as the default action for the face.
# @api public
# @dsl Faces
# @return [void]
def default(value = true)
@action.default = !!value
end
# @api private
def display_global_options(*args)
@action.add_display_global_options args
end
alias :display_global_option :display_global_options
# Sets the default rendering format
# @api private
def render_as(value = nil)
if value.nil?
# TRANSLATORS 'render_as' is a method name and should not be translated
raise ArgumentError, _("You must give a rendering format to render_as")
end
formats = Puppet::Network::FormatHandler.formats
unless formats.include? value
raise ArgumentError, _("%{value} is not a valid rendering format: %{formats_list}") %
{ value: value.inspect, formats_list: formats.sort.join(", ") }
end
@action.render_as = value
end
# Metaprogram the simple DSL from the target class.
Puppet::Interface::Action.instance_methods.grep(/=$/).each do |setter|
next if setter =~ /^=/
property = setter.to_s.chomp('=')
unless method_defined? property
# ActionBuilder#<property> delegates to Action#<setter>
def_delegator :@action, setter, property
end
end
private
def initialize(face, name, &block)
@face = face
@action = Puppet::Interface::Action.new(face, name)
instance_eval(&block)
unless @action.when_invoked
# TRANSLATORS 'when_invoked' is a method name and should not be translated and 'block' is a Ruby code block
raise ArgumentError, _("actions need to know what to do when_invoked; please add the block")
end
end
end
|
