[DEPRECATED] axe-matchers
This repository has been deprecated. The package has been moved to axe-core-gems. These set of packages will be available via rubygems.org prefixed with
@axe-core-*
.
Automated accessibility testing powered by aXe.
Provides Cucumber step definitions and RSpec matchers for auditing accessibility.
Uses the aXe core javascript library for accessibility testing.
Philosophy
We believe that automated testing has an important role to play in achieving digital equality and that in order to do that, it must achieve mainstream adoption by professional web developers. That means that the tests must inspire trust, must be fast, must work everywhere and must be available everywhere.
Manifesto
- Automated accessibility testing rules must have a zero false positive rate
- Automated accessibility testing rules must be lightweight and fast
- Automated accessibility testing rules must work in all modern browsers
- Automated accessibility testing rules must, themselves, be tested automatically
Getting Started
Installation
Add this line to your application's Gemfile:
gem 'axe-matchers'
And then execute:
$ bundle install
Or install it yourself as:
$ gem install axe-matchers
Usage
Cucumber
A set of step definitions have been provided for accessibility testing through Cucumber, using WebDrivers.
Read the documentation for the Cucumber Integration.
RSpec
A set of matchers have been provided for accessibility testing through RSpec using WebDrivers.
Read the documentation for the RSpec Integration
The Accessibility Rules
axe-matchers uses axe-core@3x, which can test for accessibility inside of Shadow DOM HTML subtrees. See the axe-core repository for more information.
The complete list of rules run by axe-core can be found in doc/rule-descriptions.md.
WebDrivers
axe-matchers supports Capybara, Selenium, and Watir webdrivers; each tested with Firefox, Chrome, and Safari. Additionally, selenium-chrome-headless and capybara-webkit are supported.
Notes:
- Chrome requires ChromeDriver (tested with 2.35)
- Safari requires SafariDriver (tested with 2.48)
Contributing
Read the documentation on contributing