Utilizzo Avanzato delle API con Ruby

Questo documento discute regole personalizzate, opzioni di reportistica e il servizio di utilizzo con Ruby.

Regole Personalizzate

Puoi specificare regole personalizzate di axe in un file JSON.

Configura Regole Personalizzate tramite una Variabile di Ambiente

La configurazione predefinita si aspetta che la posizione del file delle regole personalizzate sia config/axe-ruleset.json, rispetto alla directory di lavoro corrente.

Puoi sovrascrivere questa posizione con la variabile di ambiente AXE_RULESET_PATH o manualmente tramite la configurazione di Axe DevTools.

Imposta la variabile di ambiente AXE_RULESET_PATH per cambiare la posizione del tuo axe-ruleset.json:

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

Configurazione delle Regole Personalizzate tramite la Configurazione di Axe DevTools

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

Tutte le impostazioni seguenti sono opzionali. Puoi omettere l'intera invocazione di AxeDevTools.configure 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 Reportistica

Configurazione delle Opzioni di Reportistica tramite la Configurazione di Axe DevTools

I gem axe-devtools-* abilitano il logging dei risultati dei test. Utilizza l'invocazione AxeDevTools.Configure per impostare una configurazione globale per la reportistica:

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 per la reportistica può avere le seguenti proprietà:

Nota anche che tutte le opzioni sopra per AxeDevTools.configure possono essere passate quando si configura il WebDriver di scelta. Ad esempio:

require 'axe-devtools-capybara'

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

Vedi Anche

• Caricamento dei risultati di accessibilità JSON su Axe Reports descrive come caricare i tuoi 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 dei report mostra come puoi creare report di accessibilità in formato CSV, XML o HTML dai tuoi risultati di accessibilità JSON. Puoi anche filtrare il tuo output per gravità utilizzando questo strumento.
• Come vengono memorizzati i risultati JSON sul disco descrive le convenzioni di denominazione dei file per i risultati di accessibilità JSON.
• Utilizzo della CLI per inviare i risultati di accessibilità a Axe Developer Hub mostra come puoi caricare i tuoi file di risultati .json su Axe Developer Hub.

Servizio di Utilizzo

Puoi ottenere informazioni sulle tendenze di utilizzo di Axe DevTools all'interno della tua organizzazione con il servizio di utilizzo.

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

I gem axe-devtools-* permettono di configurare il servizio di utilizzo tramite una configurazione globale:

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

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

Inoltre, nota che tutte le opzioni sopra menzionate per AxeDevTools.configure possono anche essere passate 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 tramite variabili d'ambiente.