deprecation_toolkit 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e01e1ccdad76b3a084e7c5ad013fea98f28fc959
-  data.tar.gz: af5cd6abbb05a4ee4ea615b424d00be914b57567
+  metadata.gz: 4a142310e36ffb312bd50a257a82260477fc8940
+  data.tar.gz: ca2b082fddc00a195c72e081eac71512d358b7dd
 SHA512:
-  metadata.gz: afd8e6cc37cd0bd0e025334752f13bb389a191531a8e0a26de2ecc09f1e9f7086cf796cd56e3a1dd8e1154dbd236c99de913c37aba4f248112b8c335c330e5ea
-  data.tar.gz: c24ee0952676a10d928125b1145e293bc5a72a59cf5d6a1624ab1264aa6e29f0913618289e40720c0edd16e0f83e61988aa92febf0457d2973a5d6253d44cbce
+  metadata.gz: '038a0936b7029bd2b73b557fa0a43ce6d4b22dfdb92bb98ca9d1c06dd5084528f74809244944b717dbcc41cecde1cba3b358b707fece9a6d62fa3e88b9a96c57'
+  data.tar.gz: e2af9e16220b684ca29b79426918aed40c7cdb79ca90f85a72f0a9f7185dab4c21bb15d9cd279c322ccf78ad64f72d2e16462a6fa5abcc0d02e1c5b263781684

data/CHANGELOG.md

@@ -3,6 +3,11 @@
 ## master (unreleased)
 ### Bug fixes
 
+## 1.1.0 (2018-11-13)
+### New Features
+* [#28](https://github.com/Shopify/deprecation_toolkit/pull/28): `Configuration.allowed_deprecations now accepts Procs.
+  This is useful if you need to whitelist deprecations based on the caller.
+
 ## 1.0.3 (2018-10-25)
 ### Bug fixes
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    deprecation_toolkit (1.0.3)
+    deprecation_toolkit (1.1.0)
       activesupport (>= 4.2)
 
 GEM
@@ -13,7 +13,7 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     ast (2.4.0)
-    concurrent-ruby (1.0.5)
+    concurrent-ruby (1.1.3)
     i18n (1.1.1)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.1)
@@ -50,4 +50,4 @@ DEPENDENCIES
   rubocop
 
 BUNDLED WITH
-   1.16.6
+   1.17.1

data/README.md

@@ -73,7 +73,7 @@ DeprecationToolkit::Configuration.behavior = StatsdBehavior
 
 ### 🔨 `#DeprecationToolkit::Configuration#allowed_deprecations`
 
-You can ignore some deprecations using `allowed_deprecations`. `allowed_deprecations` accepts an array of Regexp.
+You can ignore some deprecations using `allowed_deprecations`. `allowed_deprecations` accepts an array of Regexp and Procs.
 
 Whenever a deprecation matches one of the regex, it is ignored.
 
@@ -83,6 +83,19 @@ DeprecationToolkit::Configuration.allowed_deprecations = [/Hello World/]
 ActiveSupport::Deprecation.warn('Hello World') # ignored by Deprecation Toolkit
 ```
 
+When passing procs, each proc will get passed the deprecation message and the callstack.
+This is useful if you want to whitelist deprecations based on the caller.
+
+```ruby
+DeprecationToolkit::Configuration.allowed_deprecations = [
+  ->(message, stack) { message ~= 'Foo' && stack.first.label == 'method_triggering_deprecation' }
+]
+
+def method_triggering_deprecation
+  ActiveSupport::Deprecation.warn('Foo') # Ignored by the the DeprecationToolkit
+end
+```
+
 ### 🔨 `#DeprecationToolkit::Configuration#warnings_treated_as_deprecation`
 
 Most gems don't use `ActiveSupport::Deprecation` to deprecate their code but instead just use `Kernel#warn` to output

data/lib/deprecation_toolkit.rb

@@ -22,6 +22,8 @@ module DeprecationToolkit
   end
 
   def self.attach_subscriber
+    return if DeprecationSubscriber.already_attached?
+
     Configuration.attach_to.each do |gem_name|
       DeprecationSubscriber.attach_to gem_name
     end

data/lib/deprecation_toolkit/deprecation_subscriber.rb

@@ -4,16 +4,23 @@ require "active_support/subscriber"
 
 module DeprecationToolkit
   class DeprecationSubscriber < ActiveSupport::Subscriber
+    def self.already_attached?
+      notifier != nil
+    end
+
     def deprecation(event)
       message = event.payload[:message]
 
-      Collector.collect(message) unless deprecation_allowed?(message)
+      Collector.collect(message) unless deprecation_allowed?(event.payload)
     end
 
     private
 
-    def deprecation_allowed?(message)
-      Configuration.allowed_deprecations.any? { |regex| regex =~ message }
+    def deprecation_allowed?(payload)
+      allowed_deprecations, procs = Configuration.allowed_deprecations.partition { |el| el.is_a?(Regexp) }
+
+      allowed_deprecations.any? { |regex| regex =~ payload[:message] } ||
+      procs.any? { |proc| proc.call(payload[:message], payload[:callstack]) }
     end
   end
 end

data/lib/deprecation_toolkit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeprecationToolkit
-  VERSION = "1.0.3"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deprecation_toolkit
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-25 00:00:00.000000000 Z
+date: 2018-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport