123456789_123456789_123456789_123456789_123456789_

Class: ActiveModel::Type::Binary

Relationships & Source Files
Namespace Children
Classes:
Data
Extension / Inclusion / Inheritance Descendants
Subclasses:
ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Bytea
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Value
Instance Chain:
self, Value, SerializeCastValue
Inherits: ActiveModel::Type::Value
Defined in: activemodel/lib/active_model/type/binary.rb

Overview

Active Model Binary Type

::ActiveModel::Attribute type for representation of binary data. This type is registered under the :binary key.

Non-string values are coerced to strings using their to_s method.

Class Method Summary

Value - Inherited

.new

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

Instance Attribute Summary

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

Value - Inherited

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

::ActiveModel::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?

Alias for Value#==.
#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

::ActiveModel::Type casts a value for schema dumping.
#value_constructed_by_mass_assignment?

SerializeCastValue - Included

#initialize, #itself_if_serialize_cast_value_compatible

Constructor Details

This class inherits a constructor from ActiveModel::Type::Value

Instance Attribute Details

#binary? ⇒ Boolean (readonly)

[ GitHub ] 

  


# File 'activemodel/lib/active_model/type/binary.rb', line 16



def binary?
  true
end


  







Instance Method Details



  

    #cast(value)  
  

  [ GitHub ]


  

  


# File 'activemodel/lib/active_model/type/binary.rb', line 20



def cast(value)
  if value.is_a?(Data)
    value.to_s
  else
    value = super
    value = value.b if ::String === value && value.encoding != Encoding::BINARY
    value
  end
end


  








  

    #changed_in_place?(raw_old_value, value)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'activemodel/lib/active_model/type/binary.rb', line 35



def changed_in_place?(raw_old_value, value)
  old_value = deserialize(raw_old_value)
  old_value != value
end


  








  

    #serialize(value)  
  

  [ GitHub ]


  

  


# File 'activemodel/lib/active_model/type/binary.rb', line 30



def serialize(value)
  return if value.nil?
  Data.new(super)
end


  








  

    #type  
  

  [ GitHub ]


  

  


# File 'activemodel/lib/active_model/type/binary.rb', line 12



def type
  :binary
end