Erweiterte API-Nutzung mit Ruby

Dieses Dokument behandelt benutzerdefinierte Regeln, Berichtsoptionen und den Nutzungsdienst mit Ruby.

Benutzerdefinierte Regeln

Sie können benutzerdefinierte Axe-Regeln in einer JSON-Datei angeben.

Benutzerdefinierte Regeln über eine Umgebungsvariable konfigurieren

Die Standardkonfiguration erwartet den Speicherort der benutzerdefinierten Regeln unter config/axe-ruleset.json relativ zum aktuellen Arbeitsverzeichnis.

Sie können diesen Speicherort mit der AXE_RULESET_PATH-Umgebungsvariable oder manuell über die Axe DevTools-Konfiguration überschreiben.

Setzen Sie die AXE_RULESET_PATH-Umgebungsvariable, um den Speicherort Ihrer axe-ruleset.json zu ändern:

AXE_RULESET_PATH=/path/to/your/axe-ruleset.json

Benutzerdefinierte Regeln über die Axe DevTools-Konfiguration konfigurieren

Ein Konfigurationsobjekt steht zur Verfügung, um einen benutzerdefinierten Regel-Speicherort mit der AxeDevTools.configure-Methode zu definieren, falls Sie nicht mit der AXE_RULESET_PATH-Umgebungsvariable arbeiten möchten.

Alle nachstehenden Einstellungen sind optional. Sie können die gesamte AxeDevTools.configure-Aufrufung auslassen, um die ursprünglichen Standardwerte zu verwenden.

AxeDevTools.configure do |config|
  # path to json configuration providing custom rules and checks
  # set defaults to "config/axe-ruleset.json"
  config.axe_ruleset_path = "config/axe-ruleset.json"

  # Configure user pre-defined standard rule sets. Custom
  # rules override these rule sets. See https://github.com/dequelabs/axe-core/blob/develop/doc/rule-descriptions.md
  config.rule_set_id = '508'
end

Berichtsoptionen

Berichtsoptionen mit der Axe DevTools-Konfiguration einstellen

Die axe-devtools-*-Gems ermöglichen das Protokollieren von Testergebnissen. Verwenden Sie den AxeDevTools.Configure-Aufruf, um eine globale Konfiguration für Berichte einzurichten:

AxeDevTools.configure do |config|
  config.output_directory: 'my-results',
  config.test_machine: 'my-server',
  config.test_suite_name: 'Accessibility Tests For Application',
  config.user_agent: 'Headless Chrome'
end

expect(page).to be_audited_for_accessibility.logging_results({
  ui_state: 'Landing Page Load',
})

Die Berichts-Konfiguration kann folgende Eigenschaften haben:

Beachten Sie auch, dass alle oben genannten Optionen für AxeDevTools.configure beim Konfigurieren des bevorzugten WebDrivers übergeben werden können. Zum Beispiel:

require 'axe-devtools-capybara'

AxeCapybara.configure do |config|
 config.axe_config_path = 'config/my-ruleset.json'
end

Siehe auch

• Hochladen von JSON-Zugänglichkeitsergebnissen zu den Axe-Berichten beschreibt, wie Sie Ihre Ergebnisse in Axe-Berichte hochladen können.
• Erhalten eines Axe-Berichts-API-Schlüssels erklärt, wie Sie einen API-Schlüssel erhalten, um mit der Verwendung der Axe-Berichte zu beginnen.
• Erstellen und Filtern von Berichten zeigt, wie Sie Barriereberichte in CSV, XML oder HTML aus Ihren JSON-Barrierefreiheitsergebnissen erstellen können. Sie können Ihre Ausgabe auch nach Schweregrad filtern, indem Sie dieses Tool verwenden.
• Wie JSON-Ergebnisse auf der Festplatte gespeichert werden beschreibt die Namenskonventionen für JSON-Barrierefreiheitsergebnisse.
• Verwenden des CLI zum Senden von Zugänglichkeitsergebnissen an die Axe Developer Hub zeigt, wie Sie Ihre .json Ergebnisdateien zu Axe Developer Hub hochladen können.

Nutzungsdienst

Mit dem Nutzungsdienst können Sie Einblicke in die Nutzungstrends von Axe DevTools in Ihrer Organisation gewinnen.

Standardmäßig ist der Nutzungsdienst aktiviert, und die Tracking-URL ist https://usage.deque.com.

Optionen für den Nutzungsdienst mit AxeDevTools-Konfiguration einstellen

Die axe-devtools-*-Gems ermöglichen die Konfiguration des Nutzungsdienstes über eine globale Konfiguration:

AxeDevTools.configure do |config|
  config.setTrackingUrl: 'https://usage.deque.com',
end

Die spezifischen Konfigurationseigenschaften des Nutzungsdienstes sind:

Beachten Sie auch, dass alle oben genannten Optionen für AxeDevTools.configure auch bei der Konfiguration des gewünschten WebDrivers übergeben werden können. Zum Beispiel bei Capybara:

require 'axe-devtools-capybara'

AxeCapybara.configure do |config|
 config.enableTracking = false
end

Konfigurieren von Nutzungsdienst-Optionen mit Umgebungsvariablen

Zusätzlich können Nutzungsdienst-Optionen über Umgebungsvariablen konfiguriert werden.