Class: ActiveModel::Type::Value
- Inherits:
-
Object
- Object
- ActiveModel::Type::Value
- Defined in:
- lib/active_model/type/value.rb
Direct Known Subclasses
Binary, Boolean, Date, DateTime, Decimal, Float, ImmutableString, Integer, Time
Instance Attribute Summary collapse
-
#limit ⇒ Object
readonly
Returns the value of attribute limit.
-
#precision ⇒ Object
readonly
Returns the value of attribute precision.
-
#scale ⇒ Object
readonly
Returns the value of attribute scale.
Instance Method Summary collapse
- #==(other) ⇒ Object (also: #eql?)
- #assert_valid_value ⇒ Object
-
#binary? ⇒ Boolean
These predicates are not documented, as I need to look further into their use, and see if they can be removed entirely.
-
#cast(value) ⇒ Object
Type casts a value from user input (e.g. from a setter).
-
#changed?(old_value, new_value, _new_value_before_type_cast) ⇒ Boolean
Determines whether a value has changed for dirty checking.
-
#changed_in_place?(raw_old_value, new_value) ⇒ Boolean
Determines whether the mutable value has been modified since it was read.
-
#deserialize(value) ⇒ Object
Converts a value from database input to the appropriate ruby type.
-
#force_equality?(_value) ⇒ Boolean
:nodoc:.
- #hash ⇒ Object
-
#initialize(precision: nil, limit: nil, scale: nil) ⇒ Value
constructor
A new instance of Value.
-
#map(value) {|value| ... } ⇒ Object
:nodoc:.
-
#serialize(value) ⇒ Object
Casts a value from the ruby type to a type that the database knows how to understand.
-
#type ⇒ Object
:nodoc:.
-
#type_cast_for_schema(value) ⇒ Object
Type casts a value for schema dumping.
-
#value_constructed_by_mass_assignment?(_value) ⇒ Boolean
:nodoc:.
Constructor Details
#initialize(precision: nil, limit: nil, scale: nil) ⇒ Value
Returns a new instance of Value.
8 9 10 11 12 |
# File 'lib/active_model/type/value.rb', line 8 def initialize(precision: nil, limit: nil, scale: nil) @precision = precision @scale = scale @limit = limit end |
Instance Attribute Details
#limit ⇒ Object (readonly)
Returns the value of attribute limit.
6 7 8 |
# File 'lib/active_model/type/value.rb', line 6 def limit @limit end |
#precision ⇒ Object (readonly)
Returns the value of attribute precision.
6 7 8 |
# File 'lib/active_model/type/value.rb', line 6 def precision @precision end |
#scale ⇒ Object (readonly)
Returns the value of attribute scale.
6 7 8 |
# File 'lib/active_model/type/value.rb', line 6 def scale @scale end |
Instance Method Details
#==(other) ⇒ Object Also known as: eql?
101 102 103 104 105 106 |
# File '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 ⇒ Object
113 114 |
# File 'lib/active_model/type/value.rb', line 113 def assert_valid_value(*) end |
#binary? ⇒ Boolean
These predicates are not documented, as I need to look further into their use, and see if they can be removed entirely.
57 58 59 |
# File 'lib/active_model/type/value.rb', line 57 def binary? # :nodoc: false end |
#cast(value) ⇒ Object
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.
37 38 39 |
# File '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) ⇒ Boolean
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.
64 65 66 |
# File '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) ⇒ Boolean
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
to Value#serialize and compare it toraw_old_value
or
-
pass
raw_old_value
to Value#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.
85 86 87 |
# File 'lib/active_model/type/value.rb', line 85 def changed_in_place?(raw_old_value, new_value) false end |
#deserialize(value) ⇒ Object
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.
23 24 25 |
# File 'lib/active_model/type/value.rb', line 23 def deserialize(value) cast(value) end |
#force_equality?(_value) ⇒ Boolean
:nodoc:
93 94 95 |
# File 'lib/active_model/type/value.rb', line 93 def force_equality?(_value) # :nodoc: false end |
#hash ⇒ Object
109 110 111 |
# File 'lib/active_model/type/value.rb', line 109 def hash [self.class, precision, scale, limit].hash end |
#map(value) {|value| ... } ⇒ Object
:nodoc:
97 98 99 |
# File 'lib/active_model/type/value.rb', line 97 def map(value) # :nodoc: yield value end |
#serialize(value) ⇒ Object
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
.
45 46 47 |
# File 'lib/active_model/type/value.rb', line 45 def serialize(value) value end |
#type ⇒ Object
:nodoc:
14 15 |
# File 'lib/active_model/type/value.rb', line 14 def type # :nodoc: end |
#type_cast_for_schema(value) ⇒ Object
Type casts a value for schema dumping. This method is private, as we are hoping to remove it entirely.
51 52 53 |
# File 'lib/active_model/type/value.rb', line 51 def type_cast_for_schema(value) # :nodoc: value.inspect end |
#value_constructed_by_mass_assignment?(_value) ⇒ Boolean
:nodoc:
89 90 91 |
# File 'lib/active_model/type/value.rb', line 89 def value_constructed_by_mass_assignment?(_value) # :nodoc: false end |