ActiveArchive

ActiveArchive is a library for preventing database records from being destroyed.

Installation

Add this line to your application's Gemfile:

gem 'active_archive'

And then execute:

$ bundle

Or install it yourself as:

$ gem install active_archive

Table of Contents

• Configurations
• Methods
• Scopes

Configurations

rails generate active_archive:install will generate the following file: ../config/initalizers/active_archive.rb

ActiveArchive::Settings.configure do |config|
  config.all_records_archivable = false
  config.dependent_record_window = 3.seconds
end

Methods

Options:

• archive
• destroy
• destroy_all
• delete
• delete_all
• unarchive
• unarchive_all

User.first.archive          #=> archives User record and dependents
User.first.destroy          #=> archives User record and dependents
User.first.delete           #=> deletes User record and dependents
User.first.unarchive        #=> unarchives User record and dependents

User.first.to_archival      #=> returns archival state string

User.first.archive(:force)  #=> destroys User record and dependents
User.first.destroy(:force)  #=> destroys User record and dependents

User.archive_all            #=> archives all User records and dependents
User.destroy_all            #=> archives all User records and dependents
User.delete_all             #=> deletes all User records and dependents
User.unarchive_all          #=> unarchives all User record and dependents

Scopes

Options:

• default
• archived
• unarchived

User.all                    #=> returns all records
User.archived.all           #=> returns only archived record
User.unarchived.all         #=> returns only unarchived record

Contributing

Your contribution is welcome.

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request