rails_accessibility_testing 1.4.3 → 1.5.1

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
+