Methods
- ==
- assert_valid_value
- cast
- cast_value
- changed?
- changed_in_place?
- deserialize
- eql?
- hash
- new
- serialize
Attributes
[R] | limit | |
[R] | precision | |
[R] | scale |
Class Public methods
new(precision: nil, limit: nil, scale: nil)
Source:
# 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
Instance Public methods
==(other)
Source:
# File activemodel/lib/active_model/type/value.rb, line 101
def ==(other)
self.class == other.class &&
precision == other.precision &&
scale == other.scale &&
limit == other.limit
end
assert_valid_value(*)
Source:
# File activemodel/lib/active_model/type/value.rb, line 113
def assert_valid_value(*)
end
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:
# File activemodel/lib/active_model/type/value.rb, line 37
def cast(value)
cast_value(value) unless value.nil?
end
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:
# File activemodel/lib/active_model/type/value.rb, line 64
def changed?(old_value, new_value, _new_value_before_type_cast)
old_value != new_value
end
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:
# File activemodel/lib/active_model/type/value.rb, line 85
def changed_in_place?(raw_old_value, new_value)
false
end
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:
# File activemodel/lib/active_model/type/value.rb, line 23
def deserialize(value)
cast(value)
end
hash()
Source:
# File activemodel/lib/active_model/type/value.rb, line 109
def hash
[self.class, precision, scale, limit].hash
end
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:
# File activemodel/lib/active_model/type/value.rb, line 45
def serialize(value)
value
end
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:
# File activemodel/lib/active_model/type/value.rb, line 120
def cast_value(value) # :doc:
value
end