rails_accessibility_testing 1.4.3 → 1.5.0

data/lib/rails_accessibility_testing/middleware/page_visit_logger.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'fileutils'
+
+module RailsAccessibilityTesting
+  module Middleware
+    # Middleware to log page visits for live accessibility scanning
+    # Only active in development environment
+    class PageVisitLogger
+      def initialize(app)
+        @app = app
+        @log_file = Rails.root.join('tmp', 'a11y_page_visits.log')
+        FileUtils.mkdir_p(File.dirname(@log_file))
+        @pending_logs = []
+        @last_flush = Time.now
+        @mutex = Mutex.new
+        
+        # Start background thread to flush logs periodically
+        @flush_thread = Thread.new do
+          loop do
+            sleep 2 # Flush every 2 seconds
+            flush_logs
+          end
+        end
+      end
+
+      def call(env)
+        request = ActionDispatch::Request.new(env)
+        
+        # Only log GET requests for HTML pages in development
+        if Rails.env.development? && 
+           request.get? && 
+           request.format.html? &&
+           !request.path.start_with?('/assets', '/packs', '/rails', '/letter_opener')
+          
+          # Add to pending logs (thread-safe)
+          @mutex.synchronize do
+            @pending_logs << {
+              path: request.path,
+              url: request.url,
+              timestamp: Time.now.to_f
+            }
+            
+            # Flush immediately if we have 3+ pending logs
+            flush_logs if @pending_logs.length >= 3
+          end
+        end
+        
+        @app.call(env)
+      end
+
+      private
+
+      def flush_logs
+        logs_to_write = []
+        
+        @mutex.synchronize do
+          return if @pending_logs.empty?
+          logs_to_write = @pending_logs.dup
+          @pending_logs.clear
+          @last_flush = Time.now
+        end
+        
+        return if logs_to_write.empty?
+        
+        # Write all logs at once
+        File.open(@log_file, 'a') do |f|
+          logs_to_write.each do |log_entry|
+            f.puts(log_entry.to_json)
+          end
+          f.flush
+        end
+      rescue StandardError => e
+        # Silently fail - don't break the app if logging fails
+        Rails.logger.debug("Failed to flush page visit logs: #{e.message}") if defined?(Rails.logger)
+      end
+    end
+  end
+end
+

data/lib/rails_accessibility_testing/railtie.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Only define Railtie if Rails is available
+if defined?(Rails)
+  module RailsAccessibilityTesting
+    # Railtie for Rails integration
+    # Makes generators available to Rails
+    class Railtie < Rails::Railtie
+      # Generators are automatically discovered by Rails
+      # when they're in lib/generators/ directory
+      
+      # Add middleware for live scanning in development
+      initializer 'rails_accessibility_testing.middleware' do |app|
+        if Rails.env.development?
+          require 'rails_accessibility_testing/middleware/page_visit_logger'
+          app.middleware.use RailsAccessibilityTesting::Middleware::PageVisitLogger
+        end
+      end
+    end
+  end
+end
+

data/lib/rails_accessibility_testing/rspec_integration.rb

@@ -27,11 +27,21 @@ module RailsAccessibilityTesting
 
       # Include accessibility helpers for system specs
       def include_helpers(config)
-        config.include AccessibilityHelper, type: :system
+        config.include RailsAccessibilityTesting::AccessibilityHelper, type: :system
       end
 
       # Setup automatic accessibility checks
       def setup_automatic_checks(config)
+        # Use class variable to track results across all examples
+        @@accessibility_results = {
+          pages_tested: [],
+          total_errors: 0,
+          total_warnings: 0,
+          pages_passed: 0,
+          pages_failed: 0,
+          pages_with_warnings: 0
+        }
+        
         config.after(:each, type: :system) do |example|
           # Skip if test failed or explicitly skipped
           next if example.exception
@@ -45,19 +55,175 @@ module RailsAccessibilityTesting
             next
           end
 
+          # Track this page test
+          page_result = {
+            path: current_path,
+            errors: 0,
+            warnings: 0,
+            status: :pending
+          }
+          
           # Run comprehensive accessibility checks
+          # Note: check_comprehensive_accessibility will:
+          # - Raise if there are errors (test fails)
+          # - Print warnings if there are warnings (test passes but shows warnings)
+          # - Print success message if everything passes (no errors, no warnings)
+          # - Return hash with :errors and :warnings counts
           instance = example.example_group_instance
-          instance.check_comprehensive_accessibility
           
