rails_accessibility_testing 1.5.5 → 1.5.6

data/lib/rails_accessibility_testing/accessibility_helper.rb

@@ -115,6 +115,43 @@ module RailsAccessibilityTesting
         
         nil
       end
+      
+      # Find partial in layouts directory based on element context
+      def find_partial_in_layouts(element_context)
+        return nil unless element_context
+        
+        extensions = %w[erb haml slim]
+        id = element_context[:id].to_s
+        classes = element_context[:classes].to_s
+        
+        # Common layout partial names
+        partial_names = []
+        partial_names << id.split('-').first if id.present?
+        partial_names << id.split('_').first if id.present?
+        
+        if classes.present?
+          classes.split(/\s+/).each do |cls|
+            partial_names << cls.split('-').first
+            partial_names << cls.split('_').first
+          end
+        end
+        
+        # Check all partials in layouts directory
+        extensions.each do |ext|
+          # First try specific names
+          partial_names.uniq.each do |partial_name|
+            next if partial_name.blank?
+            partial_path = "app/views/layouts/_#{partial_name}.html.#{ext}"
+            return partial_path if File.exist?(partial_path)
+          end
+          
+          # If no match, scan all layout partials and try to match by content
+          layout_partials = Dir.glob("app/views/layouts/_*.html.#{ext}")
+          # Could add content-based matching here if needed
+        end
+        
+        nil
+      end
     end
     
     # Include PartialDetection in AccessibilityHelper so methods are available
@@ -598,6 +635,16 @@ module RailsAccessibilityTesting
   end
 
   # Determine likely view file based on Rails path and element context
+  # 
+  # Priority order (based on Rails HTML structure):
+  # 1. View file (yield content) - most common location for page-specific issues
+  # 2. Partials rendered in the view file
+  # 3. Layout partials (navbar, footer) - site-wide components
+  # 4. Layout file (application.html.erb) - wrapper structure
+  #
+  # This ensures errors are attributed to the correct file:
+  # - Page-specific issues → view files (yield content)
+  # - Site-wide issues → layout partials
   def determine_view_file(path, url, element_context = nil)
     return nil unless path
     
@@ -610,10 +657,12 @@ module RailsAccessibilityTesting
         controller = route[:controller]
         action = route[:action]
         
-        # Try to find the exact view file
+        # Priority 1: Try to find the exact view file (yield content)
+        # This is where most page-specific accessibility issues occur
         view_file = find_view_file_for_controller_action(controller, action)
         
-        # If we found the view file, check for partials that might contain the element
+        # Priority 2: Check for partials rendered in the view file
+        # These are page-specific partials (e.g., _form, _item_card)
         if view_file && element_context
           # Scan the view file for rendered partials
           partials_in_view = find_partials_in_view_file(view_file)
@@ -623,23 +672,25 @@ module RailsAccessibilityTesting
           return partial_file if partial_file
         end
         
-        # If element might be in a partial or layout, check those too
-        if element_context
-          # Check if element is likely in a layout (navbar, footer, etc.)
-          if element_in_layout?(element_context)
-            layout_file = find_layout_file
-            return layout_file if layout_file
-            
-            # Also check layout partials
-            layout_partial = find_partial_in_layouts(element_context)
-            return layout_partial if layout_partial
-          end
+        # Priority 3: Check if element is in a layout partial (navbar, footer, etc.)
+        # These are site-wide components rendered in the layout
+        if element_context && element_in_layout?(element_context)
+          # Check layout partials first (more specific than layout file)
+          layout_partial = find_partial_in_layouts(element_context)
+          return layout_partial if layout_partial
           
-          # Check if element is in a partial based on context
+          # Then check layout file itself
+          layout_file = find_layout_file
+          return layout_file if layout_file
+        end
+        
+        # Priority 4: Check other partials (shared partials, etc.)
+        if element_context
           partial_file = find_partial_for_element(controller, element_context)
           return partial_file if partial_file
         end
         
+        # Return view file if found (yield content - most common case)
         return view_file if view_file
       rescue StandardError => e
         # Fall through to path-based detection
@@ -713,6 +764,15 @@ module RailsAccessibilityTesting
   end
 
   # Check if element is likely in a layout (navbar, footer, etc.)
+  # vs yield content (main area)
+  #
+  # Based on Rails HTML structure:
+  # - Layout elements: navbar, footer, header (outside <main>)
+  # - Yield content: elements inside <main id="maincontent"> (view files)
+  #
+  # This helps correctly attribute errors:
+  # - Layout issues → layout partials/files
+  # - Page-specific issues → view files (yield content)
   def element_in_layout?(element_context)
     return false unless element_context
     
@@ -720,8 +780,18 @@ module RailsAccessibilityTesting
     parent = element_context[:parent]
     return false unless parent
     
