super_diff 0.12.1 → 0.13.0

data/spec/spec_helper.rb

@@ -68,6 +68,7 @@ RSpec.configure do |config|
   unless defined?(ActiveSupport)
     config.filter_run_excluding active_support: true
   end
+  config.filter_run_excluding with_superdiff_rspec: false
 
   config.order = :random
   Kernel.srand config.seed

data/spec/support/models/point.rb

@@ -0,0 +1,7 @@
+if defined?(Data)
+  module SuperDiff
+    module Test
+      Point = Data.define(:x, :y)
+    end
+  end
+end

data/spec/unit/basic/inspection_tree_builders/data_object_spec.rb

@@ -0,0 +1,146 @@
+require "spec_helper"
+
+if defined?(Data)
+  RSpec.describe SuperDiff, type: :unit do
+    describe ".inspect_object" do
+      context "given as_lines: false" do
+        subject(:output) do
+          described_class.inspect_object(object, as_lines: false)
+        end
+
+        context "given an anonymous Data object" do
+          let(:object) { Data.define(:x, :y).new(1, 2) }
+
+          it "shows the data" do
+            expect(output).to eq("#<data  x: 1, y: 2>")
+          end
+        end
+
+        context "given a named Data object" do
+          let(:object) { SuperDiff::Test::Point.new(1, 2) }
+
+          it "shows the data" do
+            expect(output).to eq("#<data SuperDiff::Test::Point x: 1, y: 2>")
+          end
+        end
+
+        context "given a Data object that defines #attributes_for_super_diff" do
+          let(:klass) do
+            Data.define(:x, :y) do
+              def attributes_for_super_diff
+                { beep: :boop }
+              end
+            end
+          end
+          let(:object) { klass.new(1, 2) }
+
+          it "uses the custom attributes" do
+            expect(output).to start_with("#<#<Class:0x").and end_with(
+                    "beep: :boop>"
+                  )
+          end
+        end
+      end
+
+      context "given as_lines: true" do
+        subject(:tiered_lines) do
+          described_class.inspect_object(
+            object,
+            as_lines: true,
+            type: :noop,
+            indentation_level: 1
+          )
+        end
+
+        context "given an anonymous Data object" do
+          let(:object) { Data.define(:x, :y).new(1, 2) }
+
+          it "shows the data" do
+            expect(tiered_lines).to match(
+              [
+                an_object_having_attributes(
+                  value: "#<data  {",
+                  collection_bookend: :open
+                ),
+                an_object_having_attributes(
+                  prefix: "x: ",
+                  value: "1",
+                  add_comma: true
+                ),
+                an_object_having_attributes(
+                  prefix: "y: ",
+                  value: "2",
+                  add_comma: false
+                ),
+                an_object_having_attributes(
+                  value: "}>",
+                  collection_bookend: :close
+                )
+              ]
+            )
+          end
+        end
+
+        context "given a named Data object" do
+          let(:object) { SuperDiff::Test::Point.new(1, 2) }
+
+          it "shows the data" do
+            expect(tiered_lines).to match(
+              [
+                an_object_having_attributes(
+                  value: "#<data SuperDiff::Test::Point {",
+                  collection_bookend: :open
+                ),
+                an_object_having_attributes(
+                  prefix: "x: ",
+                  value: "1",
+                  add_comma: true
+                ),
+                an_object_having_attributes(
+                  prefix: "y: ",
+                  value: "2",
+                  add_comma: false
+                ),
+                an_object_having_attributes(
+                  value: "}>",
+                  collection_bookend: :close
+                )
+              ]
+            )
+          end
+        end
+
+        context "given a Data object that defines #attributes_for_super_diff" do
+          let(:klass) do
+            Data.define(:x, :y) do
+              def attributes_for_super_diff
+                { beep: :boop }
+              end
+            end
+          end
+          let(:object) { klass.new(1, 2) }
+
+          it "uses the custom attributes" do
+            expect(tiered_lines).to match(
+              [
+                an_object_having_attributes(
+                  value: /\A#<#<Class:0x.*> {/,
+                  collection_bookend: :open
+                ),
+                an_object_having_attributes(
+                  prefix: "beep: ",
+                  value: ":boop",
+                  add_comma: false
+                ),
+                an_object_having_attributes(
+                  value: "}>",
+                  collection_bookend: :close
+                )
+              ]
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/spec/unit/basic/operation_tree_builders/data_object_spec.rb

@@ -0,0 +1,82 @@
+require "spec_helper"
+
+if defined?(Data)
+  RSpec.describe SuperDiff, type: :unit do
+    describe ".diff" do
+      subject(:diff) { described_class.diff(a, b) }
+
+      context "when given two Data objects of the same class" do
+        let(:a) { SuperDiff::Test::Point.new(1, 2) }
+        let(:b) { SuperDiff::Test::Point.new(1, 3) }
+
+        it "diffs their member attributes" do
+          expected_output =
+            SuperDiff::Core::Helpers
+              .style(color_enabled: true) do
+                plain_line "  #<SuperDiff::Test::Point {"
+                plain_line "    x: 1,"
+                expected_line "-   y: 2"
+                actual_line "+   y: 3"
+                plain_line "  }>"
+              end
+              .to_s
+              .chomp
+
+          expect(diff).to eq(expected_output)
+        end
+
+        context "when the Data class defines #attributes_for_super_diff" do
+          let(:klass) do
+            Class.new(Data.define(:attribute)) do
+              def self.to_s = "TestClass"
+
+              def attributes_for_super_diff
+                { attribute: :does_not_matter }
+              end
+            end
+          end
+
+          let(:a) { klass.new(1) }
+          let(:b) { klass.new(2) }
+
+          it "diffs their member attributes" do
+            expected_output =
+              SuperDiff::Core::Helpers
+                .style(color_enabled: true) do
+                  plain_line "  #<TestClass {"
+                  expected_line "-   attribute: 1"
+                  actual_line "+   attribute: 2"
+                  plain_line "  }>"
+                end
+                .to_s
+                .chomp
+
+            expect(diff).to eq(expected_output)
+          end
+        end
+      end
+
+      context "when given two Data objects of different classes" do
+        let(:a) { SuperDiff::Test::Point.new(1, 2) }
+        let(:b) { Data.define(:one, :two).new(1, 2) }
+
+        it "raises" do
+          expect { SuperDiff.diff(a, b) }.to raise_error(
+            SuperDiff::Core::NoDifferAvailableError
+          )
+        end
+      end
+
+      context "when given a Data object and a hash" do
+        let(:a) { Data.define(:one, :two).new(1, 2) }
+        let(:b) { { one: 1, two: 2 } }
+
+        it "raises" do
+          expect { SuperDiff.diff(a, b) }.to raise_error(
+            SuperDiff::Core::NoDifferAvailableError
+          )
+        end
+      end
+    end
+  end
+end

data/spec/unit/core/configuration_no_rspec_spec.rb

@@ -0,0 +1,58 @@
+require "delegate"
+require "super_diff"
+
+class FakeTTYDecorator < SimpleDelegator
+  def initialize(obj, is_tty:)
+    super(obj)
+    @is_tty = is_tty
+  end
+
+  def isatty = @is_tty
+  def tty? = isatty
+end
+
+RSpec.describe SuperDiff::Core::Configuration, with_superdiff_rspec: false do
+  describe "#color_enabled?" do
+    it "is true when stdout is a TTY" do
+      original_stdout = $stdout
+      color_enabled = nil
+      begin
+        $stdout = FakeTTYDecorator.new(StringIO.new, is_tty: true)
+        color_enabled = SuperDiff.configuration.color_enabled?
+      ensure
+        $stdout = original_stdout
+      end
+      expect(color_enabled).to be(true)
+    end
+
+    it "is false when stdout is not a TTY but we are in CI" do
+      original_stdout = $stdout
+      original_ci = ENV["CI"]
+      color_enabled = nil
+      begin
+        $stdout = FakeTTYDecorator.new(StringIO.new, is_tty: false)
+        ENV["CI"] = "true"
+        color_enabled = SuperDiff.configuration.color_enabled?
+      ensure
+        $stdout = original_stdout
+        ENV["CI"] = original_ci
+      end
+      expect(color_enabled).to be(true)
+    end
+
+    it "is false when stdout is not a TTY and we are not in CI" do
+      original_stdout = $stdout
+      original_ci = ENV["CI"]
+      color_enabled = nil
+      begin
+        $stdout = FakeTTYDecorator.new(StringIO.new, is_tty: false)
+        ENV["CI"] = nil
+        color_enabled = SuperDiff.configuration.color_enabled?
+      ensure
+        $stdout = original_stdout
+        ENV["CI"] = original_ci
+      end
+      expect(color_enabled).to be(false)
+    end
+  end
+end

data/spec/unit/core/configuration_spec.rb

@@ -0,0 +1,176 @@
+require "spec_helper"
+
+RSpec.describe SuperDiff::Core::Configuration do
+  it "maintains frozen instance variables" do
+    expect(described_class.new.instance_variables).to all(be_frozen)
+  end
+
+  describe ".new" do
+    context "when passed nothing" do
+      subject(:config) { described_class.new }
+
+      it "creates a Configuration object with reasonable defaults" do
+        expect(config.actual_color).to eq(:yellow)
+      end
+    end
+
+    context "when passed options" do
+      subject(:config) { described_class.new(actual_color: :cyan) }
+
+      it "overrides the defaults with the provided options" do
+        expect(config.actual_color).to eq(:cyan)
+      end
+
+      it "uses the defaults for other options" do
+        expect(config.border_color).to eq(:blue)
+      end
+    end
+  end
+
+  describe ".dup" do
+    subject(:duplicated_config) { original_config.dup }
+
+    let(:original_config) { described_class.new(overrides) }
+    let(:in_both) { Class.new }
+    let(:in_duplicated_only) { Class.new }
+    let(:in_original_only) { Class.new }
+
+    let(:overrides) do
+      {
+        extra_diff_formatter_classes: [],
+        extra_differ_classes: [],
+        extra_inspection_tree_builder_classes: [],
+        extra_operation_tree_builder_classes: [],
+        extra_operation_tree_classes: []
+      }
+    end
+
+    %i[
+      diff_formatter
+      differ
+      operation_tree_builder
+      operation_tree
+      inspection_tree_builder
+    ].each do |object_type|
+      it "duplicates extra #{object_type.to_s.tr("_", " ")} classes" do
+        add_method_name = :"add_extra_#{object_type}_class"
+        get_method_name = :"extra_#{object_type}_classes"
+
+        original_config.send(add_method_name, in_both)
+        expect {
+          duplicated_config.send(get_method_name) << in_duplicated_only
+        }.to raise_error(FrozenError)
+        duplicated_config.send(add_method_name, in_duplicated_only)
+        original_config.send(add_method_name, in_original_only)
+
+        expect(original_config.send(get_method_name)).to include(
+          in_both,
+          in_original_only
+        )
+        expect(original_config.send(get_method_name)).not_to include(
+          in_duplicated_only
+        )
+
+        expect(duplicated_config.send(get_method_name)).to include(
+          in_both,
+          in_duplicated_only
+        )
+        expect(duplicated_config.send(get_method_name)).not_to include(
+          in_original_only
+        )
+      end
+    end
+  end
+
+  %i[
+    diff_formatter
+    differ
+    operation_tree_builder
+    operation_tree
+    inspection_tree_builder
+  ].each do |object_type|
+    describe "#add_extra_#{object_type}_classes" do
+      let(:config) { described_class.new }
+      let(:new_class1) { Class.new }
+      let(:new_class2) { Class.new }
+
+      it "appends multiple given classes" do
+        config.send("add_extra_#{object_type}_classes", new_class1, new_class2)
+        expect(config.send("extra_#{object_type}_classes")[-2..]).to eq(
+          [new_class1, new_class2]
+        )
+      end
+
+      it "appends a single given class" do
+        config.send("add_extra_#{object_type}_classes", new_class1)
+        expect(config.send("extra_#{object_type}_classes")[-1]).to eq(
+          new_class1
+        )
+      end
+    end
+
+    describe "#prepend_extra_#{object_type}_classes" do
+      let(:config) { described_class.new }
+      let(:new_class1) { Class.new }
+      let(:new_class2) { Class.new }
+
+      it "prepends multiple given classes" do
+        config.send(
+          "prepend_extra_#{object_type}_classes",
+          new_class1,
+          new_class2
+        )
+        expect(config.send("extra_#{object_type}_classes")[..1]).to eq(
+          [new_class1, new_class2]
+        )
+      end
+
+      it "prepends a single given class" do
+        config.send("prepend_extra_#{object_type}_classes", new_class1)
+        expect(config.send("extra_#{object_type}_classes")[0]).to eq(new_class1)
+      end
+    end
+  end
+
+  describe "#color_enabled?" do
+    context "when explicitly set" do
+      it "equals what was set" do
+        [true, false].each do |value|
+          SuperDiff.configuration.color_enabled.tap do |original|
+            SuperDiff.configuration.color_enabled = value
+            expect(SuperDiff.configuration.color_enabled?).to be(value)
+            SuperDiff.configuration.color_enabled = original
+          end
+        end
+      end
+    end
+
+    context "when not explicitly set" do
+      context 'when ENV["CI"] is true' do
+        it "is true" do
+          color_enabled = nil
+          ClimateControl.modify(CI: "true") do
+            color_enabled = SuperDiff.configuration.color_enabled?
+          end
+          expect(color_enabled).to be(true)
+        end
+      end
+
+      context 'when ENV["CI"] is not true' do
+        it "defaults to RSpec's config" do
+          ClimateControl.modify(CI: nil) do
+            %i[automatic on off].each do |value|
+              RSpec.configuration.color_mode.tap do |original|
+                RSpec.configuration.color_mode = value
+                expect(SuperDiff.configuration.color_enabled?).to eq(
+                  RSpec.configuration.color_enabled?
+                )
+                RSpec.configuration.color_mode = original
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/super_diff.gemspec

@@ -3,9 +3,9 @@ require File.expand_path("lib/super_diff/version", __dir__)
 Gem::Specification.new do |s|
   s.name = "super_diff"
   s.version = SuperDiff::VERSION
-  s.authors = ["Elliot Winkler"]
-  s.email = ["elliot.winkler@gmail.com"]
-  s.homepage = "https://github.com/mcmire/super_diff"
+  s.authors = ["Elliot Winkler", "Splitwise, Inc."]
+  s.email = ["oss-community@splitwise.com"]
+  s.homepage = "https://github.com/splitwise/super_diff"
   s.summary =
     "A better way to view differences between complex data structures in RSpec."
   s.license = "MIT"
@@ -14,10 +14,11 @@ Gem::Specification.new do |s|
     differences between two data structures of any type.
   DESC
   s.metadata = {
-    "bug_tracker_uri" => "https://github.com/mcmire/super_diff/issues",
+    "bug_tracker_uri" => "https://github.com/splitwise/super_diff/issues",
     "changelog_uri" =>
-      "https://github.com/mcmire/super_diff/blob/main/CHANGELOG.md",
-    "source_code_uri" => "https://github.com/mcmire/super_diff"
+      "https://github.com/splitwise/super_diff/blob/main/CHANGELOG.md",
+    "rubygems_mfa_required" => "true",
+    "source_code_uri" => "https://github.com/splitwise/super_diff"
   }
   s.required_ruby_version = ">= 3"
 

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: super_diff
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.0
 platform: ruby
 authors:
 - Elliot Winkler
+- Splitwise, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-27 00:00:00.000000000 Z
+date: 2024-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: attr_extras
@@ -56,7 +57,7 @@ description: |
   SuperDiff is a gem that hooks into RSpec to intelligently display the
   differences between two data structures of any type.
 email:
-- elliot.winkler@gmail.com
+- oss-community@splitwise.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -106,6 +107,7 @@ files:
 - lib/super_diff/basic/inspection_tree_builders.rb
 - lib/super_diff/basic/inspection_tree_builders/array.rb
 - lib/super_diff/basic/inspection_tree_builders/custom_object.rb
+- lib/super_diff/basic/inspection_tree_builders/data_object.rb
 - lib/super_diff/basic/inspection_tree_builders/date_like.rb
 - lib/super_diff/basic/inspection_tree_builders/default_object.rb
 - lib/super_diff/basic/inspection_tree_builders/hash.rb
@@ -114,6 +116,7 @@ files:
 - lib/super_diff/basic/operation_tree_builders.rb
 - lib/super_diff/basic/operation_tree_builders/array.rb
 - lib/super_diff/basic/operation_tree_builders/custom_object.rb
+- lib/super_diff/basic/operation_tree_builders/data_object.rb
 - lib/super_diff/basic/operation_tree_builders/date_like.rb
 - lib/super_diff/basic/operation_tree_builders/default_object.rb
 - lib/super_diff/basic/operation_tree_builders/hash.rb
@@ -264,7 +267,6 @@ files:
 - spec/integration/rspec/respond_to_matcher_spec.rb
 - spec/integration/rspec/third_party_matcher_spec.rb
 - spec/integration/rspec/unhandled_errors_spec.rb
-- spec/internal/log/test.log
 - spec/spec_helper.rb
 - spec/support/colorizer.rb
 - spec/support/command_runner.rb
@@ -288,6 +290,7 @@ files:
 - spec/support/models/order.rb
 - spec/support/models/person.rb
 - spec/support/models/player.rb
+- spec/support/models/point.rb
 - spec/support/models/shipping_address.rb
 - spec/support/shared_examples/active_record.rb
 - spec/support/shared_examples/active_support.rb
@@ -299,11 +302,15 @@ files:
 - spec/support/unit/matchers/match_output.rb
 - spec/unit/active_record/object_inspection_spec.rb
 - spec/unit/active_support/object_inspection_spec.rb
+- spec/unit/basic/inspection_tree_builders/data_object_spec.rb
+- spec/unit/basic/operation_tree_builders/data_object_spec.rb
 - spec/unit/basic/operation_tree_flatteners/array_spec.rb
 - spec/unit/basic/operation_tree_flatteners/custom_object_spec.rb
 - spec/unit/basic/operation_tree_flatteners/default_object_spec.rb
 - spec/unit/basic/operation_tree_flatteners/hash_spec.rb
 - spec/unit/basic/operation_tree_flatteners/multiline_string_spec.rb
+- spec/unit/core/configuration_no_rspec_spec.rb
+- spec/unit/core/configuration_spec.rb
 - spec/unit/core/helpers_spec.rb
 - spec/unit/core/tiered_lines_elider_spec.rb
 - spec/unit/core/tiered_lines_formatter_spec.rb
@@ -328,13 +335,14 @@ files:
 - spec/unit/rspec/object_inspection_spec.rb
 - spec/unit/super_diff_spec.rb
 - super_diff.gemspec
-homepage: https://github.com/mcmire/super_diff
+homepage: https://github.com/splitwise/super_diff
 licenses:
 - MIT
 metadata:
-  bug_tracker_uri: https://github.com/mcmire/super_diff/issues
-  changelog_uri: https://github.com/mcmire/super_diff/blob/main/CHANGELOG.md
-  source_code_uri: https://github.com/mcmire/super_diff
+  bug_tracker_uri: https://github.com/splitwise/super_diff/issues
+  changelog_uri: https://github.com/splitwise/super_diff/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/splitwise/super_diff
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -350,7 +358,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: A better way to view differences between complex data structures in RSpec.
@@ -378,7 +386,6 @@ test_files:
 - spec/integration/rspec/respond_to_matcher_spec.rb
 - spec/integration/rspec/third_party_matcher_spec.rb
 - spec/integration/rspec/unhandled_errors_spec.rb
-- spec/internal/log/test.log
 - spec/spec_helper.rb
 - spec/support/colorizer.rb
 - spec/support/command_runner.rb
@@ -402,6 +409,7 @@ test_files:
 - spec/support/models/order.rb
 - spec/support/models/person.rb
 - spec/support/models/player.rb
+- spec/support/models/point.rb
 - spec/support/models/shipping_address.rb
 - spec/support/shared_examples/active_record.rb
 - spec/support/shared_examples/active_support.rb
@@ -413,11 +421,15 @@ test_files:
 - spec/support/unit/matchers/match_output.rb
 - spec/unit/active_record/object_inspection_spec.rb
 - spec/unit/active_support/object_inspection_spec.rb
+- spec/unit/basic/inspection_tree_builders/data_object_spec.rb
+- spec/unit/basic/operation_tree_builders/data_object_spec.rb
 - spec/unit/basic/operation_tree_flatteners/array_spec.rb
 - spec/unit/basic/operation_tree_flatteners/custom_object_spec.rb
 - spec/unit/basic/operation_tree_flatteners/default_object_spec.rb
 - spec/unit/basic/operation_tree_flatteners/hash_spec.rb
 - spec/unit/basic/operation_tree_flatteners/multiline_string_spec.rb
+- spec/unit/core/configuration_no_rspec_spec.rb
+- spec/unit/core/configuration_spec.rb
 - spec/unit/core/helpers_spec.rb
 - spec/unit/core/tiered_lines_elider_spec.rb
 - spec/unit/core/tiered_lines_formatter_spec.rb