PaperTrail::ActiveRecordExt

Various ActiveRecord extensions to make your life easier when working with PaperTrail versions and versioned model records.

• .versions
• .find_deleted_version
• .find_deleted
• .has_many_versions
• .has_related_versions
• .has_versions_with_all_related
• created_version
• paper_trail_update_column_using_value_from_changes
• paper_trail_update_columns_using_value_from_changes

• .preceding_inclusive
• .between_inclusive
• scope :where_object_changed
• scope :where_object_changed_any
• #action
• #item_class

Defines a {association}_or_deleted method for the given association. This method will call the usual association method to try to find the associated record but if that returns nil, will fall back to looking for a deleted record from the versions history (using klass.find_deleted).

You can replace the or_deleted part with a different suffix using suffix: option.

You can even give it the same name as the existing association method if you want to override the existing method with one that always falls back to looking for a deleted record.

class Post
  belongs_to :author
  # overrides author method with a version that finds deleted if not found
  define_assoc_or_deleted :author, suffix: nil

If you include PaperTrail::ActiveRecordExt::OrDeleted into a model, it will automatically add a {association}_or_deleted method for every belongs_to or has_one association that is defined.

Because it reflects on all associations on that model as soon as it is included, make sure to include it after all of your associations are defined. You can also call define_assoc_or_deleted_on_all_associations at the end of your model class (that is the same method that including the module triggers).

If you want it to automatically be added for all assocations on all application models, you can use gem 'active_record_include' like this:

  class ApplicationRecord < ActiveRecord::Base
    include_when_connected PaperTrail::ActiveRecordExt::OrDeleted

Add this line to your application's Gemfile:

gem 'paper_trail-active_record'

And then execute:

$ bundle

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/TylerRick/paper_trail-active_record.