rails_accessibility_testing 1.4.1 β 1.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +14 -0
- data/GUIDES/getting_started.md +26 -1
- data/README.md +15 -3
- data/docs_site/getting_started.md +51 -3
- data/docs_site/index.md +7 -1
- data/lib/rails_accessibility_testing/version.rb +1 -1
- data/lib/rails_accessibility_testing.rb +2 -2
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 7a60633c05618ff8bc3fa720655c2a954675aa9a7ab5fdc3b515f18f937481ec
|
|
4
|
+
data.tar.gz: e15e7a3238221d4ae21ed60bf451818fbc94bca45ea6af4c0f9675309125ab63
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ff0b0cfc0c3f51b2bf022ffa97bfeab3c50da7cd0c3afb024d0ab8043f9cf599df8bb76f6cf8d3c97127a352e7050b5309819eac6b91030c5ea73a2e5d01c6ac
|
|
7
|
+
data.tar.gz: 9debe7aa2879d009108cbb801e158fc12e8c12e592f69c76e2a603c3fd8db4ad72b8e322d15e5d0987dbcb4e6b4f146e24edb5bd3cc1c4b241a5f0659e548cfb
|
data/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,19 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [1.4.2] - 2025-11-18
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
- Procfile.dev documentation for continuous accessibility checking during development
|
|
12
|
+
- Instructions for running accessibility checks automatically every 30 seconds via `bin/dev`
|
|
13
|
+
- Updated getting started guides with Procfile setup examples
|
|
14
|
+
- Enhanced README with continuous testing workflow documentation
|
|
15
|
+
|
|
16
|
+
### Improved
|
|
17
|
+
- Better developer experience with continuous accessibility feedback during development
|
|
18
|
+
- Clearer documentation on multiple ways to run accessibility checks (manual vs continuous)
|
|
19
|
+
- Improved onboarding with step-by-step Procfile setup instructions
|
|
20
|
+
|
|
8
21
|
## [1.4.1] - 2025-11-18
|
|
9
22
|
|
|
10
23
|
### Changed
|
|
@@ -155,6 +168,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
155
168
|
- Compatible with RSpec Rails 6.0+
|
|
156
169
|
- Modular architecture with rule engine and check definitions
|
|
157
170
|
|
|
171
|
+
[1.4.2]: https://github.com/rayraycodes/rails-accessibility-testing/releases/tag/v1.4.2
|
|
158
172
|
[1.4.1]: https://github.com/rayraycodes/rails-accessibility-testing/releases/tag/v1.4.1
|
|
159
173
|
[1.4.0]: https://github.com/rayraycodes/rails-accessibility-testing/releases/tag/v1.4.0
|
|
160
174
|
[1.3.0]: https://github.com/rayraycodes/rails-accessibility-testing/releases/tag/v1.3.0
|
data/GUIDES/getting_started.md
CHANGED
|
@@ -40,7 +40,9 @@ This creates:
|
|
|
40
40
|
|
|
41
41
|
### Step 3: Run Your Tests
|
|
42
42
|
|
|
43
|
-
|
|
43
|
+
You can run accessibility checks in several ways:
|
|
44
|
+
|
|
45
|
+
#### Option A: Run Tests Manually
|
|
44
46
|
|
|
45
47
|
```bash
|
|
46
48
|
bundle exec rspec spec/system/
|
|
@@ -48,6 +50,29 @@ bundle exec rspec spec/system/
|
|
|
48
50
|
|
|
49
51
|
Accessibility checks run automatically on every system test that visits a page.
|
|
50
52
|
|
|
53
|
+
#### Option B: Run Continuously with Procfile (Recommended for Development)
|
|
54
|
+
|
|
55
|
+
For continuous accessibility checking during development, add to your `Procfile.dev`:
|
|
56
|
+
|
|
57
|
+
```procfile
|
|
58
|
+
web: bin/rails server
|
|
59
|
+
css: bin/rails dartsass:watch
|
|
60
|
+
a11y: while true; do bundle exec rspec spec/system/*_accessibility_spec.rb; sleep 30; done
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
Then run:
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
bin/dev
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
This will:
|
|
70
|
+
- Start your Rails server
|
|
71
|
+
- Watch for CSS changes
|
|
72
|
+
- **Automatically run accessibility checks every 30 seconds** on all `*_accessibility_spec.rb` files
|
|
73
|
+
|
|
74
|
+
The accessibility checker will continuously monitor your pages and alert you to any issues as you develop!
|
|
75
|
+
|
|
51
76
|
## Your First Accessibility Check
|
|
52
77
|
|
|
53
78
|
Let's see it in action. Create a simple system spec:
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
|
|
8
8
|
**The RSpec + RuboCop of accessibility for Rails. Catch WCAG violations before they reach production.**
|
|
9
9
|
|
|
10
|
-
**Current Version:** 1.4.
|
|
10
|
+
**Current Version:** 1.4.2
|
|
11
11
|
|
|
12
12
|
π **[π Full Documentation](https://rayraycodes.github.io/rails-accessibility-testing/)** | [π» GitHub](https://github.com/rayraycodes/rails-accessibility-testing) | [π RubyGems](https://rubygems.org/gems/rails_accessibility_testing)
|
|
13
13
|
|
|
@@ -108,12 +108,24 @@ end
|
|
|
108
108
|
|
|
109
109
|
**Accessibility checks run automatically after each `visit` in system specs!**
|
|
110
110
|
|
|
111
|
-
|
|
111
|
+
#### Continuous Testing with Procfile (Recommended for Development)
|
|
112
112
|
|
|
113
|
-
|
|
113
|
+
For continuous accessibility checking during development, add to your `Procfile.dev`:
|
|
114
|
+
|
|
115
|
+
```procfile
|
|
116
|
+
web: bin/rails server
|
|
117
|
+
css: bin/rails dartsass:watch
|
|
114
118
|
a11y: while true; do bundle exec rspec spec/system/*_accessibility_spec.rb; sleep 30; done
|
|
115
119
|
```
|
|
116
120
|
|
|
121
|
+
Then run:
|
|
122
|
+
|
|
123
|
+
```bash
|
|
124
|
+
bin/dev
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
This will automatically run accessibility checks every 30 seconds on all `*_accessibility_spec.rb` files, giving you continuous feedback as you develop!
|
|
128
|
+
|
|
117
129
|
π **[See the full System Specs Guide](GUIDES/system_specs_for_accessibility.md)** for detailed examples and best practices.
|
|
118
130
|
|
|
119
131
|
### Automatic Checks
|
|
@@ -43,9 +43,31 @@ This creates:
|
|
|
43
43
|
- `config/accessibility.yml` - Check settings
|
|
44
44
|
- Updates `spec/rails_helper.rb` (if using RSpec)
|
|
45
45
|
|
|
46
|
-
### Step 3:
|
|
46
|
+
### Step 3: Create System Specs (Recommended)
|
|
47
47
|
|
|
48
|
-
|
|
48
|
+
Create system specs for the pages you want to test. This is the **recommended and most reliable** approach:
|
|
49
|
+
|
|
50
|
+
```ruby
|
|
51
|
+
# spec/system/home_page_accessibility_spec.rb
|
|
52
|
+
require 'rails_helper'
|
|
53
|
+
|
|
54
|
+
RSpec.describe 'Home Page Accessibility', type: :system do
|
|
55
|
+
it 'loads the page and runs comprehensive accessibility checks' do
|
|
56
|
+
visit root_path
|
|
57
|
+
|
|
58
|
+
# Run comprehensive accessibility checks
|
|
59
|
+
# This will fail the test if any accessibility issues are found
|
|
60
|
+
check_comprehensive_accessibility
|
|
61
|
+
# β
If all checks pass, you'll see: "All comprehensive accessibility checks passed! (11 checks)"
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### Step 4: Run Your Tests
|
|
67
|
+
|
|
68
|
+
You can run accessibility checks in several ways:
|
|
69
|
+
|
|
70
|
+
#### Option A: Run Tests Manually
|
|
49
71
|
|
|
50
72
|
```bash
|
|
51
73
|
bundle exec rspec spec/system/
|
|
@@ -53,5 +75,31 @@ bundle exec rspec spec/system/
|
|
|
53
75
|
|
|
54
76
|
Accessibility checks run automatically on every system test that visits a page.
|
|
55
77
|
|
|
56
|
-
|
|
78
|
+
#### Option B: Run Continuously with Procfile (Recommended for Development)
|
|
79
|
+
|
|
80
|
+
For continuous accessibility checking during development, add to your `Procfile.dev`:
|
|
81
|
+
|
|
82
|
+
```procfile
|
|
83
|
+
web: bin/rails server
|
|
84
|
+
css: bin/rails dartsass:watch
|
|
85
|
+
a11y: while true; do bundle exec rspec spec/system/*_accessibility_spec.rb; sleep 30; done
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
Then run:
|
|
89
|
+
|
|
90
|
+
```bash
|
|
91
|
+
bin/dev
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
This will:
|
|
95
|
+
- Start your Rails server
|
|
96
|
+
- Watch for CSS changes
|
|
97
|
+
- **Automatically run accessibility checks every 30 seconds** on all `*_accessibility_spec.rb` files
|
|
98
|
+
|
|
99
|
+
The accessibility checker will continuously monitor your pages and alert you to any issues as you develop!
|
|
100
|
+
|
|
101
|
+
## Learn More
|
|
102
|
+
|
|
103
|
+
- **[System Specs Guide](https://github.com/rayraycodes/rails-accessibility-testing/blob/main/GUIDES/system_specs_for_accessibility.md)** - β Recommended approach for reliable accessibility testing
|
|
104
|
+
- **[Complete Getting Started Guide](https://github.com/rayraycodes/rails-accessibility-testing/blob/main/GUIDES/getting_started.md)** - Detailed setup instructions
|
|
57
105
|
|
data/docs_site/index.md
CHANGED
|
@@ -7,7 +7,7 @@ title: Home
|
|
|
7
7
|
|
|
8
8
|
**The RSpec + RuboCop of accessibility for Rails. Catch WCAG violations before they reach production.**
|
|
9
9
|
|
|
10
|
-
**Version:** 1.
|
|
10
|
+
**Version:** 1.4.2
|
|
11
11
|
|
|
12
12
|
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.
|
|
13
13
|
|
|
@@ -48,6 +48,12 @@ bundle exec rspec spec/system/
|
|
|
48
48
|
- [CI Integration]({{ '/ci_integration.html' | relative_url }}) - CI/CD setup
|
|
49
49
|
- [Contributing]({{ '/contributing.html' | relative_url }}) - How to contribute
|
|
50
50
|
|
|
51
|
+
## Additional Guides
|
|
52
|
+
|
|
53
|
+
- [System Specs for Accessibility](https://github.com/rayraycodes/rails-accessibility-testing/blob/main/GUIDES/system_specs_for_accessibility.md) - β Recommended approach
|
|
54
|
+
- [Writing Accessible Views](https://github.com/rayraycodes/rails-accessibility-testing/blob/main/GUIDES/writing_accessible_views_in_rails.md) - Best practices
|
|
55
|
+
- [Working with Designers](https://github.com/rayraycodes/rails-accessibility-testing/blob/main/GUIDES/working_with_designers_and_content_authors.md) - Team collaboration
|
|
56
|
+
|
|
51
57
|
## Links
|
|
52
58
|
|
|
53
59
|
- [GitHub Repository](https://github.com/rayraycodes/rails-accessibility-testing)
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
# Automatically configures accessibility testing for Rails system specs with
|
|
6
6
|
# comprehensive checks and detailed error messages.
|
|
7
7
|
#
|
|
8
|
-
# @version 1.4.
|
|
8
|
+
# @version 1.4.2
|
|
9
9
|
# @author Regan Maharjan
|
|
10
10
|
#
|
|
11
11
|
# @example Basic usage
|
|
@@ -38,7 +38,7 @@ begin
|
|
|
38
38
|
require_relative 'rails_accessibility_testing/version'
|
|
39
39
|
rescue LoadError
|
|
40
40
|
module RailsAccessibilityTesting
|
|
41
|
-
VERSION = '1.4.
|
|
41
|
+
VERSION = '1.4.2'
|
|
42
42
|
end
|
|
43
43
|
end
|
|
44
44
|
|