Configatron

Configatron makes configuring your applications and scripts incredibly easy. No longer is a there a need to use constants or global variables. Now you can use a simple and painless system to configure your life. And, because it’s all Ruby, you can do any crazy thing you would like to!

Examples

Simple

configatron.email = '[email protected]'
configatron.database_url = "postgres://localhost/mack_framework_rocks"

Now, anywhere in your code you can do the following:

configatron.email # => "[email protected]"
configatron.database_url # => "postgres://localhost/mack_framework_rocks"

Viola! Simple as can be.

Now you’re saying, what if I want to have a ‘default’ set of options, but then override them later, based on other information? Simple again. Let’s use our above example. We’ve configured our database_url option to be postgres://localhost/mack_framework_rocks. The problem with that is that is our production database url, not our development url. Fair enough, all you have to do is redeclare it:

configatron.database_url = "postgres://localhost/mack_framework_rocks_development"

becomes:

configatron.email # => "[email protected]"
configatron.database_url # => "postgres://localhost/mack_framework_rocks_development"

Notice how our other configuration parameters haven’t changed? Cool, eh?

Hash/YAML

You can configure configatron from a hash as well:

configatron.configure_from_hash({:email => {:pop => {:address => 'pop.example.com', :port => 110}}, :smtp => {:address => 'smtp.example.com'}})

configatron.email.pop.address # => 'pop.example.com'
configatron.email.pop.port # => 110
# and so on...

Notice how they’re all namespaced for your as well. The same holds true for YAML files:

configuration.configure_from_yaml('/path/to/file.yml')

Namespaces

The question that should be on your lips is what I need to have namespaced configuration parameters. It’s easy! Configatron allows you to create namespaces.

configatron.website_url = "http://www.mackframework.com"
configatron.email.pop.address = "pop.example.com"
configatron.email.pop.port = 110
configatron.email.smtp.address = "smtp.example.com"
configatron.email.smtp.port = 25

becomes:

configatron.email.pop.address # => "pop.example.com"
configatron.email.smtp.address # => "smtp.example.com"
configatron.website_url # => "http://www.mackframework.com"

Configatron allows you to nest namespaces to your hearts content! Just keep going, it’s that easy.

Of course you can update a single parameter n levels deep as well:

configatron.email.pop.address = "pop2.example.com"

configatron.email.pop.address # => "pop2.example.com"
configatron.email.smtp.address # => "smtp.example.com"

Misc.

Even if parameters haven’t been set, you can still call them, but you’ll get a Configatron::Store object back. The Configatron::Store class, however, will respond true to .nil? if there are no parameters configured on it.

configatron.i.dont.exist.nil? # => true
configatron.i.dont.exist # => Configatron::Store

If you want to get back an actual nil then you can use the retrieve method:

configatron.i.do.exist = [:some, :array]
configatron.i.dont.retrieve(:exist, nil) # => nil
configatron.i.do.retrieve(:exist, :foo) # => [:some, :array]

You can set ‘default’ values for parameters. If there is already a setting, it won’t be replaced. This is useful if you’ve already done your ‘configuration’ and you call a library, that needs to have parameters set. The library can set its defaults, without worrying that it might have overridden your custom settings.

configatron.set_default(:name, 'Mark Bates')
configatron.name # => 'Mark Bates'
configatron.set_default(:name, 'Me')
configatron.name # => 'Mark Bates'

Sometimes in testing, or other situations, you want to temporarily change some settings. You can do this with the temp method:

configatron.one = 1
configatron.letters.a = 'A'
configatron.letters.b = 'B'
configatron.temp do
  configatron.letters.b = 'bb'
  configatron.letters.c = 'c'
  configatron.one # => 1
  configatron.letters.a # => 'A'
  configatron.letters.b # => 'bb'
  configatron.letters.c # => 'c'
end
configatron.one # => 1
configatron.letters.a # => 'A'
configatron.letters.b # => 'B'
configatron.letters.c # => nil

You can also pass in an optional Hash to the temp:

configatron.one = 1
configatron.letters.a = 'A'
configatron.letters.b = 'B'
configatron.temp(:letters => {:b => 'bb', :c => 'c'}) do
  configatron.one == 1
  configatron.letters.a # => 'A'
  configatron.letters.b # => 'bb'
  configatron.letters.c # => 'c'
end
configatron.one == 1
configatron.letters.a # => 'A'
configatron.letters.b # => 'B'
configatron.letters.c # => nil

Enjoy!

Contact

Please mail bugs, suggestions and patches to “[email protected]”:[email protected]

On the web at: “www.mackframework.com”:www.mackframework.com

License and Copyright

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.