deprecation_toolkit 2.1.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ed492475deec1821f75a8e79aa20ad0415abc84d55a1901e41bc178f8b3e7b5
-  data.tar.gz: 9420f08d816ea5c65331d91aad7cf942dcd3efe06fbf9eb78fd6f74f026528db
+  metadata.gz: 3584b676fc957381c253538150d205b4a0711efee7ef5b3f5926b4b2674b10a4
+  data.tar.gz: b44b3fc7c0b2fe3a93cc05f225cd8cb13cb4f6d3d762c5c4a89ac67863c9a4bc
 SHA512:
-  metadata.gz: 86fcf411a9243ceb75c551de88194a12606ededb0174ea3a0336fee7093f673702deb76c409e6ad642a02cef169991eb9a0f73a90a84a57448fbfcbb8d4e9583
-  data.tar.gz: bb1b607fd1bf0dba205be60a672ab9c6931c0eb66bc338a5f6b281992f6603e899d954201f04f174e20926b999191eb4663d4cc7a78f7d34ff2499d7e39b3f13
+  metadata.gz: f20edbb85c72c400f9fb1a6f2e9151fe08d249107f4ac27e2432f29b7c13ceb5222f78dfe2990ec5faf34190fe197096db7065f4be61c55ce199a3a049cf756a
+  data.tar.gz: 55c16daef83b058df361785d033bffaa4be13efeac27acf77f1fa65bfcd236ccb42e719402f9b965737d31dd3647fa5efd6f87225b8aca2ece519491d8c4f6b7

data/.rubocop.yml

@@ -2,7 +2,6 @@ inherit_gem:
   rubocop-shopify: rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.6
   SuggestExtensions: false
   Exclude:
     - gemfiles/vendor/**/*
