super_diff 0.9.0 → 0.10.0

data/spec/support/shared_examples/key.rb

@@ -0,0 +1,123 @@
+shared_examples_for "a matcher that supports a toggleable key" do
+  context "if key_enabled is set to true" do
+    it "produces the key" do
+      as_both_colored_and_uncolored do |color_enabled|
+        snippet = <<~TEST.strip
+          expected = [
+            "Afghanistan",
+            "Aland Islands",
+            "Albania"
+          ]
+          actual = [
+            "Afghanistan",
+            "Aland Islands",
+            "Australia"
+          ]
+          expect(actual).to #{matcher}(expected)
+        TEST
+        program =
+          make_plain_test_program(
+            snippet,
+            color_enabled: color_enabled,
+            configuration: {
+              key_enabled: true
+            }
+          )
+
+        expected_output =
+          build_expected_output(
+            color_enabled: color_enabled,
+            snippet: %|expect(actual).to #{matcher}(expected)|,
+            newline_before_expectation: true,
+            expectation:
+              proc do
+                line do
+                  plain "Expected "
+                  actual %|["Afghanistan", "Aland Islands", "Australia"]|
+                end
+
+                line do
+                  plain "   to eq "
+                  expected %|["Afghanistan", "Aland Islands", "Albania"]|
+                end
+              end,
+            diff:
+              proc do
+                plain_line "  ["
+                plain_line %|    "Afghanistan",|
+                plain_line %|    "Aland Islands",|
+                expected_line %|-   "Albania"|
+                actual_line %|+   "Australia"|
+                plain_line "  ]"
+              end,
+            key_enabled: true
+          )
+
+        expect(program).to produce_output_when_run(expected_output).in_color(
+          color_enabled
+        )
+      end
+    end
+  end
+
+  context "if key_enabled is set to false" do
+    it "does not produce the key" do
+      as_both_colored_and_uncolored do |color_enabled|
+        snippet = <<~TEST.strip
+          expected = [
+            "Afghanistan",
+            "Aland Islands",
+            "Albania"
+          ]
+          actual = [
+            "Afghanistan",
+            "Aland Islands",
+            "Australia"
+          ]
+          expect(actual).to #{matcher}(expected)
+        TEST
+        program =
+          make_plain_test_program(
+            snippet,
+            color_enabled: color_enabled,
+            configuration: {
+              key_enabled: false
+            }
+          )
+
+        expected_output =
+          build_expected_output(
+            key_enabled: false,
+            color_enabled: color_enabled,
+            snippet: %|expect(actual).to #{matcher}(expected)|,
+            newline_before_expectation: true,
+            expectation:
+              proc do
+                line do
+                  plain "Expected "
+                  actual %|["Afghanistan", "Aland Islands", "Australia"]|
+                end
+
+                line do
+                  plain "   to eq "
+                  expected %|["Afghanistan", "Aland Islands", "Albania"]|
+                end
+              end,
+            diff:
+              proc do
+                plain_line "  ["
+                plain_line %|    "Afghanistan",|
+                plain_line %|    "Aland Islands",|
+                expected_line %|-   "Albania"|
+                actual_line %|+   "Australia"|
+                plain_line "  ]"
+              end
+          )
+
+        expect(program).to produce_output_when_run(expected_output).in_color(
+          color_enabled
+        )
+      end
+    end
+  end
+end

data/spec/support/unit/helpers.rb

@@ -3,9 +3,7 @@ module SuperDiff
     def with_configuration(configuration)
       old_configuration = SuperDiff.configuration.dup
       SuperDiff.configuration.merge!(configuration)
-      yield.tap do
-        SuperDiff.configuration.merge!(old_configuration)
-      end
+      yield.tap { SuperDiff.configuration.merge!(old_configuration) }
     end
 
     def colored(*args, **opts, &block)

data/spec/support/unit/matchers/match_output.rb

@@ -18,20 +18,19 @@ module SuperDiff
       def failure_message
         message =
           "Expected colored output to be printed, but got a mismatch.\n\n" +
-          "Expected output:\n\n" +
-          SuperDiff::Test::OutputHelpers.bookended(expected_output) +
-          "\n" +
-          "Actual output:\n\n" +
-          SuperDiff::Test::OutputHelpers.bookended(actual_output)
+            "Expected output:\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,
-            )
+        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

data/spec/unit/active_record/object_inspection_spec.rb

@@ -5,13 +5,14 @@ RSpec.describe SuperDiff, type: :unit do
     context "given an ActiveRecord object" do
       context "given as_lines: false" do
         it "returns an inspected version of the object" do
-          string = described_class.inspect_object(
-            SuperDiff::Test::Models::ActiveRecord::Person.new(
-              name: "Elliot",
-              age: 31,
-            ),
-            as_lines: false,
-          )
+          string =
+            described_class.inspect_object(
+              SuperDiff::Test::Models::ActiveRecord::Person.new(
+                name: "Elliot",
+                age: 31
+              ),
+              as_lines: false
+            )
           expect(string).to eq(
             %(#<SuperDiff::Test::Models::ActiveRecord::Person id: nil, age: 31, name: "Elliot">)
           )
@@ -20,50 +21,53 @@ RSpec.describe SuperDiff, type: :unit do
 
       context "given as_lines: true" do
         it "returns an inspected version of the object as multiple Lines" do
-          tiered_lines = described_class.inspect_object(
-            SuperDiff::Test::Models::ActiveRecord::Person.new(
-              name: "Elliot",
-              age: 31,
-            ),
-            as_lines: true,
-            type: :delete,
-            indentation_level: 1,
-          )
-          expect(tiered_lines).to match([
-            an_object_having_attributes(
-              type: :delete,
-              indentation_level: 1,
-              value: %(#<SuperDiff::Test::Models::ActiveRecord::Person {),
-              collection_bookend: :open,
-            ),
-            an_object_having_attributes(
-              type: :delete,
-              indentation_level: 2,
-              prefix: %(id: ),
-              value: %(nil),
-              add_comma: true,
-            ),
-            an_object_having_attributes(
+          tiered_lines =
+            described_class.inspect_object(
+              SuperDiff::Test::Models::ActiveRecord::Person.new(
+                name: "Elliot",
+                age: 31
+              ),
+              as_lines: true,
               type: :delete,
-              indentation_level: 2,
-              prefix: %(age: ),
-              value: %(31),
-              add_comma: true,
-            ),
-            an_object_having_attributes(
-              type: :delete,
-              indentation_level: 2,
-              prefix: %(name: ),
-              value: %("Elliot"),
-              add_comma: false,
-            ),
-            an_object_having_attributes(
-              type: :delete,
-              indentation_level: 1,
-              value: %(}>),
-              collection_bookend: :close,
-            ),
-          ])
+              indentation_level: 1
+            )
+          expect(tiered_lines).to match(
+            [
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 1,
+                value: "#<SuperDiff::Test::Models::ActiveRecord::Person {",
+                collection_bookend: :open
+              ),
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 2,
+                prefix: "id: ",
+                value: "nil",
+                add_comma: true
+              ),
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 2,
+                prefix: "age: ",
+                value: "31",
+                add_comma: true
+              ),
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 2,
+                prefix: "name: ",
+                value: %("Elliot"),
+                add_comma: false
+              ),
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 1,
+                value: "}>",
+                collection_bookend: :close
+              )
+            ]
+          )
         end
       end
     end
@@ -73,17 +77,18 @@ RSpec.describe SuperDiff, type: :unit do
         it "returns an inspected version of the Relation" do
           SuperDiff::Test::Models::ActiveRecord::Person.create!(
             name: "Marty",
-            age: 19,
+            age: 19
           )
           SuperDiff::Test::Models::ActiveRecord::Person.create!(
             name: "Jennifer",
-            age: 17,
+            age: 17
           )
 
-          string = described_class.inspect_object(
-            SuperDiff::Test::Models::ActiveRecord::Person.all,
-            as_lines: false,
-          )
+          string =
+            described_class.inspect_object(
+              SuperDiff::Test::Models::ActiveRecord::Person.all,
+              as_lines: false
+            )
 
           expect(string).to eq(
             %(#<ActiveRecord::Relation [#<SuperDiff::Test::Models::ActiveRecord::Person id: 1, age: 19, name: "Marty">, #<SuperDiff::Test::Models::ActiveRecord::Person id: 2, age: 17, name: "Jennifer">]>)
@@ -95,100 +100,103 @@ RSpec.describe SuperDiff, type: :unit do
         it "returns an inspected version of the Relation as multiple Lines" do
           SuperDiff::Test::Models::ActiveRecord::Person.create!(
             name: "Marty",
-            age: 19,
+            age: 19
           )
           SuperDiff::Test::Models::ActiveRecord::Person.create!(
             name: "Jennifer",
-            age: 17,
+            age: 17
           )
 
-          tiered_lines = described_class.inspect_object(
-            SuperDiff::Test::Models::ActiveRecord::Person.all,
-            as_lines: true,
-            type: :delete,
-            indentation_level: 1,
-          )
-
-          expect(tiered_lines).to match([
-            an_object_having_attributes(
-              type: :delete,
-              indentation_level: 1,
-              value: %(#<ActiveRecord::Relation [),
-              collection_bookend: :open,
-            ),
-            an_object_having_attributes(
-              type: :delete,
-              indentation_level: 2,
-              value: %(#<SuperDiff::Test::Models::ActiveRecord::Person {),
-              collection_bookend: :open,
-            ),
-            an_object_having_attributes(
-              type: :delete,
-              indentation_level: 3,
-              prefix: %(id: ),
-              value: %(1),
-              add_comma: true,
-            ),
-            an_object_having_attributes(
-              type: :delete,
-              indentation_level: 3,
-              prefix: %(age: ),
-              value: %(19),
-              add_comma: true,
-            ),
-            an_object_having_attributes(
-              type: :delete,
-              indentation_level: 3,
-              prefix: %(name: ),
-              value: %("Marty"),
-              add_comma: false,
-            ),
-            an_object_having_attributes(
-              type: :delete,
-              indentation_level: 2,
-              value: %(}>),
-              collection_bookend: :close,
-            ),
-            an_object_having_attributes(
+          tiered_lines =
+            described_class.inspect_object(
+              SuperDiff::Test::Models::ActiveRecord::Person.all,
+              as_lines: true,
               type: :delete,
-              indentation_level: 2,
-              value: %(#<SuperDiff::Test::Models::ActiveRecord::Person {),
-              collection_bookend: :open,
-            ),
-            an_object_having_attributes(
-              type: :delete,
-              indentation_level: 3,
-              prefix: %(id: ),
-              value: %(2),
-              add_comma: true,
-            ),
-            an_object_having_attributes(
-              type: :delete,
-              indentation_level: 3,
-              prefix: %(age: ),
-              value: %(17),
-              add_comma: true,
-            ),
-            an_object_having_attributes(
-              type: :delete,
-              indentation_level: 3,
-              prefix: %(name: ),
-              value: %("Jennifer"),
-              add_comma: false,
-            ),
-            an_object_having_attributes(
-              type: :delete,
-              indentation_level: 2,
-              value: %(}>),
-              collection_bookend: :close,
-            ),
-            an_object_having_attributes(
-              type: :delete,
-              indentation_level: 1,
-              value: %(]>),
-              collection_bookend: :close,
-            ),
-          ])
+              indentation_level: 1
+            )
+
+          expect(tiered_lines).to match(
+            [
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 1,
+                value: "#<ActiveRecord::Relation [",
+                collection_bookend: :open
+              ),
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 2,
+                value: "#<SuperDiff::Test::Models::ActiveRecord::Person {",
+                collection_bookend: :open
+              ),
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 3,
+                prefix: "id: ",
+                value: "1",
+                add_comma: true
+              ),
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 3,
+                prefix: "age: ",
+                value: "19",
+                add_comma: true
+              ),
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 3,
+                prefix: "name: ",
+                value: %("Marty"),
+                add_comma: false
+              ),
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 2,
+                value: "}>",
+                collection_bookend: :close
+              ),
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 2,
+                value: "#<SuperDiff::Test::Models::ActiveRecord::Person {",
+                collection_bookend: :open
+              ),
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 3,
+                prefix: "id: ",
+                value: "2",
+                add_comma: true
+              ),
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 3,
+                prefix: "age: ",
+                value: "17",
+                add_comma: true
+              ),
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 3,
+                prefix: "name: ",
+                value: %("Jennifer"),
+                add_comma: false
+              ),
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 2,
+                value: "}>",
+                collection_bookend: :close
+              ),
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 1,
+                value: "]>",
+                collection_bookend: :close
+              )
+            ]
+          )
         end
       end
     end
