switch from specific coderay reporter message to hook

Author: JonRowe

lib/rspec/core/notifications.rb

@@ -281,10 +281,8 @@ def fully_formatted
     # @attr pending_examples [Array<RSpec::Core::Example>] the pending examples
     # @attr load_time [Float] the number of seconds taken to boot RSpec
     #                         and load the spec files
-    # @attr syntax_highlighting_unavailable [Boolean] indicates if syntax highlighting
-    #       was attempted to be used but was unavailable.
-    SummaryNotification = Struct.new(:duration, :examples, :failed_examples, :pending_examples,
-                                     :load_time, :syntax_highlighting_unavailable)
+    SummaryNotification = Struct.new(:duration, :examples, :failed_examples,
+                                     :pending_examples, :load_time)
     class SummaryNotification
       # @api
       # @return [Fixnum] the number of examples run
@@ -362,11 +360,7 @@ def formatted_load_time
       # @return [String] The summary information fully formatted in the way that
       #   RSpec's built-in formatters emit.
       def fully_formatted(colorizer=::RSpec::Core::Formatters::ConsoleCodes)
-        formatted = ""
-        if syntax_highlighting_unavailable
-          formatted << "\nSyntax highlighting of failure snippets unavailable -- install the coderay gem to enable it.\n"
-        end
-        formatted << "\nFinished in #{formatted_duration} " \
+        formatted = "\nFinished in #{formatted_duration} " \
                     "(files took #{formatted_load_time} to load)\n" \
                     "#{colorized_totals_line(colorizer)}\n"
 

lib/rspec/core/reporter.rb

@@ -17,19 +17,19 @@ def initialize(configuration)
       @examples = []
       @failed_examples = []
       @pending_examples = []
+      @before_summary_messages = {}
       @duration = @start = @load_time = nil
     end
 
     # @private
-    attr_reader :examples, :failed_examples, :pending_examples
-    # @private
-    attr_accessor :syntax_highlighting_unavailable
+    attr_reader :examples, :failed_examples, :pending_examples, :before_summary_messages
 
     # @private
     def reset
       @examples = []
       @failed_examples = []
       @pending_examples = []
+      @before_summary_messages = {}
       @profiler = Profiler.new if defined?(@profiler)
     end
 
@@ -97,6 +97,14 @@ def message(message)
       notify :message, Notifications::MessageNotification.new(message)
     end
 
+    # @param type A key to limit duplicate messages
+    # @param message [#to_s] A message object to output on exit to formatters
+    #
+    # Send a custom message to supporting formatters once on exit.
+    def add_message_before_summary(type, message)
+      @before_summary_messages[type] ||= message
+    end
+
     # @param event [Symbol] Name of the custom event to trigger on formatters
     # @param options [Hash] Hash of arguments to provide via `CustomNotification`
     #
@@ -166,9 +174,11 @@ def finish
                                                                        @configuration.profile_examples,
                                                                        @profiler.example_groups)
         end
+        before_summary_messages.each_value do |text|
+          notify :message, Notifications::MessageNotification.new(text)
+        end
         notify :dump_summary, Notifications::SummaryNotification.new(@duration, @examples, @failed_examples,
-                                                                     @pending_examples, @load_time,
-                                                                     syntax_highlighting_unavailable)
+                                                                     @pending_examples, @load_time)
         notify :seed, Notifications::SeedNotification.new(@configuration.seed, seed_used?)
       end
     end

lib/rspec/core/source/syntax_highlighter.rb

@@ -31,10 +31,13 @@ def implementation
         def color_enabled_implementation
           @color_enabled_implementation ||= begin
             ::Kernel.require 'coderay'
-            @configuration.reporter.syntax_highlighting_unavailable = false
             CodeRayImplementation
           rescue LoadError
-            @configuration.reporter.syntax_highlighting_unavailable = true
+            @configuration.reporter.add_message_before_summary(
+              :coderay,
+              "\nSyntax highlighting of failure snippets unavailable " \
+              "-- install the coderay gem to enable it.\n"
+            )
             NoSyntaxHighlightingImplementation
           end
         end

spec/rspec/core/reporter_spec.rb

@@ -35,32 +35,26 @@ module RSpec::Core
         reporter.finish
       end
 
-      let(:install_coderay_snippet) { "install the coderay gem" }
-
-      def formatter_notified_of_dump_summary(syntax_highlighting_unavailable)
-        formatter = spy("formatter")
-        reporter.syntax_highlighting_unavailable = syntax_highlighting_unavailable
-        reporter.register_listener formatter, :dump_summary
+      it "dumps any add_message_before_summary messages once before the summary" do
+        formatter = instance_double("RSpec::Core::Formatter::ProgressFormatter")
+        reporter.register_listener(formatter, :message, :dump_summary)
+
+        reporter.add_message_before_summary :install_this_gem, "install my gem"
+        reporter.add_message_before_summary :install_this_gem, "install my gem please?"
+        reporter.add_message_before_summary :install_that_gem, "install a different gem"
+
+        expect(formatter).to receive(:message).with(
+          an_object_having_attributes(:message => "install my gem")
+        ).once.ordered
+        expect(formatter).to receive(:message).with(
+          an_object_having_attributes(:message => "install a different gem")
+        ).once.ordered
+        expect(formatter).to receive(:dump_summary).ordered
 
-        reporter.start(0)
         reporter.finish
-        formatter
       end
 
-      it "includes a note about install coderay if syntax highlighting is unavailable" do
-        formatter = formatter_notified_of_dump_summary(true)
-
-        expect(formatter).to have_received(:dump_summary).with(an_object_having_attributes(
-          :fully_formatted => a_string_including(install_coderay_snippet)
-        ))
-      end
-
-      it "does not include a note about installing coderay if syntax highlighting is available" do
-        formatter = formatter_notified_of_dump_summary(false)
-
-        expect(formatter).to have_received(:dump_summary).with(an_object_having_attributes(
-          :fully_formatted => a_string_excluding(install_coderay_snippet)
-        ))
+      it 'wont dump any silenced messages' do
       end
     end
 

spec/rspec/core/source/syntax_highlighter_spec.rb

@@ -5,10 +5,6 @@ class RSpec::Core::Source
     let(:config)      { RSpec::Core::Configuration.new.tap { |c| c.color = true } }
     let(:highlighter) { SyntaxHighlighter.new(config)  }
 
-    def be_highlighted
-      include("\e[32m")
-    end
-
     context "when CodeRay is available", :unless => RSpec::Support::OS.windows? do
       before { expect { require 'coderay' }.not_to raise_error }
 
@@ -42,22 +38,6 @@ def be_highlighted
         expect(highlighter.highlight(['[:ok, "ok"]']).first).not_to be_highlighted
       end
 
-      it 'notifies the reporter' do
-        config.reporter.syntax_highlighting_unavailable = true
-
-        expect {
-          highlighter.highlight([""])
-        }.to change { config.reporter.syntax_highlighting_unavailable }.to(false)
-      end
-
-      it 'does not notify the reporter if highlighting is never attempted' do
-        config.reporter.syntax_highlighting_unavailable = true
-
-        expect {
-          SyntaxHighlighter.new(config)
-        }.not_to change { config.reporter.syntax_highlighting_unavailable }
-      end
-
       it "rescues coderay failures since we do not want a coderay error to be displayed instead of the user's error" do
         allow(CodeRay).to receive(:encode).and_raise(Exception.new "boom")
         lines = [":ok"]
@@ -96,20 +76,27 @@ def be_highlighted
       end
 
       it 'notifies the reporter', :unless => RSpec::Support::OS.windows? do
-        config.reporter.syntax_highlighting_unavailable = false
-
         expect {
           highlighter.highlight([""])
-        }.to change { config.reporter.syntax_highlighting_unavailable }.to(true)
+        }.to change {
+          config.reporter.before_summary_messages
+        }.to include_coderay_snippet
       end
 
       it 'does not notify the reporter if highlighting is never attempted' do
-        config.reporter.syntax_highlighting_unavailable = false
-
         expect {
           SyntaxHighlighter.new(config)
-        }.not_to change { config.reporter.syntax_highlighting_unavailable }
+        }.not_to change { config.reporter.before_summary_messages }
       end
     end
+
+    def be_highlighted
+      include("\e[32m")
+    end
+
+    def include_coderay_snippet
+      include(:coderay => a_string_including("install the coderay gem"))
+    end
+
   end
 end