Class: Puppet::Parameter

Inherits:

Object

• Object
• Puppet::Parameter

show all

Extended by:

Util, Util::Docs

Includes:

Util, Util::Errors, Util::LogPaths, Util::Logging, Util::MethodHelper

Defined in:

lib/puppet/parameter.rb

Overview

Defined Under Namespace

Classes: Value, ValueCollection

Constant Summary

Class Attribute Summary (collapse)

• + (Object) munger readonly private

  Unused?.

• + (Array<Symbol>) required_features DSL readonly

  The names of the provider features required for this parameter to work.

• + (Object) validater readonly private

  Unused?.

• + (Puppet::Parameter::ValueCollection) value_collection readonly private

  The set of valid values (or an empty set that accepts any value).

Instance Attribute Summary (collapse)

• - (Puppet::Parameter) parent private

  A reference to the parameter’s parent kept for backwards compatibility.

Class Method Summary (collapse)

• + (Object) aliasvalue(name, other) DSL

  Makes the given name an alias for the given other name.

• + defaultto(value = nil, &block) DSL

  Defines how the default value of a parameter is computed.

• + (String) desc(str) DSL

  Sets the documentation for this parameter.

• + (String) doc

  Produces a documentation string.

• + initvars private

  Initializes the instance variables.

• + isnamevar DSL

  Sets a marker indicating that this parameter is the namevar (unique identifier) of the type where the parameter is contained.

• + (Boolean) isnamevar?

  Returns whether this parameter is the namevar or not.

• + isrequired DSL

  Sets a marker indicating that this parameter is required.

• + (Object) munge({|| ... }) DSL

  Defines an optional method used to convert the parameter value from DSL/string form to an internal form.

• + newvalues(*names) DSL

  Defines valid values for the parameter (enumeration or regular expressions).

• + nodefault DSL

  Removes the default method if defined.

• + (Object) proxymethods(*values) private

  Creates instance (proxy) methods that delegates to a class method with the same name.

• + (Boolean) required?

  Returns whether this parameter is required or not.

• + (Object) unmunge({|| ... }) DSL

  Defines an optional method used to convert the parameter value to DSL/string form from an internal form.

• + validate({|| ... }) DSL

  Defines an optional method that is used to validate the parameter’s value.

Instance Method Summary (collapse)

• - (Parameter) initialize(options = {}) constructor

  Initializes the parameter with a required resource reference and optional attribute settings.

• - (Boolean) isnamevar?

  Returns whether this parameter is the namevar or not.

• - log(msg)

  Writes the given msg to the log with the loglevel indicated by the associated resource’s loglevel parameter.

• - (Object) pathbuilder private
• - (Boolean) required?

  Returns whether this parameter is required or not.

• - (Object) unsafe_munge(value) private

  This is the default implementation of munge that simply produces the value (if it is valid).

• - unsafe_validate(value) private

  This is the default implementation of validate that may be overridden by the DSL method Parameter.validate.

• - validate(value)

  Performs validation of the given value against the rules defined by this parameter.

Methods included from Util

exit_on_fail, exit_on_fail, which, which

329
330
331
332
333
334
335
336
337
338
339

# File 'lib/puppet/parameter.rb', line 329

def initialize(options = {})
  options = symbolize_options(options)
  if resource = options[:resource]
    self.resource = resource
    options.delete(:resource)
  else
    raise Puppet::DevError, "No resource set for #{self.class.name}"
  end

  set_options(options)
end

46
47
48

# File 'lib/puppet/parameter.rb', line 46

def munger
  @munger
end

74
75
76

# File 'lib/puppet/parameter.rb', line 74

def required_features
  @required_features
end

39
40
41

# File 'lib/puppet/parameter.rb', line 39

def validater
  @validater
end

79
80
81

# File 'lib/puppet/parameter.rb', line 79

def value_collection
  @value_collection
end

304
305
306

# File 'lib/puppet/parameter.rb', line 304

def parent
  @parent
end

274
275
276

