Merge pull request #1866 from rspec/expose_reporter_and_allow_message

Expose reporter to running examples

Author: JonRowe

Changelog.md

@@ -1,3 +1,11 @@
+### Development
+
+Enhancements:
+
+* Expose the reporter used to run examples via `RSpec::Core::Example#reporter`.
+  (Jon Rowe, #1866)
+* Make `RSpec::Core::Reporter#message` a public supported API. (Jon Rowe, #1866)
+
 ### 3.2.0 / 2015-02-03
 [Full Changelog](http://github.com/rspec/rspec-core/compare/v3.1.7...v3.2.0)
 

lib/rspec/core/example.rb

@@ -143,8 +143,12 @@ def initialize(example_group_class, description, user_metadata, example_block=ni
 
         @example_group_instance = @exception = nil
         @clock = RSpec::Core::Time
+        @reporter = RSpec::Core::NullReporter
       end
 
+      # @return [RSpec::Core::Reporter] the current reporter for the example
+      attr_reader :reporter
+
       # Returns the example group class that provides the context for running
       # this example.
       def example_group
@@ -160,6 +164,7 @@ def example_group
       # @param example_group_instance the instance of an ExampleGroup subclass
       def run(example_group_instance, reporter)
         @example_group_instance = example_group_instance
+        @reporter = reporter
         hooks.register_global_singleton_context_hooks(self, RSpec.configuration.hooks)
         RSpec.configuration.configure_example(self)
         RSpec.current_example = self

lib/rspec/core/example_group.rb

@@ -499,7 +499,7 @@ def self.run_after_context_hooks(example_group_instance)
       end
 
       # Runs all the examples in this group.
-      def self.run(reporter=RSpec::Core::NullReporter.new)
+      def self.run(reporter=RSpec::Core::NullReporter)
         if RSpec.world.wants_to_quit
           RSpec.world.clear_remaining_example_groups if top_level?
           return

lib/rspec/core/reporter.rb

@@ -40,7 +40,6 @@ def registered_listeners(notification)
       @listeners[notification].to_a
     end
 
-    # @api
     # @overload report(count, &block)
     # @overload report(count, &block)
     # @param expected_example_count [Integer] the number of examples being run
@@ -73,7 +72,9 @@ def start(expected_example_count, time=RSpec::Core::Time.now)
       notify :seed, Notifications::SeedNotification.new(@configuration.seed, seed_used?)
     end
 
-    # @private
+    # @param message [#to_s] A message object to send to formatters
+    #
+    # Send a custom message to supporting formatters.
     def message(message)
       notify :message, Notifications::MessageNotification.new(message)
     end
@@ -163,10 +164,9 @@ def seed_used?
   # @private
   # # Used in place of a {Reporter} for situations where we don't want reporting output.
   class NullReporter
-  private
-
-    def method_missing(*)
+    def self.method_missing(*)
       # ignore
     end
+    private_class_method :method_missing
   end
 end

spec/rspec/core/example_spec.rb

@@ -732,4 +732,19 @@ def expect_pending_result(example)
       expect(ex).to pass
     end
   end
+
+  describe "exposing the examples reporter" do
+    it "returns a null reporter when the example hasnt run yet" do
+      example = RSpec.describe.example
+      expect(example.reporter).to be RSpec::Core::NullReporter
+    end
+
+    it "returns the reporter used to run the example when executed" do
+      reporter = double(:reporter).as_null_object
+      group = RSpec.describe
+      example = group.example
+      example.run group.new, reporter
+      expect(example.reporter).to be reporter
+    end
+  end
 end