Merge pull request #923 from samphippen/remove-backtrace-clean-patterns

Remove #backtrace_clean_patterns.

Author: Sam Phippen

features/configuration/backtrace_clean_patterns.feature renamed to features/configuration/backtrace_exclusion_patterns.feature

@@ -1,6 +1,7 @@
-Feature: Backtrace cleaning
+Feature: Excluding lines from the backtrace
 
-  To aid in diagnozing spec failures, RSpec cleans matching lines from backtraces. The default patterns cleaned are:
+  To reduce the noise when diagnosing , RSpec excludes matching lines from
+  backtraces. The default exclusion patterns are:
 
     /\/lib\d*\/ruby\//,
     /org\/jruby\//,
@@ -9,9 +10,11 @@ Feature: Backtrace cleaning
     /spec\/spec_helper\.rb/,
     /lib\/rspec\/(core|expectations|matchers|mocks)/
 
-  This list can be modified or replaced with the `backtrace_clean_patterns` option. Additionally, rspec can be run with the `--backtrace` option to skip backtrace cleaning entirely.
+  This list can be modified or replaced with the `backtrace_exclusion_patterns`
+  option. Additionally, rspec can be run with the `--backtrace` option to skip
+  backtrace cleaning entirely.
 
-  Scenario: default configuration
+  Scenario: using default backtrace_exclusion_patterns
     Given a file named "spec/failing_spec.rb" with:
     """ruby
     describe "2 + 2" do
@@ -24,11 +27,11 @@ Feature: Backtrace cleaning
     Then the output should contain "1 example, 1 failure"
     And the output should not contain "lib/rspec/expectations"
 
-  Scenario: With a custom setting for backtrace_clean_patterns
+  Scenario: replacing backtrace_exclusion_patterns
     Given a file named "spec/spec_helper.rb" with:
     """ruby
     RSpec.configure do |config|
-      config.backtrace_clean_patterns = [
+      config.backtrace_exclusion_patterns = [
         /spec_helper/
       ]
     end
@@ -50,7 +53,7 @@ Feature: Backtrace cleaning
     Then the output should contain "1 example, 1 failure"
     And the output should contain "lib/rspec/expectations"
 
-  Scenario: Adding a pattern
+  Scenario: appending to backtrace_exclusion_patterns
     Given a file named "spec/matchers/be_baz_matcher.rb" with:
     """ruby
     RSpec::Matchers.define :be_baz do |_|
@@ -62,7 +65,7 @@ Feature: Backtrace cleaning
     And a file named "spec/example_spec.rb" with:
     """ruby
     RSpec.configure do |config|
-      config.backtrace_clean_patterns << /be_baz_matcher/
+      config.backtrace_exclusion_patterns << /be_baz_matcher/
     end
 
     describe "bar" do
@@ -76,7 +79,7 @@ Feature: Backtrace cleaning
     But the output should not contain "be_baz_matcher"
     And the output should not contain "lib/rspec/expectations"
 
-  Scenario: Running with the --backtrace option
+  Scenario: running rspec with the --backtrace option
     Given a file named "spec/matchers/be_baz_matcher.rb" with:
     """ruby
     RSpec::Matchers.define :be_baz do |_|
@@ -88,7 +91,7 @@ Feature: Backtrace cleaning
     And a file named "spec/example_spec.rb" with:
     """ruby
     RSpec.configure do |config|
-      config.backtrace_clean_patterns << /be_baz_matcher/
+      config.backtrace_exclusion_patterns << /be_baz_matcher/
     end
 
     describe "bar" do

lib/rspec/core/configuration.rb

@@ -284,29 +284,6 @@ def mock_framework=(framework)
         mock_with framework
       end
 
-      # The patterns to discard from backtraces. Deprecated, use
-      # Configuration#backtrace_exclusion_patterns instead
-      #
-      # Defaults to RSpec::Core::BacktraceCleaner::DEFAULT_EXCLUSION_PATTERNS
-      #
-      # One can replace the list by using the setter or modify it through the
-      # getter
-      #
-      # To override this behaviour and display a full backtrace, use
-      # `--backtrace`on the command line, in a `.rspec` file, or in the
-      # `rspec_options` attribute of RSpec's rake task.
-      def backtrace_clean_patterns
-        RSpec.deprecate("RSpec::Core::Configuration#backtrace_clean_patterns",
-                        :replacement => "RSpec::Core::Configuration#backtrace_exclusion_patterns")
-        @backtrace_cleaner.exclusion_patterns
-      end
-
-      def backtrace_clean_patterns=(patterns)
-        RSpec.deprecate("RSpec::Core::Configuration#backtrace_clean_patterns",
-                        :replacement => "RSpec::Core::Configuration#backtrace_exclusion_patterns")
-        @backtrace_cleaner.exclusion_patterns = patterns
-      end
-
       # The patterns to always include to backtraces.
       #
       # Defaults to [Regexp.new Dir.getwd] if the current working directory

lib/rspec/core/mocking/with_rr.rb

@@ -1,6 +1,6 @@
 require 'rr'
 
-RSpec.configuration.backtrace_clean_patterns.push(RR::Errors::BACKTRACE_IDENTIFIER)
+RSpec.configuration.backtrace_exclusion_patterns.push(RR::Errors::BACKTRACE_IDENTIFIER)
 
 module RSpec
   module Core

spec/rspec/core/configuration_spec.rb

@@ -1016,11 +1016,10 @@ def metadata_hash(*args)
       end
     end
 
-    describe "#backtrace_clean_patterns=" do
+    describe "#backtrace_exclusion_patterns=" do
       it "actually receives the new filter values" do
-        RSpec.stub(:deprecate)
         config = Configuration.new
-        config.backtrace_clean_patterns = [/.*/]
+        config.backtrace_exclusion_patterns = [/.*/]
         expect(config.backtrace_cleaner.exclude? "this").to be_true
       end
     end
@@ -1037,17 +1036,10 @@ def metadata_hash(*args)
       end
     end
 
-    describe "#backtrace_clean_patterns" do
-      before { allow(RSpec).to receive(:deprecate) }
-      it "is deprecated" do
-        RSpec.should_receive(:deprecate)
-        config = Configuration.new
-        config.backtrace_clean_patterns
-      end
-
+    describe "#backtrace_exclusion_patterns" do
       it "can be appended to" do
         config = Configuration.new
-        config.backtrace_clean_patterns << /.*/
+        config.backtrace_exclusion_patterns << /.*/
         expect(config.backtrace_cleaner.exclude? "this").to be_true
       end
     end