as_deprecation_tracker 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f7afb9114abb2b1eb8342ce87fad1e76f398261
-  data.tar.gz: ed0827eecdeb1d66f8db27dc8ac733e789bc80d8
+  metadata.gz: 423aa104af4ca208621d8c1e8eee3c3fb1c1ed4f
+  data.tar.gz: 841eec03f2e5fec185ff747b9413978d58d44e3f
 SHA512:
-  metadata.gz: 14c349e5c726f6ba9fc390bc43f86f274623174997522791e082cdda207583d46083058c8def4ea096c0aaa3725c1ec3c15b9848d5c5826c93933d3ee54a22f4
-  data.tar.gz: 0c0aba7080bc8074e1df57a37f9130cf1f2be22ccc2a2d3a1626ae1c5a78ef47e2875f7cae6469342af9abcba5507a5c67d8c719dd41570848763ccafa0db0ca
+  metadata.gz: c135f7983f1fda478172f436ef533aa135ae2dabcceaaca184f851614180ebcd1ffc1545d1cbc02d1fabd9ea466351185aa0c54ac0617299308d1b356b954ae7
+  data.tar.gz: c6fda97efae671f2e1875905bd694903023322e12441677520405698330b3b7970b7be9ea892399ad8b97f39c8ae169f82433e31260ca19bf84e9c6484804fdc

data/CHANGELOG.md

@@ -0,0 +1,66 @@
+# 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.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/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

data/lib/as_deprecation_tracker.rb

@@ -15,7 +15,7 @@ module ASDeprecationTracker
   end
 
   def self.pause!
-    @running = false
+    @paused = true
   end
 
   def self.receiver
@@ -23,15 +23,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["ASDT_#{name}"])
+  end
 end

data/lib/as_deprecation_tracker/configuration.rb

@@ -8,7 +8,7 @@ module ASDeprecationTracker
     def initialize
       @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/receiver.rb

@@ -24,7 +24,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 +41,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,4 @@
 # frozen_string_literal: true
 module ASDeprecationTracker
-  VERSION = '1.4.1'.freeze
+  VERSION = '1.5.0'.freeze
 end

data/test/as_deprecation_tracker_test.rb

@@ -21,6 +21,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 +61,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

@@ -2,45 +2,52 @@
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: as_deprecation_tracker
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Dominic Cleal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-27 00:00:00.000000000 Z
+date: 2017-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -45,6 +45,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
 - Rakefile