super_diff 0.9.0 → 0.11.0

data/spec/support/command_runner.rb

@@ -28,16 +28,13 @@ class CommandRunner
 Command #{command.inspect} failed, exiting with status #{exit_status}.
       MESSAGE
 
-      if output
-        message << <<-MESSAGE
+      message << <<-MESSAGE if output
 Output:
 #{
-  SuperDiff::Test::OutputHelpers.divider("START") +
-  output +
-  SuperDiff::Test::OutputHelpers.divider("END")
-}
+        SuperDiff::Test::OutputHelpers.divider("START") + output +
+          SuperDiff::Test::OutputHelpers.divider("END")
+      }
         MESSAGE
-      end
 
       message
     end
@@ -66,16 +63,13 @@ Output:
 Command #{formatted_command.inspect} timed out after #{timeout} seconds.
       MESSAGE
 
-      if output
-        message << <<-MESSAGE
+      message << <<-MESSAGE if output
 Output:
 #{
-  SuperDiff::Test::OutputHelpers.divider("START") +
-  output +
-  SuperDiff::Test::OutputHelpers.divider("END")
-}
+        SuperDiff::Test::OutputHelpers.divider("START") + output +
+          SuperDiff::Test::OutputHelpers.divider("END")
+      }
         MESSAGE
-      end
 
       message
     end
@@ -96,26 +90,20 @@ Output:
   end
 
   attr_reader :status, :options, :env
-  attr_accessor :run_quickly, :run_successfully, :retries,
-    :timeout
+  attr_accessor :run_quickly, :run_successfully, :retries, :timeout
 
   def initialize(*args)
     @reader, @writer = IO.pipe
     options = (args.last.is_a?(Hash) ? args.pop : {})
     @args = args
-    @options = options.merge(
-      err: [:child, :out],
-      out: @writer,
-    )
+    @options = options.merge(err: %i[child out], out: @writer)
     @env = extract_env_from(@options)
 
     @process = ChildProcess.build(*command)
-    @env.each do |key, value|
-      @process.environment[key] = value
-    end
+    @env.each { |key, value| @process.environment[key] = value }
     @process.io.stdout = @process.io.stderr = @writer
 
-    @wrapper = -> (block) { block.call }
+    @wrapper = ->(block) { block.call }
     self.directory = Dir.pwd
     @run_quickly = false
     @run_successfully = false
@@ -137,43 +125,36 @@ Output:
   end
 
   def formatted_command
-    [formatted_env, Shellwords.join(command)].
-      reject(&:empty?).
-      join(" ")
+    [formatted_env, Shellwords.join(command)].reject(&:empty?).join(" ")
   end
 
   def run
     possibly_running_quickly do
       run_with_debugging
 
-      if run_successfully && !success?
-        fail!
-      end
+      fail! if run_successfully && !success?
     end
 
     self
   end
 
   def stop
-    if !writer.closed?
-      writer.close
-    end
+    writer.close if !writer.closed?
   end
 
   def output
-    @_output ||= begin
-      stop
-      reader.read
-    end
+    @_output ||=
+      begin
+        stop
+        reader.read
+      end
   end
 
   def elided_output
     lines = output.split(/\n/)
     new_lines = lines[0..4]
 
-    if lines.size > 10
-      new_lines << "(...#{lines.size - 10} more lines...)"
-    end
+    new_lines << "(...#{lines.size - 10} more lines...)" if lines.size > 10
 
     new_lines << lines[-5..-1]
     new_lines.join("\n")
@@ -189,10 +170,10 @@ Output:
 
   def fail!
     raise CommandFailedError.create(
-      command: formatted_command,
-      exit_status: exit_status,
-      output: output,
-    )
+            command: formatted_command,
+            exit_status: exit_status,
+            output: output
+          )
   end
 
   def has_output?(expected_output)
@@ -210,9 +191,9 @@ Output:
   private
 
   def extract_env_from(options)
-    options.delete(:env) { {} }.reduce({}) do |hash, (key, value)|
-      hash.merge(key.to_s => value)
-    end
+    options
+      .delete(:env) { {} }
+      .reduce({}) { |hash, (key, value)| hash.merge(key.to_s => value) }
   end
 
   def command
@@ -239,9 +220,7 @@ Output:
     run_with_wrapper
 
     debug do
-      "\n" +
-        SuperDiff::Test::OutputHelpers.divider("START") +
-        output +
+      "\n" + SuperDiff::Test::OutputHelpers.divider("START") + output +
         SuperDiff::Test::OutputHelpers.divider("END")
     end
   end
