Use id in rerun command when the location identifies multiple examples.

Author: myronmarston

lib/rspec/core/example.rb

@@ -92,15 +92,26 @@ def inspect_output
         inspect_output
       end
 
-      # Returns the argument that can be passed to the `rspec` command to rerun this example.
-      def rerun_argument
-        loaded_spec_files = RSpec.configuration.loaded_spec_files
+      # Returns the location-based argument that can be passed to the `rspec` command to rerun this example.
+      def location_rerun_argument
+        @location_rerun_argument ||= begin
+          loaded_spec_files = RSpec.configuration.loaded_spec_files
 
-        Metadata.ascending(metadata) do |meta|
-          return meta[:location] if loaded_spec_files.include?(meta[:absolute_file_path])
+          Metadata.ascending(metadata) do |meta|
+            return meta[:location] if loaded_spec_files.include?(meta[:absolute_file_path])
+          end
         end
       end
 
+      # Returns the location-based argument that can be passed to the `rspec` command to rerun this example.
+      #
+      # @deprecated Use {#location_rerun_argument} instead.
+      # @note If there are multiple examples identified by this location, they will use {#id}
+      #   to rerun instead, but this method will still return the location (that's why it is deprecated!).
+      def rerun_argument
+        location_rerun_argument
+      end
+
       # @return [String] the unique id of this example. Pass
       #   this at the command line to re-run this exact example.
       def id

lib/rspec/core/notifications.rb

@@ -485,7 +485,7 @@ def colorized_totals_line(colorizer=::RSpec::Core::Formatters::ConsoleCodes)
       def colorized_rerun_commands(colorizer=::RSpec::Core::Formatters::ConsoleCodes)
         "\nFailed examples:\n\n" +
         failed_examples.map do |example|
-          colorizer.wrap("rspec #{example.rerun_argument}", RSpec.configuration.failure_color) + " " +
+          colorizer.wrap("rspec #{rerun_argument_for(example)}", RSpec.configuration.failure_color) + " " +
           colorizer.wrap("# #{example.full_description}",   RSpec.configuration.detail_color)
         end.join("\n")
       end
@@ -515,6 +515,25 @@ def fully_formatted(colorizer=::RSpec::Core::Formatters::ConsoleCodes)
 
         formatted
       end
+
+    private
+
+      def rerun_argument_for(example)
+        location = example.location_rerun_argument
+        duplicate_rerun_locations.include?(location) ? example.id : location
+      end
+
+      def duplicate_rerun_locations
+        @duplicate_rerun_locations ||= begin
+          locations = RSpec.world.all_examples.map(&:location_rerun_argument)
+
+          Set.new.tap do |s|
+            locations.group_by { |l| l }.each do |l, ls|
+              s << l if ls.count > 1
+            end
+          end
+        end
+      end
     end
 
     # The `ProfileNotification` holds information about the results of running a

lib/rspec/core/world.rb

@@ -88,6 +88,12 @@ def example_count(groups=example_groups)
           inject(0) { |a, e| a + e.filtered_examples.size }
       end
 
+      # @api private
+      def all_examples
+        flattened_groups = FlatMap.flat_map(example_groups) { |g| g.descendants }
+        FlatMap.flat_map(flattened_groups) { |g| g.examples }
+      end
+
       # @api private
       #
       # Find line number of previous declaration.

spec/integration/filtering_spec.rb

@@ -6,16 +6,17 @@
 
   it 'prints a rerun command for shared examples in external files that works to rerun' do
     write_file "spec/support/shared_examples.rb", """
-      RSpec.shared_examples 'a failing example' do
-        example { expect(1).to eq(2) }
+      RSpec.shared_examples 'with a failing example' do
+        example { expect(1).to eq(2) } # failing
+        example { expect(2).to eq(2) } # passing
       end
     """
 
     write_file "spec/host_group_spec.rb", """
       load File.expand_path('../support/shared_examples.rb', __FILE__)
 
       RSpec.describe 'A group with shared examples' do
-        include_examples 'a failing example'
+        include_examples 'with a failing example'
       end
 
       RSpec.describe 'A group with a passing example' do
@@ -24,7 +25,7 @@
     """
 
     run_command ""
-    expect(last_cmd_stdout).to include("2 examples, 1 failure")
+    expect(last_cmd_stdout).to include("3 examples, 1 failure")
     run_rerun_command_for_failing_spec
     expect(last_cmd_stdout).to include("1 example, 1 failure")
     # There was originally a bug when doing it again...

spec/rspec/core/formatters/base_text_formatter_spec.rb

@@ -30,33 +30,48 @@
       expect(output.string).to match("2 examples, 2 failures, 2 pending")
     end
 
-    it "includes command to re-run each failed example" do
-      example_group = RSpec.describe("example group") do
-        it("fails") { fail }
+    describe "rerun command for failed examples" do
+      it "uses the location to identify the example" do
+        example_group = RSpec.describe("example group") do
+          it("fails") { fail }
+        end
+        line = __LINE__ - 2
+
+        expect(output_from_running example_group).to include("rspec #{RSpec::Core::Metadata::relative_path("#{__FILE__}:#{line}")} # example group fails")
       end
-      line = __LINE__ - 2
 
-      expect(output_from_running example_group).to include("rspec #{RSpec::Core::Metadata::relative_path("#{__FILE__}:#{line}")} # example group fails")
-    end
+      context "for an example defined in an file required by the user rather than loaded by rspec" do
+        it "looks through ancestor metadata to find a workable re-run command" do
+          line = __LINE__ + 1
+          example_group = RSpec.describe("example group") do
+            # Using eval in order to make it think this got defined in an external file.
+            instance_eval "it('fails') { fail }", "some/external/file.rb", 1
+          end
 
-    context "for an example defined in an file required by the user rather than loaded by rspec" do
-      it "looks through ancestor metadata to find a workable re-run command" do
-        line = __LINE__ + 1
-        example_group = RSpec.describe("example group") do
-          # Using eval in order to make it think this got defined in an external file.
-          instance_eval "it('fails') { fail }", "some/external/file.rb", 1
+          expect(output_from_running example_group).to include("rspec #{RSpec::Core::Metadata::relative_path("#{__FILE__}:#{line}")} # example group fails")
         end
+      end
 
-        expect(output_from_running example_group).to include("rspec #{RSpec::Core::Metadata::relative_path("#{__FILE__}:#{line}")} # example group fails")
+      context "for an example that is not uniquely identified by the location" do
+        it "uses the id instead" do
+          example_group = RSpec.describe("example group") do
+            1.upto(2) do |i|
+              it("compares #{i} against 2") { expect(i).to eq(2) }
+            end
+          end
+
+          expect(output_from_running example_group).to include("rspec #{RSpec::Core::Metadata::relative_path("#{__FILE__}[1:1]")} # example group compares 1 against 2")
+        end
       end
-    end
 
-    def output_from_running(example_group)
-      allow(RSpec.configuration).to receive(:loaded_spec_files) { RSpec::Core::Set.new([File.expand_path(__FILE__)]) }
-      example_group.run(reporter)
-      examples = example_group.examples
-      send_notification :dump_summary, summary_notification(1, examples, examples, [], 0)
-      output.string
+      def output_from_running(example_group)
+        allow(RSpec.configuration).to receive(:loaded_spec_files) { RSpec::Core::Set.new([File.expand_path(__FILE__)]) }
+        example_group.run(reporter)
+        examples = example_group.examples
+        failed   = examples.select { |e| e.execution_result.status == :failed }
+        send_notification :dump_summary, summary_notification(1, examples, failed, [], 0)
+        output.string
+      end
     end
   end
 

spec/rspec/core/world_spec.rb

@@ -23,6 +23,33 @@ module RSpec::Core
       end
     end
 
+    describe "#all_examples" do
+      it "contains all examples from all levels of nesting" do
+        RSpec.describe do
+          example("ex1")
+
+          context "nested" do
+            example("ex2")
+
+            context "nested" do
+              example("ex3")
+              example("ex4")
+            end
+          end
+
+          example("ex5")
+        end
+
+        RSpec.describe do
+          example("ex6")
+        end
+
+        expect(RSpec.world.all_examples.map(&:description)).to match_array(%w[
+          ex1 ex2 ex3 ex4 ex5 ex6
+        ])
+      end
+    end
+
     describe "#preceding_declaration_line (again)" do
       let(:group) do
         RSpec.describe("group") do

spec/support/formatter_support.rb

@@ -214,7 +214,7 @@ def example
                         :full_description  => "Example",
                         :execution_result  => result,
                         :location          => "",
-                        :rerun_argument    => "",
+                        :location_rerun_argument => "",
                         :metadata          => {
                           :shared_group_inclusion_backtrace => []
                         }