super_diff 0.1.0 → 0.2.0

data/spec/support/models/a.rb

@@ -0,0 +1,11 @@
+class A
+  attr_reader :name
+
+  def initialize(name)
+    @name = name
+  end
+
+  def attributes_for_super_diff
+    { name: name }
+  end
+end

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

@@ -0,0 +1,26 @@
+module SuperDiff
+  module Test
+    module Models
+      module ActiveRecord
+        class Person < ::ActiveRecord::Base
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.connection.create_table(:people) do |t|
+  t.string :name, null: false
+  t.integer :age, null: false
+end
+
+RSpec.configure do |config|
+  config.before do
+    ActiveRecord::Base.connection.execute(
+      "DELETE FROM people",
+    )
+    ActiveRecord::Base.connection.execute(
+      "DELETE FROM sqlite_sequence WHERE name='people'",
+    )
+  end
+end

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

@@ -0,0 +1,29 @@
+module SuperDiff
+  module Test
+    module Models
+      module ActiveRecord
+        class ShippingAddress < ::ActiveRecord::Base
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.connection.create_table(:shipping_addresses) 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
+
+RSpec.configure do |config|
+  config.before do
+    ActiveRecord::Base.connection.execute(
+      "DELETE FROM shipping_addresses",
+    )
+    ActiveRecord::Base.connection.execute(
+      "DELETE FROM sqlite_sequence WHERE name='shipping_addresses'",
+    )
+  end
+end

data/spec/support/models/customer.rb

@@ -0,0 +1,24 @@
+module SuperDiff
+  module Test
+    class Customer
+      attr_reader :name, :shipping_address, :phone
+
+      def initialize(name:, shipping_address:, phone:)
+        @name = name
+        @shipping_address = shipping_address
+        @phone = phone
+      end
+
+      def ==(other)
+        other.is_a?(self.class) &&
+          other.name == name &&
+          other.shipping_address == shipping_address &&
+          other.phone == phone
+      end
+
+      def attributes_for_super_diff
+        { name: name, shipping_address: shipping_address, phone: phone }
+      end
+    end
+  end
+end

data/spec/support/models/empty_class.rb

@@ -0,0 +1,6 @@
+module SuperDiff
+  module Test
+    class EmptyClass
+    end
+  end
+end

data/spec/support/models/item.rb

@@ -0,0 +1,10 @@
+module SuperDiff
+  module Test
+    class Item
+      def initialize(name:, quantity:)
+        @name = name
+        @quantity = quantity
+      end
+    end
+  end
+end

data/spec/support/models/order.rb

@@ -0,0 +1,9 @@
+module SuperDiff
+  module Test
+    class Order
+      def initialize(items)
+        @items = items
+      end
+    end
+  end
+end

data/spec/support/models/person.rb

@@ -0,0 +1,20 @@
+module SuperDiff
+  module Test
+    class Person
+      attr_reader :name, :age
+
+      def initialize(name:, age:)
+        @name = name
+        @age = age
+      end
+
+      def ==(other)
+        other.is_a?(self.class) && other.name == name && other.age == age
+      end
+
+      def attributes_for_super_diff
+        { name: name, age: age }
+      end
+    end
+  end
+end

data/spec/support/models/player.rb

@@ -0,0 +1,33 @@
+module SuperDiff
+  module Test
+    class Player
+      attr_reader :handle, :character, :inventory, :shields, :health, :ultimate
+
+      def initialize(
+        handle:,
+        character:,
+        inventory:,
+        shields:,
+        health:,
+        ultimate:
+      )
+        @handle = handle
+        @character = character
+        @inventory = inventory
+        @shields = shields
+        @health = health
+        @ultimate = ultimate
+      end
+
+      def ==(other)
+        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
+  end
+end

data/spec/support/models/shipping_address.rb

@@ -0,0 +1,34 @@
+module SuperDiff
+  module Test
+    class ShippingAddress
+      attr_reader :line_1, :line_2, :city, :state, :zip
+
+      def initialize(line_1:, line_2:, city:, state:, zip:)
+        @line_1 = line_1
+        @line_2 = line_2
+        @city = city
+        @state = state
+        @zip = zip
+      end
+
+      def ==(other)
+        other.is_a?(self.class) &&
+          other.line_1 == line_1 &&
+          other.line_2 == line_2 &&
+          other.city == city &&
+          other.state == state &&
+          other.zip == zip
+      end
+
+      def attributes_for_super_diff
+        {
+          line_1: line_1,
+          line_2: line_2,
+          city: city,
+          state: state,
+          zip: zip
+        }
+      end
+    end
+  end
+end

data/spec/support/ruby_versions.rb

@@ -0,0 +1,7 @@
+module SuperDiff
+  module Test
+    def self.jruby?
+      defined?(JRUBY_VERSION)
+    end
+  end
+end

data/spec/support/shared_examples/active_record.rb

@@ -0,0 +1,338 @@
+shared_examples_for "integration with ActiveRecord" do
+  describe "and RSpec's #eq matcher" do
+    context "when comparing two instances of the same ActiveRecord model" do
+      it "produces the correct output" do
+        as_both_colored_and_uncolored do |color_enabled|
+          snippet = <<~TEST.strip
+            expected = SuperDiff::Test::Models::ActiveRecord::ShippingAddress.new(
+              line_1: "123 Main St.",
+              city: "Hill Valley",
+              state: "CA",
+              zip: "90382",
+            )
+            actual = SuperDiff::Test::Models::ActiveRecord::ShippingAddress.new(
+              line_1: "456 Ponderosa Ct.",
+              city: "Oakland",
+              state: "CA",
+              zip: "91234",
+            )
+            expect(actual).to eq(expected)
+          TEST
+          program = make_program(snippet, color_enabled: color_enabled)
+
+          expected_output = build_expected_output(
+            color_enabled: color_enabled,
+            snippet: "expect(actual).to eq(expected)",
+            expectation: proc {
+              line do
+                plain "Expected "
+                beta %|#<SuperDiff::Test::Models::ActiveRecord::ShippingAddress id: nil, city: "Oakland", line_1: "456 Ponderosa Ct.", line_2: "", state: "CA", zip: "91234">|
+              end
+
+              line do
+                plain "   to eq "
+                alpha %|#<SuperDiff::Test::Models::ActiveRecord::ShippingAddress id: nil, city: "Hill Valley", line_1: "123 Main St.", line_2: "", state: "CA", zip: "90382">|
+              end
+            },
+            diff: proc {
+              plain_line %|  #<SuperDiff::Test::Models::ActiveRecord::ShippingAddress {|
+              plain_line %|    id: nil,|
+              alpha_line %|-   city: "Hill Valley",|
+              beta_line %|+   city: "Oakland",|
+              alpha_line %|-   line_1: "123 Main St.",|
+              beta_line %|+   line_1: "456 Ponderosa Ct.",|
+              plain_line %|    line_2: "",|
+              plain_line %|    state: "CA",|
+              alpha_line %|-   zip: "90382"|
+              beta_line %|+   zip: "91234"|
+              plain_line %|  }>|
+            },
+          )
+
+          expect(program).
+            to produce_output_when_run(expected_output).
+            in_color(color_enabled)
+        end
+      end
+    end
+
+    context "when comparing instances of two different ActiveRecord models" do
+      it "produces the correct output" do
+        as_both_colored_and_uncolored do |color_enabled|
+          snippet = <<~TEST.strip
+            expected = SuperDiff::Test::Models::ActiveRecord::ShippingAddress.new(
+              line_1: "123 Main St.",
+              city: "Hill Valley",
+              state: "CA",
+              zip: "90382",
+            )
+            actual = SuperDiff::Test::Models::ActiveRecord::Person.new(
+              name: "Elliot",
+              age: 31,
+            )
+            expect(actual).to eq(expected)
+          TEST
+          program = make_program(snippet, color_enabled: color_enabled)
+
+          expected_output = build_expected_output(
+            color_enabled: color_enabled,
+            snippet: "expect(actual).to eq(expected)",
+            newline_before_expectation: true,
+            expectation: proc {
+              line do
+                plain "Expected "
+                beta %|#<SuperDiff::Test::Models::ActiveRecord::Person id: nil, age: 31, name: "Elliot">|
+              end
+
+              line do
+                plain "   to eq "
+                alpha %|#<SuperDiff::Test::Models::ActiveRecord::ShippingAddress id: nil, city: "Hill Valley", line_1: "123 Main St.", line_2: "", state: "CA", zip: "90382">|
+              end
+            },
+          )
+
+          expect(program).
+            to produce_output_when_run(expected_output).
+            in_color(color_enabled)
+        end
+      end
+    end
+
+    context "when comparing an ActiveRecord object with nothing" do
+      it "produces the correct output" do
+        as_both_colored_and_uncolored do |color_enabled|
+          snippet = <<~TEST.strip
+            expected = SuperDiff::Test::Models::ActiveRecord::ShippingAddress.new(
+              line_1: "123 Main St.",
+              city: "Hill Valley",
+              state: "CA",
+              zip: "90382"
+            )
+            actual = nil
+            expect(actual).to eq(expected)
+          TEST
+          program = make_program(snippet, color_enabled: color_enabled)
+
+          expected_output = build_expected_output(
+            color_enabled: color_enabled,
+            snippet: "expect(actual).to eq(expected)",
+            newline_before_expectation: true,
+            expectation: proc {
+              line do
+                plain "Expected "
+                beta %|nil|
+              end
+
+              line do
+                plain "   to eq "
+                alpha %|#<SuperDiff::Test::Models::ActiveRecord::ShippingAddress id: nil, city: "Hill Valley", line_1: "123 Main St.", line_2: "", state: "CA", zip: "90382">|
+              end
+            },
+          )
+
+          expect(program).
+            to produce_output_when_run(expected_output).
+            in_color(color_enabled)
+        end
+      end
+    end
+
+    context "when comparing two data structures that contain two instances of the same ActiveRecord model" do
+      it "produces the correct output" do
+        as_both_colored_and_uncolored do |color_enabled|
+          snippet = <<~TEST.strip
+            expected = {
+              name: "Marty McFly",
+              shipping_address: SuperDiff::Test::Models::ActiveRecord::ShippingAddress.new(
+                line_1: "123 Main St.",
+                city: "Hill Valley",
+                state: "CA",
+                zip: "90382",
+              )
+            }
+            actual = {
+              name: "Marty McFly",
+              shipping_address: SuperDiff::Test::Models::ActiveRecord::ShippingAddress.new(
+                line_1: "456 Ponderosa Ct.",
+                city: "Oakland",
+                state: "CA",
+                zip: "91234",
+              )
+            }
+            expect(actual).to eq(expected)
+          TEST
+          program = make_program(snippet, color_enabled: color_enabled)
+
+          expected_output = build_expected_output(
+            color_enabled: color_enabled,
+            snippet: "expect(actual).to eq(expected)",
+            expectation: proc {
+              line do
+                plain "Expected "
+                beta %|{ name: "Marty McFly", shipping_address: #<SuperDiff::Test::Models::ActiveRecord::ShippingAddress id: nil, city: "Oakland", line_1: "456 Ponderosa Ct.", line_2: "", state: "CA", zip: "91234"> }|
+              end
+
+              line do
+                plain "   to eq "
+                alpha %|{ name: "Marty McFly", shipping_address: #<SuperDiff::Test::Models::ActiveRecord::ShippingAddress id: nil, city: "Hill Valley", line_1: "123 Main St.", line_2: "", state: "CA", zip: "90382"> }|
+              end
+            },
+            diff: proc {
+              plain_line %|  {|
+              plain_line %|    name: "Marty McFly",|
+              plain_line %|    shipping_address: #<SuperDiff::Test::Models::ActiveRecord::ShippingAddress {|
+              plain_line %|      id: nil,|
+              alpha_line %|-     city: "Hill Valley",|
+              beta_line %|+     city: "Oakland",|
+              alpha_line %|-     line_1: "123 Main St.",|
+              beta_line %|+     line_1: "456 Ponderosa Ct.",|
+              plain_line %|      line_2: "",|
+              plain_line %|      state: "CA",|
+              alpha_line %|-     zip: "90382"|
+              beta_line %|+     zip: "91234"|
+              plain_line %|    }>|
+              plain_line %|  }|
+            },
+          )
+
+          expect(program).
+            to produce_output_when_run(expected_output).
+            in_color(color_enabled)
+        end
+      end
+    end
+
+    context "when comparing two data structures that contain instances of two different ActiveRecord models" do
+      it "produces the correct output" do
+        as_both_colored_and_uncolored do |color_enabled|
+          snippet = <<~TEST.strip
+            expected = {
+              name: "Marty McFly",
+              shipping_address: SuperDiff::Test::Models::ActiveRecord::ShippingAddress.new(
+                line_1: "123 Main St.",
+                city: "Hill Valley",
+                state: "CA",
+                zip: "90382",
+              )
+            }
+            actual = {
+              name: "Marty McFly",
+              shipping_address: SuperDiff::Test::Models::ActiveRecord::Person.new(
+                name: "Elliot",
+                age: 31,
+              )
+            }
+            expect(actual).to eq(expected)
+          TEST
+          program = make_program(snippet, color_enabled: color_enabled)
+
+          expected_output = build_expected_output(
+            color_enabled: color_enabled,
+            snippet: "expect(actual).to eq(expected)",
+            expectation: proc {
+              line do
+                plain "Expected "
+                beta %|{ name: "Marty McFly", shipping_address: #<SuperDiff::Test::Models::ActiveRecord::Person id: nil, age: 31, name: "Elliot"> }|
+              end
+
+              line do
+                plain "   to eq "
+                alpha %|{ name: "Marty McFly", shipping_address: #<SuperDiff::Test::Models::ActiveRecord::ShippingAddress id: nil, city: "Hill Valley", line_1: "123 Main St.", line_2: "", state: "CA", zip: "90382"> }|
+              end
+            },
+            diff: proc {
+              plain_line %|  {|
+              plain_line %|    name: "Marty McFly",|
+              alpha_line %|-   shipping_address: #<SuperDiff::Test::Models::ActiveRecord::ShippingAddress {|
+              alpha_line %|-     id: nil,|
+              alpha_line %|-     city: "Hill Valley",|
+              alpha_line %|-     line_1: "123 Main St.",|
+              alpha_line %|-     line_2: "",|
+              alpha_line %|-     state: "CA",|
+              alpha_line %|-     zip: "90382"|
+              alpha_line %|-   }>|
+              beta_line %|+   shipping_address: #<SuperDiff::Test::Models::ActiveRecord::Person {|
+              beta_line %|+     id: nil,|
+              beta_line %|+     age: 31,|
+              beta_line %|+     name: "Elliot"|
+              beta_line %|+   }>|
+              plain_line %|  }|
+            },
+          )
+
+          expect(program).
+            to produce_output_when_run(expected_output).
+            in_color(color_enabled)
+        end
+      end
+    end
+
+    context "when comparing an ActiveRecord::Relation object with an array" do
+      it "produces the correct output" do
+        as_both_colored_and_uncolored do |color_enabled|
+          snippet = <<~TEST.strip
+            SuperDiff::Test::Models::ActiveRecord::ShippingAddress.delete_all
+            shipping_addresses = [
+              SuperDiff::Test::Models::ActiveRecord::ShippingAddress.create!(
+                line_1: "123 Main St.",
+                city: "Hill Valley",
+                state: "CA",
+                zip: "90382",
+              ),
+              SuperDiff::Test::Models::ActiveRecord::ShippingAddress.create!(
+                line_1: "456 Ponderosa Ct.",
+                city: "Oakland",
+                state: "CA",
+                zip: "91234",
+              )
+            ]
+            expected = [shipping_addresses.first]
+            actual = SuperDiff::Test::Models::ActiveRecord::ShippingAddress.all
+            expect(actual).to eq(expected)
+          TEST
+          program = make_program(snippet, color_enabled: color_enabled)
+
+          expected_output = build_expected_output(
+            color_enabled: color_enabled,
+            snippet: "expect(actual).to eq(expected)",
+            expectation: proc {
+              line do
+                plain "Expected "
+                beta %|#<ActiveRecord::Relation [#<SuperDiff::Test::Models::ActiveRecord::ShippingAddress id: 1, city: "Hill Valley", line_1: "123 Main St.", line_2: "", state: "CA", zip: "90382">, #<SuperDiff::Test::Models::ActiveRecord::ShippingAddress id: 2, city: "Oakland", line_1: "456 Ponderosa Ct.", line_2: "", state: "CA", zip: "91234">]>|
+              end
+
+              line do
+                plain "   to eq "
+                alpha %|[#<SuperDiff::Test::Models::ActiveRecord::ShippingAddress id: 1, city: "Hill Valley", line_1: "123 Main St.", line_2: "", state: "CA", zip: "90382">]|
+              end
+            },
+            diff: proc {
+              plain_line %|  #<ActiveRecord::Relation [|
+              plain_line %|    #<SuperDiff::Test::Models::ActiveRecord::ShippingAddress {|
+              plain_line %|      id: 1,|
+              plain_line %|      city: "Hill Valley",|
+              plain_line %|      line_1: "123 Main St.",|
+              plain_line %|      line_2: "",|
+              plain_line %|      state: "CA",|
+              plain_line %|      zip: "90382"|
+              plain_line %|    }>,|
+              beta_line %|+   #<SuperDiff::Test::Models::ActiveRecord::ShippingAddress {|
+              beta_line %|+     id: 2,|
+              beta_line %|+     city: "Oakland",|
+              beta_line %|+     line_1: "456 Ponderosa Ct.",|
+              beta_line %|+     line_2: "",|
+              beta_line %|+     state: "CA",|
+              beta_line %|+     zip: "91234"|
+              beta_line %|+   }>|
+              plain_line %|  ]>|
+            },
+          )
+
+          expect(program).
+            to produce_output_when_run(expected_output).
+            in_color(color_enabled)
+        end
+      end
+    end
+  end
+end