deprecation_toolkit 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2aa284de572854194d47e8fb3a0928f6004e657c957fc3818a646f7f87baa2e
-  data.tar.gz: 80c06869204811d135e0ca7933aad4d29d58c297d78c586aef170f35400fe809
+  metadata.gz: 2d2f08916abc502412bc2c68826947592e55e90a5eee9cce948e57145a9e3db4
+  data.tar.gz: d96b9c8941b6f769f2218e6695e7b1d99fcde3b4cb40fac5bace9d6af81706ab
 SHA512:
-  metadata.gz: f6919678301384aee34d895fc914b044af7729261ebeb0c1cf50b50eb3bc2c8cb696225fc24a6a74eccc525394b89d0b3f2e6f250862f58d4c8cc775e88a635f
-  data.tar.gz: ce5328b98b756eb6c19f163e58333cfd1a3f3ed286d34cf5bb9dbdabf97a00f0678b7663e8c7825811ee28b0f51f27eed78da7cf66496d41cda257d93101f23c
+  metadata.gz: 1ba98635a5fcf3b30868ebeb4d7b52256c8444b2ef2681860308be56d506a6849e1c27d98cd2c9b2322490ec25f2416a09eb989be19a0c3bb819511cf491cf84
+  data.tar.gz: 2bda4d027138410c2752fb9217bd2a01bebf3c5f0420d4a0a571f7172ee8965483eebc76257b3d8df50e1f4f09d9c71fc69c1586a26491942970102f8419ec87

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require spec_helper
+

data/.rubocop-https---shopify-github-io-ruby-style-guide-rubocop-yml

@@ -4,6 +4,9 @@ AllCops:
   DisabledByDefault: true
   StyleGuideBaseURL: https://shopify.github.io/ruby-style-guide/
 
+Lint/AssignmentInCondition:
+  Enabled: true
+
 Layout/AccessModifierIndentation:
   EnforcedStyle: indent
   SupportedStyles:
@@ -329,18 +332,6 @@ Style/NumericLiteralPrefix:
 Style/ParenthesesAroundCondition:
   AllowSafeAssignment: true
 
-Style/PercentLiteralDelimiters:
-  PreferredDelimiters:
-    '%': '()'
-    '%i': '()'
-    '%q': '()'
-    '%Q': '()'
-    '%r': '{}'
-    '%s': '()'
-    '%w': '()'
-    '%W': '()'
-    '%x': '()'
-
 Style/PercentQLiterals:
   EnforcedStyle: lower_case_q
   SupportedStyles:
@@ -516,14 +507,6 @@ Naming/VariableName:
 Style/WhileUntilModifier:
   Enabled: true
 
-Style/WordArray:
-  EnforcedStyle: percent
-  SupportedStyles:
-  - percent
-  - brackets
-  MinSize: 0
-  WordRegex: !ruby/regexp /\A[\p{Word}\n\t]+\z/
-
 Metrics/BlockNesting:
   Max: 3
 
@@ -754,7 +737,7 @@ Style/EvenOdd:
 Layout/InitialIndentation:
   Enabled: true
 
-Style/FlipFlop:
+Lint/FlipFlop:
   Enabled: true
 
 Style/IfInsideElse:
@@ -787,9 +770,6 @@ Style/MethodMissingSuper:
 Style/MissingRespondToMissing:
   Enabled: true
 
-Style/MultilineBlockChain:
-  Enabled: true
-
 Layout/MultilineBlockLayout:
   Enabled: true
 
@@ -856,12 +836,18 @@ Style/RedundantParentheses:
 Style/RedundantSelf:
   Enabled: true
 
+Style/RedundantSortBy:
+  Enabled: true
+
 Layout/RescueEnsureAlignment:
   Enabled: true
 
 Style/RescueModifier:
   Enabled: true
 
+Style/Sample:
+  Enabled: true
+
 Style/SelfAssignment:
   Enabled: true
 
@@ -1107,30 +1093,18 @@ Performance/FixedSize:
 Performance/FlatMap:
   EnabledForFlattenWithoutParams: false
 
-Performance/LstripRstrip:
-  Enabled: true
-
 Performance/RangeInclude:
   Enabled: true
 
-Performance/RedundantBlockCall:
-  Enabled: true
-
 Performance/RedundantMatch:
   Enabled: true
 
