module Configoro

This module handles initialization of the Configoro object, and contains some utility methods.

Public Class Methods

initialize() click to toggle source

Creates the configuration dictionary and stores it under `MyApp::Configuration` (assuming an application named `MyApp`).

# File lib/configoro/base.rb, line 9
def self.initialize
  namespace.const_set :Configuration, load_environment(Rails.env)
end

load_environment(env) click to toggle source

Loads the configuration for an environment and returns it as a {Hash}. Use this method to access Configoro options outside the context of your Rails app. You will need to configure paths first (see example).

@param [String] env The Rails environment. @return [Configoro::Hash] The configuration for that environment.

@example Accessing Configoro options outside of Rails

Configoro.paths << "#{rails_root}/config/environments"
Configoro.load_environment(rails_env) #=> { ... }

# File lib/configoro/base.rb, line 55
def self.load_environment(env)
  config = Configoro::Hash.new
  load_data config, env
  config
end

paths() click to toggle source

The search paths Configoro uses to locate configuration files. By default this list contains one item, `RAILS_ROOT/config/environments`. You can edit this list to add your own search paths. Any such paths should have subdirectories for each environment, and `common`, as expected by Configoro.

Be sure to add paths before the Configoro initializer is called (see the example).

Paths are processed in the order they appear in this array.

@return [Array<String>] An editable array of search paths.

@example Adding additional paths (application.rn)

config.before_initialize do
  Configoro.paths << '/my/custom/path'
end

# File lib/configoro/base.rb, line 30
def self.paths
  @paths ||= begin
    paths = []
    paths << "#{Rails.root}/config/environments" if defined?(Rails)
    paths
  end
end

reset_paths() click to toggle source

Resets any custom configuration paths set using {.paths}.

# File lib/configoro/base.rb, line 40
def self.reset_paths
  remove_instance_variable :@paths
end

Private Class Methods

load_data(config, env) click to toggle source

# File lib/configoro/base.rb, line 67
def self.load_data(config, env)
  paths.each do |path|
    Dir.glob("#{path}/common/*.yml").sort.each { |file| config << file }
    Dir.glob("#{path}/#{env}/*.yml").sort.each { |file| config << file }
  end
end

namespace() click to toggle source

# File lib/configoro/base.rb, line 63
def self.namespace
  Object.const_get Rails.application.class.to_s.split('::').first
end