as_deprecation_tracker 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c3db75579f6e32b233ab757406affac74f42210
-  data.tar.gz: 22c98db26c0c16b71993f038804b9b6e23ad7ea4
+  metadata.gz: 8c9e8fd0e5c19889d05575d93539fde6cbd82f90
+  data.tar.gz: 6fc07fb3155fe02e64510b1e2fa7d53440a1e0b8
 SHA512:
-  metadata.gz: 7d3a4345c389c3a37436cab4aaac86c981264f237e8e14d0366b9b3a85b53e24f6d567ecb3029daac26f6f438b4adf634ae1d8073a1d9edd3d175f6b727a8812
-  data.tar.gz: a4609be92a9373db4acba7a048f0ee320a51f027d5295a6c2c3c3cad4d608ab8ad3872cdd5eca617313337554b932d5b810fa0f76e3bbc75230a092d481582de
+  metadata.gz: f4782ab953d838c2ff817d490078117d54bff31a8ecedbda70f271c3f265847333425019a3fb75a60e7309dd6a162530757e4a35906e113d33e7a2d0945a5613
+  data.tar.gz: 8bcff72162a895eefeb70f0bf8409562b4d9beb38248f9124c7038bb955370aef46dc6fd828e60821d98d31a2d9292f64747ed16320436a30118a46bc58cef47

data/README.md

@@ -88,6 +88,10 @@ 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.
 
+The message is an exact string match, but if it's a multi-line message then not
+all lines need to be specified. Only the first lines given will be compared
+against the deprecation message.
+
 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.
 

data/lib/as_deprecation_tracker/receiver.rb

@@ -21,8 +21,9 @@ module ASDeprecationTracker
 
     def write_deprecation(message, callstack)
       writer = ASDeprecationTracker::Writer.new(whitelist_file)
-      writer.add(message, callstack)
+      entry = writer.add(message, callstack)
       writer.write_file
+      ASDeprecationTracker.whitelist.add(entry.symbolize_keys)
     end
 
     def whitelist_file

data/lib/as_deprecation_tracker/version.rb

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

data/lib/as_deprecation_tracker/whitelist.rb

@@ -14,14 +14,14 @@ module ASDeprecationTracker
     def add_to_list(*entries)
       entries.flatten.each { |entry| @list << WhitelistEntry.new(entry.symbolize_keys) }
     end
-    alias_method :add, :add_to_list
+    alias add add_to_list
 
     def clear
       @list.clear
     end
 
     def load_file(path)
-      add_to_list(YAML.load(File.read(path)))
+      add_to_list(YAML.safe_load(File.read(path), [Symbol]))
     end
 
     def matches?(deprecation)

data/lib/as_deprecation_tracker/whitelist_entry.rb

@@ -11,6 +11,7 @@ module ASDeprecationTracker
       @callstack = callstack_to_files_lines(Array.wrap(callstack))
       @engine_root = engine.present? ? engine_root(engine) : nil
       @message = message
+      @message_lines = message.lines.map(&:chomp) if message
     end
 
     # rubocop:disable Metrics/CyclomaticComplexity
@@ -25,9 +26,15 @@ module ASDeprecationTracker
     private
 
     def message_matches?(message)
+      message = clean_message(message)
+      return true if message == @message
+      return true if message.lines[0, @message_lines.length].map(&:chomp) == @message_lines
+      false
+    end
+
+    def clean_message(message)
       cleanup_match = MESSAGE_CLEANUP_RE.match(message)
-      message = cleanup_match[1] if cleanup_match
-      message == @message
+      cleanup_match ? cleanup_match[1] : message
     end
 
     def callstack_to_files_lines(callstack)
@@ -38,7 +45,8 @@ module ASDeprecationTracker
     end
 
     def callstack_matches?(callstack)
-      callstack = Rails::BacktraceCleaner.new.clean(callstack, :silent)
+      # Call #to_s to replace Thread::Backtrace::Location instances
+      callstack = Rails::BacktraceCleaner.new.clean(callstack.map(&:to_s), :silent)
       callstack = callstack_to_files_lines(callstack)
 
       @callstack.all? do |whitelist_entry|
@@ -65,7 +73,7 @@ module ASDeprecationTracker
     end
 
     def engine_root_matches?(callstack)
-      callstack.any? { |callstack_entry| callstack_entry.start_with?(@engine_root) }
+      callstack.any? { |callstack_entry| callstack_entry.to_s.start_with?(@engine_root) }
     end
 
     def engine_root(engine_name)

data/lib/as_deprecation_tracker/writer.rb

@@ -8,7 +8,7 @@ module ASDeprecationTracker
     def initialize(filename)
       @filename = filename
       @contents = []
-      @contents = YAML.load(File.read(filename)) || [] if File.exist?(filename)
+      @contents = YAML.safe_load(File.read(filename), [Symbol]) || [] if File.exist?(filename)
     end
 
     def add(message, callstack)
@@ -17,11 +17,13 @@ module ASDeprecationTracker
 
       callstack = Rails::BacktraceCleaner.new.clean(callstack, :silent)
 
-      @contents << { 'message' => message, 'callstack' => callstack.first }
+      entry = { 'message' => message, 'callstack' => callstack.first }
+      @contents << entry
+      entry
     end
 
     def contents
-      @contents.sort_by { |e| e.values_at('message', 'callstack') }.to_yaml
+      @contents.sort_by { |e| e.values_at('message', 'callstack').compact }.to_yaml
     end
 
     def write_file

data/test/receiver_test.rb

@@ -24,15 +24,15 @@ class ReceiverTest < ASDeprecationTracker::TestCase
 
   def test_deprecation_unknown_record
     whitelist = ASDeprecationTracker::Whitelist.new
-    ASDeprecationTracker.expects(:whitelist).returns(whitelist)
+    ASDeprecationTracker.expects(:whitelist).twice.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)
+    whitelist.expects(:add).with(message: 'deprecated call', callstack: stack.first)
+    ASDeprecationTracker::Writer.any_instance.expects(:add).with('deprecated call', stack).returns(message: 'deprecated call', callstack: stack.first)
     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')
+    with_env(AS_DEPRECATION_RECORD: 'true') do
+      ASDeprecationTracker::Receiver.new.deprecation(event(message: 'deprecated call', callstack: stack))
+    end
   end
 
   def test_subscription

data/test/test_helper.rb

@@ -9,5 +9,17 @@ Combustion.path = 'test/internal'
 Combustion.initialize!
 
 module ASDeprecationTracker
-  class TestCase < ::Minitest::Test; end
+  class TestCase < ::Minitest::Test
+    def with_env(new_env)
+      new_env.stringify_keys!
+      backup = ENV.to_h.slice(new_env.keys)
+      begin
+        ENV.update(new_env)
+        yield
+      ensure
+        new_env.keys.each { |k| ENV.delete(k) }
+        ENV.update(backup)
+      end
+    end
+  end
 end

data/test/whitelist_entry_test.rb

@@ -18,6 +18,10 @@ class WhitelistEntryTest < ASDeprecationTracker::TestCase
     assert entry(callstack: nil).matches?(deprecation(callstack: caller))
   end
 
+  def test_matches_partial_message
+    assert entry(callstack: nil, message: "a\nb").matches?(deprecation(message: "a\nb\nc"))
+  end
+
   def test_matches_callstack_only
     assert entry(message: nil).matches?(deprecation)
   end
@@ -86,15 +90,19 @@ class WhitelistEntryTest < ASDeprecationTracker::TestCase
   end
 
   def test_matches_only_engine
-    assert entry(engine: 'example').matches?(deprecation(called_in_engine: 'example'))
+    assert entry(message: nil, callstack: nil, engine: 'example').matches?(deprecation(called_in_engine: 'example'))
+  end
+
+  def test_matches_only_engine_backtrace_location
+    assert entry(message: nil, callstack: nil, engine: 'example').matches?(deprecation(called_in_engine: 'example', callstack: caller_locations))
   end
 
   def test_matches_different_engine
-    refute entry(engine: 'another').matches?(deprecation(called_in_engine: 'example'))
+    refute entry(message: nil, callstack: nil, engine: 'another').matches?(deprecation(called_in_engine: 'example'))
   end
 
   def test_matches_outside_engine
-    refute entry(engine: 'another').matches?(deprecation(called_in_engine: 'example'))
+    refute entry(message: nil, callstack: nil, engine: 'another').matches?(deprecation(called_in_engine: 'example'))
   end
 
   private
@@ -111,11 +119,12 @@ class WhitelistEntryTest < ASDeprecationTracker::TestCase
   end
 
   def deprecation(overrides = {})
-    deprecation = default_deprecation
+    deprecation = default_deprecation.merge(overrides)
     if (engine = overrides.delete(:called_in_engine))
+      deprecation[:callstack] ||= []
       deprecation[:callstack] << "/home/user/engines/#{engine}/app/middleware/foo.rb:12:in `call'"
     end
-    deprecation.merge(overrides).compact
+    deprecation.compact
   end
 
   def entry(overrides = {})

data/test/writer_test.rb

@@ -4,25 +4,26 @@ 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)
+    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)
   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)
+    assert_equal [{ 'message' => 'deprecated call', 'callstack' => 'app/models/a.rb:23' }], YAML.safe_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)
+    assert_equal [{ 'message' => 'deprecated call', 'callstack' => 'app/models/a.rb:23' }], YAML.safe_load(writer.contents)
   end
 
   def test_contents_new_file_is_array
-    assert_equal [], YAML.load(new_writer('').contents)
+    assert_equal [], YAML.safe_load(new_writer('').contents)
   end
 
   def test_contents_sorting
@@ -34,7 +35,17 @@ 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.load(writer.contents)
+    ], YAML.safe_load(writer.contents)
+  end
+
+  def test_contents_sorting_existing_message_without_callstack
+    existing = [{ 'message' => 'deprecated call 1' }]
+    writer = new_writer(existing.to_yaml)
+    writer.add('deprecated call 1', ['app/models/a.rb:23', 'app/models/b.rb:42'])
+    assert_equal [
+      { 'message' => 'deprecated call 1' },
+      { 'message' => 'deprecated call 1', 'callstack' => 'app/models/a.rb:23' }
+    ], YAML.safe_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.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Dominic Cleal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-21 00:00:00.000000000 Z
+date: 2017-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport