deprecation_toolkit 2.2.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3584b676fc957381c253538150d205b4a0711efee7ef5b3f5926b4b2674b10a4
-  data.tar.gz: b44b3fc7c0b2fe3a93cc05f225cd8cb13cb4f6d3d762c5c4a89ac67863c9a4bc
+  metadata.gz: 6764813c0b9b8522fa1e755f59e4f3e7137fa229a24e5b96ae05fbcbd53efdc7
+  data.tar.gz: 5e570bcbf742061e36c5aeb4b1073a3ba546c47e5caefaba2b1d33abaaf1c037
 SHA512:
-  metadata.gz: f20edbb85c72c400f9fb1a6f2e9151fe08d249107f4ac27e2432f29b7c13ceb5222f78dfe2990ec5faf34190fe197096db7065f4be61c55ce199a3a049cf756a
-  data.tar.gz: 55c16daef83b058df361785d033bffaa4be13efeac27acf77f1fa65bfcd236ccb42e719402f9b965737d31dd3647fa5efd6f87225b8aca2ece519491d8c4f6b7
+  metadata.gz: 9c851ca5d25bdaed7522be6f1736766bd92a66f454993ec060c048fe6f09feb9f28d3d7c608ba248a31492b8c6656782871507d6e9fd138af85e03b53446dda7
+  data.tar.gz: f8ba1b548b6cde09de40768dce5f2b79ba23dd3bf69620cc6255520efc6fe11c4f8839978d7f0d1ecfa1f0c77307ddf2743cd219d1834ae181f3f762d2f3a80a

data/README.md

@@ -172,7 +172,22 @@ 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).
+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) and the `attach_to` is the underscored version of the deprecator's `gem_name` (this is how the `:notify` behavior works):
+
+```ruby
+# defined in the gem:
+MyGem.deprecator = ActiveSupport::Deprecation.new("2.0", "MyGem::Something")
+
+# in the test helper:
+MyGem.deprecator.behavior = :notify
+
+DeprecationToolkit::Configuration.configure do |config|
+  config.attach_to = MyGem.deprecator.gem_name.underscore.tr("/", "_")
+  # or more simply
+  # config.attach_to = "my_gem_something"
+  config.behavior = :notify
+end
+```
 
 ## License
 

data/lib/deprecation_toolkit/behaviors/raise.rb

@@ -34,7 +34,9 @@ module DeprecationToolkit
           You have introduced new deprecations in the codebase. Fix or record them in order to discard this error.
           #{record_message}
 
+          ******* The following deprecations were added: *******
           #{introduced_deprecations.join("\n")}
+          ******************************************************
         EOM
 
         super(message)
@@ -57,7 +59,9 @@ module DeprecationToolkit
           The recorded deprecations needs to be updated to reflect your changes.
           #{record_message}
 
+          ****** The following deprecations were removed: ******
           #{removed_deprecations.join("\n")}
+          ******************************************************
         EOM
 
         super(message)

data/lib/deprecation_toolkit/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: deprecation_toolkit
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.2
 platform: ruby
 authors:
 - Shopify
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-23 00:00:00.000000000 Z
+date: 2025-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,25 +23,14 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.1'
-description:
 email:
 - rails@shopify.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-version"
-- CHANGELOG.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- RELEASE.md
-- Rakefile
-- deprecation_toolkit.gemspec
 - lib/deprecation_toolkit.rb
 - lib/deprecation_toolkit/behaviors/ci_record_helper.rb
 - lib/deprecation_toolkit/behaviors/disabled.rb
@@ -60,16 +48,14 @@ files:
 - lib/deprecation_toolkit/warning.rb
 - lib/minitest/deprecation_toolkit_plugin.rb
 - lib/tasks/ci_recorder.rake