-Performance/RedundantSortBy:
-  Enabled: true
-
 Performance/RegexpMatch:
   Enabled: true
 
 Performance/ReverseEach:
   Enabled: true
 
-Performance/Sample:
-  Enabled: true
-
 Performance/Size:
   Enabled: true
 
@@ -1143,6 +1117,9 @@ Performance/StartWith:
 Performance/StringReplacement:
   Enabled: true
 
+Rails/ApplicationRecord:
+  Enabled: true
+
 Rails/DelegateAllowBlank:
   Enabled: true
 
@@ -1172,6 +1149,9 @@ Security/Open:
 Lint/BigDecimalNew:
   Enabled: true
 
+Style/Strip:
+  Enabled: true
+
 Style/TrailingBodyOnClass:
   Enabled: true
 

data/.travis.yml

@@ -15,5 +15,6 @@ gemfile:
 script:
   - bundle exec rubocop --config .rubocop.yml
   - bundle exec rake test
+  - bundle exec rspec
 notifications:
   email: false

data/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## master (unreleased)
 
+## 1.4.0 (2019-04-29)
+* [#37](https://github.com/Shopify/deprecation_toolkit/pull/37): Add Rspec support. (@andrewmarkle)
+
 ## 1.3.0 (2019-02-28)
 * [#38](https://github.com/Shopify/deprecation_toolkit/pull/38): Add a way to mark test as flaky. (@Edouard-chin)
 * [#39](https://github.com/Shopify/deprecation_toolkit/pull/39): Introduced a way to help recording massive amount of deprecations. (@Edouard-chin)

data/Gemfile.lock

@@ -1,43 +1,56 @@
 PATH
   remote: .
   specs:
-    deprecation_toolkit (1.3.0)
+    deprecation_toolkit (1.4.0)
       activesupport (>= 4.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.2)
+    activesupport (5.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     ast (2.4.0)
-    concurrent-ruby (1.1.4)
-    i18n (1.5.3)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (1.6.0)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.1)
+    jaro_winkler (1.5.2)
     minitest (5.11.3)
-    parallel (1.12.1)
-    parser (2.5.1.0)
+    parallel (1.17.0)
+    parser (2.6.3.0)
       ast (~> 2.4.0)
-    powerpack (0.1.2)
-    rainbow (2.2.2)
-      rake
-    rake (10.5.0)
-    rubocop (0.58.0)
+    psych (3.1.0)
+    rainbow (3.0.0)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.67.2)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5)
-      powerpack (~> 0.1)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.10.0)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    unicode-display_width (1.4.0)
+    unicode-display_width (1.5.0)
 
 PLATFORMS
   ruby
@@ -47,6 +60,7 @@ DEPENDENCIES
   deprecation_toolkit!
   minitest (~> 5.0)
   rake
+  rspec (~> 3.0)
   rubocop
 
 BUNDLED WITH

data/README.md

@@ -114,6 +114,27 @@ a message in the console.
 Deprecation Toolkit allows you to configure which warnings should be treated as deprecations in order for you
 to keep track of them as if they were regular deprecations.
 
+
+## RSpec
+
+By default Deprecation Toolkit uses Minitest as its test runner. To use Deprecation Toolkit with RSpec you'll have to configure it.
+
+```ruby
+DeprecationToolkit::Configuration.test_runner = :rspec
+```
+
+Also make sure to require the before/after hooks in your `spec_helper.rb` or `rails_helper.rb`.
+
+```ruby
+require "deprecation_toolkit/rspec"
+```
+
+It's possible to record deprecations while running your specs by adding an ENV['DEPRECATION_BEHAVIOR'] variable to your test run. Run your specs with this ENV set to `"record-deprecations"`, `"record"` (or simply the `"r"` shortcut).
+
+```sh
+DEPRECATION_BEHAVIOR="record" bundle exec rspec path/to/file_spec.rb
+```
+
 ## License
 
 Deprecation Toolkit is licensed under the [MIT license](LICENSE.txt).

data/deprecation_toolkit.gemspec

@@ -30,4 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency("bundler", ">= 1.16")
   spec.add_development_dependency("rake", "~> 10.0")
   spec.add_development_dependency("minitest", "~> 5.0")
+  spec.add_development_dependency("rspec", "~> 3.0")
 end

data/gemfiles/spec/deprecations/deprecation_toolkit/behaviors/raise.yml

@@ -0,0 +1,12 @@
+---
+test_deprecation_toolkit/behaviors/raise_.trigger_raises_a_deprecation_removed_error_when_deprecations_are_removed:
+- 'DEPRECATION WARNING: Foo'
+- 'DEPRECATION WARNING: Bar'
+test_deprecation_toolkit/behaviors/raise_.trigger_raises_a_deprecation_removed_when_mismatched_and_less_than_expected:
+- 'DEPRECATION WARNING: A'
+- 'DEPRECATION WARNING: B'
+test_deprecation_toolkit/behaviors/raise_.trigger_raises_a_deprecation_mismatch_when_same_number_of_deprecations_are_triggered_with_mismatches:
+- 'DEPRECATION WARNING: C'
+test_deprecation_toolkit/behaviors/raise_.trigger_does_not_raise_when_deprecations_are_triggered_but_were_already_recorded:
+- 'DEPRECATION WARNING: Foo'
+- 'DEPRECATION WARNING: Bar'

data/lib/deprecation_toolkit.rb

@@ -7,6 +7,7 @@ module DeprecationToolkit
   autoload :Configuration,             "deprecation_toolkit/configuration"
   autoload :Collector,                 "deprecation_toolkit/collector"
   autoload :ReadWriteHelper,           "deprecation_toolkit/read_write_helper"
+  autoload :TestTriggerer,             "deprecation_toolkit/test_triggerer"
 
   module Behaviors
     autoload :Disabled,                "deprecation_toolkit/behaviors/disabled"
@@ -33,5 +34,8 @@ module DeprecationToolkit
   end
 end
 
-require "deprecation_toolkit/minitest_hook"
+unless defined?(RSpec)
+  require "deprecation_toolkit/minitest_hook"
+end
+
 require "deprecation_toolkit/warning"

data/lib/deprecation_toolkit/behaviors/ci_record_helper.rb

@@ -14,7 +14,7 @@ module DeprecationToolkit
 
         to_output = {
           filename.to_s => {
-            test.name => current_deprecations.deprecations_without_stacktrace,
+            test_name(test) => current_deprecations.deprecations_without_stacktrace,
           },
         }
 

data/lib/deprecation_toolkit/behaviors/raise.rb

@@ -21,10 +21,16 @@ module DeprecationToolkit
     class DeprecationIntroduced < DeprecationException
       def initialize(current_deprecations, recorded_deprecations)
         introduced_deprecations = current_deprecations - recorded_deprecations
+        record_message =
+          if DeprecationToolkit::Configuration.test_runner == :rspec
+            "You can record deprecations by adding the `DEPRECATION_BEHAVIOR='record'` ENV when running your specs."
+          else
+            "You can record deprecations by adding the `--record-deprecations` flag when running your tests."
+          end
 
         message = <<~EOM
           You have introduced new deprecations in the codebase. Fix or record them in order to discard this error.
-          You can record deprecations by adding the `--record-deprecations` flag when running your tests.
+          #{record_message}
 
           #{introduced_deprecations.join("\n")}
         EOM
@@ -37,10 +43,17 @@ module DeprecationToolkit
       def initialize(current_deprecations, recorded_deprecations)
         removed_deprecations = recorded_deprecations - current_deprecations
 
+        record_message =
+          if DeprecationToolkit::Configuration.test_runner == :rspec
+            "You can re-record deprecations by setting the `DEPRECATION_BEHAVIOR='record'` ENV when running your specs."
+          else
+            "You can re-record deprecations by adding the `--record-deprecations` flag when running your tests."
+          end
+
         message = <<~EOM
           You have removed deprecations from the codebase. Thanks for being an awesome person.
           The recorded deprecations needs to be updated to reflect your changes.
-          You can re-record deprecations by adding the `--record-deprecations` flag when running your tests.
+          #{record_message}
 
           #{removed_deprecations.join("\n")}
         EOM
@@ -51,11 +64,17 @@ module DeprecationToolkit
 
     class DeprecationMismatch < DeprecationException
       def initialize(current_deprecations, recorded_deprecations)
