123456789_123456789_123456789_123456789_123456789_

Class: ActiveModel::Type::Date

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Subclasses:
ActiveRecord::Type::Date, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Date
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Value
Instance Chain:
self, Helpers::Timezone, Value, SerializeCastValue
Inherits: ActiveModel::Type::Value
Defined in: activemodel/lib/active_model/type/date.rb

Overview

Active Model Date Type

::ActiveModel::Attribute type for date representation. It is registered under the :date key.

class Person
  include ActiveModel::Attributes

  attribute :birthday, :date
end

person = Person.new
person.birthday = "1989-07-13"

person.birthday.class # => Date
person.birthday.year  # => 1989
person.birthday.month # => 7
person.birthday.day   # => 13

String values are parsed using the ISO 8601 date format. Any other values are cast using their to_date method, if it exists.

Constant Summary

Class Method Summary

Value - Inherited

.new

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

Instance Attribute Summary

Helpers::Timezone - Included

#is_utc?

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::Timezone - Included

#default_timezone

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



def cast_value(value)
  if value.is_a?(::String)
    return if value.empty?
    fast_string_to_date(value) || fallback_string_to_date(value)
  elsif value.respond_to?(:to_date)
    value.to_date
  else
    value
  end
end


  








  

    #fallback_string_to_date(string)   (private)
  

  [ GitHub ]


  

  


# File 'activemodel/lib/active_model/type/date.rb', line 57



def fallback_string_to_date(string)
  parts = begin
    ::Date._parse(string, false)
  rescue ArgumentError
  end

  new_date(*parts.values_at(:year, :mon, :mday)) if parts
end


  








  

    #fast_string_to_date(string)   (private)
  

  [ GitHub ]


  

  


# File 'activemodel/lib/active_model/type/date.rb', line 51



def fast_string_to_date(string)
  if string =~ ISO_DATE
    new_date $1.to_i, $2.to_i, $3.to_i
  end
end


  








  

    #new_date(year, mon, mday)   (private)
  

  [ GitHub ]


  

  


# File 'activemodel/lib/active_model/type/date.rb', line 66



def new_date(year, mon, mday)
  unless year.nil? || (year == 0 && mon == 0 && mday == 0)
    ::Date.new(year, mon, mday) rescue nil
  end
end


  








  

    #type  
  

  [ GitHub ]


  

  


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



def type
  :date
end


  








  

    #type_cast_for_schema(value)  
  

  [ GitHub ]


  

  


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



def type_cast_for_schema(value)
  value.to_fs(:db).inspect
end


  








  

    #value_from_multiparameter_assignment   (private)
  

  [ GitHub ]


  

  


# File 'activemodel/lib/active_model/type/date.rb', line 72



def value_from_multiparameter_assignment(*)
  time = super
  time && new_date(time.year, time.mon, time.mday)
end