Module Mongoid::Versioning
In: lib/mongoid/versioning.rb

Include this module to get automatic versioning of root level documents. This will add a version field to the Document and a has_many association with all the versions contained in it.

Methods

Public Instance methods

Create a new version of the Document. This will load the previous document from the database and set it as the next version before saving the current document. It then increments the version number. If a max_versions limit is set in the model and it‘s exceeded, the oldest version gets discarded.

@example Revise the document.

  person.revise

@since 1.0.0

Forces the creation of a new version of the Document, regardless of whether a change was actually made.

@example Revise the document.

  person.revise!

@since 2.2.1

Filters the results of attributes by removing any fields that should not be versioned.

@return [ Hash ] A hash of versioned attributes.

@since 2.1.0

Check if any versioned fields have been modified. This is similar to +changed?+, except this method also ignores fields set to be ignored by versioning.

@return [ Boolean ] Whether fields that will be versioned have changed.

@since 2.1.0

Filters the results of changes by removing any fields that should not be versioned.

@return [ Hash ] A hash of versioned changed attributes.

@since 2.1.0

Executes a block that temporarily disables versioning. This is for cases where you do not want to version on every save.

@example Execute a save without versioning.

  person.versionless(&:save)

@return [ Object ] The document or result of the block execution.

@since 2.0.0

[Validate]