Class: ActiveSupport::OrderedOptions
- Defined in:
- lib/active_support/ordered_options.rb
Overview
Usually key value pairs are handled something like this:
h = {}
h[:boy] = 'John'
h[:girl] = 'Mary'
h[:boy] # => 'John'
h[:girl] # => 'Mary'
h[:dog] # => nil
Using OrderedOptions
, the above code could be reduced to:
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
Direct Known Subclasses
Instance Method Summary collapse
- #[](key) ⇒ Object
- #[]=(key, value) ⇒ Object
- #extractable_options? ⇒ Boolean
- #method_missing(name, *args) ⇒ Object
- #respond_to_missing?(name, include_private) ⇒ Boolean
Methods inherited from Hash
#as_json, #assert_valid_keys, #deep_dup, #deep_merge, #deep_merge!, #deep_stringify_keys, #deep_stringify_keys!, #deep_symbolize_keys, #deep_symbolize_keys!, #deep_transform_keys, #deep_transform_keys!, #deep_transform_values, #deep_transform_values!, #except, #except!, #extract!, from_trusted_xml, from_xml, #reverse_merge, #reverse_merge!, #slice!, #stringify_keys, #stringify_keys!, #symbolize_keys, #symbolize_keys!, #to_query, #to_xml, #with_indifferent_access
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(name, *args) ⇒ Object
41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
# File 'lib/active_support/ordered_options.rb', line 41 def method_missing(name, *args) name_string = +name.to_s if name_string.chomp!("=") self[name_string] = args.first else bangs = name_string.chomp!("!") if bangs self[name_string].presence || raise(KeyError.new(":#{name_string} is blank")) else self[name_string] end end end |
Instance Method Details
#[](key) ⇒ Object
37 38 39 |
# File 'lib/active_support/ordered_options.rb', line 37 def [](key) super(key.to_sym) end |
#[]=(key, value) ⇒ Object
33 34 35 |
# File 'lib/active_support/ordered_options.rb', line 33 def []=(key, value) super(key.to_sym, value) end |
#extractable_options? ⇒ Boolean
60 61 62 |
# File 'lib/active_support/ordered_options.rb', line 60 def true end |
#respond_to_missing?(name, include_private) ⇒ Boolean
56 57 58 |
# File 'lib/active_support/ordered_options.rb', line 56 def respond_to_missing?(name, include_private) true end |