+        record_message =
+          if DeprecationToolkit::Configuration.test_runner == :rspec
+            "You can re-record deprecations by adding the `DEPRECATION_BEHAVIOR='record'` ENV when running your specs."
+          else
+            "You can re-record deprecations by adding the `--record-deprecations` flag when running your tests."
+          end
         message = <<~EOM
           The recorded deprecations for this test doesn't match the one that got triggered.
           Fix or record the new deprecations to discard this error.
 
-          You can re-record deprecations by adding the `--record-deprecations` flag when running your tests.
+          #{record_message}
 
           ===== Expected
           #{recorded_deprecations.deprecations.join("\n")}

data/lib/deprecation_toolkit/behaviors/record.rb

@@ -8,7 +8,7 @@ module DeprecationToolkit
       def self.trigger(test, collector, _)
         deprecation_file = recorded_deprecations_path(test)
 
-        write(deprecation_file, test.name => collector.deprecations_without_stacktrace)
+        write(deprecation_file, test_name(test) => collector.deprecations_without_stacktrace)
       end
     end
   end

data/lib/deprecation_toolkit/configuration.rb

@@ -6,10 +6,11 @@ module DeprecationToolkit
   class Configuration
     include ActiveSupport::Configurable
 
-    config_accessor(:behavior) { Behaviors::Raise }
     config_accessor(:allowed_deprecations) { [] }
-    config_accessor(:deprecation_path) { "test/deprecations" }
     config_accessor(:attach_to) { [:rails] }
+    config_accessor(:behavior) { Behaviors::Raise }
+    config_accessor(:deprecation_path) { "test/deprecations" }
+    config_accessor(:test_runner) { :minitest }
     config_accessor(:warnings_treated_as_deprecation) { [] }
   end
 end

data/lib/deprecation_toolkit/minitest_hook.rb

@@ -5,13 +5,7 @@ require "minitest"
 module DeprecationToolkit
   module Minitest
     def trigger_deprecation_toolkit_behavior
-      current_deprecations = Collector.new(Collector.deprecations)
-      recorded_deprecations = Collector.load(self)
-      if !recorded_deprecations.flaky? && current_deprecations != recorded_deprecations
-        Configuration.behavior.trigger(self, current_deprecations, recorded_deprecations)
-      end
-    ensure
-      Collector.reset!
+      DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(self)
     end
   end
 end

data/lib/deprecation_toolkit/read_write_helper.rb

@@ -8,7 +8,7 @@ module DeprecationToolkit
   module ReadWriteHelper
     def read(test)
       deprecation_file = Bundler.root.join(recorded_deprecations_path(test))
-      YAML.load(deprecation_file.read).fetch(test.name, [])
+      YAML.load(deprecation_file.read).fetch(test_name(test), [])
     rescue Errno::ENOENT
       []
     end
@@ -17,11 +17,12 @@ module DeprecationToolkit
       create_deprecation_file(deprecation_file) unless deprecation_file.exist?
 
       content = YAML.load_file(deprecation_file)
-      deprecations_to_record.each do |test_name, deprecations|
+
+      deprecations_to_record.each do |test, deprecations|
         if deprecations.any?
-          content[test_name] = deprecations
+          content[test] = deprecations
         else
-          content.delete(test_name)
+          content.delete(test)
         end
       end
 
@@ -46,13 +47,28 @@ module DeprecationToolkit
         Configuration.deprecation_path
       end
 
-      Pathname(deprecation_folder).join("#{test.class.name.underscore}.yml")
+      path =
+        if DeprecationToolkit::Configuration.test_runner == :rspec
+          test.example_group.file_path.sub(%r{^./spec/}, "").sub(/_spec.rb$/, "")
+        else
+          test.class.name.underscore
+        end
+
+      Pathname(deprecation_folder).join("#{path}.yml")
     end
 
     def test_location(test)
-      test.method(test.name).source_location[0]
+      test.method(test_name(test)).source_location[0]
     rescue NameError
       "unknown"
     end
+
+    def test_name(test)
+      if DeprecationToolkit::Configuration.test_runner == :rspec
+        "test_" + test.full_description.underscore.squish.tr(" ", "_")
+      else
+        test.name
+      end
+    end
   end
 end

