Skip to main content

Repository: deprecated_columns

A gem for marking columns as deprecated in ActiveRecord models

Ownership
#navigation-and-presentation-govuk
Hosting
N/A
Category
Gems

README

Permits a grace period for substractive column changes, via Active Record migrations.

This was inspired by (read: entirely lifted) from Whitehall with a few modifications.

Installation

Add this line to your application’s Gemfile:

gem 'deprecated_columns'

And then execute:

$ bundle

Or install it yourself as:

$ gem install deprecated_columns

Usage

class User < ActiveRecord::Base
  deprecated_columns :name
end

For subtractive migrations to columns in your schema you’ll see a warning, unless you’ve specifically marked the column(s) using the deprecated_columns macro.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/alphagov/deprecated_columns. 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.

License

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