rspec-enriched_json 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 563d2936f51c8422129b04e84c39447739a5a0895dd02e3a1e3db58de431a9e4
+  data.tar.gz: f164a70a9216ff65b4e54dbc90b398858f0a6e3b2ea4fa00967a807e71e534c2
+SHA512:
+  metadata.gz: b3947459ce3038f272de17e1e6c5425dda737c9d694c04d628ba3a0b00041edf2b0090c51a52daa4c481db970fefe2f123037298760edd334e62e25bcf1d77c5
+  data.tar.gz: 850a62aef71132f3aa4ab925890c6f6841ff18d499e52cc919b1ced2dbf18aa8ea48c20feed970f07748e2400896292c4cd08de72b7a1e442338774cd4c0778d

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Raghu Betina
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,187 @@
+# RSpec::EnrichedJson
+
+A drop-in replacement for RSpec's built-in JSON formatter that enriches the output with structured failure data. This makes it easy to programmatically analyze test results, extract expected/actual values, and build better CI/CD integrations.
+
+## Quick Demo
+
+To see the difference between RSpec's built-in JSON formatter and this enriched formatter, use the included demo script:
+
+```bash
+# Compare the two formatters side-by-side
+# Built-in formatter (string-only failure messages):
+bundle exec rspec demo_all_failures.rb --format json --no-profile 2>/dev/null | jq '.examples[4]'
+
+# Enriched formatter (includes structured_data field):
+bundle exec rspec demo_all_failures.rb --format RSpec::EnrichedJson::Formatters::EnrichedJsonFormatter --no-profile -r ./lib/rspec/enriched_json 2>/dev/null | jq '.examples[4]'
+
+# For a cleaner comparison, look at just the structured data:
+bundle exec rspec demo_all_failures.rb --format RSpec::EnrichedJson::Formatters::EnrichedJsonFormatter --no-profile -r ./lib/rspec/enriched_json 2>/dev/null | jq '.examples[] | select(.description == "fails with string comparison") | .structured_data'
+```
+
+The demo file `demo_all_failures.rb` contains 59 different test failure scenarios covering virtually all RSpec matcher types and how they appear in the JSON output.
+
+The demo script (`demo_all_failures.rb`) includes various types of test failures:
+- Simple equality failures
+- String, array, and hash comparisons
+- Custom error messages
+- Exception failures
+- Complex object comparisons
+- Various matcher types (include, respond_to, be_within, etc.)
+
+Key differences you'll see:
+- **Built-in formatter**: Failure information is embedded in string messages
+- **Enriched formatter**: Adds a `structured_data` field with:
+  - `expected`: The expected value as a proper JSON object
+  - `actual`: The actual value as a proper JSON object
+  - `matcher_name`: The RSpec matcher class used
+  - `original_message`: Preserved when custom messages are provided
+
+## Requirements
+
+- Ruby 2.7 or higher
+- RSpec 3.0 or higher
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-enriched_json'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rspec-enriched_json
+
+## Usage
+
+Use it just like RSpec's built-in JSON formatter:
+
+```bash
+# Command line
+rspec --format RSpec::EnrichedJson::Formatters::EnrichedJsonFormatter
+
+# Or in your .rspec file
+--format RSpec::EnrichedJson::Formatters::EnrichedJsonFormatter
+
+# Or in spec_helper.rb
+RSpec.configure do |config|
+  config.formatter = RSpec::EnrichedJson::Formatters::EnrichedJsonFormatter
+end
+```
+
+## What's Different?
+
+### Standard RSpec JSON Output
+
+With RSpec's built-in JSON formatter, failure information comes as a string:
+
+```json
+{
+  "exception": {
+    "message": "\nexpected: \"Hello, Ruby!\"\n     got: \"Hello, World!\"\n\n(compared using ==)\n"
+  }
+}
+```
+
+### Enriched JSON Output
+
+With this gem, you get structured data alongside the original message:
+
+```json
+{
+  "exception": {
+    "class": "RSpec::EnrichedJson::EnrichedExpectationNotMetError",
+    "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)>'"]
+  },
+  "structured_data": {
+    "expected": "Hello, Ruby!",
+    "actual": "Hello, World!",
+    "matcher_name": "RSpec::Matchers::BuiltIn::Eq",
+    "original_message": null
+  }
+}
+```
+
+## Features
+
+- **Drop-in replacement**: Inherits from RSpec's JsonFormatter, maintaining 100% compatibility
+- **Structured data extraction**: Expected and actual values as proper JSON objects
+- **Rich object support**: Arrays, hashes, and custom objects are properly serialized
+- **Original message preservation**: When you override with a custom message, the original is preserved
+- **Graceful degradation**: Regular exceptions (non-expectation failures) work normally
+
+## Examples
+
+### Simple Values
+```ruby
+expect(1 + 1).to eq(3)
+# structured_data: { "expected": 3, "actual": 2 }
+```
+
+### Collections
+```ruby
+expect([1, 2, 3]).to eq([1, 2, 4])
+# structured_data: { "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))
+# structured_data includes class info and struct values
+```
+
+### Custom Messages
+```ruby
+expect(balance).to be >= required,
+  "Insufficient funds: $#{balance} available, $#{required} required"
+# exception.message: "Insufficient funds: $50 available, $100 required"
+# structured_data: { "original_message": "expected: >= 100\n     got:    50" }
+```
+
+## Use Cases
+
+- **CI/CD Integration**: Parse test results to create rich error reports
+- **Test Analytics**: Track which values commonly cause test failures  
+- **Debugging Tools**: Build tools that can display expected vs actual diffs
+- **Learning Platforms**: Provide detailed feedback on why tests failed
+
+## How It Works
+
+The gem works by:
+
+1. Patching RSpec's expectation system to capture structured data when expectations fail
+2. Extending the JsonFormatter to include this data in the JSON output
+3. Maintaining full backward compatibility with existing tools
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+
+## Performance Considerations
+
+The enriched formatter adds minimal overhead:
+- Only processes failing tests (passing tests have no extra processing)
+- Limits serialization depth to prevent infinite recursion
+- Truncates large strings and collections to maintain reasonable output sizes
+- No impact on test execution time, only on failure reporting
+
+Default limits:
+- Max serialization depth: 5 levels
+- Max array size: 100 items
+- Max hash size: 100 keys
+- Max string length: 1000 characters
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/firstdraft/rspec-enriched_json.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/rspec/enriched_json/enriched_expectation_not_met_error.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "rspec/expectations"
+
+module RSpec
+  module EnrichedJson
+    # Custom exception that carries structured data alongside the message
+    class EnrichedExpectationNotMetError < RSpec::Expectations::ExpectationNotMetError
+      attr_reader :structured_data
+
+      def initialize(message, structured_data = {})
+        super(message)
+        @structured_data = structured_data
+      end
+    end
+  end
+end

