rspec_hashdiff_helper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6691eb2a2f62e9ded52f11fa362814abbd0f40d9de115204deaa386dbb17d81a
+  data.tar.gz: c2391bf2b180f2619d58044ecea1dc9410123ebe0c1d821a4891fc33b315bdfc
+SHA512:
+  metadata.gz: db77db2a44b9c34a97cf4af1eb549c9c0d73a55eb0f5d578132d9e5bc03625f2241a1d4a7c3d65203ce3ea0ee531210cad944b302b8f106a0e58e9b43e81720a
+  data.tar.gz: b3bb274130e403f4a0560e2b7d2ca55f2a844be7284cd8e79024d1c238d83b13764cd3a4887af4d8081047ef37cab2b2d3363f269c5d0c11716472537e04a582

data/lib/rspec_hashdiff_helper.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'hashdiff'
+
+module RSpec
+  module Support
+    class Differ # rubocop:disable Style/Documentation
+      def strip_matchers(expected)
+        if expected.respond_to?(:expected)
+          strip_matchers(expected.expected)
+        elsif expected.instance_of?(Hash)
+          expected.transform_values { |v| strip_matchers(v) }
+        elsif expected.instance_of?(Array)
+          expected.map { |v| strip_matchers(v) }
+        else
+          expected
+        end
+      end
+
+      def find_contain_nodes(object, current_path = [])
+        if object.instance_of?(RSpec::Matchers::BuiltIn::Match)
+          find_contain_nodes(object.expected, current_path)
+        elsif object.instance_of?(RSpec::Matchers::BuiltIn::ContainExactly)
+          paths = [current_path.dup]
+          find_contain_nodes(object.expected, current_path).each { |p| paths << p }
+          paths
+        elsif object.instance_of?(Hash)
+          paths = []
+          object.each { |key, value| find_contain_nodes(value, current_path.dup << key).each { |p| paths << p } }
+          paths
+        elsif object.instance_of?(Array)
+          paths = []
+          object.each_with_index { |value, index| find_contain_nodes(value, current_path.dup << index).each { |p| paths << p } }
+          paths
+        else
+          []
+        end
+      end
+
+      def format_hashes_for_diff(actual, expected)
+        paths_to_contain_nodes = find_contain_nodes(expected)
+        expected = strip_matchers(expected)
+
+        paths_to_contain_nodes.each do |full_path|
+          actual_target = actual
+          expected_target = expected
+          full_path.each do |step|
+            actual_target = actual_target.respond_to?(:[]) ? actual_target[step] : nil
+            expected_target = expected_target[step]
+          end
+
+          actual_target&.sort_by! { |v| v.instance_of?(Hash) ? v.to_s : v }
+          expected_target.sort_by! { |v| v.instance_of?(Hash) ? v.to_s : v }
+        end
+
+        [actual, expected]
+      end
+
+      def diff_as_object(actual, expected)
+        if actual.instance_of?(Hash) && expected.instance_of?(Hash)
+          mod_actual, mod_expected = format_hashes_for_diff(actual, expected)
+          diff = Hashdiff.diff(mod_actual,
+                               mod_expected,
+                               delimiter: ':',
+                               array_path: true,
+                               similarity: 1,
+                               strict: false,
+                               use_lcs: false,
+                               indifferent: true)
+
+          diff_str = diff.sort_by { |x| x[1].map(&:to_s) }.map do |diff_line|
+            keys = diff_line[1]
+            case diff_line[0]
+            when '~'
+              "+ #{keys.map { |key| "{#{key}:" }.join} #{diff_line[2]} #{Array.new(keys.length) { '}' }.join}\n" \
+                "- #{keys.map { |key| "{#{key}:" }.join} #{diff_line[3]} #{Array.new(keys.length) { '}' }.join}\n"
+            when '+', '-'
+              "#{diff_line[0]} #{keys.map { |key| "{#{key}:" }.join}"\
+                " #{diff_line[2]} #{Array.new(keys.length) { '}' }.join}\n"
+            end
+          end.join
+          color_diff "\n#{diff_str}"
+        else
+          actual_as_string = object_to_string(actual)
+          expected_as_string = object_to_string(expected)
+          diff_as_string(actual_as_string, expected_as_string)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: rspec_hashdiff_helper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sid Shanker
+- Robert Uhl
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashdiff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rspec_hashdiff_helper.rb
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '='
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: A library for rspec that displays better hash diffs
+test_files: []