Class: ActiveModel::Type::Value

Inherits:
Object
  • Object
show all
Includes:
SerializeCastValue
Defined in:
activemodel/lib/active_model/type/value.rb

Overview

The base class for all attribute types. This class also serves as the default type for attributes that do not specify a type.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(precision: nil, limit: nil, scale: nil) ⇒ Value

Initializes a type with three basic configuration settings: precision, limit, and scale. The Value base class does not define behavior for these settings. It uses them for equality comparison and hash key generation only.



15
16
17
18
19
20
 
# File 'activemodel/lib/active_model/type/value.rb', line 15

def initialize(precision: nil, limit: nil, scale: nil)
  super()
  @precision = precision
  @scale = scale
  @limit = limit
end

Instance Attribute Details

#limit ⇒ Object (readonly)

Returns the value of attribute limit



9
10
11
 
# File 'activemodel/lib/active_model/type/value.rb', line 9

def limit
  @limit
end

#precision ⇒ Object (readonly)

Returns the value of attribute precision



9
10
11
 
# File 'activemodel/lib/active_model/type/value.rb', line 9

def precision
  @precision
end

#scale ⇒ Object (readonly)

Returns the value of attribute scale



9
10
11
 
# File 'activemodel/lib/active_model/type/value.rb', line 9

def scale
  @scale
end

Instance Method Details

#==(other) ⇒ Object Also known as: eql? 



119
120
121
122
123
124
 
# File 'activemodel/lib/active_model/type/value.rb', line 119

def ==(other)
  self.class == other.class &&
    precision == other.precision &&
    scale == other.scale &&
    limit == other.limit
end

#as_json ⇒ Object

Raises:

  • (NoMethodError) 


138
139
140
 
# File 'activemodel/lib/active_model/type/value.rb', line 138

def as_json(*)
  raise NoMethodError
end

#assert_valid_value(_) ⇒ Object 



131
132
 
# File 'activemodel/lib/active_model/type/value.rb', line 131

def assert_valid_value(_)
end

#binary? ⇒ Boolean

These predicates are not documented, as I need to look further into their use, and see if they can be removed entirely.

Returns:



75
76
77
 
# File 'activemodel/lib/active_model/type/value.rb', line 75

def binary? # :nodoc:
  false
end

#cast(value) ⇒ Object

Type casts a value from user input (e.g. from a setter). This value may be a string from the form builder, or a ruby object passed to a setter. There is currently no way to differentiate between which source it came from.

The return value of this method will be returned from ActiveRecord::AttributeMethods::Read#read_attribute. See also: Value#cast_value.

value The raw input, as provided to the attribute setter.



55
56
57
 
# File 'activemodel/lib/active_model/type/value.rb', line 55

def cast(value)
  cast_value(value) unless value.nil?
end

#changed?(old_value, new_value, _new_value_before_type_cast) ⇒ Boolean

Determines whether a value has changed for dirty checking. old_value and new_value will always be type-cast. Types should not need to override this method.

Returns:



82
83
84
 
# File 'activemodel/lib/active_model/type/value.rb', line 82

def changed?(old_value, new_value, _new_value_before_type_cast)
  old_value != new_value
end

#changed_in_place?(raw_old_value, new_value) ⇒ Boolean

Determines whether the mutable value has been modified since it was read. Returns false by default. If your type returns an object which could be mutated, you should override this method. You will need to either:

  • pass new_value to Value#serialize and compare it to raw_old_value

or

  • pass raw_old_value to Value#deserialize and compare it to new_value

raw_old_value The original value, before being passed to deserialize.

new_value The current value, after type casting.

Returns:



103
104
105
 
# File 'activemodel/lib/active_model/type/value.rb', line 103

def changed_in_place?(raw_old_value, new_value)
  false
end

#deserialize(value) ⇒ Object

Converts a value from database input to the appropriate ruby type. The return value of this method will be returned from ActiveRecord::AttributeMethods::Read#read_attribute. The default implementation just calls Value#cast.

value The raw input, as provided from the database.



41
42
43
 
# File 'activemodel/lib/active_model/type/value.rb', line 41

def deserialize(value)
  cast(value)
end

#force_equality?(_value) ⇒ Boolean

:nodoc:

Returns:



111
112
113
 
# File 'activemodel/lib/active_model/type/value.rb', line 111

def force_equality?(_value) # :nodoc:
  false
end

#hash ⇒ Object 



127
128
129
 
# File 'activemodel/lib/active_model/type/value.rb', line 127

def hash
  [self.class, precision, scale, limit].hash
end

#immutable_value(value) ⇒ Object

:nodoc:



134
135
136
 
# File 'activemodel/lib/active_model/type/value.rb', line 134

def immutable_value(value) # :nodoc:
  value
end

#map(value) {|value| ... } ⇒ Object

:nodoc:

Yields:

  • (value) 


115
116
117
 
# File 'activemodel/lib/active_model/type/value.rb', line 115

def map(value) # :nodoc:
  yield value
end

#serializable?(value) ⇒ Boolean

Returns true if this type can convert value to a type that is usable by the database. For example a boolean type can return true if the value parameter is a Ruby boolean, but may return false if the value parameter is some other object.

Returns:



26
27
28
 
# File 'activemodel/lib/active_model/type/value.rb', line 26

def serializable?(value)
  true
end

#serialize(value) ⇒ Object

Casts a value from the ruby type to a type that the database knows how to understand. The returned value from this method should be a String, Numeric, Date, Time, Symbol, true, false, or nil.



63
64
65
 
# File 'activemodel/lib/active_model/type/value.rb', line 63

def serialize(value)
  value
end

#type ⇒ Object

Returns the unique type name as a Symbol. Subclasses should override this method.



32
33
 
# File 'activemodel/lib/active_model/type/value.rb', line 32

def type
end

#type_cast_for_schema(value) ⇒ Object

Type casts a value for schema dumping. This method is private, as we are hoping to remove it entirely.



69
70
71
 
# File 'activemodel/lib/active_model/type/value.rb', line 69

def type_cast_for_schema(value) # :nodoc:
  value.inspect
end

#value_constructed_by_mass_assignment?(_value) ⇒ Boolean

:nodoc:

Returns:



107
108
109
 
# File 'activemodel/lib/active_model/type/value.rb', line 107

def value_constructed_by_mass_assignment?(_value) # :nodoc:
  false
end