mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
16ae3db5a5
We pretty frequently get bug reports that "dirty is broken inside of after callbacks". Intuitively they are correct. You'd expect `Model.after_save { puts changed? }; model.save` to do the same thing as `model.save; puts model.changed?`, but it does not. However, changing this goes much farther than just making the behavior more intuitive. There are a _ton_ of places inside of AR that can be drastically simplified with this change. Specifically, autosave associations, timestamps, touch, counter cache, and just about anything else in AR that works with callbacks have code to try to avoid "double save" bugs which we will be able to flat out remove with this change. We introduce two new sets of methods, both with names that are meant to be more explicit than dirty. The first set maintains the old behavior, and their names are meant to center that they are about changes that occurred during the save that just happened. They are equivalent to `previous_changes` when called outside of after callbacks, or once the deprecation cycle moves. The second set is the new behavior. Their names imply that they are talking about changes from the database representation. The fact that this is what we really care about became clear when looking at `BelongsTo.touch_record` when tests were failing. I'm unsure that this set of methods should be in the public API. Outside of after callbacks, they are equivalent to the existing methods on dirty. Dirty itself is not deprecated, nor are the methods inside of it. They will only emit the warning when called inside of after callbacks. The scope of this breakage is pretty large, but the migration path is simple. Given how much this can improve our codebase, and considering that it makes our API more intuitive, I think it's worth doing.
132 lines
3.9 KiB
Ruby
132 lines
3.9 KiB
Ruby
module ActiveRecord
|
|
# = Active Record \Timestamp
|
|
#
|
|
# Active Record automatically timestamps create and update operations if the
|
|
# table has fields named <tt>created_at/created_on</tt> or
|
|
# <tt>updated_at/updated_on</tt>.
|
|
#
|
|
# Timestamping can be turned off by setting:
|
|
#
|
|
# config.active_record.record_timestamps = false
|
|
#
|
|
# Timestamps are in UTC by default but you can use the local timezone by setting:
|
|
#
|
|
# config.active_record.default_timezone = :local
|
|
#
|
|
# == Time Zone aware attributes
|
|
#
|
|
# Active Record keeps all the <tt>datetime</tt> and <tt>time</tt> columns
|
|
# timezone aware. By default, these values are stored in the database as UTC
|
|
# and converted back to the current <tt>Time.zone</tt> when pulled from the database.
|
|
#
|
|
# This feature can be turned off completely by setting:
|
|
#
|
|
# config.active_record.time_zone_aware_attributes = false
|
|
#
|
|
# You can also specify that only <tt>datetime</tt> columns should be time-zone
|
|
# aware (while <tt>time</tt> should not) by setting:
|
|
#
|
|
# ActiveRecord::Base.time_zone_aware_types = [:datetime]
|
|
#
|
|
# You can also add database specific timezone aware types. For example, for PostgreSQL:
|
|
#
|
|
# ActiveRecord::Base.time_zone_aware_types += [:tsrange, :tstzrange]
|
|
#
|
|
# Finally, you can indicate specific attributes of a model for which time zone
|
|
# conversion should not applied, for instance by setting:
|
|
#
|
|
# class Topic < ActiveRecord::Base
|
|
# self.skip_time_zone_conversion_for_attributes = [:written_on]
|
|
# end
|
|
module Timestamp
|
|
extend ActiveSupport::Concern
|
|
|
|
included do
|
|
class_attribute :record_timestamps
|
|
self.record_timestamps = true
|
|
end
|
|
|
|
def initialize_dup(other) # :nodoc:
|
|
super
|
|
clear_timestamp_attributes
|
|
end
|
|
|
|
private
|
|
|
|
def _create_record
|
|
if record_timestamps
|
|
current_time = current_time_from_proper_timezone
|
|
|
|
all_timestamp_attributes.each do |column|
|
|
column = column.to_s
|
|
if has_attribute?(column) && !attribute_present?(column)
|
|
write_attribute(column, current_time)
|
|
end
|
|
end
|
|
end
|
|
|
|
super
|
|
end
|
|
|
|
def _update_record(*args, touch: true, **options)
|
|
if touch && should_record_timestamps?
|
|
current_time = current_time_from_proper_timezone
|
|
|
|
timestamp_attributes_for_update_in_model.each do |column|
|
|
column = column.to_s
|
|
next if will_save_change_to_attribute?(column)
|
|
write_attribute(column, current_time)
|
|
end
|
|
end
|
|
super(*args)
|
|
end
|
|
|
|
def should_record_timestamps?
|
|
record_timestamps && (!partial_writes? || has_changes_to_save?)
|
|
end
|
|
|
|
def timestamp_attributes_for_create_in_model
|
|
timestamp_attributes_for_create.select { |c| self.class.column_names.include?(c.to_s) }
|
|
end
|
|
|
|
def timestamp_attributes_for_update_in_model
|
|
timestamp_attributes_for_update.select { |c| self.class.column_names.include?(c.to_s) }
|
|
end
|
|
|
|
def all_timestamp_attributes_in_model
|
|
timestamp_attributes_for_create_in_model + timestamp_attributes_for_update_in_model
|
|
end
|
|
|
|
def timestamp_attributes_for_update
|
|
[:updated_at, :updated_on]
|
|
end
|
|
|
|
def timestamp_attributes_for_create
|
|
[:created_at, :created_on]
|
|
end
|
|
|
|
def all_timestamp_attributes
|
|
timestamp_attributes_for_create + timestamp_attributes_for_update
|
|
end
|
|
|
|
def max_updated_column_timestamp(timestamp_names = timestamp_attributes_for_update)
|
|
timestamp_names
|
|
.map { |attr| self[attr] }
|
|
.compact
|
|
.map(&:to_time)
|
|
.max
|
|
end
|
|
|
|
def current_time_from_proper_timezone
|
|
self.class.default_timezone == :utc ? Time.now.utc : Time.now
|
|
end
|
|
|
|
# Clear attributes and changed_attributes
|
|
def clear_timestamp_attributes
|
|
all_timestamp_attributes_in_model.each do |attribute_name|
|
|
self[attribute_name] = nil
|
|
clear_attribute_changes([attribute_name])
|
|
end
|
|
end
|
|
end
|
|
end
|