@@ -196,76 +204,84 @@ RSpec.describe SuperDiff, type: :unit do
     context "given a HashWithIndifferentAccess" do
       context "given as_lines: false" do
         it "returns an inspected version of the object" do
-          string = described_class.inspect_object(
-            HashWithIndifferentAccess.new({
-              line_1: "123 Main St.",
-              city: "Hill Valley",
-              state: "CA",
-              zip: "90382",
-            }),
-            as_lines: false,
-          )
+          string =
+            described_class.inspect_object(
+              HashWithIndifferentAccess.new(
+                {
+                  line_1: "123 Main St.",
+                  city: "Hill Valley",
+                  state: "CA",
+                  zip: "90382"
+                }
+              ),
+              as_lines: false
+            )
           expect(string).to eq(
-            %(#<HashWithIndifferentAccess { "line_1" => "123 Main St.", "city" => "Hill Valley", "state" => "CA", "zip" => "90382" }>),
+            %(#<HashWithIndifferentAccess { "line_1" => "123 Main St.", "city" => "Hill Valley", "state" => "CA", "zip" => "90382" }>)
           )
         end
       end
 
       context "given as_lines: true" do
         it "returns an inspected version of the object as multiple Lines" do
-          tiered_lines = described_class.inspect_object(
-            HashWithIndifferentAccess.new({
-              line_1: "123 Main St.",
-              city: "Hill Valley",
-              state: "CA",
-              zip: "90382",
-            }),
-            as_lines: true,
-            type: :delete,
-            indentation_level: 1,
-          )
-          expect(tiered_lines).to match([
-            an_object_having_attributes(
-              type: :delete,
-              indentation_level: 1,
-              value: %(#<HashWithIndifferentAccess {),
-              collection_bookend: :open,
-            ),
-            an_object_having_attributes(
-              type: :delete,
-              indentation_level: 2,
-              prefix: %("line_1" => ),
-              value: %("123 Main St."),
-              add_comma: true,
-            ),
-            an_object_having_attributes(
-              type: :delete,
-              indentation_level: 2,
-              prefix: %("city" => ),
-              value: %("Hill Valley"),
-              add_comma: true,
-            ),
-            an_object_having_attributes(
+          tiered_lines =
+            described_class.inspect_object(
+              HashWithIndifferentAccess.new(
+                {
+                  line_1: "123 Main St.",
+                  city: "Hill Valley",
+                  state: "CA",
+                  zip: "90382"
+                }
+              ),
+              as_lines: true,
               type: :delete,
-              indentation_level: 2,
-              prefix: %("state" => ),
-              value: %("CA"),
-              add_comma: true,
-            ),
-            an_object_having_attributes(
-              type: :delete,
-              indentation_level: 2,
-              prefix: %("zip" => ),
-              value: %("90382"),
-              add_comma: false,
-            ),
-            an_object_having_attributes(
-              type: :delete,
-              indentation_level: 1,
-              value: %(}>),
-              collection_bookend: :close,
-            ),
-          ])
+              indentation_level: 1
+            )
+          expect(tiered_lines).to match(
+            [
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 1,
+                value: "#<HashWithIndifferentAccess {",
+                collection_bookend: :open
+              ),
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 2,
+                prefix: %("line_1" => ),
+                value: %("123 Main St."),
+                add_comma: true
+              ),
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 2,
+                prefix: %("city" => ),
+                value: %("Hill Valley"),
+                add_comma: true
+              ),
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 2,
+                prefix: %("state" => ),
+                value: %("CA"),
+                add_comma: true
+              ),
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 2,
+                prefix: %("zip" => ),
+                value: %("90382"),
+                add_comma: false
+              ),
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 1,
+                value: "}>",
+                collection_bookend: :close
+              )
+            ]
+          )
         end
       end
     end