123456789_123456789_123456789_123456789_123456789_

Class: ActiveRecord::Type::Serialized

Do not use. This class is for internal use only.
Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
Instance Chain:
Inherits: ActiveModel::Type::Value
Defined in: activerecord/lib/active_record/type/serialized.rb

Class Method Summary

::ActiveModel::Type::Value - Inherited

.new

Initializes a type with three basic configuration settings: precision, limit, and scale.

Instance Attribute Summary

::ActiveModel::Type::Helpers::Mutable - Included

::ActiveModel::Type::Value - Inherited

#limit, #precision, #scale,
#binary?

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

#mutable?, #serialized?

Instance Method Summary

::ActiveModel::Type::Helpers::Mutable - Included

#cast,
#changed_in_place?

raw_old_value will be the _before_type_cast version of the value (likely a string).

::ActiveModel::Type::Value - Inherited

#==, #as_json, #assert_valid_value,
#cast

::ActiveRecord::Type casts a value from user input (e.g. from a setter).

#changed?

Determines whether a value has changed for dirty checking.

#changed_in_place?

Determines whether the mutable value has been modified since it was read.

#deserialize

Converts a value from database input to the appropriate ruby type.

#eql?
#hash,
#serializable?

Returns true if this type can convert value to a type that is usable by the database.

#serialize

Casts a value from the ruby type to a type that the database knows how to understand.

#type

Returns the unique type name as a ::Symbol.

#cast_value

Convenience method for types which do not need separate type casting behavior for user and database inputs.

#force_equality?, #map,
#type_cast_for_schema

::ActiveRecord::Type casts a value for schema dumping.

#value_constructed_by_mass_assignment?

::ActiveModel::Type::SerializeCastValue - Included

Constructor Details

.new(subtype, coder) ⇒ Serialized

[ GitHub ]

  
# File 'activerecord/lib/active_record/type/serialized.rb', line 12

def initialize(subtype, coder)
  @subtype = subtype
  @coder = coder
  super(subtype)
end

Instance Attribute Details

#coder (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/type/serialized.rb', line 10

attr_reader :subtype, :coder

#serialized?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/type/serialized.rb', line 56

def serialized? # :nodoc:
  true
end

#subtype (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/type/serialized.rb', line 10

attr_reader :subtype, :coder

Instance Method Details

#accessor

[ GitHub ]

  
# File 'activerecord/lib/active_record/type/serialized.rb', line 42

def accessor
  ActiveRecord::Store::IndifferentHashAccessor
end

#assert_valid_value(value)

[ GitHub ]

  
# File 'activerecord/lib/active_record/type/serialized.rb', line 46

def assert_valid_value(value)
  if coder.respond_to?(:assert_valid_value)
    coder.assert_valid_value(value, action: "serialize")
  end
end

#changed_in_place?(raw_old_value, value) ⇒ Boolean

[ GitHub ]

  
# File 'activerecord/lib/active_record/type/serialized.rb', line 35

def changed_in_place?(raw_old_value, value)
  return false if value.nil?
  raw_new_value = encoded(value)
  raw_old_value.nil? != raw_new_value.nil? ||
    subtype.changed_in_place?(raw_old_value, raw_new_value)
end

#default_value?(value) ⇒ Boolean (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/type/serialized.rb', line 61

def default_value?(value)
  value == coder.load(nil)
end

#deserialize(value)

[ GitHub ]

  
# File 'activerecord/lib/active_record/type/serialized.rb', line 18

def deserialize(value)
  if default_value?(value)
    value
  else
    coder.load(super)
  end
end

#encoded(value) (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/type/serialized.rb', line 65

def encoded(value)
  return if default_value?(value)
  payload = coder.dump(value)
  if payload && @subtype.binary?
    ActiveModel::Type::Binary::Data.new(payload)
  else
    payload
  end
end

#force_equality?(value) ⇒ Boolean

[ GitHub ]

  
# File 'activerecord/lib/active_record/type/serialized.rb', line 52

def force_equality?(value)
  coder.respond_to?(:object_class) && value.is_a?(coder.object_class)
end

#serialize(value)

[ GitHub ]

  
# File 'activerecord/lib/active_record/type/serialized.rb', line 26

def serialize(value)
  return if value.nil?
  unless default_value?(value)
    super coder.dump(value)
  end
end