Merge pull request #2006 from gavingmiller/master

Provide a human readable format when inspecting an RSpec::Core::Example

Author: myronmarston

lib/rspec/core/example.rb

@@ -170,6 +170,12 @@ def initialize(example_group_class, description, user_metadata, example_block=ni
         @reporter = RSpec::Core::NullReporter
       end
 
+      # Provide a human-readable representation of this class
+      def inspect
+        "#<#{self.class.name} #{description.inspect}>"
+      end
+      alias to_s inspect
+
       # @return [RSpec::Core::Reporter] the current reporter for the example
       attr_reader :reporter
 
@@ -256,13 +262,13 @@ class Procsy
         attr_reader :example
 
         Example.public_instance_methods(false).each do |name|
-          next if name.to_sym == :run || name.to_sym == :inspect
+          next if name.to_sym == :run || name.to_sym == :inspect || name.to_sym == :to_s
 
           define_method(name) { |*a, &b| @example.__send__(name, *a, &b) }
         end
 
         Proc.public_instance_methods(false).each do |name|
-          next if name.to_sym == :call || name.to_sym == :inspect || name.to_sym == :to_proc
+          next if name.to_sym == :call || name.to_sym == :inspect || name.to_sym == :to_s || name.to_sym == :to_proc
 
           define_method(name) { |*a, &b| @proc.__send__(name, *a, &b) }
         end

spec/rspec/core/example_spec.rb

@@ -22,6 +22,16 @@ def metadata_hash(*args)
     expect { ignoring_warnings { pp example_instance }}.to output(/RSpec::Core::Example/).to_stdout
   end
 
+  describe "human readable output" do
+    it 'prints a human readable description when inspected' do
+      expect(example_instance.inspect).to eq("#<RSpec::Core::Example \"example description\">")
+    end
+
+    it 'prints a human readable description for #to_s' do
+      expect(example_instance.to_s).to eq("#<RSpec::Core::Example \"example description\">")
+    end
+  end
+
   describe "#rerun_argument" do
     it "returns the location-based rerun argument" do
       allow(RSpec.configuration).to receive_messages(:loaded_spec_files => [__FILE__])