deprecation_toolkit 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50f90bbfa1a09a7e1f2cbd9dad67e90d50a3d43e71e57d713f4ed37824bf288f
-  data.tar.gz: a8e704fd3454e2f0b7753cc6ed677ebfc7f07298362cd06166f53d5d8a01b67b
+  metadata.gz: c2d0b00fe8e8b87b77af20209fac4531b7d2faebdecc55a8cdbd1b490cd65089
+  data.tar.gz: 4ed23c378e87023b0303839edaaa99265929c2b4eb5e7c1b56156992c24ba8e7
 SHA512:
-  metadata.gz: aa06c177df6e63bf8a2ba11d734b837481bc1d5ada8d1fbbf8187e5d6424797aa605b70be127c48642ff3a0e66188fff8cbded056167ef045811a74e8a73eb41
-  data.tar.gz: 52a7bccd13c97db713aa708e226e817cd0fac52550ded6ef0890ca1b8d6da4a18291787f552f1c11358c5a52d25a8d54a2dfbb1c1efc05bcc99cc559ed8ee7c4
+  metadata.gz: 947cd740128e855612cc94917760cf00160adeda014fb4727153a811ea3e2b4cec4e563c61c02729c4eabdebdbf28307787f727feefa4a76e273c4b534c0fc40
+  data.tar.gz: e46958cb158e2ede1139cabb445462349ceb8bc4de06b4084d6af1f086aacba390e86c9cba7c07a23d074d899cd669ef775c790263632be66b88990164404cd2

data/.github/workflows/ci.yml

@@ -3,7 +3,7 @@ name: CI
 on: [push, pull_request]
 
 jobs:
-  build:
+  functionality:
     runs-on: ubuntu-latest
     name: Ruby ${{ matrix.ruby }} / ${{ matrix.gemfile }}
     strategy:
@@ -29,11 +29,22 @@ jobs:
         ruby-version: ${{ matrix.ruby }}
         bundler-cache: true
 
-    - name: RuboCop
-      run: bundle exec rubocop
-
     - name: Tests
       run: bundle exec rake test
 
     - name: Specs
       run: bundle exec rspec
+  style:
+    runs-on: ubuntu-latest
+    name: Rubocop
+    steps:
+    - name: Check out code
+      uses: actions/checkout@v3
+
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: "3.1"
+        bundler-cache: true
+
+    - name: RuboCop
+      run: bundle exec rubocop

data/.github/workflows/cla.yml

@@ -0,0 +1,26 @@
+name: Contributor License Agreement (CLA)
+
+on:
+  pull_request_target:
+    types: [opened, synchronize]
+  issue_comment:
+    types: [created]
+
+permissions:
+  pull-requests: write # to set the label
+  actions: write # to re-run the workflow when a comment is received
+
+jobs:
+  cla:
+    runs-on: ubuntu-latest
+    if: |
+      (github.event.issue.pull_request 
+        && !github.event.issue.pull_request.merged_at
+        && contains(github.event.comment.body, 'signed')
+      ) 
+      || (github.event.pull_request && !github.event.pull_request.merged)
+    steps:
+      - uses: Shopify/shopify-cla-action@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          cla-token: ${{ secrets.CLA_TOKEN }}

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## main (unreleased)
 
+## 2.0.1 (2022-11-18)
+
+* [#74](https://github.com/Shopify/deprecation_toolkit/pull/74): Add support for `Rails.application.deprecators`. (@gmcgibbon)
+
 ## 2.0.0 (2022-03-16)
 
 * [#58](https://github.com/Shopify/deprecation_toolkit/pull/58): Drop support for Ruby < 2.6 & Active Support < 5.2. (@sambostock)

data/Gemfile.lock

@@ -1,21 +1,21 @@
 PATH
   remote: .
   specs:
-    deprecation_toolkit (2.0.0)
+    deprecation_toolkit (2.0.1)
       activesupport (>= 5.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.2.3)
+    activesupport (7.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
-    i18n (1.10.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     minitest (5.15.0)
     parallel (1.21.0)
@@ -52,7 +52,7 @@ GEM
     rubocop-shopify (2.5.0)
       rubocop (~> 1.25)
     ruby-progressbar (1.11.0)
-    tzinfo (2.0.4)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
 

data/README.md

@@ -6,10 +6,9 @@ Deprecation Toolkit is a gem that helps you get rid of deprecations in your code
 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).
+The Deprecation Toolkit gem works by using a [shitlist approach](https://www.youtube.com/watch?v=20pj_ajDBOg).
 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
@@ -44,15 +43,13 @@ end
 
 Behaviors define what happens when non-recorded deprecations are encountered.
 
-Behaviors are classes that have a `.trigger` class method.
-
-This gem provides 3 behaviors, the default one being `DeprecationToolkit::Behaviors::Raise`.
+This gem provides 4 behaviors, the default one being `DeprecationToolkit::Behaviors::Raise`.
 
 * `DeprecationToolkit::Behaviors::Raise` will raise either:
-  - `DeprecationToolkit::DeprecationIntroduced` error if a new deprecation is introduced.
-  - `DeprecationToolkit::DeprecationRemoved` error if a deprecation was removed (compare to the one recorded in the shitlist).
+  - `DeprecationToolkit::Behaviors::DeprecationIntroduced` error if a new deprecation is introduced.
+  - `DeprecationToolkit::Behaviors::DeprecationRemoved` error if a deprecation was removed (compare to the one recorded in the shitlist).
 * `DeprecationToolkit::Behaviors::Record` will record deprecations.
-* `DeprecationToolkit::Behaviors::CIRecordHelper` See separated explanation below.
+* `DeprecationToolkit::Behaviors::CIRecordHelper` See separate explanation below.
 * `DeprecationToolkit::Behaviors::Disabled` will do nothing.
   - This is useful if you want to disable this gem for a moment without removing the gem from your Gemfile.
 
@@ -72,7 +69,7 @@ end
 DeprecationToolkit::Configuration.behavior = StatsdBehavior
 ```
 
-##### DeprecationToolkit::Behaviors::CIRecordHelper
+#### DeprecationToolkit::Behaviors::CIRecordHelper
 
 This is a special type of behaviour meant to help you record deprecations if you have a lof of them.
 Imagine if you have thousands of tests and need to record deprecations for each on your machine, this is going to take ages.

data/lib/deprecation_toolkit/version.rb

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

data/lib/deprecation_toolkit.rb

@@ -18,20 +18,35 @@ module DeprecationToolkit
     autoload :CIRecordHelper,          "deprecation_toolkit/behaviors/ci_record_helper"
   end
 
-  def self.add_notify_behavior
-    notify = ActiveSupport::Deprecation::DEFAULT_BEHAVIORS[:notify]
-    behaviors = ActiveSupport::Deprecation.behavior
+  class << self
+    def add_notify_behavior
+      notify = ActiveSupport::Deprecation::DEFAULT_BEHAVIORS[:notify]
 
-    unless behaviors.find { |behavior| behavior == notify }
-      ActiveSupport::Deprecation.behavior = behaviors << notify
+      each_deprecator do |deprecator|
+        behaviors = deprecator.behavior
+
+        unless behaviors.find { |behavior| behavior == notify }
+          deprecator.behavior = (behaviors << notify)
+        end
+      end
+    end
+
+    def attach_subscriber
+      return if DeprecationSubscriber.already_attached?
+
+      Configuration.attach_to.each do |gem_name|
+        DeprecationSubscriber.attach_to(gem_name)
+      end
     end
-  end
 
-  def self.attach_subscriber
-    return if DeprecationSubscriber.already_attached?
+    private
 
-    Configuration.attach_to.each do |gem_name|
-      DeprecationSubscriber.attach_to(gem_name)
+    def each_deprecator(&block)
+      if defined?(Rails.application) && Rails.application.respond_to?(:deprecators)
+        Rails.application.deprecators.each(&block)
+      else
+        block.call(ActiveSupport::Deprecation)
+      end
     end
   end
 end

data/lib/minitest/deprecation_toolkit_plugin.rb

@@ -13,6 +13,7 @@ module Minitest
     return unless using_bundler?
 
     require "deprecation_toolkit"
+
     if options[:record_deprecations]
       DeprecationToolkit::Configuration.behavior = DeprecationToolkit::Behaviors::Record
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deprecation_toolkit
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-16 00:00:00.000000000 Z
+date: 2022-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -32,6 +32,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
+- ".github/workflows/cla.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -98,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: Deprecation Toolkit around ActiveSupport::Deprecation