AdministrateFieldPaperTrail
An Administrate plugin to show record change histories from PaperTrail.
Requirements
- Ruby on Rails version >= 5.0
- Administrate version >= 0.2.2
- PaperTrail version >= 2.7.2
Installation
Make sure you already setup PaperTrail properly in your project.
Add administrate-field-paper_trail
to your Gemfile:
gem 'administrate-field-paper_trail'
And then execute:
$ bundle install
Usage
Add to your UserDashboard
:
ATTRIBUTE_TYPES = {
changeset: Field::PaperTrail.with_options(excluded_attributes: %w[created_at updated_at]),
}
The excluded_attributes
option takes an array of string of the attributes you want to exclude from the result. Default excluded attributes are: id
, created_at
, and updated_at
.
Then show the field in your show page like so:
SHOW_PAGE_ATTRIBUTES = %i[
changeset
]
Currently, only support to show changes in the show page. Contribution will be appreciated.
To Do
- Show record changes information in the show page
- Show count of changes of each records in the index page
- Add i18n support for the result message
- Add i18n support for date/time value
Contributing
- Contribution are welcome (codes, suggestions, and bugs)
- Please test your code:
bundle exec rspec
- Please document your code
- Bug reports and pull requests are welcome on GitHub at https://github.com/IrvanFza/administrate-field-paper_trail
License
Based on the Administrate::Field::Image template