aboutsummaryrefslogtreecommitdiffstats
path: root/activerecord/lib/active_record/attribute_methods/time_zone_conversion.rb
blob: b060e5c06f91048e02cbc404c501adf64014a359 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
require 'active_support/core_ext/class/attribute'

module ActiveRecord
  ActiveSupport.on_load(:active_record_config) do
    mattr_accessor :time_zone_aware_attributes, instance_accessor: false
    self.time_zone_aware_attributes = false

    mattr_accessor :skip_time_zone_conversion_for_attributes, instance_accessor: false
    self.skip_time_zone_conversion_for_attributes = []
  end

  module AttributeMethods
    module TimeZoneConversion
      class Type # :nodoc:
        def initialize(column)
          @column = column
        end

        def type_cast(value)
          value = @column.type_cast(value)
          value.acts_like?(:time) ? value.in_time_zone : value
        end

        def type
          @column.type
        end
      end

      extend ActiveSupport::Concern

      included do
        config_attribute :time_zone_aware_attributes, global: true
        config_attribute :skip_time_zone_conversion_for_attributes
      end

      module ClassMethods
        protected
        # The enhanced read method automatically converts the UTC time stored in the database to the time
        # zone stored in Time.zone.
        def attribute_cast_code(attr_name)
          column = columns_hash[attr_name]

          if create_time_zone_conversion_attribute?(attr_name, column)
            typecast             = "v = #{super}"
            time_zone_conversion = "v.acts_like?(:time) ? v.in_time_zone : v"

            "((#{typecast}) && (#{time_zone_conversion}))"
          else
            super
          end
        end

        # Defined for all +datetime+ and +timestamp+ attributes when +time_zone_aware_attributes+ are enabled.
        # This enhanced write method will automatically convert the time passed to it to the zone stored in Time.zone.
        def define_method_attribute=(attr_name)
          if create_time_zone_conversion_attribute?(attr_name, columns_hash[attr_name])
            method_body, line = <<-EOV, __LINE__ + 1
              def #{attr_name}=(original_time)
                time = original_time
                unless time.acts_like?(:time)
                  time = time.is_a?(String) ? Time.zone.parse(time) : time.to_time rescue time
                end
                time = time.in_time_zone rescue nil if time
                changed = read_attribute(:#{attr_name}) != time
                write_attribute(:#{attr_name}, original_time)
                #{attr_name}_will_change! if changed
                @attributes_cache["#{attr_name}"] = time
              end
            EOV
            generated_attribute_methods.module_eval(method_body, __FILE__, line)
          else
            super
          end
        end

        private
        def create_time_zone_conversion_attribute?(name, column)
          time_zone_aware_attributes &&
            !self.skip_time_zone_conversion_for_attributes.include?(name.to_sym) &&
            [:datetime, :timestamp].include?(column.type)
        end
      end
    end
  end
end