@@ -254,10 +233,10 @@ Output:
         stop
 
         raise CommandTimedOutError.create(
-          command: formatted_command,
-          timeout: timeout,
-          output: output,
-        )
+                command: formatted_command,
+                timeout: timeout,
+                output: output
+              )
       end
     else
       yield
@@ -269,8 +248,6 @@ Output:
   end
 
   def debug
-    if debugging_enabled?
-      puts yield
-    end
+    puts yield if debugging_enabled?
   end
 end

data/spec/support/integration/helpers.rb

@@ -3,22 +3,20 @@ module SuperDiff
     PROJECT_DIRECTORY = Pathname.new("../../..").expand_path(__dir__)
 
     def as_both_colored_and_uncolored
-      [true, false].each do |color_enabled|
-        yield color_enabled
-      end
+      [true, false].each { |color_enabled| yield color_enabled }
     end
 
     def make_plain_test_program(
       test,
       color_enabled:,
-      configuration: {},
+      super_diff_configuration: {},
       preserve_as_whole_file: false
     )
       TestPrograms::Plain.new(
         test,
         color_enabled: color_enabled,
-        configuration: configuration,
-        preserve_as_whole_file: preserve_as_whole_file,
+        super_diff_configuration: super_diff_configuration,
+        preserve_as_whole_file: preserve_as_whole_file
       )
     end
 
@@ -34,27 +32,38 @@ module SuperDiff
       TestPrograms::RSpecRails.new(test, color_enabled: color_enabled)
     end
 
+    def make_rspec_rails_engine_with_action_controller_program(
+      test,
+      color_enabled:
+    )
+      TestPrograms::RspecRailsEngineWithActionController.new(
+        test,
+        color_enabled: color_enabled
+      )
+    end
+
     def build_expected_output(
       color_enabled:,
       snippet:,
       expectation:,
+      test_name: "test passes",
+      key_enabled: true,
       newline_before_expectation: false,
       indentation: 7,
-      diff: nil
+      diff: nil,
+      extra_failure_lines: nil
     )
       colored(color_enabled: color_enabled) do
         line "Failures:\n"
 
-        line "1) test passes", indent_by: 2
+        line "1) #{test_name}", indent_by: 2
 
         line indent_by: 5 do
           bold "Failure/Error: "
           plain snippet
         end
 
-        if diff || newline_before_expectation
-          newline
-        end
+        newline if diff || newline_before_expectation
 
         indent by: indentation do
           evaluate_block(&expectation)
@@ -64,32 +73,30 @@ module SuperDiff
 
             white_line "Diff:"
 
-            newline
+            if key_enabled
+              newline
 
-            line do
-              blue "┌ (Key) ──────────────────────────┐"
-            end
+              line { blue "┌ (Key) ──────────────────────────┐" }
 
-            line do
-              blue "│ "
-              magenta "‹-› in expected, not in actual"
-              blue "  │"
-            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 "│ "
+                yellow "‹+› in actual, not in expected"
+                blue "  │"
+              end
 
-            line do
-              blue "│ "
-              text "‹ › in both expected and actual"
-              blue " │"
-            end
+              line do
+                blue "│ "
+                text "‹ › in both expected and actual"
+                blue " │"
+              end
 
-            line do
-              blue "└─────────────────────────────────┘"
+              line { blue "└─────────────────────────────────┘" }
             end
 
             newline
@@ -99,6 +106,11 @@ module SuperDiff
             newline
           end
         end
+
+        if extra_failure_lines
+          newline
+          evaluate_block(&extra_failure_lines)
+        end
       end
     end
 

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

@@ -32,31 +32,35 @@ module SuperDiff
           "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") +
-            "."
+            (expect_output_to_contain_color? ? "it did not" : "it did") + "."
         else
           message =
             "Expected test to produce #{expect_output_to_contain_color? ? "colored" : "uncolored"} output, but it did not.\n\n" +
-            "Expected output to contain:\n\n" +
-            SuperDiff::Test::OutputHelpers.bookended(expected_output) +
-            "\n" +
-            "Actual output:\n\n" +
-            SuperDiff::Test::OutputHelpers.bookended(actual_output)
-
-          if ["1", "true"].include?(ENV["SHOW_DIFF"])
-            ::RSpec::Matchers::ExpectedsForMultipleDiffs.
-              from(expected_output).
-              message_with_diff(
-                message,
-                ::RSpec::Expectations.differ,
-                actual_output,
-              )
+              "Expected output to contain:\n\n" +
+              SuperDiff::Test::OutputHelpers.bookended(expected_output) + "\n" +
+              "Actual output:\n\n" +
+              SuperDiff::Test::OutputHelpers.bookended(actual_output)
+
+          if %w[1 true].include?(ENV["SHOW_DIFF"])
+            ::RSpec::Matchers::ExpectedsForMultipleDiffs.from(
+              expected_output
+            ).message_with_diff(
+              message,
+              ::RSpec::Expectations.differ,
+              actual_output
+            )
           else
             message
           end
         end
       end
 
+      def failure_message_when_negated
+        "Expected output of test not to produce output, but it did.\n\n" +
+          "Actual output:\n\n" +
+          SuperDiff::Test::OutputHelpers.bookended(actual_output)
+      end
+
       private
 
       attr_reader :expected_output, :program, :output_processor
@@ -75,15 +79,16 @@ module SuperDiff
       end
 
       def actual_output
-        @_actual_output ||= begin
-          output = program.run.output.strip
+        @_actual_output ||=
+          begin
+            output = program.run.output.strip
 
-          if output_processor
-            output.gsub!(output_processor[0], output_processor[1])
-          end
+            if output_processor
+              output.gsub!(output_processor[0], output_processor[1])
+            end
 
-          output
-        end
+            output
+          end
       end
 
       def presence_of_color_matches?

data/spec/support/integration/matchers.rb

@@ -32,6 +32,40 @@ module SuperDiff
       PassWithSinglelineFailureMessageMatcher.new
     end
 
+    RSpec::Matchers.define :failing_custom_matcher_from_dsl do |value|
+      match { false }
+
+      description do
+        "custom matcher defined via the DSL with value #{value.inspect}"
+      end
+    end
+
+    def failing_custom_matcher_from_scratch(value)
+      FailingCustomMatcherFromScratch.new(value)
+    end
+
+    class FailingCustomMatcherFromScratch
+      def initialize(value)
+        @value = value
+      end
+
+      def matches?(_)
+        false
+      end
+
+      def description
+        "custom matcher defined from scratch with value #{value.inspect}"
+      end
+
+      def failure_message
+        "Expected custom matcher not to fail, but did"
+      end
+
+      private
+
+      attr_reader :value
+    end
+
     class FailWithIndentedMultilineFailureMessageMatcher
       def matches?(_)
         false

data/spec/support/integration/test_programs/base.rb

@@ -13,12 +13,12 @@ module SuperDiff
         def initialize(
           code,
           color_enabled:,
-          configuration: {},
+          super_diff_configuration: {},
           preserve_as_whole_file: false
         )
           @code = code.strip
           @color_enabled = color_enabled
-          @configuration = configuration
+          @super_diff_configuration = super_diff_configuration
           @preserve_as_whole_file = preserve_as_whole_file
         end
 
@@ -38,7 +38,7 @@ module SuperDiff
 
         private
 
-        attr_reader :code, :configuration
+        attr_reader :code, :super_diff_configuration
 
         def color_enabled?
           @color_enabled
@@ -57,15 +57,15 @@ module SuperDiff
             else
               CommandRunner.run(
                 Shellwords.join(command),
-                env: { 'DISABLE_PRY' => 'true' },
+                env: {
+                  "DISABLE_PRY" => "true"
+                }
               )
             end
         end
 
         def command
-          if ENV["RAILS_ENV"]
-            raise "RAILS_ENV is being set somehow?!"
-          end
+          raise "RAILS_ENV is being set somehow?!" if ENV["RAILS_ENV"]
 
           if zeus_running?
             [
@@ -74,16 +74,11 @@ module SuperDiff
               color_option,
               "--no-pry",
               tempfile.to_s,
-              "--configuration",
-              JSON.generate(configuration),
+              "--super-diff-configuration",
+              JSON.generate(super_diff_configuration)
             ]
           else
-            [
-              "rspec",
-              "--options",
-              "/tmp/dummy-rspec-config",
-              tempfile.to_s,
-            ]
+            ["rspec", "--options", "/tmp/dummy-rspec-config", tempfile.to_s]
           end
         end
 
@@ -96,12 +91,13 @@ module SuperDiff
         end
 
         def tempfile
-          @_tempfile ||= begin
-            TEMP_DIRECTORY.mkpath
-            TEMP_DIRECTORY.join("integration_spec.rb").tap do |file|
-              file.write(program)
+          @_tempfile ||=
+            begin
+              TEMP_DIRECTORY.mkpath
+              TEMP_DIRECTORY
+                .join("integration_spec.rb")
+                .tap { |file| file.write(program) }
             end
-          end
         end
 
         def program
@@ -114,9 +110,8 @@ module SuperDiff
               test_plan = TestPlan.new(
                 using_outside_of_zeus: true,
                 color_enabled: #{color_enabled?.inspect},
-                configuration: #{configuration.inspect}
+                super_diff_configuration: #{super_diff_configuration.inspect}
               )
-              test_plan.boot
               #{test_plan_prelude}
               test_plan.#{test_plan_command}
 

data/spec/support/integration/test_programs/plain.rb

@@ -4,6 +4,12 @@ module SuperDiff
       class Plain < Base
         protected
 
+        def test_plan_prelude
+          <<~PRELUDE.strip
+            test_plan.boot
+          PRELUDE
+        end
+
         def test_plan_command
           "run_plain_test"
         end

data/spec/support/integration/test_programs/rspec_active_record.rb

@@ -5,7 +5,10 @@ module SuperDiff
         protected
 
         def test_plan_prelude
-          "test_plan.boot_active_record"
+          <<~PRELUDE.strip
+            test_plan.boot
+            test_plan.boot_active_record
+          PRELUDE
         end
 
         def test_plan_command

data/spec/support/integration/test_programs/rspec_active_support.rb

@@ -5,7 +5,10 @@ module SuperDiff
         protected
 
         def test_plan_prelude
-          "test_plan.boot_active_support"
+          <<~PRELUDE.strip
+            test_plan.boot
+            test_plan.boot_active_support
+          PRELUDE
         end
 
         def test_plan_command

data/spec/support/integration/test_programs/rspec_rails.rb

@@ -5,7 +5,10 @@ module SuperDiff
         protected
 
         def test_plan_prelude
-          "test_plan.boot_active_record"
+          <<~PRELUDE.strip
+            test_plan.boot
+            test_plan.boot_active_record
+          PRELUDE
         end
 
         def test_plan_command

data/spec/support/integration/test_programs/rspec_rails_engine.rb

@@ -0,0 +1,20 @@
+module SuperDiff
+  module IntegrationTests
+    module TestPrograms
+      class RspecRailsEngineWithActionController < Base
+        protected
+
+        def test_plan_prelude
+          <<~PRELUDE.strip
+            test_plan.boot
+            test_plan.boot_rails_engine_with_action_controller
+          PRELUDE
+        end
+
+        def test_plan_command
+          "run_rspec_rails_test"
+        end
+      end
+    end
+  end
+end

data/spec/support/models/active_record/person.rb

@@ -11,9 +11,11 @@ end
 
 RSpec.configure do |config|
   config.before do
-    ActiveRecord::Base.connection.create_table(:people, force: true) do |t|
-      t.string :name, null: false
-      t.integer :age, null: false
-    end
+    ActiveRecord::Base
+      .connection
+      .create_table(:people, force: true) do |t|
+        t.string :name, null: false
+        t.integer :age, null: false
+      end
   end
 end

data/spec/support/models/active_record/shipping_address.rb

@@ -11,15 +11,14 @@ end
 
 RSpec.configure do |config|
   config.before do
-    ActiveRecord::Base.connection.create_table(
-      :shipping_addresses,
-      force: true,
-    ) do |t|
-      t.string :line_1, null: false, default: ""
-      t.string :line_2, null: false, default: ""
-      t.string :city, null: false, default: ""
-      t.string :state, null: false, default: ""
-      t.string :zip, null: false, default: ""
-    end
+    ActiveRecord::Base
+      .connection
+      .create_table(:shipping_addresses, force: true) do |t|
+        t.string :line_1, null: false, default: ""
+        t.string :line_2, null: false, default: ""
+        t.string :city, null: false, default: ""
+        t.string :state, null: false, default: ""
+        t.string :zip, null: false, default: ""
+      end
   end
 end

data/spec/support/models/customer.rb

@@ -10,10 +10,8 @@ module SuperDiff
       end
 
       def ==(other)
-        other.is_a?(self.class) &&
-          other.name == name &&
-          other.shipping_address == shipping_address &&
-          other.phone == phone
+        other.is_a?(self.class) && other.name == name &&
+          other.shipping_address == shipping_address && other.phone == phone
       end
 
       def attributes_for_super_diff

data/spec/support/models/player.rb

@@ -20,12 +20,9 @@ module SuperDiff
       end
 
       def ==(other)
-        other.is_a?(self.class) &&
-          other.handle == handle &&
-          other.character == character &&
-          other.inventory == inventory &&
-          other.shields == shields &&
-          other.health == health &&
+        other.is_a?(self.class) && other.handle == handle &&
+          other.character == character && other.inventory == inventory &&
+          other.shields == shields && other.health == health &&
           other.ultimate == ultimate
       end
     end