Module: HasConfiguration::ClassMethods

Defined in:

lib/has_configuration.rb

Overview

:nodoc:

Defined Under Namespace

Modules: Getter

Instance Method Summary

• #has_configuration(options = {}) ⇒ Object

  Load configuration settings from a yaml file and adds a class and an instance method configuration to the object.

Instance Method Details

#has_configuration(options = {}) ⇒ Object

Load configuration settings from a yaml file and adds a class and an instance method configuration to the object.

options

file

The yml file to load: Defaults to config/classname.yml if Rails is defined, classname.yml otherwise.

env

The environment to load from the file. Defaults to Rails.env if Rails is defined, no default if not.

Integration Examples

has_configuration
# => loads setting without environment processing from the
#    file #{self.class.name.downcase}.yml

has_configuration file: Rails.root.join('config', 'example.yml'), env: 'staging'
# => loads settings for staging environment from RAILS_ROOT/config/example.yml file

YAML File Example

The yaml file may contain defaults. Nesting is not limited. ERB in the yaml file is evaluated.

defaults: &defaults
  user: root
  some:
    nested: value

development:
  <<: *defaults
  password: secret

production:
  <<: *defaults
  password: <%= ENV[:secret] &>

Configuration Retrieval

If the example above was loaded into a class Foo in production environment:

Foo.configuration       # => <HasConfiguration::Configuration:0x00...>
Foo.new.configuration   # => <HasConfiguration::Configuration:0x00...>

# convenient getter methods
Foo.configuration.some.nested             # => "value"

# to_h returns a HashWithIndifferentAccess
Foo.configuration.to_h                    # => { :user => "root",
                                          #      :password => "prod-secret",
                                          #      :some => { :nested => "value" } }
Foo.configuration.to_h[:some][:nested]    # => "value"
Foo.configuration.to_h[:some]['nested']   # => "value"

# force a special key type (when merging with other hashes)
Foo.configuration.to_h(:symbolized)       # => { :user => "root",
                                          #      :password => "prod-secret",
                                          #      :some => { :nested => "value" } }
Foo.configuration.to_h(:stringify)        # => { 'user' => "root",
                                          #      'password' => "prod-secret",
                                          #      'some' => { 'nested' => "value" } }

# File 'lib/has_configuration.rb', line 72

def has_configuration(options = {})
  @configuration = Configuration.new(self, options)
  include Getter
end