-          # If we get here without an exception, all checks passed
-          # Note: check_comprehensive_accessibility will raise if there are errors,
-          # so if we reach this point, checks passed successfully
-          $stdout.puts "\n✅ All comprehensive accessibility checks passed! (11 checks)"
-          $stdout.flush
-        rescue StandardError => e
-          # Accessibility check failed - set the exception so test fails
-          example.set_exception(e)
+          begin
+            result = instance.check_comprehensive_accessibility
+            
+            # Get results from return value
+            page_result[:errors] = result[:errors] || 0
+            page_result[:warnings] = result[:warnings] || 0
+            # Capture view_file if available from result
+            page_result[:view_file] = result[:page_context][:view_file] if result[:page_context] && result[:page_context][:view_file]
+            
+            if page_result[:errors] > 0
+              page_result[:status] = :failed
+              @@accessibility_results[:pages_failed] += 1
+              @@accessibility_results[:total_errors] += page_result[:errors]
+            elsif page_result[:warnings] > 0
+              page_result[:status] = :warning
+              @@accessibility_results[:pages_with_warnings] += 1
+              @@accessibility_results[:total_warnings] += page_result[:warnings]
+            else
+              page_result[:status] = :passed
+              @@accessibility_results[:pages_passed] += 1
+            end
+            
+            @@accessibility_results[:pages_tested] << page_result
+          rescue StandardError => e
+            # Accessibility check failed - extract error count from exception message or instance
+            errors_count = 0
+            warnings_count = 0
+            
+            # Try to extract counts from exception message first
+            if e.message =~ /ACCESSIBILITY ERRORS FOUND: (\d+) error\(s\), (\d+) warning\(s\)/
+              errors_count = $1.to_i
+              warnings_count = $2.to_i
+            elsif e.message =~ /(\d+) issue\(s\)/
+              errors_count = $1.to_i
+            else
+              # Fallback: get from instance variables
+              errors_count = instance.instance_variable_get(:@accessibility_errors)&.length || 1
+              warnings_count = instance.instance_variable_get(:@accessibility_warnings)&.length || 0
+            end
+            
+            # Ensure we have at least 1 error if exception was raised
+            errors_count = 1 if errors_count == 0 && e.message.include?('ACCESSIBILITY ERRORS')
+            
+            page_result[:status] = :failed
+            page_result[:errors] = errors_count
+            page_result[:warnings] = warnings_count
+            @@accessibility_results[:pages_failed] += 1
+            @@accessibility_results[:total_errors] += errors_count
+            @@accessibility_results[:total_warnings] += warnings_count
+            @@accessibility_results[:pages_tested] << page_result
+            
+            # Flush stdout BEFORE setting exception to ensure errors are visible
+            $stdout.flush
+            $stderr.flush
+            
+            # Store error info in example metadata so it's available even if output is cleared
+            example.metadata[:a11y_errors] = errors_count
+            example.metadata[:a11y_warnings] = warnings_count
+            example.metadata[:a11y_failed] = true
+            
+            # Set exception but don't clear output - keep errors visible
+            example.set_exception(e)
+            
+            # Flush again after setting exception
+            $stdout.flush
+            $stderr.flush
+          end
+        end
+        
+        # Show overall summary after all tests complete
+        config.after(:suite) do
+          # Show summary if we tested any pages
+          if @@accessibility_results && @@accessibility_results[:pages_tested].any?
+            show_overall_summary(@@accessibility_results)
+          end
+        end
+      end
+      
+      # Show overall summary of all pages tested
+      def show_overall_summary(results)
+        return unless results && results[:pages_tested].any?
+        
+        puts "\n" + "="*80
+        puts "📊 COMPREHENSIVE ACCESSIBILITY TEST REPORT"
+        puts "="*80
+        puts ""
+        puts "📈 Test Statistics:"
+        puts "   Total pages tested: #{results[:pages_tested].length}"
+        puts "   ✅ Passed (no issues):  #{results[:pages_passed]} page#{'s' if results[:pages_passed] != 1}"
+        puts "   ❌ Failed (errors):     #{results[:pages_failed]} page#{'s' if results[:pages_failed] != 1}"
+        puts "   ⚠️  Warnings only:      #{results[:pages_with_warnings]} page#{'s' if results[:pages_with_warnings] != 1}"
+        puts ""
+        puts "📋 Total Issues Across All Pages:"
+        puts "   ❌ Total errors:   #{results[:total_errors]}"
+        puts "   ⚠️  Total warnings: #{results[:total_warnings]}"
+        puts ""
+        
+        # Show pages with errors (highest priority)
+        pages_with_errors = results[:pages_tested].select { |p| p[:status] == :failed }
+        if pages_with_errors.any?
+          puts "❌ Pages with Errors (#{pages_with_errors.length}):"
+          pages_with_errors.each do |page|
+            view_file = page[:view_file] || page[:path]
+            puts "   • #{view_file}"
+            puts "     Errors: #{page[:errors]}#{", Warnings: #{page[:warnings]}" if page[:warnings] > 0}"
+            puts "     Path: #{page[:path]}" if page[:view_file] && page[:path] != view_file
+          end
+          puts ""
+        end
+        
+        # Show pages with warnings only
+        pages_with_warnings_only = results[:pages_tested].select { |p| p[:status] == :warning }
+        if pages_with_warnings_only.any?
+          puts "⚠️  Pages with Warnings Only (#{pages_with_warnings_only.length}):"
+          pages_with_warnings_only.each do |page|
+            view_file = page[:view_file] || page[:path]
+            puts "   • #{view_file}"
+            puts "     Warnings: #{page[:warnings]}"
+            puts "     Path: #{page[:path]}" if page[:view_file] && page[:path] != view_file
+          end
+          puts ""
+        end
+        
+        # Show summary of pages that passed
+        pages_passed = results[:pages_tested].select { |p| p[:status] == :passed }
+        if pages_passed.any?
+          if pages_passed.length <= 15
+            puts "✅ Pages Passed All Checks (#{pages_passed.length}):"
+            pages_passed.each do |page|
+              puts "   ✓ #{page[:path]}"
+            end
+          else
+            puts "✅ #{pages_passed.length} pages passed all accessibility checks"
+            puts "   (Showing first 10):"
+            pages_passed.first(10).each do |page|
+              puts "   ✓ #{page[:path]}"
+            end
+            puts "   ... and #{pages_passed.length - 10} more"
+          end
+          puts ""
+        end
+        
+        # Final summary
+        puts "="*80
+        if results[:total_errors] > 0
+          puts "❌ OVERALL STATUS: FAILED - #{results[:total_errors]} error#{'s' if results[:total_errors] != 1} found across #{results[:pages_failed]} page#{'s' if results[:pages_failed] != 1}"
+        elsif results[:total_warnings] > 0
+          puts "⚠️  OVERALL STATUS: PASSED WITH WARNINGS - #{results[:total_warnings]} warning#{'s' if results[:total_warnings] != 1} found"
+        else
+          puts "✅ OVERALL STATUS: PASSED - All #{results[:pages_tested].length} page#{'s' if results[:pages_tested].length != 1} passed accessibility checks!"
         end
+        puts "="*80
+        puts ""
       end
     end
   end

data/lib/rails_accessibility_testing/version.rb

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

data/lib/rails_accessibility_testing.rb

@@ -5,7 +5,7 @@
 # Automatically configures accessibility testing for Rails system specs with
 # comprehensive checks and detailed error messages.
 #
-# @version 1.4.3
+# @version 1.5.0
 # @author Regan Maharjan
 #
 # @example Basic usage
@@ -38,7 +38,7 @@ begin
   require_relative 'rails_accessibility_testing/version'
 rescue LoadError
   module RailsAccessibilityTesting
-    VERSION = '1.4.3'
+    VERSION = '1.5.0'
   end
 end
 
@@ -63,7 +63,7 @@ require_relative 'rails_accessibility_testing/checks/base_check'
 require_relative 'rails_accessibility_testing/checks/form_labels_check'
 require_relative 'rails_accessibility_testing/checks/image_alt_text_check'
 require_relative 'rails_accessibility_testing/checks/interactive_elements_check'
-require_relative 'rails_accessibility_testing/checks/heading_hierarchy_check'
+require_relative 'rails_accessibility_testing/checks/heading_check'
 require_relative 'rails_accessibility_testing/checks/keyboard_accessibility_check'
 require_relative 'rails_accessibility_testing/checks/aria_landmarks_check'
 require_relative 'rails_accessibility_testing/checks/form_errors_check'
@@ -78,6 +78,11 @@ require_relative 'rails_accessibility_testing/config/yaml_loader'
 # Load integrations
 require_relative 'rails_accessibility_testing/integration/minitest_integration'
 
+# Load railtie (needed for generator discovery) - only if Rails is available
+if defined?(Rails)
+  require_relative 'rails_accessibility_testing/railtie'
+end
+
 # Auto-configure when RSpec is available
 if defined?(RSpec)
   RSpec.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_accessibility_testing
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.5.0
 platform: ruby
 authors:
 - Regan Maharjan
@@ -75,6 +75,7 @@ email:
 executables:
 - rails_a11y
 - rails_server_safe
+- a11y_live_scanner
 extensions: []
 extra_rdoc_files: []
 files:
@@ -101,9 +102,10 @@ files:
 - docs_site/contributing.md
 - docs_site/getting_started.md
 - docs_site/index.md
+- exe/a11y_live_scanner
 - exe/rails_a11y
 - exe/rails_server_safe
-- lib/generators/rails_a11y/install/generator.rb
+- lib/generators/rails_a11y/install/install_generator.rb
 - lib/rails_accessibility_testing.rb
 - lib/rails_accessibility_testing/accessibility_helper.rb
 - lib/rails_accessibility_testing/change_detector.rb
@@ -113,7 +115,7 @@ files:
 - lib/rails_accessibility_testing/checks/duplicate_ids_check.rb
 - lib/rails_accessibility_testing/checks/form_errors_check.rb
 - lib/rails_accessibility_testing/checks/form_labels_check.rb
-- lib/rails_accessibility_testing/checks/heading_hierarchy_check.rb
+- lib/rails_accessibility_testing/checks/heading_check.rb
 - lib/rails_accessibility_testing/checks/image_alt_text_check.rb
 - lib/rails_accessibility_testing/checks/interactive_elements_check.rb
 - lib/rails_accessibility_testing/checks/keyboard_accessibility_check.rb
@@ -127,6 +129,8 @@ files:
 - lib/rails_accessibility_testing/engine/violation_collector.rb
 - lib/rails_accessibility_testing/error_message_builder.rb
 - lib/rails_accessibility_testing/integration/minitest_integration.rb
+- lib/rails_accessibility_testing/middleware/page_visit_logger.rb
+- lib/rails_accessibility_testing/railtie.rb
 - lib/rails_accessibility_testing/rspec_integration.rb
 - lib/rails_accessibility_testing/shared_examples.rb
 - lib/rails_accessibility_testing/version.rb

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

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/generators/base'
-
-module RailsAccessibilityTesting
-  module Generators
-    # Generator to install Rails Accessibility Testing
-    #
-    # Creates initializer and configuration file.
-    #
-    # @example
-    #   rails generate rails_a11y:install
-    #
-    class InstallGenerator < Rails::Generators::Base
-      source_root File.expand_path('templates', __dir__)
-      
-      desc "Install Rails A11y: creates initializer and configuration file"
-      
-      def create_initializer
-        template 'initializer.rb.erb', 'config/initializers/rails_a11y.rb'
-      end
-      
-      def create_config_file
-        template 'accessibility.yml.erb', 'config/accessibility.yml'
-      end
-      
-      def add_to_rails_helper
-        rails_helper_path = 'spec/rails_helper.rb'
-        
-        if File.exist?(rails_helper_path)
-          inject_into_file rails_helper_path,
-            after: "require 'rspec/rails'\n" do
-            "require 'rails_accessibility_testing'\n"
-          end
-        else
-          say "⚠️  spec/rails_helper.rb not found. Please add: require 'rails_accessibility_testing'", :yellow
-        end
-      end
-      
-      def show_instructions
-        say "\n✅ Rails Accessibility Testing installed successfully!", :green
-        say "\nNext steps:", :yellow
-        say "  1. Run your system specs: bundle exec rspec spec/system/"
-        say "  2. Accessibility checks will run automatically"
-        say "  3. Configure checks in config/accessibility.yml"
-        say "\nFor more information, see: https://github.com/rayraycodes/rails-accessibility-testing"
-      end
-    end
-  end
-end
-

data/lib/rails_accessibility_testing/checks/heading_hierarchy_check.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-module RailsAccessibilityTesting
-  module Checks
-    # Checks for proper heading hierarchy
-    #
-    # WCAG 2.1 AA: 1.3.1 Info and Relationships (Level A)
-    #
-    # @api private
-    class HeadingHierarchyCheck < BaseCheck
-      def self.rule_name
-        :heading_hierarchy
-      end
-      
-      def check
-        violations = []
-        headings = page.all('h1, h2, h3, h4, h5, h6', visible: true)
-        
-        if headings.empty?
-          return violations  # Warning only, not error
-        end
-        
-        h1_count = headings.count { |h| h.tag_name == 'h1' }
-        if h1_count == 0
-          violations << violation(
-            message: "Page missing H1 heading",
-            element_context: { tag: 'page', text: 'Page has no H1 heading' },
-            wcag_reference: "1.3.1",
-            remediation: "Add an <h1> heading to your page:\n\n<h1>Main Page Title</h1>"
-          )
-        end
-        
-        previous_level = 0
-        headings.each do |heading|
-          current_level = heading.tag_name[1].to_i
-          if current_level > previous_level + 1
-            element_ctx = element_context(heading)
-            violations << violation(
-              message: "Heading hierarchy skipped (h#{previous_level} to h#{current_level})",
-              element_context: element_ctx,
-              wcag_reference: "1.3.1",
-              remediation: "Fix the heading hierarchy. Don't skip levels."
-            )
-          end
-          previous_level = current_level
-        end
-        
-        violations
-      end
-    end
-  end
-end
-