public
Description: A simple class based Config mechanism, similar to the one found in Chef
Homepage: http://www.opscode.com
Clone URL: git://github.com/opscode/mixlib-config.git
name age message
file .gitignore Mon May 11 21:06:48 -0700 2009 Convert mixlib-config to jeweler Add interna... [fujin]
file LICENSE Wed Mar 11 18:11:34 -0700 2009 Initial commit [adamhjk]
file NOTICE Wed Mar 11 18:11:34 -0700 2009 Initial commit [adamhjk]
file README.rdoc Wed Mar 11 18:11:34 -0700 2009 Initial commit [adamhjk]
file Rakefile Mon May 18 11:57:54 -0700 2009 catch up to master & add internal_set to config [Christopher Brown]
file VERSION.yml Tue Aug 25 07:28:42 -0700 2009 Version bump to 1.0.12 [fujin]
directory features/ Mon May 11 21:06:48 -0700 2009 Convert mixlib-config to jeweler Add interna... [fujin]
directory lib/ Mon Aug 24 15:14:13 -0700 2009 added config_attr_writer [Christopher Brown]
file mixlib-config.gemspec Tue Aug 25 07:28:43 -0700 2009 Regenerated gemspec for version 1.0.12 [fujin]
directory spec/ Mon Aug 24 15:14:13 -0700 2009 added config_attr_writer [Christopher Brown]
README.rdoc

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!