data/lib/deprecation_toolkit/rspec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "deprecation_toolkit/rspec_plugin"
+
+RSpec.configure do |config|
+  config.after do |example|
+    DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(example)
+  end
+end

data/lib/deprecation_toolkit/rspec_plugin.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module DeprecationToolkit
+  module RSpecPlugin
+    RSpec.configure do |config|
+      config.before(:suite) do
+        case ENV['DEPRECATION_BEHAVIOR']
+        when "r", "record", "record-deprecations"
+          DeprecationToolkit::Configuration.behavior = DeprecationToolkit::Behaviors::Record
+        end
+
+        DeprecationToolkit.add_notify_behavior
+        DeprecationToolkit.attach_subscriber
+      end
+    end
+  end
+end

data/lib/deprecation_toolkit/test_triggerer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module DeprecationToolkit
+  module TestTriggerer
+    def self.trigger_deprecation_toolkit_behavior(test)
+      current_deprecations = DeprecationToolkit::Collector.new(DeprecationToolkit::Collector.deprecations)
+      recorded_deprecations = DeprecationToolkit::Collector.load(test)
+      if !recorded_deprecations.flaky? && current_deprecations != recorded_deprecations
+        DeprecationToolkit::Configuration.behavior.trigger(
+          test, current_deprecations, recorded_deprecations
+        )
+      end
+    ensure
+      DeprecationToolkit::Collector.reset!
+    end
+  end
+end

data/lib/deprecation_toolkit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeprecationToolkit
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

data/spec/deprecation_toolkit/behaviors/disabled_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe(DeprecationToolkit::Behaviors::Raise) do
+  before do
+    @previous_configuration = DeprecationToolkit::Configuration.behavior
+    DeprecationToolkit::Configuration.behavior = DeprecationToolkit::Behaviors::Disabled
+  end
+
+  after do
+    DeprecationToolkit::Configuration.behavior = @previous_configuration
+  end
+
+  it '.trigger noop any deprecations' do |example|
+    expect do
+      ActiveSupport::Deprecation.warn("Foo")
+      ActiveSupport::Deprecation.warn("Bar")
+
+      DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(example)
+    end.not_to(raise_error)
+  end
+end

data/spec/deprecation_toolkit/behaviors/raise_spec.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe(DeprecationToolkit::Behaviors::Raise) do
+  before do
+    @previous_configuration = DeprecationToolkit::Configuration.behavior
+    DeprecationToolkit::Configuration.behavior = DeprecationToolkit::Behaviors::Raise
+  end
+
+  after do
+    DeprecationToolkit::Configuration.behavior = @previous_configuration
+  end
+
+  it ".trigger raises an DeprecationIntroduced error when deprecations are introduced" do |example|
+    expect do
+      ActiveSupport::Deprecation.warn("Foo")
+      ActiveSupport::Deprecation.warn("Bar")
+
+      DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(example)
+    end.to(raise_error(DeprecationToolkit::Behaviors::DeprecationIntroduced))
+  end
+
+  it ".trigger raises a DeprecationRemoved error when deprecations are removed" do |example|
+    expect do
+      ActiveSupport::Deprecation.warn("Foo")
+
+      DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(example)
+    end.to(raise_error(DeprecationToolkit::Behaviors::DeprecationRemoved))
+  end
+
+  it '.trigger raises a DeprecationRemoved when mismatched and less than expected' do |example|
+    expect do
+      ActiveSupport::Deprecation.warn("C")
+
+      DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(example)
+    end.to(raise_error(DeprecationToolkit::Behaviors::DeprecationRemoved))
+  end
+
+  it '.trigger raises a DeprecationMismatch when same number of deprecations are triggered with mismatches' do |example|
+    expect do
+      ActiveSupport::Deprecation.warn("A")
+
+      DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(example)
+    end.to(raise_error(DeprecationToolkit::Behaviors::DeprecationMismatch))
+  end
+
+  it ".trigger does not raise when deprecations are triggered but were already recorded" do |example|
+    expect do
+      ActiveSupport::Deprecation.warn("Foo")
+      ActiveSupport::Deprecation.warn("Bar")
+
+      DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(example)
+    end.not_to(raise_error)
+  end
+
+  it ".trigger does not raise when deprecations are allowed with Regex" do |example|
+    @old_allowed_deprecations = DeprecationToolkit::Configuration.allowed_deprecations
+    DeprecationToolkit::Configuration.allowed_deprecations = [/John Doe/]
+
+    begin
+      ActiveSupport::Deprecation.warn("John Doe")
+      expect do
+        DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(example)
+      end.not_to(raise_error)
+    ensure
+      DeprecationToolkit::Configuration.allowed_deprecations = @old_allowed_deprecations
+    end
+  end
+
+  it ".trigger does not raise when deprecations are allowed with Procs" do |example|
+    class_eval <<-RUBY, 'my_file.rb', 1337
+      def deprecation_caller
+        deprecation_callee
+      end
+
+      def deprecation_callee
+        ActiveSupport::Deprecation.warn("John Doe")
+      end
+    RUBY
+
+    old_allowed_deprecations = DeprecationToolkit::Configuration.allowed_deprecations
+    DeprecationToolkit::Configuration.allowed_deprecations = [
+      ->(_, stack) { stack.first.to_s =~ /my_file\.rb/ },
+    ]
+
+    begin
+      deprecation_caller
+      expect do
+        DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(example)
+      end.not_to(raise_error)
+    ensure
+      DeprecationToolkit::Configuration.allowed_deprecations = old_allowed_deprecations
+    end
+  end
+end

data/spec/deprecation_toolkit/behaviors/record_spec.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "tmpdir"
+
+RSpec.describe(DeprecationToolkit::Behaviors::Record) do
+  before do
+    @previous_deprecation_path = DeprecationToolkit::Configuration.deprecation_path
+    @deprecation_path = Dir.mktmpdir
+    @previous_behavior = DeprecationToolkit::Configuration.behavior
+    DeprecationToolkit::Configuration.behavior = DeprecationToolkit::Behaviors::Record
+    DeprecationToolkit::Configuration.deprecation_path = @deprecation_path
+  end
+
+  after do
+    DeprecationToolkit::Configuration.behavior = @previous_behavior
+    DeprecationToolkit::Configuration.deprecation_path = @previous_deprecation_path
+    FileUtils.rm_rf(@deprecation_path)
+  end
+
+  it '.trigger should record deprecations' do |example|
+    expect_deprecations_recorded("Foo", "Bar", example) do
+      ActiveSupport::Deprecation.warn("Foo")
+      ActiveSupport::Deprecation.warn("Bar")
+
+      DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(example)
+    end
+  end
+
+  it ".trigger re-record an existing deprecation file" do |example|
+    expect_deprecations_recorded("Foo", "Bar", example) do
+      ActiveSupport::Deprecation.warn("Foo")
+      ActiveSupport::Deprecation.warn("Bar")
+
+      DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(example)
+    end
+
+    expect_deprecations_recorded("Foo", example) do
+      ActiveSupport::Deprecation.warn("Foo")
+
+      DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(example)
+    end
+  end
+
+  it ".trigger removes the deprecation file when all deprecations were removed" do |example|
+    expect_deprecations_recorded("Foo", example) do
+      ActiveSupport::Deprecation.warn("Foo")
+
+      DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(example)
+    end
+
+    expect do
+      expect_deprecations_recorded("Foo", example) do
+        DeprecationToolkit::TestTriggerer.trigger_deprecation_toolkit_behavior(example)
+      end
+    end.to(raise_error(Errno::ENOENT))
+  end
+
+  private
+
+  def expect_deprecations_recorded(*deprecation_triggered, example)
+    yield
+
+    recorded = YAML.load_file(
+      "#{@deprecation_path}/deprecation_toolkit/behaviors/record.yml"
+    ).fetch("test_" + example.full_description.underscore.squish.tr(" ", "_"))
+    triggered = deprecation_triggered.map { |msg| "DEPRECATION WARNING: #{msg}" }
+
+    expect(recorded).to(eq(triggered))
+  end
+end

data/spec/deprecations/deprecation_toolkit/behaviors/raise.yml

