kotovalexarian-likes-github
/
paper-trail-gem--paper_trail
mirror of https://github.com/paper-trail-gem/paper_trail.git
1
0
Fork 0
Code Releases Activity

Merge pull request #583 from airblade/extract_reify 

Extract functionality to module: Reifier
This commit is contained in:
Ben Atkins 2015-09-28 18:47:04 -04:00
parent 71ba6d3636 fbac7a6de8
commit f64c4f36ad
2 changed files with 253 additions and 219 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

252
lib/paper_trail/reifier.rb Normal file
View File

@ -0,0 +1,252 @@
module PaperTrail
# Given a version record and some options, builds a new model object.
# @api private
module Reifier
class << self
# See `VersionConcern#reify` for documentation.
# @api private
def reify(version, options)
options = options.dup
options.reverse_merge!(
:version_at => version.created_at,
:mark_for_destruction => false,
:has_one => false,
:has_many => false,
:unversioned_attributes => :nil
)
attrs = version.class.object_col_is_json? ?
version.object :
PaperTrail.serializer.load(version.object)
# Normally a polymorphic belongs_to relationship allows us to get the
# object we belong to by calling, in this case, `item`. However this
# returns nil if `item` has been destroyed, and we need to be able to
# retrieve destroyed objects.
#
# In this situation we constantize the `item_type` to get hold of the
# class...except when the stored object's attributes include a `type`
# key. If this is the case, the object we belong to is using single
# table inheritance and the `item_type` will be the base class, not the
# actual subclass. If `type` is present but empty, the class is the base
# class.
if options[:dup] != true && version.item
model = version.item
# Look for attributes that exist in the model and not in this
# version. These attributes should be set to nil.
if options[:unversioned_attributes] == :nil
(model.attribute_names - attrs.keys).each { |k| attrs[k] = nil }
end
else
inheritance_column_name = version.item_type.constantize.inheritance_column
class_name = attrs[inheritance_column_name].blank? ?
version.item_type :
attrs[inheritance_column_name]
klass = class_name.constantize
# The `dup` option always returns a new object, otherwise we should
# attempt to look for the item outside of default scope(s).
if options[:dup] || (_item = klass.unscoped.find_by_id(version.item_id)).nil?
model = klass.new
elsif options[:unversioned_attributes] == :nil
model = _item
# Look for attributes that exist in the model and not in this
# version. These attributes should be set to nil.
(model.attribute_names - attrs.keys).each { |k| attrs[k] = nil }
end
end
if PaperTrail.serialized_attributes?
model.class.unserialize_attributes_for_paper_trail! attrs
end
# Set all the attributes in this version on the model.
attrs.each do |k, v|
if model.has_attribute?(k)
model[k.to_sym] = v
elsif model.respond_to?("#{k}=")
model.send("#{k}=", v)
else
version.logger.warn(
"Attribute #{k} does not exist on #{version.item_type} (Version id: #{version.id})."
)
end
end
model.send "#{model.class.version_association_name}=", version
unless options[:has_one] == false
reify_has_ones version.transaction_id, model, options
end
unless options[:has_many] == false
reify_has_manys version.transaction_id, model, options
end
model
end
private
# Restore the `model`'s has_one associations as they were when this
# version was superseded by the next (because that's what the user was
# looking at when they made the change).
def reify_has_ones(transaction_id, model, options = {})
version_table_name = model.class.paper_trail_version_class.table_name
model.class.reflect_on_all_associations(:has_one).each do |assoc|
if assoc.klass.paper_trail_enabled_for_model?
version = model.class.paper_trail_version_class.joins(:version_associations).
where("version_associations.foreign_key_name = ?", assoc.foreign_key).
where("version_associations.foreign_key_id = ?", model.id).
where("#{version_table_name}.item_type = ?", assoc.class_name).
where("created_at >= ? OR transaction_id = ?", options[:version_at], transaction_id).
order("#{version_table_name}.id ASC").
first
if version
if version.event == 'create'
if options[:mark_for_destruction]
model.send(assoc.name).mark_for_destruction if model.send(assoc.name, true)
else
model.appear_as_new_record do
model.send "#{assoc.name}=", nil
end
end
else
child = version.reify(options.merge(:has_many => false, :has_one => false))
model.appear_as_new_record do
model.send "#{assoc.name}=", child
end
end
end
end
end
end
# Restore the `model`'s has_many associations as they were at version_at
# timestamp We lookup the first child versions after version_at timestamp or
# in same transaction.
def reify_has_manys(transaction_id, model, options = {})
assoc_has_many_through, assoc_has_many_directly =
model.class.reflect_on_all_associations(:has_many).
partition { |assoc| assoc.options[:through] }
reify_has_many_directly(transaction_id, assoc_has_many_directly, model, options)
reify_has_many_through(transaction_id, assoc_has_many_through, model, options)
end
# Restore the `model`'s has_many associations not associated through
# another association.
def reify_has_many_directly(transaction_id, associations, model, options = {})
version_table_name = model.class.paper_trail_version_class.table_name
associations.each do |assoc|
next unless assoc.klass.paper_trail_enabled_for_model?
version_id_subquery = PaperTrail::VersionAssociation.
joins(model.class.version_association_name).
select("MIN(version_id)").
where("foreign_key_name = ?", assoc.foreign_key).
where("foreign_key_id = ?", model.id).
where("#{version_table_name}.item_type = ?", assoc.class_name).
where("created_at >= ? OR transaction_id = ?", options[:version_at], transaction_id).
group("item_id").
to_sql
versions = model.
class.
paper_trail_version_class.
where("id IN (#{version_id_subquery})").
inject({}) { |acc, v| acc.merge!(v.item_id => v) }
# Pass true to force the model to load.
collection = Array.new model.send(assoc.name, true)
# Iterate each child to replace it with the previous value if there is
# a version after the timestamp.
collection.map! do |c|
if (version = versions.delete(c.id)).nil?
c
elsif version.event == 'create'
options[:mark_for_destruction] ? c.tap { |r| r.mark_for_destruction } : nil
else
version.reify(options.merge(:has_many => false, :has_one => false))
end
end
# Reify the rest of the versions and add them to the collection, these
# versions are for those that have been removed from the live
# associations.
collection += versions.values.map { |v| v.reify(options.merge(:has_many => false, :has_one => false)) }
model.send(assoc.name).proxy_association.target = collection.compact
end
end
# Restore the `model`'s has_many associations through another association.
# This must be called after the direct has_manys have been reified
# (reify_has_many_directly).
def reify_has_many_through(transaction_id, associations, model, options = {})
associations.each do |assoc|
next unless assoc.klass.paper_trail_enabled_for_model?
# Load the collection of through-models. For example, if `model` is a
# Chapter, having many Paragraphs through Sections, then
# `through_collection` will contain Sections.
through_collection = model.send(assoc.options[:through])
# Examine the `source_reflection`, i.e. the "source" of `assoc` the
# `ThroughReflection`. The source can be a `BelongsToReflection`
# or a `HasManyReflection`.
#
# If the association is a has_many association again, then call
# reify_has_manys for each record in `through_collection`.
if !assoc.source_reflection.belongs_to? && through_collection.present?
through_collection.each do |through_model|
reify_has_manys(transaction_id, through_model, options)
end
next
end
collection_keys = through_collection.map { |through_model|
through_model.send(assoc.association_foreign_key)
}
version_id_subquery = assoc.klass.paper_trail_version_class.
select("MIN(id)").
where("item_type = ?", assoc.class_name).
where("item_id IN (?)", collection_keys).
where("created_at >= ? OR transaction_id = ?", options[:version_at], transaction_id).
group("item_id").
to_sql
versions = assoc.
klass.
paper_trail_version_class.
where("id IN (#{version_id_subquery})").
inject({}) { |acc, v| acc.merge!(v.item_id => v) }
collection = Array.new assoc.klass.where(assoc.klass.primary_key => collection_keys)
# Iterate each child to replace it with the previous value if there is
# a version after the timestamp.
collection.map! do |c|
if (version = versions.delete(c.id)).nil?
c
elsif version.event == 'create'
options[:mark_for_destruction] ? c.tap { |r| r.mark_for_destruction } : nil
else
version.reify(options.merge(:has_many => false, :has_one => false))
end
end
# Reify the rest of the versions and add them to the collection, these
# versions are for those that have been removed from the live
# associations.
collection += versions.values.map { |v|
v.reify(options.merge(:has_many => false, :has_one => false))
}
model.send(assoc.name).proxy_association.target = collection.compact
end
end
end
end
end

