123456789_123456789_123456789_123456789_123456789_

Class: ActiveModel::Type::Value

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Subclasses:
BigInteger, Binary, Boolean, Date, DateTime, Decimal, Float, ImmutableString, Integer, String, Time, ActiveRecord::Encryption::EncryptedAttributeType, ActiveRecord::Locking::LockingType, ActiveRecord::Normalization::NormalizedValueType, ActiveRecord::Type::Date, ActiveRecord::Type::DateTime, ActiveRecord::Type::DecimalWithoutScale, ActiveRecord::Type::Json, ActiveRecord::Type::Serialized, ActiveRecord::Type::Text, ActiveRecord::Type::Time, ActiveRecord::Type::UnsignedInteger, ActiveRecord::AttributeMethods::TimeZoneConversion::TimeZoneConverter, ActiveRecord::ConnectionAdapters::SQLite3Adapter::SQLite3Integer, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Array, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Bit, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::BitVarying, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Bytea, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Cidr, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Date, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::DateTime, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Decimal, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Enum, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Hstore, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Inet, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Interval, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Jsonb, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::LegacyPoint, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Macaddr, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Money, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Oid, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Point, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Range, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::SpecializedString, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Timestamp, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::TimestampWithTimeZone, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Uuid, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Vector, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Xml
Super Chains via Extension / Inclusion / Inheritance
Instance Chain:
Inherits: Object
Defined in: activemodel/lib/active_model/type/value.rb

Overview

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.

Class Method Summary

Instance Attribute Summary

Instance Method Summary

SerializeCastValue - Included

Constructor Details

.new(precision: nil, limit: nil, scale: nil) ⇒ Value

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.

[ GitHub ]

  
# 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

Instance Attribute Details

#binary?Boolean (readonly)

This method is for internal use only.

These predicates are not documented, as I need to look further into their use, and see if they can be removed entirely.

[ GitHub ]

  
# File 'activemodel/lib/active_model/type/value.rb', line 77

def binary? # :nodoc:
  false
end

#limit (readonly)

[ GitHub ]

  
# File 'activemodel/lib/active_model/type/value.rb', line 11

attr_reader :precision, :scale, :limit

#mutable?Boolean (readonly)

This method is for internal use only.
[ GitHub ]

  
# File 'activemodel/lib/active_model/type/value.rb', line 140

def mutable? # :nodoc:
  false
end

#precision (readonly)

[ GitHub ]

  
# File 'activemodel/lib/active_model/type/value.rb', line 11

attr_reader :precision, :scale, :limit

#scale (readonly)

[ GitHub ]

  
# File 'activemodel/lib/active_model/type/value.rb', line 11

attr_reader :precision, :scale, :limit

#serialized?Boolean (readonly)

This method is for internal use only.
[ GitHub ]

  
# File 'activemodel/lib/active_model/type/value.rb', line 136

def serialized? # :nodoc:
  false
end

Instance Method Details

#==(other) Also known as: #eql?

[ GitHub ]

  
# 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

#as_json

Raises:

  • (NoMethodError)
[ GitHub ]

  
# File 'activemodel/lib/active_model/type/value.rb', line 144

def as_json(*)
  raise NoMethodError
end

#assert_valid_value(_)

[ GitHub ]

  
# File 'activemodel/lib/active_model/type/value.rb', line 133

def assert_valid_value(_)
end

#cast(value)

::ActiveModel::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: #cast_value.

value The raw input, as provided to the attribute setter.

[ GitHub ]

  
# File 'activemodel/lib/active_model/type/value.rb', line 57

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

#cast_value(value) (private)

Convenience method for types which do not need separate type casting behavior for user and database inputs. Called by #cast for values except nil.

[ GitHub ]

  
# File 'activemodel/lib/active_model/type/value.rb', line 152

def cast_value(value) # :doc:
  value
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.

[ GitHub ]

  
# 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

#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 #serialize and compare it to raw_old_value

or

  • pass raw_old_value to #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.

[ GitHub ]

  
# File 'activemodel/lib/active_model/type/value.rb', line 105

def changed_in_place?(raw_old_value, new_value)
  false
end

#deserialize(value) Also known as: #serialize

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 #cast.

value The raw input, as provided from the database.

[ GitHub ]

  
# File 'activemodel/lib/active_model/type/value.rb', line 43

def deserialize(value)
  cast(value)
end

#eql?(other)

Alias for #==.

[ GitHub ]

  
# File 'activemodel/lib/active_model/type/value.rb', line 127

alias eql? ==

#force_equality?(_value) ⇒ Boolean

This method is for internal use only.
[ GitHub ]

  
# File 'activemodel/lib/active_model/type/value.rb', line 113

def force_equality?(_value) # :nodoc:
  false
end

#hash

[ GitHub ]

  
# File 'activemodel/lib/active_model/type/value.rb', line 129

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

#map(value)

This method is for internal use only.
[ GitHub ]

  
# File 'activemodel/lib/active_model/type/value.rb', line 117

def map(value, &) # :nodoc:
  value
end

#serializable?(value) ⇒ Boolean

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.

[ GitHub ]

  
# File 'activemodel/lib/active_model/type/value.rb', line 28

def serializable?(value)
  true
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.

[ GitHub ]

  
# File 'activemodel/lib/active_model/type/value.rb', line 65

def serialize(value)
  value
end

#type

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

[ GitHub ]

  
# File 'activemodel/lib/active_model/type/value.rb', line 34

def type
end

#type_cast_for_schema(value)

This method is for internal use only.

::ActiveModel::Type casts a value for schema dumping. This method is private, as we are hoping to remove it entirely.

[ GitHub ]

  
# File 'activemodel/lib/active_model/type/value.rb', line 71

def type_cast_for_schema(value) # :nodoc:
  value.inspect
end

#value_constructed_by_mass_assignment?(_value) ⇒ Boolean

This method is for internal use only.
[ GitHub ]

  
# File 'activemodel/lib/active_model/type/value.rb', line 109

def value_constructed_by_mass_assignment?(_value) # :nodoc:
  false
end