super_diff 0.2.0 → 0.5.0

data/spec/integration/rspec/third_party_matcher_spec.rb

@@ -0,0 +1,241 @@
+require "spec_helper"
+
+RSpec.describe "Integration with a third-party matcher", type: :integration do
+  context "when the matcher is used in the positive and fails" do
+    context "when the failure message spans multiple lines" do
+      context "and some of the message is indented" do
+        it "colorizes the non-indented part in red" do
+          as_both_colored_and_uncolored do |color_enabled|
+            snippet = <<~TEST.strip
+              expect(:anything).to fail_with_indented_multiline_failure_message
+            TEST
+            program = make_plain_test_program(
+              snippet,
+              color_enabled: color_enabled,
+            )
+
+            expected_output = build_expected_output(
+              color_enabled: color_enabled,
+              snippet: %|expect(:anything).to fail_with_indented_multiline_failure_message|,
+              newline_before_expectation: true,
+              expectation: proc {
+                red_line   "This is a message that spans multiple lines."
+                red_line   "Here is the next line."
+                plain_line "  This part is indented, for whatever reason. It just kinda keeps"
+                plain_line "  going until we finish saying whatever it is we want to say."
+              }
+            )
+
+            expect(program).
+              to produce_output_when_run(expected_output).
+              in_color(color_enabled)
+          end
+        end
+      end
+
+      context "and some of the message is not indented" do
+        context "and the message is divided into paragraphs" do
+          it "colorizes the first paragraph in red" do
+            as_both_colored_and_uncolored do |color_enabled|
+              snippet = <<~TEST.strip
+                expect(:anything).to fail_with_paragraphed_failure_message
+              TEST
+              program = make_plain_test_program(
+                snippet,
+                color_enabled: color_enabled,
+              )
+
+              expected_output = build_expected_output(
+                color_enabled: color_enabled,
+                snippet: %|expect(:anything).to fail_with_paragraphed_failure_message|,
+                newline_before_expectation: true,
+                expectation: proc {
+                  red_line "This is a message that spans multiple paragraphs."
+                  newline
+                  plain_line "Here is the next paragraph."
+                }
+              )
+
+              expect(program).
+                to produce_output_when_run(expected_output).
+                in_color(color_enabled)
+            end
+          end
+        end
+
+        context "and the message is not divided into paragraphs" do
+          it "colorizes all of the message in red" do
+            as_both_colored_and_uncolored do |color_enabled|
+              snippet = <<~TEST.strip
+                expect(:anything).to fail_with_non_indented_multiline_failure_message
+              TEST
+              program = make_plain_test_program(
+                snippet,
+                color_enabled: color_enabled,
+              )
+
+              expected_output = build_expected_output(
+                color_enabled: color_enabled,
+                snippet: %|expect(:anything).to fail_with_non_indented_multiline_failure_message|,
+                newline_before_expectation: true,
+                expectation: proc {
+                  red_line "This is a message that spans multiple lines."
+                  red_line "Here is the next line."
+                }
+              )
+
+              expect(program).
+                to produce_output_when_run(expected_output).
+                in_color(color_enabled)
+            end
+          end
+        end
+      end
+    end
+
+    context "when the failure message does not span multiple lines" do
+      it "colorizes all of the message in red" do
+        as_both_colored_and_uncolored do |color_enabled|
+          snippet = <<~TEST.strip
+            expect(:anything).to fail_with_singleline_failure_message
+          TEST
+          program = make_plain_test_program(
+            snippet,
+            color_enabled: color_enabled,
+          )
+
+          expected_output = build_expected_output(
+            color_enabled: color_enabled,
+            snippet: %|expect(:anything).to fail_with_singleline_failure_message|,
+            expectation: proc {
+              red_line "This is a message that spans only one line."
+            }
+          )
+
+          expect(program).
+            to produce_output_when_run(expected_output).
+            in_color(color_enabled)
+        end
+      end
+    end
+  end
+
+  context "when the matcher is used in the negative and fails" do
+    context "when the failure message spans multiple lines" do
+      context "and some of the message is indented" do
+        it "colorizes the non-indented part in red" do
+          as_both_colored_and_uncolored do |color_enabled|
+            snippet = <<~TEST.strip
+              expect(:anything).not_to pass_with_indented_multiline_failure_message
+            TEST
+            program = make_plain_test_program(
+              snippet,
+              color_enabled: color_enabled,
+            )
+
+            expected_output = build_expected_output(
+              color_enabled: color_enabled,
+              snippet: %|expect(:anything).not_to pass_with_indented_multiline_failure_message|,
+              newline_before_expectation: true,
+              expectation: proc {
+                red_line   "This is a message that spans multiple lines."
+                red_line   "Here is the next line."
+                plain_line "  This part is indented, for whatever reason. It just kinda keeps"
+                plain_line "  going until we finish saying whatever it is we want to say."
+              }
+            )
+
+            expect(program).
+              to produce_output_when_run(expected_output).
+              in_color(color_enabled)
+          end
+        end
+      end
+
+      context "and some of the message is not indented" do
+        context "and the message is divided into paragraphs" do
+          it "colorizes all of the message in red" do
+            as_both_colored_and_uncolored do |color_enabled|
+              snippet = <<~TEST.strip
+                expect(:anything).not_to pass_with_paragraphed_failure_message
+              TEST
+              program = make_plain_test_program(
+                snippet,
+                color_enabled: color_enabled,
+              )
+
+              expected_output = build_expected_output(
+                color_enabled: color_enabled,
+                snippet: %|expect(:anything).not_to pass_with_paragraphed_failure_message|,
+                newline_before_expectation: true,
+                expectation: proc {
+                  red_line "This is a message that spans multiple paragraphs."
+                  newline
+                  plain_line "Here is the next paragraph."
+                }
+              )
+
+              expect(program).
+                to produce_output_when_run(expected_output).
+                in_color(color_enabled)
+            end
+          end
+        end
+
+        context "and the message is not divided into paragraphs" do
+          it "colorizes all of the message in red" do
+            as_both_colored_and_uncolored do |color_enabled|
+              snippet = <<~TEST.strip
+                expect(:anything).not_to pass_with_non_indented_multiline_failure_message
+              TEST
+              program = make_plain_test_program(
+                snippet,
+                color_enabled: color_enabled,
+              )
+
+              expected_output = build_expected_output(
+                color_enabled: color_enabled,
+                snippet: %|expect(:anything).not_to pass_with_non_indented_multiline_failure_message|,
+                newline_before_expectation: true,
+                expectation: proc {
+                  red_line "This is a message that spans multiple lines."
+                  red_line "Here is the next line."
+                }
+              )
+
+              expect(program).
+                to produce_output_when_run(expected_output).
+                in_color(color_enabled)
+            end
+          end
+        end
+      end
+    end
+
+    context "when the failure message does not span multiple lines" do
+      it "colorizes all of the message in red" do
+        as_both_colored_and_uncolored do |color_enabled|
+          snippet = <<~TEST.strip
+            expect(:anything).not_to pass_with_singleline_failure_message
+          TEST
+          program = make_plain_test_program(
+            snippet,
+            color_enabled: color_enabled,
+          )
+
+          expected_output = build_expected_output(
+            color_enabled: color_enabled,
+            snippet: %|expect(:anything).not_to pass_with_singleline_failure_message|,
+            expectation: proc {
+              red_line "This is a message that spans only one line."
+            }
+          )
+
+          expect(program).
+            to produce_output_when_run(expected_output).
+            in_color(color_enabled)
+        end
+      end
+    end
+  end
+end

data/spec/integration/rspec/unhandled_errors_spec.rb

@@ -2,91 +2,143 @@ require "spec_helper"
 
 RSpec.describe "Integration with RSpec and unhandled errors", type: :integration do
   context "when a random exception occurs" do
-    it "highlights the whole output after the code snippet in red" do
-      as_both_colored_and_uncolored do |color_enabled|
-        snippet = <<~TEST.strip
-          raise "Some kind of error or whatever"
-        TEST
-        program = make_plain_test_program(
-          snippet,
-          color_enabled: color_enabled,
-        )
-
-        expected_output = colored(color_enabled: color_enabled) do
-          line "Failures:\n"
-
-          line "1) test passes", indent_by: 2
-
-          line indent_by: 5 do
-            bold "Failure/Error: "
-            plain %|raise "Some kind of error or whatever"|
-          end
-
-          newline
-
-          indent by: 5 do
-            red_line "RuntimeError:"
-            plain_line "  Some kind of error or whatever"
-          end
+    context "and the message spans multiple lines" do
+      it "highlights the first line in red, and then leaves the rest of the message alone" do
+        as_both_colored_and_uncolored do |color_enabled|
+          snippet = <<~TEST.strip
+            raise "Some kind of error or whatever\\n\\nThis is another line"
+          TEST
+          program = make_plain_test_program(
+            snippet,
+            color_enabled: color_enabled,
+          )
+
+          expected_output = build_expected_output(
+            color_enabled: color_enabled,
+            snippet: snippet,
+            newline_before_expectation: true,
+            indentation: 5,
+            expectation: proc {
+              red_line "RuntimeError:"
+              indent by: 2 do
+                red_line "Some kind of error or whatever"
+                newline
+                plain_line "This is another line"
+              end
+            },
+          )
+
+          expect(program).
+            to produce_output_when_run(expected_output).
+            in_color(color_enabled)
         end
+      end
+    end
 
-        expect(program).
-          to produce_output_when_run(expected_output).
-          in_color(color_enabled)
+    context "and the message does not span multiple lines" do
+      it "highlights the whole output after the code snippet in red" do
+        as_both_colored_and_uncolored do |color_enabled|
+          snippet = <<~TEST.strip
+            raise "Some kind of error or whatever"
+          TEST
+          program = make_plain_test_program(
+            snippet,
+            color_enabled: color_enabled,
+          )
+
+          expected_output = build_expected_output(
+            color_enabled: color_enabled,
+            snippet: snippet,
+            newline_before_expectation: true,
+            indentation: 5,
+            expectation: proc {
+              red_line "RuntimeError:"
+              indent by: 2 do
+                red_line "Some kind of error or whatever"
+              end
+            },
+          )
+
+          expect(program).
+            to produce_output_when_run(expected_output).
+            in_color(color_enabled)
+        end
       end
     end
   end
 
-  context "when a matcher that has a multi-line message fails" do
-    it "highlights the first line of the failure message in red" do
+  context "when multiple exceptions occur" do
+    it "displays all exceptions, and for each exception, highlights the first line in red and leaves the rest of the message alone" do
       as_both_colored_and_uncolored do |color_enabled|
         snippet = <<~TEST.strip
-          RSpec::Matchers.define :fail_with_multiline_message do
-            match do
-              false
+          raise "Some kind of error or whatever\\n\\nThis is another line"
+        TEST
+        code = <<~CODE
+          RSpec.describe "test" do
+            after(:each) do
+              #{snippet}
             end
 
-            failure_message do
-              <<\~MESSAGE
-                First line
-
-                Second line
-
-                Third line
-              MESSAGE
+            it "passes" do
+              #{snippet}
             end
           end
+        CODE
 
-          expect(:foo).to fail_with_multiline_message
-        TEST
         program = make_plain_test_program(
-          snippet,
+          code,
           color_enabled: color_enabled,
+          preserve_as_whole_file: true,
         )
 
-        expected_output = colored(color_enabled: color_enabled) do
-          line "Failures:\n"
+        expected_output1 = colored(color_enabled: color_enabled) do
+          indent by: 5 do
+            line do
+              plain "1.1) "
+              bold "Failure/Error: "
+              plain snippet
+            end
 
-          line "1) test passes", indent_by: 2
+            newline
 
-          line indent_by: 5 do
-            bold "Failure/Error: "
-            plain %|expect(:foo).to fail_with_multiline_message|
+            indent by: 5 do
+              red_line "RuntimeError:"
+              indent by: 2 do
+                red_line "Some kind of error or whatever"
+                newline
+                line "This is another line"
+              end
+            end
           end
+        end
 
-          newline
-
+        expected_output2 = colored(color_enabled: color_enabled) do
           indent by: 5 do
-            red_line "  First line"
-            newline
-            plain_line "  Second line"
+            line do
+              plain "1.2) "
+              bold "Failure/Error: "
+              plain snippet
+            end
+
             newline
-            plain_line "  Third line"
+
+            indent by: 5 do
+              red_line "RuntimeError:"
+              indent by: 2 do
+                red_line "Some kind of error or whatever"
+                newline
+                line "This is another line"
+              end
+            end
           end
         end
 
         expect(program).
-          to produce_output_when_run(expected_output).
+          to produce_output_when_run(expected_output1).
+          in_color(color_enabled)
+
+        expect(program).
+          to produce_output_when_run(expected_output2).
           in_color(color_enabled)
       end
     end

data/spec/spec_helper.rb

@@ -16,17 +16,26 @@ SuperDiff::CurrentBundle.instance.assert_appraisal!
 
 #---
 
-require "active_record"
+begin
+  require "active_record"
+  active_record_available = true
+rescue LoadError
+  active_record_available = false
+end
 
-ActiveRecord::Base.establish_connection(
-  adapter: "sqlite3",
-  database: ":memory:",
-)
+if active_record_available
+  ActiveRecord::Base.establish_connection(
+    adapter: "sqlite3",
+    database: ":memory:",
+  )
 
-$:.unshift(File.expand_path("../lib", __dir__))
-require "super_diff/rspec-rails"
+  require "super_diff/rspec-rails"
+else
+  require "super_diff/rspec"
+end
 
 Dir.glob(File.expand_path("support/**/*.rb", __dir__)).each do |file|
+  next if !active_record_available && file.include?('models/active_record')
   require file
 end
 
@@ -52,6 +61,8 @@ RSpec.configure do |config|
     config.default_formatter = "documentation"
   end
 
+  config.filter_run_excluding active_record: true unless active_record_available
+
   config.order = :random
   Kernel.srand config.seed
 end