Method: Mongoid::Config::Options#option

Defined in:
lib/mongoid/config/options.rb

#option(name, options = {}) ⇒ Object

Define a configuration option with a default.

Examples:

Define the option.

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

Parameters:

  • The name of the configuration option.

  • (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