as_deprecation_tracker 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2d01e6823baf38e699a6de7c4d27391d9f8f6a00
-  data.tar.gz: f95996a72dd62db5cd33f8cc8a9f0ee5e7686454
+SHA256:
+  metadata.gz: afbd5cdcd05ef8e999ba0e809a3f9dd9f47f2379c2d2d1f753a5b308652e6ebb
+  data.tar.gz: cd5f7e4d5934d6f7e8aa67bfbc3487ecc3f21a5498a11ffed3f8bb77223a24dd
 SHA512:
-  metadata.gz: 7b649d6be7f3273fe8400ff28dc6162402b4cc744b47136b355b5648e9a1a27494f2d21c2d7e4c92b0aec10c7009b94882ce21e8cffc522ee8e2eb4f06b7d386
-  data.tar.gz: 80fdb221aa9b693793740b511190a090a895881dec79d0b78ebd1d8c70ce9b18f80aaf49ef0a97a7ecc3135a4a8d82043799f4cd7f106562e23f9b05fa77fe71
+  metadata.gz: 9ea16660167a5744c86895f2722cc85af01acda3b93f3ec8eef5bd4b470c6f4168037d8105b798b64c809b08353282d872f9707925c5b8ec76d48c59cedb5dab
+  data.tar.gz: b22dabfa1a44820bd2c30a98b5c6ee9c1c674bd88e4f1c96f4dcc5c7f384b370a29d0a79a0ed016f2ace836fdcdf69933a0951192a16a66910e6040ed9206b6d

data/.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+---
+name: CI
+
+on:
+  pull_request:
+  push:
+
+
+concurrency:
+  group: ${{ github.ref_name }}
+  cancel-in-progress: true
+
+jobs:
+  ruby:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby_version:
+          - '2.7.6'
+          - '3.0.4'
+          - '3.1.2'
+        rails_version:
+          - '6.0.5.1'
+          - '6.1.6.1'
+          - '7.0.3.1'
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+          bundler-cache: true
+        env:
+          RAILS_VERSION: ${{ matrix.rails_version }}
+      - name: Run tests
+        run: bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,71 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## 1.6.0
+
+### Fixed
+- Fix array splat errors under Ruby 3 (PR thanks to @evgeni)
+
+## 1.5.0
+
+### Added
+- Add `AS_DEPRECATION_DISABLE` environment variable to fully disable ASDT.
+- Support shorter `ASDT_` prefix for all environment variables.
+
+## 1.4.1
+
+### Fixed
+- Fix YAML safe load error under Ruby 2.0.
+
+## 1.4.0
+
+### Added
+- Add pause!/resume! API to temporarily queue deprecation processing.
+
+### Fixed
+- Fix engine root search error when engine name is given as a symbol.
+
+## 1.3.0
+
+### Changed
+- Deprecation messages are matched by prefix, so only the first part of the
+  message needs to be stored on the whitelist entry.
+
+### Fixed
+- Fix error loading empty whitelist file.
+
+## 1.2.0
+
+### Changed
+- Multi-line deprecation messages are matched line-by-line, so only the first
+  lines need to be stored in the whitelist entry.
+- Use safe YAML load on configuration files.
+
+### Fixed
+- Fix duplicate entries created during record mode.
+- Fix Rails 5 callstack compatibility when matching deprecations.
+- Fix array comparison error when matching entries without callstacks.
+
+## 1.1.0
+
+### Added
+- Add `AS_DEPRECATION_WHITELIST` environment variable to load/write whitelist
+  to a different path.
+- Load and merge whitelist config files from each Rails engine root.
+- Add `engine` config option to whitelist, matches engine name.
+- Add whitelist API to add new entries programmatically.
+
+### Changed
+- Raise errors for unknown config options in whitelist.
+
+### Fixed
+- Fix callstack matching against whitelist with relative paths.
+
+## 1.0.0
+
+### Added
+- Initial release, supporting raising of exceptions and recording mode.

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2016-2017 Dominic Cleal
+Copyright (c) 2016-2022 Dominic Cleal
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -119,6 +119,20 @@ Supported options:
 * `whitelist_file` to customise the location of the whitelist YAML file
   (defaults to `config/as_deprecation_whitelist.yaml`)
 
+### Environment variables
+
+Both `AS_DEPRECATION_` or the shorter `ASDT_` prefixes work with all
+environment variables listed below.
+
+* `AS_DEPRECATION_DISABLE` - set to any value will prevent ASDT from monitoring
+  deprecations and throwing exceptions. Rails will use default deprecation
+  behaviour.
+* `AS_DEPRECATION_RECORD` - set to any value will prevent ASDT from throwing
+  exceptions and will append entries to the `whitelist_file` for every
+  deprecation seen.
+* `AS_DEPRECATION_WHITELIST` - set to the root or full path of a whitelist
+  configuration file, overrides `whitelist_file`.
+
 ### Pause/resume
 
 The processing of deprecation warnings can be suspended and resumed via the
@@ -129,6 +143,15 @@ initialisation, as deprecation processing can be disabled until the whitelist
 is fully formed. ASDT will queue events while paused and processes them when
 `resume!` is called.
 
+## Alternatives
+
+Shopify have open-sourced a gem that works very similarly to ASDT and is worth
+a look. It supports more configuration options when seeing a new or removed
+deprecation warning, and also supports `Kernel#warn`.
+
+* [Shopify: Introducing the deprecation toolkit](https://engineering.shopify.com/blogs/engineering/introducing-the-deprecation-toolkit)
+* [deprecation_toolkit (GitHub)](https://github.com/shopify/deprecation_toolkit)
+
 ## License
 
-Copyright (c) 2016-2017 Dominic Cleal.  Distributed under the MIT license.
+Copyright (c) 2016-2022 Dominic Cleal.  Distributed under the MIT license.

data/Rakefile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'rubocop/rake_task'
@@ -11,4 +12,4 @@ end
 
 RuboCop::RakeTask.new
 
-task default: %w(rubocop test)
+task default: %w[rubocop test]

data/config.ru

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'rubygems'
 require 'bundler'
 

data/lib/as_deprecation_tracker/configuration.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module ASDeprecationTracker
   # Maintains configuration for one instance (usually global)
   class Configuration
@@ -6,9 +7,9 @@ module ASDeprecationTracker
     alias register_behavior? register_behavior
 
     def initialize
-      @envs = %w(test)
+      @envs = %w[test]
       @line_tolerance = 10
-      @register_behavior = true
+      @register_behavior = ASDeprecationTracker.env('DISABLE').nil?
       @whitelist_file = File.join('config', 'as_deprecation_whitelist.yaml')
     end
   end

data/lib/as_deprecation_tracker/railtie.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'as_deprecation_tracker/receiver'
 
 module ASDeprecationTracker

data/lib/as_deprecation_tracker/receiver.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'active_support/subscriber'
 require 'as_deprecation_tracker/writer'
 
@@ -24,7 +25,7 @@ module ASDeprecationTracker
 
       message = event.payload[:message]
       callstack = event.payload[:callstack].map(&:to_s)
-      if ENV['AS_DEPRECATION_RECORD'].present?
+      if ASDeprecationTracker.env('RECORD').present?
         write_deprecation(message, callstack)
       else
         raise_deprecation(message, callstack)
@@ -41,8 +42,8 @@ module ASDeprecationTracker
     end
 
     def whitelist_file
-      root = if ENV['AS_DEPRECATION_WHITELIST'].present?
-               File.expand_path(ENV['AS_DEPRECATION_WHITELIST'])
+      root = if ASDeprecationTracker.env('WHITELIST').present?
+               File.expand_path(ASDeprecationTracker.env('WHITELIST'))
              else
                Rails.root
              end

data/lib/as_deprecation_tracker/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module ASDeprecationTracker
-  VERSION = '1.4.0'.freeze
+  VERSION = '1.6.0'
 end

data/lib/as_deprecation_tracker/whitelist.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'as_deprecation_tracker/whitelist_entry'
 
 module ASDeprecationTracker
@@ -12,7 +13,7 @@ module ASDeprecationTracker
     end
 
     def add_to_list(*entries)
-      entries.flatten.each { |entry| @list << WhitelistEntry.new(entry.symbolize_keys) }
+      entries.flatten.each { |entry| @list << WhitelistEntry.new(**entry.symbolize_keys) }
     end
     alias add add_to_list
 
@@ -21,7 +22,7 @@ module ASDeprecationTracker
     end
 
     def load_file(path)
-      add_to_list(YAML.safe_load(File.read(path), [Symbol]) || [])
+      add_to_list(YAML.load(File.read(path)) || [])
     end
 
     def matches?(deprecation)

data/lib/as_deprecation_tracker/whitelist_entry.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
+
 module ASDeprecationTracker
   # Configuration of a whitelisted (known) deprecation warning matched by data
   # such as a message and/or callstack
   class WhitelistEntry
-    KNOWN_KEYS = %w(callstack engine message).freeze
+    KNOWN_KEYS = %w[callstack engine message].freeze
     MESSAGE_CLEANUP_RE = Regexp.new('\ADEPRECATION WARNING: (.+) \(called from.*')
     CALLSTACK_FILE_RE = Regexp.new('\A(.*?)(?::(\d+))?(?::in `(.+)\')?\z')
 
@@ -13,14 +14,13 @@ module ASDeprecationTracker
       @message = message
     end
 
-    # rubocop:disable Metrics/CyclomaticComplexity
     def matches?(deprecation)
       return false if @message.present? && !message_matches?(deprecation[:message])
       return false if @callstack.present? && !callstack_matches?(deprecation[:callstack])
       return false if @engine_root.present? && !engine_root_matches?(deprecation[:callstack])
+
       true
     end
-    # rubocop:enable Metrics/CyclomaticComplexity
 
     private
 
@@ -60,11 +60,13 @@ module ASDeprecationTracker
 
     def line_number_within_tolerance(line1, line2)
       return true if line1.nil? || line2.nil?
+
       (line1 - line2).abs <= ASDeprecationTracker.config.line_tolerance
     end
 
     def method_name_matches(method1, method2)
       return true if method1.nil? || method2.nil?
+
       method1 == method2
     end
 
@@ -76,7 +78,7 @@ module ASDeprecationTracker
       ::Rails::Engine.descendants.each do |engine|
         begin
           return engine.root.to_s if engine_name.to_s == engine.engine_name.to_s
-        rescue NoMethodError, RuntimeError # rubocop:disable Lint/HandleExceptions
+        rescue NoMethodError, RuntimeError
           # Ignore failures with singleton engine subclasses etc.
         end
       end

data/lib/as_deprecation_tracker/writer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'as_deprecation_tracker/whitelist_entry'
 require 'rails/backtrace_cleaner'
 
@@ -8,7 +9,7 @@ module ASDeprecationTracker
     def initialize(filename)
       @filename = filename
       @contents = []
-      @contents = YAML.safe_load(File.read(filename), [Symbol]) || [] if File.exist?(filename)
+      @contents = YAML.load(File.read(filename)) || [] if File.exist?(filename)
     end
 
     def add(message, callstack)

data/lib/as_deprecation_tracker.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Entry point, provides constant with access to global configuration only
 module ASDeprecationTracker
   require 'as_deprecation_tracker/configuration'
@@ -15,7 +16,7 @@ module ASDeprecationTracker
   end
 
   def self.pause!
-    @running = false
+    @paused = true
   end
 
   def self.receiver
@@ -23,15 +24,19 @@ module ASDeprecationTracker
   end
 
   def self.resume!
-    @running = true
+    @paused = false
     @receiver.try!(:process_queue)
   end
 
   def self.running?
-    @running.nil? || @running
+    env('DISABLE').nil? && !@paused
   end
 
   def self.whitelist
     @whitelist ||= Whitelist.new
   end
+
+  def self.env(name)
+    ENV.fetch("AS_DEPRECATION_#{name}", ENV.fetch("ASDT_#{name}", nil))
+  end
 end

data/test/as_deprecation_tracker_test.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'test_helper'
 
 class ASDeprecationTrackerTest < ASDeprecationTracker::TestCase
@@ -21,6 +22,18 @@ class ASDeprecationTrackerTest < ASDeprecationTracker::TestCase
     assert_equal config, ASDeprecationTracker.config
   end
 
+  def test_env_as_deprecation
+    with_env(AS_DEPRECATION_TEST: 'test') do
+      assert_equal 'test', ASDeprecationTracker.env('TEST')
+    end
+  end
+
+  def test_env_asdt
+    with_env(ASDT_TEST: 'test') do
+      assert_equal 'test', ASDeprecationTracker.env('TEST')
+    end
+  end
+
   def test_pause!
     ASDeprecationTracker.pause!
     refute ASDeprecationTracker.running?
@@ -49,6 +62,12 @@ class ASDeprecationTrackerTest < ASDeprecationTracker::TestCase
     assert_equal true, ASDeprecationTracker.running?
   end
 
+  def test_running_with_disable_true
+    with_env(AS_DEPRECATION_DISABLE: 'true') do
+      assert_equal false, ASDeprecationTracker.running?
+    end
+  end
+
   def test_whitelist
     assert_kind_of ASDeprecationTracker::Whitelist, ASDeprecationTracker.whitelist
   end

data/test/configuration_test.rb

@@ -1,46 +1,54 @@
 # frozen_string_literal: true
+
 require 'test_helper'
 
 class ConfigurationTest < ASDeprecationTracker::TestCase
-  def setup
-    @config = ASDeprecationTracker::Configuration.new
-    super
-  end
-
   def test_envs
-    assert_equal ['test'], @config.envs
+    assert_equal ['test'], config.envs
   end
 
   def test_envs=
-    @config.envs = ['development']
-    assert_equal ['development'], @config.envs
+    config.envs = ['development']
+    assert_equal ['development'], config.envs
   end
 
   def test_line_tolerance
-    assert_equal 10, @config.line_tolerance
+    assert_equal 10, config.line_tolerance
   end
 
   def test_line_tolerance=
-    @config.line_tolerance = 42
-    assert_equal 42, @config.line_tolerance
+    config.line_tolerance = 42
+    assert_equal 42, config.line_tolerance
   end
 
   def test_register_behavior?
-    assert_equal true, @config.register_behavior?
+    assert_equal true, config.register_behavior?
+  end
+
+  def test_running_with_disable_true
+    with_env(AS_DEPRECATION_DISABLE: 'true') do
+      assert_equal false, config.register_behavior?
+    end
   end
 
   def test_register_behavior=
-    @config.register_behavior = false
-    assert_equal false, @config.register_behavior?
+    config.register_behavior = false
+    assert_equal false, config.register_behavior?
   end
 
   def test_whitelist_file
-    assert_kind_of String, @config.whitelist_file
-    assert File.exist?(File.join(Rails.root, @config.whitelist_file))
+    assert_kind_of String, config.whitelist_file
+    assert File.exist?(File.join(Rails.root, config.whitelist_file))
   end
 
   def test_whitelist_file=
-    @config.whitelist_file = 'another_file.yaml'
-    assert_equal 'another_file.yaml', @config.whitelist_file
+    config.whitelist_file = 'another_file.yaml'
+    assert_equal 'another_file.yaml', config.whitelist_file
+  end
+
+  private
+
+  def config
+    @config ||= ASDeprecationTracker::Configuration.new
   end
 end

data/test/internal/config/routes.rb

@@ -1,4 +1,3 @@
 # frozen_string_literal: true
-Rails.application.routes.draw do
-  #
-end
+#
+# No routes in test app

data/test/railtie_test.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'test_helper'
 
 class RailtieTest < ASDeprecationTracker::TestCase

data/test/receiver_test.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'test_helper'
 
 class ReceiverTest < ASDeprecationTracker::TestCase

data/test/test_helper.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
+
 require 'minitest/autorun'
-require 'mocha/mini_test'
+require 'mocha/minitest'
 require 'combustion'
 
 require 'as_deprecation_tracker'
@@ -17,7 +18,7 @@ module ASDeprecationTracker
         ENV.update(new_env)
         yield
       ensure
-        new_env.keys.each { |k| ENV.delete(k) }
+        new_env.each_key { |k| ENV.delete(k) }
         ENV.update(backup)
       end
     end

data/test/whitelist_entry_test.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'test_helper'
 
 class WhitelistEntryTest < ASDeprecationTracker::TestCase
@@ -133,9 +134,9 @@ class WhitelistEntryTest < ASDeprecationTracker::TestCase
 
   def entry(overrides = {})
     entry_hash = default_deprecation.merge(overrides).compact
-    entry_hash[:callstack].map! { |line| line.sub(Rails.root.to_s + '/', '') } if entry_hash[:callstack].is_a?(Array)
+    entry_hash[:callstack].map! { |line| line.sub("#{Rails.root}/", '') } if entry_hash[:callstack].is_a?(Array)
 
     ASDeprecationTracker::WhitelistEntry.any_instance.expects(:engine_root).with(overrides[:engine]).returns("/home/user/engines/#{overrides[:engine]}") if overrides.key?(:engine)
-    ASDeprecationTracker::WhitelistEntry.new(entry_hash)
+    ASDeprecationTracker::WhitelistEntry.new(**entry_hash)
   end
 end

data/test/whitelist_test.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'test_helper'
 
 class WhitelistTest < ASDeprecationTracker::TestCase

data/test/writer_test.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'test_helper'
 
 class WriterTest < ASDeprecationTracker::TestCase
@@ -6,24 +7,24 @@ class WriterTest < ASDeprecationTracker::TestCase
     writer = new_writer
     ret = writer.add('deprecated call', ['app/models/a.rb:23', 'app/models/b.rb:42'])
     assert_equal({ 'message' => 'deprecated call', 'callstack' => 'app/models/a.rb:23' }, ret)
-    assert_equal [ret], YAML.safe_load(writer.contents)
+    assert_equal [ret], YAML.load(writer.contents)
   end
 
   def test_add_strips_surrounding
     writer = new_writer
     writer.add('DEPRECATION WARNING: deprecated call (called from app/models/a.rb:23)', ['app/models/a.rb:23', 'app/models/b.rb:42'])
-    assert_equal [{ 'message' => 'deprecated call', 'callstack' => 'app/models/a.rb:23' }], YAML.safe_load(writer.contents)
+    assert_equal [{ 'message' => 'deprecated call', 'callstack' => 'app/models/a.rb:23' }], YAML.load(writer.contents)
   end
 
   def test_add_cleans_callstack
     writer = new_writer
     Gem.expects(:path).returns(['/home/user/.rvm/gems/ruby-2.3.0'])
     writer.add('deprecated call', ['/home/user/.rvm/gems/ruby-2.3.0/gems/activerecord-4.2.7.1/lib/active_record/relation/finder_methods.rb:280:in `exists?\'', 'app/models/a.rb:23', 'app/models/b.rb:42'])
-    assert_equal [{ 'message' => 'deprecated call', 'callstack' => 'app/models/a.rb:23' }], YAML.safe_load(writer.contents)
+    assert_equal [{ 'message' => 'deprecated call', 'callstack' => 'app/models/a.rb:23' }], YAML.load(writer.contents)
   end
 
   def test_contents_new_file_is_array
-    assert_equal [], YAML.safe_load(new_writer('').contents)
+    assert_equal [], YAML.load(new_writer('').contents)
   end
 
   def test_contents_sorting
@@ -35,7 +36,7 @@ class WriterTest < ASDeprecationTracker::TestCase
       { 'message' => 'deprecated call 1', 'callstack' => 'app/models/a.rb:23' },
       { 'message' => 'deprecated call 1', 'callstack' => 'app/models/a.rb:42' },
       { 'message' => 'deprecated call 2', 'callstack' => 'app/models/a.rb:23' }
-    ], YAML.safe_load(writer.contents)
+    ], YAML.load(writer.contents)
   end
 
   def test_contents_sorting_existing_message_without_callstack
@@ -45,7 +46,7 @@ class WriterTest < ASDeprecationTracker::TestCase
     assert_equal [
       { 'message' => 'deprecated call 1' },
       { 'message' => 'deprecated call 1', 'callstack' => 'app/models/a.rb:23' }
-    ], YAML.safe_load(writer.contents)
+    ], YAML.load(writer.contents)
   end
 
   def test_write_file

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: as_deprecation_tracker
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Dominic Cleal
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-02-27 00:00:00.000000000 Z
+date: 2022-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -45,6 +45,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
+- CHANGELOG.md
 - LICENSE
 - README.md
 - Rakefile
@@ -72,8 +74,9 @@ files:
 homepage: https://github.com/domcleal/as_deprecation_tracker
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -88,9 +91,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Track known ActiveSupport deprecation warnings
 test_files: []