Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A simple class based Config mechanism, similar to the one found in Chef

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 features
Octocat-spinner-32 lib
Octocat-spinner-32 spec
Octocat-spinner-32 .gitignore
Octocat-spinner-32 LICENSE
Octocat-spinner-32 NOTICE
Octocat-spinner-32 README.rdoc
Octocat-spinner-32 Rakefile
Octocat-spinner-32 VERSION.yml
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>.

You can also configure defaults:

class MyConfig
  extend(Mixlib::Config)
  configure_defaults do |c|
    c[:first_value] = 'something'
  end
end

MyConfig.first_value   # returns 'something'
MyConfig.first_value('foobar')    # sets first_value to 'foobar'
MyConfig.first_value   # returns 'foobar'
MyConfig.defaults!
MyConfig.first_value   # returns 'something'

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

MyConfig.from_file('your_config_file.rb')

Enjoy!

Something went wrong with that request. Please try again.