Methods
- ==
- assert_valid_value
- cast
- cast_value
- changed?
- changed_in_place?
- deserialize
- eql?
- hash
- new
- serializable?
- serialize
Attributes
[R] | limit | |
[R] | precision | |
[R] | scale |
Class Public methods
new(precision: nil, limit: nil, scale: nil)
📝 Source code
# File activemodel/lib/active_model/type/value.rb, line 8
def initialize(precision: nil, limit: nil, scale: nil)
@precision = precision
@scale = scale
@limit = limit
end
🔎 See on GitHub
Instance Public methods
==(other)
📝 Source code
# File activemodel/lib/active_model/type/value.rb, line 109
def ==(other)
self.class == other.class &&
precision == other.precision &&
scale == other.scale &&
limit == other.limit
end
🔎 See on GitHub
assert_valid_value(_)
📝 Source code
# File activemodel/lib/active_model/type/value.rb, line 121
def assert_valid_value(_)
end
🔎 See on GitHub
cast(value)
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.
📝 Source code
# File activemodel/lib/active_model/type/value.rb, line 45
def cast(value)
cast_value(value) unless value.nil?
end
🔎 See on GitHub
changed?(old_value, new_value, _new_value_before_type_cast)
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.
📝 Source code
# File activemodel/lib/active_model/type/value.rb, line 72
def changed?(old_value, new_value, _new_value_before_type_cast)
old_value != new_value
end
🔎 See on GitHub
changed_in_place?(raw_old_value, new_value)
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.
📝 Source code
# File activemodel/lib/active_model/type/value.rb, line 93
def changed_in_place?(raw_old_value, new_value)
false
end
🔎 See on GitHub
deserialize(value)
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.
📝 Source code
# File activemodel/lib/active_model/type/value.rb, line 31
def deserialize(value)
cast(value)
end
🔎 See on GitHub
hash()
📝 Source code
# File activemodel/lib/active_model/type/value.rb, line 117
def hash
[self.class, precision, scale, limit].hash
end
🔎 See on GitHub
serializable?(value)
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.
📝 Source code
# File activemodel/lib/active_model/type/value.rb, line 18
def serializable?(value)
true
end
🔎 See on GitHub
serialize(value)
Casts a value from the ruby type to a type that the database knows how to understand. The returned value from this method should be a String
, Numeric
, Date
, Time
, Symbol
, true
, false
, or nil
.
📝 Source code
# File activemodel/lib/active_model/type/value.rb, line 53
def serialize(value)
value
end
🔎 See on GitHub
Instance Private methods
cast_value(value)
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
.
📝 Source code
# File activemodel/lib/active_model/type/value.rb, line 128
def cast_value(value) # :doc:
value
end
🔎 See on GitHub