Migration vers axe DevTools for Web v4.x pour Ruby
Étapes de la migration vers la version 4.x d'axe DevTools for Web pour Ruby
Axe DevTools pour les gemmes Web v4.x est une réécriture majeure de l'ensemble du projet. Les changements les plus notables sont résumés ci-dessous, suivis de modifications plus spécifiques apportées aux packages concernés.
Résumé
La suite de gems axe-devtools-*
a été réarchitecturée pour alléger les outils d'intégration fournis et offrir une meilleure expérience aux développeurs.
Par rapport aux versions précédentes où un seul gem était fourni, cette version fournit une collection de gems permettant aux utilisateurs finaux de choisir ce qui est essentiel et qui correspond le mieux à leur flux de travail actuel.
Étapes de la migration
Étant donné la séparation d'une structure de gem monolithique en gems individuelles, certaines étapes de migration sont nécessaires. Vous pouvez utiliser le guide de migration suivant.
Configuration du développeur
Il n’y a aucun changement par rapport à la configuration précédente du développeur. Les exigences nécessaires sont les suivantes :
- [Ruby][] (la dernière version)
- [Bundler][] pour les dépendances de gemmes Ruby
- [Rake][] en tant qu'exécuteur de tâches
- [RSpec][] ou [Cucumber][] pour les tests
- [Node][] et [Npm][] pour installer le package [axe-core][]
Installation d'axe DevTools pour Web Gems
Assurez-vous d'avoir accès au [registre de Deque][configuration du registre npm]. Dans le cas contraire, [reportez-vous au guide d’installation][].
Après avoir accès au registre de Deque, vous pouvez installer l'un des gems suivants en les incluant dans les fichiers Gemfile ou gemspec.
gem "axe-devtools-cucumber"
Alternativement, vous pouvez spécifier une source pour la gem :
gem "attest-devtools-cucumber", :source => 'https://agora.dequecloud.com/artifactory/api/gems/devtools-gems'
Les gems disponibles sont :
- [axe DevTools pour Web Cucumber][]
- [axe DevTools pour Web RSpec][]
- [axe DevTools pour Web Capybara][]
- [axe DevTools pour Web Selenium][]
- [axe DevTools pour Web Watir][]
Veuillez vous référer à la documentation pour les instructions d'utilisation et les informations détaillées sur les API.
Désinstallation des intégrations Ruby
Vous pouvez désinstaller les intégrations Ruby précédentes en exécutant les commandes ci-dessous :
gem uninstall axe-matchers
gem uninstall attest-ruby
Changements notables
D'autres changements notables apportés à l'intégration de Ruby incluent :
- La variable d'environnement pour la configuration des règles personnalisées a été modifiée de
ATTEST_PATH
àAXE_RULESET_PATH
. Reportez-vous à [utilisation avancée][]. - Les règles par défaut ont changé. Axe DevTools for Web audite une page donnée avec « wcag2 » comme ensemble de règles par défaut. Aucune modification n’est requise de la part de l’utilisateur final. Si vous souhaitez configurer un ensemble de règles différent, vous pouvez utiliser les clauses respectives proposées dans la documentation Cucumber ou la documentation RSpec.
- Les Matchers
be_accessible
dans RSpec ont été renommés enbe_axe_clean
. - La
be accessible
définition d'étape dans RSpec a été renommée enbe axe clean
.
[ruby] : https://www.ruby-lang.org/en/ [bundler] : https://bundler.io/ [rake] : https://github.com/ruby/rake [rspec] : https://rspec.info/ [cucumber] : https://cucumber.io/ [node] : https://nodejs.org/ [npm] : https://www.npmjs.com/ [axe-core] : https://github.com/dequelabs/axe-core [registre de Deque] : https://dequeuniversity.com/guide/attest/2.11/getting-started/npm-setup/ [attest npm registry setup] : https://dequeuniversity.com/guide/attest/2.11/getting-started/npm-setup/ [se référer au guide d'installation] : rb-access-setup#required-access--setup [axe DevTools for Web Cucumber] : rb-cucumber [axe DevTools pour Web rspec] : rb-rspec [axe DevTools pour Web capybara] : rb-capybara [axe DevTools for Web selenium] : rb-selenium [axe DevTools pour Web watir] : rb-watir [utilisation avancée] : rb-advanced-usage