class ActiveRecord::Type::Value
Active Model Value Type¶ ↑
The base class for all attribute types. This class also serves as the default type for attributes that do not specify a type.
Attributes
Public Class Methods
Initializes a type with three basic configuration settings: precision, limit, and scale. The Value
base class does not define behavior for these settings. It uses them for equality comparison and hash key generation only.
# File activemodel/lib/active_model/type/value.rb, line 17 def initialize(precision: nil, limit: nil, scale: nil) super() @precision = precision @scale = scale @limit = limit end
Public Instance Methods
# File activemodel/lib/active_model/type/value.rb, line 121 def ==(other) self.class == other.class && precision == other.precision && scale == other.scale && limit == other.limit end
# File activemodel/lib/active_model/type/value.rb, line 144 def as_json(*) raise NoMethodError end
# File activemodel/lib/active_model/type/value.rb, line 133 def assert_valid_value(_) end
Type
casts a value from user input (e.g. from a setter). This value may be a string from the form builder, or a ruby object passed to a setter. There is currently no way to differentiate between which source it came from.
The return value of this method will be returned from ActiveRecord::AttributeMethods::Read#read_attribute
. See also: Value#cast_value
.
value
The raw input, as provided to the attribute setter.
# File activemodel/lib/active_model/type/value.rb, line 57 def cast(value) cast_value(value) unless value.nil? end
Determines whether a value has changed for dirty checking. old_value
and new_value
will always be type-cast. Types should not need to override this method.
# File activemodel/lib/active_model/type/value.rb, line 84 def changed?(old_value, new_value, _new_value_before_type_cast) old_value != new_value end
Determines whether the mutable value has been modified since it was read. Returns false
by default. If your type returns an object which could be mutated, you should override this method. You will need to either:
-
pass
new_value
toValue#serialize
and compare it toraw_old_value
or
-
pass
raw_old_value
toValue#deserialize
and compare it tonew_value
raw_old_value
The original value, before being passed to deserialize
.
new_value
The current value, after type casting.
# File activemodel/lib/active_model/type/value.rb, line 105 def changed_in_place?(raw_old_value, new_value) false end
Converts a value from database input to the appropriate ruby type. The return value of this method will be returned from ActiveRecord::AttributeMethods::Read#read_attribute
. The default implementation just calls Value#cast
.
value
The raw input, as provided from the database.
# File activemodel/lib/active_model/type/value.rb, line 43 def deserialize(value) cast(value) end
# File activemodel/lib/active_model/type/value.rb, line 129 def hash [self.class, precision, scale, limit].hash end
Returns true if this type can convert value
to a type that is usable by the database. For example a boolean type can return true
if the value parameter is a Ruby boolean, but may return false
if the value parameter is some other object.
# File activemodel/lib/active_model/type/value.rb, line 28 def serializable?(value, &_) true end
Private Instance Methods
Convenience method for types which do not need separate type casting behavior for user and database inputs. Called by Value#cast
for values except nil
.
# File activemodel/lib/active_model/type/value.rb, line 152 def cast_value(value) # :doc: value end