123456789_123456789_123456789_123456789_123456789_

Class: ActiveModel::Type::BigInteger

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Subclasses:
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Integer, Value
Instance Chain:
Inherits: ActiveModel::Type::Integer
Defined in: activemodel/lib/active_model/type/big_integer.rb

Overview

Active Model BigInteger Type

::ActiveModel::Attribute type for integers that can be serialized to an unlimited number of bytes. This type is registered under the :big_integer key.

class Person
include ActiveModel::Attributes

attribute :id, :big_integer
end

person = Person.new
person.id = "18_000_000_000"

person.id # => 18000000000

All casting and serialization are performed in the same way as the standard Integer type.

Constant Summary

Helpers::Numeric - Included

NUMERIC_REGEX

Integer - Inherited

DEFAULT_LIMIT

Class Method Summary

Integer - Inherited

Value - Inherited

.new

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

Instance Attribute Summary

Helpers::Immutable - Included

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

Integer - Inherited

#deserialize, #serializable?, #serialize, #type, #_limit, #cast_value,
#max_cast_bytesize

Only the first bytes of a string are cast, to bound the work done by to_i on very long input.

#max_value, #min_value, #out_of_range?, #serialize_cast_value

Helpers::Numeric - Included

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

Constructor Details

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

Instance Method Details

#max_cast_bytesize (private)

Values are not limited to limit bytes, so bound the cast by the precision (number of digits) instead. Without a precision, fall back to the largest precision databases accept for a numeric column (1000 digits on PostgreSQL). Twice the precision leaves room for a sign or a short slug suffix.

[ GitHub ]

  
# File 'activemodel/lib/active_model/type/big_integer.rb', line 64

def max_cast_bytesize
  (precision || MAX_PRECISION) * 2
end

#max_value (private)

[ GitHub ]

  
# File 'activemodel/lib/active_model/type/big_integer.rb', line 55

def max_value
  ::Float::INFINITY
end

#serializable?(value) ⇒ Boolean

[ GitHub ]

  
# File 'activemodel/lib/active_model/type/big_integer.rb', line 50

def serializable?(value, &)
  true
end

#serialize(value)

This method is for internal use only.
[ GitHub ]

  
# File 'activemodel/lib/active_model/type/big_integer.rb', line 29

def serialize(value) # :nodoc:
  case value
  when ::Integer
    # noop
  when ::String
    int = value.to_i
    if int.zero? && value != "0"
      return if non_numeric_string?(value)
    end
    value = int
  else
    value = super
  end

  value
end

#serialize_cast_value(value)

This method is for internal use only.
[ GitHub ]

  
# File 'activemodel/lib/active_model/type/big_integer.rb', line 46

def serialize_cast_value(value) # :nodoc:
  value
end