Migration zu axe DevTools for Web v4.x für Ruby

Axe DevTools für Web Gems v4.x ist eine grundlegende Überarbeitung des gesamten Projekts. Die wichtigsten Änderungen sind unten zusammengefasst, gefolgt von spezifischeren Änderungen an relevanten Paketen.

Zusammenfassung

Die Suite von gems „axe-devtools-*“ wurde neu konzipiert, um die bereitgestellten Integrationstools zu verschlanken und ein besseres Entwicklererlebnis zu bieten.

Im Vergleich zu früheren Versionen, in denen nur ein einziges Gem bereitgestellt wurde, bietet diese Version eine Sammlung von Gems, sodass Endbenutzer auswählen können, was wichtig ist und am besten zu ihrem aktuellen Arbeitsablauf passt.

Migrationsschritte

Angesichts der Aufspaltung von einer monolithischen Gem-Struktur in einzelne Gems sind einige Migrationsschritte erforderlich. Sie können den folgenden Migrationsleitfaden verwenden.

Entwickler-Setup

Es gibt keine Änderungen gegenüber dem vorherigen Entwickler-Setup. Die notwendigen Voraussetzungen sind wie folgt:

• Ruby (die neueste Version)
• Bundler für Gem-Abhängigkeiten
• Rake als Task Runner
• RSpec oder Cucumber zum Testen
• Node und Npm für die Installation des axe-core-Pakets

Installieren von axe DevTools für Web Gems

Stellen Sie sicher, dass Sie Zugriff auf [Deque's Register][Attest NPM-Register Setup] haben. Wenn nicht, [lesen Sie im Einrichtungshandbuch nach][].

Nachdem Sie Zugriff auf Deque's Paketdatenbank haben, können Sie die folgenden Gems installieren, indem Sie sie entweder in die Gemfile- oder Gemspec-Dateien einbinden.

gem "axe-devtools-cucumber"

Alternativ können Sie eine Quelle für das Gem angeben:

gem "attest-devtools-cucumber", :source => 'https://agora.dequecloud.com/artifactory/api/gems/devtools-gems'

Die verfügbaren Gems sind:

• [Axe DevTools für Web Cucumber][]
• [axe DevTools für Web RSpec][]
• [axe DevTools für Web Capybara][]
• axe DevTools für Web Selenium
• [axe DevTools für Web Watir][]

Hinweise zur Verwendung und ausführliche Informationen zu den APIs finden Sie in der Dokumentation.

Deinstallieren der Ruby-Integrationen

Sie können die vorherigen Ruby-Integrationen deinstallieren, indem Sie die folgenden Befehle ausführen:

gem uninstall axe-matchers
gem uninstall attest-ruby

Bemerkenswerte Änderungen

Weitere wichtige Änderungen an der Ruby-Integration sind:

– Die Umgebungsvariable zum Konfigurieren benutzerdefinierter Regeln wurde von ATTEST_PATH in AXE_RULESET_PATH geändert. Siehe [Erweiterte Verwendung][]. – Der Standardregelsatz hat sich geändert. axe DevTools for Web prüft eine bestimmte Seite mit „wcag2“ als Standardregelsatz. Es sind keine Änderungen seitens des Endbenutzers erforderlich. Wenn Sie einen anderen Regelsatz konfigurieren möchten, können Sie die entsprechenden Klauseln in der Cucumber-Dokumentation oder der RSpec-Dokumentation verwenden. – Die be_accessible Matchers in RSpec wurden umbenannt in be_axe_clean[insert term here]. – Die be accessible Schrittdefinition in RSpec wurde in be axe clean[insert term here] umbenannt.