# File 'lib/puppet/parameter.rb', line 274

def aliasvalue(name, other)
  @value_collection.aliasvalue(name, other)
end

99
100
101
102
103
104
105
106
107
108
109

# File 'lib/puppet/parameter.rb', line 99

def defaultto(value = nil, &block)
  if block
    define_method(:default, &block)
  else
    if value.nil?
      raise Puppet::DevError,
        "Either a default value or block must be provided"
    end
    define_method(:default) do value end
  end
end

154
155
156

# File 'lib/puppet/parameter.rb', line 154

def desc(str)
  @doc = str
end

117
118
119
120
121
122
123
124
125
126
127
128
129
130

# File 'lib/puppet/parameter.rb', line 117

def doc
  @doc ||= ""

  unless defined?(@addeddocvals)
    @doc += value_collection.doc

    if f = self.required_features
      @doc += "  Requires features #{f.flatten.collect { |f| f.to_s }.join(" ")}."
    end
    @addeddocvals = true
  end

  @doc
end

163
164
165

# File 'lib/puppet/parameter.rb', line 163

def initvars
  @value_collection = ValueCollection.new
end

202
203
204
205

# File 'lib/puppet/parameter.rb', line 202

def isnamevar
  @isnamevar = true
  @required = true
end

210
211
212

# File 'lib/puppet/parameter.rb', line 210

def isnamevar?
  @isnamevar
end

220
221
222

# File 'lib/puppet/parameter.rb', line 220

def isrequired
  @required = true
end

175
176
177
178
179
180
181

# File 'lib/puppet/parameter.rb', line 175

def munge(&block)
  # I need to wrap the unsafe version in begin/rescue parameterments,
  # but if I directly call the block then it gets bound to the
  # class's context, not the instance's, thus the two methods,
  # instead of just one.
  define_method(:unsafe_munge, &block)
end

263
264
265

# File 'lib/puppet/parameter.rb', line 263

def newvalues(*names)
  @value_collection.newvalues(*names)
end

143
144
145

# File 'lib/puppet/parameter.rb', line 143

def nodefault
  undef_method :default if public_method_defined? :default
end

282
283
284
285
286
287
288

# File 'lib/puppet/parameter.rb', line 282

def self.proxymethods(*values)
  values.each { |val|
    define_method(val) do
      self.class.send(val)
    end
  }
end

239
240
241

# File 'lib/puppet/parameter.rb', line 239

def required?
  @required
end

191
192
193

# File 'lib/puppet/parameter.rb', line 191

def unmunge(&block)
  define_method(:unmunge, &block)
end

250
251
252

# File 'lib/puppet/parameter.rb', line 250

def validate(&block)
  define_method(:unsafe_validate, &block)
end

295

# File 'lib/puppet/parameter.rb', line 295

proxymethods("required?", "isnamevar?")

346
347
348

# File 'lib/puppet/parameter.rb', line 346

def log(msg)
  send_log(resource[:loglevel], msg)
end

382
383
384
385
386
387
388

# File 'lib/puppet/parameter.rb', line 382

def pathbuilder
  if @resource
    return [@resource.pathbuilder, self.name]
  else
    return [self.name]
  end
end

295

# File 'lib/puppet/parameter.rb', line 295

proxymethods("required?", "isnamevar?")

395
396
397

# File 'lib/puppet/parameter.rb', line 395

def unsafe_munge(value)
  self.class.value_collection.munge(value)
end

436
437
438

# File 'lib/puppet/parameter.rb', line 436

def unsafe_validate(value)
  self.class.value_collection.validate(value)
end

448
449
450
451
452
453
454
455
456
457
458

# File 'lib/puppet/parameter.rb', line 448

def validate(value)
  begin
    unsafe_validate(value)
  rescue ArgumentError => detail
    fail detail.to_s
  rescue Puppet::Error, TypeError
    raise
  rescue => detail
    raise Puppet::DevError, "Validate method failed for class #{self.name}: #{detail}", detail.backtrace
  end
end