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/circle.yml DELETED

@@ -1,3 +0,0 @@
-test:
-  override:
-    - bundle exec rake

data/examples/bbc-pages/Gemfile DELETED

@@ -1,3 +0,0 @@
-source 'https://rubygems.org'
-gem 'bbc-a11y', path: '../..'

data/examples/bbc-pages/Rakefile DELETED

@@ -1,3 +0,0 @@
-task :default do
-  sh "bundle exec ../../bin/a11y"
-end

data/examples/bbc-pages/a11y.rb DELETED

	@@ -1,2 +0,0 @@
1	- page "http://bbc.co.uk/news"
2	- page "http://bbc.co.uk/mundo"

data/examples/local-web-app/Gemfile DELETED

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-gem 'rack'
-gem 'bbc-a11y', path: '../..'

data/examples/local-web-app/Rakefile DELETED

@@ -1,3 +0,0 @@
-task :default do
-  sh "bundle exec ../../bin/a11y"
-end

data/examples/local-web-app/a11y.rb DELETED

@@ -1,52 +0,0 @@
-class Server
-  attr_reader :port
-  def initialize
-    @pid = nil
-    @port = find_available_port
-  end
-  def start
-    @pid = fork { `rackup -p #{port} -q` }
-    @pid = @pid + 1 # because rackup starts a child process
-    sleep(0.1) until responsive?
-  end
-  def stop
-    return unless @pid
-    Process.kill("SIGKILL", @pid)
-    Process.wait(@pid)
-  rescue Errno::ECHILD
-  end
-  private
-  def find_available_port
-    server = TCPServer.new('127.0.0.1', 0)
-    server.addr[1]
-  ensure
-    server.close if server
-  end
-  def responsive?
-    Net::HTTP.start('localhost', port) { |http| http.get("/perfect.html") }.is_a?(Net::HTTPSuccess)
-  rescue SystemCallError
-    false
-  end
-end
-server = Server.new
-server.start
-at_exit do
-  server.stop
-end
-page "http://localhost:#{server.port}/perfect.html" do
-  skip_standard "W3C"
-end
-page "http://localhost:#{server.port}/missing_header.html" do
-  skip_standard "W3C"
-  skip_standard "Check headings"
-end

data/examples/local-web-app/config.ru DELETED

	@@ -1 +0,0 @@
1	- run Rack::Directory.new("public")

data/examples/local-web-app/public/missing_header.html DELETED

@@ -1,13 +0,0 @@
-<html lang="en-gb">
-  <head>
-    <title>Missing header</title>
-  </head>
-  <body>
-    <p role="main">
-    Here is some text in British English. This is needed so that we can verify that
-    the lang attribute in the html element at the top, which specified en-gb, is
-    correct.
-    </p>
-  </body>
-</html>

data/examples/local-web-app/public/perfect.html DELETED

@@ -1,14 +0,0 @@
-<html lang="en-gb">
-  <head>
-    <title>Perfect page - Main heading</title>
-  </head>
-  <body>
-    <h1>Main heading</h1>
-    <p role="main">
-    Here is some text in British English. This is needed so that we can verify that
-    the lang attribute in the html element at the top, which specified en-gb, is
-    correct.
-    </p>
-  </body>
-</html>

data/examples/local-web-app/readme.md DELETED

File without changes

data/features/check_standards/headings.feature DELETED

@@ -1,153 +0,0 @@
-Feature: 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.
-  Scenario: No main heading
-    Given a page with the HTML:
-      """
-      <h2>Heading 2</h2>
-      """
-    When I validate the "exactly one main heading" standard
-    Then it fails with the message:
-      """
-      Found 0 h1 elements.
-      """
-  Scenario: More than one main heading
-    Given a page with the HTML:
-      """
-      <h1>Heading 1</h1>
-      <h2>Heading 2</h2>
-      <h1>Heading 1</h1>
-      """
-    When I validate the "exactly one main heading" standard
-    Then it fails with the message:
-      """
-      Found 2 h1 elements: /html/body/h1[1] /html/body/h1[2]
-      """
-  Scenario: Headings in ascending order
-    Given a page with the HTML:
-      """
-      <h1>Heading 1</h1>
-      <h2>Heading 2</h2>
-      <h3>Heading 3</h3>
-      <h4>Heading 4</h4>
-      <h5>Heading 5</h5>
-      <h6>Heading 6</h6>
-      """
-    When I validate the "headings must be in ascending order" standard
-    Then it passes
-  Scenario: Headings in invalid order
-    Given a page with the HTML:
-      """
-      <h1>Heading 1</h1>
-      <h3>Heading 3</h3>
-      <h2>Heading 2</h2>
-      """
-    When I validate the "headings must be in ascending order" standard
-    Then it fails with the message:
-      """
-      Headings are not in order: /html/body/h1 /html/body/h3
-      """
-  Scenario: Headings jump back up more than one level
-    Given a page with the HTML:
-      """
-      <h1>Heading 1</h1>
-      <h2>Heading 2</h2>
-      <h3>Heading 3</h3>
-      <h4>Heading 4</h4>
-      <h2>Heading 2b</h2>
-      <h3>Heading 3b</h3>
-      """
-    When I validate the "headings must be in ascending order" standard
-    Then it passes
-  Scenario: Heading is hidden
-    Given a page with the HTML:
-      """
-      <h1>Heading 1</h1>
-      <h3 style="display:none">Heading 3</h3>
-      <h2>Heading 2</h2>
-      """
-    When I validate the "headings must be in ascending order" standard
-    Then it fails with the message:
-      """
-      Headings are not in order: /html/body/h1 /html/body/h3
-      """
-  Scenario: Heading in a script tag
-    Given a page with the HTML:
-      """
-      <h1>Heading 1</h1>
-      <script>
-        var stuff = "<h3>Heading 3</h3>";
-      </script>
-      <h2>Heading 2</h2>
-      """
-    When I validate the "headings must be in ascending order" standard
-    Then it passes
-  Scenario: Subheading before the first main heading
-    Given a page with the HTML:
-      """
-      <h3>Ignore me</h3>
-      <h1>Heading 1</h1>
-      <h2>Heading 2</h2>
-      """
-    When I validate the "headings must be in ascending order" standard
-    Then it passes
-    Scenario: Content between headings
-      Given a page with the HTML:
-        """
-        <div role="main">
-          <h1>Main heading</h1>
-          <p>non-heading content</p>
-          <h2>Another heading</h2>
-          <p>non-heading content</p>
-          <h3>Main content</h3>
-          non-heading content
-          <h2>Secondary content</h2>
-          <p>non-heading content</p>
-          <h2>Tertiary content</h2>
-          non-heading content
-        </div>
-        """
-      When I validate the "content must follow headings" standard
-      Then it passes
-  Scenario: No content between headings
-    Given a page with the HTML:
-      """
-      <div role="main">
-        <h1>Main heading</h1>
-        <p>non-heading content</p>
-        <h2>Secondary content</h2>
-        <h2>Tertiary content</h2>
-        <p>non-heading content</p>
-      </div>
-      """
-    When I validate the "content must follow headings" standard
-    Then it fails with the message:
-      """
-      No content follows: /html/body/div/h2[1]
-      """

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

@@ -1,15 +0,0 @@
-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) {
-      if ($(heading.nextSibling).is(headingSelector) ||
-         ($(heading.nextSibling).text().trim() == '' &&
-          $(heading).next().is(headingSelector))) {
-        fail("No content follows:", heading);
-      }
-    });
-  }
-}

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

@@ -1,45 +0,0 @@
-require 'bbc/a11y/standards/anchor_hrefs'
-require 'bbc/a11y/standards/content_follows_headings'
-require 'bbc/a11y/standards/exactly_one_main_heading'
-require 'bbc/a11y/standards/exactly_one_main_landmark'
-require 'bbc/a11y/standards/form_labels'
-require 'bbc/a11y/standards/form_submit_buttons'
-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
-    module Standards
-      def self.for(page_settings)
-        all.reject { |standard|
-          page_settings.skip_standard?(standard)
-        }
-      end
-      def self.matching(name)
-        all.select { |standard|
-          name.match(standard.name)
-        }
-      end
-      def self.all
-        [
-          AnchorHrefs,
-          ContentFollowsHeadings,
-          FormLabels,
-          FormSubmitButtons,
-          HeadingHierarchy,
-          ImageAlt,
-          ExactlyOneMainHeading,
-          ExactlyOneMainLandmark,
-          LanguageAttribute,
-          TabIndex,
-          TitleAttribute
-        ]
-      end
-    end
-  end
-end

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

@@ -1,18 +0,0 @@
-module BBC
-  module A11y
-    module Standards
-      class AnchorHrefs
-        def initialize(page)
-          @page = page
-        end
-        def call(errors)
-          @page.all("a:not([href])").each do |anchor|
-            errors << "Anchor has no href attribute: #{anchor.path}"
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,22 +0,0 @@
-module BBC
-  module A11y
-    module Standards
-      class ContentFollowsHeadings
-        def initialize(page)
-          @page = page
-        end
-        def call(errors)
-          ["h1", "h2", "h3", "h4", "h5", "h6"].each do |h|
-            if @page.all("#{h} + #{h}").any?
-              errors << "Heading elements must be followed by content. " +
-                        "No content follows a #{h}."
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,25 +0,0 @@
-module BBC
-  module A11y
-    module Standards
-      class ExactlyOneMainHeading
-        def initialize(page)
-          @page = page
-        end
-        def call(errors)
-          main_headings = @page.all('h1')
-          count = main_headings.size
-          if count == 0
-            errors << "A document must have exactly one main heading." +
-                      " Found 0 h1 elements."
-          elsif count != 1
-            errors << "A document must have exactly one main heading." +
-                      " Found #{count} h1 elements:\n" +
-                      main_headings.map { |h1| "* #{h1.path}" }.join("\n")
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,20 +0,0 @@
-module BBC
-  module A11y
-    module Standards
-      class ExactlyOneMainLandmark
-        def initialize(page)
-          @page = page
-        end
-        def call(errors)
-          count = @page.all('*[role=main]').size
-          if count != 1
-            errors << "A document must have exactly one main landmark." +
-                      " Found #{count} elements with role=\"main\"."
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,39 +0,0 @@
-module BBC
-  module A11y
-    module Standards
-      class FormLabels
-        def initialize(page)
-          @page = page
-        end
-        def call(errors)
-          fields = @page.all(potential_offenders)
-          fields.each do |field|
-            if offender? field
-              errors << "Field has no label or title attribute: #{field.path}"
-            end
-          end
-        end
-        private
-        def potential_offenders
-          "input:not([title]):not([type='hidden']), textarea:not([title]), select:not([title])"
-        end
-        def offender?(field)
-          (missing_id? field) or (missing_label? field)
-        end
-        def missing_id?(field)
-          field['id'] == nil or field['id'] == ''
-        end
-        def missing_label?(field)
-          @page.all("label[for='#{field['id']}']").empty?
-        end
-      end
-    end
-  end
-end