-    # Common layout class/id patterns
-    layout_indicators = ['navbar', 'nav', 'footer', 'header', 'main-nav', 'sidebar']
+    # If element is inside <main>, it's likely yield content (view file), not layout
+    # Check if parent or ancestor is main element
+    parent_tag = parent[:tag].to_s.downcase
+    parent_id = parent[:id].to_s.downcase
+    
+    # Elements inside <main> are yield content, not layout
+    if parent_tag == 'main' || parent_id.include?('maincontent') || parent_id.include?('main-content')
+      return false
+    end
+    
+    # Common layout class/id patterns (navbar, footer, header)
+    layout_indicators = ['navbar', 'nav', 'footer', 'header', 'main-nav', 'sidebar', 'skip']
     
     classes = parent[:classes].to_s.downcase
     id = parent[:id].to_s.downcase

data/lib/rails_accessibility_testing/checks/base_check.rb

@@ -137,8 +137,12 @@ module RailsAccessibilityTesting
         nil
       end
       
-      # Determine likely view file (simplified version)
-      # Also checks for partials that might contain the element
+      # Determine likely view file (simplified version for checks)
+      # Uses same priority logic as AccessibilityHelper:
+      # 1. View file (yield content) - most common
+      # 2. Partials in view file
+      # 3. Layout partials
+      # 4. Layout file
       def determine_view_file(element_context = nil)
         return nil unless safe_page_path
         
@@ -150,20 +154,43 @@ module RailsAccessibilityTesting
             controller = route[:controller]
             action = route[:action]
             
+            # Priority 1: View file (yield content)
             view_file = find_view_file_for_controller_action(controller, action)
             
-            # If we found the view file and have element context, check for partials
+            # Priority 2: Partials rendered in the view file
             if view_file && element_context
-              # Scan the view file for rendered partials
               partials_in_view = find_partials_in_view_file(view_file)
               
-              # Check if element matches any partial in the view
               if partials_in_view.any?
                 partial_file = find_partial_for_element_in_list(controller, element_context, partials_in_view)
                 return partial_file if partial_file
               end
             end
             
+            # Priority 3: Layout partials (if element is in layout area)
+            if element_context
+              # Use the same element_in_layout? logic from AccessibilityHelper
+              # Check if element is likely in layout (navbar, footer, etc.)
+              parent = element_context[:parent]
+              if parent
+                parent_tag = parent[:tag].to_s.downcase
+                parent_id = parent[:id].to_s.downcase
+                
+                # Skip if inside <main> (yield content)
+                unless parent_tag == 'main' || parent_id.include?('maincontent') || parent_id.include?('main-content')
+                  layout_indicators = ['navbar', 'nav', 'footer', 'header', 'main-nav', 'sidebar', 'skip']
+                  classes = parent[:classes].to_s.downcase
+                  id = parent[:id].to_s.downcase
+                  
+                  if layout_indicators.any? { |indicator| classes.include?(indicator) || id.include?(indicator) }
+                    layout_partial = find_partial_in_layouts(element_context)
+                    return layout_partial if layout_partial
+                  end
+                end
+              end
+            end
+            
+            # Return view file (yield content) - most common case
             view_file
           rescue StandardError
             nil

data/lib/rails_accessibility_testing/checks/interactive_elements_check.rb

@@ -18,6 +18,29 @@ module RailsAccessibilityTesting
         page.all('button, a[href], [role="button"], [role="link"]').each do |element|
           next unless element.visible?
           
+          # Check for headings inside button elements (accessibility violation)
+          # Headings should not be nested inside interactive elements
+          if element.tag_name == 'button' || element[:role] == 'button'
+            headings_inside = element.all('h1, h2, h3, h4, h5, h6', visible: true)
+            if headings_inside.any?
+              headings_inside.each do |heading|
+                element_ctx = element_context(element)
+                heading_level = heading.tag_name
+                element_ctx[:nested_heading] = heading_level
+                element_ctx[:heading_text] = heading.text.strip
+                
+                violations << violation(
+                  message: "Button contains #{heading_level.upcase} heading - headings should not be nested inside buttons",
+                  element_context: element_ctx,
+                  wcag_reference: "4.1.2",
+                  remediation: "Remove the heading from inside the button. Use plain text or aria-label instead:\n\n" \
+                               "<button aria-label='#{heading.text.strip}'>#{heading.text.strip}</button>\n\n" \
+                               "Or use a div/span with appropriate styling instead of a heading element."
+                )
+              end
+            end
+          end
+          
           text = element.text.to_s.strip
           aria_label = element[:"aria-label"]
           aria_labelledby = element[:"aria-labelledby"]

data/lib/rails_accessibility_testing/config/yaml_loader.rb

@@ -78,11 +78,17 @@ module RailsAccessibilityTesting
           profile_static_scanner = profile_config['static_scanner'] || {}
           merged_static_scanner = base_static_scanner.merge(profile_static_scanner)
           
+          # Merge system_specs config
+          base_system_specs = base_config['system_specs'] || {}
+          profile_system_specs = profile_config['system_specs'] || {}
+          merged_system_specs = base_system_specs.merge(profile_system_specs)
+          
           base_config.merge(
             'checks' => merged_checks,
             'summary' => merged_summary,
             'scan_strategy' => profile_config['scan_strategy'] || base_config['scan_strategy'] || 'paths',
             'static_scanner' => merged_static_scanner,
+            'system_specs' => merged_system_specs,
             'profile' => profile.to_s,
             'ignored_rules' => parse_ignored_rules(parsed, profile)
           )
@@ -125,6 +131,9 @@ module RailsAccessibilityTesting
               'ignore_warnings' => false
             },
             'scan_strategy' => 'paths',
+            'system_specs' => {
+              'auto_run' => false  # Run accessibility checks automatically in system specs (default: false)
+            },
             'ignored_rules' => [],
             'profile' => 'test'
           }

data/lib/rails_accessibility_testing/error_message_builder.rb

@@ -138,6 +138,8 @@ module RailsAccessibilityTesting
           custom_element_remediation(error_type, element_context)
         when /Duplicate IDs found/i
           duplicate_ids_remediation(element_context)
+        when /Button contains.*heading|heading.*inside.*button/i
+          button_heading_remediation(error_type, element_context)
         else
           # Fallback: try to match on key phrases even if format is slightly different
           case error_type.to_s
@@ -169,6 +171,8 @@ module RailsAccessibilityTesting
             custom_element_remediation(error_type, element_context)
           when /duplicate.*id/i
             duplicate_ids_remediation(element_context)
+          when /button.*heading|heading.*button/i
+            button_heading_remediation(error_type, element_context)
           else
             "   Please review the element details above and fix the accessibility issue."
           end
@@ -406,6 +410,30 @@ module RailsAccessibilityTesting
         remediation
       end
 
+      def button_heading_remediation(error_type, element_context)
+        heading_level = element_context[:nested_heading] || 'H2'
+        heading_text = element_context[:heading_text] || 'Section Title'
+        
+        remediation = "   Remove heading from inside button:\n\n"
+        remediation += "   ❌ Current (Bad):\n"
+        remediation += "   <button>\n"
+        remediation += "     <#{heading_level.downcase}>#{heading_text}</#{heading_level.downcase}>\n"
+        remediation += "   </button>\n\n"
+        remediation += "   ✅ Solution 1: Use plain text with aria-label:\n"
+        remediation += "   <button aria-label=\"#{heading_text}\">#{heading_text}</button>\n\n"
+        remediation += "   ✅ Solution 2: Use span/div with CSS styling:\n"
+        remediation += "   <button>\n"
+        remediation += "     <span class=\"button-title\">#{heading_text}</span>\n"
+        remediation += "   </button>\n\n"
+        remediation += "   ✅ Solution 3: Separate heading and button:\n"
+        remediation += "   <#{heading_level.downcase}>#{heading_text}</#{heading_level.downcase}>\n"
+        remediation += "   <button>Action</button>\n\n"
+        remediation += "   💡 Best Practice: Headings should not be nested inside buttons.\n"
+        remediation += "      Buttons are interactive elements, headings are structural.\n"
+        remediation += "      Use plain text or aria-label for button labels.\n"
+        remediation
+      end
+
       def footer
         "📖 WCAG Reference: #{WCAG_REFERENCE}\n#{SEPARATOR}"
       end

data/lib/rails_accessibility_testing/rspec_integration.rb

@@ -9,7 +9,31 @@ module RailsAccessibilityTesting
         enable_spec_type_inference(config)
         include_matchers(config)
         include_helpers(config)
-        setup_automatic_checks(config) if RailsAccessibilityTesting.config.auto_run_checks
+        
+        # Check YAML config first, then fall back to initializer config
+        auto_run = should_auto_run_checks?
+        setup_automatic_checks(config) if auto_run
+      end
+      
+      # Determine if checks should run automatically
+      # Checks YAML config first, then falls back to initializer config
+      def should_auto_run_checks?
+        # Try to load from YAML config
+        begin
+          require 'rails_accessibility_testing/config/yaml_loader'
+          profile = defined?(Rails) && Rails.env.test? ? :test : :development
+          yaml_config = Config::YamlLoader.load(profile: profile)
+          
+          # Check if system_specs.auto_run is explicitly set in YAML
+          if yaml_config['system_specs'] && yaml_config['system_specs'].key?('auto_run')
+            return yaml_config['system_specs']['auto_run']
+          end
+        rescue StandardError
+          # If YAML loading fails, fall through to initializer config
+        end
+        
+        # Fall back to initializer configuration
+        RailsAccessibilityTesting.config.auto_run_checks
       end
 
       private

data/lib/rails_accessibility_testing/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module RailsAccessibilityTesting
-  VERSION = "1.5.5"
+  VERSION = "1.5.6"
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_accessibility_testing
 version: !ruby/object:Gem::Version
-  version: 1.5.5
+  version: 1.5.6
 platform: ruby
 authors:
 - Regan Maharjan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-11-20 00:00:00.000000000 Z
+date: 2025-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: axe-core-capybara
@@ -116,6 +116,7 @@ files:
 - docs_site/ci_integration.md
 - docs_site/configuration.md
 - docs_site/contributing.md
+- docs_site/favicon.svg
 - docs_site/getting_started.md
 - docs_site/index.md
 - exe/a11y_live_scanner