module Mongoid::Attributes
This module contains the logic for handling the internal attributes hash, and how to get and set values.
Attributes
Public Instance Methods
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.
@example Assign the attributes.
person.assign_attributes(:title => "Mr.")
@example Assign the attributes (with a role).
person.assign_attributes({ :title => "Mr." }, :as => :admin)
@param [ Hash ] attrs The new attributes to set.
@since 2.2.1
# File lib/mongoid/attributes.rb, line 200 def assign_attributes(attrs = nil) _assigning do process_attributes(attrs) end end
Determine if the attribute is missing from the document, due to loading it from the database with missing fields.
@example Is the attribute missing?
document.attribute_missing?("test")
@param [ String ] name The name of the attribute.
@return [ true, false ] If the attribute is missing.
@since 4.0.0
# File lib/mongoid/attributes.rb, line 236 def attribute_missing?(name) selection = __selected_fields return false unless selection field = fields[name] (selection.values.first == 0 && selection_excluded?(name, selection, field)) || (selection.values.first == 1 && !selection_included?(name, selection, field)) end
Determine if an attribute is present.
@example Is the attribute present?
person.attribute_present?("title")
@param [ String, Symbol ] name The name of the attribute.
@return [ true, false ] True if present, false if not.
@since 1.0.0
# File lib/mongoid/attributes.rb, line 30 def attribute_present?(name) attribute = read_attribute(name) !attribute.blank? || attribute == false end
Get the attributes that have not been cast.
@example Get the attributes before type cast.
document.attributes_before_type_cast
@return [ Hash ] The uncast attributes.
@since 3.1.0
# File lib/mongoid/attributes.rb, line 43 def attributes_before_type_cast @attributes_before_type_cast ||= {} end
Does the document have the provided attribute?
@example Does the document have the attribute?
model.has_attribute?(:name)
@param [ String, Symbol ] name The name of the attribute.
@return [ true, false ] If the key is present in the attributes.
@since 3.0.0
# File lib/mongoid/attributes.rb, line 57 def has_attribute?(name) attributes.has_key?(name.to_s) end
Does the document have the provided attribute before it was assigned and type cast?
@example Does the document have the attribute before it was assigned?
model.has_attribute_before_type_cast?(:name)
@param [ String, Symbol ] name The name of the attribute.
@return [ true, false ] If the key is present in the
attributes_before_type_cast.
@since 3.1.0
# File lib/mongoid/attributes.rb, line 73 def has_attribute_before_type_cast?(name) attributes_before_type_cast.has_key?(name.to_s) end
Read a value from the document attributes. If the value does not exist it will return nil.
@example Read an attribute.
person.read_attribute(:title)
@example Read an attribute (alternate syntax.)
person[:title]
@param [ String, Symbol ] name The name of the attribute to get.
@return [ Object ] The value of the attribute.
@since 1.0.0
# File lib/mongoid/attributes.rb, line 91 def read_attribute(name) normalized = database_field_name(name.to_s) if attribute_missing?(normalized) raise ActiveModel::MissingAttributeError, "Missing attribute: '#{name}'." end if hash_dot_syntax?(normalized) attributes.__nested__(normalized) else attributes[normalized] end end
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.
@example Read an attribute before type cast.
person.read_attribute_before_type_cast(:price)
@param [ String, Symbol ] name The name of the attribute to get.
@return [ Object ] The value of the attribute before type cast, if
available. Otherwise, the value of the attribute.
@since 3.1.0
# File lib/mongoid/attributes.rb, line 117 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 a value from the Document
attributes. If the value does
not exist it will fail gracefully.
@example Remove the attribute.
person.remove_attribute(:title)
@param [ String, Symbol ] name The name of the attribute to remove.
@raise [ Errors::ReadonlyAttribute ] If the field cannot be removed due
to being flagged as reaodnly.
@since 1.0.0
# File lib/mongoid/attributes.rb, line 138 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)] = [] unless new_record? attributes.delete(access) end end
Write a single attribute to the document attribute hash. This will also fire the before and after update callbacks, and perform any necessary typecasting.
@example Write the attribute.
person.write_attribute(:title, "Mr.")
@example Write the attribute (alternate syntax.)
person[:title] = "Mr."
@param [ String, Symbol ] name The name of the attribute to update. @param [ Object ] value The value to set for the attribute.
@since 1.0.0
# File lib/mongoid/attributes.rb, line 164 def write_attribute(name, value) access = database_field_name(name.to_s) if attribute_writable?(access) _assigning do validate_attribute_value(access, value) 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
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.
@example Write the attributes.
person.write_attributes(:title => "Mr.")
@example Write the attributes (alternate syntax.)
person.attributes = { :title => "Mr." }
@param [ Hash ] attrs The new attributes to set. @param [ Boolean ] guard_protected_attributes False to skip mass assignment protection.
@since 1.0.0
# File lib/mongoid/attributes.rb, line 220 def write_attributes(attrs = nil) assign_attributes(attrs) end
Private Instance Methods
Does the string contain dot syntax for accessing hashes?
@api private
@example Is the string in dot syntax.
model.hash_dot_syntax?
@return [ true, false ] If the string contains a “.”
@since 3.0.15
# File lib/mongoid/attributes.rb, line 272 def hash_dot_syntax?(string) string.include?(".") end
# File lib/mongoid/attributes.rb, line 246 def selection_excluded?(name, selection, field) if field && field.localized? selection["#{name}.#{::I18n.locale}"] == 0 else selection[name] == 0 end end
# File lib/mongoid/attributes.rb, line 254 def selection_included?(name, selection, field) if field && field.localized? selection.has_key?("#{name}.#{::I18n.locale}") else selection.has_key?(name) end end
Return the typecasted value for a field.
@example Get the value typecasted.
person.typed_value_for(:title, :sir)
@param [ String, Symbol ] key The field name. @param [ Object ] value The uncast value.
@return [ Object ] The cast value.
@since 1.0.0
# File lib/mongoid/attributes.rb, line 287 def typed_value_for(key, value) fields.has_key?(key) ? fields[key].mongoize(value) : value.mongoize end
Validates an attribute value. This provides validation checking if the value is valid for given a field. For now, only Hash and Array fields are validated.
@param [ String, Symbol ] name The name of the attribute to validate. @param [ Object ] value The to be validated.
@since 3.0.10
# File lib/mongoid/attributes.rb, line 335 def validate_attribute_value(access, value) return unless fields[access] && value validatable_types = [ Hash, Array ] if validatable_types.include? fields[access].type unless value.is_a? fields[access].type raise Mongoid::Errors::InvalidValue.new(fields[access].type, value.class) end end end