Lite::Archive is a library for archiving (soft-delete) database records.
NOTE: If you are coming from
ActiveArchive, please read the port section.
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install lite-archive
Table of Contents
rails g lite:archive:install will generate the following file:
::. do |config| config.all_records_archivable = false config.sync_updated_at = true end
archived_at column must be added to tables where you do not want records destroyed.
If the table does not have this column, records will be destroy instead of archived.
class AddArchivedAtColumn < ActiveRecord::Migration def change create_table :table_name do |t| t. # Adds archived_at automatically (if all_records_archivable is set to true) t. archive: true # Adds archived_at timestamp t. archive: false # Does NOT add archived_at timestamp end :table_name add_column :table_name, :archived_at, :datetime # Manual column (null constraint must be false) end end
user = User.first user.archive #=> Archives the User record and its dependents user.unarchive #=> Unarchives the User record and its dependents user.to_archival #=> Returns the User archival state locale string (ex: Archived) User.archive_all #=> Archives all User records and their dependents User.unarchive_all #=> Unarchives all User record and their dependents
User.archived.all #=> Returns only archived records User.unarchived.all #=> Returns only unarchived records
class User < ActiveRecord::Base # ... omitted ... before_archive :do_something after_archive :do_something before_unarchived :do_something after_unarchive :do_something # ... omitted ... end
Lite::Archive is a compatible port of ActiveArchive.
Switching is as easy as renaming
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/[USERNAME]/lite-archive. 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.
Code of Conduct
Everyone interacting in the Lite::Archive project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.