123456789_123456789_123456789_123456789_123456789_

Class: ActiveModel::Type::Time

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

Overview

Active Model Time Type

::ActiveModel::Attribute type for time of day representation. It is registered under the :time key.

class Event
  include ActiveModel::Attributes

  attribute :start, :time
end

String values are parsed using the ISO 8601 datetime format, but are normalized to have a date of 2000-01-01 and be in the UTC time zone.

event = Event.new
event.start = "2004-10-25T01:23:45-06:00"

event.start.class # => Time
event.start       # => 2000-01-01 07:23:45 UTC

Partial time-only formats are also accepted.

event.start = "00:01:02+03:00"
event.start # => 1999-12-31 21:01:02 UTC

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

class Event
  include ActiveModel::Attributes

  attribute :start, :time, precision: 4
end

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

#apply_seconds_precision, #serialize_cast_value, #type_cast_for_schema, #user_input_in_time_zone,
#fast_string_to_time

BUG: Wrapping the Time object with Time.at because Time.new with in: in Ruby 3.2.0 used to return an invalid Time object see: bugs.ruby-lang.org/issues/19292.
#new_time

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/time.rb', line 69



def cast_value(value)
  return apply_seconds_precision(value) unless value.is_a?(::String)
  return if value.blank?

  dummy_time_value = value.sub(/\A\d{4}-\d\d-\d\d(?:T|\s)|/, "2000-01-01 ")

  fast_string_to_time(dummy_time_value) || begin
    time_hash = begin
      ::Date._parse(dummy_time_value)
    rescue ArgumentError
    end

    return if time_hash.nil? || time_hash[:hour].nil?
    new_time(*time_hash.values_at(:year, :mon, :mday, :hour, :min, :sec, :sec_fraction, :offset))
  end
end


  








  

    #type  
  

  [ GitHub ]


  

  


# File 'activemodel/lib/active_model/type/time.rb', line 45



def type
  :time
end


  








  

    #user_input_in_time_zone(value)  
  

  [ GitHub ]


  

  


# File 'activemodel/lib/active_model/type/time.rb', line 49



def user_input_in_time_zone(value)
  return unless value.present?

  case value
  when ::String
    value = "2000-01-01 #{value}"
    time_hash = begin
      ::Date._parse(value)
    rescue ArgumentError
    end

    return if time_hash.nil? || time_hash[:hour].nil?
  when ::Time
    value = value.change(year: 2000, day: 1, month: 1)
  end

  super(value)
end