capybara-accessible 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bc474ce3ecde90316cd8f6693ec63070c2e7c134
-  data.tar.gz: 80e58047c93f55023767eecc37d46b6487f64391
+SHA256:
+  metadata.gz: 44aeee6bf81a4a9249b1d99191de2f0f1a1f8260e5bd124f488d7d2b9cf59c4e
+  data.tar.gz: 6f10dd18c5978d5ceb5ce2f118b52856fd6381f27569845997e647675f82a46b
 SHA512:
-  metadata.gz: bb2173ca56885f1cb684ceafb54438e0059f1224e93fca36974592c64a2935c639926b5fcf8a9885af54228662445a5e2678e6c4594a4e96644afbefa06bb45b
-  data.tar.gz: 0f18d822bca546abd31efddaa2775a622c2a1a0b8dee4caf2831a1197bc2698668f1b6f8543556242a977577fe93f9686e878317f2203c4e423ce3c2e9383a22
+  metadata.gz: 22b5c864295928aa1315861d36d39db10d334b9f76edb2248b69374f4f1ba58f4f105b8c940e769b5b861ad95a27470daaf1d708bd1e777cbfea980f4684dc14
+  data.tar.gz: d124caccb286e9f84b5ce2c334012c3b3a621e6bcea243c3315f5f03385908ad694728a5162c4028777663b299e0826b4fd903f96d3581bdbd2253803e9373e3

data/.gitignore

@@ -2,8 +2,10 @@
 *.rbc
 .bundle
 .config
-.rspec
 .yardoc
+.idea
+.DS_Store
+.ruby-version
 Gemfile.lock
 InstalledFiles
 _yardoc
@@ -16,4 +18,3 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-.tddium*

data/.travis.yml

@@ -0,0 +1,26 @@
+language: ruby
+sudo: required
+dist: trusty
+
+rvm:
+  - 2.3.7
+  - 2.4.4
+  - 2.5.3
+  - 2.6.1
+
+before_install:
+  - sudo apt-get update
+  - sudo apt-get install chromium-chromedriver
+  - wget https://github.com/mozilla/geckodriver/releases/download/v0.24.0/geckodriver-v0.24.0-linux64.tar.gz
+  - mkdir geckodriver
+  - tar -xzf geckodriver-v0.24.0-linux64.tar.gz -C geckodriver
+  - export PATH=$PATH:$PWD/geckodriver
+before_script:
+  - "export PATH=$PATH:/usr/lib/chromium-browser/"
+  - "export DISPLAY=:99.0"
+  - "sh -e /etc/init.d/xvfb start"
+  - sleep 3 # give xvfb some time to start
+
+addons:
+  chrome: stable
+  firefox: latest-esr

data/Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in capybara-praseodymium.gemspec
 gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013-2016 Case Commons, Inc. <http://casecommons.org>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,60 +1,55 @@
-# capybara-accessible
+# [capybara-accessible](https://github.com/Casecommons/capybara-accessible)
 
-## Automated accessibility testing in RSpec and Rails
+[![Gem Version](https://img.shields.io/gem/v/capybara-accessible.svg?style=flat)](https://rubygems.org/gems/capybara-accessible)
+[![Build Status](https://secure.travis-ci.org/Casecommons/capybara-accessible.svg?branch=master)](https://travis-ci.org/Casecommons/capybara-accessible)
 
-capybara-accessible introduces accessibility tests into your [Rspec integration tests](https://www.relishapp.com/rspec/rspec-rails/docs/feature-specs/feature-spec), 
-helping you to capture existing failures and prevent future regressions.
+capybara-accessible introduces accessibility tests into your [Rspec integration tests](https://www.relishapp.com/rspec/rspec-rails/docs/feature-specs/feature-spec) which use [Capybara](https://jnicklas.github.io/capybara/), helping you to capture existing failures and prevent future regressions.
 
-It works by defining a custom webdriver that runs [Google's Accessibility Developer Tools](https://github.com/GoogleChrome/accessibility-developer-tools)
-audits during each test run. Since the audits are invoked automatically on page load, you do not need to make explicit assertions on accessibility. 
-Instead, the test will simply fail with a message indicating the failures, like so:
+It works by defining a custom webdriver that runs [Google's Accessibility Developer Tools](https://github.com/GoogleChrome/accessibility-developer-tools) audits during each test run. Since the audits are invoked automatically on page load, you do not need to make explicit assertions on accessibility. Instead, the test will simply fail with a message indicating the failures, like so:
 
-![Error output from an Rspec failure](http://i.imgur.com/8RWEzzg.png)
+![Error output from an Rspec failure](https://i.imgur.com/8RWEzzg.png)
 
 Some of the audit rules that are included from Google's Accessibility Developer Tools:
-* minimum color contrast
-* label associations with inputs
-* presence of alt attributes
-* valid use of ARIA roles
 
-See the [Google Accessibility Developer Tools wiki](https://code.google.com/p/accessibility-developer-tools/wiki/AuditRules) 
-for a full list of rules.
+- minimum color contrast
+- label associations with inputs
+- presence of alt attributes
+- valid use of ARIA roles
 
-Visit the [capybara-accessible wiki](https://github.com/Casecommons/capybara-accessible/wiki) for background on why and how 
-we built capybara-accessible.
+See the [Google Accessibility Developer Tools wiki](https://code.google.com/p/accessibility-developer-tools/wiki/AuditRules) for a full list of rules.
 
+Visit the [capybara-accessible wiki](https://github.com/Casecommons/capybara-accessible/wiki) for background on why and how we built capybara-accessible.
 
 ## Installation
 
-Add `gem 'capybara-accessible'` to your application's Gemfile and run `bundle` on the command line.
-
+Install as usual: `gem install capybara-accessible` or add `gem 'capybara-accessible'` to your Gemfile. See `.travis.yml` for supported (tested) Ruby versions.
 
 ## Usage
 
-You can use capybara-accessible as a drop-in replacement for Rack::Test, Selenium, capybara-webkit, or Poltergeist drivers for Capybara.
-Simply set the driver in `spec/spec_helper.rb` or `features/support/env.rb`:
+**Attention: capybara-accessible stop supporting Capybara WebKit since version 0.3.0. You can only use 0.2.1 or pervious versions for Capybara WebKit.** 
+
+You can use capybara-accessible as a drop-in replacement for Rack::Test, Selenium(Firefox & Chrome), or Poltergeist drivers for Capybara. Simply set the driver in `spec/spec_helper.rb` or `features/support/env.rb`:
 
     require 'capybara/rspec'
     require 'capybara/accessible'
 
-    # For selenium integration
+    # For selenium firefox integration
     Capybara.default_driver = :accessible_selenium
-    Capybara.javascript_driver = :accessible_selenium
+    Capybara.javascript_driver = Capybara.default_driver
 
-    # For capybara webkit integration
-    Capybara.default_driver = :accessible_webkit
-    Capybara.javascript_driver = :accessible_webkit
+    # For selenium chrome integration
+    Capybara.default_driver = :accessible_selenium_chrome
+    Capybara.javascript_driver = Capybara.default_driver
 
     # For poltergeist integration
     Capybara.default_driver = :accessible_poltergeist
-    Capybara.javascript_driver = :accessible_poltergeist
+    Capybara.javascript_driver = Capybara.default_driver
 
 
-We suggest that you use [pry-rescue with pry-stack_explorer](https://github.com/ConradIrwin/pry-rescue) 
-to debug the accessibility failures in the DOM. pry-rescue will open a debugging session at the first exception, 
-pausing the driver so that you can inspect the page.
+We suggest that you use [pry-rescue with pry-stack_explorer](https://github.com/ConradIrwin/pry-rescue) to debug the accessibility failures in the DOM. pry-rescue will open a debugging session at the first exception, pausing the driver so that you can inspect the page.
 
 ### Disabling audits
+
 You can disable audits on individual tests by tagging the example or group with `inaccessible`.
 
 #### Rspec
@@ -96,25 +91,23 @@ You can disable audits on individual tests by tagging the example or group with
       When I visit a page that is inaccessible
       Then I should see the inaccessible image # this assertion will still be executed
 
-
 ### Changing the severity of audit rules
 
-If you'd like to enforce certain rules and raise errors instead of showing them as warnings, 
-for example images should never have alt attributes, you can configure it as follows:
+If you'd like to enforce certain rules and raise errors instead of showing them as warnings, for example images should never have alt attributes, you can configure it as follows:
 
     Capybara::Accessible::Auditor.severe_rules = ['AX_TEXT_02']
 
-
 ## Support
 
-If you think you've found a bug, or have installation questions or feature requests, please send a message 
-to the [mailing list](https://groups.google.com/forum/#!forum/capybara-accessible).
+If you think you've found a bug, or have installation questions or feature requests, please send a message to the [mailing list](https://groups.google.com/forum/#!forum/capybara-accessible).
 
-If you are commenting on the audit rules and failure messages, please check out the Google Accessibility Developer Tools 
-Project, and review their guidelines for reporting issues.
+If you are commenting on the audit rules and failure messages, please check out the Google Accessibility Developer Tools Project, and review their guidelines for reporting issues.
 
 ## Contributing
 
-NOTE: axs_testing.js is a generated file from 
-[Google's Accessibility Developer Tools](https://github.com/GoogleChrome/accessibility-developer-tools). 
-If you'd like to contribute to the audit rules, please fork their Github project.
+NOTE: axs_testing.js is a generated file from [Google's Accessibility Developer Tools](https://github.com/GoogleChrome/accessibility-developer-tools). If you'd like to contribute to the audit rules, please fork their Github project.
+
+## License
+
+Copyright © 2013–2016 [Case Commons, Inc](http://casecommons.org).
+Licensed under the MIT license, see [LICENSE](/LICENSE) file.

data/Rakefile

@@ -1,11 +1,6 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
-Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new
 
-RSpec::Core::RakeTask.new do |t|
-  t.pattern = "spec/**/*_spec.rb"
-end
-
-desc "Default: run all specs"
-task :default => [:spec]
+task :default => :spec

data/capybara-accessible.gemspec

@@ -1,33 +1,27 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+# encoding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
 require 'capybara/accessible/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "capybara-accessible"
+  spec.name          = 'capybara-accessible'
   spec.version       = Capybara::Accessible::VERSION
   spec.authors       = ["Case Commons"]
   spec.email         = ["accessibility@casecommons.org"]
-  spec.description   = %q{Capybara extension and webdriver for automated accessibility testing}
-  spec.summary       = %q{A Selenium based webdriver and Capybara extension that runs Google Accessibility Developer Tools auditing assertions on page visits.}
-  spec.homepage      = "https://github.com/Casecommons/capybara-accessible"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/Casecommons/capybara-accessible'
+  spec.summary       = %q{Capybara extension and webdriver for automated accessibility testing}
+  spec.description   = %q{A Selenium based webdriver and Capybara extension that runs Google Accessibility Developer Tools auditing assertions on page visits.}
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
 
-  spec.test_files    = spec.files.grep(%r{^spec/})
-  spec.require_paths = ["lib"]
+  spec.add_dependency 'capybara', '>= 3.12.0'
 
-  spec.add_dependency("capybara", "~> 2.0")
-
-  spec.add_development_dependency "selenium-webdriver"
-  spec.add_development_dependency "capybara-webkit"
-  spec.add_development_dependency "poltergeist"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "tddium"
-
-  # Sinatra is used by Capybara's TestApp
-  spec.add_development_dependency("sinatra")
+  spec.add_development_dependency 'poltergeist'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'selenium-webdriver', '>= 3.14.0'
+  spec.add_development_dependency 'sinatra'
 end

data/lib/capybara/accessible.rb

@@ -1,72 +1,12 @@
 require 'capybara'
 require 'capybara/accessible/auditor'
-require 'capybara/accessible/element'
-require 'capybara/accessible/driver_extensions'
-require "capybara/accessible/version"
-require "capybara/accessible/railtie" if defined?(Rails)
+require 'capybara/accessible/extensions/element'
+require 'capybara/accessible/extensions/driver'
+require 'capybara/accessible/version'
+require 'capybara/accessible/railtie' if defined?(Rails)
 
 module Capybara
   module Accessible
-    class SeleniumDriverAdapter
-      def modal_dialog_present?(driver)
-        begin
-          driver.browser.switch_to.alert
-          true
-        rescue ::Selenium::WebDriver::Error::NoAlertOpenError, ::NoMethodError
-          false
-        end
-      end
-
-      def failures_script
-        "return axs.Audit.auditResults(results).getErrors();"
-      end
-
-      def create_report_script
-        "return axs.Audit.createReport(results);"
-      end
-
-      def run_javascript(driver, script)
-        driver.execute_script(script)
-      end
-    end
-
-    class WebkitDriverAdapter
-      def modal_dialog_present?(driver)
-        driver.alert_messages.any?
-      end
-
-      def failures_script
-        "axs.Audit.auditResults(results).getErrors();"
-      end
-
-      def create_report_script
-        "axs.Audit.createReport(results);"
-      end
-
-      def run_javascript(driver, script)
-        driver.evaluate_script(script)
-      end
-    end
-
-    class PoltergeistDriverAdapter
-      def modal_dialog_present?(driver)
-        false
-      end
-
-      def failures_script
-        "return axs.Audit.auditResults(results).getErrors()"
-      end
-
-      def create_report_script
-        "return axs.Audit.createReport(results)"
-      end
-
-      def run_javascript(driver, script)
-        # Have to wrap in an anonymous function because of https://github.com/jonleighton/poltergeist/issues/198
-        driver.evaluate_script %{ (function() {#{script}})() }
-      end
-    end
-
     class << self
       def skip_audit
         Capybara::Accessible::Auditor.disable
@@ -75,13 +15,10 @@ module Capybara
         Capybara::Accessible::Auditor.enable
       end
 
-      def driver_adapter
-        @driver_adapter
-      end
-
-      def setup(driver, adaptor)
-        @driver_adapter = adaptor
-        driver.extend(Capybara::Accessible::DriverExtensions)
+      def create_driver(base_driver, driver_adaptor, app, **options)
+        driver_class = Capybara::Accessible::Extensions::Driver.wrap(base_driver)
+        driver = driver_class.new(app, **options)
+        driver.accessible = driver_adaptor.new
         driver
       end
     end
@@ -90,26 +27,38 @@ end
 
 Capybara.register_driver :accessible do |app|
   puts "DEPRECATED: Please register this driver as 'accessible_selenium'"
-  driver = Capybara::Selenium::Driver.new(app)
-  adaptor = Capybara::Accessible::SeleniumDriverAdapter.new
-  Capybara::Accessible.setup(driver, adaptor)
+  require 'capybara/accessible/adapters/selenium'
+  Capybara::Accessible.create_driver(
+    Capybara::Selenium::Driver,
+    Capybara::Accessible::Adapters::Selenium,
+    app,
+  )
 end
 
-
 Capybara.register_driver :accessible_selenium do |app|
-  driver = Capybara::Selenium::Driver.new(app)
-  adaptor = Capybara::Accessible::SeleniumDriverAdapter.new
-  Capybara::Accessible.setup(driver, adaptor)
+  require 'capybara/accessible/adapters/selenium'
+  Capybara::Accessible.create_driver(
+    Capybara::Selenium::Driver,
+    Capybara::Accessible::Adapters::Selenium,
+    app,
+  )
 end
 
-Capybara.register_driver :accessible_webkit do |app|
-  driver = Capybara::Webkit::Driver.new(app)
-  adaptor = Capybara::Accessible::WebkitDriverAdapter.new
-  Capybara::Accessible.setup(driver, adaptor)
+Capybara.register_driver :accessible_selenium_chrome do |app|
+  require 'capybara/accessible/adapters/selenium'
+  Capybara::Accessible.create_driver(
+    Capybara::Selenium::Driver,
+    Capybara::Accessible::Adapters::Selenium,
+    app,
+    :browser => :chrome
+  )
 end
 
 Capybara.register_driver :accessible_poltergeist do |app|
-  driver = Capybara::Poltergeist::Driver.new(app)
-  adaptor = Capybara::Accessible::PoltergeistDriverAdapter.new
-  Capybara::Accessible.setup(driver, adaptor)
+  require 'capybara/accessible/adapters/poltergeist'
+  Capybara::Accessible.create_driver(
+    Capybara::Poltergeist::Driver,
+    Capybara::Accessible::Adapters::Poltergeist,
+    app,
+  )
 end

data/lib/capybara/accessible/adapters/poltergeist.rb

@@ -0,0 +1,18 @@
+module Capybara::Accessible
+  module Adapters
+    class Poltergeist
+      def failures_script
+        'return axs.Audit.auditResults(results).getErrors()'
+      end
+
+      def create_report_script
+        'return axs.Audit.createReport(results)'
+      end
+
+      def run_javascript(driver, script)
+        # Have to wrap in an anonymous function because of https://github.com/jonleighton/poltergeist/issues/198
+        driver.evaluate_script %{ (function() {#{script}})() }
+      end
+    end
+  end
+end

data/lib/capybara/accessible/adapters/selenium.rb

@@ -0,0 +1,20 @@
+module Capybara::Accessible
+  module Adapters
+    class Selenium
+      def failures_script
+        'return axs.Audit.auditResults(results).getErrors();'
+      end
+
+      def create_report_script
+        'return axs.Audit.createReport(results);'
+      end
+
+      def run_javascript(driver, script)
+        driver.execute_script(script)
+      rescue ::Selenium::WebDriver::Error::UnhandledAlertError
+        puts 'Skipping accessibility audit: Modal dialog present'
+        nil
+      end
+    end
+  end
+end