@@ -0,0 +1,12 @@
+---
+test_deprecation_toolkit/behaviors/raise_.trigger_raises_a_deprecation_removed_error_when_deprecations_are_removed:
+- 'DEPRECATION WARNING: Foo'
+- 'DEPRECATION WARNING: Bar'
+test_deprecation_toolkit/behaviors/raise_.trigger_raises_a_deprecation_removed_when_mismatched_and_less_than_expected:
+- 'DEPRECATION WARNING: A'
+- 'DEPRECATION WARNING: B'
+test_deprecation_toolkit/behaviors/raise_.trigger_raises_a_deprecation_mismatch_when_same_number_of_deprecations_are_triggered_with_mismatches:
+- 'DEPRECATION WARNING: C'
+test_deprecation_toolkit/behaviors/raise_.trigger_does_not_raise_when_deprecations_are_triggered_but_were_already_recorded:
+- 'DEPRECATION WARNING: Foo'
+- 'DEPRECATION WARNING: Bar'

data/spec/rspec/plugin_env_options_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# This needs to be set before we require `spec_helper` to simulate setting an ENV when running a spec like:
+# `DEPRECATION_BEHAVIOR="record" bundle exec rspec path/to/spec.rb`
+ENV['DEPRECATION_BEHAVIOR'] = "record"
+
+require 'spec_helper'
+
+RSpec.describe("DeprecationToolkit::RSpecPlugin ENV options") do
+  it 'should set the behavior to `Record` when ENV variable is set' do
+    expect(DeprecationToolkit::Configuration.behavior).to(eq(DeprecationToolkit::Behaviors::Record))
+  end
+end

data/spec/rspec/plugin_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe(DeprecationToolkit::RSpecPlugin) do
+  it "should add `notify` behavior to the deprecations behavior list" do
+    behavior = ActiveSupport::Deprecation::DEFAULT_BEHAVIORS[:notify]
+
+    expect(ActiveSupport::Deprecation.behavior).to(include(behavior))
+  end
+
+  it "doesn't remove previous deprecation behaviors" do
+    behavior = ActiveSupport::Deprecation::DEFAULT_BEHAVIORS[:silence]
+    ActiveSupport::Deprecation.behavior = behavior
+
+    expect(ActiveSupport::Deprecation.behavior).to(include(behavior))
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path("../lib", __dir__))
+require "deprecation_toolkit"
+require "deprecation_toolkit/rspec_plugin"
+require "active_support/all"
+
+DeprecationToolkit::Configuration.test_runner = :rspec
+DeprecationToolkit::Configuration.deprecation_path = "spec/deprecations"
+ActiveSupport::Deprecation.behavior = :silence
+
+RSpec.configure do |config|
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with(:rspec) do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deprecation_toolkit
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-28 00:00:00.000000000 Z
+date: 2019-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: 
 email:
 - rails@shopify.com
@@ -74,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".rubocop-https---shopify-github-io-ruby-style-guide-rubocop-yml"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -88,6 +103,7 @@ files:
 - gemfiles/activesupport_5.0.gemfile
 - gemfiles/activesupport_5.1.gemfile
 - gemfiles/activesupport_5.2.gemfile
+- gemfiles/spec/deprecations/deprecation_toolkit/behaviors/raise.yml
 - gemfiles/test/deprecations
 - lib/deprecation_toolkit.rb
 - lib/deprecation_toolkit/behaviors/ci_record_helper.rb
@@ -99,11 +115,21 @@ files:
 - lib/deprecation_toolkit/deprecation_subscriber.rb
 - lib/deprecation_toolkit/minitest_hook.rb
 - lib/deprecation_toolkit/read_write_helper.rb
+- lib/deprecation_toolkit/rspec.rb
+- lib/deprecation_toolkit/rspec_plugin.rb
+- lib/deprecation_toolkit/test_triggerer.rb
 - lib/deprecation_toolkit/version.rb
 - lib/deprecation_toolkit/warning.rb
 - lib/minitest/deprecation_toolkit_plugin.rb
 - lib/tasks/ci_recorder.rake
 - shipit.rubygems.yml
+- spec/deprecation_toolkit/behaviors/disabled_spec.rb
+- spec/deprecation_toolkit/behaviors/raise_spec.rb
+- spec/deprecation_toolkit/behaviors/record_spec.rb
+- spec/deprecations/deprecation_toolkit/behaviors/raise.yml
+- spec/rspec/plugin_env_options_spec.rb
+- spec/rspec/plugin_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/shopify/deprecation_toolkit
 licenses:
 - MIT