Sha256: a3b04f9150399ff83e0e489918698a6725ee37d7b389a2b82e41d0fe908c8d10

Contents?: true

Size: 1.13 KB

Versions: 11

Compression:

Stored size: 1.13 KB

Contents

== Mixlib::Config

Mixlib::Config provides a class-based configuration object, like the one used in Chef.  To use in your project:

  require 'rubygems'
  require 'mixlib/config'
  
  class MyConfig
    extend(Mixlib::Config)
    configure do |c|
      c[:first_value] = 'something'
      c[:other_value] = 'something_else'
    end
  end
  
Or...

  class MyConfig
    extend(Mixlib::Config)
    
    first_value 'something'
    other_value 'something_else'
  end
  
To check a configuration variable:

  MyConfig.first_value   # returns 'something'
  MyConfig[:first_value] # returns 'something'
  
To change a configuration variable at runtime:

  MyConfig.first_value('foobar')    # sets first_value to 'foobar'
  MyConfig[:first_value] = 'foobar' # sets first_value to 'foobar' 
  
You should populate your class with the default values for every configuration variable that might be accessed. If you try and access a variable that does not exist, Mixlib::Config will throw an <ArgumentError>.

To load a ruby configuration file (which will evaluate in the context of your configuration class):

  MyConfig.from_file('your_config_file.rb')
  
Enjoy!

Version data entries

11 entries across 11 versions & 2 rubygems

Version Path
opscode-mixlib-config-1.0.10 README.rdoc
opscode-mixlib-config-1.0.11 README.rdoc
opscode-mixlib-config-1.0.6 README.rdoc
opscode-mixlib-config-1.0.7 README.rdoc
opscode-mixlib-config-1.0.8 README.rdoc
opscode-mixlib-config-1.0.9 README.rdoc
mixlib-config-1.1.2 README.rdoc
mixlib-config-1.1.2.rc01 README.rdoc
mixlib-config-1.1.0.rc01 README.rdoc
mixlib-config-1.1.0 README.rdoc
mixlib-config-1.0.12 README.rdoc