This Ruby gem enhances
ActiveRecord::Base to save a draft version of the current instance.
- The gem stores all the data in one separate table and does not need to modify the existing tables
- It handles drafts for different models
- It allows saving draft for an instance which does not pass the validations
- A draft stores associations and virtual attributes, too
- A draft is optionally linked to a given user, so every user can manage his own drafts (invisible for the other users)
- A draft is optionally linked to a parent instance. This helps showing existing drafts in a context (e.g. message drafts for a given topic)
- Only 90 lines of code
- Ruby 2.0.0 or newer
- ActiveRecord 4.1 or newer (including 6.0)
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install drafting
Finally, generate and run the migration:
$ rails g drafting:migration $ rake db:migrate
class Message < ActiveRecord::Base end = Message.new content: "Let's start with a simple example." .save_draft(current_user) # Time passes ... draft = Message.drafts(current_user).first = draft.restore .save! drafts = Message.drafts(current_user) = drafts.restore_all
Starting from 0.5.x, you will be able to save drafts under a non
User model as such:
If you are upgrading from previous versions, simply run
rails g drafting:migration again to generate the mising migration files.
Linking to parent instance
class Topic < ActiveRecord::Base has_many :messages end class Message < ActiveRecord::Base belongs_to :topic parent: :topic end topic = Topic.create! title: 'World domination' = topic..build content: 'First step: Get some coffee.' .save_draft(current_user) # Time passes ... draft = topic.drafts(current_user).first # or draft = Topic.child_drafts(current_user).first = draft.restore .save!
save_draftis allowed only if the instance is not persisted yet
save_draftoverwrites a previous draft (if there is one)
- After doing a
save, the draft (if there is one) will be deleted
userargument can be nil if you don't want to distinguish between multiple users
- Saving draft stores the data via
Marshal.load. If you don't like this or need some customization, you can override the instance methods
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.
Bug reports and pull requests are welcome on GitHub at https://github.com/ledermann/drafting. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.
Based on some code from the outdated gem drafts. Used with kind permission of Alexey Kuznetsov (@lxkuz).