Merge pull request rspec#2007 from draffensperger/silence-filter-annouce

Add silence_filter_announcements config option

Author: JonRowe

Filtering.md

@@ -159,3 +159,16 @@ end
 ```
 
 These declarations can also be overridden from the command line.
+
+## Silencing filter announcements
+
+By default, RSpec will print a message before your specs run indicating what filters are configured, for instance, it might print "Run options: include {:focus=>true}" if you set `config.filter_run_including :focus => true`.
+
+If you wish to prevent those messages from appearing in your spec output, you can set the `silence_filter_announcements` config setting to `true` like this:
+
+``` ruby
+RSpec.configure do |c|
+  c.filter_run_including :foo => :bar
+  c.silence_filter_announcements = true
+end
+```

lib/rspec/core/configuration.rb

@@ -293,6 +293,11 @@ def exclude_pattern=(value)
       #   :cyan]`
       add_setting :detail_color
 
+      # @macro add_setting
+      # Don't print filter info i.e. "Run options: include {:focus=>true}"
+      # (default `false`).
+      add_setting :silence_filter_announcements
+
       # Deprecated. This config option was added in RSpec 2 to pave the way
       # for this being the default behavior in RSpec 3. Now this option is
       # a no-op.

lib/rspec/core/world.rb

@@ -113,14 +113,14 @@ def announce_filters
 
         unless filter_manager.empty?
           if filter_announcements.length == 1
-            reporter.message("Run options: #{filter_announcements[0]}")
+            report_filter_message("Run options: #{filter_announcements[0]}")
           else
-            reporter.message("Run options:\n  #{filter_announcements.join("\n  ")}")
+            report_filter_message("Run options:\n  #{filter_announcements.join("\n  ")}")
           end
         end
 
         if @configuration.run_all_when_everything_filtered? && example_count.zero? && !@configuration.only_failures?
-          reporter.message("#{everything_filtered_message}; ignoring #{inclusion_filter.description}")
+          report_filter_message("#{everything_filtered_message}; ignoring #{inclusion_filter.description}")
           filtered_examples.clear
           inclusion_filter.clear
         end
@@ -129,12 +129,17 @@ def announce_filters
 
         example_groups.clear
         if filter_manager.empty?
-          reporter.message("No examples found.")
+          report_filter_message("No examples found.")
         elsif exclusion_filter.empty? || inclusion_filter.empty?
-          reporter.message(everything_filtered_message)
+          report_filter_message(everything_filtered_message)
         end
       end
 
+      # @private
+      def report_filter_message(message)
+        reporter.message(message) unless @configuration.silence_filter_announcements?
+      end
+
       # @private
       def everything_filtered_message
         "\nAll examples were filtered out"

spec/rspec/core/world_spec.rb

@@ -224,6 +224,15 @@ module RSpec::Core
             world.announce_filters
           end
         end
+
+        context "with a filter but with silence_filter_announcements" do
+          it "does not announce" do
+            configuration.silence_filter_announcements = true
+            configuration.filter_run_including :foo => 'bar'
+            expect(reporter).to_not receive(:message)
+            world.announce_filters
+          end
+        end
       end
 
       context "with examples" do