Mongoid::PendingChanges

Build Status

Gem Version

Mongoid::PendingChanges adds an option to keep further changes from modifying the record, pushing them to a changelist instead.

This is an initial effort to develop an approval system to control changes to collections.

Change Log

v0.3.0: Adding methods '#apply_change' and '#reject_change'

v0.2.0a: Adding method #get_change_number, which returns the change from the changelist with the specified number

v0.1.2: Fixing a bug where records created before the gem was used would cause an exception due to the required fields being nil.

Installation

Add this line to your application's Gemfile:

gem 'mongoid-pending_changes'

And then execute:

$ bundle

Or install it yourself as:

$ gem install mongoid-pending_changes

Usage

Add the following line to the models you want to track

class Model
    include Mongoid::PendingChanges

    field :example, type: String
end

Then, when you want to have changes that require approval, call

model.push_for_approval {example: 'new example value'}

Your model will keep the original value, but a new entry will be added to the changelist property, with all changes and an incrementing ID.

If you need to recover a specific change from the changelist, you can use 

change = model.get_change_number 1

Then you can use change[:data][:example] == 'new example value', for example.

If you want to apply a change to the model, you can call

model.apply_change 1

Then you can use model.example == 'new example_value'. Also, model.changelist[1][:backup] will store the old value, if there was one.

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/matheus208/mongoid-pending_changes.

TODO list

  • Write the TODO list