Skip to content

przemosk/entity_history

Repository files navigation

EntityHistory

This is a tool that will help you keep track of changes related to your models.

Background

TODO

Installation

Add to your Gemfile:

gem "entity_history", git: "https://github.com/przemosk/entity_history"

run installer:

rails generate entity_history:install which copy entity_history.rbfile into your initializer directory. ( please remember about restart your app server)

copy migration into your app:rails generate entity_history:copy_migration

run migration: rails db:migrate

Usage

After successful database migration, the next step is to use in your model method log_entity_history as below:

class Book
  log_entity_history

end

Configuration

EntityHistorySerializer

Default entity history entry log
 {
   :action=>"update",
   :event_id=>"a39c837b-d443-4a62-898b-ca2d049d958f",
   :attributes=>
     {
       "id"=>24,
       "title"=>"Some Cool Novel Title",
       "author"=>"Tom Jones",
       "isbn"=>nil,
       "created_at"=>Thu, 30 Nov 2023 13:26:34.376937000 UTC +00:00,
       "updated_at"=>Tue, 12 Dec 2023 15:34:00.784779000 UTC +00:00
     },
   :changes=>
     [
       {"isbn"=>{:from=>nil, :to=>"TJ7838383"}},
       {"updated_at"=>{:from=>Tue, 12 Dec 2023 10:14:35.343564000 UTC +00:00, :to=>Tue, 12 Dec 2023 15:34:00.784779000 UTC +00:00}}
     ]
  }

TODO

Development

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 the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/entity_history. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the EntityHistory project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages