bbc-a11y 0.1.2 → 0.2.0

data/lib/bbc/a11y/js/standards.js

@@ -5,20 +5,61 @@ function Standards(standards, skipped) {
   this.skipped = skipped;
 }
 
-Standards.all = [
-  require('./standards/anchorsMustHaveHrefs'),
-  require('./standards/contentMustFollowHeadings'),
-  require('./standards/elementsWithZeroTabIndexMustBeFields'),
-  require('./standards/exactlyOneMainHeading'),
-  require('./standards/exactlyOneMainLandmark'),
-  require('./standards/fieldsMustHaveLabelsOrTitles'),
-  require('./standards/formsMustHaveSubmitButtons'),
-  require('./standards/headingsMustBeInAscendingOrder'),
-  require('./standards/htmlMustHaveLangAttribute'),
-  require('./standards/imagesMustHaveAltAttributes'),
-  require('./standards/minimumTextSize'),
-  require('./standards/titleAttributesOnlyOnInputs')
-];
+Standards.sections = {
+
+  focusableControls: [
+    require('./standards/focusableControls/anchorsMustHaveHrefs')
+  ],
+
+  formInteractions: [
+    require('./standards/formInteractions/formsMustHaveSubmitButtons')
+  ],
+
+  formLabels: [
+    require('./standards/formLabels/fieldsMustHaveLabelsOrTitles')
+  ],
+
+  headings: [
+    require('./standards/headings/contentMustFollowHeadings'),
+    require('./standards/headings/exactlyOneMainHeading'),
+    require('./standards/headings/headingsMustBeInAscendingOrder')
+  ],
+
+  imageAlternatives: [
+    require('./standards/imageAlternatives/imagesMustHaveAltAttributes'),
+  ],
+
+  indicatingLanguage: [
+    require('./standards/indicatingLanguage/htmlMustHaveLangAttribute')
+  ],
+
+  mainLandmark: [
+    require('./standards/mainLandmark/exactlyOneMainLandmark')
+  ],
+
+  minimumTextSize: [
+    require('./standards/minimumTextSize/textCannotBeTooSmall')
+  ],
+
+  tabIndex: [
+    require('./standards/tabIndex/elementsWithZeroTabIndexMustBeFields')
+  ],
+
+  titleAttributes: [
+    require('./standards/titleAttributes/titleAttributesOnlyOnInputs')
+  ]
+
+}
+
+Standards.all = [];
+
+for (var section in Standards.sections) {
+  var sectionStandards = Standards.sections[section];
+  for (var i = 0; i < sectionStandards.length; ++i) {
+    sectionStandards[i].section = section;
+    Standards.all.push(sectionStandards[i]);
+  }
+}
 
 Standards.prototype.validate = function(jquery) {
   var results = [];
@@ -28,7 +69,13 @@ Standards.prototype.validate = function(jquery) {
   }
   for (var i = 0; i < this.standards.length; ++i) {
     standard = this.standards[i];
-    standardResult = { standard: this.standards[i].name, errors: [] };
+    standardResult = {
+      standard: {
+        section: this.standards[i].section,
+        name: this.standards[i].name
+      },
+      errors: []
+    };
     standard.validate(jquery, fail);
     results.push(standardResult);
   }
@@ -49,15 +96,15 @@ Standards.matching = function(criteria) {
 function standardsMatching(criteria) {
   var skips = criteria.skip || [];
   for (var i = 0; i < skips.length; ++i) {
-    skips[i] = normalise(skips[i]);
+    skips[i] = normaliseStandardName(skips[i]);
   }
   var isOnly = typeof(criteria.only) == 'string';
-  var only = isOnly ? normalise(criteria.only) : null;
+  var only = isOnly ? normaliseStandardName(criteria.only) : null;
   var matches = [];
   var skipped = [];
   for (var i = 0; i < Standards.all.length; ++i) {
     var standard = Standards.all[i];
-    var name = normalise(standard.name);
+    var name = standard.section.toLowerCase() + normaliseStandardName(standard.name);
     if (isOnly) {
       if (only == name) {
         matches.push(standard);
@@ -73,8 +120,8 @@ function standardsMatching(criteria) {
   return { matches: matches, skipped: skipped };
 }
 
-function normalise(name) {
-  return name.replace(/\s+/g, '').toLowerCase();
+function normaliseStandardName(name) {
+  return name.replace(/\W+/g, '').toLowerCase();
 }
 
 module.exports = Standards;

data/lib/bbc/a11y/js/standards/headings/contentMustFollowHeadings.js

@@ -0,0 +1,18 @@
+var headingSelector = 'h1, h2, h3, h4, h5, h6, h7, h8';
+
+module.exports = {
+  name: 'Content must follow headings',
+
+  validate: function($, fail) {
+    $(headingSelector).each(function(index, heading) {
+      var nextSibling = heading.nextSibling;
+      while (nextSibling) {
+        if ($(nextSibling).is(heading.tagName)) { break; }
+        if ($(nextSibling).text().trim().length > 0) { return; }
+        nextSibling = nextSibling.nextSibling ?
+                      nextSibling.nextSibling : (nextSibling.parentNode && nextSibling.parentNode.nextSibling);
+      }
+      fail("No content follows:", heading);
+    });
+  }
+}

data/lib/bbc/a11y/js/standards/{exactlyOneMainHeading.js → headings/exactlyOneMainHeading.js}

@@ -2,7 +2,7 @@ module.exports = {
   name: 'Exactly one main heading',
 
   validate: function($, fail) {
-    var mainHeadings = $('h1');
+    var mainHeadings = $('h1:visible');
     var count = mainHeadings.length;
     if (count == 0) {
       fail('Found 0 h1 elements.');

data/lib/bbc/a11y/js/standards/{minimumTextSize.js → minimumTextSize/textCannotBeTooSmall.js}

@@ -1,9 +1,9 @@
 module.exports = {
-  name: 'Minimum text size',
+  name: 'Text cannot be too small',
 
   validate: function($, fail) {
-    var textNodes = $('*:not(head, script, style)').contents().filter(function() {
-      return this.nodeType === 3;
+    var textNodes = $('*:not(head, script, style):visible').contents().filter(function() {
+      return this.nodeType === 3 && this.textContent.trim().length > 0;
     });
 
     var parents = [];

data/lib/bbc/a11y/js/standards/{titleAttributesOnlyOnInputs.js → titleAttributes/titleAttributesOnlyOnInputs.js}

@@ -2,7 +2,7 @@ module.exports = {
   name: 'Title attributes only on inputs',
 
   validate: function($, fail) {
-    $("[title]:not(input, button, textarea, select)").each(function(index, element) {
+    $("[title]:not(input, button, textarea, select):visible").each(function(index, element) {
       fail('Non-input element has title attribute:', element);
     });
   }

data/lib/bbc/a11y/linter.rb

@@ -1,5 +1,3 @@
-require 'bbc/a11y/standards'
-
 module BBC
   module A11y
 
@@ -38,8 +36,13 @@ module BBC
       end
 
       def self.from_json(json)
-        errors = json["results"].map { |standard|
-          standard["errors"].map { |error| error.join " " }
+        errors = json["results"].map { |standard_result|
+          standard_result["errors"].map { |error_message_array|
+            message = error_message_array.join ' '
+            LintError.new(standard_result["standard"]["section"],
+                          standard_result["standard"]["name"],
+                          message)
+          }
         }.flatten
         LintResult.new(errors, json["skipped"])
       end
@@ -47,5 +50,14 @@ module BBC
       attr_reader :errors, :skipped
     end
 
+    class LintError
+      def initialize(section, name, message)
+        @section = section
+        @name = name
+        @message = message
+      end
+
+      attr_reader :section, :name, :message
+    end
   end
 end

data/lib/bbc/a11y/runner.rb

@@ -1,4 +1,3 @@
-require 'bbc/a11y/standards'
 require 'bbc/a11y/javascript'
 require 'phantomjs/poltergeist'
 

data/lib/bbc/a11y/string_colours.rb

@@ -0,0 +1,15 @@
+module BBC
+  module A11y
+    module StringColours
+      def red
+        "\e[31m#{self}\e[0m"
+      end
+
+      def green
+        "\e[32m#{self}\e[0m"
+      end
+    end
+  end
+end
+
+String.send(:include, BBC::A11y::StringColours)

data/lib/bbc/a11y/version

@@ -1 +1 @@
-0.1.2
+0.2.0

data/package.json

@@ -5,6 +5,7 @@
   "main": "index.js",
   "directories": {},
   "scripts": {
+    "test": "karma start --single-run --browsers PhantomJS",
     "browserify": "browserify ./lib/bbc/a11y/js/a11y.js -o ./lib/bbc/a11y/js/bundle.js"
   },
   "repository": {
@@ -27,7 +28,9 @@
     "karma-chrome-launcher": "^0.2.2",
     "karma-mocha": "^0.2.1",
     "karma-mocha-reporter": "^1.1.3",
+    "karma-phantomjs-launcher": "^1.0.0",
     "mocha": "^2.3.4",
+    "phantomjs-prebuilt": "^2.1.4",
     "watchify": "^3.6.1"
   }
 }

data/spec/bbc/a11y/js/a11ySpec.js

@@ -14,21 +14,30 @@ describe('a11y', function() {
     });
     var expectedErrors = [
       {
-        "standard":"Exactly one main heading",
+        "standard": {
+          "section": "headings",
+          "name": "Exactly one main heading"
+        },
         "errors":[
           ["Found 0 h1 elements."]
         ]
       },
       {
-        "standard":"Exactly one main landmark",
+        "standard": {
+          "section": "indicatingLanguage",
+          "name": "Html must have lang attribute"
+        },
         "errors":[
-          ['Found 0 elements with role="main".']
+          ["html tag has no lang attribute:","/html"]
         ]
       },
       {
-        "standard":"Html must have lang attribute",
+        "standard": {
+          "section": "mainLandmark",
+          "name": "Exactly one main landmark"
+        },
         "errors":[
-          ["html tag has no lang attribute:","/html"]
+          ['Found 0 elements with role="main".']
         ]
       }
     ];
@@ -36,7 +45,7 @@ describe('a11y', function() {
   });
 
   it('skips standards', function() {
-    var validation = a11y.validate({ skip: ['Exactly one main landmark'] });
+    var validation = a11y.validate({ skip: ['Main landmark: Exactly one main landmark'] });
     expect(validation.skipped).to.eql(['Exactly one main landmark']);
   });
 });

data/spec/bbc/a11y/js/minimumTextSizeStandardSpec.js

@@ -0,0 +1,25 @@
+var standard = require('../../../../lib/bbc/a11y/js/standards/minimumTextSize/textCannotBeTooSmall');
+var $ = require('jquery');
+var expect = require('chai').expect;
+
+describe('minimum text size standard', function() {
+  it('ignores text nodes with parents with display: none', function() {
+    $('<div style="display:none; font-size: 1px">Text!</div>').appendTo('body');
+    var failures = [];
+    var fail = function(failure) {
+      failures.push(failure);
+    }
+    standard.validate($, fail);
+    expect(failures).to.eql([]);
+  });
+
+  it('ignores comment nodes', function() {
+    $('<div style="font-size: 1px"><!-- this is a comment --></div>').appendTo('body');
+    var failures = [];
+    var fail = function(failure) {
+      failures.push(failure);
+    }
+    standard.validate($, fail);
+    expect(failures).to.eql([]);
+  });
+});

data/spec/bbc/a11y/js/standardsSpec.js

@@ -9,23 +9,23 @@ describe('standards', function() {
     });
   });
 
-  describe('.matching(string)', function() {
+  describe('.matching("Focusable Controls: Anchors must have hrefs")', function() {
     it('finds standards matching the string', function() {
-      var matches = standards.matching('anchors must have hrefs');
+      var matches = standards.matching('Focusable Controls: anchors must have hrefs');
       expect(matches.standards.length).to.equal(1);
     });
   });
 
-  describe('.matching({ skip: ["anchors must have hrefs"] })', function() {
+  describe('.matching({ skip: ["Focusable Controls: Anchors must have hrefs"] })', function() {
     it('finds all standards except one', function() {
-      var matches = standards.matching({ skip: ["anchors must have hrefs"] });
+      var matches = standards.matching({ skip: ["Focusable Controls: Anchors must have hrefs"] });
       expect(matches.standards.length).to.equal(standards.all.length - 1);
     });
   });
 
-  describe('.matching({ only: "anchors must have hrefs" })', function() {
+  describe('.matching({ only: "Focusable controls: Anchors must have hrefs" })', function() {
     it('finds one standard', function() {
-      var matches = standards.matching({ only: "anchors must have hrefs" });
+      var matches = standards.matching({ only: "Focusable controls: Anchors must have hrefs" });
       expect(matches.standards.length).to.equal(1);
     });
   });

data/spec/bbc/a11y/string_colours_spec.rb

@@ -0,0 +1,13 @@
+require 'bbc/a11y/string_colours'
+
+module BBC::A11y
+  describe StringColours do
+    it "makes strings red" do
+      expect("red".red).to eql("\e[31mred\e[0m")
+    end
+
+    it "makes strings green" do
+      expect("green".green).to eql("\e[32mgreen\e[0m")
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bbc-a11y
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Matt Wynne
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-18 00:00:00.000000000 Z
+date: 2016-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -54,20 +54,6 @@ dependencies:
     - - ">="
       - !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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -148,7 +134,9 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".ruby-version"
+- ".travis.yml"
 - CONTRIBUTING.md
+- GETTINGSTARTED.md
 - Gemfile
 - LICENSE
 - README.md
@@ -156,28 +144,28 @@ files:
 - a11y.rb
 - bbc-a11y.gemspec
 - bin/a11y
-- circle.yml
-- examples/bbc-pages/Gemfile
-- examples/bbc-pages/Rakefile
-- examples/bbc-pages/a11y.rb
-- examples/local-web-app/Gemfile
-- examples/local-web-app/Rakefile
-- examples/local-web-app/a11y.rb
-- examples/local-web-app/config.ru
-- examples/local-web-app/public/missing_header.html
-- examples/local-web-app/public/perfect.html
-- examples/local-web-app/readme.md
 - features/README.md
-- features/check_standards/focusable_controls.feature
-- features/check_standards/form_interactions.feature
-- features/check_standards/form_labels.feature
-- features/check_standards/headings.feature
-- features/check_standards/image_alt.feature
-- features/check_standards/language.feature
-- features/check_standards/main_landmark.feature
-- features/check_standards/minimum_text_size.feature
-- features/check_standards/tab_index.feature
-- features/check_standards/title_attribute.feature
+- features/check_standards/01_core_purpose.feature
+- features/check_standards/02_validation.feature
+- features/check_standards/03_progressive_enhancement.feature
+- features/check_standards/04_indicating_language.feature
+- features/check_standards/05_page_titles.feature
+- features/check_standards/06_main_landmark.feature
+- features/check_standards/07_headings.feature
+- features/check_standards/08_minimum_text_size.feature
+- features/check_standards/09_resizable_text.feature
+- features/check_standards/10_tab_index.feature
+- features/check_standards/11_title_attributes.feature
+- features/check_standards/12_focusable_controls.feature
+- features/check_standards/13_visible_on_focus.feature
+- features/check_standards/14_control_styles.feature
+- features/check_standards/15_focus_styles.feature
+- features/check_standards/16_colour_contrast.feature
+- features/check_standards/17_colour_and_meaning.feature
+- features/check_standards/18_image_alternatives.feature
+- features/check_standards/19_form_labels.feature
+- features/check_standards/20_form_interactions.feature
+- features/check_standards/21_tables.feature
 - features/cli/coloured_output.feature
 - features/cli/display_failing_result.feature
 - features/cli/display_result_summary.feature
@@ -194,8 +182,10 @@ files:
 - features/support/capybara.rb
 - features/support/env.rb
 - features/support/web_server.rb
+- features/support/web_server/blank.html
 - features/support/web_server/missing_header.html
 - features/support/web_server/perfect.html
+- features/support/web_server/two_headings_failures.html
 - karma.conf.js
 - lib/bbc/a11y/cli.rb
 - lib/bbc/a11y/configuration.rb
@@ -203,70 +193,31 @@ files:
 - lib/bbc/a11y/js/a11y.js
 - lib/bbc/a11y/js/bundle.js
 - lib/bbc/a11y/js/standards.js
-- lib/bbc/a11y/js/standards/anchorsMustHaveHrefs.js
-- lib/bbc/a11y/js/standards/contentMustFollowHeadings.js
-- lib/bbc/a11y/js/standards/elementsWithZeroTabIndexMustBeFields.js
-- lib/bbc/a11y/js/standards/exactlyOneMainHeading.js
-- lib/bbc/a11y/js/standards/exactlyOneMainLandmark.js
-- lib/bbc/a11y/js/standards/fieldsMustHaveLabelsOrTitles.js
-- lib/bbc/a11y/js/standards/formsMustHaveSubmitButtons.js
-- lib/bbc/a11y/js/standards/headingsMustBeInAscendingOrder.js
-- lib/bbc/a11y/js/standards/htmlMustHaveLangAttribute.js
-- lib/bbc/a11y/js/standards/imagesMustHaveAltAttributes.js
-- lib/bbc/a11y/js/standards/minimumTextSize.js
-- lib/bbc/a11y/js/standards/titleAttributesOnlyOnInputs.js
+- lib/bbc/a11y/js/standards/focusableControls/anchorsMustHaveHrefs.js
+- lib/bbc/a11y/js/standards/formInteractions/formsMustHaveSubmitButtons.js
+- lib/bbc/a11y/js/standards/formLabels/fieldsMustHaveLabelsOrTitles.js
+- lib/bbc/a11y/js/standards/headings/contentMustFollowHeadings.js
+- lib/bbc/a11y/js/standards/headings/exactlyOneMainHeading.js
+- lib/bbc/a11y/js/standards/headings/headingsMustBeInAscendingOrder.js
+- lib/bbc/a11y/js/standards/imageAlternatives/imagesMustHaveAltAttributes.js
+- lib/bbc/a11y/js/standards/indicatingLanguage/htmlMustHaveLangAttribute.js
+- lib/bbc/a11y/js/standards/mainLandmark/exactlyOneMainLandmark.js
+- lib/bbc/a11y/js/standards/minimumTextSize/textCannotBeTooSmall.js
+- lib/bbc/a11y/js/standards/tabIndex/elementsWithZeroTabIndexMustBeFields.js
+- lib/bbc/a11y/js/standards/titleAttributes/titleAttributesOnlyOnInputs.js
 - lib/bbc/a11y/js/xpath.js
 - 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
-- lib/bbc/a11y/standards/exactly_one_main_heading.rb
-- lib/bbc/a11y/standards/exactly_one_main_landmark.rb
-- lib/bbc/a11y/standards/form_labels.rb
-- lib/bbc/a11y/standards/form_submit_buttons.rb
-- lib/bbc/a11y/standards/heading_hierarchy.rb
-- 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/string_colours.rb
 - lib/bbc/a11y/version
 - package.json
 - spec/bbc/a11y/cli_spec.rb
 - spec/bbc/a11y/configuration_spec.rb
 - spec/bbc/a11y/js/a11ySpec.js
+- spec/bbc/a11y/js/minimumTextSizeStandardSpec.js
 - spec/bbc/a11y/js/standardsSpec.js
 - spec/bbc/a11y/js/xpathSpec.js
-- 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
+- spec/bbc/a11y/string_colours_spec.rb
 homepage: https://cucumber.pro
 licenses:
 - MIT
@@ -291,19 +242,30 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: bbc-a11y-0.1.2
+summary: bbc-a11y-0.2.0
 test_files:
 - features/README.md
-- features/check_standards/focusable_controls.feature
-- features/check_standards/form_interactions.feature
-- features/check_standards/form_labels.feature
-- features/check_standards/headings.feature
-- features/check_standards/image_alt.feature
-- features/check_standards/language.feature
-- features/check_standards/main_landmark.feature
-- features/check_standards/minimum_text_size.feature
-- features/check_standards/tab_index.feature
-- features/check_standards/title_attribute.feature
+- features/check_standards/01_core_purpose.feature
+- features/check_standards/02_validation.feature
+- features/check_standards/03_progressive_enhancement.feature
+- features/check_standards/04_indicating_language.feature
+- features/check_standards/05_page_titles.feature
+- features/check_standards/06_main_landmark.feature
+- features/check_standards/07_headings.feature
+- features/check_standards/08_minimum_text_size.feature
+- features/check_standards/09_resizable_text.feature
+- features/check_standards/10_tab_index.feature
+- features/check_standards/11_title_attributes.feature
+- features/check_standards/12_focusable_controls.feature
+- features/check_standards/13_visible_on_focus.feature
+- features/check_standards/14_control_styles.feature
+- features/check_standards/15_focus_styles.feature
+- features/check_standards/16_colour_contrast.feature
+- features/check_standards/17_colour_and_meaning.feature
+- features/check_standards/18_image_alternatives.feature
+- features/check_standards/19_form_labels.feature
+- features/check_standards/20_form_interactions.feature
+- features/check_standards/21_tables.feature
 - features/cli/coloured_output.feature
 - features/cli/display_failing_result.feature
 - features/cli/display_result_summary.feature
@@ -320,10 +282,14 @@ test_files:
 - features/support/capybara.rb
 - features/support/env.rb
 - features/support/web_server.rb
+- features/support/web_server/blank.html
 - features/support/web_server/missing_header.html
 - features/support/web_server/perfect.html
+- features/support/web_server/two_headings_failures.html
 - spec/bbc/a11y/cli_spec.rb
 - spec/bbc/a11y/configuration_spec.rb
 - spec/bbc/a11y/js/a11ySpec.js
+- spec/bbc/a11y/js/minimumTextSizeStandardSpec.js
 - spec/bbc/a11y/js/standardsSpec.js
 - spec/bbc/a11y/js/xpathSpec.js
+- spec/bbc/a11y/string_colours_spec.rb