123456789_123456789_123456789_123456789_123456789_

Class: ActiveModel::Type::Boolean

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

Overview

Active Model Boolean Type

A class that behaves like a boolean type, including rules for coercion of user input.

  • "false", "f", "0", 0 or any other value in FALSE_VALUES will be coerced to false.

  • Empty strings are coerced to nil.

  • All other values will be coerced to true.

Constant Summary

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

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/boolean.rb', line 39

def cast_value(value)
  if value == ""
    nil
  else
    !FALSE_VALUES.include?(value)
  end
end

#serialize(value)

This method is for internal use only.
[ GitHub ]

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

def serialize(value) # :nodoc:
  cast(value)
end

#serialize_cast_value(value)

This method is for internal use only.
[ GitHub ]

  
# File 'activemodel/lib/active_model/type/boolean.rb', line 34

def serialize_cast_value(value) # :nodoc:
  value
end

#type

This method is for internal use only.
[ GitHub ]

  
# File 'activemodel/lib/active_model/type/boolean.rb', line 26

def type # :nodoc:
  :boolean
end