Add specs covering uncovered code.

Author: myronmarston

lib/rspec/core/formatters/snippet_extractor.rb

@@ -7,26 +7,30 @@ module Formatters
       # and applies synax highlighting and line numbers using html.
       class SnippetExtractor
         # @private
-        class NullConverter
-          def convert(code)
+        module NullConverter
+          def self.convert(code)
             %Q(#{code}\n<span class="comment"># Install the coderay gem to get syntax highlighting</span>)
           end
         end
 
         # @private
-        class CoderayConverter
-          def convert(code)
+        module CoderayConverter
+          def self.convert(code)
             CodeRay.scan(code, :ruby).html(:line_numbers => false)
           end
         end
 
+        # rubocop:disable Style/ClassVars
+        @@converter = NullConverter
         begin
           require 'coderay'
-          # rubocop:disable Style/ClassVars
-          @@converter = CoderayConverter.new
+          @@converter = CoderayConverter
+          # rubocop:disable Lint/HandleExceptions
         rescue LoadError
-          @@converter = NullConverter.new
+          # it'll fall back to the NullConverter assigned above
+          # rubocop:enable Lint/HandleExceptions
         end
+
         # rubocop:enable Style/ClassVars
 
         # @api private
@@ -43,6 +47,7 @@ def snippet(backtrace)
           highlighted = @@converter.convert(raw_code)
           post_process(highlighted, line)
         end
+        # rubocop:enable Style/ClassVars
 
         # @api private
         #

lib/rspec/core/runner.rb

@@ -17,20 +17,23 @@ def self.autorun
           return
         end
 
-        at_exit do
-          # Don't bother running any specs and just let the program terminate
-          # if we got here due to an unrescued exception (anything other than
-          # SystemExit, which is raised when somebody calls Kernel#exit).
-          next unless $!.nil? || $!.is_a?(SystemExit)
-
-          # We got here because either the end of the program was reached or
-          # somebody called Kernel#exit. Run the specs and then override any
-          # existing exit status with RSpec's exit status if any specs failed.
-          invoke
-        end
+        at_exit { perform_at_exit }
         @installed_at_exit = true
       end
 
+      # @private
+      def self.perform_at_exit
+        # Don't bother running any specs and just let the program terminate
+        # if we got here due to an unrescued exception (anything other than
+        # SystemExit, which is raised when somebody calls Kernel#exit).
+        return unless $!.nil? || $!.is_a?(SystemExit)
+
+        # We got here because either the end of the program was reached or
+        # somebody called Kernel#exit. Run the specs and then override any
+        # existing exit status with RSpec's exit status if any specs failed.
+        invoke
+      end
+
       # Runs the suite of specs and exits the process with an appropriate exit
       # code.
       def self.invoke
@@ -159,8 +162,14 @@ def self.running_in_drb?
 
       # @private
       def self.trap_interrupt
-        trap('INT') do
-          exit!(1) if RSpec.world.wants_to_quit
+        trap('INT') { handle_interrupt }
+      end
+
+      # @private
+      def self.handle_interrupt
+        if RSpec.world.wants_to_quit
+          exit!(1)
+        else
           RSpec.world.wants_to_quit = true
           STDERR.puts "\nRSpec is shutting down and will print the summary report... Interrupt again to force quit."
         end

spec/rspec/core/backtrace_formatter_spec.rb

@@ -206,6 +206,7 @@ def make_backtrace_formatter(exclusion_patterns=nil, inclusion_patterns=nil)
       end
 
       it "deals gracefully with a security error" do
+        Metadata.instance_eval { @relative_path_regex = nil }
         with_safe_set_to_level_that_triggers_security_errors do
           self.formatter.__send__(:backtrace_line, __FILE__)
           # on some rubies, this doesn't raise a SecurityError; this test just

spec/rspec/core/configuration_spec.rb

@@ -1341,6 +1341,20 @@ def metadata_hash(*args)
       end
     end
 
+    describe "#backtrace_inclusion_patterns" do
+      before { config.backtrace_exclusion_patterns << /.*/ }
+
+      it 'can be assigned to' do
+        config.backtrace_inclusion_patterns = [/foo/]
+        expect(config.backtrace_formatter.exclude?("food")).to be false
+      end
+
+      it 'can be appended to' do
+        config.backtrace_inclusion_patterns << /foo/
+        expect(config.backtrace_formatter.exclude?("food")).to be false
+      end
+    end
+
     describe "#filter_gems_from_backtrace" do
       def exclude?(line)
         config.backtrace_formatter.exclude?(line)
@@ -1357,6 +1371,22 @@ def exclude?(line)
       end
     end
 
+    describe "#profile_examples" do
+      it "defaults to false" do
+        expect(config.profile_examples).to be false
+      end
+
+      it "can be set to an integer value" do
+        config.profile_examples = 17
+        expect(config.profile_examples).to eq(17)
+      end
+
+      it "returns 10 when set simply enabled" do
+        config.profile_examples = true
+        expect(config.profile_examples).to eq(10)
+      end
+    end
+
     describe "#libs=" do
       it "adds directories to the LOAD_PATH" do
         expect($LOAD_PATH).to receive(:unshift).with("a/dir")

spec/rspec/core/drb_spec.rb

@@ -82,6 +82,15 @@ def self.run(argv, err, out)
       DRb::stop_service
     end
 
+    it "falls back to `druby://:0` when `druby://localhost:0` fails" do
+      # see https://bugs.ruby-lang.org/issues/496 for background
+      expect(::DRb).to receive(:start_service).with("druby://localhost:0").and_raise(SocketError)
+      expect(::DRb).to receive(:start_service).with("druby://:0").and_call_original
+
+      result = runner("--drb-port", @drb_port, passing_spec_filename).run(err, out)
+      expect(result).to be(0)
+    end
+
     it "returns 0 if spec passes" do
       result = runner("--drb-port", @drb_port, passing_spec_filename).run(err, out)
       expect(result).to be(0)

spec/rspec/core/example_group_spec.rb

@@ -1419,8 +1419,7 @@ def foo; 'third value'; end
         let(:group) { RSpec.describe }
 
         before do
-          allow(RSpec.world).to receive(:wants_to_quit) { true }
-          allow(RSpec.world).to receive(:clear_remaining_example_groups)
+          RSpec.world.wants_to_quit = true
         end
 
         it "returns without starting the group" do
@@ -1430,16 +1429,19 @@ def foo; 'third value'; end
 
         context "at top level" do
           it "purges remaining groups" do
-            expect(RSpec.world).to receive(:clear_remaining_example_groups)
-            self.group.run(reporter)
+            expect {
+              self.group.run(reporter)
+            }.to change { RSpec.world.example_groups }.from([self.group]).to([])
           end
         end
 
         context "in a nested group" do
           it "does not purge remaining groups" do
             nested_group = self.group.describe
-            expect(RSpec.world).not_to receive(:clear_remaining_example_groups)
-            nested_group.run(reporter)
+
+            expect {
+              nested_group.run(reporter)
+            }.not_to change { RSpec.world.example_groups }.from([self.group])
           end
         end
       end

spec/rspec/core/example_spec.rb

@@ -22,6 +22,14 @@ def metadata_hash(*args)
     expect { ignoring_warnings { pp example_instance }}.to output(/RSpec::Core::Example/).to_stdout
   end
 
+  describe "#rerun_argument" do
+    it "returns the location-based rerun argument" do
+      allow(RSpec.configuration).to receive_messages(:loaded_spec_files => [__FILE__])
+      example = RSpec.describe.example
+      expect(example.rerun_argument).to eq("#{RSpec::Core::Metadata.relative_path(__FILE__)}:#{__LINE__ - 1}")
+    end
+  end
+
   describe "#exception" do
     it "supplies the first exception raised, if any" do
       RSpec.configuration.output_stream = StringIO.new

spec/rspec/core/formatters/json_formatter_spec.rb

@@ -13,7 +13,13 @@
 RSpec.describe RSpec::Core::Formatters::JsonFormatter do
   include FormatterSupport
 
-  it "outputs json (brittle high level functional test)" do
+  it "can be loaded via `--format json`" do
+    formatter_output = run_example_specs_with_formatter("json", false)
+    parsed = JSON.parse(formatter_output)
+    expect(parsed.keys).to include("examples", "summary", "summary_line")
+  end
+
+  it "outputs expected json (brittle high level functional test)" do
     group = RSpec.describe("one apiece") do
       it("succeeds") { expect(1).to eq 1 }
       it("fails") { fail "eek" }

spec/rspec/core/formatters/snippet_extractor_spec.rb

@@ -9,7 +9,7 @@ module Formatters
         end
 
         it "falls back on a default message when it doesn't find the file" do
-         expect(RSpec::Core::Formatters::SnippetExtractor.new.lines_around("blech", 8)).to eq("# Couldn't get snippet for blech")
+          expect(RSpec::Core::Formatters::SnippetExtractor.new.lines_around("blech", 8)).to eq("# Couldn't get snippet for blech")
         end
 
         it "falls back on a default message when it gets a security error" do
@@ -19,6 +19,31 @@ module Formatters
           end
           expect(message).to eq("# Couldn't get snippet for blech")
         end
+
+        describe "snippet extraction" do
+          let(:snippet) do
+            SnippetExtractor.new.snippet(["#{__FILE__}:#{__LINE__}"])
+          end
+
+          before do
+            # `send` is required for 1.8.7...
+            @orig_converter = SnippetExtractor.send(:class_variable_get, :@@converter)
+          end
+
+          after do
+            SnippetExtractor.send(:class_variable_set, :@@converter, @orig_converter)
+          end
+
+          it 'suggests you install coderay when it cannot be loaded' do
+            SnippetExtractor.send(:class_variable_set, :@@converter, SnippetExtractor::NullConverter)
+
+            expect(snippet).to include("Install the coderay gem")
+          end
+
+          it 'does not suggest installing coderay normally' do
+            expect(snippet).to exclude("Install the coderay gem")
+          end
+        end
       end
     end
   end

spec/rspec/core/metadata_spec.rb

@@ -15,6 +15,8 @@ module Core
         end
         # I have no idea what line = line.sub(/\A([^:]+:\d+)$/, '\\1') is supposed to do
         it "gracefully returns nil if run in a secure thread" do
+          # Ensure our call to `File.expand_path` is not cached as that is the insecure operation.
+          Metadata.instance_eval { @relative_path_regex = nil }
           with_safe_set_to_level_that_triggers_security_errors do
             value = Metadata.relative_path(".")
             # on some rubies, File.expand_path is not a security error, so accept "." as well

spec/rspec/core/notifications_spec.rb

@@ -47,6 +47,16 @@
       end
     end
 
+    context "when ruby reports a file that does not exist" do
+      let(:file) { "#{__FILE__}/blah.rb" }
+      let(:exception) { instance_double(Exception, :backtrace => [ "#{file}:1"]) }
+
+      it "reports the filename and that it was unable to find the matching line" do
+        example.metadata[:absolute_file_path] = file
+        expect(notification.send(:read_failed_line)).to include("Unable to find #{file} to read failed line")
+      end
+    end
+
     context "when the stacktrace includes relative paths (which can happen when using `rspec/autorun` and running files through `ruby`)" do
       let(:relative_file) { Pathname(__FILE__).relative_path_from(Pathname(Dir.pwd)) }
       line = __LINE__
@@ -117,3 +127,24 @@
     end
   end
 end
+
+module RSpec::Core::Notifications
+  RSpec.describe ExamplesNotification do
+    include FormatterSupport
+
+    describe "#notifications" do
+      it 'returns an array of notification objects for all the examples' do
+        reporter = RSpec::Core::Reporter.new(RSpec.configuration)
+        example = new_example
+
+        reporter.example_started(example)
+        reporter.example_passed(example)
+
+        notification = ExamplesNotification.new(reporter)
+        expect(notification.notifications).to match [
+          an_instance_of(ExampleNotification) & an_object_having_attributes(:example => example)
+        ]
+      end
+    end
+  end
+end

spec/rspec/core/option_parser_spec.rb

@@ -1,3 +1,5 @@
+require 'rspec/core/project_initializer'
+
 module RSpec::Core
   RSpec.describe OptionParser do
     before do
@@ -59,6 +61,33 @@ def generate_help_text
       expect { generate_help_text }.to_not output(useless_lines).to_stdout
     end
 
+    %w[ -v --version ].each do |option|
+      describe option do
+        it "prints the version and exits" do
+          parser = Parser.new
+          expect(parser).to receive(:exit)
+
+          expect {
+            parser.parse([option])
+          }.to output("#{RSpec::Core::Version::STRING}\n").to_stdout
+        end
+      end
+    end
+
+    describe "--init" do
+      it "initializes a project and exits" do
+        project_init = instance_double(ProjectInitializer)
+        allow(ProjectInitializer).to receive_messages(:new => project_init)
+
+        parser = Parser.new
+
+        expect(project_init).to receive(:run).ordered
+        expect(parser).to receive(:exit).ordered
+
+        parser.parse(["--init"])
+      end
+    end
+
     describe "-I" do
       it "sets the path" do
         options = Parser.parse(%w[-I path/to/foo])