Module: Mongoid::Config::Options

Included in:
Mongoid::Config
Defined in:
lib/mongoid/config/options.rb

Overview

Encapsulates logic for setting options.

Instance Method Summary collapse

Instance Method Details

#defaults ⇒ Hash

Get the defaults or initialize a new empty hash.

Examples:

Get the defaults.

options.defaults

Returns:

  • (Hash) —

    The default options.



16
17
18
 
# File 'lib/mongoid/config/options.rb', line 16

def defaults
  @defaults ||= {}
end

#log_level ⇒ Integer

Get the log level.

Examples:

Get the log level.

config.log_level

Returns:

  • (Integer) —

    The log level.



83
84
85
86
87
88
89
90
91
 
# 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 = {}) ⇒ Object

Define a configuration option with a default.

Examples:

Define the option.

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

Parameters:

  • name (Symbol) —

    The name of the configuration option.

  • options (Hash) (defaults to: {}) —

    Extras for the option.

Options Hash (options):

  • :default (Object) —

    The default value.

  • :on_change (Proc | nil) —

    The callback to invoke when the setter is invoked.



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# 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 ⇒ Hash

Reset the configuration options to the defaults.

Examples:

Reset the configuration options.

config.reset

Returns:

  • (Hash) —

    The defaults.



59
60
61
62
63
64
65
 
# 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 ⇒ Hash

Get the settings or initialize a new empty hash.

Examples:

Get the settings.

options.settings

Returns:

  • (Hash) —

    The setting options.



73
74
75
 
# File 'lib/mongoid/config/options.rb', line 73

def settings
  @settings ||= {}
end