super_diff 0.12.1 → 0.15.0

data/lib/super_diff/rspec/monkey_patches.rb

@@ -309,73 +309,146 @@ module RSpec
   end
 
   module Matchers
-    class ExpectedsForMultipleDiffs
-      SuperDiff.insert_singleton_overrides(self) do
-        # Add a key for different sides
-        def from(expected)
-          return expected if self === expected
-
-          text = colorizer.wrap("Diff:", SuperDiff.configuration.header_color)
-
-          if SuperDiff.configuration.key_enabled?
-            text +=
-              "\n\n" +
-                colorizer.wrap(
-                  "┌ (Key) ──────────────────────────┐",
-                  SuperDiff.configuration.border_color
-                ) + "\n" +
-                colorizer.wrap("│ ", SuperDiff.configuration.border_color) +
-                colorizer.wrap(
-                  "‹-› in expected, not in actual",
-                  SuperDiff.configuration.expected_color
-                ) +
-                colorizer.wrap("  │", SuperDiff.configuration.border_color) +
-                "\n" +
-                colorizer.wrap("│ ", SuperDiff.configuration.border_color) +
-                colorizer.wrap(
-                  "‹+› in actual, not in expected",
-                  SuperDiff.configuration.actual_color
-                ) +
-                colorizer.wrap("  │", SuperDiff.configuration.border_color) +
-                "\n" +
-                colorizer.wrap("│ ", SuperDiff.configuration.border_color) +
-                "‹ › in both expected and actual" +
-                colorizer.wrap(" │", SuperDiff.configuration.border_color) +
-                "\n" +
-                colorizer.wrap(
-                  "└─────────────────────────────────┘",
-                  SuperDiff.configuration.border_color
-                )
+    if SuperDiff::RSpec.rspec_version < "3.13.0"
+      class ExpectedsForMultipleDiffs
+        SuperDiff.insert_singleton_overrides(self) do
+          # Add a key for different sides
+          def from(expected)
+            return expected if self === expected
+
+            text = colorizer.wrap("Diff:", SuperDiff.configuration.header_color)
+
+            if SuperDiff.configuration.key_enabled?
+              text +=
+                "\n\n" +
+                  colorizer.wrap(
+                    "┌ (Key) ──────────────────────────┐",
+                    SuperDiff.configuration.border_color
+                  ) + "\n" +
+                  colorizer.wrap("│ ", SuperDiff.configuration.border_color) +
+                  colorizer.wrap(
+                    "‹-› in expected, not in actual",
+                    SuperDiff.configuration.expected_color
+                  ) +
+                  colorizer.wrap("  │", SuperDiff.configuration.border_color) +
+                  "\n" +
+                  colorizer.wrap("│ ", SuperDiff.configuration.border_color) +
+                  colorizer.wrap(
+                    "‹+› in actual, not in expected",
+                    SuperDiff.configuration.actual_color
+                  ) +
+                  colorizer.wrap("  │", SuperDiff.configuration.border_color) +
+                  "\n" +
+                  colorizer.wrap("│ ", SuperDiff.configuration.border_color) +
+                  "‹ › in both expected and actual" +
+                  colorizer.wrap(" │", SuperDiff.configuration.border_color) +
+                  "\n" +
+                  colorizer.wrap(
+                    "└─────────────────────────────────┘",
+                    SuperDiff.configuration.border_color
+                  )
+            end
+
+            new([[expected, text]])
           end
 
-          new([[expected, text]])
+          def colorizer
+            RSpec::Core::Formatters::ConsoleCodes
+          end
         end
 
-        def colorizer
-          RSpec::Core::Formatters::ConsoleCodes
+        SuperDiff.insert_overrides(self) do
+          # Add an extra line break
+          def message_with_diff(message, differ, actual)
+            diff = diffs(differ, actual)
+
+            diff.empty? ? message : "#{message.rstrip}\n\n#{diff}"
+          end
+
+          private
+
+          # Add extra line breaks in between diffs, and colorize the word "Diff"
+          def diffs(differ, actual)
+            @expected_list
+              .map do |(expected, diff_label)|
+                diff = differ.diff(actual, expected)
+                next if diff.strip.empty?
+                diff_label + diff
+              end
+              .compact
+              .join("\n\n")
+          end
         end
       end
+    else
+      class MultiMatcherDiff
+        SuperDiff.insert_singleton_overrides(self) do
+          # Add a key for different sides
+          def from(expected, actual)
+            return expected if self === expected
+
+            text = colorizer.wrap("Diff:", SuperDiff.configuration.header_color)
+
+            if SuperDiff.configuration.key_enabled?
+              text +=
+                "\n\n" +
+                  colorizer.wrap(
+                    "┌ (Key) ──────────────────────────┐",
+                    SuperDiff.configuration.border_color
+                  ) + "\n" +
+                  colorizer.wrap("│ ", SuperDiff.configuration.border_color) +
+                  colorizer.wrap(
+                    "‹-› in expected, not in actual",
+                    SuperDiff.configuration.expected_color
+                  ) +
+                  colorizer.wrap("  │", SuperDiff.configuration.border_color) +
+                  "\n" +
+                  colorizer.wrap("│ ", SuperDiff.configuration.border_color) +
+                  colorizer.wrap(
+                    "‹+› in actual, not in expected",
+                    SuperDiff.configuration.actual_color
+                  ) +
+                  colorizer.wrap("  │", SuperDiff.configuration.border_color) +
+                  "\n" +
+                  colorizer.wrap("│ ", SuperDiff.configuration.border_color) +
+                  "‹ › in both expected and actual" +
+                  colorizer.wrap(" │", SuperDiff.configuration.border_color) +
+                  "\n" +
+                  colorizer.wrap(
+                    "└─────────────────────────────────┘",
+                    SuperDiff.configuration.border_color
+                  )
+            end
 
-      SuperDiff.insert_overrides(self) do
-        # Add an extra line break
-        def message_with_diff(message, differ, actual)
-          diff = diffs(differ, actual)
+            new([[expected, text, actual]])
+          end
 
-          diff.empty? ? message : "#{message.rstrip}\n\n#{diff}"
+          def colorizer
+            RSpec::Core::Formatters::ConsoleCodes
+          end
         end
 
-        private
+        SuperDiff.insert_overrides(self) do
+          # Add an extra line break
+          def message_with_diff(message, differ)
+            diff = diffs(differ)
+
+            diff.empty? ? message : "#{message.rstrip}\n\n#{diff}"
+          end
 
-        # Add extra line breaks in between diffs, and colorize the word "Diff"
-        def diffs(differ, actual)
-          @expected_list
-            .map do |(expected, diff_label)|
-              diff = differ.diff(actual, expected)
-              next if diff.strip.empty?
-              diff_label + diff
-            end
-            .compact
-            .join("\n\n")
+          private
+
+          # Add extra line breaks in between diffs, and colorize the word "Diff"
+          def diffs(differ)
+            @expected_list
+              .map do |(expected, diff_label, actual)|
+                diff = differ.diff(actual, expected)
+                next if diff.strip.empty?
+                diff_label + diff
+              end
+              .compact
+              .join("\n\n")
+          end
         end
       end
     end

data/lib/super_diff/rspec/object_inspection.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module RSpec
     module ObjectInspection
       module InspectionTreeBuilders
         def self.const_missing(missing_const_name)
           if RSpec::InspectionTreeBuilders.const_defined?(missing_const_name)
-            warn <<~EOT
-          WARNING: SuperDiff::RSpec::ObjectInspection::InspectionTreeBuilders::#{missing_const_name} is deprecated and will be removed in the next major release.
-          Please use SuperDiff::RSpec::InspectionTreeBuilders::#{missing_const_name} instead.
-          #{caller_locations.join("\n")}
-        EOT
+            warn <<~WARNING
+              WARNING: SuperDiff::RSpec::ObjectInspection::InspectionTreeBuilders::#{missing_const_name} is deprecated and will be removed in the next major release.
+              Please use SuperDiff::RSpec::InspectionTreeBuilders::#{missing_const_name} instead.
+              #{caller_locations.join("\n")}
+            WARNING
             RSpec::InspectionTreeBuilders.const_get(missing_const_name)
           else
             super

data/lib/super_diff/rspec/operation_tree_builders/collection_containing_exactly.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module RSpec
     module OperationTreeBuilders
@@ -19,9 +21,7 @@ module SuperDiff
           operations = []
 
           (0...actual.length)
-            .reject do |index|
-              indexes_in_actual_but_not_in_expected.include?(index)
-            end
+            .reject { |index| indexes_in_actual_but_not_in_expected.include?(index) }
             .each { |index| add_noop_to(operations, index) }
 
           indexes_in_actual_but_not_in_expected.each do |index|
@@ -36,7 +36,7 @@ module SuperDiff
         end
 
         def build_operation_tree
-          OperationTrees::Array.new([])
+          Basic::OperationTrees::Array.new([])
         end
 
         private

data/lib/super_diff/rspec/operation_tree_builders/collection_including.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module RSpec
     module OperationTreeBuilders

data/lib/super_diff/rspec/operation_tree_builders/hash_including.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module RSpec
     module OperationTreeBuilders

data/lib/super_diff/rspec/operation_tree_builders/object_having_attributes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module RSpec
     module OperationTreeBuilders

data/lib/super_diff/rspec/operation_tree_builders.rb

@@ -1,21 +1,23 @@
+# frozen_string_literal: true
+
 module SuperDiff
   module RSpec
     module OperationTreeBuilders
       autoload(
         :CollectionContainingExactly,
-        "super_diff/rspec/operation_tree_builders/collection_containing_exactly"
+        'super_diff/rspec/operation_tree_builders/collection_containing_exactly'
       )
       autoload(
         :CollectionIncluding,
-        "super_diff/rspec/operation_tree_builders/collection_including"
+        'super_diff/rspec/operation_tree_builders/collection_including'
       )
       autoload(
         :HashIncluding,
-        "super_diff/rspec/operation_tree_builders/hash_including"
+        'super_diff/rspec/operation_tree_builders/hash_including'
       )
       autoload(
         :ObjectHavingAttributes,
-        "super_diff/rspec/operation_tree_builders/object_having_attributes"
+        'super_diff/rspec/operation_tree_builders/object_having_attributes'
       )
     end
   end

data/lib/super_diff/rspec-rails.rb

@@ -1,2 +1,4 @@
-require "super_diff/rspec"
-require "super_diff/rails"
+# frozen_string_literal: true
+
+require 'super_diff/rspec'
+require 'super_diff/rails'

data/lib/super_diff/rspec.rb

@@ -1,17 +1,19 @@
-require "super_diff"
+# frozen_string_literal: true
 
-require "super_diff/rspec/differs"
-require "super_diff/rspec/inspection_tree_builders"
-require "super_diff/rspec/operation_tree_builders"
+require 'super_diff'
+
+require 'super_diff/rspec/differs'
+require 'super_diff/rspec/inspection_tree_builders'
+require 'super_diff/rspec/operation_tree_builders'
 
 module SuperDiff
   module RSpec
-    autoload :AugmentedMatcher, "super_diff/rspec/augmented_matcher"
-    autoload :Configuration, "super_diff/rspec/configuration"
-    autoload :Differ, "super_diff/rspec/differ"
-    autoload :MatcherTextBuilders, "super_diff/rspec/matcher_text_builders"
-    autoload :MatcherTextTemplate, "super_diff/rspec/matcher_text_template"
-    autoload :ObjectInspection, "super_diff/rspec/object_inspection"
+    autoload :AugmentedMatcher, 'super_diff/rspec/augmented_matcher'
+    autoload :Configuration, 'super_diff/rspec/configuration'
+    autoload :Differ, 'super_diff/rspec/differ'
+    autoload :MatcherTextBuilders, 'super_diff/rspec/matcher_text_builders'
+    autoload :MatcherTextTemplate, 'super_diff/rspec/matcher_text_template'
+    autoload :ObjectInspection, 'super_diff/rspec/object_inspection'
 
     def self.configure(&block)
       SuperDiff.configure(&block)
@@ -79,13 +81,22 @@ module SuperDiff
     end
 
     def self.aliased_matcher?(value)
-      value.is_a?(::RSpec::Matchers::AliasedMatcher)
+      if SuperDiff::RSpec.rspec_version < '3.13.0'
+        value.is_a?(::RSpec::Matchers::AliasedMatcher)
+      else # See Github issue #250.
+        !ordered_options?(value) && value.respond_to?(:base_matcher)
+      end
+    end
+
+    def self.ordered_options?(value)
+      defined?(::ActiveSupport::OrderedOptions) &&
+        value.is_a?(::ActiveSupport::OrderedOptions)
     end
 
     def self.rspec_version
-      @_rspec_version ||=
+      @rspec_version ||=
         begin
-          require "rspec/core/version"
+          require 'rspec/core/version'
           Core::GemVersion.new(::RSpec::Core::Version::STRING)
         end
     end
@@ -121,4 +132,6 @@ module SuperDiff
   end
 end
 
-require_relative "rspec/monkey_patches"
+require_relative 'rspec/monkey_patches'
+
+RSpec.configuration.filter_gems_from_backtrace('super_diff')

data/lib/super_diff/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperDiff
-  VERSION = "0.12.1".freeze
+  VERSION = '0.15.0'
 end

data/lib/super_diff.rb

@@ -1,33 +1,35 @@
-require "attr_extras/explicit"
-require "date"
+# frozen_string_literal: true
+
+require 'attr_extras/explicit'
+require 'date'
 
 module SuperDiff
-  autoload :Core, "super_diff/core"
-  autoload :Csi, "super_diff/csi"
-  autoload :Differs, "super_diff/differs"
-  autoload :EqualityMatchers, "super_diff/equality_matchers"
-  autoload :Errors, "super_diff/errors"
-  autoload :ObjectInspection, "super_diff/object_inspection"
-  autoload :OperationTreeBuilders, "super_diff/operation_tree_builders"
-  autoload :OperationTreeFlatteners, "super_diff/operation_tree_flatteners"
-  autoload :OperationTrees, "super_diff/operation_trees"
-  autoload :Operations, "super_diff/operations"
-  autoload :VERSION, "super_diff/version"
+  autoload :Core, 'super_diff/core'
+  autoload :Csi, 'super_diff/csi'
+  autoload :Differs, 'super_diff/differs'
+  autoload :EqualityMatchers, 'super_diff/equality_matchers'
+  autoload :Errors, 'super_diff/errors'
+  autoload :ObjectInspection, 'super_diff/object_inspection'
+  autoload :OperationTreeBuilders, 'super_diff/operation_tree_builders'
+  autoload :OperationTreeFlatteners, 'super_diff/operation_tree_flatteners'
+  autoload :OperationTrees, 'super_diff/operation_trees'
+  autoload :Operations, 'super_diff/operations'
+  autoload :VERSION, 'super_diff/version'
 
   def self.const_missing(missing_const_name)
     if Core.const_defined?(missing_const_name)
-      warn <<~EOT
+      warn <<~WARNING
         WARNING: SuperDiff::#{missing_const_name} is deprecated and will be removed in the next major release.
         Please use SuperDiff::Core::#{missing_const_name} instead.
         #{caller_locations.join("\n")}
-      EOT
+      WARNING
       Core.const_get(missing_const_name)
     elsif Basic.const_defined?(missing_const_name)
-      warn <<~EOT
+      warn <<~WARNING
         WARNING: SuperDiff::#{missing_const_name} is deprecated and will be removed in the next major release.
         Please use SuperDiff::Basic::#{missing_const_name} instead.
         #{caller_locations.join("\n")}
-      EOT
+      WARNING
       Basic.const_get(missing_const_name)
     else
       super
@@ -36,11 +38,10 @@ module SuperDiff
 
   def self.configure
     yield configuration
-    configuration.updated
   end
 
   def self.configuration
-    @_configuration ||= Core::Configuration.new
+    @configuration ||= Core::Configuration.new
   end
 
   def self.diff(
@@ -114,7 +115,7 @@ module SuperDiff
 
   def self.primitive?(value)
     case value
-    when true, false, nil, Symbol, Numeric, Regexp, Class
+    when true, false, nil, Symbol, Numeric, Regexp, Class, Module, String
       true
     else
       false
@@ -122,16 +123,12 @@ module SuperDiff
   end
 
   def self.insert_overrides(target_module, mod = nil, &block)
-    mod ? target_module.prepend(mod) : target_module.prepend(Module.new(&block))
+    target_module.prepend(mod || Module.new(&block))
   end
 
   def self.insert_singleton_overrides(target_module, mod = nil, &block)
-    if mod
-      target_module.singleton_class.prepend(mod)
-    else
-      target_module.singleton_class.prepend(Module.new(&block))
-    end
+    target_module.singleton_class.prepend(mod || Module.new(&block))
   end
 end
 
-require "super_diff/basic"
+require 'super_diff/basic'

data/super_diff.gemspec

@@ -1,31 +1,33 @@
-require File.expand_path("lib/super_diff/version", __dir__)
+# frozen_string_literal: true
+
+require File.expand_path('lib/super_diff/version', __dir__)
 
 Gem::Specification.new do |s|
-  s.name = "super_diff"
+  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"
+    'A better way to view differences between complex data structures in RSpec.'
+  s.license = 'MIT'
   s.description = <<~DESC
     SuperDiff is a gem that hooks into RSpec to intelligently display the
     differences between two data structures of any type.
   DESC
   s.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'
   }
-  s.required_ruby_version = ">= 3"
+  s.required_ruby_version = '>= 3.0'
 
-  s.files = %w[README.md super_diff.gemspec] + Dir["lib/**/*"]
-  s.test_files = Dir["spec/**/*"]
-  s.executables = Dir["exe/**/*"].map { |f| File.basename(f) }
+  s.files = %w[README.md super_diff.gemspec] + Dir['lib/**/*']
+  s.executables = Dir['exe/**/*'].map { |f| File.basename(f) }
 
-  s.add_dependency "attr_extras", ">= 6.2.4"
-  s.add_dependency "diff-lcs"
-  s.add_dependency "patience_diff"
+  s.add_dependency 'attr_extras', '>= 6.2.4'
+  s.add_dependency 'diff-lcs'
+  s.add_dependency 'patience_diff'
 end