Class: ActiveModel::Type::DateTime

Inherits:
Value
  • Object
show all
Includes:
Helpers::TimeValue, Helpers::Timezone
Defined in:
lib/active_model/type/date_time.rb

Overview

Active Model DateTime Type

Attribute type to represent dates and times. It is registered under the :datetime key.

class Event
  include ActiveModel::Attributes

  attribute :start, :datetime
end

event = Event.new
event.start = "Wed, 04 Sep 2013 03:00:00 EAT"

event.start.class # => Time
event.start.year  # => 2013
event.start.month # => 9
event.start.day   # => 4
event.start.hour  # => 3
event.start.min   # => 0
event.start.sec   # => 0
event.start.zone  # => "EAT"

String values are parsed using the ISO 8601 datetime format. Partial time-only formats are also accepted.

event.start = "06:07:08+09:00"
event.start.utc # => 1999-12-31 21:07:08 UTC

The degree of sub-second precision can be customized when declaring an attribute:

class Event
  include ActiveModel::Attributes

  attribute :start, :datetime, precision: 4
end

Instance Attribute Summary

Attributes inherited from Value

#limit, #precision, #scale

Instance Method Summary collapse

Methods included from Helpers::TimeValue

#apply_seconds_precision, #serialize_cast_value, #type_cast_for_schema, #user_input_in_time_zone

Methods included from Helpers::Timezone

#default_timezone, #is_utc?

Methods inherited from Value

#==, #as_json, #assert_valid_value, #binary?, #cast, #changed?, #changed_in_place?, #deserialize, #force_equality?, #hash, #initialize, #map, #mutable?, #serializable?, #serialize, #serialized?, #type_cast_for_schema, #value_constructed_by_mass_assignment?

Methods included from SerializeCastValue

included, #initialize, #itself_if_serialize_cast_value_compatible, serialize

Constructor Details

This class inherits a constructor from ActiveModel::Type::Value

Instance Method Details

#type ⇒ Object 



49
50
51
 
# File 'lib/active_model/type/date_time.rb', line 49

def type
  :datetime
end