rspec-ai-formatter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78649016754440db1ab8030edcf686c32a35871bb8d967d3b2423e6677c6d68c
-  data.tar.gz: 3d82c9e6e41523f4e914d6a66815755cbe7e59d5313feadc938fcbe6ec785904
+  metadata.gz: cc6a7dcbd86749ed1474847222a8ec4ecad876c2f8b2bc2b7db03ede73484b0b
+  data.tar.gz: a801f5b55489c3e0b2a101325cf3f91dffb396b067bedfd7a4f68e1e02267800
 SHA512:
-  metadata.gz: 1b0d8fc0ef7a083fa584db00e2f11ad5dd0bb2a5456a7addca0ab10aac6ef6bd514ca39b24f208b82d5dcfda027ab20b2b9617a8a94fbe57acd1bcc33f76874c
-  data.tar.gz: e03b3ac07503f063d3b3c9aa8c9ed3591dfb1fc85471aaa75b9d5c89c0c482762122d6187efe893c2e8ca5964ba90f202697d26ee032e22e5332363026f62763
+  metadata.gz: 02b285fe5fcd39a142700949d96da31c0997f0b60ed37eecc6f115d71bfb3fdd39733f11aff03bae94bd038374790a1412a00bf9fdfe5e2529128dbefdb3acd1
+  data.tar.gz: d7b2a3a616155ba2330044f9a39901afb3007863cde7832a31e5797374caa1014e53dff90788d854abc1ece0d73cf3d4e5c018f3a50f1e490d5e7b9770974a26

data/README.md

@@ -98,32 +98,6 @@ Includes: test names, timestamps, timing for every test.
 rspec --format progress --format RSpec::AiFormatter::Formatter --out rspec.jsonl
 ```
 
-### GitHub Actions
-
-The formatter auto-detects `GITHUB_ACTIONS=true` and emits workflow commands for inline PR annotations:
-
-```yaml
-- name: Run tests
-  env:
-    GITHUB_ACTIONS: true  # Usually already set by GitHub
-  run: bundle exec rspec --format RSpec::AiFormatter::Formatter
-```
-
-**Annotations appear on:**
-- Failed tests → `::error` with file/line
-- Skipped/pending tests → `::warning`
-
-**Example output:**
-```
-::error file=spec/models/user_spec.rb,line=42::expected false, got true
-::warning file=spec/api/client_spec.rb,line=15::Skipped: pending implementation
-```
-
-To disable annotations but keep NDJSON:
-```bash
-GITHUB_ACTIONS= bundle exec rspec --format RSpec::AiFormatter::Formatter
-```
-
 ### Parallel Tests
 
 When using `parallel_tests`, each process writes its own output file. Merge them with `rspec-ai-merge`:
@@ -161,6 +135,46 @@ rspec-ai-merge --no-summary file1.jsonl file2.jsonl
 - Combined `done` event with totals from all files
 - Deduplication summaries (if enabled)
 
+### Capybara Screenshots
+
+For system tests using Capybara, the formatter automatically captures screenshots on failure:
+
+```ruby
+# In your spec_helper.rb or rails_helper.rb
+require 'capybara/rspec'
+
+RSpec.configure do |config|
+  config.before(:each, type: :system) do
+    driven_by :selenium_chrome_headless
+  end
+end
+```
+
+When a system test fails, the screenshot path is included in the error output:
+
+```json
+{
+  "t": "test",
+  "id": "spec/system/login_spec.rb:15",
+  "n": "User logs in successfully",
+  "s": "fail",
+  "e": {
+    "type": "ExpectationNotMet",
+    "msg": "expected to find text 'Welcome'",
+    "loc": "spec/system/login_spec.rb:20",
+    "log": "tmp/rspec_logs/login_spec_15.log",
+    "screenshot": "tmp/rspec_logs/login_spec_15.png"
+  }
+}
+```
+
+The screenshot is automatically saved to the log directory alongside the failure log.
+
+**Requirements:**
+- Capybara gem must be available
+- Test type must be `:feature` or `:system`
+- Browser driver must support screenshots (Selenium, Playwright, etc.)
+
 ## Output Format
 
 ### NDJSON Stream
@@ -233,6 +247,9 @@ spec/models/user_spec.rb:42:in `block (3 levels) in <top (required)>'
 | `msg` | Truncated message (200 chars) |
 | `loc` | File:line of failure |
 | `log` | Path to full log file |
+| `screenshot` | Path to Capybara screenshot (system tests only) |
+| `sig` | MD5 signature of error (if dedup/signatures enabled) |
+| `diff` | Expected/actual diff (for expectations) |
 | `sig` | MD5 signature of error (if dedup/signatures enabled) |
 | `diff` | Expected/actual diff (for expectations) |
 
@@ -274,13 +291,10 @@ Useful when a shared setup/teardown failure cascades through many tests.
 - ✅ **Diff generation**: Smart expected/actual comparison
 - ✅ **Truncation**: Prevent token explosion on large outputs
 - ✅ **ANSI-free**: Clean text, no escape codes
-- ✅ **GitHub Actions**: Auto-detects and emits `::error`/`::warning` annotations
+- ✅ **Screenshot capture**: Auto-capture Capybara screenshots on system test failures
 
 ## TODO
 
-### CI/CD Integration
-- [x] GitHub Actions workflow command integration — Auto-detect `GITHUB_ACTIONS` env and emit `::error` / `::warning` commands for inline PR annotations
-
 ### Error Intelligence
 - [x] Error pattern deduplication across test runs — Group failures by signature hash, show "and 4 more like this"
 - [ ] Quick-fix hints integration with `did_you_mean` — Suggest typo corrections, similar method names
@@ -294,7 +308,7 @@ Useful when a shared setup/teardown failure cascades through many tests.
 ### Compatibility & Tooling
 - [ ] JUnit XML compatibility mode — Dual output for systems requiring XML
 - [x] Parallel test log merging — Clean merge of outputs from `parallel_tests` runs
-- [ ] Screenshot capture for system tests — Auto-capture Capybara screenshot path on failure
+- [x] Screenshot capture for system tests — Auto-capture Capybara screenshot path on failure
 - [ ] Custom output templates — User-defined NDJSON schema / field selection
 
 ## License

data/lib/rspec/ai_formatter/error_formatter.rb

@@ -4,7 +4,7 @@ module RSpec
   module AiFormatter
     # Formats error details for output
     module ErrorFormatter
-      def error_details(example, notification, log_path, sig = nil)
+      def error_details(example, notification, log_path, sig = nil, screenshot_path = nil)
         exception = notification.exception
         return {} unless exception
 
@@ -15,6 +15,7 @@ module RSpec
         }
 
         details[:log] = log_path if log_path && @log_dir != File::NULL
+        details[:screenshot] = screenshot_path if screenshot_path
         details[:sig] = sig if sig
 
         # Add diff for expectation failures

data/lib/rspec/ai_formatter/formatter.rb

@@ -7,6 +7,7 @@ require_relative 'log_writer'
 require_relative 'error_formatter'
 require_relative 'location_helper'
 require_relative 'output_helper'
+require_relative 'screenshot_capture'
 
 module RSpec
   module AiFormatter
@@ -17,6 +18,7 @@ module RSpec
       include ErrorFormatter
       include LocationHelper
       include OutputHelper
+      include ScreenshotCapture
 
       RSpec::Core::Formatters.register self,
                                        :start,
@@ -75,13 +77,17 @@ module RSpec
         exception = notification.exception
         log_path = write_failure_log(ex, notification)
 
+        # Capture Capybara screenshot if available
+        screenshot_path = capture_screenshot(ex)
+        screenshot_log_path = copy_screenshot_to_logs(ex, screenshot_path) if screenshot_path
+
         # Calculate signature for deduplication
         sig = error_signature(exception) if @deduplicate || ENV['RSPEC_AI_SIGNATURES'] == '1'
 
         if @deduplicate && sig && @error_signatures.key?(sig)
           handle_duplicate_error(ex, sig)
         else
-          handle_first_error(ex, notification, log_path, sig)
+          handle_first_error(ex, notification, log_path, sig, screenshot_log_path)
         end
       end
 
@@ -130,7 +136,7 @@ module RSpec
         )
       end
 
-      def handle_first_error(example, notification, log_path, sig)
+      def handle_first_error(example, notification, log_path, sig, screenshot_path = nil)
         # First occurrence of this error
         if @deduplicate && sig
           @error_signatures[sig] = {
@@ -148,7 +154,7 @@ module RSpec
           n: short_name(example),
           s: 'fail',
           time: execution_time_ms(example),
-          e: error_details(example, notification, log_path, sig),
+          e: error_details(example, notification, log_path, sig, screenshot_path),
           ts: timestamp
         )
       end

data/lib/rspec/ai_formatter/screenshot_capture.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module RSpec
+  module AiFormatter
+    # Captures Capybara screenshots on test failure
+    module ScreenshotCapture
+      def capture_screenshot(example)
+        return nil unless capybara_available?
+        return nil unless example.metadata[:type] == :feature || example.metadata[:type] == :system
+
+        screenshot_path = take_screenshot
+        return nil unless screenshot_path && File.exist?(screenshot_path)
+
+        screenshot_path
+      rescue StandardError
+        nil
+      end
+
+      def copy_screenshot_to_logs(example, screenshot_path)
+        return nil unless screenshot_path && @log_dir != File::NULL
+
+        file = example.metadata[:file_path]
+        line = example.metadata[:line_number]
+        filename = "#{File.basename(file, '.rb')}_#{line}.png"
+        dest_path = File.join(@log_dir, filename)
+
+        FileUtils.cp(screenshot_path, dest_path)
+        dest_path
+      rescue StandardError
+        nil
+      end
+
+      private
+
+      def capybara_available?
+        defined?(Capybara) && Capybara.respond_to?(:current_session)
+      end
+
+      def take_screenshot
+        # Try different Capybara screenshot methods
+        if Capybara.current_session.respond_to?(:save_screenshot)
+          # Generate unique temp path
+          temp_path = File.join(Dir.tmpdir, "rspec_ai_screenshot_#{Time.now.to_i}_#{rand(1000)}.png")
+          Capybara.current_session.save_screenshot(temp_path)
+          temp_path
+        elsif Capybara.respond_to?(:save_screenshot)
+          temp_path = File.join(Dir.tmpdir, "rspec_ai_screenshot_#{Time.now.to_i}_#{rand(1000)}.png")
+          Capybara.save_screenshot(temp_path)
+          temp_path
+        end
+      end
+    end
+  end
+end

data/lib/rspec/ai_formatter.rb

@@ -4,7 +4,7 @@ require_relative 'ai_formatter/formatter'
 
 module RSpec
   module AiFormatter
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
 
     class Error < StandardError; end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-ai-formatter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - SK
@@ -46,6 +46,7 @@ files:
 - lib/rspec/ai_formatter/location_helper.rb
 - lib/rspec/ai_formatter/log_writer.rb
 - lib/rspec/ai_formatter/output_helper.rb
+- lib/rspec/ai_formatter/screenshot_capture.rb
 - lib/rspec_ai_formatter.rb
 homepage: https://github.com/sciencejet/rspec-ai-formatter
 licenses: