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

Add documentation for where_object method

This commit is contained in:
Jacob Evelyn 2014-09-21 10:29:14 -04:00
parent a683be88ea
commit fd0bc5ff40
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -135,7 +135,7 @@ Widget.paper_trail_off!
# Turn PaperTrail on for all widgets.
Widget.paper_trail_on!
# Check wheter PaperTrail is enabled for all widgets
# Check whether PaperTrail is enabled for all widgets.
Widget.paper_trail_enabled_for_model?
widget.paper_trail_enabled_for_model?
```
@ -168,6 +168,9 @@ version.index
# Returns the event that caused this version (create|update|destroy).
version.event
# Query versions objects by attributes.
PaperTrail::Version.where_object(attr1: val1, attr2: val2)
```
In your controllers you can override these methods:
@ -436,7 +439,7 @@ You can find out which of an item's versions yours is:
>> current_version_number = version.index # 0-based
```
Finally, if you got an item by reifying one of its versions, you can navigate back to the version it came from:
If you got an item by reifying one of its versions, you can navigate back to the version it came from:
```ruby
>> latest_version = Widget.find(42).versions.last
@ -453,6 +456,13 @@ You can find out whether a model instance is the current, live one -- or whether
>> widget.live? # false
```
And you can perform `WHERE` queries for object versions based on attributes:
```ruby
>> # All versions that meet these criteria.
>> PaperTrail::Version.where_object(content: "Hello", title: "Article")
```
## Finding Out Who Was Responsible For A Change
If your `ApplicationController` has a `current_user` method, PaperTrail will store the value it returns in the version's `whodunnit` column. Note that this column is of type `String`, so you will have to convert it to an integer if it's an id and you want to look up the user later on: