https://github.com/umbrellio/sequel-bulk-audit

Sequel plugin for tracking changes in your data.
https://github.com/umbrellio/sequel-bulk-audit

audit changes logging sequel

Last synced: 3 months ago
JSON representation

Sequel plugin for tracking changes in your data.

• Host: GitHub
• URL: https://github.com/umbrellio/sequel-bulk-audit
• Owner: umbrellio
• License: mit
• Created: 2018-03-12T05:39:20.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2020-03-04T14:05:33.000Z (almost 5 years ago)
• Last Synced: 2024-10-30T13:45:21.442Z (4 months ago)
• Topics: audit, changes, logging, sequel
• Language: Ruby
• Size: 45.9 KB
• Stars: 4
• Watchers: 5
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# sequel-bulk-audit [![Gem Version](https://badge.fury.io/rb/sequel-bulk-audit.svg)](https://badge.fury.io/rb/sequel-bulk-audit) [![Build Status](https://travis-ci.org/umbrellio/sequel-bulk-audit.svg?branch=master)](https://travis-ci.org/umbrellio/sequel-bulk-audit)

This gem allows you to track any changes in your tables. This approach is not only suitable for model updates but also enables you to track dataset updates.

Method #with_current_user expects current_user to be an object (or record) having attributes id and login. It sets user_id as 0 and login as "unspecified" by default.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'sequel-bulk-audit'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install sequel-bulk-audit

After installation you should run ```rails g audit_migration``` generator.

You can exdend this migration by attaching the trigger to audited tables.

Please note, that this gem reqires pg_array and pg_json sequel extensions to work.

## Usage

Models with audited changes should contain:

```ruby

plugin :bulk_audit

```

Method #with_current_user should wrap all the operations on the table. You must use method from the model you are changing for this gem to work correclty. 

Keep in mind that everything wraped in #with_current_user will happen in one transaction.

Correct usage:

```ruby

Model.with_current_user(current_user) do

  Model.where(...).update(...)

end

```

Correct usage for several models in one transaction:

```ruby

DB.transaction do

  Model.with_current_user(current_user) do # will create temp table for model

    Model.where(...).update(...)

  end

  OtherModel.with_current_user(current_user) do # will create temp table for other_model

    OtherModel.where(...).update(...)

  end

end

```

Incorrect usage:

```ruby

SomeOtherModel.with_current_user(current_user) do

  Model.where(...).update(...)

end

```

## Migration from 0.2.0 to 1.0.0

Recreate audit_changes() function with new changes.

## 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/umbrellio/sequel-bulk-audit.