bbc-a11y 0.0.9 → 0.0.11

data/lib/bbc/a11y/cucumber_support/page.rb

@@ -19,6 +19,13 @@ module BBC
           browser.title
         end
 
+        def all_elements_matching(*selectors)
+          results = selectors.map { |selector| browser.all(selector) }
+          # A Capybara::Result looks like an array, but it's not. Turn them into plain
+          # old nodes
+          results.map { |result| result.map { |element| element } }.flatten
+        end
+
         def must_have_lang_attribute
           expect(browser).to have_css('html[lang]')
         end
@@ -57,12 +64,15 @@ module BBC
           expect(bad_nodes).to be_empty
         end
 
-        def must_not_have_any_positive_tabindex_values
-          nodes_with_positive_tabindex = browser.all('[tabindex]').select { |node| node['tabindex'].to_i > 0 }
-          expect(nodes_with_positive_tabindex).to be_empty
-          nodes_with_zero_tabindex     = browser.all('[tabindex]').select { |node| node['tabindex'].to_i == 0 }
-          bad_nodes_with_zero_tabindex = nodes_with_zero_tabindex.reject { |node| node.tag_name =~ /^a|button|input|select|textarea$/ }
-          expect(bad_nodes_with_zero_tabindex).to be_empty
+        def must_not_have_any_elements_with_tabindex_greater_than(max)
+          bad_nodes = browser.all('[tabindex]').select { |node| node['tabindex'].to_i > max }
+          expect(bad_nodes).to be_empty
+        end
+
+        def must_not_have_elements_with_tabindex(tabindex, except: [])
+          nodes_with_tabindex = browser.all('[tabindex]').select { |node| node['tabindex'].to_i == tabindex }
+          bad_nodes = nodes_with_tabindex.reject { |node| except.include? node.tag_name }
+          expect(bad_nodes).to be_empty
         end
 
         def to_s

data/lib/bbc/a11y/version

@@ -1 +1 @@
-0.0.9
+0.0.11

data/spec/bbc/a11y/cli_spec.rb

@@ -0,0 +1,27 @@
+require 'bbc/a11y/cli'
+
+module BBC
+  module A11y
+    describe CLI do
+      it "uses a single URL from the CLI args if given" do
+        runner = double
+        expect(runner).to receive(:new) do |settings, cucumber_args|
+          expect(settings.pages.length).to eq 1
+          expect(settings.pages[0].url).to eq "http://foo.com"
+          double(call: nil)
+        end
+        CLI.new(double, double, double, ["http://foo.com"]).call(runner)
+      end
+
+      it "splits a11y and cucumber args" do
+        runner = double
+        expect(runner).to receive(:new) do |settings, cucumber_args|
+          expect(settings.pages.length).to eq 1
+          expect(cucumber_args).to eq ["--tags", "~@wip"]
+          double(call: nil)
+        end
+        CLI.new(double, double, double, ["http://foo.com", "--", "--tags", "~@wip"]).call(runner)
+      end
+    end
+  end
+end

data/spec/bbc/a11y/configuration_spec.rb

@@ -19,15 +19,27 @@ module BBC::A11y
       expect(BBC::A11y.configuration.pages[1].url).to eq "two.html"
     end
 
-    it "allows you to specify scenarios to be skipped for a given page" do
+    it "allows you to specify scenarios to be skipped for a given page (using regexp)" do
       BBC::A11y.configure do
         page "three.html" do
-          skip_scenario /^foo/
+          skip_scenario /javascript/
+        end
+      end
+
+      page_settings = BBC::A11y.configuration.pages[0]
+      test_case = double(name: "View the page with javascript disabled")
+      expect(page_settings.skip_test_case?(test_case)).to be_truthy
+    end
+
+    it "allows you to specify scenarios to be skipped for a given page (using string)" do
+      BBC::A11y.configure do
+        page "three.html" do
+          skip_scenario "javascript"
         end
       end
 
       page_settings = BBC::A11y.configuration.pages[0]
-      test_case = double(name: "foo_page.html")
+      test_case = double(name: "View the page with javascript disabled")
       expect(page_settings.skip_test_case?(test_case)).to be_truthy
     end
 

data/spec/bbc/a11y/cucumber_support/matchers_spec.rb

@@ -0,0 +1,52 @@
+require 'bbc/a11y/cucumber_support/matchers'
+require 'capybara'
+
+module BBC::A11y::CucumberSupport
+  describe 'matchers' do
+    let(:page) do
+      Capybara.string(html)
+    end
+
+    describe '#have_title_attribute_or_associated_label_tag' do
+      context 'a form field with a title attribute' do
+        let(:element) { Capybara.string(<<-HTML).find('input') }
+        <input type="text" name="q" title="Search the BBC" />
+        HTML
+        it 'passes' do
+          expect(element).to have_title_attribute_or_associated_label_tag
+        end
+      end
+
+      context 'a form field with a label, associated by `for` attribute' do
+        let(:element) { Capybara.string(<<-HTML).find('input') }
+        <label for="search">Search the BBC</label>
+        <input type="text" id="search" name="q" />
+        HTML
+        it 'passes' do
+          expect(element).to have_title_attribute_or_associated_label_tag
+        end
+      end
+
+      context 'a form field within a label' do
+        let(:element) { Capybara.string(<<-HTML).find('input') }
+        <label for="search">
+          Search the BBC
+          <input type="text" name="q" />
+        </label>
+        HTML
+        it 'passes' do
+          expect(element).to have_title_attribute_or_associated_label_tag
+        end
+      end
+
+      context "a form field without associated label tag or title attribute" do
+        let(:element) { Capybara.string(<<-HTML).find('input') }
+        <input type="text" name="name" />
+        HTML
+        it 'fails' do
+          expect(element).not_to have_title_attribute_or_associated_label_tag
+        end
+      end
+    end
+  end
+end

data/spec/bbc/a11y/cucumber_support/page_spec.rb

@@ -7,6 +7,22 @@ module BBC::A11y::CucumberSupport
       Page.new(Capybara.string(html))
     end
 
+    describe '#all_elements_matching' do
+      context 'with multiple matches' do
+        let(:html) { <<-HTML }
+        <html>
+          <ul>
+            <li><p></li>
+            <li></li>
+          </ul>
+        </html>
+        HTML
+        it 'returns each element that matches' do
+          expect(page.all_elements_matching('li', 'p').length).to eq 3
+        end
+      end
+    end
+
     describe '#must_have_lang_attribute' do
       context 'with no lang attribute' do
         let(:html) { <<-HTML }
@@ -101,8 +117,8 @@ module BBC::A11y::CucumberSupport
       end
     end
 
-    describe "#must_not_have_any_positive_tabindex_values" do
-      context "a positive tabindex value" do
+    describe "#must_not_have_any_elements_with_tabindex_greater_than" do
+      context "an element with a tabindex value of 1" do
         let(:html) { <<-HTML }
         <html>
           <body>
@@ -111,13 +127,21 @@ module BBC::A11y::CucumberSupport
         </html>
         HTML
 
-        it "fails" do
-          expect { page.must_not_have_any_positive_tabindex_values }.
+        it "fails for zero" do
+          expect { page.must_not_have_any_elements_with_tabindex_greater_than 0 }.
+            to raise_error(RSpec::Expectations::ExpectationNotMetError)
+        end
+
+        it "passes for 1" do
+          expect { page.must_not_have_any_elements_with_tabindex_greater_than 0 }.
             to raise_error(RSpec::Expectations::ExpectationNotMetError)
         end
       end
+    end
+
+    describe "#must_not_have_elements_with_tabindex" do
 
-      context "a zero tabindex value on a focusable element (<a>, <button>, <input>, <select>, <textarea>)" do
+      context "an element that's in the list of exceptions" do
         let(:html) { <<-HTML }
         <html>
           <body>
@@ -127,11 +151,11 @@ module BBC::A11y::CucumberSupport
         HTML
 
         it "passes" do
-          expect { page.must_not_have_any_positive_tabindex_values }.not_to raise_error
+          expect { page.must_not_have_elements_with_tabindex(0, except: 'a') }.not_to raise_error
         end
       end
 
-      context "a zero tabindex value on a non-focusable element" do
+      context "an element not in the list of exceptions" do
         let(:html) { <<-HTML }
         <html>
           <body>
@@ -141,12 +165,12 @@ module BBC::A11y::CucumberSupport
         HTML
 
         it "fails" do
-          expect { page.must_not_have_any_positive_tabindex_values }.
+          expect { page.must_not_have_elements_with_tabindex(0, except: 'a') }.
             to raise_error(RSpec::Expectations::ExpectationNotMetError)
         end
       end
 
-      context "a negative tabindex value" do
+      context "a different tabindex value" do
         let(:html) { <<-HTML }
         <html>
           <body>
@@ -156,7 +180,7 @@ module BBC::A11y::CucumberSupport
         HTML
 
         it "passes" do
-          expect { page.must_not_have_any_positive_tabindex_values }.not_to raise_error
+          expect { page.must_not_have_elements_with_tabindex(0, except: 'a') }.not_to raise_error
         end
       end
     end

data/{features → standards}/09_tabindex.feature

@@ -41,4 +41,11 @@ Feature: Correctly use `tabindex` attributes
 
   Scenario: Check all tabindex values
     When I visit the page
-    Then there should be no elements with a tabindex attribte of 0 or greater
+    Then there should be no elements with a tabindex attribte of 1 or greater
+    And there should be no elements with a tabindex attribute of 0 except for:
+      | a        |
+      | button   |
+      | input    |
+      | select   |
+      | textarea |
+

data/standards/10_form_labels.feature

@@ -0,0 +1,88 @@
+Feature: Correctly use form labels
+
+  Form fields that allow input (`select`, and `textarea` elements, and all 
+  `input` element types other than image, submit, reset, button, or hidden) 
+  **must** have an associated label, either in the form of a `<label>` element 
+  or, for simple forms when no visible label is required, a `title` attribute.
+  
+  Rationale
+  ---------
+  
+  Form labels are important for all users in order to understand what the form 
+  field is however they are essential for speech output users who cannot easily 
+  infer what the form element is by looking at the surrounding content.
+  
+  While there are WAI-ARIA attributes that allow for labelling of forms it is 
+  not supported in all versions of assistive technologies that BBC users could 
+  reasonably expect to be able to use.
+  
+  Techniques
+  ----------
+  
+  Pass:
+  
+  ```
+  <label for="search">Search the BBC</label>
+  <input type="text" id="search" name="q" />
+  
+  <label for="search">
+    Search the BBC
+    <input type="text" name="q" />
+  </label>
+  
+  <input type="text" name="q" title="Search the BBC" />
+  ```
+  
+  Fail:
+  
+  ```
+  <input type="text" name="name" title="Name" />
+  <input type="text" name="email" title="Email" />
+  
+  <input type="text" name="q" value="Search the BBC" />
+  
+  <input type="text" name="q" aria-label="Search the BBC" />
+  
+  <input type="text" name="q" placeholder="Search the BBC" />
+  ```
+  
+  Tests
+  -----
+..
+  | Procedure | Expected Result | Type | 
+  | --------- | --------------- | ---- |
+  | Use WAVE Toolbar (or similar) to identify accessibility errors errors | There must be no 'ERROR: Form label missing' or 'ARIA label or description' messages | Tool |
+  | Check every `select`, and `textarea` elements, and all `input` element types other than image, submit, reset, button, or hidden | Every element must have either an associated `<label>` or a title attribute | Manual / Automated |
+..
+  Notes
+  -----
+..
+  Hopefully the second test can be automated. Associated labels are those that 
+  wrap the element (`<label>Foo <input type="text" /></label>`) and those that 
+  have a `for` attribute value that matches the `id` attribute of a field element 
+  (`<label for="foo">Bar</label><input type="text" id="foo" />`). In the second 
+  case the `<label>` can wrap the form element, but does not have to.
+
+  Scenario: Validate use of labels
+    When I visit the page
+    Then the following form elements must have a title attribute or associated label tag:
+      | select                     |
+      | textarea                   |
+      | input[type=checkbox]       |
+      | input[type=color]          |
+      | input[type=date]           |
+      | input[type=datetime]       |
+      | input[type=datetime-local] |
+      | input[type=email]          |
+      | input[type=file]           |
+      | input[type=month]          |
+      | input[type=number]         |
+      | input[type=password]       |
+      | input[type=radio]          |
+      | input[type=range]          |
+      | input[type=search]         |
+      | input[type=tel]            |
+      | input[type=text]           |
+      | input[type=time]           |
+      | input[type=url]            |
+      | input[type=week]           |

data/standards/step_definitions/form_steps.rb

@@ -0,0 +1,6 @@
+Then(/^the following form elements must have a title attribute or associated label tag:$/) do |table|
+  selectors = table.raw.flatten
+  page.all_elements_matching(*selectors).each do |element|
+    expect(element).to have_title_attribute_or_associated_label_tag
+  end
+end

data/{features → standards}/step_definitions/page_steps.rb

@@ -41,6 +41,10 @@ Then(/^any form fields with associated labels do not have a title attribute$/) d
   page.must_have_no_form_fields_with_label_and_title
 end
 
-Then(/^there should be no elements with a tabindex attribte of 0 or greater$/) do
-  page.must_not_have_any_positive_tabindex_values
+Given(/^there should be no elements with a tabindex attribte of (\d+) or greater$/) do |max_tabindex|
+  page.must_not_have_any_elements_with_tabindex_greater_than max_tabindex.to_i
+end
+
+Given(/^there should be no elements with a tabindex attribute of (\d+) except for:$/) do |tabindex, elements|
+  page.must_not_have_elements_with_tabindex(tabindex.to_i, except: elements.raw.flatten)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bbc-a11y
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.11
 platform: ruby
 authors:
 - Matt Wynne
@@ -9,146 +9,146 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-10 00:00:00.000000000 Z
+date: 2015-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.0.rc
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.0.rc
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: poltergeist
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: w3c_validators
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: cld
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A tool for testing the compliance of web URLs against the BBC's accessibilty
@@ -159,7 +159,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .rspec
+- ".rspec"
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
@@ -177,105 +177,101 @@ files:
 - examples/local-web-app/public/missing_header.html
 - examples/local-web-app/public/perfect.html
 - examples/local-web-app/readme.md
-- features/01_core-purpose.md
-- features/02_validation.feature
-- features/03_javascript.feature
-- features/04_language.feature
-- features/05_page_title.feature
-- features/06_main_landmark.feature
-- features/07_headings.feature
-- features/08_title_attribute.feature
-- features/09_tabindex.feature
-- features/10_form-labels.md
-- features/11_visible-on-focus.md
-- features/13_colour-contrast.md
-- features/14_colour-meaning.md
-- features/15_focusable-controls.md
-- features/16_table.md
-- features/17_control-styles.md
-- features/18_focus-styles.md
-- features/19_form-interactions.md
-- features/20_image-alt.md
-- features/21_min-font-sizes.md
-- features/22_resize-zoom.md
-- features/step_definitions/core_content_steps.rb
-- features/step_definitions/language_steps.rb
-- features/step_definitions/page_steps.rb
-- features/step_definitions/w3c_steps.rb
-- features/support/capybara.rb
-- features/support/skipper.rb
-- features/support/world.rb
-- features/support/world_extender.rb
+- features/README.md
+- features/exit_status.feature
+- features/specify_url_via_cli.feature
+- features/specify_url_via_config.feature
+- features/step_definitions/steps.rb
+- features/support/env.rb
+- features/support/web_server.rb
+- features/support/web_server/missing_header.html
+- features/support/web_server/perfect.html
 - lib/bbc/a11y.rb
 - lib/bbc/a11y/cli.rb
 - lib/bbc/a11y/configuration.rb
 - lib/bbc/a11y/cucumber_runner.rb
 - lib/bbc/a11y/cucumber_support.rb
+- lib/bbc/a11y/cucumber_support/disabled_w3c.rb
 - lib/bbc/a11y/cucumber_support/heading_hierarchy.rb
 - lib/bbc/a11y/cucumber_support/language_detector.rb
+- lib/bbc/a11y/cucumber_support/matchers.rb
 - lib/bbc/a11y/cucumber_support/page.rb
 - lib/bbc/a11y/cucumber_support/per_page_checks.rb
 - lib/bbc/a11y/cucumber_support/w3c.rb
 - lib/bbc/a11y/version
+- spec/bbc/a11y/cli_spec.rb
 - spec/bbc/a11y/configuration_spec.rb
 - spec/bbc/a11y/cucumber_support/heading_hierarchy_spec.rb
+- spec/bbc/a11y/cucumber_support/matchers_spec.rb
 - spec/bbc/a11y/cucumber_support/page_spec.rb
+- standards/01_core-purpose.md
+- standards/02_validation.feature
+- standards/03_javascript.feature
+- standards/04_language.feature
+- standards/05_page_title.feature
+- standards/06_main_landmark.feature
+- standards/07_headings.feature
+- standards/08_title_attribute.feature
+- standards/09_tabindex.feature
+- standards/10_form_labels.feature
+- standards/11_visible-on-focus.md
+- standards/13_colour-contrast.md
+- standards/14_colour-meaning.md
+- standards/15_focusable-controls.md
+- standards/16_table.md
+- standards/17_control-styles.md
+- standards/18_focus-styles.md
+- standards/19_form-interactions.md
+- standards/20_image-alt.md
+- standards/21_min-font-sizes.md
+- standards/22_resize-zoom.md
+- standards/step_definitions/core_content_steps.rb
+- standards/step_definitions/form_steps.rb
+- standards/step_definitions/language_steps.rb
+- standards/step_definitions/page_steps.rb
+- standards/step_definitions/w3c_steps.rb
+- standards/support/capybara.rb
+- standards/support/skipper.rb
+- standards/support/world.rb
+- standards/support/world_extender.rb
 homepage: https://cucumber.pro
 licenses:
 - MIT
 metadata: {}
 post_install_message: 
 rdoc_options:
-- --charset=UTF-8
+- "--charset=UTF-8"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: bbc-a11y-0.0.9
+summary: bbc-a11y-0.0.11
 test_files:
-- features/01_core-purpose.md
-- features/02_validation.feature
-- features/03_javascript.feature
-- features/04_language.feature
-- features/05_page_title.feature
-- features/06_main_landmark.feature
-- features/07_headings.feature
-- features/08_title_attribute.feature
-- features/09_tabindex.feature
-- features/10_form-labels.md
-- features/11_visible-on-focus.md
-- features/13_colour-contrast.md
-- features/14_colour-meaning.md
-- features/15_focusable-controls.md
-- features/16_table.md
-- features/17_control-styles.md
-- features/18_focus-styles.md
-- features/19_form-interactions.md
-- features/20_image-alt.md
-- features/21_min-font-sizes.md
-- features/22_resize-zoom.md
-- features/step_definitions/core_content_steps.rb
-- features/step_definitions/language_steps.rb
-- features/step_definitions/page_steps.rb
-- features/step_definitions/w3c_steps.rb
-- features/support/capybara.rb
-- features/support/skipper.rb
-- features/support/world.rb
-- features/support/world_extender.rb
+- features/README.md
+- features/exit_status.feature
+- features/specify_url_via_cli.feature
+- features/specify_url_via_config.feature
+- features/step_definitions/steps.rb
+- features/support/env.rb
+- features/support/web_server.rb
+- features/support/web_server/missing_header.html
+- features/support/web_server/perfect.html
+- spec/bbc/a11y/cli_spec.rb
 - spec/bbc/a11y/configuration_spec.rb
 - spec/bbc/a11y/cucumber_support/heading_hierarchy_spec.rb
+- spec/bbc/a11y/cucumber_support/matchers_spec.rb
 - spec/bbc/a11y/cucumber_support/page_spec.rb
 has_rdoc: