Uso avanzado de API con Ruby

Este documento analiza las reglas personalizadas, las opciones de informes y el servicio de utilización con Ruby.

Reglas personalizadas

Puede especificar reglas de axe personalizadas en un archivo JSON .

Configurar reglas personalizadas a través de una variable de entorno

La configuración predeterminada espera que la ubicación del archivo de reglas personalizadas sea config/axe-ruleset.json, relativa al directorio de trabajo actual.

Puede anular esta ubicación con la AXE_RULESET_PATH variable de entorno o manualmente a través de la configuración de Axe DevTools.

Establezca la AXE_RULESET_PATH variable de entorno para cambiar la axe-ruleset.json ubicación de su:

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

Configuración de reglas personalizadas mediante axe DevTools Configuration

Hay un objeto de configuración disponible para definir una ubicación de regla personalizada usando el AxeDevTools.configure método si no desea trabajar con la AXE_RULESET_PATH variable de entorno.

Todas las configuraciones a continuación son opcionales. Puede omitir toda la AxeDevTools.configure invocación para utilizar los valores predeterminados originales.

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

Opciones de informes

Configuración de opciones de informes with axe DevTools Configuration

La invocación axe-devtools-* gems enable logging test results. Use the AxeDevTools.Configure para configurar una configuración global para informes:

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 configuración de informes puede tomar las siguientes propiedades:

Además, tenga en cuenta que todas las opciones anteriores para AxeDevTools.configure se pueden pasar al configurar el WebDriver preferido. Por ejemplo:

require 'axe-devtools-capybara'

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

Consulte también

• Cómo cargar resultados de accesibilidad JSON en axe Reports describe cómo cargar sus resultados en axe Reports.
• Cómo obtener una clave API de axe Reports indica cómo obtener una clave API para comenzar a utilizar axe Reports.
• Creación y filtrado de informes muestra cómo puede crear informes de accesibilidad en formato CSV, XML o HTML a partir de sus resultados de accesibilidad JSON. También puede filtrar su salida por severidad utilizando esta herramienta.
• Cómo se almacenan los resultados JSON en el disco describe las convenciones de nombres de archivos para los resultados de accesibilidad JSON.

Servicio de uso

Puede obtener información sobre las tendencias de uso de axe DevTools dentro de su organización con el servicio de uso.

De forma predeterminada, el servicio de uso está deshabilitado y la URL de seguimiento es https://usage.deque.com.

Configuración de las opciones del servicio de uso con AxeDevTools Configuration

Las gemas axe-devtools-* permiten configurar el servicio de uso a través de una configuración global:

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

Las propiedades de configuración específicas del servicio de uso son:

Además, tenga en cuenta que todas las opciones anteriores para AxeDevTools.configure también se pueden pasar al configurar el WebDriver preferido. Por ejemplo, para Capybara:

require 'axe-devtools-capybara'

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

Configuración de las opciones del servicio de uso con variables de entorno

Además, las opciones del servicio de uso se pueden configurar como variables de entorno.

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