Module: ActiveRecord::Normalization::ClassMethods

Defined in:
activerecord/lib/active_record/normalization.rb

Instance Method Summary collapse

Instance Method Details

#normalize_value_for(name, value) ⇒ Object

Normalizes a given value using normalizations declared for name.

Examples

class User < ActiveRecord::Base
  normalizes :email, with: -> email { email.strip.downcase }
end

User.normalize_value_for(:email, " [email protected]\n")
# => "[email protected]"



96
97
98
 
# File 'activerecord/lib/active_record/normalization.rb', line 96

def normalize_value_for(name, value)
  type_for_attribute(name).cast(value)
end

#normalizes(*names, with:, apply_to_nil: false) ⇒ Object

Declares a normalization for one or more attributes. The normalization is applied when the attribute is assigned or updated, and the normalized value will be persisted to the database. The normalization is also applied to the corresponding keyword argument of finder methods. This allows a record to be created and later queried using unnormalized values.

However, to prevent confusion, the normalization will not be applied when the attribute is fetched from the database. This means that if a record was persisted before the normalization was declared, the record’s attribute will not be normalized until either it is assigned a new value, or it is explicitly migrated via Normalization#normalize_attribute.

Because the normalization may be applied multiple times, it should be idempotent. In other words, applying the normalization more than once should have the same result as applying it only once.

By default, the normalization will not be applied to nil values. This behavior can be changed with the :apply_to_nil option.

Options

  • :with - The normalization to apply.

  • :apply_to_nil - Whether to apply the normalization to nil values. Defaults to false.

Examples

class User < ActiveRecord::Base
  normalizes :email, with: -> email { email.strip.downcase }
  normalizes :phone, with: -> phone { phone.delete("^0-9").delete_prefix("1") }
end

user = User.create(email: " [email protected]\n")
user.email                  # => "[email protected]"

user = User.find_by(email: "\[email protected] ")
user.email                  # => "[email protected]"
user.email_before_type_cast # => "[email protected]"

User.exists?(email: "\[email protected] ")         # => true
User.exists?(["email = ?", "\[email protected] "]) # => false

User.normalize_value_for(:phone, "+1 (555) 867-5309") # => "5558675309"



76
77
78
79
80
81
82
83
84
 
# File 'activerecord/lib/active_record/normalization.rb', line 76

def normalizes(*names, with:, apply_to_nil: false)
  names.each do |name|
    attribute(name) do |cast_type|
      NormalizedValueType.new(cast_type: cast_type, normalizer: with, normalize_nil: apply_to_nil)
    end
  end

  self.normalized_attributes += names.map(&:to_sym)
end