rails_accessibility_testing 1.5.3 → 1.5.5

data/lib/rails_accessibility_testing/static_scanning.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# Static scanning module - provides file-based accessibility scanning
+# This module aggregates all static scanning components for easy access
+#
+# @api public
+module RailsAccessibilityTesting
+  # Static scanning components
+  # All components work together to scan view files without browser rendering
+  #
+  # Components:
+  # - StaticFileScanner: Main scanner that orchestrates the scanning process
+  # - ErbExtractor: Converts ERB templates to HTML for analysis
+  # - StaticPageAdapter: Makes Nokogiri documents look like Capybara pages
+  # - LineNumberFinder: Finds line numbers for reported issues
+  # - ViolationConverter: Converts violations to error/warning format
+  #
+  # All 11 accessibility checks are automatically used via RuleEngine:
+  # 1. FormLabelsCheck
+  # 2. ImageAltTextCheck
+  # 3. InteractiveElementsCheck
+  # 4. HeadingCheck
+  # 5. KeyboardAccessibilityCheck
+  # 6. AriaLandmarksCheck
+  # 7. FormErrorsCheck
+  # 8. TableStructureCheck
+  # 9. DuplicateIdsCheck
+  # 10. SkipLinksCheck
+  # 11. ColorContrastCheck
+  #
+  # @example Scanning a view file
+  #   scanner = StaticFileScanner.new('app/views/pages/home.html.erb')
+  #   result = scanner.scan
+  #   # => { errors: [...], warnings: [...] }
+  #
+  module StaticScanning
+    # Convenience method to scan a single file
+    # @param file_path [String] Path to view file
+    # @return [Hash] Hash with :errors and :warnings arrays
+    def self.scan_file(file_path)
+      StaticFileScanner.new(file_path).scan
+    end
+
+    # Convenience method to scan multiple files
+    # @param file_paths [Array<String>] Array of file paths
+    # @return [Hash] Hash with :errors and :warnings arrays (aggregated)
+    def self.scan_files(file_paths)
+      all_errors = []
+      all_warnings = []
+
+      file_paths.each do |file_path|
+        result = scan_file(file_path)
+        all_errors.concat(result[:errors] || [])
+        all_warnings.concat(result[:warnings] || [])
+      end
+
+      { errors: all_errors, warnings: all_warnings }
+    end
+  end
+end
+

data/lib/rails_accessibility_testing/version.rb

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

data/lib/rails_accessibility_testing/violation_converter.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module RailsAccessibilityTesting
+  # Converts Violation objects to error/warning hash format
+  # Used by static file scanner to format results
+  #
+  # @api private
+  class ViolationConverter
+    # Convert violations to errors/warnings format
+    # @param violations [Array<Engine::Violation>] Array of violations
+    # @param view_file [String] Path to the view file
+    # @param line_number_finder [LineNumberFinder] Finder for line numbers
+    # @param config [Hash] Optional configuration hash (for ignore_warnings flag)
+    # @return [Hash] Hash with :errors and :warnings arrays
+    def self.convert(violations, view_file:, line_number_finder:, config: {})
+      new(violations, view_file: view_file, line_number_finder: line_number_finder, config: config).convert
+    end
+
+    def initialize(violations, view_file:, line_number_finder:, config: {})
+      @violations = violations
+      @view_file = view_file
+      @line_number_finder = line_number_finder
+      @config = config
+    end
+
+    def convert
+      errors = []
+      warnings = []
+
+      @violations.each do |violation|
+        # Skip warnings if ignore_warnings is enabled
+        if warning?(violation) && ignore_warnings?
+          next
+        end
+
+        element_context = violation.element_context || {}
+        line_num = @line_number_finder.find_line_number(element_context)
+
+        error_data = {
+          type: violation.message,
+          element: element_context,
+          file: @view_file,
+          line: line_num,
+          wcag: violation.wcag_reference
+        }
+
+        if warning?(violation)
+          warnings << error_data
+        else
+          errors << error_data
+        end
+      end
+
+      { errors: errors, warnings: warnings }
+    end
+
+    private
+
+    # Check if warnings should be ignored
+    def ignore_warnings?
+      summary_config = @config['summary'] || {}
+      summary_config.fetch('ignore_warnings', false)
+    end
+
+    # Determine if a violation should be a warning instead of an error
+    def warning?(violation)
+      message = violation.message
+      rule_name = violation.rule_name
+
+      # Skip links are warnings (best practice, not required)
+      return true if message.include?('skip link') || message.include?('Skip link')
+
+      # ARIA landmarks are warnings (best practice, not always required)
+      return true if rule_name == 'aria_landmarks'
+
+      false
+    end
+  end
+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.5.0
+# @version 1.5.5
 # @author Regan Maharjan
 #
 # @example Basic usage
@@ -45,8 +45,16 @@ end
 # Load core components
 require_relative 'rails_accessibility_testing/configuration'
 require_relative 'rails_accessibility_testing/change_detector'
+require_relative 'rails_accessibility_testing/file_change_tracker'
 require_relative 'rails_accessibility_testing/error_message_builder'
 require_relative 'rails_accessibility_testing/accessibility_helper'
+# Static scanning components (modular and reusable)
+require_relative 'rails_accessibility_testing/static_page_adapter'
+require_relative 'rails_accessibility_testing/erb_extractor'
+require_relative 'rails_accessibility_testing/line_number_finder'
+require_relative 'rails_accessibility_testing/violation_converter'
+require_relative 'rails_accessibility_testing/static_file_scanner'
+require_relative 'rails_accessibility_testing/static_scanning'
 # Only load RSpec-specific components when RSpec is available
 if defined?(RSpec)
   require_relative 'rails_accessibility_testing/shared_examples'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_accessibility_testing
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 1.5.5
 platform: ruby
 authors:
 - Regan Maharjan
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -75,7 +89,7 @@ email:
 executables:
 - rails_a11y
 - rails_server_safe
-- a11y_live_scanner
+- a11y_static_scanner
 extensions: []
 extra_rdoc_files: []
 files:
@@ -92,10 +106,12 @@ files:
 - README.md
 - docs_site/404.html
 - docs_site/Gemfile
+- docs_site/Gemfile.lock
 - docs_site/Makefile
 - docs_site/_config.yml
 - docs_site/_includes/header.html
 - docs_site/_layouts/default.html
+- docs_site/architecture.md
 - docs_site/assets/main.scss
 - docs_site/ci_integration.md
 - docs_site/configuration.md
@@ -103,6 +119,7 @@ files:
 - docs_site/getting_started.md
 - docs_site/index.md
 - exe/a11y_live_scanner
+- exe/a11y_static_scanner
 - exe/rails_a11y
 - exe/rails_server_safe
 - lib/generators/rails_a11y/install/install_generator.rb
@@ -130,13 +147,20 @@ files:
 - lib/rails_accessibility_testing/engine/rule_engine.rb
 - lib/rails_accessibility_testing/engine/violation.rb
 - lib/rails_accessibility_testing/engine/violation_collector.rb
+- lib/rails_accessibility_testing/erb_extractor.rb
 - lib/rails_accessibility_testing/error_message_builder.rb
+- lib/rails_accessibility_testing/file_change_tracker.rb
 - lib/rails_accessibility_testing/integration/minitest_integration.rb
+- lib/rails_accessibility_testing/line_number_finder.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/static_file_scanner.rb
+- lib/rails_accessibility_testing/static_page_adapter.rb
+- lib/rails_accessibility_testing/static_scanning.rb
 - lib/rails_accessibility_testing/version.rb
+- lib/rails_accessibility_testing/violation_converter.rb
 - lib/tasks/accessibility.rake
 homepage: https://rayraycodes.github.io/rails-accessibility-testing/
 licenses: