rails_accessibility_testing 1.1.0

data/docs_site/configuration.md

@@ -0,0 +1,114 @@
+---
+layout: default
+title: Configuration
+---
+
+# Configuration
+
+Rails Accessibility Testing works out of the box with zero configuration, but you can customize it to fit your needs.
+
+## YAML Configuration
+
+Create `config/accessibility.yml` in your Rails app:
+
+```yaml
+# WCAG compliance level (A, AA, AAA)
+wcag_level: AA
+
+# Global check configuration
+checks:
+  form_labels: true
+  image_alt_text: true
+  interactive_elements: true
+  heading_hierarchy: true
+  keyboard_accessibility: true
+  aria_landmarks: true
+  form_errors: true
+  table_structure: true
+  duplicate_ids: true
+  skip_links: true
+  color_contrast: false  # Disabled by default (expensive)
+
+# Profile-specific configurations
+development:
+  checks:
+    color_contrast: false  # Skip in dev for speed
+
+test:
+  checks:
+    # Test environment uses global settings by default
+
+ci:
+  checks:
+    color_contrast: true   # Full checks in CI
+
+# Ignored rules with reasons
+ignored_rules:
+  # - rule: form_labels
+  #   reason: "Legacy form, scheduled for refactor in Q2"
+  #   comment: "Will be fixed in PR #123"
+```
+
+## Ruby Configuration
+
+Edit `config/initializers/rails_a11y.rb`:
+
+```ruby
+RailsAccessibilityTesting.configure do |config|
+  # Automatically run checks after system specs
+  config.auto_run_checks = true
+  
+  # Logger for accessibility check output
+  config.logger = Rails.logger
+  
+  # Configuration file path (relative to Rails.root)
+  config.config_path = 'config/accessibility.yml'
+  
+  # Default profile to use (development, test, ci)
+  config.default_profile = :test
+end
+```
+
+## Profiles
+
+Use different configurations for different environments:
+
+- **development**: Faster checks, skip expensive operations
+- **test**: Default settings, balanced checks
+- **ci**: Full checks, strict validation
+
+Set the profile via environment variable:
+
+```bash
+RAILS_A11Y_PROFILE=ci bundle exec rspec spec/system/
+```
+
+## Ignoring Rules
+
+Temporarily ignore specific rules while fixing issues:
+
+```yaml
+ignored_rules:
+  - rule: form_labels
+    reason: "Legacy form, scheduled for refactor in Q2"
+    comment: "Will be fixed in PR #123"
+```
+
+**Important:** Always include a reason and plan to fix. This is for temporary exceptions, not permanent workarounds.
+
+## Skipping Checks in Tests
+
+Skip accessibility checks for specific tests:
+
+```ruby
+# RSpec
+it "does something", skip_a11y: true do
+  # Accessibility checks won't run
+end
+
+# Minitest
+test "does something", skip_a11y: true do
+  # Accessibility checks won't run
+end
+```
+

data/docs_site/contributing.md

