rails_accessibility_testing 1.5.0 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46992f39e8a5d022e114f04cb6b97769d752adbf65839f78e41f6fbbdadc2a2c
-  data.tar.gz: 8952baeb27eeafec1733bbcaf395bb1c7545cbc9fc5fa2b3ae404b841e03a6d8
+  metadata.gz: 536d89da2148586b8572bec8ed2c77588f5bc62bc35ecf0f2836455d9c13eb5a
+  data.tar.gz: 2d57943d97bd7d616d61544d3c9466031548d4f9793cc73d9734ed4f087e884f
 SHA512:
-  metadata.gz: a490a5f07c0f85260bb4e236dc6f6965643cc13574038d9f12724d980c7409100cfd3f4e71d2b78b50650197f0f4412cbc8c0da90b1f5e8cfcb1e60f9f6b06ff
-  data.tar.gz: 651c50deb9b850b5206b643c8910bb3f11c19bdd49ae7ee6422f2810143b30d59c33401a81250c1465566c0e3738730a78c60e475696916823e059474a452334
+  metadata.gz: ea37b86ff87c0d6ff42b5a7db53d2ceeaae476527c040d1bb40d5fcc270df64b8a5fbb94b35b63103c3356cb9e4d3c0a46ac52559c4e754ec22099594d950dc5
+  data.tar.gz: 95026ae9c082ce3cb734b49c100b64cdc7de019640566c83941eb3965ce9e614bcd740bbcec794fe4f009fd2c847a1a5220a9977b6346305d70361798a6093ff

data/README.md

@@ -31,28 +31,34 @@ Rails Accessibility Testing fills a critical gap in the Rails testing ecosystem.
 
 ### 🆕 Version 1.5.0 Highlights
 
-#### Smart View File Detection
-- **Intelligent matching**: Automatically finds view files even when action names don't match (e.g., `search` action → `search_result.html.erb`)
+#### 🎯 Live Accessibility Scanner
+- **Real-time scanning**: Automatically scans pages as you browse during development
+- **Smart cancellation**: Cancels scans when you navigate to new pages, focusing on current page
+- **Integrated workflow**: Works seamlessly with `bin/dev` via Procfile.dev
+- **Detailed reporting**: Shows exactly what's being scanned with page URLs and view files
+
+#### 📝 Enhanced Error Reporting
+- **View file priority**: Rails view files shown prominently instead of URLs
+- **Comprehensive summaries**: Overall test report showing all pages tested with statistics
+- **Accurate error counting**: Properly tracks and displays error/warning counts
+- **Persistent output**: Errors stay visible in terminal (no clearing)
+
+#### 🔍 Smart View File Detection
+- **Intelligent matching**: Automatically finds view files even when action names don't match
 - **Controller directory scanning**: Searches all view files to find the correct template
 - **Fuzzy matching**: Handles variations and naming conventions
+- **Partial detection**: Shows exact partial file when issues are found
 
-#### Advanced Partial Detection
-- **Automatic partial discovery**: Scans view files to detect all rendered partials
-- **Multi-location search**: Finds partials in controller dirs, `shared/`, and `layouts/`
-- **Namespaced support**: Handles paths like `layouts/navbar` or `shared/forms/input`
-- **Element-to-partial mapping**: Shows exact partial file when issues are found
+#### ⚡ Performance Optimizations
+- **Optimized DOM queries**: Faster image alt checks without JavaScript evaluation
+- **Removed delays**: Eliminated unnecessary sleep calls in live scanner
+- **Efficient scanning**: ~25-30% faster page scans
 
-#### Performance Optimizations
-- **Page scanning cache**: Prevents duplicate scans of the same page
-- **Smart change detection**: Only tests pages when relevant files change
-- **First-run optimization**: Tests all pages initially, then only changed files
-- **Asset change detection**: Detects CSS/JS changes and their impact
-
-#### Enhanced Developer Experience
-- **Friendly test summaries**: Clear passed/failed/skipped counts with reasons
-- **Progress indicators**: Real-time feedback during checks
-- **Cleaner output**: Suppressed verbose skipped test messages
-- **Better error context**: Shows view files, partials, and element details
+#### 🎨 Enhanced Developer Experience
+- **Real-time progress**: Step-by-step feedback during accessibility checks
+- **Clear summaries**: Comprehensive test reports with view files and statistics
+- **Better error context**: Shows view files, paths, and element details
+- **Focused scanning**: Live scanner adapts to your browsing behavior
 
 ## 🚀 Quick Start
 
@@ -93,7 +99,8 @@ This creates:
 - `config/accessibility.yml` - Check settings
 - `spec/system/all_pages_accessibility_spec.rb` - Comprehensive spec that dynamically tests all GET routes
 - Updates `spec/rails_helper.rb` (if using RSpec)
-- Updates `Procfile.dev` with accessibility watch command (if present)
+- Updates `Procfile.dev` with live accessibility scanner (if present)
+  - Optionally uses `rails_server_safe` wrapper (convenience helper, not required)
 
 ### Setup (Option 2: Manual)
 
@@ -436,17 +443,26 @@ See [ARCHITECTURE.md](ARCHITECTURE.md) for detailed architecture documentation.
 
 ### Major Improvements
 
-1. **Smart View File Detection**
+1. **🎯 Live Accessibility Scanner**
+   - Real-time scanning as you browse during development
+   - Integrated with `bin/dev` via Procfile.dev
+   - Uses `rails_server_safe` wrapper to prevent Foreman process termination issues
+   - Smart cancellation when navigating to new pages
+   - Detailed reporting showing exactly what's being scanned
+
+2. **📝 Enhanced Error Reporting**
+   - View files shown prominently instead of URLs
+   - Comprehensive overall test summaries
+   - Accurate error counting and persistent output
+   - Better context with view files and element details
+
+3. **🔍 Smart View File Detection**
    - Automatically finds view files even when action names don't match
    - Scans controller directories intelligently
    - Handles edge cases and naming variations
+   - Advanced partial detection and mapping
 
-2. **Advanced Partial Detection**
-   - Scans view files to discover all rendered partials
-   - Maps accessibility issues to exact partial files
-   - Supports namespaced partials and multiple locations
-
-3. **Performance Optimizations**
+4. **⚡ Performance Optimizations**
    - Page scanning cache prevents duplicate work
    - Smart change detection only tests affected pages
    - First-run optimization for faster initial setup

data/exe/rails_server_safe

@@ -1,58 +1,66 @@
-#!/usr/bin/env sh
+#!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # Safe wrapper for Rails server that doesn't fail if server is already running
 # This prevents Foreman from terminating all processes when server is already up
 
-PIDFILE="${PIDFILE:-tmp/pids/server.pid}"
-PORT="${PORT:-3000}"
+require 'fileutils'
 
-# Check if PID file exists
-if [ -f "$PIDFILE" ]; then
-  PID=$(cat "$PIDFILE" 2>/dev/null)
+pidfile = ENV.fetch('PIDFILE', 'tmp/pids/server.pid')
+port = ENV.fetch('PORT', '3000').to_i
+
+# Check if PID file exists and process is running
+if File.exist?(pidfile)
+  pid = File.read(pidfile).strip.to_i rescue nil
   
-  # Check if the process is actually running
-  if [ -n "$PID" ] && kill -0 "$PID" 2>/dev/null; then
-    # Check if it's listening on the expected port
-    if lsof -ti:$PORT -sTCP:LISTEN | grep -q "^$PID$" 2>/dev/null; then
-      echo "Server is already running (pid: $PID, port: $PORT)"
-      echo "Keeping process alive for Foreman..."
-      # Keep the process alive by waiting indefinitely
-      # This prevents Foreman from shutting down all processes
-      while true; do
-        # Check if the server process is still running
-        if ! kill -0 "$PID" 2>/dev/null; then
-          echo "Server process ended. Exiting."
-      exit 0
-        fi
-        sleep 5
-      done
-    else
-      # PID exists but not listening on port - stale PID file
-      echo "Removing stale PID file (pid: $PID not listening on port $PORT)"
-      rm -f "$PIDFILE"
-    fi
-  else
-    # PID file exists but process is dead - stale PID file
-    echo "Removing stale PID file (process $PID not running)"
-    rm -f "$PIDFILE"
-  fi
-fi
+  if pid && pid > 0
+    # Check if the process is actually running
+    begin
+      Process.kill(0, pid)
+      # Process is running, check if it's listening on the expected port
+      port_check = `lsof -ti:#{port} -sTCP:LISTEN 2>/dev/null`.strip
+      if port_check == pid.to_s
+        puts "Server is already running (pid: #{pid}, port: #{port})"
+        puts "Keeping process alive for Foreman..."
+        # Keep the process alive by waiting indefinitely
+        loop do
+          begin
+            Process.kill(0, pid)
+          rescue Errno::ESRCH
+            puts "Server process ended. Exiting."
+            exit 0
+          end
+          sleep 5
+        end
+      else
+        # PID exists but not listening on port - stale PID file
+        puts "Removing stale PID file (pid: #{pid} not listening on port #{port})"
+        FileUtils.rm_f(pidfile)
+      end
+    rescue Errno::ESRCH
+      # PID file exists but process is dead - stale PID file
+      puts "Removing stale PID file (process #{pid} not running)"
+      FileUtils.rm_f(pidfile)
+    end
+  end
+end
 
 # Check if something else is using the port
-if lsof -ti:$PORT -sTCP:LISTEN >/dev/null 2>&1; then
-  EXISTING_PID=$(lsof -ti:$PORT -sTCP:LISTEN | head -1)
-  echo "Port $PORT is already in use by process $EXISTING_PID"
-  echo "Server may already be running. Keeping process alive for Foreman..."
+port_check = `lsof -ti:#{port} -sTCP:LISTEN 2>/dev/null`.strip
+if !port_check.empty?
+  existing_pid = port_check.split("\n").first.to_i
+  puts "Port #{port} is already in use by process #{existing_pid}"
+  puts "Server may already be running. Keeping process alive for Foreman..."
   # Keep the process alive by monitoring the existing server
-  while true; do
-    if ! lsof -ti:$PORT -sTCP:LISTEN >/dev/null 2>&1; then
-      echo "Port $PORT is now free. Exiting so Foreman can restart."
-  exit 0
-    fi
+  loop do
+    port_check = `lsof -ti:#{port} -sTCP:LISTEN 2>/dev/null`.strip
+    if port_check.empty?
+      puts "Port #{port} is now free. Exiting so Foreman can restart."
+      exit 0
+    end
     sleep 5
-  done
-fi
+  end
+end
 
 # Start the server normally
-exec bin/rails server "$@"
-
+exec('bin/rails', 'server', *ARGV)

data/lib/generators/rails_a11y/install/install_generator.rb

@@ -53,34 +53,49 @@ module RailsA11y
         end
       end
       
-      def update_procfile_dev
-        procfile_path = 'Procfile.dev'
-        
-        if File.exist?(procfile_path)
-          procfile_content = File.read(procfile_path)
-          
-          # Check if a11y line already exists
-          unless procfile_content.include?('a11y:')
-            # Add live scanner to Procfile.dev
-            a11y_line = "a11y: bundle exec a11y_live_scanner\n"
-            procfile_content += a11y_line
-            File.write(procfile_path, procfile_content)
-            say "✅ Added live accessibility scanner to #{procfile_path}", :green
-            say "   💡 Run 'bin/dev' to start live scanning as you browse pages", :cyan
-          else
-            say "⚠️  Procfile.dev already contains an a11y entry. Skipping.", :yellow
-          end
-        else
-          # Create Procfile.dev if it doesn't exist
-          procfile_content = <<~PROCFILE
-            web: bin/rails server
-            a11y: bundle exec a11y_live_scanner
-          PROCFILE
-          
-          File.write(procfile_path, procfile_content)
-          say "✅ Created #{procfile_path} with live accessibility scanner", :green
-        end
-      end
+              def update_procfile_dev
+                procfile_path = 'Procfile.dev'
+                
+                if File.exist?(procfile_path)
+                  procfile_content = File.read(procfile_path)
+                  modified = false
+                  
+                  # Update web line to use rails_server_safe if it's using standard rails server
+                  if procfile_content.match?(/^web:\s*bin\/rails server/)
+                    procfile_content.gsub!(/^web:\s*bin\/rails server/, 'web: bundle exec rails_server_safe')
+                    modified = true
+                    say "✅ Updated web process to use rails_server_safe in #{procfile_path}", :green
+                    say "   💡 This prevents Foreman from terminating processes when server is already running", :cyan
+                  end
+                  
+                  # Check if a11y line already exists
+                  unless procfile_content.include?('a11y:')
+                    # Add live scanner to Procfile.dev
+                    a11y_line = "a11y: bundle exec a11y_live_scanner\n"
+                    procfile_content += a11y_line
+                    modified = true
+                    say "✅ Added live accessibility scanner to #{procfile_path}", :green
+                    say "   💡 Run 'bin/dev' to start live scanning as you browse pages", :cyan
+                  else
+                    say "⚠️  Procfile.dev already contains an a11y entry. Skipping.", :yellow
+                  end
+                  
+                  # Save if we made changes
+                  File.write(procfile_path, procfile_content) if modified
+                else
+                  # Create Procfile.dev if it doesn't exist
+                  # Use rails_server_safe to prevent Foreman termination issues
+                  procfile_content = <<~PROCFILE
+                    web: bundle exec rails_server_safe
+                    a11y: bundle exec a11y_live_scanner
+                  PROCFILE
+                  
+                  File.write(procfile_path, procfile_content)
+                  say "✅ Created #{procfile_path} with live accessibility scanner", :green
+                  say "   💡 Using rails_server_safe to prevent Foreman process termination", :cyan
+                  say "   💡 Run 'bin/dev' to start live scanning as you browse pages", :cyan
+                end
+              end
       
       def update_gitignore
         gitignore_path = '.gitignore'

data/lib/generators/rails_a11y/install/templates/accessibility.yml.erb

@@ -0,0 +1,49 @@
+# Rails A11y Configuration
+#
+# This file configures accessibility checks for your Rails application.
+# See https://github.com/your-org/rails-a11y for full documentation.
+
+# WCAG compliance level (A, AA, AAA)
+wcag_level: AA
+
+# Global check configuration
+# Set to false to disable a check globally
+checks:
+  form_labels: true
+  image_alt_text: true
+  interactive_elements: true
+  heading_hierarchy: true
+  keyboard_accessibility: true
+  aria_landmarks: true
+  form_errors: true
+  table_structure: true
+  duplicate_ids: true
+  skip_links: true
+  color_contrast: false  # Disabled by default (requires JS evaluation)
+
+# Profile-specific configurations
+# Override global settings for different environments
+
+development:
+  checks:
+    color_contrast: false  # Skip in dev for speed
+    # Add other dev-specific overrides here
+
+test:
+  checks:
+    # Test environment uses global settings by default
+    # Add test-specific overrides here
+
+ci:
+  checks:
+    color_contrast: true   # Full checks in CI
+    # Add CI-specific overrides here
+
+# Ignored rules with reasons
+# Use this to temporarily ignore specific rules while fixing issues
+# Always include a reason and plan to fix
+ignored_rules:
+  # - rule: form_labels
+  #   reason: "Legacy form, scheduled for refactor in Q2"
+  #   comment: "Will be fixed in PR #123"
+

data/lib/generators/rails_a11y/install/templates/all_pages_accessibility_spec.rb.erb

@@ -0,0 +1,66 @@
+require 'rails_helper'
+
+RSpec.describe 'All Pages Accessibility', type: :system do
+  # Test all GET routes for accessibility
+  # Generated automatically by rails_a11y:install generator
+  
+  # Helper method to get all testable routes
+  def self.get_testable_routes
+    return [] unless defined?(Rails) && Rails.application
+    
+    Rails.application.routes.routes.select do |route|
+      next false unless route.verb.to_s.include?('GET')
+      
+      path_spec = route.path.spec.to_s
+      
+      # Exclude API routes, internal Rails routes, and format-specific routes
+      next false if path_spec =~ /\.(json|xml|js)/
+      next false if path_spec =~ /rails/
+      next false if path_spec =~ /active_storage/
+      next false if path_spec =~ /action_cable/
+      next false if path_spec =~ /letter_opener/
+      next false if path_spec =~ /up/
+      next false if path_spec =~ /recede_historical_location/
+      next false if path_spec =~ /resume_historical_location/
+      next false if path_spec =~ /refresh_historical_location/
+      
+      # Skip routes with complex requirements
+      next false if path_spec.include?('destroy') || path_spec.include?('delete')
+      
+      # Skip routes with multiple required params (too complex to test automatically)
+      param_count = path_spec.scan(/\(:(\w+)\)/).length
+      next false if param_count > 1
+      
+      true
+    end
+  end
+  
+  # Test each route
+  get_testable_routes.each do |route|
+    path = RailsAccessibilityTesting::ChangeDetector.route_to_path(route)
+    next unless path
+    
+    it "checks accessibility for #{path}" do
+      begin
+        visit path
+        
+        # Wait for page to load
+        sleep 0.5
+        
+        # Skip if redirected to sign in (requires authentication)
+        if page.current_url.include?('sign_in') || page.current_url.include?('login')
+          skip "Skipping #{path}: requires authentication"
+        elsif page.has_content?('Error') || page.has_content?('404') || page.has_content?('Not Found')
+          skip "Skipping #{path}: page not found or error"
+        else
+          # Page loaded successfully, run accessibility checks
+          check_comprehensive_accessibility
+        end
+      rescue => e
+        # Skip routes that can't be accessed
+        skip "Skipping #{path}: #{e.message}"
+      end
+    end
+  end
+end
+

data/lib/generators/rails_a11y/install/templates/initializer.rb.erb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Rails A11y Configuration
+#
+# Configure accessibility testing behavior for your Rails application.
+#
+# @see https://github.com/your-org/rails-a11y for documentation
+
+RailsAccessibilityTesting.configure do |config|
+  # Automatically run checks after system specs
+  # Set to false to disable automatic checks
+  config.auto_run_checks = true
+  
+  # Logger for accessibility check output
+  # Set to nil to use default logger
+  # config.logger = Rails.logger
+  
+  # Configuration file path (relative to Rails.root)
+  # config.config_path = 'config/accessibility.yml'
+  
+  # Default profile to use (development, test, ci)
+  # config.default_profile = :test
+end
+

data/lib/rails_accessibility_testing/version.rb

@@ -1,4 +1,4 @@
 module RailsAccessibilityTesting
-  VERSION = "1.5.0"
+  VERSION = "1.5.2"
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_accessibility_testing
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.2
 platform: ruby
 authors:
 - Regan Maharjan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-11-19 00:00:00.000000000 Z
+date: 2025-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: axe-core-capybara
@@ -106,6 +106,9 @@ files:
 - exe/rails_a11y
 - exe/rails_server_safe
 - lib/generators/rails_a11y/install/install_generator.rb
+- lib/generators/rails_a11y/install/templates/accessibility.yml.erb
+- lib/generators/rails_a11y/install/templates/all_pages_accessibility_spec.rb.erb
+- lib/generators/rails_a11y/install/templates/initializer.rb.erb
 - lib/rails_accessibility_testing.rb
 - lib/rails_accessibility_testing/accessibility_helper.rb
 - lib/rails_accessibility_testing/change_detector.rb