https://github.com/drexed/lite-archive
Archive (soft-delete) ActiveRecord database records
https://github.com/drexed/lite-archive
activerecord archive paranoid rails ruby soft-delete
Last synced: 11 months ago
JSON representation
Archive (soft-delete) ActiveRecord database records
- Host: GitHub
- URL: https://github.com/drexed/lite-archive
- Owner: drexed
- License: mit
- Created: 2019-07-01T16:07:38.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-19T01:39:29.000Z (about 3 years ago)
- Last Synced: 2024-04-24T14:38:06.301Z (almost 2 years ago)
- Topics: activerecord, archive, paranoid, rails, ruby, soft-delete
- Language: Ruby
- Homepage: https://drexed.github.io/lite-archive
- Size: 70.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Lite::Archive
[](http://badge.fury.io/rb/lite-archive)
[](https://travis-ci.org/drexed/lite-archive)
Lite::Archive is a library for archiving (soft-delete) database records.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'lite-archive'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install lite-archive
## Table of Contents
* [Configurations](#configurations)
* [Usage](#usage)
* [Methods](#methods)
* [Scopes](#scopes)
* [Callbacks](#callbacks)
## Configurations
`rails g lite:archive:install` will generate the following file in your application root:
`config/initalizers/lite_archive.rb`
```ruby
Lite::Archive.configure do |config|
config.all_records_archivable = false
config.sync_updated_at = true
end
```
## Usage
An `archived_at` column must be added to tables where you that you want to archive.
If the table does not have this column, records will be destroyed instead.
#### Table create
```ruby
class AddArchivedAtColumn < ActiveRecord::Migration
def change
create_table :table_name do |t|
t.timestamp # Adds archived_at automatically if all_records_archivable
t.timestamp archive: true # Adds archived_at timestamp
t.timestamp archive: false # Does NOT add archived_at timestamp
end
end
end
```
#### Column migration
```ruby
class AddArchivedAtColumn < ActiveRecord::Migration
def change
add_column :table_name, :archived_at, :datetime # Manual column (null constraint must be false)
add_timestamp :table_name # Named column helper (equivalent to the above)
end
end
```
## Methods
#### Instance
```ruby
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)
```
#### Class
```ruby
User.archive_all #=> Archives all User records and their dependents
User.unarchive_all #=> Unarchives all User record and their dependents
```
## Scopes
```ruby
User.archived.all #=> Returns only archived records
User.unarchived.all #=> Returns only unarchived records
```
## Callbacks
#### Before
```ruby
class User < ActiveRecord::Base
before_archive :do_something
before_unarchived :do_something
end
```
#### After
```ruby
class User < ActiveRecord::Base
after_archive :do_something
after_unarchive :do_something
end
```
## 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](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/drexed/lite-archive. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## 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](https://github.com/drexed/lite-archive/blob/master/CODE_OF_CONDUCT.md).