Relegate

A simple ActiveRecord archiving gem, forked from jhawthorn/discard with additional configuration options.

Relegate provides methods and scopes to mark records as archived without deleting them. It integrates with ActiveRecord via an archived_at timestamp column (customizable).

Add this line to your application's Gemfile:

gem "relegate"

And then execute:

bundle install

Or install it yourself as:

gem install relegate

Add relegate to your model:

class YourModel < ApplicationRecord
  relegate
end

This will generate:

• archived? / unarchived? predicate methods
• archive / unarchive instance methods (non-bang and bang versions)
• archive_all / unarchive_all class methods
• archived / unarchived scopes

You can override the column name:

class YourModel < ApplicationRecord
  relegate column_name: :discarded_at
end

This will generate equivalent methods and scopes using discarded_at instead of archived_at:

• discarded? / not_discarded? predicate methods
• discard, not_discard instance methods (non-bang and bang versions)
• discard_all, not_discard_all class methods
• discarded, and not_discarded scopes

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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 the created tag, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/namolnad/relegate. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the Relegate project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.