as_deprecation_tracker 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b25a9c470b3310b7a3112d290e0655811ea93c3d
-  data.tar.gz: 78857eba82e956ad61ad8e6276128fe4a73d6056
+  metadata.gz: 3c3db75579f6e32b233ab757406affac74f42210
+  data.tar.gz: 22c98db26c0c16b71993f038804b9b6e23ad7ea4
 SHA512:
-  metadata.gz: 83efcef8a382e9c9cace6a2e942f7d96032d587b76b1ab36707cf3f7c37c82a1e6a8a241c1bdd8da5de298fe6e5ec2b2f705414f8c47208d3581059087629e0e
-  data.tar.gz: c6558bacefd24acba76e6aa3e6bb23beff1e26cf1ec502cc010f6172f7cdd07f86affaf919509eef9b58015fb2ab7d3e761b129b16800765684a422b9aa7b94d
+  metadata.gz: 7d3a4345c389c3a37436cab4aaac86c981264f237e8e14d0366b9b3a85b53e24f6d567ecb3029daac26f6f438b4adf634ae1d8073a1d9edd3d175f6b727a8812
+  data.tar.gz: a4609be92a9373db4acba7a048f0ee320a51f027d5295a6c2c3c3cad4d608ab8ad3872cdd5eca617313337554b932d5b810fa0f76e3bbc75230a092d481582de

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2016 Dominic Cleal
+Copyright (c) 2016-2017 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

@@ -50,7 +50,10 @@ specific instances of deprecated calls which can be committed. Subsequent `rake
 test` runs will then automatically raise errors for new occurrences.
 
 Re-run tests with `AS_DEPRECATION_RECORD=yes` to append new instances to the
-existing configuration file, if you wish to whitelist rather than fix them.
+existing whitelist file, if you wish to permit rather than fix them.
+
+Use `AS_DEPRECATION_WHITELIST=~/rails_engine` to set a different root directory
+or whitelist file to update, e.g. for a Rails engine.
 
 ### Whitelist configuration
 
@@ -71,9 +74,12 @@ array of hashes:
   callstack: "app/models/foo.rb:23:in `example_method'"
 ```
 
-Accepted keys are `message`, matching the exact deprecation message and
-`callstack`, a string or an array forming the backtrace of the deprecation.
-If an array is given for the callstack, all entries must match the caller.
+Accepted keys are:
+
+* `message`, matching the exact deprecation message
+* `callstack`, a string or an array forming the backtrace of the deprecation.
+  If an array is given for the callstack, all entries must match the caller.
+* `engine`, a Rails `engine_name` string, matching any call within the engine
 
 The callstack will match on as much data as is provided - if only a file is
 given, any matching deprecation within the file will be whitelisted. The line
@@ -82,6 +88,13 @@ number may vary by up to ten lines from the recorded number by default (see
 `line_tolerance` to tune). Usually the filename and method name are sufficient
 to match the caller without needing line numbers.
 
+Additional whitelist files may be placed below the root of each Rails engine
+and will be loaded at startup in addition to the main Rails root config file.
+
+Entries can be added programmatically by calling
+`ASDeprecationTracker.whitelist.add(message: ...)` with any of the supported
+keys above supplied as keyword arguments.
+
 ### Configuration
 
 Use an initializer to change ASDT's behaviour at startup:
@@ -101,8 +114,8 @@ Supported options:
   to ASDeprecationTracker::Receiver at startup, may be disabled to use multiple
   behaviors (defaults to true)
 * `whitelist_file` to customise the location of the whitelist YAML file
-  (defaults to `config/as_deprecation_whitelist.yaml` beneath the Rails root)
+  (defaults to `config/as_deprecation_whitelist.yaml`)
 
 ## License
 
-Copyright (c) 2016 Dominic Cleal.  Distributed under the MIT license.
+Copyright (c) 2016-2017 Dominic Cleal.  Distributed under the MIT license.

data/lib/as_deprecation_tracker/configuration.rb

@@ -9,7 +9,7 @@ module ASDeprecationTracker
       @envs = %w(test)
       @line_tolerance = 10
       @register_behavior = true
-      @whitelist_file = File.join(Rails.root, 'config', 'as_deprecation_whitelist.yaml')
+      @whitelist_file = File.join('config', 'as_deprecation_whitelist.yaml')
     end
   end
 end

data/lib/as_deprecation_tracker/railtie.rb

@@ -9,7 +9,16 @@ module ASDeprecationTracker
       ActiveSupport::Deprecation.behavior = :notify if ASDeprecationTracker.config.register_behavior?
 
       whitelist = ASDeprecationTracker.config.whitelist_file
-      ASDeprecationTracker.whitelist.load_file(whitelist) if File.exist?(whitelist)
+      ([Rails.root] + engine_roots).each do |root|
+        engine_whitelist = File.join(root, whitelist)
+        ASDeprecationTracker.whitelist.load_file(engine_whitelist) if File.exist?(engine_whitelist)
+      end
+    end
+
+    private
+
+    def engine_roots
+      ::Rails::Engine.descendants.map { |engine| engine.root rescue nil }.compact.uniq # rubocop:disable Style/RescueModifier
     end
   end
 end

data/lib/as_deprecation_tracker/receiver.rb

@@ -20,11 +20,25 @@ module ASDeprecationTracker
     private
 
     def write_deprecation(message, callstack)
-      writer = ASDeprecationTracker::Writer.new(ASDeprecationTracker.config.whitelist_file)
+      writer = ASDeprecationTracker::Writer.new(whitelist_file)
       writer.add(message, callstack)
       writer.write_file
     end
 
+    def whitelist_file
+      root = if ENV['AS_DEPRECATION_WHITELIST'].present?
+               File.expand_path(ENV['AS_DEPRECATION_WHITELIST'])
+             else
+               Rails.root
+             end
+
+      if File.directory?(root)
+        File.join(root, ASDeprecationTracker.config.whitelist_file)
+      else
+        root
+      end
+    end
+
     def raise_deprecation(message, callstack)
       e = ActiveSupport::DeprecationException.new(message)
       e.set_backtrace(callstack)

data/lib/as_deprecation_tracker/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ASDeprecationTracker
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/lib/as_deprecation_tracker/whitelist.rb

@@ -11,9 +11,10 @@ module ASDeprecationTracker
       @list = []
     end
 
-    def add_to_list(entries)
-      entries.each { |entry| @list << WhitelistEntry.new(entry) }
+    def add_to_list(*entries)
+      entries.flatten.each { |entry| @list << WhitelistEntry.new(entry.symbolize_keys) }
     end
+    alias_method :add, :add_to_list
 
     def clear
       @list.clear

data/lib/as_deprecation_tracker/whitelist_entry.rb

@@ -3,21 +3,24 @@ 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
     MESSAGE_CLEANUP_RE = Regexp.new('\ADEPRECATION WARNING: (.+) \(called from.*')
     CALLSTACK_FILE_RE = Regexp.new('\A(.*?)(?::(\d+))?(?::in `(.+)\')?\z')
 
-    def initialize(entry)
-      entry = entry.with_indifferent_access
-      raise('Missing `message` or `callstack` from whitelist entry') unless entry.key?(:message) || entry.key?(:callstack)
-      @message = entry[:message]
-      @callstack = callstack_to_files_lines(Array.wrap(entry[:callstack]))
+    def initialize(callstack: [], engine: nil, message: nil)
+      @callstack = callstack_to_files_lines(Array.wrap(callstack))
+      @engine_root = engine.present? ? engine_root(engine) : nil
+      @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
 
@@ -35,6 +38,7 @@ module ASDeprecationTracker
     end
 
     def callstack_matches?(callstack)
+      callstack = Rails::BacktraceCleaner.new.clean(callstack, :silent)
       callstack = callstack_to_files_lines(callstack)
 
       @callstack.all? do |whitelist_entry|
@@ -59,5 +63,20 @@ module ASDeprecationTracker
       return true if method1.nil? || method2.nil?
       method1 == method2
     end
+
+    def engine_root_matches?(callstack)
+      callstack.any? { |callstack_entry| callstack_entry.start_with?(@engine_root) }
+    end
+
+    def engine_root(engine_name)
+      ::Rails::Engine.descendants.each do |engine|
+        begin
+          return engine.root.to_s if engine_name == engine.engine_name
+        rescue NoMethodError, RuntimeError # rubocop:disable Lint/HandleExceptions
+          # Ignore failures with singleton engine subclasses etc.
+        end
+      end
+      raise("Unknown configured engine name #{engine_name}")
+    end
   end
 end

data/test/configuration_test.rb

