bbc-a11y 0.0.15 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17ede39ffd3b5ba558b9981710dd720808ffc5b6
-  data.tar.gz: dc7906e1b703f766942c30cefcbe35c87a30cc10
+  metadata.gz: 8dd9e7e73e7a90b1f1a0151176196f940e149c8e
+  data.tar.gz: f793efc23dc248e5c1261368ea5f5ec0c2ec3e16
 SHA512:
-  metadata.gz: 1a73e2a295bbb009a9d8e1626cee41321903010a3cdb95c52030375bc7b1db665c2cb0cee1e07c52af9ac00cd5c7eff90b2dbf1d35555ea5278a28ddb5410556
-  data.tar.gz: f623f9903f1f290bc2830e802116ece5c323682433f255012f7ce4a93b7156441cddcf99534e0db1730737811150c725d06ca8d3afb742d1eac010700e656884
+  metadata.gz: db950a702d499d56739b17087ee83b69ffd62c0548ee91e9b91d3dfa1e4d8dcfd740505dfcd708803be56690f2913e4994b008c516fefbd79dde54b80720a012
+  data.tar.gz: 9c2706280a6e6767469c2af7c1fea8c6abb1d88288034b02dd4c34742e518eaa22aa3cef34255c2a9505a0349f0d39179d838de090a28e8ff458c8d4f5757535

data/README.md

@@ -4,7 +4,7 @@
 
 This project is still at an experimental / proof-of-concept stage. Please set your expectations appropriately, but *do* [give us as much feedback](https://github.com/cucumber-ltd/bbc-a11y/issues) as you can.
 
-#BBC Accessiblity Standards
+#BBC Accessibility Standards
 
 This tool runs a set of tests against a set of URLs to verify whether each one meets the [BBC accessibility standards](http://www.bbc.co.uk/guidelines/futuremedia/accessibility/).
 

data/features/check_standards/headings.feature

@@ -26,7 +26,7 @@ Feature: Headings
     When I validate the heading standards
     Then it fails with the message:
       """
-      A document must have exactly one heading. Found 0 h1 elements.
+      A document must have exactly one main heading. Found 0 h1 elements.
       """
 
   Scenario: More than one main heading
@@ -39,7 +39,7 @@ Feature: Headings
     When I validate the heading standards
     Then it fails with the message:
       """
-      A document must have exactly one heading. Found 2 h1 elements.
+      A document must have exactly one main heading. Found 2 h1 elements.
       """
 
   Scenario: Headings in ascending order

data/features/check_standards/title_attribute.feature

@@ -0,0 +1,40 @@
+Feature: Correctly use `title` attributes
+
+  `title` attributes **must not** be used for critical information and **must not** repeat content that is already visible and associated with the same control or content.
+
+  Rationale
+  =========
+
+  `title` attributes are inaccessible to keyboard users without additional Assistive Technology. They are dependent on user settings in Screen Readers and similar Assistive Technology.
+
+  Additionally they suffer from discoverability problems: pointing device users are required to hover over page elements and pause before the title tooltip displays, usually with no indication that there is additional content to be displayed.
+
+  Repeating content in visible text and `title` attributes can lead to content clutter and repeated phrases.
+
+  Key recommendations are:
+
+  - Do not use the `title` attribute unless on a form input as title text is not well supported on links on mobile
+  - Do not use `title` attributes and explicit labels together on form fields
+
+  Scenario: Form field with title attribute
+    Given a page with the HTML:
+      """
+      <button type="button" title="Close Button">
+        <img src="close.png" />
+      </button>
+      """
+    When I validate the title attribute standards
+    Then it passes
+
+  Scenario: Anchor tag with title attribute
+    Given a page with the HTML:
+      """
+      <a href="close" title="Close Button">
+        <img src="close.png" />
+      </a>
+      """
+    When I validate the title attribute standards
+    Then it fails with the message:
+      """
+      Element (not a form input) has a title attribute: /html/body/a
+      """

data/features/cli/display_failing_result.feature

@@ -3,8 +3,8 @@ Feature: Display failing result
   Scenario: One standard fails
     Given a website running at http://localhost:54321
     When I run `a11y http://localhost:54321/missing_header.html`
-    Then it should fail with exactly:
+    Then it should fail with:
       """
       ✗ http://localhost:54321/missing_header.html
-        - A document must have exactly one heading. Found 0 h1 elements.
+        - A document must have exactly one main heading. Found 0 h1 elements.
       """

data/features/cli/display_result_summary.feature

@@ -0,0 +1,17 @@
+Feature: Display result summary
+
+  Scenario: Summarises pages checked and standard results
+    Given a website running at http://localhost:54321
+    And a file named "a11y.rb" with:
+      """
+      page "http://localhost:54321/perfect.html"
+      page "http://localhost:54321/missing_header.html"
+      page "http://localhost:54321/missing_header.html?again!" do
+        skip_standard /ExactlyOneMainHeading/
+      end
+      """
+    When I run `a11y`
+    Then it should fail with:
+      """
+      Tested 3 pages, errors: 1, skipped: 1
+      """

data/features/cli/specify_url.feature

@@ -3,7 +3,7 @@ Feature: Specify URL
   Scenario: No config, just pass page URL on command-line
     Given a website running at http://localhost:54321
     When I run `a11y http://localhost:54321/perfect.html`
-    Then it should pass with exactly:
+    Then it should pass with:
       """
       ✓ http://localhost:54321/perfect.html
       """

data/features/mute_errors.feature

@@ -19,7 +19,7 @@ Feature: Mute errors
     When I validate the exactly one main heading standard
     Then it fails with the message:
       """
-      A document must have exactly one heading. Found 0 h1 elements.
+      A document must have exactly one main heading. Found 0 h1 elements.
       """
     When I add a configuration with:
       """

data/lib/bbc/a11y/cli.rb

@@ -1,6 +1,7 @@
 # coding: UTF-8
 require 'bbc/a11y/configuration'
 require 'bbc/a11y/linter'
+require 'bbc/a11y/runner'
 require 'open-uri'
 require 'capybara'
 require 'colorize'
@@ -14,32 +15,29 @@ module BBC
       end
 
       def call
-        all_errors = []
-        settings.pages.each do |page_settings|
-          errors = check_standards_for(page_settings)
-          if errors.empty?
-            stdout.puts "✓ #{page_settings.url}".colorize(:green)
-          else
-            stdout.puts "✗ #{page_settings.url}".colorize(:red)
-            stdout.puts errors.map { |error|
-              "  - #{error}"
-            }.join("\n")
-          end
-          all_errors += errors
-        end
-        exit 1 unless all_errors.empty?
+        Runner.new(settings, self).run
+        exit 1 if @any_errors
       rescue Configuration::ParseError => error
         exit_with_message error.message
       end
 
-      private
+      def page_tested(page_settings, errors)
+        if errors.empty?
+          stdout.puts "✓ #{page_settings.url}".colorize(:green)
+        else
+          stdout.puts "✗ #{page_settings.url}".colorize(:red)
+          stdout.puts errors.map { |error| "  - #{error}" }.join("\n")
+        end
+        stdout.puts ""
+      end
 
-      def check_standards_for(page_settings)
-        standards = Standards.for(page_settings)
-        html = open(page_settings.url).read
-        Linter.new(Capybara.string(html), standards).run.errors.to_a
+      def all_pages_tested(summary)
+        stdout.puts "Tested #{summary.pages} pages, errors: #{summary.errors}, skipped: #{summary.skips}"
+        @any_errors = summary.fail?
       end
 
+      private
+
       def settings
         return Configuration.for_urls(@args) if @args.any?
         configuration_file = File.expand_path("a11y.rb")

data/lib/bbc/a11y/runner.rb

@@ -0,0 +1,48 @@
+require 'bbc/a11y/standards'
+
+module BBC
+  module A11y
+    class Runner
+      def initialize(settings, listener)
+        @settings = settings
+        @listener = listener
+      end
+
+      def run
+        @summary = RunSummary.new
+        @summary.pages = @settings.pages.size
+        @settings.pages.each do |page_settings|
+          errors = check_standards_for(page_settings)
+          @summary.errors += errors.size
+          @listener.page_tested(page_settings, errors)
+        end
+        @listener.all_pages_tested(@summary)
+      end
+
+      private
+
+      def check_standards_for(page_settings)
+        standards = Standards.for(page_settings)
+        @summary.skips += Standards.all.size - standards.size
+        html = open(page_settings.url).read
+        Linter.new(Capybara.string(html), standards).run.errors.to_a
+      end
+
+      class RunSummary
+        def initialize
+          @pages = 0
+          @errors = 0
+          @skips = 0
+        end
+
+        attr_accessor :pages
+        attr_accessor :errors
+        attr_accessor :skips
+
+        def fail?
+          @errors > 0
+        end
+      end
+    end
+  end
+end

data/lib/bbc/a11y/standards.rb

@@ -8,6 +8,7 @@ require 'bbc/a11y/standards/heading_hierarchy'
 require 'bbc/a11y/standards/image_alt'
 require 'bbc/a11y/standards/language_attribute'
 require 'bbc/a11y/standards/tab_index'
+require 'bbc/a11y/standards/title_attribute'
 
 module BBC
   module A11y
@@ -35,7 +36,8 @@ module BBC
           ExactlyOneMainHeading,
           ExactlyOneMainLandmark,
           LanguageAttribute,
-          TabIndex
+          TabIndex,
+          TitleAttribute
         ]
       end
     end

data/lib/bbc/a11y/standards/exactly_one_main_heading.rb

@@ -9,7 +9,7 @@ module BBC
         def call(errors)
           count = @page.all('h1').size
           if count != 1
-            errors << "A document must have exactly one heading." +
+            errors << "A document must have exactly one main heading." +
                       " Found #{count} h1 elements."
           end
         end

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

@@ -0,0 +1,31 @@
+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/lib/bbc/a11y/version

@@ -1 +1 @@
-0.0.15
+0.0.16

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bbc-a11y
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.16
 platform: ruby
 authors:
 - Matt Wynne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2015-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -146,7 +146,9 @@ files:
 - features/check_standards/language.feature
 - features/check_standards/main_landmark.feature
 - features/check_standards/tab_index.feature
+- features/check_standards/title_attribute.feature
 - features/cli/display_failing_result.feature
+- features/cli/display_result_summary.feature
 - features/cli/exit_status.feature
 - features/cli/provide_muting_tips.feature
 - features/cli/report_configuration_errors.feature
@@ -162,6 +164,7 @@ files:
 - lib/bbc/a11y/cli.rb
 - lib/bbc/a11y/configuration.rb
 - lib/bbc/a11y/linter.rb
+- lib/bbc/a11y/runner.rb
 - lib/bbc/a11y/standards.rb
 - lib/bbc/a11y/standards/anchor_hrefs.rb
 - lib/bbc/a11y/standards/content_follows_headings.rb
@@ -173,6 +176,7 @@ files:
 - lib/bbc/a11y/standards/image_alt.rb
 - lib/bbc/a11y/standards/language_attribute.rb
 - lib/bbc/a11y/standards/tab_index.rb
+- lib/bbc/a11y/standards/title_attribute.rb
 - lib/bbc/a11y/version
 - spec/bbc/a11y/cli_spec.rb
 - spec/bbc/a11y/configuration_spec.rb
@@ -230,7 +234,7 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: bbc-a11y-0.0.15
+summary: bbc-a11y-0.0.16
 test_files:
 - features/README.md
 - features/check_standards/focusable_controls.feature
@@ -241,7 +245,9 @@ test_files:
 - features/check_standards/language.feature
 - features/check_standards/main_landmark.feature
 - features/check_standards/tab_index.feature
+- features/check_standards/title_attribute.feature
 - features/cli/display_failing_result.feature
+- features/cli/display_result_summary.feature
 - features/cli/exit_status.feature
 - features/cli/provide_muting_tips.feature
 - features/cli/report_configuration_errors.feature