Module: Mongoid::Attributes
- Extended by:
- ActiveSupport::Concern
- Includes:
- Processing, Readonly
- Included in:
- Components
- Defined in:
- lib/mongoid/attributes.rb,
lib/mongoid/attributes/readonly.rb,
lib/mongoid/attributes/processing.rb
Overview
This module contains the logic for handling the internal attributes hash, and how to get and set values.
Defined Under Namespace
Modules: ClassMethods, Processing, Readonly
Instance Attribute Summary collapse
-
#attributes ⇒ Object
(also: #raw_attributes)
readonly
Returns the value of attribute attributes.
-
#attributes_before_type_cast ⇒ Object
readonly
Returns the value of attribute attributes_before_type_cast.
Instance Method Summary collapse
-
#assign_attributes(attrs = nil, options = {}) ⇒ Object
Allows you to set all the attributes for a particular mass-assignment security role by passing in a hash of attributes with keys matching the attribute names (which again matches the column names) and the role name using the :as option.
-
#attribute_present?(name) ⇒ true, false
Determine if an attribute is present.
-
#has_attribute?(name) ⇒ true, false
Does the document have the provided attribute?.
-
#has_attribute_before_type_cast?(name) ⇒ true, false
Does the document have the provided attribute before it was assigned and type cast?.
-
#read_attribute(name) ⇒ Object
(also: #[])
Read a value from the document attributes.
-
#read_attribute_before_type_cast(name) ⇒ Object
Read a value from the attributes before type cast.
-
#remove_attribute(name) ⇒ Object
Remove a value from the
Document
attributes. -
#respond_to?(name, include_private = false) ⇒ true, false
Override respond_to? so it responds properly for dynamic attributes.
-
#write_attribute(name, value) ⇒ Object
(also: #[]=)
Write a single attribute to the document attribute hash.
-
#write_attributes(attrs = nil, guard_protected_attributes = true) ⇒ Object
(also: #attributes=)
Writes the supplied attributes hash to the document.
Methods included from Readonly
Methods included from Processing
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(name, *args) ⇒ Object (private)
Used for allowing accessor methods for dynamic attributes.
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 |
# File 'lib/mongoid/attributes.rb', line 305 def method_missing(name, *args) attr = name.to_s return super unless attributes.has_key?(attr.reader) if attr.writer? getter = attr.reader define_dynamic_writer(getter) write_attribute(getter, args.first) elsif attr.before_type_cast? define_dynamic_before_type_cast_reader(attr.reader) read_attribute_before_type_cast(attr.reader) else getter = attr.reader define_dynamic_reader(getter) read_attribute(getter) end end |
Instance Attribute Details
#attributes ⇒ Object (readonly) Also known as: raw_attributes
Returns the value of attribute attributes.
14 15 16 |
# File 'lib/mongoid/attributes.rb', line 14 def attributes @attributes end |
#attributes_before_type_cast ⇒ Object (readonly)
Returns the value of attribute attributes_before_type_cast.
15 16 17 |
# File 'lib/mongoid/attributes.rb', line 15 def attributes_before_type_cast @attributes_before_type_cast end |
Instance Method Details
#assign_attributes(attrs = nil, options = {}) ⇒ Object
Allows you to set all the attributes for a particular mass-assignment security role by passing in a hash of attributes with keys matching the attribute names (which again matches the column names) and the role name using the :as option. To bypass mass-assignment security you can use the :without_protection => true option.
202 203 204 205 206 |
# File 'lib/mongoid/attributes.rb', line 202 def assign_attributes(attrs = nil, = {}) _assigning do process_attributes(attrs, [:as] || :default, ![:without_protection]) end end |
#attribute_present?(name) ⇒ true, false
Determine if an attribute is present.
28 29 30 31 |
# File 'lib/mongoid/attributes.rb', line 28 def attribute_present?(name) attribute = read_attribute(name) !attribute.blank? || attribute == false end |
#has_attribute?(name) ⇒ true, false
Does the document have the provided attribute?
43 44 45 |
# File 'lib/mongoid/attributes.rb', line 43 def has_attribute?(name) attributes.has_key?(name.to_s) end |
#has_attribute_before_type_cast?(name) ⇒ true, false
Does the document have the provided attribute before it was assigned and type cast?
59 60 61 |
# File 'lib/mongoid/attributes.rb', line 59 def has_attribute_before_type_cast?(name) attributes_before_type_cast.has_key?(name.to_s) end |
#read_attribute(name) ⇒ Object Also known as: []
Read a value from the document attributes. If the value does not exist it will return nil.
77 78 79 80 81 82 83 84 |
# File 'lib/mongoid/attributes.rb', line 77 def read_attribute(name) normalized = name.to_s if hash_dot_syntax?(normalized) attributes.__nested__(normalized) else attributes[normalized] end end |
#read_attribute_before_type_cast(name) ⇒ Object
Read a value from the attributes before type cast. If the value has not yet been assigned then this will return the attribute’s existing value using read_attribute.
100 101 102 103 104 105 106 107 |
# File 'lib/mongoid/attributes.rb', line 100 def read_attribute_before_type_cast(name) attr = name.to_s if attributes_before_type_cast.has_key?(attr) attributes_before_type_cast[attr] else read_attribute(attr) end end |
#remove_attribute(name) ⇒ Object
Remove a value from the Document
attributes. If the value does not exist it will fail gracefully.
121 122 123 124 125 126 127 128 129 130 131 |
# File 'lib/mongoid/attributes.rb', line 121 def remove_attribute(name) access = name.to_s unless attribute_writable?(name) raise Errors::ReadonlyAttribute.new(name, :nil) end _assigning do attribute_will_change!(access) delayed_atomic_unsets[atomic_attribute_name(access)] = [] attributes.delete(access) end end |
#respond_to?(name, include_private = false) ⇒ true, false
Override respond_to? so it responds properly for dynamic attributes.
143 144 145 146 147 148 149 150 |
# File 'lib/mongoid/attributes.rb', line 143 def respond_to?(name, include_private = false) super || ( Mongoid.allow_dynamic_fields && attributes && attributes.has_key?(name.to_s.reader) && name.to_s.valid_method_name? ) end |
#write_attribute(name, value) ⇒ Object Also known as: []=
Write a single attribute to the document attribute hash. This will also fire the before and after update callbacks, and perform any necessary typecasting.
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
# File 'lib/mongoid/attributes.rb', line 166 def write_attribute(name, value) access = database_field_name(name.to_s) if attribute_writable?(access) _assigning do localized = fields[access].try(:localized?) attributes_before_type_cast[name.to_s] = value typed_value = typed_value_for(access, value) unless attributes[access] == typed_value || attribute_changed?(access) attribute_will_change!(access) end if localized (attributes[access] ||= {}).merge!(typed_value) else attributes[access] = typed_value end typed_value end end end |
#write_attributes(attrs = nil, guard_protected_attributes = true) ⇒ Object Also known as: attributes=
Writes the supplied attributes hash to the document. This will only overwrite existing attributes if they are present in the new Hash
, all others will be preserved.
222 223 224 |
# File 'lib/mongoid/attributes.rb', line 222 def write_attributes(attrs = nil, guard_protected_attributes = true) assign_attributes(attrs, without_protection: !guard_protected_attributes) end |