@@ -11,3 +10,6 @@ Style/MethodCallWithArgsParentheses:
   Exclude:
     - Gemfile
     - gemfiles/*
+
+Style/CaseEquality:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.3.0

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## main (unreleased)
 
+## 2.2.0 (2024-02-05)
+
+* Restore Rails 6.1 compatibility.
+* Accept anything that responds to `===` in `Configuration.warnings_treated_as_deprecation`.
+
 ## 2.1.0 (2024-01-19)
 
 * [#99](https://github.com/Shopify/deprecation_toolkit/pull/99): Fix `Warning.warn` hook to accept a category.

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    deprecation_toolkit (2.1.0)
-      activesupport (>= 7.0)
+    deprecation_toolkit (2.2.1)
+      activesupport (>= 6.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.2)
+    activesupport (7.1.3.4)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -19,54 +19,60 @@ GEM
       tzinfo (~> 2.0)
     ast (2.4.2)
     base64 (0.2.0)
-    bigdecimal (3.1.4)
-    concurrent-ruby (1.2.2)
+    bigdecimal (3.1.8)
+    concurrent-ruby (1.3.3)
     connection_pool (2.4.1)
-    diff-lcs (1.5.0)
-    drb (2.2.0)
-      ruby2_keywords
-    i18n (1.14.1)
+    diff-lcs (1.5.1)
+    drb (2.2.1)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
-    minitest (5.20.0)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    minitest (5.25.1)
     mutex_m (0.2.0)
-    parallel (1.21.0)
-    parser (3.1.1.0)
+    parallel (1.24.0)
+    parser (3.3.1.0)
       ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.2.1)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.3.6)
+      strscan
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.25.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.63.5)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.15.1, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
-      parser (>= 3.1.1.0)
-    rubocop-shopify (2.5.0)
-      rubocop (~> 1.25)
-    ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.5)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-shopify (2.15.1)
+      rubocop (~> 1.51)
+    ruby-progressbar (1.13.0)
+    strscan (3.1.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   ruby
@@ -80,4 +86,4 @@ DEPENDENCIES
   rubocop-shopify
 
 BUNDLED WITH
-   2.4.4
+   2.5.10

data/README.md

@@ -57,16 +57,16 @@ This gem provides 4 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 `.trigger`.
+You can also create your own behavior object and perform the logic you want. Your behavior needs to respond to `trigger`.
 
 ```ruby
 class StatsdBehavior
-  def self.trigger(test, deprecations, recorded_deprecations)
+  def trigger(test, deprecations, recorded_deprecations)
      # Could send some statsd event for example
   end
 end
 
-DeprecationToolkit::Configuration.behavior = StatsdBehavior
+DeprecationToolkit::Configuration.behavior = StatsdBehavior.new
 ```
 
 #### DeprecationToolkit::Behaviors::CIRecordHelper
@@ -75,7 +75,7 @@ This is a special type of behaviour meant to help you record deprecations if you
 Imagine if you have thousands of tests and need to record deprecations for each on your machine, this is going to take ages.
 Recording deprecations on CI with the regular `Record` behavior isn't possible because of the way CI parallelize test in multiple container (Multiple tests from the same file runs in parallel in diferrent machines, the deprecation files that get created are then splitted. Regrouping them is a nightmare.)
 
-This behaviour will output a JSON representation of your deprecations. Your CI should have a way to download the log generated from the test run. Download it on your locale machine. Finally run the rake task `FILEPATH=<path_to_downloaded_log> deprecation_toolkit:record_from_ci_output`.
+This behavior will output a JSON representation of your deprecations. Your CI should have a way to download the log generated from the test run. Download it on your locale machine. Finally run the rake task `FILEPATH=<path_to_downloaded_log> deprecation_toolkit:record_from_ci_output`.
 This task will parse your CI log and grab the output generated by the DeprecationToolkit and will finally convert everything back to YML files.
 
 ### 🔨 `#DeprecationToolkit::Configuration#allowed_deprecations`
@@ -117,6 +117,14 @@ This setting accepts an array of regular expressions. To match on all warnings,
 DeprecationToolkit::Configuration.warnings_treated_as_deprecation = [//]
 ```
 
+In addition to regexps, anything that responds to `===` can be a matcher, for instance a proc:
+
+```ruby
+DeprecationToolkit::Configuration.warnings_treated_as_deprecation = [
+  ->(warning) { !warning.match?(/not a deprecation/)}
+]
+```
+
 ### 🔨 `#DeprecationToolkit::Configuration#deprecation_file_path_format`
 
 DeprecationToolkit allows you to choose the file path format for deprecation files.
@@ -162,6 +170,10 @@ It's possible to record deprecations while running your specs by adding an ENV['
 DEPRECATION_BEHAVIOR="record" bundle exec rspec path/to/file_spec.rb
 ```
 
+## Usage without Rails
+
+Without Rails, you'll need to make sure your `ActiveSupport::Deprecation` instances use the [`:notify` behavior](https://api.rubyonrails.org/classes/ActiveSupport/Deprecation/Behavior.html#method-i-behavior-3D).
+
 ## License
 
 Deprecation Toolkit is licensed under the [MIT license](LICENSE.txt).

data/deprecation_toolkit.gemspec

@@ -20,12 +20,12 @@ Gem::Specification.new do |spec|
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
-  spec.required_ruby_version = ">= 2.7"
+  spec.required_ruby_version = ">= 3.0.0"
 
   spec.files = %x(git ls-files -z).split("\x0").reject do |f|
     f.match(%r{^(test|spec|\.github|gemfiles)/})
   end
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency("activesupport", ">= 7.0")
+  spec.add_runtime_dependency("activesupport", ">= 6.1")
 end

data/lib/deprecation_toolkit/behaviors/ci_record_helper.rb

@@ -4,12 +4,13 @@ require "json"
 
 module DeprecationToolkit
   module Behaviors
-    class CIRecordHelper
+    module CIRecordHelper
+      extend self
       extend ReadWriteHelper
 
       HEADER = "[DeprecationToolkit]"
 
-      def self.trigger(test, current_deprecations, _recorded_deprecations)
+      def trigger(test, current_deprecations, _recorded_deprecations)
         filename = recorded_deprecations_path(test)
 
         to_output = {

data/lib/deprecation_toolkit/behaviors/disabled.rb

@@ -2,8 +2,10 @@
 
 module DeprecationToolkit
   module Behaviors
-    class Disabled
-      def self.trigger(*)
+    module Disabled
+      extend self
+
+      def trigger(*)
       end
     end
   end

data/lib/deprecation_toolkit/behaviors/raise.rb

@@ -2,8 +2,10 @@
 
 module DeprecationToolkit
   module Behaviors
-    class Raise
-      def self.trigger(_test, current_deprecations, recorded_deprecations)
+    module Raise
+      extend self
+
+      def trigger(_test, current_deprecations, recorded_deprecations)
         error_class = if current_deprecations.size > recorded_deprecations.size
           DeprecationIntroduced
         elsif current_deprecations.size < recorded_deprecations.size

data/lib/deprecation_toolkit/behaviors/record.rb

@@ -2,10 +2,11 @@
 
 module DeprecationToolkit
   module Behaviors
-    class Record
+    module Record
+      extend self
       extend ReadWriteHelper
 
-      def self.trigger(test, collector, _)
+      def trigger(test, collector, _)
         deprecation_file = recorded_deprecations_path(test)
 
         write(deprecation_file, test_name(test) => collector.deprecations_without_stacktrace)

data/lib/deprecation_toolkit/collector.rb

@@ -65,11 +65,7 @@ module DeprecationToolkit
     private
 
     def active_support_deprecation_sub_params
-      if ActiveSupport.gem_version.to_s < "5.0"
-        [/\W\s\(called from .*\)$/, ""]
-      else
-        [/ \(called from .*\)$/, ""]
-      end
+      [/ \(called from .*\)$/, ""]
     end
 
     def gem_deprecate_sub_params

data/lib/deprecation_toolkit/deprecation_subscriber.rb

@@ -4,8 +4,10 @@ require "active_support/subscriber"
 
 module DeprecationToolkit
   class DeprecationSubscriber < ActiveSupport::Subscriber
-    def self.already_attached?
-      notifier != nil
+    class << self
+      def already_attached?
+        notifier != nil
+      end
     end
 
     def deprecation(event)
@@ -17,10 +19,13 @@ module DeprecationToolkit
     private
 
     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]) }
+      Configuration.allowed_deprecations.any? do |rule|
+        if rule.is_a?(Regexp)
+          rule.match?(payload[:message])
+        else
+          rule.call(payload[:message], payload[:callstack])
+        end
+      end
     end
   end
 end

data/lib/deprecation_toolkit/test_triggerer.rb

@@ -2,7 +2,9 @@
 
 module DeprecationToolkit
   module TestTriggerer
-    def self.trigger_deprecation_toolkit_behavior(test)
+    extend self
+
+    def trigger_deprecation_toolkit_behavior(test)
       current_deprecations = DeprecationToolkit::Collector.new(DeprecationToolkit::Collector.deprecations)
       recorded_deprecations = DeprecationToolkit::Collector.load(test)
       if !recorded_deprecations.flaky? && current_deprecations != recorded_deprecations

data/lib/deprecation_toolkit/version.rb

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

data/lib/deprecation_toolkit/warning.rb

@@ -38,7 +38,7 @@ module DeprecationToolkit
     end
 
     def deprecation_triggered?(str)
-      DeprecationToolkit::Configuration.warnings_treated_as_deprecation.any? { |warning| warning =~ str }
+      DeprecationToolkit::Configuration.warnings_treated_as_deprecation.any? { |warning| warning === str }
     end
 
     def deprecator
@@ -48,11 +48,13 @@ module DeprecationToolkit
       end
     end
   end
-end
 
-module DeprecationToolkit
   module WarningPatch
     def warn(str, *)
+      if Configuration.warnings_treated_as_deprecation.empty?
+        return super
+      end
+
       str = DeprecationToolkit::Warning.handle_multipart(str)
       return unless str
 
@@ -64,5 +66,6 @@ module DeprecationToolkit
     end
     ruby2_keywords :warn
   end
+
+  ::Warning.singleton_class.prepend(WarningPatch)
 end
-Warning.singleton_class.prepend(DeprecationToolkit::WarningPatch)

data/lib/deprecation_toolkit.rb

@@ -44,7 +44,7 @@ module DeprecationToolkit
     def each_deprecator(&block)
       if defined?(Rails.application) && Rails.application.respond_to?(:deprecators)
         Rails.application.deprecators.each(&block)
-      else
+      elsif ActiveSupport::Deprecation.respond_to?(:behavior)
         block.call(ActiveSupport::Deprecation)
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deprecation_toolkit
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Shopify
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-19 00:00:00.000000000 Z
+date: 2024-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,15 +16,15 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
-description: 
+        version: '6.1'
+description:
 email:
 - rails@shopify.com
 executables: []
@@ -34,6 +34,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -68,7 +69,7 @@ metadata:
   source_code_uri: https://github.com/shopify/deprecation_toolkit
   changelog_uri: https://github.com/Shopify/deprecation_toolkit/blob/main/CHANGELOG.md
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -76,15 +77,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.4
-signing_key: 
+rubygems_version: 3.5.17
+signing_key:
 specification_version: 4
 summary: Deprecation Toolkit around ActiveSupport::Deprecation
 test_files: []