Axe DevTools for Web v4.x への移行方法 (Ruby 用)

Axe DevTools for Web Gems v4.x は、プロジェクト全体の主要な書き換えです。最も注目すべき変更点を以下にまとめ、それに続いて関連するパッケージのより具体的な変更を示します。

概要

axe-devtools-* のスイートは、統合ツールを簡素化し、より良い開発者体験を提供するために再設計されました。

以前のバージョンでは単一の gem が提供されていただけでしたが、このバージョンでは、一連の gem を提供しており、エンドユーザーが自身のワークフローに最適なものを選択できます。

移行手順

モノリシックな gem 構造から個々の gem への分割により、いくつかの移行手順が必要です。以下の移行ガイドを利用できます。

開発者セットアップ

以前の開発者セットアップからの変更はありません。必要な要件は次の通りです：

• Ruby（最新バージョン）
• gem の依存関係用の Bundler
• タスクランナーとしての Rake
• テスト用の RSpec または Cucumber
• Node および Npm を使った axe-core パッケージのインストール

Axe DevTools for Web Gems のインストール

Deque's registry へのアクセスを確保してください。アクセスできない場合は、refer to the setup guide。

Deque のレジストリにアクセスできるようになったら、以下の gem を Gemfile または gemspec ファイルに含めることでインストールできます。

gem "axe-devtools-cucumber"

あるいは、gem のソースを指定することもできます：

gem "attest-devtools-cucumber", :source => 'https://agora.dequecloud.com/artifactory/api/gems/devtools-gems'

利用可能な gem は以下の通りです：

• Axe DevTools for Web Cucumber
• Axe DevTools for Web RSpec
• Axe DevTools for Web Capybara
• Axe DevTools for Web Selenium
• Axe DevTools for Web Watir

使用説明書や API の詳細情報につきましては、ドキュメントをご参照ください。

Ruby インテグレーションのアンインストール

以下のコマンドを実行して、以前の Ruby インテグレーションをアンインストールできます：

gem uninstall axe-matchers
gem uninstall attest-ruby

注目すべき変更点

Ruby インテグレーションにおける他の注目すべき変更点は以下の通りです：

• カスタムルールを設定するための環境変数が ATTEST_PATH から AXE_RULESET_PATH に変更されました。advanced usage を参照してください。
• デフォルトのルールセットが変更されました。Axe DevTools for Web は指定されたページをデフォルトルールセットである wcag2 を用いて監査します。エンドユーザーによる変更は不要です。別のルールセットを設定したい場合は、Cucumber のドキュメント または RSpec のドキュメント で提供されるそれぞれの句を利用できます。
• RSpec の be_accessible マッチャーが be_axe_clean に名前が変更されました。
• RSpec の be accessible ステップ定義が be axe clean に名前が変更されました。