deprecation_toolkit 2.0.0 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50f90bbfa1a09a7e1f2cbd9dad67e90d50a3d43e71e57d713f4ed37824bf288f
-  data.tar.gz: a8e704fd3454e2f0b7753cc6ed677ebfc7f07298362cd06166f53d5d8a01b67b
+  metadata.gz: a215b859ad3948057d353332378a89f8ff22199296677f2ecab9f318d24a73b3
+  data.tar.gz: 99a5d3368ab2a066a4118ba0330a913223214ba686c5779138cc685610eea4ae
 SHA512:
-  metadata.gz: aa06c177df6e63bf8a2ba11d734b837481bc1d5ada8d1fbbf8187e5d6424797aa605b70be127c48642ff3a0e66188fff8cbded056167ef045811a74e8a73eb41
-  data.tar.gz: 52a7bccd13c97db713aa708e226e817cd0fac52550ded6ef0890ca1b8d6da4a18291787f552f1c11358c5a52d25a8d54a2dfbb1c1efc05bcc99cc559ed8ee7c4
+  metadata.gz: a6b2c17228b8091e8d2260fb6aa001153b859fcc029412133552b6fb074cb547735bbd27e1194c36128f390658c4e8b82e76018244388a91a56528f6fad05256
+  data.tar.gz: 4199799c0190b92530119d4ad093e359a6b076f35a1ceb039081bbdf6c0b26bd3731cd36fedb6f6025e3bc4bedd7fc38cd43c13e21652b7a3ac898a9a86c3d37

data/.github/workflows/ci.yml

@@ -3,13 +3,13 @@ name: CI
 on: [push, pull_request]
 
 jobs:
-  build:
+  functionality:
     runs-on: ubuntu-latest
     name: Ruby ${{ matrix.ruby }} / ${{ matrix.gemfile }}
     strategy:
       matrix:
         gemfile: [gemfiles/activesupport_5.2.gemfile, gemfiles/activesupport_6.0.gemfile, gemfiles/activesupport_6.1.gemfile, gemfiles/activesupport_7.0.gemfile, gemfiles/activesupport_edge.gemfile]
-        ruby: ["2.6", "2.7", "3.0", "3.1"]
+        ruby: ["2.7", "3.0", "3.1", "3.2"]
         exclude:
         # Active Support requires Ruby >= 2.7 as of 7.0
         - gemfile: "gemfiles/activesupport_7.0.gemfile"
@@ -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.2"
+        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,18 @@
 
 ## main (unreleased)
 
+## 2.0.3 (2023-02-10)
+
+* [#80](https://github.com/Shopify/deprecation_toolkit/pull/80): Filter out stack trace from Gem::Deprecate deprecation messages
+
+## 2.0.2 (2023-02-08)
+
+* [#78](https://github.com/Shopify/deprecation_toolkit/pull/78): Show deprecations without stacktrace. (@shioyama)
+
+## 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.3)
       activesupport (>= 5.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.2.3)
+    activesupport (7.0.4.2)
       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.2.0)
     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.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
 
@@ -68,4 +68,4 @@ DEPENDENCIES
   rubocop-shopify
 
 BUNDLED WITH
-   2.2.22
+   2.4.4

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/deprecation_toolkit.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
-  spec.required_ruby_version = ">= 2.6"
+  spec.required_ruby_version = ">= 2.7"
 
   spec.files = %x(git ls-files -z).split("\x0").reject do |f|
     f.match(%r{^(test)/})

data/lib/deprecation_toolkit/behaviors/raise.rb

@@ -77,9 +77,9 @@ module DeprecationToolkit
           #{record_message}
 
           ===== Expected
-          #{recorded_deprecations.deprecations.join("\n")}
+          #{recorded_deprecations.deprecations_without_stacktrace.join("\n")}
           ===== Actual
-          #{current_deprecations.deprecations.join("\n")}
+          #{current_deprecations.deprecations_without_stacktrace.join("\n")}
         EOM
 
         super(message)

data/lib/deprecation_toolkit/collector.rb

@@ -35,11 +35,9 @@ module DeprecationToolkit
 
     def deprecations_without_stacktrace
       deprecations.map do |deprecation|
-        if ActiveSupport.gem_version.to_s < "5.0"
-          deprecation.sub(/\W\s\(called from .*\)$/, "")
-        else
-          deprecation.sub(/ \(called from .*\)$/, "")
-        end
+        deprecation
+          .sub(*active_support_deprecation_sub_params)
+          .sub(*gem_deprecate_sub_params)
       end
     end
 
@@ -63,5 +61,19 @@ module DeprecationToolkit
     def flaky?
       size == 1 && deprecations.first["flaky"] == true
     end
+
+    private
+
+    def active_support_deprecation_sub_params
+      if ActiveSupport.gem_version.to_s < "5.0"
+        [/\W\s\(called from .*\)$/, ""]
+      else
+        [/ \(called from .*\)$/, ""]
+      end
+    end
+
+    def gem_deprecate_sub_params
+      [/NOTE: (.*is deprecated.*)\n.* called from.*:\d+\.\n/, "\\1"]
+    end
   end
 end

data/lib/deprecation_toolkit/read_write_helper.rb

@@ -58,7 +58,7 @@ module DeprecationToolkit
     end
 
     def test_location(test)
-      test.method(test_name(test)).source_location[0]
+      Kernel.const_source_location(test.class.name)[0]
     rescue NameError
       "unknown"
     end

data/lib/deprecation_toolkit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeprecationToolkit
-  VERSION = "2.0.0"
+  VERSION = "2.0.3"
 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.3
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-16 00:00:00.000000000 Z
+date: 2023-02-10 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"
@@ -91,14 +92,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !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