README.md in warner-1.0.1 vs README.md in warner-1.0.2
- old
+ new
@@ -1,11 +1,19 @@
# Warner
[](https://badge.fury.io/rb/warner) [](https://app.codeship.com/projects/246699)
-Annotate your code w/ custom deprecation warnings to the `$stderr` when a newer version of a gem or rails is installed. Especially useful for monkeypatching.
+Annotate your code w/ custom deprecation warnings to the `$stderr` when a newer version of a gem or rails is installed.
+
+Especially useful for a controlled (rails) monkeypatching workflow:
+
+Say you found a bug in a gem and waiting for a new release wil ltake to long.
+Add a monkeypatch in `app/monkeypatches/` (e.g. `app/monkeypatches/bootstrap_form.rb` and maybe write a spec for it.)
+When you update the flawed gem, `Warner` will check the supplied version against the installed version and will put out a deprecation warning (w/ `ActiveSupport::Deprecation`) so you can act upon it.
+
+
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -20,54 +28,32 @@
$ gem install warner
## Usage
-### `Warner.gem_version_warning`
-
-Display a message when specified is updated and needs a change.
-
```ruby
# app/monkeypatches/bootstrap_form.rb
Warner.gem_version_warning('bootstrap_form', "1.2", "upgrade to latest version")
+Warner.rails_version_warning("5.0", "Remove this monkeypatch b/c it's fixed in 5.1 (see issue #99999)")
+Warner.colored_warning("Somebody look at this piece of code please!")
```
will output:
```log
DEPRECATION WARNING: [gem:bootstrap_form] 2.7.0 > 1.2 : upgrade to latest version (called from <top (required)> at /Users/berl/Clients/bwh/core/app/monkeypatches/bootstrap_form.rb:1)
+DEPRECATION WARNING: [RAILS] 5.1.6 > 5.0 : Remove this monkeypatch b/c it's fixed in 5.1 (see issue #99999) (called from <top (required)> at /Users/berl/Clients/bwh/core/app/monkeypatches/bootstrap_form.rb:2)
+DEPRECATION WARNING: Somebody look at this piece of code please! (called from <top (required)> at /Users/berl/Clients/bwh/core/app/monkeypatches/bootstrap_form.rb:3)
```
----
-### `Warner.rails_version_warning`
+## Bonus material: make deprecations stand out in the logfile
-Display a message when rails is updated and needs a change.
-
```ruby
-# app/monkeypatches/bootstrap_form.rb
-Warner.rails_version_warning("5.0", "Remove this monkeypatch b/c it's fixed in 5.1 (see issue #99999)")
-```
-
-will output:
-
-```log
-DEPRECATION WARNING: [RAILS] 5.1.6 > 5.0 : Remove this monkeypatch b/c it's fixed in 5.1 (see issue #99999) (called from <top (required)> at /Users/berl/Clients/bwh/core/app/monkeypatches/bootstrap_form.rb:1)
-```
-
----
-### `Warner.colored_warning`
-
-Just display a message w/o any checking of versions
-
-```ruby
-# app/monkeypatches/bootstrap_form.rb
-Warner.colored_warning("Somebody look at this piece of code please!")
-```
-
-will output:
-
-```log
-DEPRECATION WARNING: Somebody look at this piece of code please! (called from <top (required)> at /Users/berl/Clients/bwh/core/app/monkeypatches/bootstrap_form.rb:1)
+# config/environments/development.rb
+ActiveSupport::Deprecation.behavior = -> (message, callstack) {
+ $stderr.puts"\e[41;37;1m#{message}\e[0m"
+ $stderr.puts callstack.join("\n ") if debug
+}
```
## Development
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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).