rspec-enriched_json 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 897a7b35c81a2a9b629d4af420b37e5f404e360ad92d6bfb06a983c580687f2c
-  data.tar.gz: 3907177ad79acea11dff76511d2fbb6d5577a6e234147a6a66b47519fdd3e527
+  metadata.gz: c155a0065925088da970a60a0c9d2ca9522fd1d50c15ac935a0e433b5fc7db34
+  data.tar.gz: 34ebf27abad693dd02c86a74508b9166d1e58eb9911cbf8432e1aefab00c1b04
 SHA512:
-  metadata.gz: 5573a16911801b63c1210357122e97436e1cb5a5ad2d5e3addc089b8afd60bc3a1bb995c34a7a252f4ed926123e011f7c331c8ec681ad2907f6d079d946c4e95
-  data.tar.gz: 6114b639b4b64796f06629cbf4ac5b323d62647175a10738af938236e1c261883097dc1d914fb179b5b2431d05063f5b2a28a6c0a72473b3546bed43c5c7255f
+  metadata.gz: 74be0b49aec163bb30b2d9924f617fcf001cd9994dd351e67e5962b48f53c1e005d0046acc03f78fcbeede84082a04984a08742b540d3835d648ff824d83c965
+  data.tar.gz: 933b7e250a69259b2781a23637bdf8b69543a941700c22eb174806f684a26e13dd9b3488a8839108ae0d29e7dde9138cb135a2b5daf49031041be7b69e72ceea

data/lib/rspec/enriched_json/expectation_helper_wrapper.rb

@@ -2,6 +2,7 @@
 
 require "json"
 require "rspec/expectations"
+require "rspec/support/differ"
 
 module RSpec
   module EnrichedJson
@@ -28,12 +29,16 @@ module RSpec
           return "[Max depth exceeded]" if depth > MAX_SERIALIZATION_DEPTH
 
           case value
-          when nil, Numeric, TrueClass, FalseClass
+          when Numeric, TrueClass, FalseClass
             value
           when String
-            truncate_string(value)
+            unescape_string_double_quotes(
+              truncate_string(value)
+            )
           when Symbol
-            value.to_s
+            serialize_object(value)
+          when nil
+            serialize_object(value)
           when Array
             return "[Large array: #{value.size} items]" if value.size > MAX_ARRAY_SIZE
             value.map { |v| serialize_value(v, depth + 1) }
@@ -78,6 +83,14 @@ module RSpec
           "#{str[0...MAX_STRING_LENGTH]}... (truncated)"
         end
 
+        def unescape_string_double_quotes(str)
+          if str.start_with?('"') && str.end_with?('"')
+            return str.undump
+          else
+            str
+          end
+        end
+
         def safe_inspect(obj)
           truncate_string(obj.inspect)
         rescue => e
@@ -109,11 +122,21 @@ module RSpec
         details = {
           expected: Serializer.serialize_value(expected_raw),
           actual: Serializer.serialize_value(actual_raw),
-          original_message: original_message,  # Only populated when custom message overrides it
+          original_message: original_message, # Only populated when custom message overrides it
           matcher_name: matcher.class.name,
           diffable: values_diffable?(expected_raw, actual_raw, matcher)
         }
 
+        # Generate diff if values are diffable
+        if details[:diffable] && expected_raw && actual_raw
+          diff = generate_diff(actual_raw, expected_raw)
+          details[:diff] = diff unless diff.nil? || diff.strip.empty?
+        end
+
+        # Capture matcher-specific instance variables
+        matcher_data = extract_matcher_specific_data(matcher)
+        details.merge!(matcher_data) unless matcher_data.empty?
+
         # Raise new exception with data attached
         raise EnrichedExpectationNotMetError.new(e.message, details)
       end
@@ -131,6 +154,71 @@ module RSpec
         nil
       end
 
+      def extract_matcher_specific_data(matcher)
+        # Skip common instance variables that are already captured
+        skip_vars = [
+          :@expected, :@actual, :@args, :@name,
+          # Skip internal implementation details
+          :@matcher, :@matchers, :@target,
+          :@delegator, :@base_matcher,
+          :@block, :@event_proc,
+          # Skip verbose internal state
+          :@pairings_maximizer, :@best_solution,
+          :@expected_captures, :@match_captures,
+          :@failures, :@errors,
+          # Skip RSpec internals
+          :@matcher_execution_context,
+          :@chained_method_with_args_combos
+        ]
+
+        # Define meaningful variables we want to keep
+        useful_vars = [
+          :@missing_items, :@extra_items,  # ContainExactly
+          :@expecteds, :@actuals,           # Include
+          :@operator, :@delta, :@tolerance, # Comparison matchers
+          :@expected_before, :@expected_after, :@actual_before, :@actual_after, # Change matcher
+          :@from, :@to, :@minimum, :@maximum, :@count, # Various matchers
+          :@failure_message, :@failure_message_when_negated,
+          :@description
+        ]
+
+        # Get all instance variables
+        ivars = matcher.instance_variables - skip_vars
+        return {} if ivars.empty?
+
+        # Build a hash of matcher-specific data
+        matcher_data = {}
+
+        ivars.each do |ivar|
+          # Only include if it's in our useful list or looks like user data
+          unless useful_vars.include?(ivar) || ivar.to_s.match?(/^@(missing|extra|failed|unmatched|matched)_/)
+            next
+          end
+
+          value = matcher.instance_variable_get(ivar)
+
+          # Skip if value is nil or the matcher itself
+          next if value.nil? || value == matcher
+
+          # Skip procs and complex objects unless they're simple collections
+          if value.is_a?(Proc) || (value.is_a?(Object) && !value.is_a?(Enumerable) && !value.is_a?(Numeric) && !value.is_a?(String) && !value.is_a?(Symbol))
+            next
+          end
+
+          # Convert instance variable name to a more readable format
+          # @missing_items -> missing_items
+          key = ivar.to_s.delete_prefix("@").to_sym
+
+          # Serialize the value
+          matcher_data[key] = Serializer.serialize_value(value)
+        rescue
+          # Skip this instance variable if we can't serialize it
+          next
+        end
+
+        matcher_data
+      end
+
       def values_diffable?(expected, actual, matcher)
         # First check if the matcher itself declares diffability
         if matcher.respond_to?(:diffable?)
@@ -157,6 +245,20 @@ module RSpec
         # If any error occurs during checking, assume not diffable
         false
       end
+
+      def generate_diff(actual, expected)
+        # Use RSpec's own differ for consistency
+        differ = RSpec::Support::Differ.new(
+          object_preparer: lambda { |obj|
+            RSpec::Matchers::Composable.surface_descriptions_in(obj)
+          },
+          color: false # Always disable color for JSON output
+        )
+        differ.diff(actual, expected)
+      rescue
+        # If diff generation fails, return nil rather than crashing
+        nil
+      end
     end
   end
 end

data/lib/rspec/enriched_json/formatters/enriched_json_formatter.rb

@@ -28,6 +28,13 @@ module RSpec
                 if e.is_a?(RSpec::EnrichedJson::EnrichedExpectationNotMetError) && e.details
                   hash[:details] = safe_structured_data(e.details)
                 end
+
+                if hash.key?(:details) && hash[:details].key?(:expected) && hash[:details].key?(:actual)
+                  exception_message = hash[:exception][:message]
+                  if exception_message.include?("\nDiff:")
+                    hash[:exception][:message] = exception_message.sub(/Diff:.*/m, "").strip
+                  end
+                end
               end
             end
           end
@@ -85,13 +92,22 @@ module RSpec
         end
 
         def safe_structured_data(details)
-          {
+          # Start with core fields
+          result = {
             expected: safe_serialize(details[:expected]),
             actual: safe_serialize(details[:actual]),
             matcher_name: details[:matcher_name],
             original_message: details[:original_message],
             diffable: details[:diffable]
-          }.compact
+          }
+
+          # Add any additional matcher-specific fields
+          details.each do |key, value|
+            next if [:expected, :actual, :matcher_name, :original_message, :diffable].include?(key)
+            result[key] = safe_serialize(value)
+          end
+
+          result.compact
         end
 
         def safe_serialize(value)

data/lib/rspec/enriched_json/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module EnrichedJson
-    VERSION = "0.5.0"
+    VERSION = "0.6.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-enriched_json
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Raghu Betina
@@ -120,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Enriches RSpec JSON output with structured failure data
 test_files: []