rails_accessibility_testing 1.1.0

data/lib/rails_accessibility_testing.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+# Rails Accessibility Testing Gem
+#
+# Automatically configures accessibility testing for Rails system specs with
+# comprehensive checks and detailed error messages.
+#
+# @version 1.1.0
+# @author Regan Maharjan
+#
+# @example Basic usage
+#   # In spec/rails_helper.rb
+#   require 'rails_accessibility_testing'
+#
+#   # That's it! Comprehensive accessibility checks run automatically
+#   # after each system spec that visits a page
+#
+# @example Manual checks in specs
+#   it 'has no accessibility issues' do
+#     visit root_path
+#     check_comprehensive_accessibility  # All 11 checks
+#   end
+#
+# @example Skip checks for specific tests
+#   it 'does something', skip_a11y: true do
+#     # This test won't run accessibility checks
+#   end
+#
+# @see RailsAccessibilityTesting::AccessibilityHelper
+# @see RailsAccessibilityTesting::ErrorMessageBuilder
+# @see RailsAccessibilityTesting::RSpecIntegration
+
+require 'axe-capybara'
+require 'axe/matchers/be_axe_clean'
+
+# Load version
+begin
+  require_relative 'rails_accessibility_testing/version'
+rescue LoadError
+  module RailsAccessibilityTesting
+    VERSION = '1.1.0'
+  end
+end
+
+# Load core components
+require_relative 'rails_accessibility_testing/configuration'
+require_relative 'rails_accessibility_testing/change_detector'
+require_relative 'rails_accessibility_testing/error_message_builder'
+require_relative 'rails_accessibility_testing/accessibility_helper'
+require_relative 'rails_accessibility_testing/shared_examples'
+require_relative 'rails_accessibility_testing/rspec_integration'
+
+# Load engine components
+require_relative 'rails_accessibility_testing/engine/violation'
+require_relative 'rails_accessibility_testing/engine/violation_collector'
+require_relative 'rails_accessibility_testing/engine/rule_engine'
+
+# Load check definitions
+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/keyboard_accessibility_check'
+require_relative 'rails_accessibility_testing/checks/aria_landmarks_check'
+require_relative 'rails_accessibility_testing/checks/form_errors_check'
+require_relative 'rails_accessibility_testing/checks/table_structure_check'
+require_relative 'rails_accessibility_testing/checks/duplicate_ids_check'
+require_relative 'rails_accessibility_testing/checks/skip_links_check'
+require_relative 'rails_accessibility_testing/checks/color_contrast_check'
+
+# Load configuration
+require_relative 'rails_accessibility_testing/config/yaml_loader'
+
+# Load integrations
+require_relative 'rails_accessibility_testing/integration/minitest_integration'
+
+# Auto-configure when RSpec is available
+if defined?(RSpec)
+  RSpec.configure do |config|
+    RailsAccessibilityTesting::RSpecIntegration.configure!(config)
+  end
+end

data/lib/tasks/accessibility.rake

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+namespace :a11y do
+  desc "Run all accessibility tests"
+  task :test do
+    sh "bundle exec rspec spec/system/ --tag accessibility"
+  end
+
+  desc "Run accessibility tests in watch mode"
+  task :watch do
+    sh "bundle exec rspec spec/system/ --tag accessibility --watch"
+  end
+
+  desc "Run all system tests (includes accessibility)"
+  task :system do
+    sh "bundle exec rspec spec/system/"
+  end
+
+  desc "Run accessibility tests for a specific file"
+  task :file, [:file] do |t, args|
+    file = args[:file] || "spec/system/rte_loaded_spec.rb"
+    sh "bundle exec rspec #{file}"
+  end
+end
+
+desc "Run accessibility tests (alias for a11y:test)"
+task a11y: "a11y:test"
+

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: rails_accessibility_testing
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Regan Maharjan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2025-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: axe-core-capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Comprehensive, opinionated but configurable accessibility testing gem
+  for Rails. Integrates seamlessly into your test suite with RSpec and Minitest support.
+  Includes CLI tool, Rails generator, YAML configuration, and 11+ WCAG 2.1 AA aligned
+  checks with actionable error messages.
+email:
+- imregan@umich.edu
+executables:
+- rails_a11y
+- rails_server_safe
+extensions: []
+extra_rdoc_files: []
+files:
+- ARCHITECTURE.md
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- GUIDES/continuous_integration.md
+- GUIDES/getting_started.md
+- GUIDES/working_with_designers_and_content_authors.md
+- GUIDES/writing_accessible_views_in_rails.md
+- LICENSE
+- README.md
+- docs_site/404.html
+- docs_site/Gemfile
+- docs_site/Makefile
+- docs_site/_config.yml
+- docs_site/_includes/header.html
+- docs_site/_layouts/default.html
+- docs_site/assets/main.scss
+- docs_site/ci_integration.md
+- docs_site/configuration.md
+- docs_site/contributing.md
+- docs_site/getting_started.md
+- docs_site/index.md
+- exe/rails_a11y
+- exe/rails_server_safe
+- lib/generators/rails_a11y/install/generator.rb
+- lib/rails_accessibility_testing.rb
+- lib/rails_accessibility_testing/accessibility_helper.rb
+- lib/rails_accessibility_testing/change_detector.rb
+- lib/rails_accessibility_testing/checks/aria_landmarks_check.rb
+- lib/rails_accessibility_testing/checks/base_check.rb
+- lib/rails_accessibility_testing/checks/color_contrast_check.rb
+- 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/image_alt_text_check.rb
+- lib/rails_accessibility_testing/checks/interactive_elements_check.rb
+- lib/rails_accessibility_testing/checks/keyboard_accessibility_check.rb
+- lib/rails_accessibility_testing/checks/skip_links_check.rb
+- lib/rails_accessibility_testing/checks/table_structure_check.rb
+- lib/rails_accessibility_testing/cli/command.rb
+- lib/rails_accessibility_testing/config/yaml_loader.rb
+- lib/rails_accessibility_testing/configuration.rb
+- 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/error_message_builder.rb
+- lib/rails_accessibility_testing/integration/minitest_integration.rb
+- lib/rails_accessibility_testing/rspec_integration.rb
+- lib/rails_accessibility_testing/shared_examples.rb
+- lib/rails_accessibility_testing/version.rb
+- lib/tasks/accessibility.rake
+homepage: https://github.com/rayraycodes/rails_accessibility_testing
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rayraycodes/rails_accessibility_testing
+  source_code_uri: https://github.com/rayraycodes/rails_accessibility_testing
+  changelog_uri: https://github.com/rayraycodes/rails_accessibility_testing/blob/main/CHANGELOG.md
+  documentation_uri: https://rayraycodes.github.io/rails-accessibility-testing/
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: The RSpec + RuboCop of accessibility for Rails. Catch WCAG violations before
+  they reach production.
+test_files: []