capydash 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa238074c05a59e8c88ec84c887944dc2c376ae379ffde69c3422b939d052d77
-  data.tar.gz: fdfc24fbe669f5a8d0ff44792383b5eae3abcf69d21ed52810228972d0773959
+  metadata.gz: 92f824ed1079edfc71c33d6260bf708a036a9a0f99a20f10c919a2a0f305623a
+  data.tar.gz: c70b934e69ae0b8a4759146044beb115f1f3170ccdfd7d6fd7d1480f2492f2d2
 SHA512:
-  metadata.gz: b49bd9f834a849025f79fc72fc3c317e971fba0ea74504e09d35026a4bdb18b224f48a86ab6041fb43a78de5dd6897ecba9ca43e9f57bfc356385a318313f0e4
-  data.tar.gz: 9c3f988ea6164e454f73d1600ec61ceddfc63f9f6dbb4220c535df60ecf4662f08653fdbcfc9bf6936616382455d8bef473a5f03336d6af8aba72da328c67428
+  metadata.gz: 0cbabbb16e97c1ef1214e383dc6166cfb84c3267ae9e5e26f131483420e380d102e4ac0c36ba8c589332b1068cf3d1270d9e6a631e7c06cf24540002af1106a0
+  data.tar.gz: b170062c27cd772973a37380e681b28846c592bfdbf17287b9be2535f6e71a71d6d6415970fdd8bf1f047d033d76dc5ee79bcf198112955981231b11fa71b7c4

data/README.md

@@ -16,8 +16,36 @@ Or run:
 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
+```
+
+This will automatically:
+- ✅ Create the CapyDash initializer
+- ✅ Update your test helper with all necessary hooks
+- ✅ Add rake tasks for report generation
+- ✅ Create an example test to get you started
+
+### 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:
+
+```bash
+bundle exec rails test
+```
+
 ### Generate Test Report
 
 After running your Capybara tests, generate a static HTML report:
@@ -45,17 +73,131 @@ open capydash_report/index.html
 bundle exec rake capydash:server
 ```
 
-Then open `http://localhost:5173` in your browser.
+Then open `http://localhost:4000` in your browser.
 
-### Run Tests with CapyDash
+## Troubleshooting
 
-Run your tests normally - CapyDash will automatically instrument them:
+### Common Issues
 
-```bash
-bundle exec rails test
+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.
+
+3. **Screenshots not working**: Make sure you're using a driver that supports screenshots (like Selenium, not rack_test).
+
+4. **Tests not appearing in report**: Ensure your tests are using Capybara methods like `visit`, `click_button`, `fill_in`, etc.
+
+### Example Test
+
+Here's an example test that will work with CapyDash:
+
+```ruby
+require 'test_helper'
+
+class HomepageTest < ActionDispatch::IntegrationTest
+  include Capybara::DSL
+
+  test "homepage loads with correct content" do
+    visit "/"
+    assert_text "Welcome"
+
+    fill_in "Your name", with: "Alice"
+    click_button "Greet"
+    assert_text "Hello, Alice!"
+  end
+end
+```
+
+## Manual Setup
+
+If you prefer to set up CapyDash manually instead of using the generator:
+
+### Step 1: Create CapyDash Initializer
+
+Create `config/initializers/capydash.rb` in your Rails project:
+
+```ruby
+require 'capydash'
+
+# Configure CapyDash
+CapyDash.configure do |config|
+  config.port = 4000
+  config.screenshot_path = "tmp/capydash_screenshots"
+end
+
+# Subscribe to events for test data collection
+CapyDash::EventEmitter.subscribe do |event|
+  # Collect test data for report generation
+  CapyDash::TestDataAggregator.handle_event(event)
+end
+```
+
+### Step 2: Update Test Helper
+
+In your `test/test_helper.rb`, add the following:
+
+```ruby
+require 'capydash'
+
+# Start test run data collection
+CapyDash::TestDataCollector.start_test_run
+
+# 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
+
+      # Start test run data collection if not already started
+      CapyDash::TestDataAggregator.start_test_run unless CapyDash::TestDataAggregator.instance_variable_get(:@current_run)
+
+      super
+    end
+  end
+end
+
+# Apply the hook to the test case
+class ActiveSupport::TestCase
+  prepend CapyDash::TestHooks
+end
+
+# 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
 ```
 
-The report will be generated in `capydash_report/index.html` after test completion.
+### Step 3: Add Rake Tasks
+
+Create `lib/tasks/capydash.rake` in your Rails project:
+
+```ruby
+namespace :capydash do
+  desc "Generate static HTML test report"
+  task :report => :environment do
+    CapyDash::ReportGenerator.generate_report
+  end
+
+  desc "Start local server to view static HTML report"
+  task :server => :environment do
+    CapyDash::DashboardServer.start
+  end
+end
+```
+
+### Step 4: Configure System Tests (Optional)
+
+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
+```
 
 ## Development
 

data/capydash.gemspec

@@ -16,6 +16,9 @@ Gem::Specification.new do |spec|
   spec.files         = Dir["lib/**/*", "bin/*", "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"

data/lib/capydash/version.rb

@@ -1,3 +1,3 @@
 module Capydash
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/generators/capydash/install_generator.rb

@@ -0,0 +1,145 @@
+require 'rails/generators'
+
+module Capydash
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      desc "Installs CapyDash with all necessary configuration files"
+
+      def create_initializer
+        create_file "config/initializers/capydash.rb", <<~RUBY
+          require 'capydash'
+
+          # Configure CapyDash
+          CapyDash.configure do |config|
+            config.port = 4000
+            config.screenshot_path = "tmp/capydash_screenshots"
+          end
+
+          # 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
+      end
+
+      def create_rake_tasks
+        create_file "lib/tasks/capydash.rake", <<~RUBY
+          namespace :capydash do
+            desc "Generate static HTML test report"
+            task :report => :environment do
+              CapyDash::ReportGenerator.generate_report
+            end
+
+            desc "Start local server to view static HTML report"
+            task :server => :environment do
+              CapyDash::DashboardServer.start
+            end
+          end
+        RUBY
+      end
+
+      def update_test_helper
+        test_helper_path = "test/test_helper.rb"
+
+        if File.exist?(test_helper_path)
+          # Read existing test helper
+          content = File.read(test_helper_path)
+
+          # Check if CapyDash is already configured
+          unless content.include?("require 'capydash'")
+            # Add CapyDash configuration
+            capydash_config = <<~RUBY
+
+              # CapyDash configuration
+              require 'capydash'
+
+              # Start test run data collection
+              CapyDash::TestDataCollector.start_test_run
+
+              # 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
+
+                    # Start test run data collection if not already started
+                    CapyDash::TestDataAggregator.start_test_run unless CapyDash::TestDataAggregator.instance_variable_get(:@current_run)
+
+                    super
+                  end
+                end
+              end
+
+              # Apply the hook to the test case
+              class ActiveSupport::TestCase
+                prepend CapyDash::TestHooks
+              end
+
+              # 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
+            RUBY
+
+            # Insert after the last require statement
+            if content.match(/require.*\n/)
+              content = content.gsub(/(require.*\n)/, "\\1#{capydash_config}")
+            else
+              content = capydash_config + content
+            end
+
+            File.write(test_helper_path, content)
+            say "Updated test/test_helper.rb with CapyDash configuration"
+          else
+            say "CapyDash already configured in test/test_helper.rb", :yellow
+          end
+        else
+          say "test/test_helper.rb not found. Please add CapyDash configuration manually.", :red
+        end
+      end
+
+      def create_example_test
+        example_test_path = "test/system/capydash_example_test.rb"
+
+        unless File.exist?(example_test_path)
+          create_file example_test_path, <<~RUBY
+            require "application_system_test_case"
+
+            class CapydashExampleTest < ApplicationSystemTestCase
+              test "example test for CapyDash" do
+                visit "/"
+
+                # This test will be captured by CapyDash
+                assert_text "Welcome"
+
+                # Fill in a form
+                fill_in "Your name", with: "Alice" if page.has_field?("Your name")
+                click_button "Submit" if page.has_button?("Submit")
+              end
+            end
+          RUBY
+          say "Created example test at #{example_test_path}"
+        else
+          say "Example test already exists at #{example_test_path}", :yellow
+        end
+      end
+
+      def show_instructions
+        say "\n" + "="*60, :green
+        say "CapyDash has been successfully installed!", :green
+        say "="*60, :green
+        say "\nNext steps:", :yellow
+        say "1. Run your tests: bundle exec rails test"
+        say "2. Generate report: bundle exec rake capydash:report"
+        say "3. View report: open capydash_report/index.html"
+        say "\nFor more information, see the README.md file."
+        say "="*60, :green
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capydash
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Damon Clark
@@ -9,6 +9,20 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +133,7 @@ files:
 - lib/capydash/test_data_aggregator.rb
 - lib/capydash/test_data_collector.rb
 - lib/capydash/version.rb
+- lib/generators/capydash/install_generator.rb
 - lib/tasks/capydash.rake
 homepage: https://github.com/damonclark/capydash
 licenses: