as_deprecation_tracker 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 319c016e3c0d157afe5bf366597bbe08c3f7b8a1
-  data.tar.gz: c497cffa7fb8a20754ec0bcf0c041735f1a7e8b6
+  metadata.gz: 2d01e6823baf38e699a6de7c4d27391d9f8f6a00
+  data.tar.gz: f95996a72dd62db5cd33f8cc8a9f0ee5e7686454
 SHA512:
-  metadata.gz: ac1bba14823514e09b4b5421d3fca0a265b0b26edb9fddfcd72eb2994bc148ef7107f1f7058fcbe771bb2d21ae9eb22c43591a0876085645d672d021a5fd34c6
-  data.tar.gz: 0c807d54d2e662c98a7988ae5e9df30fa262cbebbe54788d4401d67281a5b8a9f52b51d9b52abc7d5dac5c4cd9943727b98f6482be071381f1eace9da4ec0380
+  metadata.gz: 7b649d6be7f3273fe8400ff28dc6162402b4cc744b47136b355b5648e9a1a27494f2d21c2d7e4c92b0aec10c7009b94882ce21e8cffc522ee8e2eb4f06b7d386
+  data.tar.gz: 80fdb221aa9b693793740b511190a090a895881dec79d0b78ebd1d8c70ce9b18f80aaf49ef0a97a7ecc3135a4a8d82043799f4cd7f106562e23f9b05fa77fe71

data/README.md

@@ -119,6 +119,16 @@ Supported options:
 * `whitelist_file` to customise the location of the whitelist YAML file
   (defaults to `config/as_deprecation_whitelist.yaml`)
 
+### Pause/resume
+
+The processing of deprecation warnings can be suspended and resumed via the
+`ASDeprecationTracker.pause!` and `ASDeprecationTracker.resume!` methods.
+
+This is useful when programmatically building whitelist entries during Rails
+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.
+
 ## License
 
 Copyright (c) 2016-2017 Dominic Cleal.  Distributed under the MIT license.

data/lib/as_deprecation_tracker.rb

@@ -14,6 +14,23 @@ module ASDeprecationTracker
     @config ||= Configuration.new
   end
 
+  def self.pause!
+    @running = false
+  end
+
+  def self.receiver
+    @receiver ||= Receiver.new
+  end
+
+  def self.resume!
+    @running = true
+    @receiver.try!(:process_queue)
+  end
+
+  def self.running?
+    @running.nil? || @running
+  end
+
   def self.whitelist
     @whitelist ||= Whitelist.new
   end

data/lib/as_deprecation_tracker/railtie.rb

@@ -5,7 +5,7 @@ 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
+      Receiver.attach_to :rails, ASDeprecationTracker.receiver
       ActiveSupport::Deprecation.behavior = :notify if ASDeprecationTracker.config.register_behavior?
 
       whitelist = ASDeprecationTracker.config.whitelist_file

data/lib/as_deprecation_tracker/receiver.rb

@@ -5,7 +5,21 @@ require 'as_deprecation_tracker/writer'
 module ASDeprecationTracker
   # Receives deprecation.rails events via ActiveSupport::Notifications
   class Receiver < ::ActiveSupport::Subscriber
+    def initialize
+      super
+      @event_queue = []
+    end
+
     def deprecation(event)
+      @event_queue << event
+      process_queue if ASDeprecationTracker.running?
+    end
+
+    def process_queue
+      process_event(@event_queue.pop) until @event_queue.empty?
+    end
+
+    def process_event(event)
       return if ASDeprecationTracker.whitelist.matches?(event.payload)
 
       message = event.payload[:message]

data/lib/as_deprecation_tracker/version.rb

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

data/lib/as_deprecation_tracker/whitelist_entry.rb

@@ -75,7 +75,7 @@ module ASDeprecationTracker
     def engine_root(engine_name)
       ::Rails::Engine.descendants.each do |engine|
         begin
-          return engine.root.to_s if engine_name == engine.engine_name
+          return engine.root.to_s if engine_name.to_s == engine.engine_name.to_s
         rescue NoMethodError, RuntimeError # rubocop:disable Lint/HandleExceptions
           # Ignore failures with singleton engine subclasses etc.
         end

data/test/as_deprecation_tracker_test.rb

@@ -21,6 +21,34 @@ class ASDeprecationTrackerTest < ASDeprecationTracker::TestCase
     assert_equal config, ASDeprecationTracker.config
   end
 
+  def test_pause!
+    ASDeprecationTracker.pause!
+    refute ASDeprecationTracker.running?
+  ensure
+    ASDeprecationTracker.resume!
+  end
+
+  def test_receiver
+    assert_kind_of ASDeprecationTracker::Receiver, ASDeprecationTracker.receiver
+    assert_kind_of ActiveSupport::Subscriber, ASDeprecationTracker.receiver
+  end
+
+  def test_receiver_returns_same_receiver
+    receiver = ASDeprecationTracker.receiver
+    assert_equal receiver, ASDeprecationTracker.receiver
+  end
+
+  def test_resume!
+    ASDeprecationTracker.pause!
+    ASDeprecationTracker.receiver.expects(:process_queue)
+    ASDeprecationTracker.resume!
+    assert ASDeprecationTracker.running?
+  end
+
+  def test_running
+    assert_equal true, ASDeprecationTracker.running?
+  end
+
   def test_whitelist
     assert_kind_of ASDeprecationTracker::Whitelist, ASDeprecationTracker.whitelist
   end

data/test/receiver_test.rb

@@ -2,27 +2,43 @@
 require 'test_helper'
 
 class ReceiverTest < ASDeprecationTracker::TestCase
-  def test_deprecation_whitelisted
+  def test_deprecation_when_running
+    ASDeprecationTracker.expects(:running?).returns(true)
+    receiver = ASDeprecationTracker::Receiver.new
+    event = mock('event')
+    receiver.expects(:process_event).with(event)
+    receiver.deprecation(event)
+  end
+
+  def test_deprecation_when_not_running
+    ASDeprecationTracker.expects(:running?).returns(false)
+    receiver = ASDeprecationTracker::Receiver.new
+    event = mock('event')
+    receiver.expects(:process_event).never
+    receiver.deprecation(event)
+  end
+
+  def test_process_event_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))
+    ASDeprecationTracker::Receiver.new.process_event(event(message: 'deprecated call', callstack: stack))
   end
 
-  def test_deprecation_unknown
+  def test_process_event_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))
+      ASDeprecationTracker::Receiver.new.process_event(event(message: 'deprecated call', callstack: stack))
     end
     assert_equal 'deprecated call', e.message
     assert_equal stack, e.backtrace
   end
 
-  def test_deprecation_unknown_record
+  def test_process_event_unknown_record
     whitelist = ASDeprecationTracker::Whitelist.new
     ASDeprecationTracker.expects(:whitelist).twice.returns(whitelist)
     stack = caller
@@ -31,10 +47,19 @@ class ReceiverTest < ASDeprecationTracker::TestCase
     ASDeprecationTracker::Writer.any_instance.expects(:add).with('deprecated call', stack).returns(message: 'deprecated call', callstack: stack.first)
     ASDeprecationTracker::Writer.any_instance.expects(:write_file)
     with_env(AS_DEPRECATION_RECORD: 'true') do
-      ASDeprecationTracker::Receiver.new.deprecation(event(message: 'deprecated call', callstack: stack))
+      ASDeprecationTracker::Receiver.new.process_event(event(message: 'deprecated call', callstack: stack))
     end
   end
 
+  def test_process_queue
+    ASDeprecationTracker.expects(:running?).returns(false)
+    receiver = ASDeprecationTracker::Receiver.new
+    event = mock('event')
+    receiver.deprecation(event)
+    receiver.expects(:process_event).with(event)
+    receiver.process_queue
+  end
+
   def test_subscription
     ASDeprecationTracker::Receiver.any_instance.expects(:deprecation)
     ActiveSupport::Notifications.instrument('deprecation.rails', message: 'test')

metadata

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