Utilizzo avanzato dell'API con Ruby

In questo documento vengono illustrate le regole personalizzate, le opzioni di reporting e il servizio di utilizzo con Ruby.

Regole personalizzate

È possibile specificare regole personalizzate per axe in un file. JSON

Configurare regole personalizzate tramite una variabile d'ambiente

La configurazione predefinita prevede che il percorso del file delle regole personalizzate sia config/axe-ruleset.json, relativo alla directory di lavoro corrente.

È possibile sovrascrivere questa posizione con la variabile d'ambiente AXE_RULESET_PATH o manualmente tramite la configurazione di axe DevTools.

Imposta la variabile d'ambiente AXE_RULESET_PATH per modificare la posizione del tuo axe-ruleset.json:

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

Configurazione di regole personalizzate tramite axe DevTools Configuration

È disponibile un oggetto di configurazione per definire una posizione di regola personalizzata utilizzando il metodo AxeDevTools.configure se non si desidera lavorare con la variabile di ambiente AXE_RULESET_PATH .

Tutte le impostazioni seguenti sono facoltative. È possibile omettere l'intera AxeDevTools.configure invocazione per utilizzare i valori predefiniti originali.

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

Opzioni di segnalazione

Configurazione delle opzioni di reporting con axe DevTools Configuration

Invocazione axe-devtools-* gems enable logging test results. Use the AxeDevTools.Configure per impostare una configurazione globale per la segnalazione:

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',
})

La configurazione del reporting può assumere le seguenti proprietà:

Si noti inoltre che tutte le opzioni sopra indicate per AxeDevTools.configure possono essere passate durante la configurazione del WebDriver scelto. Per esempio:

require 'axe-devtools-capybara'

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

Vedere anche

• Caricamento dei risultati di accessibilità JSON su axe Reports descrive come caricare i risultati su axe Reports.
• Ottenere una chiave API per axe Reports spiega come ottenere una chiave API per iniziare a utilizzare axe Reports.
• Creazione e filtraggio di report mostra come creare report di accessibilità in formato CSV, XML o HTML a partire dai risultati di accessibilità JSON. Utilizzando questo strumento puoi anche filtrare l'output in base alla gravità.
• Come vengono archiviati i risultati JSON su disco descrive le convenzioni di denominazione dei file per i risultati di accessibilità JSON.

Servizio di utilizzo

Grazie al servizio di utilizzo puoi ottenere informazioni sulle tendenze di utilizzo di axe DevTools all'interno della tua organizzazione.

Per impostazione predefinita, il servizio di utilizzo è disabilitato e l'URL di tracciamento è https://usage.deque.com.

Configurazione delle opzioni del servizio di utilizzo con la configurazione di AxeDevTools

Le gemme axe-devtools-* consentono di configurare il servizio di utilizzo tramite una configurazione globale:

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

Le proprietà di configurazione specifiche del servizio di utilizzo sono:

Si noti inoltre che tutte le opzioni sopra indicate per AxeDevTools.configure possono essere passate anche durante la configurazione del WebDriver scelto. Ad esempio, per Capybara:

require 'axe-devtools-capybara'

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

Configurazione delle opzioni del servizio di utilizzo con variabili d'ambiente

Inoltre, le opzioni del servizio di utilizzo possono essere configurate come variabili di ambiente.

# To disable usage tracking
AXE_TRACK_USAGE=false
# To configure where usage data is sent
AXE_METRICS_URL=https://usage.dequelabs.com