capybara-accessible 0.1.8 → 0.1.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01fb309e03c6d938d6ef7b42cb937ff39c61716f
+  data.tar.gz: c7d6487f9c68c51986ed954558529df1a6bfa0f3
+SHA512:
+  metadata.gz: 534b30513f7afe122e9c78f9e900e798830f798477dd202c4d823db5fbe0adb939a5b891ddd98680bc97c6675f82cb8bc2f649de62d3c6ab89091b765fe8d68d
+  data.tar.gz: f324fa20ecb8b46c9940175266bd532b58beaa49766bb821603931c923e17606bb52ff063a9d168e1d7a81f60fc614a515e604222dd98d8426b64b7618b02219

data/Gemfile

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

data/README.md

@@ -1,67 +1,58 @@
-# Capybara::Accessible
+# capybara-accessible
 
-[![](https://api.tddium.com/pivotal-casebook/capybara-accessible/badges/25347.png?badge_token=1e276156136851abb3ca113d37e1cddca332e098)](https://api.tddium.com/pivotal-casebook/capybara-accessible/suites/25347)
+## Automated accessibility testing in RSpec and Rails
 
-Automated accessibility testing for Rails integration tests (Rspec + Capybara)
-capybara-accessible automatically runs [Google's Accessibility Developer Tools](https://code.google.com/p/accessibility-developer-tools/) audits within your Ruby on Rails project integration test suite, using [RSpec feature specs](https://www.relishapp.com/rspec/rspec-rails/docs/feature-specs/feature-spec).
+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.
 
-Some of the checks that are included:
+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)
+
+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
 
-The full list of accessibility audit rules is on the [Google Accessibility Developer Tools wiki](https://code.google.com/p/accessibility-developer-tools/wiki/AuditRules).
-
-capybara-accessible extends Capybara and defines a custom webdriver that runs javascript assertions on every page visit and link/button click.
-This way you do not need to make explicit assertions on accessibility. Instead, the test will simply fail with a message indicating the accessibility errors, like so:
-
-    Failure/Error: visit '/inaccessible'
-     Capybara::Accessible::InaccessibleError:
-       *** Begin accessibility audit results ***
-       An accessibility audit found
-       Errors:
-       Error: AX_ARIA_01 (Elements with ARIA roles must use a valid, non-abstract ARIA role) failed on the following element:
-       body > .outer > .standup > .block.buttons
-       See https://code.google.com/p/accessibility-developer-tools/wiki/AuditRules#AX_ARIA_01:_Elements_with_ARIA_roles_must_use_a_valid,_non-abstr for more information.
-
-
-       *** End accessibility audit results ***
+See the [Google Accessibility Developer Tools wiki](https://code.google.com/p/accessibility-developer-tools/wiki/AuditRules) 
+for a full list of rules.
 
-Need help? Ask on the mailing list (please do not open an issue on GitHub): https://groups.google.com/forum/#!forum/capybara-accessible
+Visit the [capybara-accessible wiki](https://github.com/Casecommons/capybara-accessible/wiki) for background on why and how 
+we built capybara-accessible.
 
-Visit the [wiki](https://github.com/Casecommons/capybara-accessible/wiki) for more background on automated accessibility testing with capybara-accessible.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add `gem 'capybara-accessible'` to your application's Gemfile and run `bundle` on the command line.
 
-    gem 'capybara-accessible'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install capybara-accessible
 
 ## Usage
 
-You can use capybara-accessible as a drop-in replacement for Rack::Test, Selenium or capybara-webkit drivers for Capybara. Simply set the driver in spec_helper.rb:
+You can use capybara-accessible as a drop-in replacement for Rack::Test, Selenium or capybara-webkit drivers for Capybara.
+Simply set the driver in `spec/spec_helper.rb` or `features/support/env.rb`:
 
     require 'capybara/rspec'
     require 'capybara/accessible'
 
     Capybara.default_driver = :accessible
+    Capybara.javascript_driver = :accessible
+
+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 as `inaccessible: true`, and configuring Rspec like so:
+You can disable audits on individual tests by tagging the example or group with `inaccessible`.
+
+#### Rspec
 
     # spec/spec_helper.rb
 
     RSpec.configure do |config|
-      config.around(:each, :inaccessible => true) do |example|
+      config.around(:each, inaccessible: true) do |example|
         Capybara::Accessible.skip_audit { example.run }
       end
     end
@@ -69,20 +60,43 @@ You can disable audits on individual tests by tagging the example or group as `i
 
     # spec/features/inaccessible_page_spec.rb
 
-    # Blocks tagged inaccessible will skip accessibility assertions.
-    # They will still run your other native assertions.
-    describe '/inaccessible', inaccessible: true do 
-      it 'display an image' do
-        page.should have_css 'img'
+    # Page loads in examples tagged as inaccessible will not trigger an audit.
+    # All other assertions will be made.
+    feature '/inaccessible', inaccessible: true do 
+      scenario 'displays an image' do
+        page.should have_css 'img' # this assertion will still be executed
       end
     end
 
-## Contributing
+#### Cucumber
+
+    # features/support/env.rb
+    
+    Around('@inaccessible') do |scenario, block|
+      Capybara::Accessible.skip_audit { block.call }
+    end
+
+
+    # features/inaccessible_page.feature
+
+    # Page loads in examples tagged as inaccessible will not trigger an audit.
+    # All other assertions will be made.
+    @inaccessible
+    Scenario: Visiting a page that is inaccessible
+      When I visit a page that is inaccessible
+      Then I should see the inaccessible image # this assertion will still be executed
 
-NOTE: axs_testing.js is automatically generated by Google's Accessibility Developer tools project. If you want to modify the audit rules, please contribute to the Google project: https://github.com/GoogleChrome/accessibility-developer-tools
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+## 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 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.

data/capybara-accessible.gemspec

@@ -15,14 +15,13 @@ Gem::Specification.new do |spec|
 
   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.test_files    = spec.files.grep(%r{^spec/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency("capybara")
+  spec.add_dependency("capybara", "~> 2.0")
   spec.add_dependency("selenium-webdriver")
   
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "tddium"

data/lib/capybara/accessible/auditor.rb

@@ -19,6 +19,14 @@ module Capybara::Accessible
       @@exclusions ||= []
     end
 
+    def self.log_level=(level)
+      @@log_level= level
+    end
+
+    def self.log_level
+      @@log_level ||= :error
+    end
+
     def audit_rules
       File.read(File.expand_path("../../../vendor/google/accessibility-developer-tools/axs_testing.js", __FILE__))
     end

data/lib/capybara/accessible/driver.rb

@@ -4,8 +4,12 @@ module Capybara::Accessible
 
     def visit(path)
       super
-      if audit_failures.any?
-        raise Capybara::Accessible::InaccessibleError, failure_messages
+      if Capybara.current_driver == :accessible && audit_failures.any?
+        if Capybara::Accessible::Auditor.log_level == :warn
+          puts failure_messages
+        else
+          raise Capybara::Accessible::InaccessibleError, failure_messages
+        end
       end
     end
   end

data/lib/capybara/accessible/element.rb

@@ -6,11 +6,16 @@ module Capybara
       def click
         synchronize { base.click }
         begin
+          @session.driver.browser.switch_to.alert
+          puts "Skipping accessibility audit: Modal dialog present"
+        rescue ::Selenium::WebDriver::Error::NoAlertOpenError, ::NoMethodError
           if Capybara.current_driver == :accessible && audit_failures.any?
-            raise Capybara::Accessible::InaccessibleError, failure_messages
+            if Capybara::Accessible::Auditor.log_level == :warn
+              puts failure_messages
+            else
+              raise Capybara::Accessible::InaccessibleError, failure_messages
+            end
           end
-        rescue ::Selenium::WebDriver::Error::UnhandledAlertError => e
-          puts "Skipping accessibility audit: #{e}"
         end
       end
     end

data/lib/capybara/accessible/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Accessible
-    VERSION = "0.1.8"
+    VERSION = "0.1.9"
   end
 end

data/spec/driver_spec.rb

@@ -30,12 +30,23 @@ describe Capybara::Accessible::Driver do
         expect { @session.visit('/excluded') }.to_not raise_error
       end
     end
-  end
 
-  context 'a page with a javascript popup' do
-    it 'does not raise an exception' do
-      @session.visit('/alert')
-      expect { @session.click_link('Alert!') }.to_not raise_error
+    context 'with log level set to warn' do
+      before do
+        Capybara::Accessible::Auditor.log_level = :warn
+      end
+
+      it 'puts to stdout and does not raise an error' do
+        $stdout.should_receive(:puts)
+        expect { @session.visit('/inaccessible') }.to_not raise_error
+      end
+    end
+
+    context 'a page with a javascript popup' do
+      it 'does not raise an exception' do
+        @session.visit('/alert')
+        expect { @session.click_link('Alert!') }.to_not raise_error
+      end
     end
   end
 end

metadata

@@ -1,126 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: capybara-accessible
 version: !ruby/object:Gem::Version
-  version: 0.1.8
-  prerelease: 
+  version: 0.1.9
 platform: ruby
 authors:
 - Case Commons
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-20 00:00:00.000000000 Z
+date: 2013-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: tddium
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Capybara extension and webdriver for automated accessibility testing
@@ -151,27 +136,26 @@ files:
 homepage: https://github.com/Casecommons/capybara-accessible
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.19
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Selenium based webdriver and Capybara extension that runs Google Accessibility
   Developer Tools auditing assertions on page visits.
 test_files: