Contents

# 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](https://badge.fury.io/rb/delayed_deprecation.svg)](https://badge.fury.io/rb/delayed_deprecation)
[![Maintainability](https://api.codeclimate.com/v1/badges/2d83bdfb73a5ac926897/maintainability)](https://codeclimate.com/github/drivy/delayed_deprecation/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/2d83bdfb73a5ac926897/test_coverage)](https://codeclimate.com/github/drivy/delayed_deprecation/test_coverage)

## Installation

Add this line to your application's Gemfile:

```ruby
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:

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

Or pass it a block:

```ruby
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](https://opensource.org/licenses/MIT).

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
delayed_deprecation-0.2.0	README.md