-- shipit.rubygems.yml
 homepage: https://github.com/shopify/deprecation_toolkit
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/shopify/deprecation_toolkit
-  source_code_uri: https://github.com/shopify/deprecation_toolkit
+  source_code_uri: https://github.com/Shopify/deprecation_toolkit/tree/v2.2.2
   changelog_uri: https://github.com/Shopify/deprecation_toolkit/blob/main/CHANGELOG.md
   allowed_push_host: https://rubygems.org
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -84,8 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Deprecation Toolkit around ActiveSupport::Deprecation
 test_files: []

data/.gitignore

@@ -1,10 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/.byebug_history
-gemfiles/*.lock

data/.rspec

@@ -1,4 +0,0 @@
---format documentation
---color
---require spec_helper
-

data/.rubocop.yml

@@ -1,15 +0,0 @@
-inherit_gem:
-  rubocop-shopify: rubocop.yml
-
-AllCops:
-  SuggestExtensions: false
-  Exclude:
-    - gemfiles/vendor/**/*
-
-Style/MethodCallWithArgsParentheses:
-  Exclude:
-    - Gemfile
-    - gemfiles/*
-
-Style/CaseEquality:
-  Enabled: false

data/.ruby-version

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

data/CHANGELOG.md

@@ -1,85 +0,0 @@
-# Change log
-
-## 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)
-* [#91](https://github.com/Shopify/deprecation_toolkit/pull/91): Require necessary Active Support core extension. (@etiennebarrie)
-
-## 2.0.3 (2023-02-10)
-
-* [#80](https://github.com/Shopify/deprecation_toolkit/pull/80): Filter out stack trace from Gem::Deprecate deprecation messages (@davidstosik)
-
-## 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)
-* [#58](https://github.com/Shopify/deprecation_toolkit/pull/58): Ensure compatibility with Rails 7. (@sambostock)
-
-## 1.5.1 (2020-04-28)
-
-* [#46](https://github.com/Shopify/deprecation_toolkit/pull/46): Handle another two part Ruby 2.7 keyword argument deprecation warning. (@casperisfine)
-
-## 1.5.0 (2020-04-14)
-
-* [#42](https://github.com/Shopify/deprecation_toolkit/pull/42): Fix Minitest plugin kicking in when it shouldn't. (@Edouard-chin)
-* [#45](https://github.com/Shopify/deprecation_toolkit/pull/45): Handle two part Ruby 2.7 keyword argument deprecation warning. (@casperisfine)
-
-## 1.4.0 (2019-04-29)
-
-* [#37](https://github.com/Shopify/deprecation_toolkit/pull/37): Add Rspec support. (@andrewmarkle)
-
-## 1.3.0 (2019-02-28)
-
-* [#38](https://github.com/Shopify/deprecation_toolkit/pull/38): Add a way to mark test as flaky. (@Edouard-chin)
-* [#39](https://github.com/Shopify/deprecation_toolkit/pull/39): Introduced a way to help recording massive amount of deprecations. (@Edouard-chin)
-
-## 1.2.1 (2019-01-09)
-
-### Bug fixes
-* [#34](https://github.com/Shopify/deprecation_toolkit/pull/34): Fixes SystemStackError with RubyGems v3 and Ruby 2.5+. (@dylanahsmith)
-
-## 1.2.0 (2018-11-28)
-
-### New features
-
-* [#30](https://github.com/Shopify/deprecation_toolkit/pull/30): Introduce a `DeprecationMismatch` error class. (@Edouard-chin)
-### Bug fixes
-* [#29](https://github.com/Shopify/deprecation_toolkit/pull/29): Fix issue where the error class triggered was incorrect in some circumstances. (@Edouard-chin)
-
-## 1.1.0 (2018-11-13)
-
-### New features
-
-* [#28](https://github.com/Shopify/deprecation_toolkit/pull/28): `Configuration.allowed_deprecations` now accepts Procs.
-  This is useful if you need to whitelist deprecations based on the caller.
-
-## 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
-
-* [#15](https://github.com/Shopify/deprecation_toolkit/pull/15): Add support for ActiveSupport 4.2. (@andrewmarkle)

data/Gemfile

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gemspec
-
-gem "bundler"
-gem "minitest"
-gem "rake"
-gem "rspec"
-gem "rubocop-shopify"
-
-if defined?(@activesupport_gem_requirement) && @activesupport_gem_requirement
-  # causes Dependabot to ignore the next line
-  activesupport = "activesupport"
-  gem activesupport, @activesupport_gem_requirement
-end

data/Gemfile.lock

@@ -1,89 +0,0 @@
-PATH
-  remote: .
-  specs:
-    deprecation_toolkit (2.2.1)
-      activesupport (>= 6.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (7.1.3.4)
-      base64
-      bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      connection_pool (>= 2.2.5)
-      drb
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
-    ast (2.4.2)
-    base64 (0.2.0)
-    bigdecimal (3.1.8)
-    concurrent-ruby (1.3.3)
-    connection_pool (2.4.1)
-    diff-lcs (1.5.1)
-    drb (2.2.1)
-    i18n (1.14.5)
-      concurrent-ruby (~> 1.0)
-    json (2.7.2)
-    language_server-protocol (3.17.0.3)
-    minitest (5.25.1)
-    mutex_m (0.2.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.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.13.0)
-    rspec-mocks (3.13.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      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.3.0.2)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-      ruby-progressbar (~> 1.7)
-      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.5.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler
-  deprecation_toolkit!
-  minitest
-  rake
-  rspec
-  rubocop-shopify
-
-BUNDLED WITH
-   2.5.10

data/RELEASE.md

@@ -1,21 +0,0 @@
-# Contribution to Deprecation Toolkit
-
-## Releasing a new version
-
-1. Audit PRs and commits merged since the last release, ensuring **all user fancing changes are documented** in `CHANGELOG.md`.
-2. Based on the changes, determine whether to increment the major, minor, or patch version, adhering to [Semantic Versioning][semver].
-3. Update the gem version string accordingly in `lib/deprecation_toolkit/version.rb`.
-4. Run `bundle install` to update the `Gemfile.lock`.
-5. Insert a new heading in `CHANGELOG.md` containing the version identifier and expected release date (e.g. `## 1.2.3 (1999-12-31)`).
-6. Commit changes on a new branch and open a PR.
-7. **Draft** a [new release][github-new-release] on GitHub, but **do not publish it yet**.
-8. Once you have received approval on your PR, merge it into `main`.
-9. Deploy using the [ShipIt][shipit] UI, and **verify** the new version is available on [RubyGems][rubygems].
-10. Publish the drafted release, tagging the deployed commit (should be `HEAD` of the `main` branch) with a tag of the form `vMAJOR.MINOR.PATCH`.
-
-If something goes wrong during the deploy process, address it and tag whatever commit was successfully deployed as that version.
-
-[semver]: https://semver.org
-[github-new-release]: https://github.com/Shopify/deprecation_toolkit/releases/new
-[shipit]: https://shipit.shopify.io/shopify/deprecation_toolkit/rubygems
-[rubygems]: https://rubygems.org/gems/deprecation_toolkit/versions

data/Rakefile

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.warning = true
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-task(default: :test)

data/deprecation_toolkit.gemspec

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path("lib", __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "deprecation_toolkit/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "deprecation_toolkit"
-  spec.version = DeprecationToolkit::VERSION
-  spec.authors = ["Shopify"]
-  spec.email = ["rails@shopify.com"]
-
-  spec.summary = "Deprecation Toolkit around ActiveSupport::Deprecation"
-  spec.homepage = "https://github.com/shopify/deprecation_toolkit"
-  spec.license = "MIT"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/shopify/deprecation_toolkit"
-  spec.metadata["changelog_uri"] = "https://github.com/Shopify/deprecation_toolkit/blob/main/CHANGELOG.md"
-
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
-
-  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", ">= 6.1")
-end

data/shipit.rubygems.yml

@@ -1 +0,0 @@
-# using the default shipit config