ActiveSupport::OrderedOptions (original) (raw)

Ordered Options

OrderedOptions inherits from Hash and provides dynamic accessor methods.

With a Hash, key-value pairs are typically managed like this:

h = {}
h[:boy] = 'John'
h[:girl] = 'Mary'
h[:boy]  # => 'John'
h[:girl] # => 'Mary'
h[:dog]  # => nil

Using OrderedOptions, the above code can be written as:

h = ActiveSupport::OrderedOptions.new
h.boy = 'John'
h.girl = 'Mary'
h.boy  # => 'John'
h.girl # => 'Mary'
h.dog  # => nil

To raise an exception when the value is blank, append a bang to the key name, like:

h.dog! # => raises KeyError: :dog is blank

Methods

• [],
• []=,
• _get

D

• dig

E

• extractable_options?

I

• inspect

M

• method_missing

R

• respond_to_missing?

Instance Public methods

[]=(key, value)Link

Source: show | on GitHub

def []=(key, value) super(key.to_sym, value) end

dig(key, *identifiers)Link

Source: show | on GitHub

def dig(key, *identifiers) super(key.to_sym, *identifiers) end

inspect()Link

Source: show | on GitHub

def inspect "#<#{self.class.name} #{super}>" end

method_missing(method, *args)Link

Source: show | on GitHub

def method_missing(method, *args) if method.end_with?("=") self[method.name.chomp("=")] = args.first elsif method.end_with?("!") name_string = method.name.chomp("!") self[name_string].presence || raise(KeyError.new(":#{name_string} is blank")) else self[method.name] end end

respond_to_missing?(name, include_private)Link

Source: show | on GitHub

def respond_to_missing?(name, include_private) true end