super_diff 0.1.0 → 0.2.0

data/spec/integration/rspec/unhandled_errors_spec.rb

@@ -0,0 +1,94 @@
+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
+        end
+
+        expect(program).
+          to produce_output_when_run(expected_output).
+          in_color(color_enabled)
+      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
+      as_both_colored_and_uncolored do |color_enabled|
+        snippet = <<~TEST.strip
+          RSpec::Matchers.define :fail_with_multiline_message do
+            match do
+              false
+            end
+
+            failure_message do
+              <<\~MESSAGE
+                First line
+
+                Second line
+
+                Third line
+              MESSAGE
+            end
+          end
+
+          expect(:foo).to fail_with_multiline_message
+        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 %|expect(:foo).to fail_with_multiline_message|
+          end
+
+          newline
+
+          indent by: 5 do
+            red_line "  First line"
+            newline
+            plain_line "  Second line"
+            newline
+            plain_line "  Third line"
+          end
+        end
+
+        expect(program).
+          to produce_output_when_run(expected_output).
+          in_color(color_enabled)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,3 @@
-require_relative "../lib/super_diff"
-require_relative "../lib/super_diff/rspec"
-
 begin
   require "pry-byebug"
 rescue LoadError
@@ -11,6 +8,24 @@ begin
 rescue LoadError
 end
 
+#---
+
+require_relative "../support/current_bundle"
+
+SuperDiff::CurrentBundle.instance.assert_appraisal!
+
+#---
+
+require "active_record"
+
+ActiveRecord::Base.establish_connection(
+  adapter: "sqlite3",
+  database: ":memory:",
+)
+
+$:.unshift(File.expand_path("../lib", __dir__))
+require "super_diff/rspec-rails"
+
 Dir.glob(File.expand_path("support/**/*.rb", __dir__)).each do |file|
   require file
 end
@@ -33,7 +48,7 @@ RSpec.configure do |config|
   config.disable_monkey_patching!
   config.warnings = true
 
-  if config.files_to_run.one?
+  if !["true", "1"].include?(ENV["CI"])
     config.default_formatter = "documentation"
   end
 

data/spec/support/colorizer.rb

@@ -0,0 +1,9 @@
+module SuperDiff
+  module Tests
+    module Colorizer
+      def self.call(*args, **opts, &block)
+        SuperDiff::Helpers.style(*args, **opts, &block)
+      end
+    end
+  end
+end

data/spec/support/command_runner.rb

@@ -6,6 +6,10 @@ require "timeout"
 
 class CommandRunner
   module OutputHelpers
+    def self.bookended(text)
+      divider("START") + text + "\n" + divider("END")
+    end
+
     def self.divider(title = "")
       total_length = 72
       start_length = 3

data/spec/support/integration/helpers.rb

@@ -0,0 +1,179 @@
+module SuperDiff
+  module IntegrationTests
+    PROJECT_DIRECTORY = Pathname.new("../../..").expand_path(__dir__)
+
+    def as_both_colored_and_uncolored
+      [true, false].each do |color_enabled|
+        yield color_enabled
+      end
+    end
+
+    def make_plain_test_program(test, color_enabled:)
+      <<~PROGRAM
+        #{set_up_with("super_diff/rspec", color_enabled: color_enabled)}
+        #{describe_block_including(test)}
+      PROGRAM
+    end
+
+    def make_rspec_active_record_program(test, color_enabled:)
+      <<~PROGRAM
+        #{
+          set_up_active_record_around do
+            set_up_with(
+              "super_diff/rspec", "super_diff/active_record",
+              color_enabled: color_enabled
+            )
+          end
+        }
+        #{describe_block_including(test)}
+      PROGRAM
+    end
+
+    def make_rspec_rails_test_program(test, color_enabled:)
+      <<~PROGRAM
+        #{
+          set_up_active_record_around do
+            set_up_with("super_diff/rspec-rails", color_enabled: color_enabled)
+          end
+        }
+        #{describe_block_including(test)}
+      PROGRAM
+    end
+
+    def set_up_active_record_around(&block)
+      <<~PROGRAM
+        require "active_record"
+
+        ActiveRecord::Base.establish_connection(
+          adapter: "sqlite3",
+          database: ":memory:"
+        )
+
+        RSpec.configuration do |config|
+          config.before do
+            SuperDiff::Test::Models::ActiveRecord::Person.delete_all
+            SuperDiff::Test::Models::ActiveRecord::ShippingAddress.delete_all
+          end
+        end
+
+        #{block.call}
+
+        Dir.glob(SUPPORT_DIR.join("models/active_record/*.rb")).each do |path|
+          require path
+        end
+      PROGRAM
+    end
+
+    def set_up_with(*libraries, color_enabled:)
+      <<~SETUP
+        PROJECT_DIRECTORY = Pathname.new("#{PROJECT_DIRECTORY}")
+        SUPPORT_DIR = PROJECT_DIRECTORY.join("spec/support")
+        INSIDE_INTEGRATION_TEST = true
+
+        $LOAD_PATH.unshift(PROJECT_DIRECTORY.join("lib"))
+        #\$LOAD_PATH.unshift(PROJECT_DIRECTORY)
+
+        begin
+          require "pry-byebug"
+        rescue LoadError
+          require "pry-nav"
+        end
+
+        RSpec.configure do |config|
+          config.color_mode = :#{color_enabled ? "on" : "off"}
+        end
+
+#{libraries.map { |library| %(        require "#{library}") }.join("\n")}
+
+        Dir.glob(SUPPORT_DIR.join("{diff_formatters,models,operational_sequencers,operation_sequences}/*.rb")).each do |path|
+          require path
+        end
+      SETUP
+    end
+
+    def describe_block_including(test)
+      <<~PROGRAM
+        RSpec.describe "test" do
+          it "passes" do
+        #{reindent(test, level: 2)}
+          end
+        end
+      PROGRAM
+    end
+
+    def build_expected_output(
+      color_enabled:,
+      snippet:,
+      expectation:,
+      newline_before_expectation: false,
+      diff: nil
+    )
+      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 snippet
+        end
+
+        if diff || newline_before_expectation
+          newline
+        end
+
+        indent by: 7 do
+          evaluate_block(&expectation)
+
+          if diff
+            newline
+
+            white_line "Diff:"
+
+            newline
+
+            line do
+              blue "┌ (Key) ──────────────────────────┐"
+            end
+
+            line do
+              blue "│ "
+              magenta "‹-› in expected, not in actual"
+              blue "  │"
+            end
+
+            line do
+              blue "│ "
+              yellow "‹+› in actual, not in expected"
+              blue "  │"
+            end
+
+            line do
+              blue "│ "
+              text "‹ › in both expected and actual"
+              blue " │"
+            end
+
+            line do
+              blue "└─────────────────────────────────┘"
+            end
+
+            newline
+
+            evaluate_block(&diff)
+
+            newline
+          end
+        end
+      end
+    end
+
+    def colored(color_enabled: true, &block)
+      SuperDiff::Helpers.style(color_enabled: color_enabled, &block).to_s.chomp
+    end
+
+    def reindent(code, level: 0)
+      code.strip.split("\n").map { |line| ("  " * level) + line }.join("\n")
+    end
+  end
+end

data/spec/support/integration/matchers/produce_output_when_run_matcher.rb

@@ -9,67 +9,105 @@ module SuperDiff
       TEMP_DIRECTORY = PROJECT_DIRECTORY.join("tmp")
 
       def initialize(expected_output)
-        @expected_output =
-          expected_output.
-            strip.
-            split(/(\n+)/).
-            map { |line| line =~ /\n+/ ? line : (" " * 7) + line }.
-            join
+        @expected_output = expected_output.to_s.strip
+        @output_processor = nil
+        @expect_output_to_contain_color = nil
       end
 
-      def matches?(test)
-        @test = test.strip
+      def removing_object_ids
+        first_replacing(/#<([\w:]+):0x[a-z0-9]+(.*?)>/, '#<\1\2>')
+        self
+      end
+
+      def in_color(color_enabled)
+        @expect_output_to_contain_color = color_enabled
+        self
+      end
+
+      def matches?(program)
+        @program = program.strip
+
         TEMP_DIRECTORY.mkpath
-        actual_output.include?(expected_output)
+
+        output_matches? && presence_of_color_matches?
       end
 
       def failure_message
-        "Expected test to produce output, but it did not.\n\n" +
-          "Expected output:\n\n" +
-          CommandRunner::OutputHelpers.divider("START") +
-          expected_output + "\n" +
-          CommandRunner::OutputHelpers.divider("END") +
-          "\n" +
-          "Actual output:\n\n" +
-          CommandRunner::OutputHelpers.divider("START") +
-          actual_output + "\n" +
-          CommandRunner::OutputHelpers.divider("END")
+        if output_matches?
+          "Expected output of test " +
+            (expect_output_to_contain_color? ? "to " : "not to ") +
+            "contain color, but " +
+            (expect_output_to_contain_color? ? "it did not" : "it did") +
+            "."
+        else
+          message =
+            "Expected test to produce output, but it did not.\n\n" +
+            "Expected output to contain:\n\n" +
+            CommandRunner::OutputHelpers.bookended(expected_output) +
+            "\n" +
+            "Actual output:\n\n" +
+            CommandRunner::OutputHelpers.bookended(actual_output)
+
+          ::RSpec::Matchers::ExpectedsForMultipleDiffs.
+            from(expected_output).
+            message_with_diff(
+              message,
+              ::RSpec::Expectations.differ,
+              actual_output,
+            )
+        end
       end
 
       private
 
-      attr_reader :expected_output, :test
+      attr_reader :expected_output, :program, :output_processor
+
+      def expect_output_to_contain_color?
+        @expect_output_to_contain_color
+      end
+
+      def first_replacing(pattern, replacement)
+        @output_processor = [pattern, replacement]
+        self
+      end
+
+      def output_matches?
+        actual_output.include?(expected_output)
+      end
 
       def actual_output
-        @_actual_output ||=
-          CommandRunner.run("rspec", tempfile.to_s).output.strip
+        @_actual_output ||= begin
+          output = run_command.output.strip
+
+          if output_processor
+            output.gsub!(output_processor[0], output_processor[1])
+          end
+
+          output
+        end
+      end
+
+      def run_command
+        CommandRunner.run(
+          "rspec",
+          tempfile.to_s,
+          env: { "DISABLE_PRY" => "true" },
+        )
       end
 
       def tempfile
         @_tempfile =
-          TEMP_DIRECTORY.join("acceptance_spec.rb").
+          TEMP_DIRECTORY.join("integration_spec.rb").
             tap { |tempfile| tempfile.write(program) }
       end
 
-      def program
-        <<~PROGRAM
-          require "#{PROJECT_DIRECTORY.join("lib/super_diff/rspec.rb")}"
-          require "#{PROJECT_DIRECTORY.join("spec/support/person.rb")}"
-          require "#{PROJECT_DIRECTORY.join("spec/support/person_diff_formatter.rb")}"
-          require "#{PROJECT_DIRECTORY.join("spec/support/person_operation_sequence.rb")}"
-          require "#{PROJECT_DIRECTORY.join("spec/support/person_operational_sequencer.rb")}"
-
-          SuperDiff::RSpec.configure do |config|
-            config.extra_operational_sequencer_classes << SuperDiff::Test::PersonOperationalSequencer
-            config.extra_diff_formatter_classes << SuperDiff::Test::PersonDiffFormatter
-          end
+      def presence_of_color_matches?
+        @expect_output_to_contain_color.nil? ||
+          output_has_color? == expect_output_to_contain_color?
+      end
 
-          RSpec.describe "test" do
-            it "passes" do
-              #{test}
-            end
-          end
-        PROGRAM
+      def output_has_color?
+        !!(actual_output =~ /\e\[\d+m/)
       end
     end
   end