as_deprecation_tracker 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b25a9c470b3310b7a3112d290e0655811ea93c3d
+  data.tar.gz: 78857eba82e956ad61ad8e6276128fe4a73d6056
+SHA512:
+  metadata.gz: 83efcef8a382e9c9cace6a2e942f7d96032d587b76b1ab36707cf3f7c37c82a1e6a8a241c1bdd8da5de298fe6e5ec2b2f705414f8c47208d3581059087629e0e
+  data.tar.gz: c6558bacefd24acba76e6aa3e6bb23beff1e26cf1ec502cc010f6172f7cdd07f86affaf919509eef9b58015fb2ab7d3e761b129b16800765684a422b9aa7b94d

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Dominic Cleal
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,108 @@
+# as_deprecation_tracker
+
+Tracks known ActiveSupport (Rails) deprecation warnings and catches new issues
+when an unknown warning is seen.
+
+This allows for easier upgrades of Rails and other AS-based apps because as
+each deprecation warning is fixed, it's removed from the whitelist and any
+attempt to reintroduce the deprecated call will fail. It's also useful when the
+app runs on multiple versions of Rails and newer deprecation warnings can't be
+fixed yet without breaking the older version.
+
+The library maintains the whitelist in a configuration file that's usually
+initially written by running the app test suite with an environment variable
+set. When the tests are run normally, deprecation warnings triggered that
+aren't in the config file will raise an exception. The call can then be fixed
+or added to the whitelist with the provided instructions.
+
+If you'd prefer just to fix all deprecation warnings at once then this gem is
+unnecessary! Just use:
+
+```ruby
+ActiveSupport::Deprecation.behavior = :raise
+```
+
+in your test environment config.
+
+## Installation
+
+    $ gem install as_deprecation_tracker
+
+or in your Gemfile:
+
+    gem 'as_deprecation_tracker', '~> 1.0', group: 'test'
+
+This gem and its API is versioned according to semver.
+
+It's recommended to only add the gem to the test Bundler group as raising
+errors in production and development isn't desirable.
+
+## Usage
+
+### Automatic whitelisting
+
+To set up an initial whitelist, run:
+
+    AS_DEPRECATION_RECORD=yes bin/rake test
+
+This will generate `config/as_deprecation_whitelist.yaml` with a list of
+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.
+
+### Whitelist configuration
+
+The whitelist may be broad, permitting any call causing a particular
+deprecation message or be precise, only permitting known calls identified by
+their backtrace. With broad whitelists, more instances of the same deprecated
+call may be added, but precise whitelists require more maintenance if code is
+moved and the backtrace changes.
+
+The whitelist is stored in the Rails root at
+`config/as_deprecation_whitelist.yaml` and is a YAML file containing a single
+array of hashes:
+
+```yaml
+---
+- message: "Deprecated call to X, use Y instead"
+- message: "Deprecated call to Z"
+  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.
+
+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
+number and method specification may be given for more specificity. The line
+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.
+
+### Configuration
+
+Use an initializer to change ASDT's behaviour at startup:
+
+```ruby
+ASDeprecationTracker.config.envs = %w(test development)
+```
+
+Supported options:
+
+* `envs` is an array of string Rails environment names that ASDT will monitor
+  and raise errors for unpermitted deprecation warnings (defaults to
+  `['test']`)
+* `line_tolerance` is the number of lines that callstack line numbers may
+  differ from the deprecated call (defaults to 10)
+* `register_behavior` controls whether to change the AS::Deprecation behavior
+  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)
+
+## License
+
+Copyright (c) 2016 Dominic Cleal.  Distributed under the MIT license.

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+RuboCop::RakeTask.new
+
+task default: %w(rubocop test)

data/config.ru

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize! :all
+run Combustion::Application

data/lib/as_deprecation_tracker/configuration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module ASDeprecationTracker
+  # Maintains configuration for one instance (usually global)
+  class Configuration
+    attr_accessor :envs, :line_tolerance, :register_behavior, :whitelist_file
+    alias register_behavior? register_behavior
+
+    def initialize
+      @envs = %w(test)
+      @line_tolerance = 10
+      @register_behavior = true
+      @whitelist_file = File.join(Rails.root, 'config', 'as_deprecation_whitelist.yaml')
+    end
+  end
+end

data/lib/as_deprecation_tracker/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+require 'as_deprecation_tracker/receiver'
+
+module ASDeprecationTracker
+  # Railtie to register for deprecation notifications
+  class Railtie < ::Rails::Railtie
+    initializer 'as_deprecation_tracker.deprecation_notifications', after: :load_environment_config, if: -> { ASDeprecationTracker.active? } do
+      Receiver.attach_to :rails
+      ActiveSupport::Deprecation.behavior = :notify if ASDeprecationTracker.config.register_behavior?
+
+      whitelist = ASDeprecationTracker.config.whitelist_file
+      ASDeprecationTracker.whitelist.load_file(whitelist) if File.exist?(whitelist)
+    end
+  end
+end

data/lib/as_deprecation_tracker/receiver.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+require 'active_support/subscriber'
+require 'as_deprecation_tracker/writer'
+
+module ASDeprecationTracker
+  # Receives deprecation.rails events via ActiveSupport::Notifications
+  class Receiver < ::ActiveSupport::Subscriber
+    def deprecation(event)
+      return if ASDeprecationTracker.whitelist.matches?(event.payload)
+
+      message = event.payload[:message]
+      callstack = event.payload[:callstack].map(&:to_s)
+      if ENV['AS_DEPRECATION_RECORD'].present?
+        write_deprecation(message, callstack)
+      else
+        raise_deprecation(message, callstack)
+      end
+    end
+
+    private
+
+    def write_deprecation(message, callstack)
+      writer = ASDeprecationTracker::Writer.new(ASDeprecationTracker.config.whitelist_file)
+      writer.add(message, callstack)
+      writer.write_file
+    end
+
+    def raise_deprecation(message, callstack)
+      e = ActiveSupport::DeprecationException.new(message)
+      e.set_backtrace(callstack)
+      raise e
+    end
+  end
+end

data/lib/as_deprecation_tracker/version.rb

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

data/lib/as_deprecation_tracker/whitelist.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+require 'as_deprecation_tracker/whitelist_entry'
+
+module ASDeprecationTracker
+  # Stores a list of known and ignored deprecation warnings, and provides a
+  # query interface to check if a warning matches the list
+  class Whitelist
+    attr_reader :list
+
+    def initialize
+      @list = []
+    end
+
+    def add_to_list(entries)
+      entries.each { |entry| @list << WhitelistEntry.new(entry) }
+    end
+
+    def clear
+      @list.clear
+    end
+
+    def load_file(path)
+      add_to_list(YAML.load(File.read(path)))
+    end
+
+    def matches?(deprecation)
+      @list.any? { |entry| entry.matches?(deprecation) }
+    end
+  end
+end

data/lib/as_deprecation_tracker/whitelist_entry.rb

@@ -0,0 +1,63 @@
+# 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
+    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]))
+    end
+
+    def matches?(deprecation)
+      return false if @message.present? && !message_matches?(deprecation[:message])
+      return false if @callstack.present? && !callstack_matches?(deprecation[:callstack])
+      true
+    end
+
+    private
+
+    def message_matches?(message)
+      cleanup_match = MESSAGE_CLEANUP_RE.match(message)
+      message = cleanup_match[1] if cleanup_match
+      message == @message
+    end
+
+    def callstack_to_files_lines(callstack)
+      callstack.map do |entry|
+        file_match = CALLSTACK_FILE_RE.match(entry)
+        [file_match[1], file_match[2].nil? ? nil : file_match[2].to_i, file_match[3]]
+      end
+    end
+
+    def callstack_matches?(callstack)
+      callstack = callstack_to_files_lines(callstack)
+
+      @callstack.all? do |whitelist_entry|
+        callstack_entry_matches?(whitelist_entry, callstack)
+      end
+    end
+
+    def callstack_entry_matches?(whitelist_entry, callstack)
+      callstack.any? do |callstack_entry|
+        callstack_entry[0] == whitelist_entry[0] &&
+          line_number_within_tolerance(callstack_entry[1], whitelist_entry[1]) &&
+          method_name_matches(callstack_entry[2], whitelist_entry[2])
+      end
+    end
+
+    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
+  end
+end

data/lib/as_deprecation_tracker/writer.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+require 'as_deprecation_tracker/whitelist_entry'
+require 'rails/backtrace_cleaner'
+
+module ASDeprecationTracker
+  # Rewrites the whitelist configuration file to append new observed entries
+  class Writer
+    def initialize(filename)
+      @filename = filename
+      @contents = []
+      @contents = YAML.load(File.read(filename)) || [] if File.exist?(filename)
+    end
+
+    def add(message, callstack)
+      cleanup_match = WhitelistEntry::MESSAGE_CLEANUP_RE.match(message)
+      message = cleanup_match[1] if cleanup_match
+
+      callstack = Rails::BacktraceCleaner.new.clean(callstack, :silent)
+
+      @contents << { 'message' => message, 'callstack' => callstack.first }
+    end
+
+    def contents
+      @contents.sort_by { |e| e.values_at('message', 'callstack') }.to_yaml
+    end
+
+    def write_file
+      File.write(@filename, contents)
+    end
+  end
+end

data/lib/as_deprecation_tracker.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+# Entry point, provides constant with access to global configuration only
+module ASDeprecationTracker
+  require 'as_deprecation_tracker/configuration'
+  require 'as_deprecation_tracker/railtie'
+  require 'as_deprecation_tracker/version'
+  require 'as_deprecation_tracker/whitelist'
+
+  def self.active?
+    config.envs.include?(Rails.env)
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.whitelist
+    @whitelist ||= Whitelist.new
+  end
+end

data/test/as_deprecation_tracker_test.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class ASDeprecationTrackerTest < ASDeprecationTracker::TestCase
+  def test_active?
+    assert ASDeprecationTracker.active?
+  end
+
+  def test_active_in_other_env
+    ASDeprecationTracker.expects(:config).twice.returns(ASDeprecationTracker::Configuration.new)
+    ASDeprecationTracker.config.envs = ['development']
+    refute ASDeprecationTracker.active?
+  end
+
+  def test_config
+    assert_kind_of ASDeprecationTracker::Configuration, ASDeprecationTracker.config
+  end
+
+  def test_config_returns_same_configuration
+    config = ASDeprecationTracker.config
+    assert_equal config, ASDeprecationTracker.config
+  end
+
+  def test_whitelist
+    assert_kind_of ASDeprecationTracker::Whitelist, ASDeprecationTracker.whitelist
+  end
+
+  def test_whitelist_returns_same_whitelist
+    whitelist = ASDeprecationTracker.whitelist
+    assert_equal whitelist, ASDeprecationTracker.whitelist
+  end
+end

data/test/configuration_test.rb

@@ -0,0 +1,46 @@
+# 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
+  end
+
+  def test_envs=
+    @config.envs = ['development']
+    assert_equal ['development'], @config.envs
+  end
+
+  def test_line_tolerance
+    assert_equal 10, @config.line_tolerance
+  end
+
+  def test_line_tolerance=
+    @config.line_tolerance = 42
+    assert_equal 42, @config.line_tolerance
+  end
+
+  def test_register_behavior?
+    assert_equal true, @config.register_behavior?
+  end
+
+  def test_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?(@config.whitelist_file)
+  end
+
+  def test_whitelist_file=
+    @config.whitelist_file = 'another_file.yaml'
+    assert_equal 'another_file.yaml', @config.whitelist_file
+  end
+end

data/test/internal/config/as_deprecation_whitelist.yaml

@@ -0,0 +1 @@
+--- []

data/test/internal/config/routes.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+Rails.application.routes.draw do
+  #
+end

data/test/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/test/railtie_test.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class RailtieTest < ASDeprecationTracker::TestCase
+  def test_deprecation_behavior
+    assert_equal [ActiveSupport::Deprecation::DEFAULT_BEHAVIORS[:notify]], ActiveSupport::Deprecation.behavior
+  end
+end

data/test/receiver_test.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class ReceiverTest < ASDeprecationTracker::TestCase
+  def test_deprecation_whitelisted
+    whitelist = ASDeprecationTracker::Whitelist.new
+    ASDeprecationTracker.expects(:whitelist).returns(whitelist)
+    stack = caller
+    whitelist.expects(:matches?).with(message: 'deprecated call', callstack: stack).returns(true)
+    ASDeprecationTracker::Receiver.new.deprecation(event(message: 'deprecated call', callstack: stack))
+  end
+
+  def test_deprecation_unknown
+    whitelist = ASDeprecationTracker::Whitelist.new
+    ASDeprecationTracker.expects(:whitelist).returns(whitelist)
+    stack = caller
+    whitelist.expects(:matches?).with(message: 'deprecated call', callstack: stack).returns(false)
+    e = assert_raises(ActiveSupport::DeprecationException) do
+      ASDeprecationTracker::Receiver.new.deprecation(event(message: 'deprecated call', callstack: stack))
+    end
+    assert_equal 'deprecated call', e.message
+    assert_equal stack, e.backtrace
+  end
+
+  def test_deprecation_unknown_record
+    whitelist = ASDeprecationTracker::Whitelist.new
+    ASDeprecationTracker.expects(:whitelist).returns(whitelist)
+    stack = caller
+    whitelist.expects(:matches?).with(message: 'deprecated call', callstack: stack).returns(false)
+    ASDeprecationTracker::Writer.any_instance.expects(:add).with('deprecated call', stack)
+    ASDeprecationTracker::Writer.any_instance.expects(:write_file)
+    ENV['AS_DEPRECATION_RECORD'] = 'true'
+    ASDeprecationTracker::Receiver.new.deprecation(event(message: 'deprecated call', callstack: stack))
+  ensure
+    ENV.delete('AS_DEPRECATION_RECORD')
+  end
+
+  def test_subscription
+    ASDeprecationTracker::Receiver.any_instance.expects(:deprecation)
+    ActiveSupport::Notifications.instrument('deprecation.rails', message: 'test')
+  end
+
+  private
+
+  def event(payload)
+    mock('event').tap do |event|
+      event.stubs(:payload).returns(payload)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+require 'minitest/autorun'
+require 'mocha/mini_test'
+require 'combustion'
+
+require 'as_deprecation_tracker'
+
+Combustion.path = 'test/internal'
+Combustion.initialize!
+
+module ASDeprecationTracker
+  class TestCase < ::Minitest::Test; end
+end

data/test/whitelist_entry_test.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class WhitelistEntryTest < ASDeprecationTracker::TestCase
+  def test_initialize_with_strings
+    ASDeprecationTracker::WhitelistEntry.new('message' => 'test')
+  end
+
+  def test_initialize_with_symbols
+    ASDeprecationTracker::WhitelistEntry.new(message: 'test')
+  end
+
+  def test_matches_message_and_callstack
+    assert entry.matches?(deprecation)
+  end
+
+  def test_matches_message_with_surrounding_content
+    assert entry.matches?(deprecation(message: 'DEPRECATION WARNING: uniq is deprecated and will be removed (called from block in <class:Foo> at app/models/foo.rb:23)'))
+  end
+
+  def test_matches_message_only
+    assert entry(callstack: nil).matches?(deprecation(callstack: caller))
+  end
+
+  def test_matches_callstack_only
+    assert entry(message: nil).matches?(deprecation)
+  end
+
+  def test_matches_partial_callstack_top
+    assert entry(callstack: ['/home/user/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)
+  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'
+                 ]).matches?(deprecation)
+  end
+
+  def test_matches_partial_callstack_within_tolerance
+    assert entry(callstack: ['/home/user/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)
+  end
+
+  def test_matches_partial_callstack_same_method
+    assert entry(callstack: ['/home/user/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)
+  end
+
+  def test_matches_partial_callstack_different_method_no_line
+    refute entry(callstack: ['/home/user/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)
+  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)
+  end
+
+  def test_matches_partial_callstack_string
+    assert entry(callstack: '/home/user/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)
+  end
+
+  def test_matches_different_message_same_callstack
+    refute entry.matches?(deprecation(message: 'a different method is deprecated'))
+  end
+
+  def test_matches_same_message_different_callstack
+    refute entry.matches?(deprecation(callstack: caller))
+  end
+
+  def test_matches_different_message_different_callstack
+    refute entry.matches?(deprecation(message: 'a different method is deprecated', callstack: caller))
+  end
+
+  private
+
+  def deprecation(overrides = {})
+    {
+      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>\''
+      ]
+    }.merge(overrides).compact
+  end
+
+  def entry(overrides = {})
+    ASDeprecationTracker::WhitelistEntry.new(deprecation(overrides))
+  end
+end

data/test/whitelist_test.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class WhitelistTest < ASDeprecationTracker::TestCase
+  def setup
+    @whitelist = ASDeprecationTracker::Whitelist.new
+    super
+  end
+
+  def test_add_to_list
+    @whitelist.add_to_list([entry])
+    assert_equal 1, @whitelist.list.count
+  end
+
+  def test_clear
+    @whitelist.add_to_list([entry])
+    @whitelist.clear
+    assert @whitelist.list.empty?
+  end
+
+  def test_load_file
+    File.expects(:read).with('root/config/as_deprecation_whitelist.yaml').returns("---\n- :message: test\n")
+    @whitelist.load_file('root/config/as_deprecation_whitelist.yaml')
+    assert_equal 1, @whitelist.list.count
+  end
+
+  def test_matches_failure
+    @whitelist.add_to_list([entry])
+    deprecation = mock('deprecation')
+    @whitelist.list.first.expects(:matches?).with(deprecation).returns(false)
+    refute @whitelist.matches?(deprecation)
+  end
+
+  def test_matches_success
+    @whitelist.add_to_list([entry])
+    deprecation = mock('deprecation')
+    @whitelist.list.first.expects(:matches?).with(deprecation).returns(true)
+    assert @whitelist.matches?(deprecation)
+  end
+
+  private
+
+  def entry
+    { message: 'deprecated call', callstack: caller }
+  end
+end

data/test/writer_test.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class WriterTest < ASDeprecationTracker::TestCase
+  def test_add
+    writer = new_writer
+    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' }], 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.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.load(writer.contents)
+  end
+
+  def test_contents_new_file_is_array
+    assert_equal [], YAML.load(new_writer('').contents)
+  end
+
+  def test_contents_sorting
+    writer = new_writer
+    writer.add('deprecated call 1', ['app/models/a.rb:42', 'app/models/b.rb:42'])
+    writer.add('deprecated call 2', ['app/models/a.rb:23', 'app/models/b.rb:42'])
+    writer.add('deprecated call 1', ['app/models/a.rb:23', 'app/models/b.rb:42'])
+    assert_equal [
+      { '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.load(writer.contents)
+  end
+
+  def test_write_file
+    writer = new_writer
+    writer.expects(:contents).returns('--- []')
+    File.expects(:write).with('root/config/as_deprecation_whitelist.yaml', '--- []')
+    writer.write_file
+  end
+
+  private
+
+  def new_writer(input = '')
+    File.expects(:exist?).with('root/config/as_deprecation_whitelist.yaml').returns(true)
+    File.expects(:read).with('root/config/as_deprecation_whitelist.yaml').returns(input)
+    ASDeprecationTracker::Writer.new('root/config/as_deprecation_whitelist.yaml')
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: as_deprecation_tracker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dominic Cleal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Tracks known ActiveSupport (Rails) deprecation warnings and catches new
+  issues when an unknown warning is seen.
+email: dominic@cleal.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- config.ru
+- lib/as_deprecation_tracker.rb
+- lib/as_deprecation_tracker/configuration.rb
+- lib/as_deprecation_tracker/railtie.rb
+- lib/as_deprecation_tracker/receiver.rb
+- lib/as_deprecation_tracker/version.rb
+- lib/as_deprecation_tracker/whitelist.rb
+- lib/as_deprecation_tracker/whitelist_entry.rb
+- lib/as_deprecation_tracker/writer.rb
+- test/as_deprecation_tracker_test.rb
+- test/configuration_test.rb
+- test/internal/config/as_deprecation_whitelist.yaml
+- test/internal/config/routes.rb
+- test/internal/log/.gitignore
+- test/internal/public/favicon.ico
+- test/railtie_test.rb
+- test/receiver_test.rb
+- test/test_helper.rb
+- test/whitelist_entry_test.rb
+- test/whitelist_test.rb
+- test/writer_test.rb
+homepage: https://github.com/domcleal/as_deprecation_tracker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Track known ActiveSupport deprecation warnings
+test_files: []