deprecation_toolkit 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 549482ab71452372bcd8cb88d49dfb9658ff4cc8
-  data.tar.gz: 6efa4b46880947f5b65ad7b8578dbe7e99c7b21c
+  metadata.gz: e01e1ccdad76b3a084e7c5ad013fea98f28fc959
+  data.tar.gz: af5cd6abbb05a4ee4ea615b424d00be914b57567
 SHA512:
-  metadata.gz: eece757510b9d571b3987534d42025c5a5874d5ac1db64a0f6e7b0f9640ffdfc8eaee3ce248fa47b1cb5da53b458570d40665b0c35fd26471c9790199d9ef5b7
-  data.tar.gz: be2ccc646aaacdf5ec2a0a0dbf0c2d47431c7118c7f33f8ad77ca0e6bc9152a96da5a5a553637fc12b09bd646d5a6dabbbd565a5579719c87aa7d047587e637a
+  metadata.gz: afd8e6cc37cd0bd0e025334752f13bb389a191531a8e0a26de2ecc09f1e9f7086cf796cd56e3a1dd8e1154dbd236c99de913c37aba4f248112b8c335c330e5ea
+  data.tar.gz: c24ee0952676a10d928125b1145e293bc5a72a59cf5d6a1624ab1264aa6e29f0913618289e40720c0edd16e0f83e61988aa92febf0457d2973a5d6253d44cbce

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change log
 
+## master (unreleased)
+### Bug fixes
+
+## 1.0.3 (2018-10-25)
+### Bug fixes
+
+* [#22](https://github.com/Shopify/deprecation_toolkit/pull/22): Fixes `Kernel.warn` not triggering deprecation. (@rmacklin)
 
 ## 1.0.2 (2018-10-01)
 ### New features

data/Gemfile.lock

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

data/README.md

@@ -2,15 +2,15 @@
 
 ## Introduction
 
-The Deprecation Toolkit is a gem to help you get rid of deprecations in your codebase.
-Having deprecations in your application is usually a sign that something will break whenever a third dependency will get updated. The sooner the better to fix them!
-Fixing all deprecations at once might be though depending on how big your app is and how much deprecations needs to be fixed. You might have to progressively resolve them while making sure your team doesn't add new one ➰. This is where this gem comes handy!
+Deprecation Toolkit is a gem that helps you get rid of deprecations in your codebase.
+Having deprecations in your application usually means that something will break whenever you upgrade third-party dependencies. The sooner the better to fix them!
+Fixing all deprecations at once might be tough depending on the size of your app and the number of deprecations. You might have to progressively resolve them while making sure your team doesn't add new ones. This is where this gem comes handy!
 
 
 ## How it works
 
 The Deprecation Toolkit gem works by using a [shitlist approach](https://confreaks.tv/videos/reddotrubyconf2017-shitlist-driven-development-and-other-tricks-for-working-on-large-codebases).
-First, all current existing deprecations in your codebase are recorded into `.yml` files. When running a test that has non-recorded deprecations, the Deprecation Toolkit gem will trigger a behavior of your choice (by default raise an error).
+First, the gem records all existing deprecations into `.yml` files. When running a test that have non-recorded deprecations after the initial recording, Deprecation Toolkit triggers a behavior of your choice (by default it raises an error).
 
 ## Recording Deprecations
 
@@ -25,9 +25,9 @@ rails test <path_to_my_test.rb> -r
 
 ### 🔨 `#DeprecationToolkit::Configuration#deprecation_path`
 
-You can control where the recorded deprecations are read and write into. By default, deprecations will be recorded in the `test/deprecations` folder.
+You can control where recorded deprecations are saved and read from. By default, deprecations are recorded in the `test/deprecations` folder.
 
-The `deprecation_path` either accepts a string or a proc. When using a proc, the proc will be passed an argument which is the path of the test file being run.
+The `deprecation_path` either accepts a string or a proc. The proc is called with the path of the running test file.
 
 ```ruby
 DeprecationToolkit::Configuration.deprecation_path = 'test/deprecations'
@@ -42,9 +42,9 @@ end
 
 ### 🔨 `#DeprecationToolkit::Configuration#behavior`
 
-Behaviors defines what will happen when a non-recorded deprecations is encountered.
+Behaviors define what happens when non-recorded deprecations are encountered.
 
-Behaviors are class that responds to the `trigger` message.
+Behaviors are classes that have a `.trigger` class method.
 
 This gem provides 3 behaviors, the default one being `DeprecationToolkit::Behaviors::Raise`.
 
@@ -59,7 +59,7 @@ This gem provides 3 behaviors, the default one being `DeprecationToolkit::Behavi
 DeprecationToolkit::Configuration.behavior = DeprecationToolkit::Behaviors::Record
 ```
 
-You can also create your own behavior class and perform the logic you want. Your behavior needs to respond to the `.trigger` message.
+You can also create your own behavior class and perform the logic you want. Your behavior needs to respond to `.trigger`.
 
 ```ruby
 class StatsdBehavior
@@ -73,25 +73,22 @@ DeprecationToolkit::Configuration.behavior = StatsdBehavior
 
 ### 🔨 `#DeprecationToolkit::Configuration#allowed_deprecations`
 
-If you want to allow some deprecations, this is where you'll configure it. The `allowed_deprecations` configuration accepts an
-array of Regexp.
+You can ignore some deprecations using `allowed_deprecations`. `allowed_deprecations` accepts an array of Regexp.
 
-Whenever a deprecation matches one of the regex, the deprecation will be ignored
+Whenever a deprecation matches one of the regex, it is ignored.
 
 ```ruby
 DeprecationToolkit::Configuration.allowed_deprecations = [/Hello World/]
 
-# Let's imagine a third dependency adds a deprecation like this,
-# the Deprecation Toolkit will simply ignore it.
-ActiveSupport::Deprecation.warn('Hello World')
+ActiveSupport::Deprecation.warn('Hello World') # ignored by Deprecation Toolkit
 ```
 
 ### 🔨 `#DeprecationToolkit::Configuration#warnings_treated_as_deprecation`
 
-Most gems doesn't use `ActiveSupport::Deprecation` to deprecate their code but instead just uses `Kernel#warn` to output
+Most gems don't use `ActiveSupport::Deprecation` to deprecate their code but instead just use `Kernel#warn` to output
 a message in the console.
 
-The DeprecationToolkit gem allows you to configure which warnings should be treated as deprecations in order for you
+Deprecation Toolkit allows you to configure which warnings should be treated as deprecations in order for you
 to keep track of them as if they were regular deprecations.
 
 ## License

data/lib/deprecation_toolkit/version.rb

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

data/lib/deprecation_toolkit/warning.rb

@@ -25,17 +25,23 @@ end
 # Note that the `Warning` module exists in Ruby 2.4 but has a bug https://bugs.ruby-lang.org/issues/12944
 if RUBY_VERSION < '2.5.0' && RUBY_ENGINE == 'ruby'
   module Kernel
-    alias_method :__original_warn, :warn
+    class << self
+      alias_method :__original_warn, :warn
 
-    def warn(*messages)
-      message = messages.join("\n")
-      message += "\n" unless message.end_with?("\n")
+      def warn(*messages)
+        message = messages.join("\n")
+        message += "\n" unless message.end_with?("\n")
 
-      if DeprecationToolkit::Warning.deprecation_triggered?(message)
-        ActiveSupport::Deprecation.warn(message)
-      else
-        __original_warn(messages)
+        if DeprecationToolkit::Warning.deprecation_triggered?(message)
+          ActiveSupport::Deprecation.warn(message)
+        else
+          __original_warn(messages)
+        end
       end
     end
+
+    def warn(*messages)
+      Kernel.warn(messages)
+    end
   end
 end

data/lib/deprecation_toolkit.rb

@@ -11,6 +11,21 @@ module DeprecationToolkit
     autoload :Raise,                   "deprecation_toolkit/behaviors/raise"
     autoload :Record,                  "deprecation_toolkit/behaviors/record"
   end
+
+  def self.add_notify_behavior
+    notify = ActiveSupport::Deprecation::DEFAULT_BEHAVIORS[:notify]
+    behaviors = ActiveSupport::Deprecation.behavior
+
+    unless behaviors.find { |behavior| behavior == notify }
+      ActiveSupport::Deprecation.behavior = behaviors << notify
+    end
+  end
+
+  def self.attach_subscriber
+    Configuration.attach_to.each do |gem_name|
+      DeprecationSubscriber.attach_to gem_name
+    end
+  end
 end
 
 require "deprecation_toolkit/minitest_hook"

data/lib/minitest/deprecation_toolkit_plugin.rb

@@ -14,24 +14,7 @@ module Minitest
       DeprecationToolkit::Configuration.behavior = DeprecationToolkit::Behaviors::Record
     end
 
-    add_notify_behavior
-    attach_subscriber
-  end
-
-  private
-
-  def add_notify_behavior
-    notify = ActiveSupport::Deprecation::DEFAULT_BEHAVIORS[:notify]
-    behaviors = ActiveSupport::Deprecation.behavior
-
-    unless behaviors.find { |behavior| behavior == notify }
-      ActiveSupport::Deprecation.behavior = behaviors << notify
-    end
-  end
-
-  def attach_subscriber
-    DeprecationToolkit::Configuration.attach_to.each do |gem_name|
-      DeprecationToolkit::DeprecationSubscriber.attach_to gem_name
-    end
+    DeprecationToolkit.add_notify_behavior
+    DeprecationToolkit.attach_subscriber
   end
 end

metadata

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