rails_accessibility_testing 1.5.3 → 1.5.4

data/exe/a11y_static_scanner

@@ -0,0 +1,333 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Static accessibility scanner for development
+# Scans all view files and shows accessibility errors
+# Usage: Add to Procfile.dev as: a11y: bundle exec a11y_static_scanner
+
+require 'bundler/setup'
+
+# Load Rails environment
+rails_root = Dir.pwd
+while rails_root != '/' && !File.exist?(File.join(rails_root, 'config', 'environment.rb'))
+  rails_root = File.dirname(rails_root)
+end
+
+if File.exist?(File.join(rails_root, 'config', 'environment.rb'))
+  Dir.chdir(rails_root)
+  require File.join(rails_root, 'config', 'environment')
+end
+
+# Require the gem
+begin
+  require 'rails_accessibility_testing'
+  require 'rails_accessibility_testing/static_file_scanner'
+  require 'rails_accessibility_testing/file_change_tracker'
+rescue LoadError => e
+  $stderr.puts "❌ Error loading rails_accessibility_testing gem: #{e.message}"
+  $stderr.puts "   Make sure the gem is installed: bundle install"
+  exit 1
+end
+
+# Format errors with file locations and line numbers
+def format_errors(errors, warnings)
+  return "" if errors.empty? && warnings.empty?
+  
+  output = []
+  
+  # Group errors by file
+  errors_by_file = errors.group_by { |e| e[:file] }
+  warnings_by_file = warnings.group_by { |w| w[:file] }
+  
+  # Show errors first
+  if errors.any?
+    output << "\n" + "="*70
+    output << "❌ #{errors.length} error#{'s' if errors.length != 1} found"
+    output << "="*70
+    output << ""
+    
+    errors_by_file.each_with_index do |(file_path, file_errors), file_index|
+      output << "" if file_index > 0
+      
+      # Show relative path
+      relative_path = file_path.sub(%r{^.*app/views/}, 'app/views/')
+      output << "📝 #{relative_path} (#{file_errors.length} error#{'s' if file_errors.length != 1})"
+      
+      file_errors.each do |error|
+        error_line = "   • #{error[:type]}"
+        
+        # Add line number if available
+        if error[:line]
+          error_line += " [Line #{error[:line]}]"
+        end
+        
+        # Add element identifier
+        element_id = error[:element][:id]
+        element_href = error[:element][:href]
+        element_src = error[:element][:src]
+        
+        if element_id && !element_id.to_s.strip.empty?
+          error_line += " [id: #{element_id}]"
+        elsif element_href && !element_href.to_s.strip.empty?
+          href_display = element_href.length > 30 ? "#{element_href[0..27]}..." : element_href
+          error_line += " [href: #{href_display}]"
+        elsif element_src && !element_src.to_s.strip.empty?
+          src_display = element_src.length > 30 ? "#{element_src[0..27]}..." : element_src
+          error_line += " [src: #{src_display}]"
+        end
+        
+        output << error_line
+      end
+    end
+    
+    output << ""
+    output << "="*70
+  end
+  
+  # Show warnings if any
+  if warnings.any?
+    output << "\n" + "="*70
+    output << "⚠️  #{warnings.length} warning#{'s' if warnings.length != 1} found"
+    output << "="*70
+    output << ""
+    
+    warnings_by_file.each_with_index do |(file_path, file_warnings), file_index|
+      output << "" if file_index > 0
+      
+      # Show relative path
+      relative_path = file_path.sub(%r{^.*app/views/}, 'app/views/')
+      output << "📝 #{relative_path} (#{file_warnings.length} warning#{'s' if file_warnings.length != 1})"
+      
+      file_warnings.each do |warning|
+        warning_line = "   • #{warning[:type]}"
+        
+        # Add line number if available
+        if warning[:line]
+          warning_line += " [Line #{warning[:line]}]"
+        end
+        
+        # Add element identifier
+        element_id = warning[:element][:id]
+        element_href = warning[:element][:href]
+        element_src = warning[:element][:src]
+        
+        if element_id && !element_id.to_s.strip.empty?
+          warning_line += " [id: #{element_id}]"
+        elsif element_href && !element_href.to_s.strip.empty?
+          href_display = element_href.length > 30 ? "#{element_href[0..27]}..." : element_href
+          warning_line += " [href: #{href_display}]"
+        elsif element_src && !element_src.to_s.strip.empty?
+          src_display = element_src.length > 30 ? "#{element_src[0..27]}..." : element_src
+          warning_line += " [src: #{src_display}]"
+        end
+        
+        output << warning_line
+      end
+    end
+    
+    output << ""
+    output << "="*70
+  end
+  
+  output.join("\n")
+end
+
+# Get all view files
+def get_all_view_files
+  return [] unless defined?(Rails) && Rails.root
+  
+  view_dir = Rails.root.join('app', 'views')
+  return [] unless File.directory?(view_dir)
+  
+  extensions = %w[erb haml slim]
+  view_files = []
+  
+  extensions.each do |ext|
+    # Find all HTML view files (exclude partials that start with _)
+    pattern = File.join(view_dir, '**', "*.html.#{ext}")
+    Dir.glob(pattern).each do |file|
+      # Skip partials (files starting with _)
+      next if File.basename(file).start_with?('_')
+      # Skip layout files
+      next if file.include?('/layouts/')
+      view_files << file
+    end
+  end
+  
+  view_files.sort
+end
+
+# Main scanner
+begin
+  puts "\n" + "="*70
+  puts "🔍 Static Accessibility Scanner"
+  puts "="*70
+  puts "📁 Scanning all view files..."
+  puts ""
+  
+  view_files = get_all_view_files
+  
+  if view_files.empty?
+    puts "⚠️  No view files found to scan"
+    exit 0
+  end
+  
+  puts "📋 Found #{view_files.length} view file#{'s' if view_files.length != 1} to scan"
+  puts ""
+  
+  # Load config
+  begin
+    config = RailsAccessibilityTesting::Config::YamlLoader.load(profile: :development)
+    ignore_warnings = config.dig('summary', 'ignore_warnings') || false
+    static_config = config['static_scanner'] || {}
+    scan_changed_only = static_config.fetch('scan_changed_only', true)
+    check_interval = static_config.fetch('check_interval', 3)
+    full_scan_on_startup = static_config.fetch('full_scan_on_startup', true)
+  rescue StandardError
+    ignore_warnings = false
+    scan_changed_only = true
+    check_interval = 3
+    full_scan_on_startup = true
+  end
+  
+  # Determine which files to scan
+  files_to_scan = []
+  
+  if scan_changed_only && !full_scan_on_startup
+    # Only scan changed files from the start (no full scan on startup)
+    changed = RailsAccessibilityTesting::FileChangeTracker.changed_files(view_files)
+    if changed.empty?
+      puts "✅ No files changed since last scan"
+      puts "🔄 Scanner running continuously - watching for file changes..."
+      puts "   Press Ctrl-C to stop"
+      puts ""
+      
+      # Just watch for changes
+      loop do
+        sleep check_interval
+        changed = RailsAccessibilityTesting::FileChangeTracker.changed_files(view_files)
+        if changed.any?
+          puts "\n📝 #{changed.length} file#{'s' if changed.length != 1} changed - scanning..."
+          files_to_scan = changed
+          break
+        end
+      end
+    else
+      puts "📝 Found #{changed.length} changed file#{'s' if changed.length != 1} to scan"
+      files_to_scan = changed
+    end
+  elsif scan_changed_only && full_scan_on_startup
+    # Always scan all files on startup when full_scan_on_startup is true
+    # This ensures every new instance of bin/dev runs a full scan
+    puts "📋 Scanning all #{view_files.length} file#{'s' if view_files.length != 1} on startup"
+    files_to_scan = view_files
+  else
+    # Scan all files every time (scan_changed_only is false)
+    puts "📋 Scanning all #{view_files.length} file#{'s' if view_files.length != 1}"
+    files_to_scan = view_files
+  end
+  
+  # Scan files
+  all_errors = []
+  all_warnings = []
+  
+  if files_to_scan.any?
+    files_to_scan.each do |view_file|
+      scanner = RailsAccessibilityTesting::StaticFileScanner.new(view_file)
+      result = scanner.scan
+      
+      errors = result[:errors] || []
+      warnings = result[:warnings] || []
+      
+      all_errors.concat(errors)
+      all_warnings.concat(warnings) unless ignore_warnings
+      
+      print "."
+      $stdout.flush
+    end
+    
+    # Update state with scanned files
+    RailsAccessibilityTesting::FileChangeTracker.update_state(files_to_scan)
+    
+    puts ""
+    puts ""
+    
+    # Show results
+    if all_errors.any? || (all_warnings.any? && !ignore_warnings)
+      puts format_errors(all_errors, ignore_warnings ? [] : all_warnings)
+      puts ""
+      puts "💡 Fix the errors above - scanner will re-run automatically"
+      puts ""
+    else
+      puts "✅ All #{files_to_scan.length} scanned file#{'s' if files_to_scan.length != 1} passed accessibility checks!"
+      puts ""
+    end
+  end
+  
+  # Keep scanner running continuously - re-scan files when they change
+  if scan_changed_only
+    # Always show waiting message after scanning
+    puts "🔄 Scanner running continuously - watching for file changes..."
+    puts "   Press Ctrl-C to stop"
+    puts ""
+    
+    loop do
+      sleep check_interval
+      
+      # Check for changed files using FileChangeTracker
+      changed = RailsAccessibilityTesting::FileChangeTracker.changed_files(view_files)
+      
+      if changed.any?
+        puts "\n📝 #{changed.length} file#{'s' if changed.length != 1} changed - re-scanning..."
+        puts ""
+        
+        # Scan only changed files
+        all_errors = []
+        all_warnings = []
+        
+        changed.each do |view_file|
+          scanner = RailsAccessibilityTesting::StaticFileScanner.new(view_file)
+          result = scanner.scan
+          
+          errors = result[:errors] || []
+          warnings = result[:warnings] || []
+          
+          all_errors.concat(errors)
+          all_warnings.concat(warnings) unless ignore_warnings
+          
+          print "."
+          $stdout.flush
+        end
+        
+        # Update state
+        RailsAccessibilityTesting::FileChangeTracker.update_state(changed)
+        
+        puts ""
+        puts ""
+        
+        # Show results
+        if all_errors.any? || (all_warnings.any? && !ignore_warnings)
+          puts format_errors(all_errors, ignore_warnings ? [] : all_warnings)
+          puts ""
+          puts "💡 Fix the errors above - scanner will re-run automatically"
+          puts ""
+        else
+          puts "✅ All #{changed.length} scanned file#{'s' if changed.length != 1} passed accessibility checks!"
+          puts ""
+        end
+      end
+    end
+  else
+    # Not watching for changes - exit after scan
+    puts "✅ Scan complete"
+  end
+  
+rescue Interrupt
+  puts "\n\n👋 Scanner stopped"
+  exit 0
+rescue StandardError => e
+  puts "\n\n❌ Error: #{e.message}"
+  puts e.backtrace.first(5).join("\n")
+  exit 1
+end
+

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

