ActiveRecord::Type::Value (original) (raw)

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.

Methods

• ==

A

• as_json,
• assert_valid_value

C

• cast,
• cast_value,
• changed?,
• changed_in_place?

D

• deserialize

E

• eql?

H

• hash

N

• new

S

• serializable?,
• serialize

T

• type

Included Modules

• ActiveModel::Type::SerializeCastValue

Attributes

Class Public methods

new(precision: nil, limit: nil, scale: nil)Link

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.

Source: show | on GitHub

def initialize(precision: nil, limit: nil, scale: nil) super() @precision = precision @scale = scale @limit = limit end

Instance Public methods

==(other)Link

Also aliased as: eql?

Source: show | on GitHub

def ==(other) self.class == other.class && precision == other.precision && scale == other.scale && limit == other.limit end

assert_valid_value(_)Link

cast(value)Link

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: show | on GitHub

def cast(value) cast_value(value) unless value.nil? end

changed?(old_value, new_value, _new_value_before_type_cast)Link

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: show | on GitHub

def changed?(old_value, new_value, _new_value_before_type_cast) old_value != new_value end

changed_in_place?(raw_old_value, new_value)Link

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 to raw_old_value

or

• pass raw_old_value to Value#deserialize and compare it to new_value

raw_old_value The original value, before being passed to deserialize.

new_value The current value, after type casting.

Source: show | on GitHub

def changed_in_place?(raw_old_value, new_value) false end

deserialize(value)Link

eql?(other)Link

Alias for: ==

hash()Link

Source: show | on GitHub

def hash [self.class, precision, scale, limit].hash end

serializable?(value, &_)Link

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.

serialize(value)Link

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.

type()Link

Returns the unique type name as a Symbol. Subclasses should override this method.

Instance Private methods

cast_value(value)Link

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.