Undo

ActiveModel serializer for Undo gem.

Does not require anything from Rails so is friendly to use with POROs.

Installation
Requirements
Contacts
Compatibility
Contributing
Copyright

Installation

Add this line to your application's Gemfile:

gem 'undo-serializer-active_model'

And then execute:

$ bundle

Or install it yourself as:

$ gem install undo-serializer-active_model

Most likely you'll install undo gem as well:

$ gem install undo

Requirements

Ruby >= 1.9
Undo gem

Usage

Gem is designed to be used with Undo gem.
Customize Undo to use serializer in global configuration:

Undo.configure do |config|
  config.serializer = Undo::Serializer::ActiveModel.new
end

Custom primary_key set, find_or_initialize and persist Procs could be provided to the adapter:

Undo.configure do |config|
  config.serializer = Undo::Serializer::ActiveModel.new(
      primary_key: [:id, :status],
      find_or_initialize: ->(object_class, pk_attributes) { object_class.find_or_initialize_by pk_attributes },
      serialize_attributes: ->(object) { object.serializable_hash },
      persist: ->(object) { object.save! },
    )
end

For ActiveRecord Undo uses reasonable defaults, so most of the time it is not needed to overwrite them. It should work with most Virtus objects as well.

As usual any Undo configuration may be set in place on store, wrap and restore:

Undo.store user, serializer: Undo::Serializer::ActiveRecord.new(primary_key: :uuid)
Undo.restore uuid, primary_key: :uuid, persist: ->(object) { object.write_to_disk! }

Associations

Add include option to serialize the association

uuid = Undo.store post, include: comments
Undo.restore uuid

Will restore post with related comments.

Contacts

Have questions or recommendations? Contact me via [email protected]

Found a bug or have enhancement request? You are welcome at Github bugtracker

Compatibility

tested with Ruby:

2.1
2.0
1.9.3
ruby-head
rbx-2
jruby-19mode
jruby-head

and ActiveRecord:

See build history

Contributing

Fork repository ( http://github.com/AlexParamonov/undo-serializer-active_model/fork )
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request