Release v1.5.10: Composed page scanning and accessibility_enabled flag

Author: rayraycodes

CHANGELOG.md

@@ -5,6 +5,63 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.5.10] - 2024-12-01
+
+### Changed
+- **Configuration flag renamed**: The `enabled` flag has been renamed to `accessibility_enabled` for better clarity. The old `enabled` key is still supported for backward compatibility.
+
+### Added
+- **Composed Page Scanning**: The static scanner now analyzes complete page compositions (layout + view + partials) for page-level accessibility checks, eliminating false positives for heading hierarchy, ARIA landmarks, duplicate IDs, and heading issues.
+- **View Composition Builder**: New comprehensive system that traces the complete page structure by finding all partials recursively across all directories in `app/views`.
+- **Exhaustive Partial Detection**: Enhanced partial detection that finds partials in any subdirectory, not just specific folders. Works for deeply nested namespaces (e.g., `collections/collection_questions`).
+- **ERB Content Detection**: Improved handling of ERB expressions (`<%= ... %>`) to prevent false positives for empty headings and missing accessible names on buttons.
+
+### Changed
+- **Heading Hierarchy Checks**: Now performed on the complete composed page instead of individual files, preventing false positives when H1 is in layout or partials.
+- **ARIA Landmarks Checks**: Now checks for `<main>` landmark across the entire composed page.
+- **Duplicate ID Checks**: Now checks for duplicate IDs across the complete page composition.
+- **Empty Heading Checks**: Now checks for empty headings across the complete composed page.
+- **Partial Search**: Enhanced to traverse ALL folders in `app/views` recursively using `Dir.glob`, making it a general solution that works for any folder structure.
+
+### Fixed
+- Fixed false positive for "Page missing MAIN landmark" when `<main>` is in the layout file.
+- Fixed false positive for "Page has h2 but no h1 heading" when H1 is in a partial rendered via `render @model`.
+- Fixed false positive for "Heading hierarchy skipped (h0 to h2)" when first heading is h2.
+- Fixed false positive for "Duplicate ID 'ERB_CONTENT'" by filtering out ERB placeholder strings.
+- Fixed partial detection for Rails shorthand patterns (`render @model`, `render collection: @models`).
+- Fixed namespaced partial path resolution (e.g., `layouts/_advance_search`).
+- Fixed path normalization to handle both relative and absolute paths consistently.
+
+### Performance
+- Optimized exhaustive directory search to return first match found instead of checking all matches.
+
+## [Unreleased]
+
+### Added
+- **Composed Page Scanning**: The static scanner now analyzes complete page compositions (layout + view + partials) for page-level accessibility checks, eliminating false positives for heading hierarchy, ARIA landmarks, duplicate IDs, and heading issues.
+- **View Composition Builder**: New comprehensive system that traces the complete page structure by finding all partials recursively across all directories in `app/views`.
+- **Exhaustive Partial Detection**: Enhanced partial detection that finds partials in any subdirectory, not just specific folders. Works for deeply nested namespaces (e.g., `collections/collection_questions`).
+- **ERB Content Detection**: Improved handling of ERB expressions (`<%= ... %>`) to prevent false positives for empty headings and missing accessible names on buttons.
+
+### Changed
+- **Heading Hierarchy Checks**: Now performed on the complete composed page instead of individual files, preventing false positives when H1 is in layout or partials.
+- **ARIA Landmarks Checks**: Now checks for `<main>` landmark across the entire composed page.
+- **Duplicate ID Checks**: Now checks for duplicate IDs across the complete page composition.
+- **Empty Heading Checks**: Now checks for empty headings across the complete composed page.
+- **Partial Search**: Enhanced to traverse ALL folders in `app/views` recursively using `Dir.glob`, making it a general solution that works for any folder structure.
+
+### Fixed
+- Fixed false positive for "Page missing MAIN landmark" when `<main>` is in the layout file.
+- Fixed false positive for "Page has h2 but no h1 heading" when H1 is in a partial rendered via `render @model`.
+- Fixed false positive for "Heading hierarchy skipped (h0 to h2)" when first heading is h2.
+- Fixed false positive for "Duplicate ID 'ERB_CONTENT'" by filtering out ERB placeholder strings.
+- Fixed partial detection for Rails shorthand patterns (`render @model`, `render collection: @models`).
+- Fixed namespaced partial path resolution (e.g., `layouts/_advance_search`).
+- Fixed path normalization to handle both relative and absolute paths consistently.
+
+### Performance
+- Optimized exhaustive directory search to return first match found instead of checking all matches.
+
 ## [1.5.9] - 2024-12-01
 
 ### Added

README.md

@@ -7,7 +7,7 @@
 
 **The RSpec + RuboCop of accessibility for Rails. Catch WCAG violations before they reach production.**
 
-**Current Version:** 1.5.5
+**Current Version:** 1.5.9
 
 📖 **[📚 Full Documentation](https://rayraycodes.github.io/rails-accessibility-testing/)** | [💻 GitHub](https://github.com/rayraycodes/rails-accessibility-testing) | [💎 RubyGems](https://rubygems.org/gems/rails_accessibility_testing)
 
@@ -51,6 +51,13 @@ Rails Accessibility Testing fills a critical gap in the Rails testing ecosystem.
 - **Accurate error counting**: Properly tracks and displays error/warning counts
 - **Persistent output**: Errors stay visible in terminal (no clearing)
 
+#### 🔍 Composed Page Scanning (NEW in 1.5.9+)
+- **Complete page analysis**: Analyzes full page composition (layout + view + partials) for page-level checks
+- **Eliminates false positives**: No more false positives when H1 is in layout or partials
+- **Exhaustive partial finding**: Traverses ALL folders recursively to find all partials
+- **Works for any structure**: General solution that works for any Rails folder structure (collections, items, profiles, loan_requests, etc.)
+- **Page-level checks**: Heading hierarchy, ARIA landmarks, duplicate IDs, and empty headings checked across complete page
+
 #### 🔍 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
@@ -61,6 +68,7 @@ Rails Accessibility Testing fills a critical gap in the Rails testing ecosystem.
 - **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
+- **Optimized directory search**: Returns first match found instead of checking all matches
 
 #### 🎨 Enhanced Developer Experience
 - **Real-time progress**: Step-by-step feedback during accessibility checks

RELEASE_1.5.7.md

@@ -3,7 +3,45 @@ layout: default
 title: Architecture
 ---
 
-# Architecture Overview
+# Architecture
+
+## Composed Page Scanning
+
+The gem now uses **composed page scanning** for page-level accessibility checks. This ensures that checks like heading hierarchy, ARIA landmarks, and duplicate IDs are evaluated against the complete rendered page (layout + view + partials), not individual files.
+
+### View Composition Builder
+
+The `ViewCompositionBuilder` class traces the complete page structure:
+
+1. **Finds Layout File**: Identifies the layout file (defaults to `application.html.erb`)
+2. **Finds View File**: The main view file being rendered
+3. **Recursively Finds Partials**: Discovers all partials rendered in the view, including:
+   - Partials in the same directory
+   - Partials in `layouts/`, `shared/`, `application/`
+   - Partials in any subdirectory (exhaustive search)
+   - Nested partials (partials within partials)
+
+### Partial Detection
+
+The gem detects all Rails render patterns:
+- `render 'partial'`
+- `render partial: 'partial'`
+- `render @model` (Rails shorthand)
+- `render collection: @models`
+- `render partial: 'item', collection: @items`
+- `render partial: 'form', locals: {...}`
+
+### Exhaustive Folder Traversal
+
+The partial search traverses ALL folders in `app/views` recursively using `Dir.glob`, ensuring partials are found regardless of their location:
+- `app/views/collections/`
+- `app/views/collections/collection_questions/`
+- `app/views/items/`
+- `app/views/profiles/`
+- `app/views/loan_requests/`
+- Any other nested structure
+
+This makes it a general solution that works for any Rails application structure. Overview
 
 This guide explains how Rails Accessibility Testing works under the hood in simple terms.
 

docs_site/architecture.md

@@ -144,12 +144,12 @@ Rails Accessibility Testing runs **11 comprehensive checks** automatically. Thes
 1. **Form Labels** - All form inputs have associated labels
 2. **Image Alt Text** - All images have descriptive alt attributes
 3. **Interactive Elements** - Buttons, links have accessible names
-4. **Heading Hierarchy** - Proper h1-h6 structure without skipping levels
+4. **Heading Hierarchy** - Proper h1-h6 structure without skipping levels (checked across complete page: layout + view + partials)
 5. **Keyboard Accessibility** - All interactive elements are keyboard accessible
-6. **ARIA Landmarks** - Proper use of ARIA landmark roles
+6. **ARIA Landmarks** - Proper use of ARIA landmark roles (checked across complete page: layout + view + partials)
 7. **Form Error Associations** - Form errors are properly linked to form fields
 8. **Table Structure** - Tables have proper headers
-9. **Duplicate IDs** - No duplicate ID attributes
+9. **Duplicate IDs** - No duplicate ID attributes (checked across complete page: layout + view + partials)
 10. **Skip Links** - Skip navigation links present
 11. **Color Contrast** - Text meets WCAG contrast requirements (optional, disabled by default)
 

docs_site/getting_started.md

@@ -7,7 +7,7 @@ title: Home
 
 **The RSpec + RuboCop of accessibility for Rails. Catch WCAG violations before they reach production.**
 
-**Version:** 1.5.5
+**Version:** 1.5.9
 
 Rails Accessibility Testing is a comprehensive, opinionated but configurable gem that makes accessibility testing as natural as unit testing. It integrates seamlessly into your Rails workflow, catching accessibility issues as you code—not after deployment.
 

docs_site/index.md

@@ -35,10 +35,11 @@ begin
     require 'rails_accessibility_testing/config/yaml_loader'
     profile = defined?(Rails) && Rails.env.test? ? :test : :development
     config = RailsAccessibilityTesting::Config::YamlLoader.load(profile: profile)
-    enabled = config.fetch('enabled', true)
+    # Support both 'accessibility_enabled' (new) and 'enabled' (legacy) for backward compatibility
+    enabled = config.fetch('accessibility_enabled', config.fetch('enabled', true))
     unless enabled
-      puts "⏸️  Accessibility checks are disabled (enabled: false in config/accessibility.yml)"
-      puts "   Set enabled: true to enable accessibility scanning"
+      puts "⏸️  Accessibility checks are disabled (accessibility_enabled: false in config/accessibility.yml)"
+      puts "   Set accessibility_enabled: true to enable accessibility scanning"
       puts "   Scanner process will remain running but will not scan files"
       puts ""
       # Keep process alive so Foreman doesn't kill other processes

exe/a11y_live_scanner

@@ -29,10 +29,11 @@ begin
     require 'rails_accessibility_testing/config/yaml_loader'
     profile = defined?(Rails) && Rails.env.test? ? :test : :development
     config = RailsAccessibilityTesting::Config::YamlLoader.load(profile: profile)
-    enabled = config.fetch('enabled', true)
+    # Support both 'accessibility_enabled' (new) and 'enabled' (legacy) for backward compatibility
+    enabled = config.fetch('accessibility_enabled', config.fetch('enabled', true))
     unless enabled
-      puts "⏸️  Accessibility checks are disabled (enabled: false in config/accessibility.yml)"
-      puts "   Set enabled: true to enable accessibility scanning"
+      puts "⏸️  Accessibility checks are disabled (accessibility_enabled: false in config/accessibility.yml)"
+      puts "   Set accessibility_enabled: true to enable accessibility scanning"
       puts "   Scanner process will remain running but will not scan files"
       puts ""
       # Keep process alive so Foreman doesn't kill other processes

exe/a11y_static_scanner

@@ -3,11 +3,11 @@
 # This file configures accessibility checks for your Rails application.
 # See https://github.com/your-org/rails-a11y for full documentation.
 
-# Global enable/disable flag
+# Global enable/disable flag for all accessibility checks
 # Set to false to completely disable all accessibility checks (manual and automatic)
 # When false, check_comprehensive_accessibility and automatic checks will be skipped
 # Default: true
-enabled: true
+accessibility_enabled: true
 
 # WCAG compliance level (A, AA, AAA)
 wcag_level: AA

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

@@ -55,6 +55,8 @@ module RailsAccessibilityTesting
 require_relative 'rails_accessibility_testing/violation_converter'
 require_relative 'rails_accessibility_testing/static_file_scanner'
 require_relative 'rails_accessibility_testing/static_scanning'
+require_relative 'rails_accessibility_testing/view_composition_builder'
+require_relative 'rails_accessibility_testing/composed_page_scanner'
 # Only load RSpec-specific components when RSpec is available
 if defined?(RSpec)
   require_relative 'rails_accessibility_testing/shared_examples'