super_diff 0.10.0 → 0.11.0

data/spec/unit/rspec/object_inspection/rspec_matcher_spec.rb

@@ -0,0 +1,91 @@
+require "spec_helper"
+
+RSpec.describe SuperDiff, type: :unit do
+  describe ".inspect_object", "for RSpec matchers" do
+    context "given a custom matcher" do
+      let(:custom_matcher) do
+        proc do |expected, &block_arg|
+          declarations =
+            proc do
+              match do |actual|
+                actual.is_a?(Integer) && actual >= 0 &&
+                  (Math.sqrt(actual) % 1).zero?
+              end
+              description { "be a perfect square" }
+            end
+          RSpec::Matchers::DSL::Matcher.new(
+            :be_a_square,
+            declarations,
+            RSpec::Matchers::DSL,
+            *expected,
+            &block_arg
+          )
+        end
+      end
+
+      context "given as_lines: false" do
+        it "returns the matcher's description string" do
+          string =
+            described_class.inspect_object(
+              custom_matcher.call(4),
+              as_lines: false
+            )
+          expect(string).to eq("#<be a perfect square>")
+        end
+      end
+
+      context "given as_lines: true" do
+        it "returns an inspected version of the matcher as multiple lines" do
+          tiered_lines =
+            described_class.inspect_object(
+              custom_matcher.call(4),
+              as_lines: true,
+              type: :delete,
+              indentation_level: 1
+            )
+          expect(tiered_lines).to match(
+            [
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 1,
+                value: "#<be a perfect square>"
+              )
+            ]
+          )
+        end
+      end
+    end
+
+    context "given a built-in matcher" do
+      let(:matcher) { be_a(Numeric) }
+
+      context "given as_lines: false" do
+        it "returns the matcher's description string" do
+          string = described_class.inspect_object(matcher, as_lines: false)
+          expect(string).to eq("#<be a kind of Numeric>")
+        end
+      end
+
+      context "given as_lines: true" do
+        it "returns an inspected version of the matcher as multiple lines" do
+          tiered_lines =
+            described_class.inspect_object(
+              matcher,
+              as_lines: true,
+              type: :delete,
+              indentation_level: 1
+            )
+          expect(tiered_lines).to match(
+            [
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 1,
+                value: "#<be a kind of Numeric>"
+              )
+            ]
+          )
+        end
+      end
+    end
+  end
+end

data/spec/unit/rspec/object_inspection_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 RSpec.describe SuperDiff, type: :unit do
-  describe ".inspect_object", "for RSpec objects" do
+  describe ".inspect_object", "for RSpec aliased matchers" do
     context "given a hash-including-<something>" do
       context "given as_lines: false" do
         it "returns an inspected version of the object" do
@@ -116,7 +116,7 @@ RSpec.describe SuperDiff, type: :unit do
       end
     end
 
-    context "given a fuzzy object" do
+    context "given an object-having-<something>" do
       context "given as_lines: false" do
         it "returns an inspected version of the object" do
           string =

data/spec/unit/super_diff_spec.rb

@@ -1026,6 +1026,70 @@ RSpec.describe SuperDiff, type: :unit do
       end
     end
 
+    context "given a Date object" do
+      context "given as_lines: false" do
+        it "returns a representation of the date on a single line" do
+          inspection =
+            described_class.inspect_object(
+              Date.new(2023, 10, 14),
+              as_lines: false
+            )
+          expect(inspection).to eq("#<Date 2023-10-14>")
+        end
+      end
+
+      context "given as_lines: true" do
+        it "returns a representation of the date across multiple lines" do
+          inspection =
+            described_class.inspect_object(
+              Date.new(2023, 10, 14),
+              as_lines: true,
+              type: :delete,
+              indentation_level: 1
+            )
+          expect(inspection).to match(
+            [
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 1,
+                value: "#<Date {",
+                add_comma: false,
+                collection_bookend: :open
+              ),
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 2,
+                value: "year: 2023",
+                add_comma: true,
+                collection_bookend: nil
+              ),
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 2,
+                value: "month: 10",
+                add_comma: true,
+                collection_bookend: nil
+              ),
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 2,
+                value: "day: 14",
+                add_comma: false,
+                collection_bookend: nil
+              ),
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 1,
+                value: "}>",
+                add_comma: false,
+                collection_bookend: :close
+              )
+            ]
+          )
+        end
+      end
+    end
+
     context "given a class" do
       context "given as_lines: false" do
         it "returns an inspected version of the object" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: super_diff
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Elliot Winkler
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-26 00:00:00.000000000 Z
+date: 2024-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: attr_extras
@@ -84,6 +84,7 @@ files:
 - lib/super_diff/active_support/object_inspection.rb
 - lib/super_diff/active_support/object_inspection/inspection_tree_builders.rb
 - lib/super_diff/active_support/object_inspection/inspection_tree_builders/hash_with_indifferent_access.rb
+- lib/super_diff/active_support/object_inspection/inspection_tree_builders/ordered_options.rb
 - lib/super_diff/active_support/operation_tree_builders.rb
 - lib/super_diff/active_support/operation_tree_builders/hash_with_indifferent_access.rb
 - lib/super_diff/active_support/operation_tree_flatteners.rb
@@ -109,6 +110,7 @@ files:
 - lib/super_diff/differs/array.rb
 - lib/super_diff/differs/base.rb
 - lib/super_diff/differs/custom_object.rb
+- lib/super_diff/differs/date_like.rb
 - lib/super_diff/differs/default_object.rb
 - lib/super_diff/differs/defaults.rb
 - lib/super_diff/differs/empty.rb
@@ -127,9 +129,7 @@ files:
 - lib/super_diff/equality_matchers/primitive.rb
 - lib/super_diff/equality_matchers/singleline_string.rb
 - lib/super_diff/errors.rb
-- lib/super_diff/errors/no_diff_formatter_available_error.rb
 - lib/super_diff/errors/no_differ_available_error.rb
-- lib/super_diff/errors/no_operational_sequencer_available_error.rb
 - lib/super_diff/gem_version.rb
 - lib/super_diff/helpers.rb
 - lib/super_diff/implementation_checks.rb
@@ -140,6 +140,7 @@ files:
 - lib/super_diff/object_inspection/inspection_tree_builders/array.rb
 - lib/super_diff/object_inspection/inspection_tree_builders/base.rb
 - lib/super_diff/object_inspection/inspection_tree_builders/custom_object.rb
+- lib/super_diff/object_inspection/inspection_tree_builders/date_like.rb
 - lib/super_diff/object_inspection/inspection_tree_builders/default_object.rb
 - lib/super_diff/object_inspection/inspection_tree_builders/defaults.rb
 - lib/super_diff/object_inspection/inspection_tree_builders/hash.rb
@@ -166,6 +167,7 @@ files:
 - lib/super_diff/operation_tree_builders/array.rb
 - lib/super_diff/operation_tree_builders/base.rb
 - lib/super_diff/operation_tree_builders/custom_object.rb
+- lib/super_diff/operation_tree_builders/date_like.rb
 - lib/super_diff/operation_tree_builders/default_object.rb
 - lib/super_diff/operation_tree_builders/defaults.rb
 - lib/super_diff/operation_tree_builders/hash.rb
@@ -218,6 +220,7 @@ files:
 - lib/super_diff/rspec/object_inspection/inspection_tree_builders/collection_containing_exactly.rb
 - lib/super_diff/rspec/object_inspection/inspection_tree_builders/collection_including.rb
 - lib/super_diff/rspec/object_inspection/inspection_tree_builders/double.rb
+- lib/super_diff/rspec/object_inspection/inspection_tree_builders/generic_describable_matcher.rb
 - lib/super_diff/rspec/object_inspection/inspection_tree_builders/hash_including.rb
 - lib/super_diff/rspec/object_inspection/inspection_tree_builders/instance_of.rb
 - lib/super_diff/rspec/object_inspection/inspection_tree_builders/kind_of.rb
@@ -245,15 +248,18 @@ files:
 - spec/integration/rspec/be_truthy_matcher_spec.rb
 - spec/integration/rspec/contain_exactly_matcher_spec.rb
 - spec/integration/rspec/eq_matcher_spec.rb
+- spec/integration/rspec/generic_describable_matchers_spec.rb
 - spec/integration/rspec/have_attributes_matcher_spec.rb
 - spec/integration/rspec/have_predicate_matcher_spec.rb
 - spec/integration/rspec/include_matcher_spec.rb
+- spec/integration/rspec/magic_metadata_spec.rb
 - spec/integration/rspec/match_array_matcher_spec.rb
 - spec/integration/rspec/match_matcher_spec.rb
 - spec/integration/rspec/raise_error_matcher_spec.rb
 - 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
@@ -286,6 +292,7 @@ files:
 - spec/support/unit/helpers.rb
 - 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/equality_matchers/main_spec.rb
 - spec/unit/helpers_spec.rb
 - spec/unit/operation_tree_flatteners/array_spec.rb
@@ -308,6 +315,7 @@ files:
 - spec/unit/rspec/matchers/match_spec.rb
 - spec/unit/rspec/matchers/raise_error_spec.rb
 - spec/unit/rspec/matchers/respond_to_spec.rb
+- spec/unit/rspec/object_inspection/rspec_matcher_spec.rb
 - spec/unit/rspec/object_inspection_spec.rb
 - spec/unit/super_diff_spec.rb
 - spec/unit/tiered_lines_elider_spec.rb
@@ -349,15 +357,18 @@ test_files:
 - spec/integration/rspec/be_truthy_matcher_spec.rb
 - spec/integration/rspec/contain_exactly_matcher_spec.rb
 - spec/integration/rspec/eq_matcher_spec.rb
+- spec/integration/rspec/generic_describable_matchers_spec.rb
 - spec/integration/rspec/have_attributes_matcher_spec.rb
 - spec/integration/rspec/have_predicate_matcher_spec.rb
 - spec/integration/rspec/include_matcher_spec.rb
+- spec/integration/rspec/magic_metadata_spec.rb
 - spec/integration/rspec/match_array_matcher_spec.rb
 - spec/integration/rspec/match_matcher_spec.rb
 - spec/integration/rspec/raise_error_matcher_spec.rb
 - 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
@@ -390,6 +401,7 @@ test_files:
 - spec/support/unit/helpers.rb
 - 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/equality_matchers/main_spec.rb
 - spec/unit/helpers_spec.rb
 - spec/unit/operation_tree_flatteners/array_spec.rb
@@ -412,6 +424,7 @@ test_files:
 - spec/unit/rspec/matchers/match_spec.rb
 - spec/unit/rspec/matchers/raise_error_spec.rb
 - spec/unit/rspec/matchers/respond_to_spec.rb
+- spec/unit/rspec/object_inspection/rspec_matcher_spec.rb
 - spec/unit/rspec/object_inspection_spec.rb
 - spec/unit/super_diff_spec.rb
 - spec/unit/tiered_lines_elider_spec.rb

data/lib/super_diff/errors/no_diff_formatter_available_error.rb

@@ -1,21 +0,0 @@
-module SuperDiff
-  module Errors
-    class NoDiffFormatterAvailableError < StandardError
-      def self.create(operation_tree)
-        allocate.tap do |error|
-          error.operation_tree = operation_tree
-          error.__send__(:initialize)
-        end
-      end
-
-      attr_accessor :operation_tree
-
-      def initialize
-        super(<<-MESSAGE)
-There is no diff formatter available to handle an operation tree object of
-#{operation_tree.class}.
-        MESSAGE
-      end
-    end
-  end
-end

data/lib/super_diff/errors/no_operational_sequencer_available_error.rb

@@ -1,22 +0,0 @@
-module SuperDiff
-  module Errors
-    class NoOperationalSequencerAvailableError < StandardError
-      def self.create(expected, actual)
-        allocate.tap do |error|
-          error.expected = expected
-          error.actual = actual
-          error.__send__(:initialize)
-        end
-      end
-
-      attr_accessor :expected, :actual
-
-      def initialize
-        super(<<-MESSAGE)
-There is no operational sequencer available to handle an "expected" value of
-type #{expected.class} and an "actual" value of type #{actual.class}.
-        MESSAGE
-      end
-    end
-  end
-end