capydash 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08b9f8d42cd5b408688aaffd4e8000a2f2514e1b7cababeaef8e6b5f22e6255b'
-  data.tar.gz: fe000167bd555af57a386e7616a4a475b577881b8d8c7cd2cec996e81d5ce088
+  metadata.gz: bb913ca0b0dce3912a15dd5eb2f1fd2673671771ff34b485f4b1c5567240faa7
+  data.tar.gz: '0794e75f2f6d2d3c6e50cb0d49370c71d7f571c87a93519fc04947ff16c3c71b'
 SHA512:
-  metadata.gz: 25087505b55812541a3be9184467174c205c4c6b8cc75bd6c0c74c5c9a8995cbcd19c1f1b160c5ebda02e4cf14a6adb26de2639bc1097724931182e4ff9bbf2b
-  data.tar.gz: 16ebd46b3f89a641cd0260dbb2f08f7702b59ea89478568fbeb06e3f47e5e6a09dfdf501dd5cb528399d4dbed24417fd42c286dce391e625df9aff774168c4a0
+  metadata.gz: 153585a1af8f9ef4415a509a53c265f552bdfc496ae20409f38ce850e09624259211f53af41e13ad59bb4384936df2cdaeab3a83aab34e22dece0401fd1b4b57
+  data.tar.gz: 6079967d5cb84f6d3867a5d8ae6a996df16c8db45a800811e0c218a3d954a6615a86aea31fed07cdb2a92f0629a5d0c8e1a5eebecf0ac880af5ed4bc09307e77

data/README.md

@@ -1,6 +1,14 @@
 # CapyDash
 
-A static HTML dashboard for Capybara tests that provides comprehensive test reporting with screenshots, step-by-step tracking, error reporting, and search capabilities. Perfect for debugging test failures and understanding test behavior.
+A minimal static HTML report generator for RSpec system tests. CapyDash automatically generates a clean, readable test report after your RSpec suite finishes.
+
+## Features
+
+- ✅ **Automatic report generation** - No configuration needed
+- ✅ **RSpec system test support** - Works out of the box with `rspec-rails`
+- ✅ **Clean HTML reports** - Simple, readable test results
+- ✅ **Error details** - Full exception messages and backtraces
+- ✅ **Zero configuration** - Just add the gem and run your tests
 
 ## Installation
 
@@ -8,237 +16,128 @@ Add to your Gemfile:
 
 ```ruby
 gem "capydash"
+gem "rspec-rails"
 ```
 
-Or run:
+Then run:
 
 ```bash
-bundle add capydash
-```
-
-## Quick Setup
-
-### One-Command Installation
-
-After adding CapyDash to your Gemfile and running `bundle install`, simply run:
-
-```bash
-bundle exec rails generate capydash:install
+bundle install
 ```
 
-This will automatically:
-- ✅ Create the CapyDash initializer
-- ✅ Update your test helper with all necessary hooks
-- ✅ Add rake tasks for report generation
-- ✅ Works with parallel testing out of the box
-
-### Manual Setup (Alternative)
-
-If you prefer to set up CapyDash manually, see the [Manual Setup Guide](#manual-setup) below.
-
 ## Usage
 
-### Run Tests with CapyDash
-
-Run your tests normally - CapyDash will automatically instrument them:
+That's it! CapyDash automatically hooks into RSpec when it detects it. Just run your tests:
 
 ```bash
-bundle exec rails test
+bundle exec rspec
 ```
 
-### Generate Test Report
-
-After running your Capybara tests, generate a static HTML report:
+After your test suite completes, CapyDash will automatically generate a report at:
 
-```bash
-bundle exec rake capydash:report
 ```
-
-This will create a `capydash_report/index.html` file with:
-- Test steps in chronological order
-- Embedded screenshots for each step
-- Click-to-open/close functionality for screenshots
-- Typeahead search across test names, step text, and pass/fail status
-- Summary statistics
-
-### View Report in Browser
-
-**Option 1: Open directly in browser**
-```bash
-open capydash_report/index.html
+capydash_report/index.html
 ```
 
-**Option 2: Use the built-in server**
-```bash
-bundle exec rake capydash:server
-```
-
-Then open `http://localhost:4000` in your browser.
-
-## Troubleshooting
-
-### Common Issues
-
-1. **"No test data found"**: Make sure you've added the test helper configuration and are running actual Capybara tests (not just unit tests).
-
-2. **"log shifting failed" error**: This is a Rails logger issue, not related to CapyDash. It's harmless but you can fix it by updating your Rails version.
+Open it in your browser to view the results.
 
-3. **Screenshots not working**: Make sure you're using a driver that supports screenshots (like Selenium, not rack_test).
+## Example Test
 
-4. **Tests not appearing in report**: Ensure your tests are using Capybara methods like `visit`, `click_button`, `fill_in`, etc.
-
-5. **"No test data found"**: Make sure you're running system tests that use Capybara methods. CapyDash works with parallel testing by default.
-
-### Example Test
-
-Here's an example test that will work with CapyDash:
+Here's an example RSpec system test:
 
 ```ruby
-require 'test_helper'
-
-class HomepageTest < ActionDispatch::IntegrationTest
-  include Capybara::DSL
+require 'rails_helper'
 
-  test "homepage loads with correct content" do
+RSpec.describe "Homepage", type: :system do
+  it "displays the welcome message" do
     visit "/"
-    assert_text "Welcome"
+    expect(page).to have_content("Welcome")
+  end
 
+  it "allows user to submit a form" do
+    visit "/"
     fill_in "Your name", with: "Alice"
     click_button "Greet"
-    assert_text "Hello, Alice!"
+    expect(page).to have_content("Hello, Alice!")
   end
 end
 ```
 
-## Manual Setup
-
-If you prefer to set up CapyDash manually instead of using the generator:
-
-### Step 1: Create CapyDash Initializer
+## Report Features
 
-Create `config/initializers/capydash.rb` in your Rails project:
+The generated report includes:
 
-```ruby
-require 'capydash'
+- **Summary statistics** - Total, passed, and failed test counts
+- **Test grouping** - Tests organized by spec file
+- **Expandable test details** - Click to view error messages
+- **Error information** - Full exception messages and backtraces
+- **Clean design** - Simple, readable HTML layout
 
-# Configure CapyDash
-CapyDash.configure do |config|
-  config.port = 4000
-  config.screenshot_path = "tmp/capydash_screenshots"
-end
+## Requirements
 
-# Subscribe to events for test data collection
-CapyDash::EventEmitter.subscribe do |event|
-  # Collect test data for report generation
-  CapyDash::TestDataAggregator.handle_event(event)
-end
-```
+- Ruby 2.7+
+- RSpec 3.0+
+- Rails 6.0+ (for system tests)
 
-### Step 2: Update Test Helper
+## How It Works
 
-In your `test/test_helper.rb`, add the following:
+1. CapyDash automatically detects when RSpec is present
+2. Hooks into RSpec's `before(:suite)`, `after(:each)`, and `after(:suite)` callbacks
+3. Collects test results in memory during the test run
+4. Generates a static HTML report after all tests complete
+5. Saves the report to `capydash_report/index.html`
 
-```ruby
-require 'capydash'
-
-# Start test run data collection
-CapyDash::TestDataCollector.start_test_run
+## Troubleshooting
 
-# Hook into test execution to set current test name and manage test runs
-module CapyDash
-  module TestHooks
-    def run(&block)
-      # Set the current test name for CapyDash
-      CapyDash.current_test = self.name
+### Report not generated
 
-      # Start test run data collection if not already started
-      CapyDash::TestDataAggregator.start_test_run unless CapyDash::TestDataAggregator.instance_variable_get(:@current_run)
+- Make sure you're running RSpec tests (not Minitest)
+- Ensure `rspec-rails` is in your Gemfile
+- Check that tests actually ran (no early exits)
 
-      super
-    end
-  end
-end
+### Tests not appearing in report
 
-# Apply the hook to the test case
-class ActiveSupport::TestCase
-  prepend CapyDash::TestHooks
-end
+- Verify you're using RSpec system tests (`type: :system`)
+- Make sure the test suite completed (not interrupted)
 
-# Hook to finish test run when all tests are done
-Minitest.after_run do
-  CapyDash::TestDataCollector.finish_test_run
-  CapyDash::TestDataAggregator.finish_test_run
-end
-```
+### Report shows old results
 
-### Step 3: Add Rake Tasks
+- Delete the `capydash_report` directory and run tests again
+- The report is regenerated on each test run
 
-Create `lib/tasks/capydash.rake` in your Rails project:
+## Development
 
-```ruby
-namespace :capydash do
-  desc "Generate static HTML test report"
-  task :report => :environment do
-    CapyDash::ReportGenerator.generate_report
-  end
+### Running Tests
 
-  desc "Start local server to view static HTML report"
-  task :server => :environment do
-    CapyDash::DashboardServer.start
-  end
-end
+```bash
+# In a Rails app with RSpec
+bundle exec rspec
 ```
 
-### Step 4: Configure System Tests (Optional)
+### Building the Gem
 
-If you're using system tests, make sure your `test/application_system_test_case.rb` uses a driver that supports screenshots:
-
-```ruby
-require "test_helper"
-
-class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
-  driven_by :selenium, using: :headless_chrome, screen_size: [ 800, 600 ]
-end
+```bash
+gem build capydash.gemspec
 ```
 
-## Development
-
-### Testing with Dummy App
-
-The project includes a dummy Rails app for testing. To run it:
+### Publishing
 
 ```bash
-cd spec/dummy_app
-bundle install
-bundle exec rails test
+gem push capydash-0.2.0.gem
 ```
 
-### Development Setup
+## License
 
-1. Clone the repository
-2. Install dependencies: `bundle install`
-3. Run the dummy app tests to verify everything works
-4. Make your changes
-5. Test with the dummy app
+MIT
 
 ## Contributing
 
 1. Fork the repository
 2. Create a feature branch
 3. Make your changes
-4. Test with the dummy app
+4. Test with RSpec
 5. Submit a pull request
 
-## Publishing
-
-Build the gem:
-
-```bash
-gem build capydash.gemspec
-```
-
-Push to RubyGems:
+---
 
-```bash
-gem push capydash-0.1.0.gem
-```
+**Note:** CapyDash is a minimal MVP focused solely on RSpec system test reporting. It does not support Minitest, configuration DSLs, local servers, or screenshots. For a simple, zero-configuration test reporting solution, CapyDash is perfect.

data/capydash.gemspec

@@ -3,31 +3,25 @@ require_relative "lib/capydash/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "capydash"
-  spec.version       = Capydash::VERSION
+  spec.version       = CapyDash::VERSION
   spec.authors       = ["Damon Clark"]
   spec.email         = ["dclark312@gmail.com"]
 
-  spec.summary       = "Real-time Capybara test dashboard"
-  spec.description   = "CapyDash instruments Capybara tests and streams test steps, screenshots, and DOM snapshots to a live dashboard."
+  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.homepage      = "https://github.com/damonclark/capydash"
   spec.license       = "MIT"
 
   # Specify which files should be added to the gem when it is released.
-  spec.files         = Dir["lib/**/*", "bin/*", "README.md", "LICENSE*", "*.gemspec"]
+  spec.files         = Dir["lib/**/*", "README.md", "LICENSE*", "*.gemspec"]
   spec.require_paths = ["lib"]
 
-  # Add generator support
-  spec.add_runtime_dependency "railties", ">= 5.0"
-
   # Dependencies
-  spec.add_runtime_dependency "capybara", ">= 3.0"
-  spec.add_runtime_dependency "faye-websocket"
-  spec.add_runtime_dependency "eventmachine"
-  spec.add_runtime_dependency "em-websocket"
+  spec.add_runtime_dependency "rspec", ">= 3.0"
 
   # Development dependencies
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rails", "~> 8.0"
+  spec.add_development_dependency "rspec-rails", "~> 6.0"
+  spec.add_development_dependency "rails", ">= 6.0"
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 end