RubyGems - bbc-a11y - Versions diffs - 0.1.2 → 0.2.0 - Mend

bbc-a11y 0.1.2 → 0.2.0

Files changed (120) hide show

checksums.yaml +4 -4
data/.travis.yml +9 -0
data/CONTRIBUTING.md +70 -8
data/GETTINGSTARTED.md +65 -0
data/LICENSE +1 -1
data/README.md +12 -55
data/Rakefile +1 -1
data/a11y.rb +1 -3
data/bbc-a11y.gemspec +0 -1
data/features/check_standards/01_core_purpose.feature +39 -0
data/features/check_standards/02_validation.feature +1 -0
data/features/check_standards/03_progressive_enhancement.feature +3 -0
data/features/check_standards/{language.feature → 04_indicating_language.feature} +2 -2
data/features/check_standards/05_page_titles.feature +1 -0
data/features/check_standards/{main_landmark.feature → 06_main_landmark.feature} +6 -6
data/features/check_standards/07_headings.feature +222 -0
data/features/check_standards/{minimum_text_size.feature → 08_minimum_text_size.feature} +22 -2
data/features/check_standards/09_resizable_text.feature +2 -0
data/features/check_standards/{tab_index.feature → 10_tab_index.feature} +7 -7
data/features/check_standards/{title_attribute.feature → 11_title_attributes.feature} +13 -5
data/features/check_standards/{focusable_controls.feature → 12_focusable_controls.feature} +4 -4
data/features/check_standards/13_visible_on_focus.feature +1 -0
data/features/check_standards/14_control_styles.feature +1 -0
data/features/check_standards/15_focus_styles.feature +1 -0
data/features/check_standards/16_colour_contrast.feature +1 -0
data/features/check_standards/17_colour_and_meaning.feature +1 -0
data/features/check_standards/{image_alt.feature → 18_image_alternatives.feature} +5 -5
data/features/check_standards/{form_labels.feature → 19_form_labels.feature} +7 -7
data/features/check_standards/{form_interactions.feature → 20_form_interactions.feature} +6 -6
data/features/check_standards/21_tables.feature +1 -0
data/features/cli/display_failing_result.feature +14 -1
data/features/cli/display_result_summary.feature +15 -1
data/features/cli/provide_muting_tips.feature +1 -1
data/features/cli/skipping_standards.feature +1 -1
data/features/mute_errors.feature +2 -2
data/features/step_definitions/steps.rb +10 -9
data/features/support/web_server.rb +0 -11
data/features/support/web_server/blank.html +7 -0
data/features/support/web_server/two_headings_failures.html +11 -0
data/karma.conf.js +1 -1
data/lib/bbc/a11y/cli.rb +33 -6
data/lib/bbc/a11y/js/bundle.js +139 -89
data/lib/bbc/a11y/js/standards.js +67 -20
data/lib/bbc/a11y/js/standards/{anchorsMustHaveHrefs.js → focusableControls/anchorsMustHaveHrefs.js} +0 -0
data/lib/bbc/a11y/js/standards/{formsMustHaveSubmitButtons.js → formInteractions/formsMustHaveSubmitButtons.js} +0 -0
data/lib/bbc/a11y/js/standards/{fieldsMustHaveLabelsOrTitles.js → formLabels/fieldsMustHaveLabelsOrTitles.js} +0 -0
data/lib/bbc/a11y/js/standards/headings/contentMustFollowHeadings.js +18 -0
data/lib/bbc/a11y/js/standards/{exactlyOneMainHeading.js → headings/exactlyOneMainHeading.js} +1 -1
data/lib/bbc/a11y/js/standards/{headingsMustBeInAscendingOrder.js → headings/headingsMustBeInAscendingOrder.js} +0 -0
data/lib/bbc/a11y/js/standards/{imagesMustHaveAltAttributes.js → imageAlternatives/imagesMustHaveAltAttributes.js} +0 -0
data/lib/bbc/a11y/js/standards/{htmlMustHaveLangAttribute.js → indicatingLanguage/htmlMustHaveLangAttribute.js} +0 -0
data/lib/bbc/a11y/js/standards/{exactlyOneMainLandmark.js → mainLandmark/exactlyOneMainLandmark.js} +0 -0
data/lib/bbc/a11y/js/standards/{minimumTextSize.js → minimumTextSize/textCannotBeTooSmall.js} +3 -3
data/lib/bbc/a11y/js/standards/{elementsWithZeroTabIndexMustBeFields.js → tabIndex/elementsWithZeroTabIndexMustBeFields.js} +0 -0
data/lib/bbc/a11y/js/standards/{titleAttributesOnlyOnInputs.js → titleAttributes/titleAttributesOnlyOnInputs.js} +1 -1
data/lib/bbc/a11y/linter.rb +16 -4
data/lib/bbc/a11y/runner.rb +0 -1
data/lib/bbc/a11y/string_colours.rb +15 -0
data/lib/bbc/a11y/version +1 -1
data/package.json +3 -0
data/spec/bbc/a11y/js/a11ySpec.js +15 -6
data/spec/bbc/a11y/js/minimumTextSizeStandardSpec.js +25 -0
data/spec/bbc/a11y/js/standardsSpec.js +6 -6
data/spec/bbc/a11y/string_colours_spec.rb +13 -0
metadata +68 -102
data/circle.yml +0 -3
data/examples/bbc-pages/Gemfile +0 -3
data/examples/bbc-pages/Rakefile +0 -3
data/examples/bbc-pages/a11y.rb +0 -2
data/examples/local-web-app/Gemfile +0 -4
data/examples/local-web-app/Rakefile +0 -3
data/examples/local-web-app/a11y.rb +0 -52
data/examples/local-web-app/config.ru +0 -1
data/examples/local-web-app/public/missing_header.html +0 -13
data/examples/local-web-app/public/perfect.html +0 -14
data/examples/local-web-app/readme.md +0 -0
data/features/check_standards/headings.feature +0 -153
data/lib/bbc/a11y/js/standards/contentMustFollowHeadings.js +0 -15
data/lib/bbc/a11y/standards.rb +0 -45
data/lib/bbc/a11y/standards/anchor_hrefs.rb +0 -18
data/lib/bbc/a11y/standards/content_follows_headings.rb +0 -22
data/lib/bbc/a11y/standards/exactly_one_main_heading.rb +0 -25
data/lib/bbc/a11y/standards/exactly_one_main_landmark.rb +0 -20
data/lib/bbc/a11y/standards/form_labels.rb +0 -39
data/lib/bbc/a11y/standards/form_submit_buttons.rb +0 -21
data/lib/bbc/a11y/standards/heading_hierarchy.rb +0 -34
data/lib/bbc/a11y/standards/image_alt.rb +0 -18
data/lib/bbc/a11y/standards/language_attribute.rb +0 -19
data/lib/bbc/a11y/standards/tab_index.rb +0 -22
data/lib/bbc/a11y/standards/title_attribute.rb +0 -31
data/standards/01_core-purpose.md +0 -24
data/standards/02_validation.feature +0 -31
data/standards/03_javascript.feature +0 -40
data/standards/04_language.feature +0 -58
data/standards/05_page_title.feature +0 -45
data/standards/06_main_landmark.feature +0 -24
data/standards/07_headings.feature +0 -65
data/standards/08_title_attribute.feature +0 -71
data/standards/09_tabindex.feature +0 -51
data/standards/10_form_labels.feature +0 -88
data/standards/11_visible-on-focus.md +0 -58
data/standards/13_colour-contrast.md +0 -27
data/standards/14_colour-meaning.md +0 -19
data/standards/15_focusable-controls.md +0 -45
data/standards/16_table.md +0 -109
data/standards/17_control-styles.md +0 -78
data/standards/18_focus-styles.md +0 -36
data/standards/19_form-interactions.md +0 -33
data/standards/20_image-alt.md +0 -34
data/standards/21_min-font-sizes.md +0 -64
data/standards/22_resize-zoom.md +0 -80
data/standards/step_definitions/core_content_steps.rb +0 -3
data/standards/step_definitions/form_steps.rb +0 -6
data/standards/step_definitions/language_steps.rb +0 -21
data/standards/step_definitions/page_steps.rb +0 -50
data/standards/step_definitions/w3c_steps.rb +0 -7
data/standards/support/capybara.rb +0 -53
data/standards/support/skipper.rb +0 -5
data/standards/support/world.rb +0 -3
data/standards/support/world_extender.rb +0 -5

data/lib/bbc/a11y/standards/form_submit_buttons.rb DELETED

@@ -1,21 +0,0 @@
-module BBC
-  module A11y
-    module Standards
-      class FormSubmitButtons
-        def initialize(page)
-          @page = page
-        end
-        def call(errors)
-          @page.all("form").each do |form|
-            submits = form.all("input[type=submit], button[type=submit]")
-            if submits.empty?
-              errors << "Form has no submit button: #{form.path}"
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/bbc/a11y/standards/heading_hierarchy.rb DELETED

@@ -1,34 +0,0 @@
-module BBC
-  module A11y
-    module Standards
-      class HeadingHierarchy
-        def initialize(page)
-          @page = page
-        end
-        def call(errors)
-          heading_levels.each_cons(2).each do |pair|
-            if pair.last > pair.first + 1
-              errors << "Headings are not in order: " +
-                        "h#{pair.first} is followed by h#{pair.last}"
-            end
-          end
-        end
-        private
-        def headings
-          @page.all('h1, h2, h3, h4, h5, h6', visible: false)
-        end
-        def heading_levels
-          headings.map do |heading|
-            heading.tag_name[1].to_i
-          end
-        end
-      end
-    end
-  end
-end

data/lib/bbc/a11y/standards/image_alt.rb DELETED

@@ -1,18 +0,0 @@
-module BBC
-  module A11y
-    module Standards
-      class ImageAlt
-        def initialize(page)
-          @page = page
-        end
-        def call(errors)
-          @page.all("img:not([alt])").each do |img|
-            errors << "Image has no alt attribute (src=\"#{img['src']}\")"
-          end
-        end
-      end
-    end
-  end
-end

data/lib/bbc/a11y/standards/language_attribute.rb DELETED

@@ -1,19 +0,0 @@
-module BBC
-  module A11y
-    module Standards
-      class LanguageAttribute
-        def initialize(page)
-          @page = page
-        end
-        def call(errors)
-          @page.all("html:not([lang])").each do |html|
-            errors << "The main language must be specified. " +
-                      "<html> tag has no lang attribute."
-          end
-        end
-      end
-    end
-  end
-end

data/lib/bbc/a11y/standards/tab_index.rb DELETED

@@ -1,22 +0,0 @@
-module BBC
-  module A11y
-    module Standards
-      class TabIndex
-        def initialize(page)
-          @page = page
-        end
-        def call(errors)
-          offenders = @page.all("*[tabindex='0']").reject { |el|
-            ['input', 'button', 'select', 'textarea', 'a'].include? el.tag_name
-          }
-          offenders.each do |el|
-            errors << "tabindex=\"0\" must not be used on <#{el.tag_name}> " +
-                      "elements (not focusable by default)"
-          end
-        end
-      end
-    end
-  end
-end

data/lib/bbc/a11y/standards/title_attribute.rb DELETED

@@ -1,31 +0,0 @@
-module BBC
-  module A11y
-    module Standards
-      class TitleAttribute
-        def initialize(page)
-          @page = page
-        end
-        def call(errors)
-          @page.all("[title]").each do |element|
-            unless form_input? element
-              errors << "Element (not a form input) has a title " +
-                        "attribute: #{element.path}"
-            end
-          end
-        end
-        private
-        def form_input?(element)
-          form_input_tags.include? element.tag_name.downcase
-        end
-        def form_input_tags
-          ['input', 'button', 'select', 'textarea']
-        end
-      end
-    end
-  end
-end

data/standards/01_core-purpose.md DELETED

@@ -1,24 +0,0 @@
-# The core purpose of every document must be defined
-Before design and implementation of a document or feature its core purpose **must** be defined.
-## Definitions
-### Core purpose
-The functionality to inform, educate, and entertain without which there would be no purpose for site or document.
-## Rationale
-While our aim is for all users to have access to all features of BBC apps and sites we recognise that technology both restricts and extends what is possible.
-Additionally GEL is aimed providing the best experience to the broadest range of users, and while it should not discriminate against users with access needs nor does it give special privilege.
-The aim of this guideline is to provide the most accessible base line experience for the core purpose across the broadest range of technology.
-See the following standards for examples of when a defined core purpose is applicable:
-- [Core experience must not rely on JavaScript or CSS]()
-- [Minimum text size]()
-It is **not** a reason to ignore accessibility for non-core page elements.

data/standards/02_validation.feature DELETED

@@ -1,31 +0,0 @@
-Feature: HTML Validation
-  All documents **must** have a [W3C recommended Doctype](http://www.w3.org/QA/2002/04/valid-dtd-list.html) and
-  all Markup **must** validate against that Doctype.
-  Rationale
-  =========
-  While assistive technologies such as screen readers generally do a good job of interpreting
-  invalid HTML there will be less risk of problems arising if the document follows a recognised
-  standard Doctype.
-  Techniques
-  ==========
-  Pass:
-      <!DOCTYPE html>
-      <html lang="en-GB">
-  Fail:
-      <html lang="en-GB">
-  Scenario: Submit to W3C validation Service
-    See http://validator.w3.org
-    When I submit the page to the W3C Markup Validation Service
-    Then there should be no errors

data/standards/03_javascript.feature DELETED

@@ -1,40 +0,0 @@
-Feature: JavaScript
-  Core experience must not rely on JavaScript
-  The core purpose of every document **must** be defined.
-  The core content of every document must not require JavaScript to be added to the DOM
-  Rationale
-  =========
-  We aim to provide a core experience to as broad an audience as possible, allowing
-  users to choose the software and devices that work best for them in a broad range of circumstances.
-  Equally a robust site or application in the more traditional sense minimises its dependencies.
-  The minimum dependency for a web site should be an internet connection and the ability to parse HTML.
-  For this reason all BBC documents must enable their core purpose without relying on CSS or JavaScript.
-  CSS and JavaScript can, and should, be used to enhance the user experience beyond this basic level.
-  For example, a ‘live’ page has a core purpose to provide the latest content about an event to the user.
-  The core experience is the latest content at the time of the request. The experience enhanced with
-  JavaScript automatically updates this content without the user having to take action.
-  Definitions
-  ===========
-  *Core content* - The content that is provided to users without JavaScript.
-  Notes
-  =====
-  This is going to have to be a product specific test. Can we provide a template for this test,
-  perhaps looking for elements based on provided selectors and make sure they are in the document?
-  @manual
-  Scenario: View the page with JavaScript disabled
-    When I view the page with JavaScript disabled
-    Then all core content is available in the DOM

data/standards/04_language.feature DELETED

@@ -1,58 +0,0 @@
-Feature: Specify content language
-  The main language of the page _must_ be specified.
-  Changes to language within the page **must** be indicated.
-  Rationale
-  =========
-  Assistive technologies such as screen readers have support for different languages,
-  allowing for appropriate pronunciation.
-  Techniques
-  ==========
-  Pass:
-  ```
-  <!DOCTYPE html>
-  <html lang="en-GB">
-  <head>
-    <title>Language techniques</title>
-  </head>
-  <body>
-    <h1>Techniques for language in HTML</h1>
-    <p><span lang="es">Cinco de Mayo</span> is Spanish for "fifth of May"</p>
-  </body>
-  </html>
-  ```
-  Fail:
-  ```
-  <!DOCTYPE html>
-  <html>
-  <head>
-    <title>Language techniques</title>
-  </head>
-  <body>
-    <h1>Techniques for language in HTML</h1>
-    <p>Cinco de Mayo is Spanish for "fifth of May"</p>
-  </body>
-  </html>
-  ```
-  Scenario: Check main body element lang attribute
-    When I visit the page
-    Then the <html> element must have a `lang` attribute
-    And the main natural language of the page must match that attribute
-  Scenario: Check for other elements with lang attributes
-    When I visit the page
-    Then all elements with `lang` attribute must have content in that natural language
-  @manual
-  Scenario: Check for areas of the page expressed in other languages, but missing a `lang` attribute
-    When I visit the page
-    Then any parts expressed in a natural language different to the main language of the page must have a matching `lang` attribute

data/standards/05_page_title.feature DELETED

@@ -1,45 +0,0 @@
-Feature: Page title
-  A document **must** have a unique page `<title>` that identifies its main content.
-  Rationale
-  =========
-  Document titles help users orientate themselves within web sites and apps. The document `<title>` element
-  content is often the first thing a speech output user will hear and acts as a confirmation of what page they
-  have arrived at. Document titles commonly have the same content as the main `<h1>` element.
-  Techniques
-  ==========
-  Pass:
-    <title>BBC Weather</title>
-  Fail:
-    <title>BBC</title>
-  @manual
-  Scenario: Check the title
-    We can't easily test for the uniqueness of the title, but we can test for the presence of the element
-    and ensure it has content.
-    In terms of prompting for manual tests, could we compare the title element with the content of the first
-    `<h1>` element on the page, and if the former contains the latter then automatically pass the test.
-    For example:
-        <title>BBC Weather - Weather in London</title>
-        ~
-        <h1>Weather in London</h1>
-    ...would pass automatically, but a `<title>` element that does not contain the string 'Weather in London'
-    would be flagged for manual review.
-    When I visit the page
-    Then the document should have a title
-    And the title should describe the primary content of the document

data/standards/06_main_landmark.feature DELETED

@@ -1,24 +0,0 @@
-Feature: Main landmark
-  A page **must** have exactly one element with `role="main"`
-  Rationale
-  =========
-  The WAI-ARIA `main` landmark role can be help keyboard users with assistive technologies such as screen readers (and in the future as native browser functionality) to skip directly to the main content of a page, bypassing navigation and other contents that might be before it.
-  Techniques
-  ==========
-  Pass:
-    <div role="main" id="main-content"></div>
-  Fail:
-    <div id="main-content"></div>
-  Scenario: Check for a single main element
-    When I visit the page
-    Then there should be exactly one element with `role="main"`

data/standards/07_headings.feature DELETED

@@ -1,65 +0,0 @@
-Feature: Correctly use headings
-  A document **must** have exactly one `<h1>` element.
-  Heading levels after the document `<h1>` element **must** be sequential and **must not** skip heading levels.
-  Heading elements **must** be followed by content.
-  Rationale
-  =========
-  A logical heading structure is invaluable for users of screen readers and similar assistive technologies to help navigate content.
-  Users should be able to use the document's `<h1>` identify its main content. Documents should have one main subject.
-  Heading levels should not be skipped as a predictable document outline is an important factor for understandability.
-  Headings should not be used for non-heading purposes, i.e. to identify blocks of content. A heading should always
-  be followed either by non-heading content or by a heading of one level deeper.
-  Techniques
-  ==========
-  Pass:
-    <div role="main">
-      <h1>Main page content</h1>
-      <p>Lorem ipsum…</p>
-      <h2>Secondary content</h2>
-      <h3>Tertiary content one</h2>
-      <ul>
-        <li>Lorem</li>
-      </ul>
-      <h3>Tertiary content two</h3>
-      <ul>
-        <li>Ipsum</li>
-      </ul>
-    </div>
-  Fail:
-    <div role="main">
-      <h3>Main content</h3>
-      <h2>Secondary content</h2>
-      <h2>Tertiary content</h2>
-      <p>Lorem ipsum…</p>
-    </div>
-  Notes
-  =====
-  For the second test, can we check the next text node after each heading and test that it is
-  either not part of a heading element, or is part of a heading level of one level higher?
-  Questions
-  =========
-  1. Clarify the note, above!
-  2. Presumably it's OK for the hierarchy to jump *up* by more than 1? e.g. h1, h2, h3, h4, h2 is ok?
-  Scenario: Check headings
-    When I visit the page
-    Then there must be exactly one h1 element
-    And each heading must be followed by content or a heading of one level deeper (h2-h6)