Uso avanzado de la API con Ruby

Este documento discute las reglas personalizadas, las opciones de informes y el servicio de uso con Ruby.

Reglas Personalizadas

Puede especificar reglas personalizadas de axe 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 sobrescribir esta ubicación con la variable de entorno AXE_RULESET_PATH o manualmente a través de la configuración de Axe DevTools.

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

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

Configurar Reglas Personalizadas a través de la Configuración de Axe DevTools

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

Todas las configuraciones a continuación son opcionales. Puede omitir toda la invocación AxeDevTools.configure para usar 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

Configurar Opciones de Informes con la Configuración de Axe DevTools

Las gemas axe-devtools-* permiten registrar los resultados de las pruebas. Use la invocación 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 de su elección. Por ejemplo:

require 'axe-devtools-capybara'

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

Ver También

• Cargando Resultados de Accesibilidad JSON a Axe Reports describe cómo cargar tus resultados en Axe Reports.
• Obteniendo una Clave API de Axe Reports explica cómo obtener una clave API para comenzar a usar Axe Reports.
• Crear y Filtrar Informes muestra cómo puedes crear informes de accesibilidad en CSV, XML o HTML a partir de tus resultados de accesibilidad JSON. También puedes filtrar tu salida por severidad utilizando esta herramienta.
• Cómo se Almacenan los Resultados JSON en el Disco describe las convenciones de nomenclatura de archivos para resultados de accesibilidad JSON.
• Usando la CLI para Enviar Resultados de Accesibilidad al Centro de Desarrolladores de Axe muestra cómo puedes subir tus archivos de resultados .json a Centro de Desarrolladores de Axe.

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.

Por defecto, el servicio de uso está habilitado, y la URL de seguimiento es https://usage.deque.com.

Configurar Opciones del Servicio de Uso con la Configuración de AxeDevTools

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, observa que todas las opciones mencionadas anteriormente para AxeDevTools.configure también se pueden pasar al configurar el WebDriver de tu elección. Por ejemplo, para Capybara:

require 'axe-devtools-capybara'

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

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

Además, las opciones de servicio de uso se pueden configurar a través de variables de entorno.