Delayed deprecation warnings
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
bin
lib
spec
.gitignore
.rspec
.rubocop.yml
Gemfile
Gemfile.lock
LICENSE.txt
README.md
Rakefile
delayed_deprecation.gemspec

README.md

DelayedDeprecation

This gem provides a simple way to setup delayed deprecation notices.

This can be useful to remind you to cleanup a piece of code, for instance if you release in multiple steps. It's also an alternative to FIXME comments that will actually warn you when running your test suite.

Gem Version Maintainability Test Coverage

Installation

Add this line to your application's Gemfile:

gem 'delayed_deprecation'

Please note that because of a current dependency to activesupport this gem is optimised to be used with Ruby on Rails.

Usage

You can use it as a one liner:

DelayedDeprecation.new("Only for launch", reconsider_after: Date.new(2017, 10, 1), owner: "Alice")

Or pass it a block:

DelayedDeprecation.new("To refactor", reconsider_after: Date.new(2017, 10, 1), owner: "Bob") do
  # Code to be executed
end

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/drivy/delayed_deprecation.

License

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