@@ -36,7 +36,7 @@ class ConfigurationTest < ASDeprecationTracker::TestCase
 
   def test_whitelist_file
     assert_kind_of String, @config.whitelist_file
-    assert File.exist?(@config.whitelist_file)
+    assert File.exist?(File.join(Rails.root, @config.whitelist_file))
   end
 
   def test_whitelist_file=

data/test/receiver_test.rb

@@ -40,6 +40,31 @@ class ReceiverTest < ASDeprecationTracker::TestCase
     ActiveSupport::Notifications.instrument('deprecation.rails', message: 'test')
   end
 
+  def test_whitelist_file_root
+    assert_equal File.join(Rails.root, 'config', 'as_deprecation_whitelist.yaml'), ASDeprecationTracker::Receiver.new.send(:whitelist_file)
+  end
+
+  def test_whitelist_file_env_directory
+    ENV['AS_DEPRECATION_WHITELIST'] = '/'
+    assert_equal File.join('/', 'config', 'as_deprecation_whitelist.yaml'), ASDeprecationTracker::Receiver.new.send(:whitelist_file)
+  ensure
+    ENV.delete('AS_DEPRECATION_WHITELIST')
+  end
+
+  def test_whitelist_file_env_file
+    ENV['AS_DEPRECATION_WHITELIST'] = '/as_deprecation_whitelist.yaml'
+    assert_equal '/as_deprecation_whitelist.yaml', ASDeprecationTracker::Receiver.new.send(:whitelist_file)
+  ensure
+    ENV.delete('AS_DEPRECATION_WHITELIST')
+  end
+
+  def test_whitelist_file_env_expand
+    ENV['AS_DEPRECATION_WHITELIST'] = File.join(Rails.root, '..', 'as_deprecation_whitelist.yaml')
+    assert_equal File.expand_path('../as_deprecation_whitelist.yaml', Rails.root), ASDeprecationTracker::Receiver.new.send(:whitelist_file)
+  ensure
+    ENV.delete('AS_DEPRECATION_WHITELIST')
+  end
+
   private
 
   def event(payload)

data/test/whitelist_entry_test.rb

@@ -2,11 +2,7 @@
 require 'test_helper'
 
 class WhitelistEntryTest < ASDeprecationTracker::TestCase
-  def test_initialize_with_strings
-    ASDeprecationTracker::WhitelistEntry.new('message' => 'test')
-  end
-
-  def test_initialize_with_symbols
+  def test_initialize
     ASDeprecationTracker::WhitelistEntry.new(message: 'test')
   end
 
@@ -27,54 +23,54 @@ class WhitelistEntryTest < ASDeprecationTracker::TestCase
   end
 
   def test_matches_partial_callstack_top
-    assert entry(callstack: ['/home/user/app/models/foo.rb:23']).matches?(deprecation)
+    assert entry(callstack: ['app/models/foo.rb:23']).matches?(deprecation)
   end
 
   def test_matches_partial_callstack_bottom
-    assert entry(callstack: ['/home/user/app/controllers/foos_controller.rb:42']).matches?(deprecation)
+    assert entry(callstack: ['app/controllers/foos_controller.rb:42']).matches?(deprecation)
   end
 
   def test_matches_partial_callstack_multiple
     assert entry(callstack: [
-                   '/home/user/app/models/foo.rb:23',
-                   '/home/user/app/controllers/foos_controller.rb:42'
+                   'app/models/foo.rb:23',
+                   'app/controllers/foos_controller.rb:42'
                  ]).matches?(deprecation)
   end
 
   def test_matches_partial_callstack_within_tolerance
-    assert entry(callstack: ['/home/user/app/models/foo.rb:25']).matches?(deprecation)
+    assert entry(callstack: ['app/models/foo.rb:25']).matches?(deprecation)
   end
 
   def test_matches_partial_callstack_outside_tolerance
-    refute entry(callstack: ['/home/user/app/models/foo.rb:34']).matches?(deprecation)
+    refute entry(callstack: ['app/models/foo.rb:34']).matches?(deprecation)
   end
 
   def test_matches_partial_callstack_same_method
-    assert entry(callstack: ['/home/user/app/models/foo.rb:in `example_method\'']).matches?(deprecation)
+    assert entry(callstack: ['app/models/foo.rb:in `example_method\'']).matches?(deprecation)
   end
 
   def test_matches_partial_callstack_different_method
-    refute entry(callstack: ['/home/user/app/models/foo.rb:23:in `another_method\'']).matches?(deprecation)
+    refute entry(callstack: ['app/models/foo.rb:23:in `another_method\'']).matches?(deprecation)
   end
 
   def test_matches_partial_callstack_different_method_no_line
-    refute entry(callstack: ['/home/user/app/models/foo.rb:in `another_method\'']).matches?(deprecation)
+    refute entry(callstack: ['app/models/foo.rb:in `another_method\'']).matches?(deprecation)
   end
 
   def test_matches_partial_callstack_within_tolerance_same_method
-    assert entry(callstack: ['/home/user/app/models/foo.rb:25:in `example_method\'']).matches?(deprecation)
+    assert entry(callstack: ['app/models/foo.rb:25:in `example_method\'']).matches?(deprecation)
   end
 
   def test_matches_partial_callstack_outside_tolerance_same_method
-    refute entry(callstack: ['/home/user/app/models/foo.rb:34:in `example_method\'']).matches?(deprecation)
+    refute entry(callstack: ['app/models/foo.rb:34:in `example_method\'']).matches?(deprecation)
   end
 
   def test_matches_partial_callstack_string
-    assert entry(callstack: '/home/user/app/models/foo.rb:23').matches?(deprecation)
+    assert entry(callstack: 'app/models/foo.rb:23').matches?(deprecation)
   end
 
   def test_matches_partial_callstack_file
-    assert entry(callstack: ['/home/user/app/models/foo.rb']).matches?(deprecation)
+    assert entry(callstack: ['app/models/foo.rb']).matches?(deprecation)
   end
 
   def test_matches_different_message_same_callstack
@@ -89,20 +85,44 @@ class WhitelistEntryTest < ASDeprecationTracker::TestCase
     refute entry.matches?(deprecation(message: 'a different method is deprecated', callstack: caller))
   end
 
+  def test_matches_only_engine
+    assert entry(engine: 'example').matches?(deprecation(called_in_engine: 'example'))
+  end
+
+  def test_matches_different_engine
+    refute entry(engine: 'another').matches?(deprecation(called_in_engine: 'example'))
+  end
+
+  def test_matches_outside_engine
+    refute entry(engine: 'another').matches?(deprecation(called_in_engine: 'example'))
+  end
+
   private
 
-  def deprecation(overrides = {})
+  def default_deprecation
     {
       message: 'uniq is deprecated and will be removed',
       callstack: [
-        '/home/user/app/models/foo.rb:23:in `example_method\'',
-        '/home/user/app/controllers/foos_controller.rb:42:in `update\'',
-        '/home/user/test/controllers/foos_controller_test.rb:18:in `block in <class:FoosControllerTest>\''
+        "#{Rails.root}/app/models/foo.rb:23:in `example_method'",
+        "#{Rails.root}/app/controllers/foos_controller.rb:42:in `update'",
+        "#{Rails.root}/test/controllers/foos_controller_test.rb:18:in `block in <class:FoosControllerTest>'"
       ]
-    }.merge(overrides).compact
+    }
+  end
+
+  def deprecation(overrides = {})
+    deprecation = default_deprecation
+    if (engine = overrides.delete(:called_in_engine))
+      deprecation[:callstack] << "/home/user/engines/#{engine}/app/middleware/foo.rb:12:in `call'"
+    end
+    deprecation.merge(overrides).compact
   end
 
   def entry(overrides = {})
-    ASDeprecationTracker::WhitelistEntry.new(deprecation(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)
+
+    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)
   end
 end

data/test/whitelist_test.rb

@@ -7,11 +7,21 @@ class WhitelistTest < ASDeprecationTracker::TestCase
     super
   end
 
+  def test_add
+    @whitelist.add(entry)
+    assert_equal 1, @whitelist.list.count
+  end
+
   def test_add_to_list
     @whitelist.add_to_list([entry])
     assert_equal 1, @whitelist.list.count
   end
 
+  def test_add_to_list_string_keys
+    @whitelist.add_to_list([entry.stringify_keys])
+    assert_equal 1, @whitelist.list.count
+  end
+
   def test_clear
     @whitelist.add_to_list([entry])
     @whitelist.clear

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: as_deprecation_tracker
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Dominic Cleal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-02 00:00:00.000000000 Z
+date: 2017-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport