path: root/activerecord/lib/active_record/attribute_methods/time_zone_conversion.rb

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
        # 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
                zoned_time   = time && time.in_time_zone rescue nil
                rounded_time = round_usec(zoned_time)
                rounded_value = round_usec(read_attribute("#{attr_name}"))
                if (rounded_value != rounded_time) || (!rounded_value && original_time)
                  write_attribute("#{attr_name}", original_time)
                  #{attr_name}_will_change!
                  @attributes_cache[:"#{attr_name}"] = zoned_time
                end
              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

      private
      def round_usec(value)
        return unless value
        value.change(:usec => 0)
      end
    end
  end
end