Erweiterte API-Nutzung mit Ruby

This page is not available in the language you requested. You have been redirected to the English version of the page.

Link to this page copied to clipboard

Not for use with personal data

In diesem Dokument werden benutzerdefinierte Regeln, Berichtsoptionen und der Nutzungsdienst mit Ruby erläutert.

Benutzerdefinierte Regeln

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

note

Wenn Sie noch keine benutzerdefinierten Regeln haben und mit einem leeren benutzerdefinierten Regelsatz beginnen möchten, erstellen Sie im lokalen Verzeichnis eine axe-ruleset.json Datei mit einem leeren JavaScript-Objekt, zum Beispiel: {}.

Konfigurieren Sie benutzerdefinierte Regeln über eine Umgebungsvariable

Die Standardkonfiguration erwartet, dass der Speicherort der benutzerdefinierten Regeldatei sich unter config/axe-ruleset.json befindet, relativ zum aktuellen Arbeitsverzeichnis.

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

Legen Sie die AXE_RULESET_PATH Umgebungsvariable fest, um den Speicherort Ihres axe-ruleset.json zu ändern:

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

Konfigurieren benutzerdefinierter Regeln über die axe DevTools-Konfiguration

Wenn Sie nicht mit der AxeDevTools.configure Umgebungsvariable arbeiten möchten, steht Ihnen ein Konfigurationsobjekt zum Definieren eines benutzerdefinierten Regelspeicherorts mithilfe der AXE_RULESET_PATH Methode zur Verfügung.

Alle folgenden Einstellungen sind optional. Sie können den gesamten AxeDevTools.configure Aufruf weglassen, 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

Konfigurieren von Berichtsoptionen mit der axe DevTools-Konfiguration

Der Aufruf von axe-devtools-* gems enable logging test results. Use the AxeDevTools.Configure zum Einrichten einer globalen Konfiguration für die Berichterstattung:

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 Berichtskonfiguration kann die folgenden Eigenschaften annehmen:

Attribut	Standardwert	Beschreibung
ui_state (Obligatorisch)		Zu übergebendes Attribut im `options` -Objekt.
Ausgabeverzeichnis (Optional)	`axe-reports`	Name des Verzeichnisses, in welchem die Berichte generiert werden sollen.
test_machine (Optional)		Wert zur Angabe, wo der Test ausgeführt wird. Z. B. `CircleCI`, `TesterMachine01`
test_suite_name (Optional)	`axe-a11yCheck`	Name der Testsuite für die Tests. Z.B., `My Module Test Suite`
Benutzer-Agent (Optional)	null	Übergeben Sie einen Ziel-Benutzer-Agent. Z. B. Chrome.
Ausführlich (optional)	false	Flag zum Aktivieren/Deaktivieren der detaillierten Protokollierung von Stacktrace und Nachrichten.

Beachten Sie auch, dass alle oben genannten Optionen für AxeDevTools.configure bei der Konfiguration des gewünschten 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 in axe Reports beschreibt, wie Sie Ihre Ergebnisse in axe Reports hochladen.

Erhalten eines API-Schlüssels für axe Reports erklärt, wie Sie einen API-Schlüssel erhalten, um mit der Verwendung von axe Reports zu beginnen.

– Berichte erstellen und filtern zeigt, wie Sie aus Ihren JSON-Zugänglichkeitsergebnissen Zugänglichkeitsberichte im CSV-, XML- oder HTML-Format erstellen können. Mit diesem Tool können Sie Ihre Ausgabe auch nach Schweregrad filtern. – So werden JSON-Ergebnisse auf der Festplatte gespeichert beschreibt die Dateibenennungskonventionen für JSON-Zugänglichkeitsergebnisse.

Nutzungsservice

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

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

Konfigurieren von Nutzungsserviceoptionen mit der AxeDevTools-Konfiguration

Die Gem axe-devtools-* ermöglicht die Konfiguration des Nutzungsservice über eine globale Konfiguration:

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

Die spezifischen Konfigurationseigenschaften des Nutzungsdienstes sind:

Attribut	Standardwert	Beschreibung
Tracking aktivieren	true	Option zum Aktivieren der Nutzungsverfolgung.
setTrackingUrl	`https://usage.deque.com`	Option zum Überschreiben der Tracking-URL.

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

require 'axe-devtools-capybara'

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

Konfigurieren von Nutzungsserviceoptionen mit Umgebungsvariablen

Darüber hinaus können Verwendungsdienstoptionen als Umgebungsvariablen konfiguriert werden.