Repository is archived
No commit activity in last 3 years
No release in over 3 years
Defining future deprecations
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.16
~> 10.0
~> 3.0

Runtime

~> 5.1, < 6
 Project Readme

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.