Module: PaperTrail::VersionConcern

Extended by:
ActiveSupport::Concern
Included in:
Version
Defined in:
lib/paper_trail/version_concern.rb

Overview

Originally, PaperTrail did not provide this module, and all of this functionality was in ‘PaperTrail::Version`. That model still exists (and is used by most apps) but by moving the functionality to this module, people can include this concern instead of sub-classing the `Version` model.

Defined Under Namespace

Modules: ClassMethods

Constant Summary collapse

E_YAML_PERMITTED_CLASSES = 
<<-EOS.squish.freeze
  PaperTrail encountered a Psych::DisallowedClass error during
  deserialization of YAML column, indicating that
  yaml_column_permitted_classes has not been configured correctly. %s
EOS

Instance Method Summary collapse

Instance Method Details

#changeset ⇒ Object

Returns what changed in this version of the item. ‘ActiveModel::Dirty#changes`. returns `nil` if your `versions` table does not have an `object_changes` text column.



280
281
282
283
 
# File 'lib/paper_trail/version_concern.rb', line 280

def changeset
  return nil unless self.class.column_names.include? "object_changes"
  @changeset ||= load_changeset
end

#index ⇒ Object

Returns an integer representing the chronological position of the version among its siblings. The “create” event, for example, has an index of 0.



310
311
312
 
# File 'lib/paper_trail/version_concern.rb', line 310

def index
  @index ||= RecordHistory.new(sibling_versions, self.class).index(self)
end

#next ⇒ Object 



297
298
299
 
# File 'lib/paper_trail/version_concern.rb', line 297

def next
  @next ||= sibling_versions.subsequent(self).first
end

#object_deserialized ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



244
245
246
247
248
249
250
 
# File 'lib/paper_trail/version_concern.rb', line 244

def object_deserialized
  if self.class.object_col_is_json?
    object
  else
    PaperTrail.serializer.load(object)
  end
end

#paper_trail_originator ⇒ Object

Returns who put the item into the state stored in this version.



286
287
288
 
# File 'lib/paper_trail/version_concern.rb', line 286

def paper_trail_originator
  @paper_trail_originator ||= previous.try(:whodunnit)
end

#previous ⇒ Object 



301
302
303
 
# File 'lib/paper_trail/version_concern.rb', line 301

def previous
  @previous ||= sibling_versions.preceding(self).first
end

#reify(options = {}) ⇒ Object

Restore the item from this version.

Options:

  • :mark_for_destruction

    • ‘true` - Mark the has_one/has_many associations that did not exist in the reified version for destruction, instead of removing them.

    • ‘false` - Default. Useful for persisting the reified version.

  • :dup

    • ‘false` - Default.

    • ‘true` - Always create a new object instance. Useful for comparing two versions of the same object.

  • :unversioned_attributes

    • ‘:nil` - Default. Attributes undefined in version record are set to nil in reified record.

    • ‘:preserve` - Attributes undefined in version record are not modified.



269
270
271
272
273
274
275
 
# File 'lib/paper_trail/version_concern.rb', line 269

def reify(options = {})
  unless self.class.column_names.include? "object"
    raise Error, "reify requires an object column"
  end
  return nil if object.nil?
  ::PaperTrail::Reifier.reify(self, options)
end

#terminator ⇒ Object Also known as: version_author

Returns who changed the item from the state it had in this version. This is an alias for ‘whodunnit`.



292
293
294
 
# File 'lib/paper_trail/version_concern.rb', line 292

def terminator
  @terminator ||= whodunnit
end