Uso Avançado de API com Ruby

Este documento discute regras personalizadas, opções de relatório e o serviço de uso com Ruby.

Regras Personalizadas

Você pode especificar regras personalizadas do axe em um arquivo JSON.

Configurar Regras Personalizadas via Variável de Ambiente

A configuração padrão espera que a localização do arquivo de regras personalizadas seja config/axe-ruleset.json, relativa ao diretório de trabalho atual.

Você pode substituir essa localização com a variável de ambiente AXE_RULESET_PATH ou manualmente através da configuração do Axe DevTools.

Defina a variável de ambiente AXE_RULESET_PATH para alterar a localização do seu axe-ruleset.json:

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

Configurando Regras Personalizadas via Configuração do Axe DevTools

Um objeto de configuração está disponível para definir a localização de uma regra personalizada usando o método AxeDevTools.configure caso você não deseje trabalhar com a variável de ambiente AXE_RULESET_PATH.

Todas as configurações abaixo são opcionais. Você pode omitir toda a invocação de AxeDevTools.configure para usar os valores padrão originais.

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

Opções de Relatório

Configurando Opções de Relatório com Configuração do Axe DevTools

Os gems axe-devtools-* permitem registrar os resultados dos testes. Use a invocação AxeDevTools.Configure para configurar uma configuração global para relatórios:

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

A configuração de relatório pode ter as seguintes propriedades:

Além disso, note que todas as opções acima para AxeDevTools.configure podem ser passadas ao configurar o WebDriver de escolha. Por exemplo:

require 'axe-devtools-capybara'

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

Veja Também

• Enviando Resultados de Acessibilidade JSON para o axe Reports descreve como enviar seus resultados para o axe Reports.
• Obtendo uma Chave de API do axe Reports explica como obter uma chave de API para começar a usar o axe Reports.
• Criando e Filtrando Relatórios mostra como você pode criar relatórios de acessibilidade em CSV, XML ou HTML a partir dos seus resultados de acessibilidade em JSON. Você também pode filtrar sua saída por gravidade usando esta ferramenta.
• Como Resultados JSON são Armazenados no Disco descreve as convenções de nomenclatura de arquivos para resultados de acessibilidade em JSON.
• Usando a CLI para Enviar Resultados de Acessibilidade para o axe Developer Hub mostra como você pode enviar seus arquivos de resultados .json para axe Developer Hub.

Serviço de Uso

Você pode obter insights sobre as tendências de uso do Axe DevTools dentro da sua organização com o serviço de uso.

Por padrão, o serviço de uso está desativado, e a URL de rastreamento é https://usage.deque.com.

Configurando Opções do Serviço de Uso com a Configuração do Axe DevTools

Os gems axe-devtools-* permitem configurar o serviço de uso via uma configuração global:

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

As propriedades específicas de configuração do serviço de uso são:

Além disso, observe que todas as opções acima para AxeDevTools.configure também podem ser passadas ao configurar o WebDriver de sua escolha. Por exemplo, para o Capybara:

require 'axe-devtools-capybara'

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

Configurando as Opções de Uso do Serviço com Variáveis de Ambiente

Além disso, as opções de uso do serviço podem ser configuradas por meio de variáveis de ambiente.