220
lib/paper_trail/version_concern.rb
View File

@ -180,79 +180,8 @@ module PaperTrail
#
def reify(options = {})
return nil if object.nil?
without_identity_map do
options.reverse_merge!(
:version_at => created_at,
:mark_for_destruction => false,
:has_one => false,
:has_many => false,
:unversioned_attributes => :nil
)
attrs = self.class.object_col_is_json? ? object : PaperTrail.serializer.load(object)
# Normally a polymorphic belongs_to relationship allows us to get the
# object we belong to by calling, in this case, `item`. However this
# returns nil if `item` has been destroyed, and we need to be able to
# retrieve destroyed objects.
#
# In this situation we constantize the `item_type` to get hold of the
# class...except when the stored object's attributes include a `type`
# key. If this is the case, the object we belong to is using single
# table inheritance and the `item_type` will be the base class, not the
# actual subclass. If `type` is present but empty, the class is the base
# class.
if options[:dup] != true && item
model = item
# Look for attributes that exist in the model and not in this
# version. These attributes should be set to nil.
if options[:unversioned_attributes] == :nil
(model.attribute_names - attrs.keys).each { |k| attrs[k] = nil }
end
else
inheritance_column_name = item_type.constantize.inheritance_column
class_name = attrs[inheritance_column_name].blank? ? item_type : attrs[inheritance_column_name]
klass = class_name.constantize
# The `dup` option always returns a new object, otherwise we should
# attempt to look for the item outside of default scope(s).
if options[:dup] || (_item = klass.unscoped.find_by_id(item_id)).nil?
model = klass.new
elsif options[:unversioned_attributes] == :nil
model = _item
# Look for attributes that exist in the model and not in this
# version. These attributes should be set to nil.
(model.attribute_names - attrs.keys).each { |k| attrs[k] = nil }
end
end
if PaperTrail.serialized_attributes?
model.class.unserialize_attributes_for_paper_trail! attrs
end
# Set all the attributes in this version on the model.
attrs.each do |k, v|
if model.has_attribute?(k)
model[k.to_sym] = v
elsif model.respond_to?("#{k}=")
model.send("#{k}=", v)
else
logger.warn "Attribute #{k} does not exist on #{item_type} (Version id: #{id})."
end
end
model.send "#{model.class.version_association_name}=", self
unless options[:has_one] == false
reify_has_ones model, options
end
unless options[:has_many] == false
reify_has_manys model, options
end
model
::PaperTrail::Reifier.reify(self, options)
end
end
@ -325,153 +254,6 @@ module PaperTrail
end
end
# Restore the `model`'s has_one associations as they were when this
# version was superseded by the next (because that's what the user was
# looking at when they made the change).
def reify_has_ones(model, options = {})
version_table_name = model.class.paper_trail_version_class.table_name
model.class.reflect_on_all_associations(:has_one).each do |assoc|
if assoc.klass.paper_trail_enabled_for_model?
version = model.class.paper_trail_version_class.joins(:version_associations).
where("version_associations.foreign_key_name = ?", assoc.foreign_key).
where("version_associations.foreign_key_id = ?", model.id).
where("#{version_table_name}.item_type = ?", assoc.class_name).
where("created_at >= ? OR transaction_id = ?", options[:version_at], transaction_id).
order("#{version_table_name}.id ASC").first
if version
if version.event == 'create'
if options[:mark_for_destruction]
model.send(assoc.name).mark_for_destruction if model.send(assoc.name, true)
else
model.appear_as_new_record do
model.send "#{assoc.name}=", nil
end
end
else
child = version.reify(options.merge(:has_many => false, :has_one => false))
model.appear_as_new_record do
model.send "#{assoc.name}=", child
end
end
end
end
end
end
# Restore the `model`'s has_many associations as they were at version_at
# timestamp We lookup the first child versions after version_at timestamp or
# in same transaction.
def reify_has_manys(model, options = {})
assoc_has_many_through, assoc_has_many_directly =
model.class.reflect_on_all_associations(:has_many).
partition { |assoc| assoc.options[:through] }
reify_has_many_directly(assoc_has_many_directly, model, options)
reify_has_many_through(assoc_has_many_through, model, options)
end
# Restore the `model`'s has_many associations not associated through
# another association.
def reify_has_many_directly(associations, model, options = {})
version_table_name = model.class.paper_trail_version_class.table_name
associations.each do |assoc|
next unless assoc.klass.paper_trail_enabled_for_model?
version_id_subquery = PaperTrail::VersionAssociation.joins(model.class.version_association_name).
select("MIN(version_id)").
where("foreign_key_name = ?", assoc.foreign_key).
where("foreign_key_id = ?", model.id).
where("#{version_table_name}.item_type = ?", assoc.class_name).
where("created_at >= ? OR transaction_id = ?", options[:version_at], transaction_id).
group("item_id").to_sql
versions = model.class.paper_trail_version_class.where("id IN (#{version_id_subquery})").inject({}) do |acc, v|
acc.merge!(v.item_id => v)
end
# Pass true to force the model to load.
collection = Array.new model.send(assoc.name, true)
# Iterate each child to replace it with the previous value if there is
# a version after the timestamp.
collection.map! do |c|
if (version = versions.delete(c.id)).nil?
c
elsif version.event == 'create'
options[:mark_for_destruction] ? c.tap { |r| r.mark_for_destruction } : nil
else
version.reify(options.merge(:has_many => false, :has_one => false))
end
end
# Reify the rest of the versions and add them to the collection, these
# versions are for those that have been removed from the live
# associations.
collection += versions.values.map { |version| version.reify(options.merge(:has_many => false, :has_one => false)) }
model.send(assoc.name).proxy_association.target = collection.compact
end
end
# Restore the `model`'s has_many associations through another association.
# This must be called after the direct has_manys have been reified
# (reify_has_many_directly).
def reify_has_many_through(associations, model, options = {})
associations.each do |assoc|
next unless assoc.klass.paper_trail_enabled_for_model?
# Load the collection of through-models. For example, if `model` is a
# Chapter, having many Paragraphs through Sections, then
# `through_collection` will contain Sections.
through_collection = model.send(assoc.options[:through])
# Examine the `source_reflection`, i.e. the "source" of `assoc` the
# `ThroughReflection`. The source can be a `BelongsToReflection`
# or a `HasManyReflection`.
#
# If the association is a has_many association again, then call
# reify_has_manys for each record in `through_collection`.
if !assoc.source_reflection.belongs_to? && through_collection.present?
through_collection.each do |through_model|
reify_has_manys(through_model, options)
end
next
end
collection_keys = through_collection.map { |through_model|
through_model.send(assoc.association_foreign_key)
}
version_id_subquery = assoc.klass.paper_trail_version_class.
select("MIN(id)").
where("item_type = ?", assoc.class_name).
where("item_id IN (?)", collection_keys).
where("created_at >= ? OR transaction_id = ?", options[:version_at], transaction_id).
group("item_id").to_sql
versions = assoc.klass.paper_trail_version_class.where("id IN (#{version_id_subquery})").inject({}) do |acc, v|
acc.merge!(v.item_id => v)
end
collection = Array.new assoc.klass.where(assoc.klass.primary_key => collection_keys)
# Iterate each child to replace it with the previous value if there is
# a version after the timestamp.
collection.map! do |c|
if (version = versions.delete(c.id)).nil?
c
elsif version.event == 'create'
options[:mark_for_destruction] ? c.tap { |r| r.mark_for_destruction } : nil
else
version.reify(options.merge(:has_many => false, :has_one => false))
end
end
# Reify the rest of the versions and add them to the collection, these
# versions are for those that have been removed from the live
# associations.
collection += versions.values.map { |version| version.reify(options.merge(:has_many => false, :has_one => false)) }
model.send(assoc.name).proxy_association.target = collection.compact
end
end
# Checks that a value has been set for the `version_limit` config
# option, and if so enforces it.
def enforce_version_limit!