dont 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24d5eabf7ad968cb3d575076d120bf5ccc4808ae
-  data.tar.gz: f7dc01339e3629f8cad5ed1cfc3297afd4c0f0b9
+  metadata.gz: 0156e22abab96bdf2ddbd0356e4cbac463db8768
+  data.tar.gz: fe0a0d6111137d0afe9b54f8d015ae70ec0a6f59
 SHA512:
-  metadata.gz: 5c2a8cf3e08e5aed86eff61fb3af1d1b612c9a56c9ca46c8655abe7ceb16904734b2f8c0e9a97cf77e6a090a752a6b303f2af693a359e6a42a8f15a6ecfd67b6
-  data.tar.gz: ff10f1eb7399ee41889c758e8d47c3ee87b410fafabd9a894e16c090fef129c7eadd37c04a4e83620c38174084fc064e2155093b879991a72dee28c644a7b9ed
+  metadata.gz: b5db40d42d4f9f50b99a3afa562dcde408fb17cf6e657db25208897b11a533a0f88d885da1f93a4d046a8ecb44b63495b244135af9c3ab3f4d8c10716acc273d
+  data.tar.gz: 903ce70655179694dd581f4d7f2e9d98fcc2e200198853d69756a111ce7252519460c2903389d3218cc4a798fbbebe65066596108ebea2de5889f6b39e6b747a

data/README.md

@@ -22,13 +22,36 @@ Or install it yourself as:
 
 ## Usage
 
+```ruby
+class Shouter
+  include Dont::WithWarn
+
+  def shout(msg)
+    msg.upcase
+  end
+
+  def scream(msg)
+    shout(msg)
+  end
+  # Indicate that we want to deprecate the scream method, and that you should
+  # use "shout" instead. The :use option can be any string or symbol.
+  dont_use :scream, use: :shout
+end
+
+# Logs "DEPRECATED: Don't use Shouter#scream. It's deprecated in favor of shout.",
+# before executing the method.
+Shouter.new.scream("hello")
+```
+
+### With a custom handler
+
 ```ruby
 # Register a deprecation handler.
 # Anything that responds to `.call(deprecation)` will work.
 LOGGER = Logger.new
-Dont.register_handler(:logger, ->(deprecation) { LOGGER.warn(deprecation.message) })
+DeprecationLogger = Dont.register_handler(:logger, ->(deprecation) { LOGGER.warn(deprecation.message) })
 class Shouter
-  include Dont.new(:logger)
+  include DeprecationLogger
 
   def shout(msg)
     msg.upcase
@@ -40,16 +63,19 @@ class Shouter
   dont_use :scream, use: :shout
 end
 
-# Logs "DEPRECATED: Don't use Shouter#scream. It's deprecated in favor of
-# shout.", before executing the method.
+# Logs "DEPRECATED: Don't use Shouter#scream. It's deprecated in favor of shout.", 
+# before executing the method.
 Shouter.new.scream("hello")
+```
 
+### Raising exceptions in development
 
+```
 # The :exception deprecation handler is provided by default.
 # It raises an exception whenever the method is called, which is handy in
 # test or development mode.
 class Person
-  include Dont.new(:exception)
+  include Dont::WithException
 
   attr_accessor :firstname
   attr_accessor :first_name
@@ -59,6 +85,30 @@ end
 Person.new.firstname # => fails with Dont::DeprecationError
 ```
 
+### Using the Rails logger
+
+```ruby
+# in config/initializers/dont.rb
+Dont.register_handler(:rails_logger, ->(deprecation) { 
+  Rails.logger.warn(deprecation.message) 
+})
+DontLogger = Dont.new(:rails_logger)
+
+# in app/models/comment.rb
+class Comment < ActiveRecord::Base
+  include DontLogger # as defined in the initializer
+  
+  # We want to use `body` instead of `description` from now on
+  alias_attribute :description, :body
+  dont_use :description, use: :body
+end
+
+comment = Comment.new
+comment.description
+# => works, but with a deprecation warning: "DEPRECATED: Don't use Comment#description. It's deprecated in favor of body."
+
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/dont.rb

@@ -128,7 +128,9 @@ class Dont < Module
     end
   end
 
-  register_handler(:exception, -> (deprecation) {
-    fail Dont::DeprecationError, deprecation.message
-  })
+  register_handler(:exception, -> (deprecation) { fail Dont::DeprecationError, deprecation.message })
+  register_handler(:warn, -> (deprecation) { warn deprecation.message })
+
+  WithException = new(:exception)
+  WithWarn = new(:warn)
 end

data/lib/dont/version.rb

@@ -1,3 +1,3 @@
 class Dont < Module
-  VERSION = "0.2.0".freeze
+  VERSION = "0.2.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dont
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Maarten Claes
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-10 00:00:00.000000000 Z
+date: 2016-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-container