@@ -70,14 +70,21 @@ module RailsA11y
                   
                   # 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"
+                    # Add static scanner to Procfile.dev
+                    a11y_line = "a11y: bundle exec a11y_static_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
+                    say "✅ Added static accessibility scanner to #{procfile_path}", :green
+                    say "   💡 Run 'bin/dev' to scan all view files and show errors", :cyan
                   else
-                    say "⚠️  Procfile.dev already contains an a11y entry. Skipping.", :yellow
+                    # Update existing a11y line if it's using live scanner
+                    if procfile_content.include?('a11y_live_scanner')
+                      procfile_content.gsub!(/a11y:.*a11y_live_scanner/, 'a11y: bundle exec a11y_static_scanner')
+                      modified = true
+                      say "✅ Updated a11y scanner to static file scanner in #{procfile_path}", :green
+                    else
+                      say "⚠️  Procfile.dev already contains an a11y entry. Skipping.", :yellow
+                    end
                   end
                   
                   # Save if we made changes
@@ -87,36 +94,18 @@ module RailsA11y
                   # Use rails_server_safe to prevent Foreman termination issues
                   procfile_content = <<~PROCFILE
                     web: bundle exec rails_server_safe
-                    a11y: bundle exec a11y_live_scanner
+                    a11y: bundle exec a11y_static_scanner
                   PROCFILE
                   
                   File.write(procfile_path, procfile_content)