@@ -0,0 +1,69 @@
+---
+layout: default
+title: Contributing
+---
+
+# Contributing to Rails Accessibility Testing
+
+Thank you for your interest in contributing to Rails Accessibility Testing! This document provides guidelines and instructions for contributing.
+
+## Getting Started
+
+### Prerequisites
+
+- Ruby 3.0+ installed
+- Bundler installed
+- Git installed
+- A GitHub account
+
+### Setting Up Development Environment
+
+1. **Fork the repository**
+2. **Clone your fork**
+   ```bash
+   git clone https://github.com/your-username/rails-accessibility-testing.git
+   cd rails-accessibility-testing
+   ```
+
+3. **Install dependencies**
+   ```bash
+   bundle install
+   ```
+
+4. **Run tests**
+   ```bash
+   bundle exec rspec
+   ```
+
+## Making Changes
+
+1. **Create a branch**
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+2. **Make your changes**
+   - Write code
+   - Add tests
+   - Update documentation
+
+3. **Test your changes**
+   ```bash
+   bundle exec rspec
+   ```
+
+4. **Commit your changes**
+   ```bash
+   git add .
+   git commit -m "Add: descriptive commit message"
+   ```
+
+5. **Push to your fork**
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+
+6. **Open a Pull Request**
+
+For complete contributing guidelines, see [CONTRIBUTING.md](https://github.com/rayraycodes/rails-accessibility-testing/blob/main/CONTRIBUTING.md) in the main repository.
+

data/docs_site/getting_started.md

@@ -0,0 +1,57 @@
+---
+layout: default
+title: Getting Started
+---
+
+# Getting Started with Rails Accessibility Testing
+
+Welcome to Rails Accessibility Testing! This guide will help you get up and running with accessibility testing in your Rails application in just a few minutes.
+
+## What is Rails Accessibility Testing?
+
+Rails Accessibility Testing is an accessibility testing gem that automatically checks your Rails views for WCAG 2.1 AA compliance. Think of it as RSpec + RuboCop for accessibility—it catches violations as you code, not after deployment.
+
+## Quick Start (5 Minutes)
+
+### Step 1: Install the Gem
+
+Add to your `Gemfile`:
+
+```ruby
+group :development, :test do
+  gem 'rails_accessibility_testing'
+  gem 'axe-core-capybara', '~> 4.0'
+end
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+### Step 2: Run the Generator
+
+```bash
+rails generate rails_a11y:install
+```
+
+**Note:** The generator uses the short name `rails_a11y` for convenience. The gem name is `rails_accessibility_testing`.
+
+This creates:
+- `config/initializers/rails_a11y.rb` - Configuration
+- `config/accessibility.yml` - Check settings
+- Updates `spec/rails_helper.rb` (if using RSpec)
+
+### Step 3: Run Your Tests
+
+That's it! Just run your system specs:
+
+```bash
+bundle exec rspec spec/system/
+```
+
+Accessibility checks run automatically on every system test that visits a page.
+
+For complete documentation, see the [Getting Started guide](https://github.com/rayraycodes/rails-accessibility-testing/blob/main/GUIDES/getting_started.md) in the main repository.
+

data/docs_site/index.md

@@ -0,0 +1,57 @@
+---
+layout: default
+title: Home
+---
+
+# Rails Accessibility Testing
+
+**The RSpec + RuboCop of accessibility for Rails. Catch WCAG violations before they reach production.**
+
+**Version:** 1.1.0
+
+Rails Accessibility Testing is a comprehensive accessibility testing gem that makes accessibility testing as natural as unit testing. It integrates seamlessly into your Rails workflow, catching WCAG 2.1 AA violations as you code—not after deployment.
+
+## Quick Start
+
+```ruby
+# Add to Gemfile
+group :development, :test do
+  gem 'rails_accessibility_testing'
+  gem 'axe-core-capybara', '~> 4.0'
+end
+```
+
+```bash
+# Install
+bundle install
+
+# Setup
+rails generate rails_a11y:install
+
+# Run tests
+bundle exec rspec spec/system/
+```
+
+## Features
+
+- **Zero Configuration** - Works out of the box with smart defaults
+- **11+ Comprehensive Checks** - WCAG 2.1 AA aligned
+- **Actionable Error Messages** - Code examples showing how to fix issues
+- **RSpec & Minitest** - Works with both test frameworks
+- **CLI Tool** - Command-line interface for scanning URLs and routes
+- **YAML Configuration** - Profile-based configuration for different environments
+
+## Documentation
+
+- [Getting Started]({{ '/getting_started.html' | relative_url }}) - Quick start guide
+- [Configuration]({{ '/configuration.html' | relative_url }}) - Configuration options
+- [CI Integration]({{ '/ci_integration.html' | relative_url }}) - CI/CD setup
+- [Contributing]({{ '/contributing.html' | relative_url }}) - How to contribute
+
+## Links
+
+- [GitHub Repository](https://github.com/rayraycodes/rails-accessibility-testing)
+- [RubyGems](https://rubygems.org/gems/rails_accessibility_testing)
+- [Issue Tracker](https://github.com/rayraycodes/rails-accessibility-testing/issues)
+- [Changelog](https://github.com/rayraycodes/rails-accessibility-testing/blob/main/CHANGELOG.md)
+

data/exe/rails_a11y

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Load the gem
+require_relative '../lib/rails_accessibility_testing'
+
+# Load CLI command
+require_relative '../lib/rails_accessibility_testing/cli/command'
+
+# Run the CLI
+RailsAccessibilityTesting::CLI::Command.run(ARGV)
+

data/exe/rails_server_safe

@@ -0,0 +1,41 @@
+#!/usr/bin/env sh
+
+# Safe wrapper for Rails server that doesn't fail if server is already running
+# This prevents Foreman from terminating all processes when server is already up
+
+PIDFILE="${PIDFILE:-tmp/pids/server.pid}"
+PORT="${PORT:-3000}"
+
+# Check if PID file exists
+if [ -f "$PIDFILE" ]; then
+  PID=$(cat "$PIDFILE" 2>/dev/null)
+  
+  # Check if the process is actually running
+  if [ -n "$PID" ] && kill -0 "$PID" 2>/dev/null; then
+    # Check if it's listening on the expected port
+    if lsof -ti:$PORT -sTCP:LISTEN | grep -q "^$PID$" 2>/dev/null; then
+      echo "Server is already running (pid: $PID, port: $PORT)"
+      exit 0
+    else
+      # PID exists but not listening on port - stale PID file
+      echo "Removing stale PID file (pid: $PID not listening on port $PORT)"
+      rm -f "$PIDFILE"
+    fi
+  else
+    # PID file exists but process is dead - stale PID file
+    echo "Removing stale PID file (process $PID not running)"
+    rm -f "$PIDFILE"
+  fi
+fi
+
+# Check if something else is using the port
+if lsof -ti:$PORT -sTCP:LISTEN >/dev/null 2>&1; then
+  EXISTING_PID=$(lsof -ti:$PORT -sTCP:LISTEN | head -1)
+  echo "Port $PORT is already in use by process $EXISTING_PID"
+  echo "Server may already be running. Exiting gracefully."
+  exit 0
+fi
+
+# Start the server normally
+exec bin/rails server "$@"
+

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

@@ -0,0 +1,51 @@
+# 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
+