Class: PuppetLibrary::Util::ConfigApi

Inherits:
Object
  • Object
show all
Defined in:
lib/puppet_library/util/config_api.rb

Defined Under Namespace

Classes: Config, Param

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(owner) ⇒ ConfigApi

Returns a new instance of ConfigApi.



26
27
28
29
 
# File 'lib/puppet_library/util/config_api.rb', line 26

def initialize(owner)
    @owner = owner
    @params = []
end

Class Method Details

.for(owner, &block) ⇒ Object 



22
23
24
 
# File 'lib/puppet_library/util/config_api.rb', line 22

def self.for(owner, &block)
    Docile.dsl_eval(ConfigApi.new(owner), &block)
end

Instance Method Details

#configure(&block) ⇒ Object 



31
32
33
34
35
36
 
# File 'lib/puppet_library/util/config_api.rb', line 31

def configure(&block)
    config_api = config_class.new
    Docile.dsl_eval(config_api, &block)
    config_api.validate!
    config_api
end

#param(name, description, required, process) ⇒ Object 



42
43
44
 
# File 'lib/puppet_library/util/config_api.rb', line 42

def param(name, description, required, process)
    @params << Param.new(name, description, required, process)
end

#required(name, description, &process) ⇒ Object 



38
39
40
 
# File 'lib/puppet_library/util/config_api.rb', line 38

def required(name, description, &process)
    param(name, description, true, process)
end