-                  say "✅ Created #{procfile_path} with live accessibility scanner", :green
+                  say "✅ Created #{procfile_path} with static 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
+                  say "   💡 Run 'bin/dev' to scan all view files and show errors", :cyan
                 end
               end
       
       def update_gitignore
-        gitignore_path = '.gitignore'
-        
-        if File.exist?(gitignore_path)
-          gitignore_content = File.read(gitignore_path)
-          
-          # Add tmp files for live scanner if not already present
-          a11y_entries = [
-            'tmp/a11y_page_visits.log',
-            'tmp/a11y_scanned_pages.json'
-          ]
-          
-          a11y_entries.each do |entry|
-            unless gitignore_content.include?(entry)
-              gitignore_content += "\n#{entry}\n"
-            end
-          end
-          
-          File.write(gitignore_path, gitignore_content) if gitignore_content != File.read(gitignore_path)
-        end
+        # No longer needed - static scanner doesn't create tmp files
       end
       
       def show_instructions
@@ -126,9 +115,9 @@ module RailsA11y
         say "  1. Run the accessibility tests:", :cyan
         say "     bundle exec rspec spec/system/all_pages_accessibility_spec.rb"
         say ""
-        say "  2. For live scanning during development:", :cyan
-        say "     bin/dev  # Starts web server + live accessibility scanner"
-        say "     # Navigate to pages in your browser to see real-time reports!"
+        say "  2. For static file scanning during development:", :cyan
+        say "     bin/dev  # Starts web server + static accessibility scanner"
+        say "     # Scans all view files and shows errors automatically!"
         say ""
         say "  3. Create custom specs for specific pages:", :cyan
         say "     # spec/system/my_page_accessibility_spec.rb"

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

@@ -6,6 +6,45 @@
 # WCAG compliance level (A, AA, AAA)
 wcag_level: AA
 
+# Summary configuration
+# Control how accessibility test summaries are displayed
+summary:
+  # Show summary at end of test suite (true/false)
+  show_summary: true
+  
+  # Show only errors in summary, hide warnings (true/false)
+  errors_only: false
+  
+  # Show fix suggestions in error messages (true/false)
+  # When false, only shows error type and location
+  show_fixes: true
+  
+  # Ignore warnings completely - only show errors (true/false)
+  # When true, warnings are filtered out and not displayed or counted
+  ignore_warnings: false
+
+# Scanning strategy
+# 'paths' - Scan by visiting routes/paths (default)
+# 'view_files' - Scan by finding view files and visiting their routes
+scan_strategy: 'view_files'
+
+# Static scanner configuration
+# Controls behavior of the static file scanner (a11y_static_scanner)
+static_scanner:
+  # Only scan files that have changed since last scan (true/false)
+  # When true, uses file modification times to track changes
+  # When false, scans all files on every run
+  scan_changed_only: true
+  
+  # Check interval in seconds when running continuously
+  # Scanner checks for file changes every N seconds
+  check_interval: 3
+  
+  # Force full scan on startup (true/false)
+  # When true, scans all files on first run regardless of changes
+  # When false, only scans changed files from the start
+  full_scan_on_startup: true
+
 # Global check configuration
 # Set to false to disable a check globally
 checks:

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

@@ -1,66 +1,153 @@
 require 'rails_helper'
 
 RSpec.describe 'All Pages Accessibility', type: :system do
-  # Test all GET routes for accessibility
+  # Test all view files for accessibility using static file scanning
   # 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
+  # Helper method to get all view files (non-partials)
+  def self.get_all_view_files
+    return [] unless defined?(Rails) && Rails.root
     
-    Rails.application.routes.routes.select do |route|
-      next false unless route.verb.to_s.include?('GET')
-      
-      path_spec = route.path.spec.to_s
+    view_dir = Rails.root.join('app', 'views')
+    return [] unless File.directory?(view_dir)
+    
+    extensions = %w[erb haml slim]
+    view_files = []
+    
+    extensions.each do |ext|
+      # Find all HTML view files (exclude partials that start with _)
+      pattern = File.join(view_dir, '**', "*.html.#{ext}")
+      Dir.glob(pattern).each do |file|
+        # Skip partials (files starting with _)
+        next if File.basename(file).start_with?('_')
+        # Skip layout files
+        next if file.include?('/layouts/')
+        view_files << file
+      end
+    end
+    
+    view_files.sort
+  end
+  
+  # Format errors with file locations and line numbers
+  def format_static_errors(errors, warnings)
+    return "" if errors.empty? && warnings.empty?
+    
+    output = []
+    
+    # Group errors by file
+    errors_by_file = errors.group_by { |e| e[:file] }
+    warnings_by_file = warnings.group_by { |w| w[:file] }
+    
+    # Show errors first
+    if errors.any?
+      output << "\n" + "="*70
+      output << "❌ #{errors.length} error#{'s' if errors.length != 1} found"
+      output << "="*70
+      output << ""
       
-      # 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/
+      errors_by_file.each_with_index do |(file_path, file_errors), file_index|
+        output << "" if file_index > 0
+        
+        output << "📝 #{file_path} (#{file_errors.length} error#{'s' if file_errors.length != 1})"
+        
+        file_errors.each do |error|
+          error_line = "   • #{error[:type]}"
+          
+          # Add line number if available
+          if error[:line]
+            error_line += " [Line #{error[:line]}]"
+          end
+          
+          # Add element identifier
+          if error[:element][:id].present?
+            error_line += " [id: #{error[:element][:id]}]"
+          elsif error[:element][:href].present?
+            href_display = error[:element][:href].length > 30 ? "#{error[:element][:href][0..27]}..." : error[:element][:href]
+            error_line += " [href: #{href_display}]"
+          elsif error[:element][:src].present?
+            src_display = error[:element][:src].length > 30 ? "#{error[:element][:src][0..27]}..." : error[:element][:src]
+            error_line += " [src: #{src_display}]"
+          end
+          
+          output << error_line
+        end
+      end
       
-      # Skip routes with complex requirements
-      next false if path_spec.include?('destroy') || path_spec.include?('delete')
+      output << ""
+      output << "="*70
+    end
+    
+    # Show warnings if any
+    if warnings.any?
+      output << "\n" + "="*70
+      output << "⚠️  #{warnings.length} warning#{'s' if warnings.length != 1} found"
+      output << "="*70
+      output << ""
       
-      # Skip routes with multiple required params (too complex to test automatically)
-      param_count = path_spec.scan(/\(:(\w+)\)/).length
-      next false if param_count > 1
+      warnings_by_file.each_with_index do |(file_path, file_warnings), file_index|
+        output << "" if file_index > 0
+        
+        output << "📝 #{file_path} (#{file_warnings.length} warning#{'s' if file_warnings.length != 1})"
+        
+        file_warnings.each do |warning|
+          warning_line = "   • #{warning[:type]}"
+          
+          # Add line number if available
+          if warning[:line]
+            warning_line += " [Line #{warning[:line]}]"
+          end
+          
+          # Add element identifier
+          if warning[:element][:id].present?
+            warning_line += " [id: #{warning[:element][:id]}]"
+          elsif warning[:element][:href].present?
+            href_display = warning[:element][:href].length > 30 ? "#{warning[:element][:href][0..27]}..." : warning[:element][:href]
+            warning_line += " [href: #{href_display}]"
+          elsif warning[:element][:src].present?
+            src_display = warning[:element][:src].length > 30 ? "#{warning[:element][:src][0..27]}..." : warning[:element][:src]
+            warning_line += " [src: #{src_display}]"
+          end
+          
+          output << warning_line
+        end
+      end
       
-      true
+      output << ""
+      output << "="*70
     end
+    
+    output.join("\n")
   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
+  # Scan all view files statically
+  view_files = get_all_view_files
+  
+  if view_files.empty?
+    it "no view files found to scan" do
+      skip "No view files found in app/views"
+    end
+  else
+    view_files.each do |view_file|
+      it "scans #{view_file} for accessibility issues" do
+        require 'rails_accessibility_testing/static_file_scanner'
+        
+        scanner = RailsAccessibilityTesting::StaticFileScanner.new(view_file)
+        result = scanner.scan
         
-        # Wait for page to load
-        sleep 0.5
+        errors = result[:errors] || []
+        warnings = result[:warnings] || []
         
-        # 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"
+        if errors.any? || warnings.any?
+          puts format_static_errors(errors, warnings)
+          
+          if errors.any?
+            raise "Found #{errors.length} accessibility error#{'s' if errors.length != 1} in #{view_file}"
+          end
         else
-          # Page loaded successfully, run accessibility checks
-          check_comprehensive_accessibility
+          puts "✅ #{view_file}: No errors found"
         end
-      rescue => e
-        # Skip routes that can't be accessed
-        skip "Skipping #{path}: #{e.message}"
       end
     end
   end
 end
-