rspec-enriched_json 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae7cf3c69f8919e4810f402f0f34fa88bb69affbadcf6f0f9ec0f1150a4bd184
-  data.tar.gz: 4102bf64a17bf2a5d925814f0cb63cb749c14a41a1c8df099a85c1c636b1737c
+  metadata.gz: 897a7b35c81a2a9b629d4af420b37e5f404e360ad92d6bfb06a983c580687f2c
+  data.tar.gz: 3907177ad79acea11dff76511d2fbb6d5577a6e234147a6a66b47519fdd3e527
 SHA512:
-  metadata.gz: 389db8798122e41f7bceacd58fe4532b2856b3795b96f540915fbe40f2dab9e6892b1dd7b790c7b04254db450d0696188ef3522d6971309808cf15eaa7bcb63b
-  data.tar.gz: 2d1a5f679578f2621bc54e9a60199ba167e5a7e5bb03fb027aaefdb0183d420e10d9e14abc1879e7ab43f04215348a823f732043e48feeb8ae2f898a029a2336
+  metadata.gz: 5573a16911801b63c1210357122e97436e1cb5a5ad2d5e3addc089b8afd60bc3a1bb995c34a7a252f4ed926123e011f7c331c8ec681ad2907f6d079d946c4e95
+  data.tar.gz: 6114b639b4b64796f06629cbf4ac5b323d62647175a10738af938236e1c261883097dc1d914fb179b5b2431d05063f5b2a28a6c0a72473b3546bed43c5c7255f

data/README.md

@@ -10,7 +10,7 @@ To see the difference between RSpec's built-in JSON formatter and this enriched
 ruby demo.rb
 ```
 
-This interactive demo script runs the same failing tests with both formatters and shows you the difference side-by-side. No external dependencies, no file cleanup needed!
+This interactive demo script runs the same failing tests with both formatters and shows you the difference side-by-side.
 
 **What you'll see:**
 - **Built-in formatter**: Failure information embedded in string messages  
@@ -83,14 +83,12 @@ With this gem, you get structured data alongside the original message:
     "message": "\nexpected: \"Hello, Ruby!\"\n     got: \"Hello, World!\"\n\n(compared using ==)\n",
     "backtrace": ["./spec/example_spec.rb:5:in `block (2 levels) in <top (required)>'"]
   },
-  "enriched_with": {
+  "details": {
     "expected": "Hello, Ruby!",
     "actual": "Hello, World!",
     "matcher_name": "RSpec::Matchers::BuiltIn::Eq",
     "original_message": null,
-    "diff_info": {
-      "diffable": true
-    }
+    "diffable": true
   }
 }
 ```
@@ -104,27 +102,27 @@ With this gem, you get structured data alongside the original message:
 - **Graceful degradation**: Regular exceptions (non-expectation failures) work normally
 - **Enhanced metadata capture**: Test location, tags, hierarchy, and custom metadata
 - **Robust error recovery**: Handles objects that fail to serialize without crashing
-- **Diff information**: Includes `diff_info.diffable` to help tools determine if values can be meaningfully diffed
+- **Diff information**: Includes `diffable` to help tools determine if values can be meaningfully diffed
 
 ## Examples
 
 ### Simple Values
 ```ruby
 expect(1 + 1).to eq(3)
-# enriched_with: { "expected": 3, "actual": 2 }
+# details: { "expected": 3, "actual": 2 }
 ```
 
 ### Collections
 ```ruby
 expect([1, 2, 3]).to eq([1, 2, 4])
-# enriched_with: { "expected": [1, 2, 4], "actual": [1, 2, 3] }
+# details: { "expected": [1, 2, 4], "actual": [1, 2, 3] }
 ```
 
 ### Complex Objects
 ```ruby
 Product = Struct.new(:name, :price)
 expect(Product.new("Laptop", 999)).to eq(Product.new("Laptop", 899))
-# enriched_with includes class info and struct values
+# details includes class info and struct values
 ```
 
 ### Custom Messages
@@ -132,7 +130,7 @@ expect(Product.new("Laptop", 999)).to eq(Product.new("Laptop", 899))
 expect(balance).to be >= required,
   "Insufficient funds: $#{balance} available, $#{required} required"
 # exception.message: "Insufficient funds: $50 available, $100 required"
-# enriched_with: { "original_message": "expected: >= 100\n     got:    50" }
+# details: { "original_message": "expected: >= 100\n     got:    50" }
 ```
 
 ### Metadata Capture

data/lib/rspec/enriched_json/enriched_expectation_not_met_error.rb

@@ -6,11 +6,11 @@ module RSpec
   module EnrichedJson
     # Custom exception that carries structured data alongside the message
     class EnrichedExpectationNotMetError < RSpec::Expectations::ExpectationNotMetError
-      attr_reader :enriched_with
+      attr_reader :details
 
-      def initialize(message, enriched_with = {})
+      def initialize(message, details = {})
         super(message)
-        @enriched_with = enriched_with
+        @details = details
       end
     end
   end

data/lib/rspec/enriched_json/expectation_helper_wrapper.rb

@@ -106,18 +106,16 @@ module RSpec
         actual_raw = extract_value(matcher, :actual)
 
         # Collect structured data
-        enriched_with = {
+        details = {
           expected: Serializer.serialize_value(expected_raw),
           actual: Serializer.serialize_value(actual_raw),
           original_message: original_message,  # Only populated when custom message overrides it
           matcher_name: matcher.class.name,
-          diff_info: {
-            diffable: values_diffable?(expected_raw, actual_raw, matcher)
-          }
+          diffable: values_diffable?(expected_raw, actual_raw, matcher)
         }
 
         # Raise new exception with data attached
-        raise EnrichedExpectationNotMetError.new(e.message, enriched_with)
+        raise EnrichedExpectationNotMetError.new(e.message, details)
       end
 
       private

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

@@ -25,8 +25,8 @@ module RSpec
                 }
 
                 # Add structured data if available
-                if e.is_a?(RSpec::EnrichedJson::EnrichedExpectationNotMetError) && e.enriched_with
-                  hash[:enriched_with] = safe_structured_data(e.enriched_with)
+                if e.is_a?(RSpec::EnrichedJson::EnrichedExpectationNotMetError) && e.details
+                  hash[:details] = safe_structured_data(e.details)
                 end
               end
             end
@@ -84,13 +84,13 @@ module RSpec
           hierarchy
         end
 
-        def safe_structured_data(enriched_with)
+        def safe_structured_data(details)
           {
-            expected: safe_serialize(enriched_with[:expected]),
-            actual: safe_serialize(enriched_with[:actual]),
-            matcher_name: enriched_with[:matcher_name],
-            original_message: enriched_with[:original_message],
-            diff_info: enriched_with[:diff_info]
+            expected: safe_serialize(details[:expected]),
+            actual: safe_serialize(details[:actual]),
+            matcher_name: details[:matcher_name],
+            original_message: details[:original_message],
+            diffable: details[:diffable]
           }.compact
         end
 

data/lib/rspec/enriched_json/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-enriched_json
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Raghu Betina