data/lib/rspec/enriched_json/expectation_helper_wrapper.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require "json"
+require "rspec/expectations"
+
+module RSpec
+  module EnrichedJson
+    # Universal wrapper to catch ALL matchers and attach structured data
+    module ExpectationHelperWrapper
+      MAX_SERIALIZATION_DEPTH = 5
+      MAX_ARRAY_SIZE = 100
+      MAX_HASH_SIZE = 100
+      MAX_STRING_LENGTH = 1000
+      def self.install!
+        RSpec::Expectations::ExpectationHelper.singleton_class.prepend(self)
+      end
+
+      def handle_failure(matcher, message, failure_message_method)
+        # If a custom message is provided, capture the original message first
+        original_message = nil
+        if message
+          original_message = matcher.send(failure_message_method)
+        end
+
+        # Call original handler with the original message
+        super
+      rescue RSpec::Expectations::ExpectationNotMetError => e
+        # Collect structured data
+        structured_data = {
+          expected: serialize_value(extract_value(matcher, :expected)),
+          actual: serialize_value(extract_value(matcher, :actual)),
+          original_message: original_message,  # Only populated when custom message overrides it
+          matcher_name: matcher.class.name
+        }
+
+        # Raise new exception with data attached
+        raise EnrichedExpectationNotMetError.new(e.message, structured_data)
+      end
+
+      private
+
+      def extract_value(matcher, method_name)
+        return nil unless matcher.respond_to?(method_name)
+
+        value = matcher.send(method_name)
+        (value == matcher) ? nil : value
+      rescue
+        nil
+      end
+
+      def serialize_value(value, depth = 0)
+        return "[Max depth exceeded]" if depth > MAX_SERIALIZATION_DEPTH
+
+        case value
+        when nil, Numeric, TrueClass, FalseClass
+          value
+        when String
+          truncate_string(value)
+        when Symbol
+          value.to_s
+        when Array
+          return "[Large array: #{value.size} items]" if value.size > MAX_ARRAY_SIZE
+          value.map { |v| serialize_value(v, depth + 1) }
+        when Hash
+          return "[Large hash: #{value.size} keys]" if value.size > MAX_HASH_SIZE
+          value.transform_values { |v| serialize_value(v, depth + 1) }
+        else
+          serialize_object(value, depth)
+        end
+      rescue => e
+        {
+          "class" => value.class.name,
+          "serialization_error" => e.message
+        }
+      end
+
+      def serialize_object(obj, depth = 0)
+        result = {
+          "class" => obj.class.name,
+          "inspect" => safe_inspect(obj),
+          "to_s" => safe_to_s(obj)
+        }
+
+        # Handle Structs specially
+        if obj.is_a?(Struct)
+          result["struct_values"] = obj.to_h.transform_values { |v| serialize_value(v, depth + 1) }
+        end
+
+        # Include instance variables only for small objects
+        ivars = obj.instance_variables
+        if ivars.any? && ivars.length <= 10
+          result["instance_variables"] = ivars.each_with_object({}) do |ivar, hash|
+            hash[ivar.to_s] = serialize_value(obj.instance_variable_get(ivar), depth + 1)
+          end
+        end
+
+        result
+      end
+
+      def truncate_string(str)
+        return str if str.length <= MAX_STRING_LENGTH
+        "#{str[0...MAX_STRING_LENGTH]}... (truncated)"
+      end
+
+      def safe_inspect(obj)
+        truncate_string(obj.inspect)
+      rescue => e
+        "[inspect failed: #{e.class}]"
+      end
+
+      def safe_to_s(obj)
+        truncate_string(obj.to_s)
+      rescue => e
+        "[to_s failed: #{e.class}]"
+      end
+    end
+  end
+end
+
+# Auto-install when this file is required
+RSpec::EnrichedJson::ExpectationHelperWrapper.install!

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "json"
+require "rspec/core/formatters/json_formatter"
+
+module RSpec
+  module EnrichedJson
+    module Formatters
+      class EnrichedJsonFormatter < RSpec::Core::Formatters::JsonFormatter
+        RSpec::Core::Formatters.register self, :message, :dump_summary, :dump_profile, :stop, :seed, :close
+
+        def stop(group_notification)
+          @output_hash[:examples] = group_notification.notifications.map do |notification|
+            format_example(notification.example).tap do |hash|
+              e = notification.example.exception
+
+              if e
+                hash[:exception] = {
+                  class: e.class.name,
+                  message: e.message,
+                  backtrace: notification.formatted_backtrace
+                }
+
+                # Add structured data if available
+                if e.is_a?(RSpec::EnrichedJson::EnrichedExpectationNotMetError) && e.structured_data
+                  hash[:structured_data] = {
+                    expected: e.structured_data[:expected],
+                    actual: e.structured_data[:actual],
+                    matcher_name: e.structured_data[:matcher_name],
+                    original_message: e.structured_data[:original_message]
+                  }
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/enriched_json/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RSpec
+  module EnrichedJson
+    VERSION = "0.1.0"
+  end
+end

data/lib/rspec/enriched_json.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "rspec/enriched_json/version"
+require "rspec/enriched_json/enriched_expectation_not_met_error"
+require "rspec/enriched_json/expectation_helper_wrapper"
+require "rspec/enriched_json/formatters/enriched_json_formatter"
+
+module RSpec
+  module EnrichedJson
+  end
+end

data/rspec-enriched_json.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/rspec/enriched_json/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rspec-enriched_json"
+  spec.version = RSpec::EnrichedJson::VERSION
+  spec.authors = ["Raghu Betina"]
+  spec.email = ["raghu@firstdraft.com"]
+  spec.homepage = "https://github.com/firstdraft/rspec-enriched_json"
+  spec.summary = "Enriches RSpec JSON output with structured failure data"
+  spec.description = "A drop-in replacement for RSpec's built-in JSON formatter that adds structured test failure data, making it easy to programmatically analyze test results."
+  spec.license = "MIT"
+
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/firstdraft/rspec-enriched_json/issues",
+    "changelog_uri" => "https://github.com/firstdraft/rspec-enriched_json/blob/main/CHANGELOG.md",
+    "homepage_uri" => "https://github.com/firstdraft/rspec-enriched_json",
+    "rubygems_mfa_required" => "true",
+    "source_code_uri" => "https://github.com/firstdraft/rspec-enriched_json"
+  }
+
+  spec.required_ruby_version = ">= 2.7.0"
+  spec.add_dependency "rspec-core", ">= 3.0"
+  spec.add_dependency "rspec-expectations", ">= 3.0"
+
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "standard", "~> 1.0"
+
+  spec.extra_rdoc_files = Dir["README*", "LICENSE*"]
+  spec.files = Dir["*.gemspec", "lib/**/*"]
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: rspec-enriched_json
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Raghu Betina
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A drop-in replacement for RSpec's built-in JSON formatter that adds structured
+  test failure data, making it easy to programmatically analyze test results.
+email:
+- raghu@firstdraft.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.md
+- README.md
+files:
+- LICENSE.md
+- README.md
+- lib/rspec/enriched_json.rb
+- lib/rspec/enriched_json/enriched_expectation_not_met_error.rb
+- lib/rspec/enriched_json/expectation_helper_wrapper.rb
+- lib/rspec/enriched_json/formatters/enriched_json_formatter.rb
+- lib/rspec/enriched_json/version.rb
+- rspec-enriched_json.gemspec
+homepage: https://github.com/firstdraft/rspec-enriched_json
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/firstdraft/rspec-enriched_json/issues
+  changelog_uri: https://github.com/firstdraft/rspec-enriched_json/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/firstdraft/rspec-enriched_json
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/firstdraft/rspec-enriched_json
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Enriches RSpec JSON output with structured failure data
+test_files: []