https://github.com/irvanfza/administrate-field-paper_trail

An Administrate plugin to show record change histories from PaperTrail
https://github.com/irvanfza/administrate-field-paper_trail

administrate administrate-field paper-trail ruby ruby-gem ruby-on-rails

Last synced: 2 months ago
JSON representation

An Administrate plugin to show record change histories from PaperTrail

• Host: GitHub
• URL: https://github.com/irvanfza/administrate-field-paper_trail
• Owner: IrvanFza
• License: mit
• Created: 2023-01-11T12:26:10.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-02-01T09:14:04.000Z (11 months ago)
• Last Synced: 2024-10-15T19:41:02.860Z (3 months ago)
• Topics: administrate, administrate-field, paper-trail, ruby, ruby-gem, ruby-on-rails
• Language: Ruby
• Homepage:
• Size: 5.86 KB
• Stars: 5
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# AdministrateFieldPaperTrail

![Gem](https://img.shields.io/gem/v/administrate-field-paper_trail.svg)

![CI](https://github.com/IrvanFza/administrate-field-paper_trail/workflows/CI/badge.svg)

An [Administrate](https://github.com/thoughtbot/administrate/) plugin to show record change histories from [PaperTrail](https://github.com/paper-trail-gem/paper_trail).

## Requirements

- Ruby on Rails version >= 5.0

- Administrate version >= 0.2.2

- PaperTrail version >= 2.7.2

## Installation

Make sure you already setup [PaperTrail](https://github.com/paper-trail-gem/paper_trail#1b-installation) properly in your project.

Add `administrate-field-paper_trail` to your Gemfile:

```ruby

gem 'administrate-field-paper_trail'

```

And then execute:

```

$ bundle install

```

## Usage

Add to your `UserDashboard`:

```ruby

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:

```ruby

SHOW_PAGE_ATTRIBUTES = %i[

  changeset

]

```

Currently, only support to show changes in the show page. Contribution will be appreciated.

## To Do

- [x] 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

1. Contribution are welcome (codes, suggestions, and bugs)

2. Please test your code: `bundle exec rspec`

3. Please document your code

4. Bug reports and pull requests are welcome on GitHub at https://github.com/IrvanFza/administrate-field-paper_trail

## License

[MIT License](https://github.com/IrvanFza/administrate-field-paper_trail/blob/master/LICENSE.md)

---

Based on the [Administrate::Field::Image](https://github.com/thoughtbot/administrate-field-image) template