Active Model Integer Type
Attribute type for integer representation. This type is registered under the :integer
key.
class Person
include ActiveModel::Attributes
attribute :age, :integer
end
Values are cast using their to_i
method, except for blank strings, which are cast to nil
. If a to_i
method is not defined or raises an error, the value will be cast to nil
.
person = Person.new
person.age = "18"
person.age # => 18
person.age = ""
person.age # => nil
person.age = :not_an_integer
person.age # => nil (because Symbol does not define #to_i)
Serialization
also works under the same principle. Non-numeric strings are serialized as nil
, for example.
Serialization
also validates that the integer can be stored using a limited number of bytes. If it cannot, an ActiveModel::RangeError
will be raised. The default limit is 4 bytes, and can be customized when declaring an attribute:
class Person
include ActiveModel::Attributes
attribute :age, :integer, limit: 6
end
Methods
Included Modules
Constants
DEFAULT_LIMIT | = | 4 |
Column storage size in bytes. 4 bytes means an integer as opposed to smallint etc. |
Class Public methods
new(**)
📝 Source code
# File activemodel/lib/active_model/type/integer.rb, line 52
def initialize(**)
super
@max = max_value
@min = min_value
end
🔎 See on GitHub
Instance Public methods
deserialize(value)
📝 Source code
# File activemodel/lib/active_model/type/integer.rb, line 62
def deserialize(value)
return if value.blank?
value.to_i
end
🔎 See on GitHub
serializable?(value)
📝 Source code
# File activemodel/lib/active_model/type/integer.rb, line 96
def serializable?(value)
cast_value = cast(value)
return true unless out_of_range?(cast_value)
yield cast_value if block_given?
false
end
🔎 See on GitHub
serialize(value)
📝 Source code
# File activemodel/lib/active_model/type/integer.rb, line 67
def serialize(value)
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
if out_of_range?(value)
raise ActiveModel::RangeError, "#{value} is out of range for #{self.class} with limit #{_limit} bytes"
end
value
end
🔎 See on GitHub
type()
📝 Source code
# File activemodel/lib/active_model/type/integer.rb, line 58
def type
:integer
end
🔎 See on GitHub