super_diff 0.3.0 → 0.5.1

data/spec/support/command_runner.rb

@@ -120,6 +120,9 @@ Output:
     @env = extract_env_from(@options)
 
     @process = ChildProcess.build(*command)
+    # @env.each do |key, value|
+      # @process.environment[key] = value
+    # end
     @process.io.stdout = @process.io.stderr = @writer
 
     @wrapper = -> (block) { block.call }

data/spec/support/integration/helpers.rb

@@ -8,97 +8,24 @@ module SuperDiff
       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
+    def make_plain_test_program(
+      test,
+      color_enabled:,
+      preserve_as_whole_file: false
+    )
+      TestPrograms::Plain.new(
+        test,
+        color_enabled: color_enabled,
+        preserve_as_whole_file: preserve_as_whole_file,
+      )
     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
+      TestPrograms::RspecActiveRecord.new(test, color_enabled: color_enabled)
     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
+      TestPrograms::RspecRails.new(test, color_enabled: color_enabled)
     end
 
     def build_expected_output(
@@ -106,6 +33,7 @@ module SuperDiff
       snippet:,
       expectation:,
       newline_before_expectation: false,
+      indentation: 7,
       diff: nil
     )
       colored(color_enabled: color_enabled) do
@@ -122,7 +50,7 @@ module SuperDiff
           newline
         end
 
-        indent by: 7 do
+        indent by: indentation do
           evaluate_block(&expectation)
 
           if diff
@@ -171,9 +99,5 @@ module SuperDiff
     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.rb

@@ -0,0 +1,143 @@
+module SuperDiff
+  module IntegrationTests
+    def fail_with_indented_multiline_failure_message
+      FailWithIndentedMultilineFailureMessageMatcher.new
+    end
+
+    def fail_with_paragraphed_failure_message
+      FailWithParagraphedFailureMessageMatcher.new
+    end
+
+    def fail_with_non_indented_multiline_failure_message
+      FailWithNonIndentedMultilineFailureMessageMatcher.new
+    end
+
+    def fail_with_singleline_failure_message
+      FailWithSinglelineFailureMessageMatcher.new
+    end
+
+    def pass_with_indented_multiline_failure_message
+      PassWithIndentedMultilineFailureMessageMatcher.new
+    end
+
+    def pass_with_paragraphed_failure_message
+      PassWithParagraphedFailureMessageMatcher.new
+    end
+
+    def pass_with_non_indented_multiline_failure_message
+      PassWithNonIndentedMultilineFailureMessageMatcher.new
+    end
+
+    def pass_with_singleline_failure_message
+      PassWithSinglelineFailureMessageMatcher.new
+    end
+
+    class FailWithIndentedMultilineFailureMessageMatcher
+      def matches?(_)
+        false
+      end
+
+      def failure_message
+        <<-MESSAGE
+This is a message that spans multiple lines.
+Here is the next line.
+  This part is indented, for whatever reason. It just kinda keeps
+  going until we finish saying whatever it is we want to say.
+        MESSAGE
+      end
+    end
+
+    class FailWithParagraphedFailureMessageMatcher
+      def matches?(_)
+        false
+      end
+
+      def failure_message
+        <<-MESSAGE
+This is a message that spans multiple paragraphs.
+
+Here is the next paragraph.
+        MESSAGE
+      end
+    end
+
+    class FailWithNonIndentedMultilineFailureMessageMatcher
+      def matches?(_)
+        false
+      end
+
+      def failure_message
+        <<-MESSAGE
+This is a message that spans multiple lines.
+Here is the next line.
+        MESSAGE
+      end
+    end
+
+    class FailWithSinglelineFailureMessageMatcher
+      def matches?(_)
+        false
+      end
+
+      def failure_message
+        <<-MESSAGE
+This is a message that spans only one line.
+        MESSAGE
+      end
+    end
+
+    class PassWithIndentedMultilineFailureMessageMatcher
+      def does_not_match?(_)
+        false
+      end
+
+      def failure_message_when_negated
+        <<-MESSAGE
+This is a message that spans multiple lines.
+Here is the next line.
+  This part is indented, for whatever reason. It just kinda keeps
+  going until we finish saying whatever it is we want to say.
+        MESSAGE
+      end
+    end
+
+    class PassWithParagraphedFailureMessageMatcher
+      def does_not_match?(_)
+        false
+      end
+
+      def failure_message_when_negated
+        <<-MESSAGE
+This is a message that spans multiple paragraphs.
+
+Here is the next paragraph.
+        MESSAGE
+      end
+    end
+
+    class PassWithNonIndentedMultilineFailureMessageMatcher
+      def does_not_match?(_)
+        false
+      end
+
+      def failure_message_when_negated
+        <<-MESSAGE
+This is a message that spans multiple lines.
+Here is the next line.
+        MESSAGE
+      end
+    end
+
+    class PassWithSinglelineFailureMessageMatcher
+      def does_not_match?(_)
+        false
+      end
+
+      def failure_message_when_negated
+        <<-MESSAGE
+This is a message that spans only one line.
+        MESSAGE
+      end
+    end
+  end
+end

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

@@ -5,11 +5,8 @@ module SuperDiff
     end
 
     class ProduceOutputWhenRunMatcher
-      PROJECT_DIRECTORY = Pathname.new("../../../../../").expand_path(__FILE__)
-      TEMP_DIRECTORY = PROJECT_DIRECTORY.join("tmp")
-
       def initialize(expected_output)
-        @expected_output = expected_output.to_s.strip
+        @expected_output = expected_output.to_s
         @output_processor = nil
         @expect_output_to_contain_color = nil
       end
@@ -25,9 +22,7 @@ module SuperDiff
       end
 
       def matches?(program)
-        @program = program.strip
-
-        TEMP_DIRECTORY.mkpath
+        @program = program
 
         output_matches? && presence_of_color_matches?
       end
@@ -48,13 +43,17 @@ module SuperDiff
             "Actual output:\n\n" +
             CommandRunner::OutputHelpers.bookended(actual_output)
 
-          ::RSpec::Matchers::ExpectedsForMultipleDiffs.
-            from(expected_output).
-            message_with_diff(
-              message,
-              ::RSpec::Expectations.differ,
-              actual_output,
-            )
+          if ["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
 
@@ -77,7 +76,7 @@ module SuperDiff
 
       def actual_output
         @_actual_output ||= begin
-          output = run_command.output.strip
+          output = program.run.output.strip
 
           if output_processor
             output.gsub!(output_processor[0], output_processor[1])
@@ -87,20 +86,6 @@ module SuperDiff
         end
       end
 
-      def run_command
-        CommandRunner.run(
-          "rspec --options /tmp/dummy-rspec-config",
-          tempfile.to_s,
-          env: { "DISABLE_PRY" => "true" },
-        )
-      end
-
-      def tempfile
-        @_tempfile =
-          TEMP_DIRECTORY.join("integration_spec.rb").
-            tap { |tempfile| tempfile.write(program) }
-      end
-
       def presence_of_color_matches?
         @expect_output_to_contain_color.nil? ||
           output_has_color? == expect_output_to_contain_color?

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

@@ -0,0 +1,120 @@
+module SuperDiff
+  module IntegrationTests
+    module TestPrograms
+      class Base
+        extend AttrExtras.mixin
+
+        PROJECT_DIRECTORY = Pathname.new("../../../..").expand_path(__dir__)
+        TEMP_DIRECTORY = PROJECT_DIRECTORY.join("tmp")
+
+        attr_private :code, :color_enabled, :preserve_as_whole_file
+
+        def initialize(code, color_enabled:, preserve_as_whole_file: false)
+          @code = code.strip
+          @color_enabled = color_enabled
+          @preserve_as_whole_file = preserve_as_whole_file
+        end
+
+        def run
+          result_of_command
+        end
+
+        protected
+
+        def test_plan_prelude
+          ""
+        end
+
+        def test_plan_command
+          raise NotImplementedError
+        end
+
+        private
+
+        attr_query :color_enabled?
+        attr_query :preserve_as_whole_file?
+
+        def result_of_command
+          @_result_of_command ||=
+            if zeus_running?
+              Bundler.with_unbundled_env { CommandRunner.run(*command) }
+            else
+              CommandRunner.run(*command)
+            end
+        end
+
+        def command
+          if ENV["RAILS_ENV"]
+            raise "RAILS_ENV is being set somehow?!"
+          end
+
+          if zeus_running?
+            ["zeus", test_plan_command, color_option, tempfile.to_s]
+          else
+            [
+              "rspec",
+              "--options",
+              "/tmp/dummy-rspec-config",
+              tempfile.to_s,
+            ]
+          end
+        end
+
+        def zeus_running?
+          PROJECT_DIRECTORY.join(".zeus.sock").exist?
+        end
+
+        def color_option
+          color_enabled ? "--color" : "--no-color"
+        end
+
+        def tempfile
+          @_tempfile ||= begin
+            TEMP_DIRECTORY.mkpath
+            TEMP_DIRECTORY.join("integration_spec.rb").tap do |file|
+              file.write(program)
+            end
+          end
+        end
+
+        def program
+          if zeus_running?
+            minimal_program
+          else
+            <<~PROGRAM
+              require "#{PROJECT_DIRECTORY.join("support/test_plan.rb")}"
+
+              test_plan = TestPlan.new(
+                using_outside_of_zeus: true,
+                color_enabled: #{color_enabled?}
+              )
+              test_plan.boot
+              #{test_plan_prelude}
+              test_plan.#{test_plan_command}
+
+              #{minimal_program}
+            PROGRAM
+          end
+        end
+
+        def minimal_program
+          if preserve_as_whole_file?
+            code
+          else
+            <<~PROGRAM
+              RSpec.describe "test" do
+                it "passes" do
+                  #{reindent(code, level: 2)}
+                end
+              end
+            PROGRAM
+          end
+        end
+
+        def reindent(code, level: 0)
+          code.strip.split("\n").map { |line| ("  " * level) + line }.join("\n")
+        end
+      end
+    end
+  end
+end