module Mongoid::Config::Options

Encapsulates logic for setting options.

Public Instance Methods

defaults() click to toggle source

Get the defaults or initialize a new empty hash.

@example Get the defaults.

options.defaults

@return [ Hash ] The default options.

# File lib/mongoid/config/options.rb, line 16
def defaults
  @defaults ||= {}
end
log_level() click to toggle source

Get the log level.

@example Get the log level.

config.log_level

@return [ Integer ] The log level.

# File lib/mongoid/config/options.rb, line 83
def log_level
  if level = settings[:log_level]
    unless level.is_a?(Integer)
      # JRuby String#constantize does not work here.
      level = Logger.const_get(level.upcase.to_s)
    end
    level
  end
end
option(name, options = {}) click to toggle source

Define a configuration option with a default.

@example Define the option.

Options.option(:logger, :default => Logger.new(STDERR, :warn))

@param [ Symbol ] name The name of the configuration option. @param [ Hash ] options Extras for the option.

@option options [ Object ] :default The default value. @option options [ Proc | nil ] :on_change The callback to invoke when the

setter is invoked.
# File lib/mongoid/config/options.rb, line 31
def option(name, options = {})
  defaults[name] = settings[name] = options[:default]

  class_eval do
    # log_level accessor is defined specially below
    unless name.to_sym == :log_level
      define_method(name) do
        settings[name]
      end
    end

    define_method("#{name}=") do |value|
      settings[name] = value
      options[:on_change]&.call(value)
    end

    define_method("#{name}?") do
      !!send(name)
    end
  end
end
reset() click to toggle source

Reset the configuration options to the defaults.

@example Reset the configuration options.

config.reset

@return [ Hash ] The defaults.

# File lib/mongoid/config/options.rb, line 59
def reset
  # do this via the setter for each option, so that any defined on_change
  # handlers can be invoked.
  defaults.each do |setting, default|
    send(:"#{setting}=", default)
  end
end
settings() click to toggle source

Get the settings or initialize a new empty hash.

@example Get the settings.

options.settings

@return [ Hash ] The setting options.

# File lib/mongoid/config/options.rb, line 73
def settings
  @settings ||= {}
end