capydash 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc3c0c3e8b55e78af53e8f1a8a34f44165da41b6149dec134cd2a573ba959a98
-  data.tar.gz: 4e3dbca12dc81a9914e418092def3c7a58a0bb1dfcad61d9b8d8056c99b2c063
+  metadata.gz: 70d2bf9d0141c676e7685b951931458b7f224c210ae470de7a489b15d31018d8
+  data.tar.gz: b29754791193c6533d4c382585c0e7c2a489afe3a776eaec42d085c5fb601003
 SHA512:
-  metadata.gz: 578279a43a188c65e710d163fb30936f96ceee8d4a4803408a25683d6547695c48250f960d87f63179206b3e1345fe52290f40b184805a9b8c3e004205c05f09
-  data.tar.gz: 72218c84707dfd0e7b7275b87287862e45cf2bfa629169cea372be719a6314b63350a427831ad5016478fe443d3c680385b5cc5f879948e11048cdf494ba1f3f
+  metadata.gz: c108d0f1310b218a43150e6d9421b19086353a23487af8b9fb08e479ededa947a4bb0fb35e6cd3acd6659c3afba008f698a665aa17d59bd948f3d1188300c3c7
+  data.tar.gz: b5e73a92af898a2ea0d1f4d876b61398084a018eb305e08427800152916ddc769d4d40966a97a552a64875d4672ce0d87969c90ec2bf93be4169448f740868ad

data/capydash.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Damon Clark"]
   spec.email         = ["dclark312@gmail.com"]
 
-  spec.summary       = "Minimal static HTML report generator for RSpec system tests"
-  spec.description   = "CapyDash automatically generates clean, readable HTML test reports after your RSpec suite finishes. Zero configuration required."
+  spec.summary       = "Minimal static HTML report generator for RSpec and Minitest system tests"
+  spec.description   = "CapyDash automatically generates clean, readable HTML test reports after your RSpec or Minitest suite finishes. Zero configuration required."
   spec.homepage      = "https://github.com/damonclark/capydash"
   spec.license       = "MIT"
 
@@ -16,10 +16,7 @@ Gem::Specification.new do |spec|
   spec.files         = Dir["lib/**/*", "README.md", "LICENSE*", "*.gemspec"]
   spec.require_paths = ["lib"]
 
-  # Dependencies
-  spec.add_runtime_dependency "rspec", ">= 3.0"
-
-  # Development dependencies
+  # Development dependencies (no runtime deps — works with RSpec or Minitest)
   spec.add_development_dependency "rspec-rails", "~> 6.0"
   spec.add_development_dependency "rails", ">= 6.0"
 

data/lib/capydash/assets/dashboard.css

@@ -291,3 +291,50 @@ body {
     white-space: pre-wrap;
     word-wrap: break-word;
 }
+
+.screenshot-container {
+    margin-top: 1rem;
+    padding: 1rem;
+    background: #fff5f5;
+    border: 1px solid #fed7d7;
+    border-radius: 6px;
+    cursor: pointer;
+}
+
+.screenshot-container h4 {
+    color: #e53e3e;
+    margin: 0 0 0.5rem 0;
+    font-size: 0.9rem;
+}
+
+.screenshot-container img {
+    max-width: 100%;
+    max-height: 300px;
+    border-radius: 4px;
+    border: 1px solid #ddd;
+}
+
+.lightbox {
+    display: none;
+    position: fixed;
+    top: 0;
+    left: 0;
+    width: 100%;
+    height: 100%;
+    background: rgba(0, 0, 0, 0.85);
+    z-index: 9999;
+    justify-content: center;
+    align-items: center;
+    cursor: pointer;
+}
+
+.lightbox.active {
+    display: flex;
+}
+
+.lightbox img {
+    max-width: 90%;
+    max-height: 90%;
+    border-radius: 6px;
+    box-shadow: 0 4px 20px rgba(0, 0, 0, 0.5);
+}

data/lib/capydash/assets/dashboard.js

@@ -1,3 +1,25 @@
+function openLightbox(src) {
+    var lightbox = document.getElementById('screenshotLightbox');
+    var img = document.getElementById('lightboxImage');
+    if (lightbox && img) {
+        img.src = src;
+        lightbox.classList.add('active');
+    }
+}
+
+function closeLightbox() {
+    var lightbox = document.getElementById('screenshotLightbox');
+    if (lightbox) {
+        lightbox.classList.remove('active');
+    }
+}
+
+document.addEventListener('keydown', function(e) {
+    if (e.key === 'Escape') {
+        closeLightbox();
+    }
+});
+
 function toggleTestMethod(safeId) {
     const stepsContainer = document.getElementById('steps-' + safeId);
     const button = document.querySelector('[onclick*="' + safeId + '"]');

data/lib/capydash/minitest.rb

@@ -0,0 +1,72 @@
+require 'capydash/reporter'
+
+module CapyDash
+  module Minitest
+    class Reporter < ::Minitest::AbstractReporter
+      include CapyDash::Reporter
+
+      def start
+        start_run
+      end
+
+      def record(result)
+        return unless @started_at
+
+        status = if result.skipped?
+                   'pending'
+                 elsif result.passed?
+                   'passed'
+                 else
+                   'failed'
+                 end
+
+        error_message = nil
+        if result.failure
+          error_message = format_exception(result.failure)
+        end
+
+        screenshot_path = nil
+        if status == 'failed'
+          # Rails system tests save screenshots before teardown to tmp/capybara/.
+          # By the time the reporter's record() runs, the session is torn down,
+          # so we look for the Rails-generated screenshot first.
+          screenshot_path = find_rails_screenshot(result.name) || capture_screenshot
+        end
+
+        class_name = result.klass || 'UnknownTest'
+        method_name = result.name.to_s.sub(/\Atest_/, '').tr('_', ' ')
+
+        location = nil
+        if result.respond_to?(:source_location) && result.source_location
+          location = result.source_location.join(':')
+        end
+
+        record_result({
+          class_name: class_name,
+          method_name: method_name,
+          status: status,
+          error: error_message,
+          location: location,
+          screenshot_path: screenshot_path
+        })
+      end
+
+      def report
+        generate_report
+      end
+
+      def passed?
+        true
+      end
+
+      private
+
+      def find_rails_screenshot(test_name)
+        path = File.join(Dir.pwd, "tmp", "capybara", "failures_#{test_name}.png")
+        File.exist?(path) ? path : nil
+      rescue
+        nil
+      end
+    end
+  end
+end

data/lib/capydash/reporter.rb

@@ -0,0 +1,180 @@
+require 'time'
+require 'fileutils'
+require 'erb'
+require 'cgi'
+require 'tmpdir'
+
+module CapyDash
+  class ReportData
+    attr_reader :processed_tests, :created_at, :total_tests, :passed_tests, :failed_tests
+
+    def initialize(processed_tests:, created_at:, total_tests:, passed_tests:, failed_tests:)
+      @processed_tests = processed_tests
+      @created_at = created_at
+      @total_tests = total_tests
+      @passed_tests = passed_tests
+      @failed_tests = failed_tests
+    end
+
+    def h(text)
+      CGI.escapeHTML(text.to_s)
+    end
+
+    def get_binding
+      binding
+    end
+  end
+
+  module Reporter
+    def start_run
+      @results = []
+      @started_at = Time.now
+    end
+
+    def record_result(result_hash)
+      return unless @started_at
+      @results << result_hash
+    end
+
+    def generate_report
+      return unless @started_at
+      return if @results.empty?
+
+      report_dir = File.join(Dir.pwd, "capydash_report")
+      FileUtils.mkdir_p(report_dir)
+
+      assets_dir = File.join(report_dir, "assets")
+      FileUtils.mkdir_p(assets_dir)
+
+      screenshots_dir = File.join(assets_dir, "screenshots")
+      FileUtils.rm_rf(screenshots_dir)
+      FileUtils.mkdir_p(screenshots_dir)
+
+      # Group results by class
+      tests_by_class = @results.group_by { |r| r[:class_name] }
+
+      # Calculate statistics
+      total_tests = @results.length
+      passed_tests = @results.count { |r| r[:status] == 'passed' }
+      failed_tests = @results.count { |r| r[:status] == 'failed' }
+
+      # Copy screenshots into report and build relative paths
+      screenshot_index = 0
+      @results.each do |result|
+        if result[:screenshot_path] && File.exist?(result[:screenshot_path])
+          screenshot_index += 1
+          dest_name = format("%03d.png", screenshot_index)
+          dest_path = File.join(screenshots_dir, dest_name)
+          FileUtils.cp(result[:screenshot_path], dest_path)
+          result[:screenshot_relative] = "assets/screenshots/#{dest_name}"
+        end
+      end
+
+      # Process for template
+      processed_tests = tests_by_class.map do |class_name, examples|
+        {
+          class_name: class_name,
+          methods: examples.map do |ex|
+            {
+              name: ex[:method_name],
+              status: ex[:status],
+              steps: [{
+                name: 'test_execution',
+                detail: ex[:method_name],
+                status: ex[:status],
+                error: ex[:error],
+                screenshot: ex[:screenshot_relative]
+              }]
+            }
+          end
+        }
+      end
+
+      # Generate HTML
+      html_content = generate_html(processed_tests, @started_at, total_tests, passed_tests, failed_tests)
+      File.write(File.join(report_dir, "index.html"), html_content)
+
+      # Generate CSS
+      css_content = generate_css
+      File.write(File.join(assets_dir, "dashboard.css"), css_content)
+
+      # Generate JS
+      js_content = generate_javascript
+      File.write(File.join(assets_dir, "dashboard.js"), js_content)
+
+      report_dir
+    end
+
+    def normalize_status(status)
+      case status
+      when :passed, 'passed'
+        'passed'
+      when :failed, 'failed'
+        'failed'
+      when :pending, 'pending', :skipped, 'skipped'
+        'pending'
+      else
+        status.to_s
+      end
+    end
+
+    def format_exception(exception)
+      return nil unless exception
+
+      message = exception.message || 'Unknown error'
+      backtrace = exception.backtrace || []
+
+      formatted = "#{exception.class}: #{message}"
+      if backtrace.any?
+        formatted += "\n" + backtrace.first(5).map { |line| "  #{line}" }.join("\n")
+      end
+
+      formatted
+    end
+
+    def capture_screenshot
+      return nil unless defined?(::Capybara) && defined?(::Capybara.current_session)
+
+      session = ::Capybara.current_session
+      return nil unless session.respond_to?(:save_screenshot)
+
+      tmpfile = File.join(Dir.tmpdir, "capydash_#{Time.now.to_i}_#{rand(10000)}.png")
+      session.save_screenshot(tmpfile)
+      tmpfile
+    rescue => _e
+      nil
+    end
+
+    private
+
+    def generate_html(processed_tests, created_at, total_tests, passed_tests, failed_tests)
+      processed_tests.each do |test_class|
+        test_class[:methods].each do |method|
+          method[:safe_id] = method[:name].gsub(/['"]/, '').gsub(/[^a-zA-Z0-9]/, '_')
+        end
+      end
+
+      template_path = File.join(File.dirname(__FILE__), 'templates', 'report.html.erb')
+      template = File.read(template_path)
+      erb = ERB.new(template)
+
+      report_data = CapyDash::ReportData.new(
+        processed_tests: processed_tests,
+        created_at: created_at,
+        total_tests: total_tests,
+        passed_tests: passed_tests,
+        failed_tests: failed_tests
+      )
+
+      erb.result(report_data.get_binding)
+    end
+
+    def generate_css
+      File.read(File.join(File.dirname(__FILE__), 'assets', 'dashboard.css'))
+    end
+
+    def generate_javascript
+      File.read(File.join(File.dirname(__FILE__), 'assets', 'dashboard.js'))
+    end
+  end
+end

data/lib/capydash/rspec.rb

@@ -1,114 +1,10 @@
-require 'time'
-require 'fileutils'
-require 'erb'
-require 'cgi'
+require 'capydash/reporter'
 
 module CapyDash
-  class ReportData
-    attr_reader :processed_tests, :created_at, :total_tests, :passed_tests, :failed_tests
-
-    def initialize(processed_tests:, created_at:, total_tests:, passed_tests:, failed_tests:)
-      @processed_tests = processed_tests
-      @created_at = created_at
-      @total_tests = total_tests
-      @passed_tests = passed_tests
-      @failed_tests = failed_tests
-    end
-
-    def h(text)
-      CGI.escapeHTML(text.to_s)
-    end
-
-    def get_binding
-      binding
-    end
-  end
-
   module RSpec
-    class << self
-      # Public method: Called from RSpec before(:suite) hook
-      def start_run
-        @results = []
-        @started_at = Time.now
-      end
-
-      # Public method: Called from RSpec after(:each) hook
-      def record_example(example)
-        return unless @started_at
-
-        execution_result = example.execution_result
-        status = normalize_status(execution_result.status)
-
-        error_message = nil
-        if execution_result.status == :failed && execution_result.exception
-          error_message = format_exception(execution_result.exception)
-        end
-
-        class_name = extract_class_name(example)
+    extend CapyDash::Reporter
 
-        @results << {
-          class_name: class_name,
-          method_name: example.full_description,
-          status: status,
-          error: error_message,
-          location: example.metadata[:location]
-        }
-      end
-
-      # Public method: Called from RSpec after(:suite) hook
-      def generate_report
-        return unless @started_at
-        return if @results.empty?
-
-        report_dir = File.join(Dir.pwd, "capydash_report")
-        FileUtils.mkdir_p(report_dir)
-
-        assets_dir = File.join(report_dir, "assets")
-        FileUtils.mkdir_p(assets_dir)
-
-        # Group results by class
-        tests_by_class = @results.group_by { |r| r[:class_name] }
-
-        # Calculate statistics
-        total_tests = @results.length
-        passed_tests = @results.count { |r| r[:status] == 'passed' }
-        failed_tests = @results.count { |r| r[:status] == 'failed' }
-
-        # Process for template
-        processed_tests = tests_by_class.map do |class_name, examples|
-          {
-            class_name: class_name,
-            methods: examples.map do |ex|
-              {
-                name: ex[:method_name],
-                status: ex[:status],
-                steps: [{
-                  name: 'test_execution',
-                  detail: ex[:method_name],
-                  status: ex[:status],
-                  error: ex[:error]
-                }]
-              }
-            end
-          }
-        end
-
-        # Generate HTML
-        html_content = generate_html(processed_tests, @started_at, total_tests, passed_tests, failed_tests)
-        File.write(File.join(report_dir, "index.html"), html_content)
-
-        # Generate CSS
-        css_content = generate_css
-        File.write(File.join(assets_dir, "dashboard.css"), css_content)
-
-        # Generate JS
-        js_content = generate_javascript
-        File.write(File.join(assets_dir, "dashboard.js"), js_content)
-
-        report_dir
-      end
-
-      # Public method: Sets up RSpec hooks
+    class << self
       def setup!
         return unless rspec_available?
         return if @configured
@@ -132,11 +28,47 @@ module CapyDash
             end
           end
         rescue => e
-          # If RSpec isn't ready, silently fail - it will be set up later
           @configured = false
         end
       end
 
+      def record_example(example)
+        return unless @started_at
+
+        execution_result = example.execution_result
+
+        # Derive status from exception since execution_result.status
+        # is not yet set during after(:each) hooks
+        status = if example.pending? || example.skipped?
+                   'pending'
+                 elsif execution_result.exception
+                   'failed'
+                 else
+                   'passed'
+                 end
+
+        error_message = nil
+        if execution_result.exception
+          error_message = format_exception(execution_result.exception)
+        end
+
+        screenshot_path = nil
+        if status == 'failed'
+          screenshot_path = capture_screenshot
+        end
+
+        class_name = extract_class_name(example)
+
+        record_result({
+          class_name: class_name,
+          method_name: example.full_description,
+          status: status,
+          error: error_message,
+          location: example.metadata[:location],
+          screenshot_path: screenshot_path
+        })
+      end
+
       private
 
       def rspec_available?
@@ -147,19 +79,6 @@ module CapyDash
         false
       end
 
-      def normalize_status(status)
-        case status
-        when :passed, 'passed'
-          'passed'
-        when :failed, 'failed'
-          'failed'
-        when :pending, 'pending'
-          'pending'
-        else
-          status.to_s
-        end
-      end
-
       def extract_class_name(example)
         group = example.metadata[:example_group]
         while group && group[:parent_example_group]
@@ -175,51 +94,6 @@ module CapyDash
           filename.split('_').map(&:capitalize).join('')
         end
       end
-
-      def format_exception(exception)
-        return nil unless exception
-
-        message = exception.message || 'Unknown error'
-        backtrace = exception.backtrace || []
-
-        formatted = "#{exception.class}: #{message}"
-        if backtrace.any?
-          formatted += "\n" + backtrace.first(5).map { |line| "  #{line}" }.join("\n")
-        end
-
-        formatted
-      end
-
-      def generate_html(processed_tests, created_at, total_tests, passed_tests, failed_tests)
-        # Create safe IDs for method names (escape special chars for HTML/JS)
-        processed_tests.each do |test_class|
-          test_class[:methods].each do |method|
-            method[:safe_id] = method[:name].gsub(/['"]/, '').gsub(/[^a-zA-Z0-9]/, '_')
-          end
-        end
-
-        template_path = File.join(__dir__, 'templates', 'report.html.erb')
-        template = File.read(template_path)
-        erb = ERB.new(template)
-
-        report_data = CapyDash::ReportData.new(
-          processed_tests: processed_tests,
-          created_at: created_at,
-          total_tests: total_tests,
-          passed_tests: passed_tests,
-          failed_tests: failed_tests
-        )
-
-        erb.result(report_data.get_binding)
-      end
-
-      def generate_css
-        File.read(File.join(__dir__, 'assets', 'dashboard.css'))
-      end
-
-      def generate_javascript
-        File.read(File.join(__dir__, 'assets', 'dashboard.js'))
-      end
     end
   end
 end

data/lib/capydash/templates/report.html.erb

@@ -63,6 +63,13 @@
                                                 <pre><%= h(step[:error]) %></pre>
                                             </div>
                                         <% end %>
+
+                                        <% if step[:screenshot] %>
+                                            <div class="screenshot-container" onclick="openLightbox('<%= h(step[:screenshot]) %>')">
+                                                <h4>Failure Screenshot</h4>
+                                                <img src="<%= h(step[:screenshot]) %>" alt="Failure screenshot">
+                                            </div>
+                                        <% end %>
                                     </div>
                                 <% end %>
                             </div>
@@ -72,6 +79,9 @@
             <% end %>
         </div>
     </div>
+    <div class="lightbox" id="screenshotLightbox" onclick="closeLightbox()">
+        <img id="lightboxImage" src="" alt="Screenshot full view">
+    </div>
     <script src="assets/dashboard.js"></script>
 </body>
 </html>

data/lib/capydash/version.rb

@@ -1,3 +1,3 @@
 module CapyDash
-  VERSION = "0.2.5"
+  VERSION = "0.3.0"
 end

data/lib/capydash.rb

@@ -4,12 +4,18 @@ require "capydash/version"
 if defined?(RSpec) && RSpec.respond_to?(:configure)
   require "capydash/rspec"
   CapyDash::RSpec.setup!
-elsif defined?(Rails)
-  # In Rails, RSpec might load after the gem, so set up a hook
-  Rails.application.config.after_initialize do
-    if defined?(RSpec) && RSpec.respond_to?(:configure)
-      require "capydash/rspec" unless defined?(CapyDash::RSpec)
-      CapyDash::RSpec.setup!
+elsif defined?(Rails) && defined?(Rails::Railtie)
+  # In Rails, RSpec might load after the gem, so defer setup
+  class CapyDash::Railtie < Rails::Railtie
+    config.after_initialize do
+      if defined?(RSpec) && RSpec.respond_to?(:configure)
+        require "capydash/rspec" unless defined?(CapyDash::RSpec)
+        CapyDash::RSpec.setup!
+      end
     end
   end
 end
+
+# Minitest integration is handled automatically via the minitest plugin system.
+# Minitest discovers lib/minitest/capydash_plugin.rb and calls
+# plugin_capydash_init during Minitest.run, which adds our reporter.

data/lib/minitest/capydash_plugin.rb

@@ -0,0 +1,6 @@
+module Minitest
+  def self.plugin_capydash_init(options)
+    require 'capydash/minitest'
+    self.reporter << CapyDash::Minitest::Reporter.new
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capydash
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Damon Clark
@@ -9,20 +9,6 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rspec
-  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-rails
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +38,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '6.0'
 description: CapyDash automatically generates clean, readable HTML test reports after
-  your RSpec suite finishes. Zero configuration required.
+  your RSpec or Minitest suite finishes. Zero configuration required.
 email:
 - dclark312@gmail.com
 executables: []
@@ -64,9 +50,12 @@ files:
 - lib/capydash.rb
 - lib/capydash/assets/dashboard.css
 - lib/capydash/assets/dashboard.js
+- lib/capydash/minitest.rb
+- lib/capydash/reporter.rb
 - lib/capydash/rspec.rb
 - lib/capydash/templates/report.html.erb
 - lib/capydash/version.rb
+- lib/minitest/capydash_plugin.rb
 homepage: https://github.com/damonclark/capydash
 licenses:
 - MIT
@@ -88,5 +77,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.7
 specification_version: 4
-summary: Minimal static HTML report generator for RSpec system tests
+summary: Minimal static HTML report generator for RSpec and Minitest system tests
 test_files: []