deprecation_toolkit 2.0.4 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 304db5daebe7343f9d4150f079eb498d5c20978ea461c3fe82f2377d42464d2a
-  data.tar.gz: bcd740c82a01dc7c3782cdef1705a3ee829fdade6684d75ea2537e5601a8007d
+  metadata.gz: 562db3c54971f9c7513f6777b6b351325772a467f3a12b9467aee8ae09faea7b
+  data.tar.gz: 5d8bfeb8af3b883747c4b72a168e7504080f9e87260b65a67f9ecabe99071016
 SHA512:
-  metadata.gz: 67e7401a039080b8ece8449290ec34fa8595540654dac74cabd45084040f07f526d81a14b4c4fb0f1232bfb62a5f4cdb132080388c236d6b47bf2237c180d9f5
-  data.tar.gz: 042f87488783ea236fa740138b659ebf03dd9befa00a5a8681817103620719e1d73cb57324d9e6e6d23ce67b1a8c0feb3d852ff313bd2030305ab774403e147e
+  metadata.gz: 4a801c1cd12e35a705b89ecb7e3f2863be8ef488f29efb8537f7a858d86f68355cd571f22e4b16cd8b50b3c08b7b63e6ac187a12e9bcda184f268b41695b2a14
+  data.tar.gz: 940e38840d651bd4cb2432b8d99c0cbdd78257fc8a5cce2175c60fbd40c0bca45a4ad66e6201e3699fdaaf4b6867c7c02257762dec942e1a3b1e29fd89bef9b0

data/.rubocop.yml

@@ -11,3 +11,6 @@ Style/MethodCallWithArgsParentheses:
   Exclude:
     - Gemfile
     - gemfiles/*
+
+Style/CaseEquality:
+  Enabled: false

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## 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.
+* [#95](https://github.com/Shopify/deprecation_toolkit/pull/95): Allow configuration of deprecation file paths and file names.
+
 ## 2.0.4 (2023-11-20)
 
 * [#90](https://github.com/Shopify/deprecation_toolkit/pull/90) & [#93](https://github.com/Shopify/deprecation_toolkit/pull/93): Stop using deprecated behavior from Active Support. (@etiennebarrie)

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    deprecation_toolkit (2.0.4)
-      activesupport (>= 5.2)
+    deprecation_toolkit (2.2.0)
+      activesupport (>= 6.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -117,6 +117,39 @@ 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.
+
+For Minitest, it defaults to using class name so the following code would correspond to `#{deprecation_path}/deprecation_toolkit/behaviors/raise_test.yml`
+
+```ruby
+module DeprecationToolkit
+  module Behaviors
+    class RaiseTest < ActiveSupport::TestCase
+    end
+  end
+end
+```
+
+For rspec if defaults to the file location with spec removed. `/spec/models/user_spec.rb` would correspond to `/models/user.yml`.
+
+If you have a specific use case you can configure this with a custom format using a proc. The proc is called with an instance of the test.
+
+```ruby
+Configuration.deprecation_file_path_format = -> (test) do
+  Kernel.const_source_location(test.class.name)[0].sub(%r{^./test/}, "").sub(/_test.rb$/, "")
+end
+```
+
 ## RSpec
 
 By default Deprecation Toolkit uses Minitest as its test runner. To use Deprecation Toolkit with RSpec you'll have to configure it.

data/deprecation_toolkit.gemspec

@@ -27,5 +27,5 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency("activesupport", ">= 5.2")
+  spec.add_runtime_dependency("activesupport", ">= 6.1")
 end

data/lib/deprecation_toolkit/configuration.rb

@@ -12,5 +12,14 @@ module DeprecationToolkit
     config_accessor(:deprecation_path) { "test/deprecations" }
     config_accessor(:test_runner) { :minitest }
     config_accessor(:warnings_treated_as_deprecation) { [] }
+    config_accessor(:deprecation_file_path_format) do
+      proc do |test|
+        if DeprecationToolkit::Configuration.test_runner == :rspec
+          test.example_group.file_path.sub(%r{^./spec/}, "").sub(/_spec.rb$/, "")
+        else
+          test.class.name.underscore
+        end
+      end
+    end
   end
 end

data/lib/deprecation_toolkit/read_write_helper.rb

@@ -48,12 +48,7 @@ module DeprecationToolkit
         Configuration.deprecation_path
       end
 
-      path =
-        if DeprecationToolkit::Configuration.test_runner == :rspec
-          test.example_group.file_path.sub(%r{^./spec/}, "").sub(/_spec.rb$/, "")
-        else
-          test.class.name.underscore
-        end
+      path = Configuration.deprecation_file_path_format.call(test)
 
       Pathname(deprecation_folder).join("#{path}.yml")
     end

data/lib/deprecation_toolkit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeprecationToolkit
-  VERSION = "2.0.4"
+  VERSION = "2.2.0"
 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
@@ -52,7 +52,7 @@ end
 
 module DeprecationToolkit
   module WarningPatch
-    def warn(str)
+    def warn(str, *)
       str = DeprecationToolkit::Warning.handle_multipart(str)
       return unless str
 
@@ -62,6 +62,7 @@ module DeprecationToolkit
         super
       end
     end
+    ruby2_keywords :warn
   end
 end
 Warning.singleton_class.prepend(DeprecationToolkit::WarningPatch)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deprecation_toolkit
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.2.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-28 00:00:00.000000000 Z
+date: 2024-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
 description: 
 email:
 - rails@shopify.com
@@ -83,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.21
+rubygems_version: 3.5.5
 signing_key: 
 specification_version: 4
 summary: Deprecation Toolkit around ActiveSupport::Deprecation