123456789_123456789_123456789_123456789_123456789_

Class: ActiveModel::Type::Float

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Value
Instance Chain:
self, Helpers::Numeric, Value, SerializeCastValue
Inherits: ActiveModel::Type::Value
Defined in: activemodel/lib/active_model/type/float.rb

Overview

Active Model Float Type

::ActiveModel::Attribute type for floating point numeric values. It is registered under the :float key.

class BagOfCoffee
  include ActiveModel::Attributes

  attribute :weight, :float
end

bag = BagOfCoffee.new

bag.weight = "0.25"
bag.weight # => 0.25

bag.weight = ""
bag.weight # => nil

bag.weight = "NaN"
bag.weight # => Float::NAN

Values are cast using their to_f method, except for the following strings:

  • Blank strings are cast to nil.

  • "Infinity" is cast to Float::INFINITY.

  • "-Infinity" is cast to -Float::INFINITY.

  • "NaN" is cast to Float::NAN.

Constant Summary

Helpers::Numeric - Included

NUMERIC_REGEX

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

Helpers::Numeric - Included

#cast, #changed?, #serialize, #serialize_cast_value, #equal_nan?, #non_numeric_string?, #number_to_non_number?

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 Method Details

#cast_value(value) (private)

[ GitHub ] 

  


# File 'activemodel/lib/active_model/type/float.rb', line 53



def cast_value(value)
  case value
  when ::Float then value
  when "Infinity" then ::Float::INFINITY
  when "-Infinity" then -::Float::INFINITY
  when "NaN" then ::Float::NAN
  else value.to_f
  end
end


  








  

    #type  
  

  [ GitHub ]


  

  


# File 'activemodel/lib/active_model/type/float.rb', line 39



def type
  :float
end


  








  

    #type_cast_for_schema(value)  
  

  [ GitHub ]


  

  


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



def type_cast_for_schema(value)
  return "::Float::NAN" if value.try(:nan?)
  case value
  when ::Float::INFINITY then "::Float::INFINITY"
  when -::Float::INFINITY then "-::Float::INFINITY"
  else super
  end
end