Class: Puppet::Interface::Option
Overview
Instance Attribute Summary collapse
Instance Method Summary
collapse
Methods included from TinyDocs
#build_synopsis, #description, #summary
Methods included from DocGen
#attr_doc, strip_whitespace
Constructor Details
#initialize(parent, *declaration, &block) ⇒ Option
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 a new instance of Option.
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
|
# File 'lib/puppet/interface/option.rb', line 12
def initialize(parent, *declaration, &block)
@parent = parent
@optparse = []
@default = nil
dups = {}
declaration.each do |item|
if item.is_a? String and item.to_s =~ /^-/ then
unless item =~ /^-[a-z]\b/ or item =~ /^--[^-]/ then
raise ArgumentError, _("%{option}: long options need two dashes (--)") % { option: item.inspect }
end
@optparse << item
name = optparse_to_optionname(item)
if Puppet.settings.include? name then
raise ArgumentError, _("%{option}: already defined in puppet") % { option: item.inspect }
end
dup = dups[name]
if dup
raise ArgumentError, _("%{option}: duplicates existing alias %{duplicate} in %{parent}") %
{ option: item.inspect, duplicate: dup.inspect, parent: @parent }
else
dups[name] = item
end
else
raise ArgumentError, _("%{option} is not valid for an option argument") % { option: item.inspect }
end
end
if @optparse.empty? then
raise ArgumentError, _("No option declarations found while building")
end
@name = optparse_to_name(@optparse.find do |a| a =~ /^--/ end || @optparse.first)
@aliases = @optparse.map { |o| optparse_to_name(o) }
@argument = @optparse.any? { |o| o =~ /[ =]/ }
if @argument and not @optparse.all? { |o| o =~ /[ =]/ } then
raise ArgumentError, _("Option %{name} is inconsistent about taking an argument") % { name: @name }
end
@optional_argument = @optparse.any? { |o| o=~/[ =]\[/ }
if @optional_argument
raise ArgumentError, _("Options with optional arguments are not supported")
end
if @optional_argument and not @optparse.all? { |o| o=~/[ =]\[/ } then
raise ArgumentError, _("Option %{name} is inconsistent about the argument being optional") % { name: @name }
end
end
|
Instance Attribute Details
#after_action ⇒ Object
155
156
157
|
# File 'lib/puppet/interface/option.rb', line 155
def after_action
@after_action
end
|
136
137
138
|
# File 'lib/puppet/interface/option.rb', line 136
def aliases
@aliases
end
|
#before_action ⇒ Object
144
145
146
|
# File 'lib/puppet/interface/option.rb', line 144
def before_action
@before_action
end
|
136
137
138
|
# File 'lib/puppet/interface/option.rb', line 136
def name
@name
end
|
136
137
138
|
# File 'lib/puppet/interface/option.rb', line 136
def optparse
@optparse
end
|
136
137
138
|
# File 'lib/puppet/interface/option.rb', line 136
def parent
@parent
end
|
136
137
138
|
# File 'lib/puppet/interface/option.rb', line 136
def required
@required
end
|
Instance Method Details
#__decoration_name(type) ⇒ Object
166
167
168
169
170
171
172
|
# File 'lib/puppet/interface/option.rb', line 166
def __decoration_name(type)
if @parent.is_a? Puppet::Interface::Action then
:"option #{name} from #{parent.name} #{type} decoration"
else
:"option #{name} #{type} decoration"
end
end
|
132
133
134
|
# File 'lib/puppet/interface/option.rb', line 132
def default
@default and @default.call
end
|
#default=(proc) ⇒ Object
120
121
122
123
124
125
126
127
128
129
130
|
# File 'lib/puppet/interface/option.rb', line 120
def default=(proc)
if required
raise ArgumentError, _("%{name} can't be optional and have a default value") % { name: self }
end
unless proc.is_a? Proc
raise ArgumentError, _("default value for %{name} is a %{class_name}, not a proc") %
{ name: self, class_name: proc.class.name.inspect }
end
@default = proc
end
|
#has_default? ⇒ Boolean
116
117
118
|
# File 'lib/puppet/interface/option.rb', line 116
def has_default?
!!@default
end
|
#optional_argument? ⇒ Boolean
109
110
111
|
# File 'lib/puppet/interface/option.rb', line 109
def optional_argument?
!!@optional_argument
end
|
#optparse_to_name(declaration) ⇒ Object
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.
97
98
99
100
101
102
103
|
# File 'lib/puppet/interface/option.rb', line 97
def optparse_to_name(declaration)
name = optparse_to_optionname(declaration).tr('-', '_')
unless name.to_s =~ /^[a-z]\w*$/
raise _("%{name} is an invalid option name") % { name: name.inspect }
end
name.to_sym
end
|
#optparse_to_optionname(declaration) ⇒ Object
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.
88
89
90
91
92
93
94
|
# File 'lib/puppet/interface/option.rb', line 88
def optparse_to_optionname(declaration)
found = declaration.match(/^-+(?:\[no-\])?([^ =]+)/)
unless found
raise ArgumentError, _("Can't find a name in the declaration %{declaration}") % { declaration: declaration.inspect }
end
found.captures.first
end
|
#required? ⇒ Boolean
112
113
114
|
# File 'lib/puppet/interface/option.rb', line 112
def required?
!!@required
end
|
#takes_argument? ⇒ Boolean
106
107
108
|
# File 'lib/puppet/interface/option.rb', line 106
def takes_argument?
!!@argument
end
|
to_s and optparse_to_name are roughly mirrored, because they are used to transform options to name symbols, and vice-versa. This isn’t a full bidirectional transformation though. –daniel 2011-04-07
83
84
85
|
# File 'lib/puppet/interface/option.rb', line 83
def to_s
@name.to_s.tr('_', '-')
end
|