RubyGems - bbc-a11y - Versions diffs - 0.0.2 - Mend

bbc-a11y 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (59) hide show

checksums.yaml +7 -0
data/.rspec +1 -0
data/CONTRIBUTING.md +19 -0
data/Gemfile +2 -0
data/LICENSE +21 -0
data/README.md +54 -0
data/Rakefile +12 -0
data/bbc-a11y.gemspec +32 -0
data/bin/a11y +5 -0
data/example/.a11y.rb +64 -0
data/example/Gemfile +4 -0
data/example/Rakefile +3 -0
data/example/config.ru +1 -0
data/example/public/missing_header.html +13 -0
data/example/public/perfect.html +14 -0
data/example/readme.md +0 -0
data/features/01_core-purpose.md +24 -0
data/features/02_validation.feature +31 -0
data/features/03_javascript.feature +40 -0
data/features/04_language.feature +58 -0
data/features/05_page_title.feature +45 -0
data/features/06_main_landmark.feature +24 -0
data/features/07_headings.feature +65 -0
data/features/08_title_attribute.feature +71 -0
data/features/09_tabindex.feature +38 -0
data/features/10_form-labels.md +47 -0
data/features/11_visible-on-focus.md +58 -0
data/features/13_colour-contrast.md +27 -0
data/features/14_colour-meaning.md +19 -0
data/features/15_focusable-controls.md +45 -0
data/features/16_table.md +109 -0
data/features/17_control-styles.md +78 -0
data/features/18_focus-styles.md +36 -0
data/features/19_form-interactions.md +33 -0
data/features/20_image-alt.md +34 -0
data/features/21_min-font-sizes.md +64 -0
data/features/22_resize-zoom.md +80 -0
data/features/step_definitions/core_content_steps.rb +3 -0
data/features/step_definitions/language_steps.rb +21 -0
data/features/step_definitions/page_steps.rb +46 -0
data/features/step_definitions/w3c_steps.rb +7 -0
data/features/support/capybara.rb +38 -0
data/features/support/skipper.rb +5 -0
data/features/support/world.rb +3 -0
data/features/support/world_extender.rb +5 -0
data/lib/bbc/a11y/cli.rb +49 -0
data/lib/bbc/a11y/configuration.rb +83 -0
data/lib/bbc/a11y/cucumber_runner.rb +133 -0
data/lib/bbc/a11y/cucumber_support/heading_hierarchy.rb +92 -0
data/lib/bbc/a11y/cucumber_support/language_detector.rb +26 -0
data/lib/bbc/a11y/cucumber_support/page.rb +81 -0
data/lib/bbc/a11y/cucumber_support/per_page_checks.rb +28 -0
data/lib/bbc/a11y/cucumber_support/w3c.rb +36 -0
data/lib/bbc/a11y/cucumber_support.rb +49 -0
data/lib/bbc/a11y/version +1 -0
data/lib/bbc/a11y.rb +4 -0
data/spec/bbc/a11y/cucumber_support/heading_hierarchy_spec.rb +123 -0
data/spec/bbc/a11y/cucumber_support/page_spec.rb +130 -0
metadata +274 -0

data/features/step_definitions/core_content_steps.rb ADDED Viewed

@@ -0,0 +1,3 @@
+Then(/^all core content is available and functional$/) do
+  skip_this_scenario
+end

data/features/step_definitions/language_steps.rb ADDED Viewed

@@ -0,0 +1,21 @@
+Then(/^the <html> element must have a `lang` attribute$/) do
+  page.must_have_lang_attribute
+end
+Then(/^the main natural language of the page must match that attribute$/) do
+  expected_language = language.detect(page)
+  puts "Detected page language: #{expected_language}"
+  page.must_have_lang_attribute_of(expected_language)
+end
+Then(/^any other tags with a lang attribute must contain text of that language$/) do
+  pending # express the regexp above with the code you wish you had
+end
+Then(/^all elements with `lang` attribute must have content in that natural language$/) do
+  pending # express the regexp above with the code you wish you had
+end
+Then(/^any parts expressed in a natural language different to the main language of the page must have a matching `lang` attribute$/) do
+  pending # express the regexp above with the code you wish you had
+end

data/features/step_definitions/page_steps.rb ADDED Viewed

@@ -0,0 +1,46 @@
+When(/^I visit the page$/) do
+  browser.visit settings.url
+end
+When(/^I view the page with JavaScript and CSS disabled$/) do
+  disable_javascript_and_css
+  browser.visit settings.url
+end
+Then(/^the document should have a title$/) do
+  page.must_have_title
+end
+Then(/^the title should describe the primary content of the document$/) do
+  begin
+    page.must_have_title_that_contains_h1_text
+  rescue => error
+    assert_title_describes_primary_content_of_document(browser.title, browser)
+  end
+end
+Then(/^there should be exactly one element with `role="(.*?)"`$/) do |arg1|
+  page.must_have_one_main_element
+end
+Then(/^there must be exactly one h1 element$/) do
+  page.must_have_one_h1
+end
+Then(/^each heading must be followed by content or a heading of one level deeper \(h2\-h6\)$/) do
+  puts "Heading hierarchy:"
+  puts page.heading_hierarchy.to_s
+  page.must_have_correct_heading_hierarchy
+end
+Then(/^there must be no elements with a title attribute whose content is repeated within the element$/) do
+  page.must_have_no_elements_with_title_attribute_content_repeated_within
+end
+Then(/^any form fields with associated labels do not have a title attribute$/) do
+  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
+end

data/features/step_definitions/w3c_steps.rb ADDED Viewed

@@ -0,0 +1,7 @@
+When(/^I submit the page to the W3C Markup Validation Service$/) do
+  w3c.validate settings.url
+end
+Then(/^there should be no errors$/) do
+  expect(w3c.errors).to be_empty
+end

data/features/support/capybara.rb ADDED Viewed

@@ -0,0 +1,38 @@
+require 'capybara'
+require 'capybara/dsl'
+require 'selenium/webdriver'
+Capybara.register_driver(:without_javascript_or_css) do |app|
+  profile = Selenium::WebDriver::Firefox::Profile.new
+  profile['permissions.default.stylesheet'] = 2
+  profile['javascript.enabled'] = false
+  Capybara::Selenium::Driver.new(app, profile: profile)
+end
+Capybara.default_driver = :selenium
+Before do
+  Capybara.use_default_driver
+end
+After do
+  Capybara.reset_sessions!
+end
+module BBC
+  module A11y
+    module Browser
+      def browser
+        Capybara.current_session
+      end
+      def disable_javascript_and_css
+        Capybara.current_driver = :without_javascript_or_css
+      end
+    end
+  end
+end
+World(BBC::A11y::Browser)

data/features/support/skipper.rb ADDED Viewed

@@ -0,0 +1,5 @@
+Before do |test_case|
+  if settings.scenarios_to_skip.any? { |name| test_case.name.match name }
+    skip_this_scenario
+  end
+end

data/features/support/world.rb ADDED Viewed

@@ -0,0 +1,3 @@
+require 'bbc/a11y/cucumber_support'
+World(BBC::A11y::CucumberSupport)

data/features/support/world_extender.rb ADDED Viewed

@@ -0,0 +1,5 @@
+Before do |test_case|
+  settings.world_extensions.each do |extension_module|
+    extend extension_module
+  end
+end

data/lib/bbc/a11y/cli.rb ADDED Viewed

@@ -0,0 +1,49 @@
+require 'bbc/a11y/cucumber_runner'
+require 'bbc/a11y/configuration'
+module BBC
+  module A11y
+    # A very thin wrapper around Cucumber which takes settings on the command-line,
+    # stores them somewhere our automation code will be able to find it, and then
+    # runs Cucumber
+    class CLI
+      MissingArgument = Class.new(StandardError)
+      def initialize(stdin, stdout, stderr, args)
+        @stdin, @stdout, @stderr, @args = stdin, stdout, stderr, args
+      end
+      def call
+        CucumberRunner.new(settings, cucumber_args).call
+      rescue MissingArgument => error
+        stderr.puts "You missed an argument: #{error.message}"
+        stderr.puts HELP
+        raise SystemExit
+      end
+      private
+      def settings
+        Configuration.parse(File.expand_path(".a11y.rb"))
+      end
+      def cucumber_args
+        return unless args.include?('--')
+        args[args.find_index('--')+1..-1].join(' ')
+      end
+      attr_reader :stdin, :stderr, :stdout, :args
+      private :stdin, :stderr, :stdout, :args
+      HELP = %{
+Usage: a11y url-to-test [-- cucumber-args]
+url-to-test     - URL of the page to run the full set of accessiblity tests against
+cucumber-args   - Arguments to pass to Cucumber when running the tests. See cucumber --help
+                  for details.
+}
+    end
+  end
+end

data/lib/bbc/a11y/configuration.rb ADDED Viewed

@@ -0,0 +1,83 @@
+module BBC
+  module A11y
+    def self.configure(&block)
+      @settings = Configuration::DSL.new(block).settings
+    end
+    def self.configuration
+      @settings ||= Configuration::Settings.new
+    end
+    module Configuration
+      def self.parse(file)
+        require file
+        # the file should call BBC::A11y.configure
+        BBC::A11y.configuration
+      end
+      class Settings
+        attr_reader :before_all_hooks,
+          :after_all_hooks,
+          :pages
+        def initialize
+          @before_all_hooks = []
+          @after_all_hooks = []
+          @pages = []
+          freeze
+        end
+      end
+      class PageSettings
+        attr_reader :url, :scenarios_to_skip, :world_extensions
+        def initialize(url)
+          @url = url
+          @scenarios_to_skip = []
+          @world_extensions = []
+          freeze
+        end
+      end
+      class DSL
+        attr_reader :settings
+        def initialize(block)
+          @settings = Settings.new
+          instance_eval &block
+        end
+        def before_all(&block)
+          settings.before_all_hooks << block
+        end
+        def after_all(&block)
+          settings.after_all_hooks << block
+        end
+        def page(url, &block)
+          settings.pages << PageDSL.new(url, block).settings
+        end
+      end
+      class PageDSL
+        attr_reader :settings
+        def initialize(url, block)
+          @settings = PageSettings.new(url)
+          instance_eval &block if block
+        end
+        def skip_scenario(name)
+          @settings.scenarios_to_skip << name
+        end
+        def customize_world(&block)
+          @settings.world_extensions << Module.new(&block)
+        end
+      end
+    end
+  end
+end

data/lib/bbc/a11y/cucumber_runner.rb ADDED Viewed

@@ -0,0 +1,133 @@
+require 'forwardable'
+require 'cucumber'
+require 'bbc/a11y/cucumber_support'
+require 'cucumber/core/filter'
+require 'colorize'
+module BBC
+  module A11y
+    class CucumberFormatter
+      def initialize(*args)
+        @current_feature = nil
+      end
+      def before_test_case(test_case)
+        on_new_feature(test_case) do |feature|
+          puts
+          puts "#{feature.name}"
+          puts "#{"-" * feature.name.length}"
+          puts
+        end
+        print "  - #{test_case.name} "
+      end
+      def after_test_case(test_case, result)
+        print colour(result)
+        if result.failed? || result.pending?
+          puts
+          puts result.exception.message.to_s.red
+          puts result.exception.backtrace.join("\n").red
+        end
+        puts
+      end
+      private
+      def colour(result)
+        ResultColour.new(result).apply_to(result.to_s)
+      end
+      def on_new_feature(test_case)
+        feature = test_case.source.first
+        if feature != @current_feature
+          @current_feature = feature
+          yield feature
+        end
+      end
+      class ResultColour
+        def initialize(result)
+          @color = :white
+          result.describe_to(self)
+        end
+        def passed
+          @color = :green
+        end
+        def skipped
+          @color = :blue
+        end
+        def pending(*)
+          @color = :yellow
+        end
+        def failed
+          @color = :red
+        end
+        def duration(*)
+        end
+        def exception(*)
+        end
+        def apply_to(string)
+          string.send(@color)
+        end
+      end
+    end
+    class CucumberRunner
+      def initialize(settings, cucumber_args)
+        @settings = settings
+      end
+      def call
+        runtime = Cucumber::Runtime.new(configuration)
+        run_before_all_hooks
+        @settings.pages.each do |page_settings|
+          # stash the settings where the support code will find them
+          BBC::A11y::CucumberSupport.current_page_settings = page_settings
+          print_page_header page_settings
+          runtime.run!
+        end
+      ensure
+        run_after_all_hooks
+      end
+      private
+      def configuration
+        return @configuration if @configuration
+        features_path = File.expand_path(File.dirname(__FILE__) + "/../../../features")
+        @configuration = Cucumber::Cli::Configuration.new
+        # This is ugly, but until Cucumber offers a better API, we have to pass in our settings as though
+        # they were CLI arguments
+        @configuration.parse!([
+                              features_path,
+                              "--format", "BBC::A11y::CucumberFormatter"])
+        @configuration
+      end
+      def run_before_all_hooks
+        @settings.before_all_hooks.each &:call
+      end
+      def run_after_all_hooks
+        @settings.after_all_hooks.each &:call
+      end
+      def print_page_header(page_settings)
+        puts
+        puts
+        puts "BBC Accesibility: #{page_settings.url}"
+        puts "=" * "BBC Accesibility: #{page_settings.url}".length
+      end
+    end
+  end
+end

data/lib/bbc/a11y/cucumber_support/heading_hierarchy.rb ADDED Viewed

@@ -0,0 +1,92 @@
+module BBC
+  module A11y
+    module CucumberSupport
+      class HeadingHierarchy
+        include RSpec::Matchers
+        def initialize(page)
+          @page = page
+        end
+        def validate
+          return self unless headings.count > 1
+          adjacent_pairs = headings.zip(headings[1..-1])[0..-2]
+          errors = adjacent_pairs.reduce([]) { |errors, pair|
+            previous, current = *pair
+            if current > previous
+              delta = current.number - previous.number
+              if delta != 1
+                errors << current
+              end
+            end
+            errors
+          }
+          expect(errors).to be_empty, error_message(errors)
+          self
+        end
+        def to_s
+          headings.map { |h|
+            indent = "  " * (h.number - 1)
+            indent + h.to_s
+          }.join("\n")
+        end
+        private
+        def error_message(errors)
+          "Headings were not in order: " +
+            headings.map { |h| errors.include?(h) ? "**#{h}**" : h }.
+          join(", ")
+        end
+        def headings
+          heading_elements.map { |h| Heading.new(h) }
+        end
+        def heading_elements
+          # can't work out how to get Capybara to do this reliably, so we'll reach down to the XML parser
+          xml = Nokogiri::XML.parse(page.source).remove_namespaces!
+          header_xml_nodes = xml.xpath('//*[substring(name(),1,1) = "h" and number(substring(name(),2,1))]')
+          header_xml_nodes.map(&:path).map { |xpath|
+            page.find(:xpath, xpath, visible: false)
+          }
+        end
+        attr_reader :page
+        private :page
+        class Heading
+          attr_reader :number
+          def initialize(element)
+            @element = element
+            @tag_name = element.tag_name
+            @number = @tag_name[1].to_i
+          end
+          def > (other)
+            number > other.number
+          end
+          def == (other)
+            begin
+              other.element.path == @element.path
+            rescue NotSupportedByDriverError
+              other.element == @element
+            end
+          end
+          def to_s
+            @tag_name
+          end
+          attr_reader :element
+          protected :element
+        end
+      end
+    end
+  end
+end

data/lib/bbc/a11y/cucumber_support/language_detector.rb ADDED Viewed

@@ -0,0 +1,26 @@
+module BBC
+  module A11y
+    module CucumberSupport
+      module LanguageDetector
+        # factory for language detector, allows us to use different mechanisms (e.g. a hard-coded language passed from settings)
+        def self.new
+          CLDLanguageDetector.new
+        end
+        require 'cld'
+        class CLDLanguageDetector
+          InsufficientConfidence = Class.new(StandardError)
+          # returns the code of the language, or raises an error if insufficient confidence
+          def detect(text)
+            detected_language = CLD.detect_language(text.to_s)
+            raise InsufficientConfidence unless detected_language[:reliable]
+            detected_language[:code]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+require 'rspec/expectations'
+require 'capybara/rspec/matchers'
+require 'bbc/a11y/cucumber_support/heading_hierarchy'
+module BBC
+  module A11y
+    module CucumberSupport
+      class Page
+        include RSpec::Matchers
+        include Capybara::RSpecMatchers
+        def initialize(browser)
+          @browser = browser
+        end
+        def title
+          browser.title
+        end
+        def must_have_lang_attribute
+          expect(browser).to have_css('html[lang]')
+        end
+        def must_have_lang_attribute_of(expected_code)
+          expect(browser.find('html')['lang'].split('-')[0]).to eq expected_code
+        end
+        def must_have_title
+          expect(browser.title).not_to be_empty
+        end
+        def must_have_title_that_contains_h1_text
+          expect(browser.title).to include(browser.find('h1').text)
+        end
+        def must_have_one_main_element
+          expect(browser.all('[role="main"]').length).to eq 1
+        end
+        def must_have_one_h1
+          expect(browser.all('h1', visible: false).length).to eq 1
+        end
+        def must_have_correct_heading_hierarchy
+          heading_hierarchy.validate
+        end
+        def must_have_no_elements_with_title_attribute_content_repeated_within
+          bad_nodes = browser.all('[title]').select { |node| node.text.include? node['title'] }
+          expect(bad_nodes).to be_empty
+        end
+        def must_have_no_form_fields_with_label_and_title
+          bad_nodes = browser.all('form *[id][title]').select { |node| browser.has_css?("label[for='#{node['id']}']") }
+          expect(bad_nodes).to be_empty
+        end
+        def must_not_have_any_positive_tabindex_values
+          bad_nodes = browser.all('[tabindex]').select { |node| node['tabindex'].to_i >= 0 }
+          expect(bad_nodes).to be_empty
+        end
+        def to_s
+          browser.text
+        end
+        def heading_hierarchy
+          HeadingHierarchy.new(browser)
+        end
+        private
+        attr_reader :browser
+        private :browser
+      end
+    end
+  end
+end

data/lib/bbc/a11y/cucumber_support/per_page_checks.rb ADDED Viewed

@@ -0,0 +1,28 @@
+module BBC
+  module A11y
+    module CucumberSupport
+      module PerPageChecks
+        def assert_title_describes_primary_content_of_document(title, page)
+          pending <<-ERROR
+Because the title did not contain the header text, you need to write a custom
+method to define how to make this check.
+In your .a11y.rb file, add the following code:
+BBC::A11y.configure do
+  page "my_page.html" do
+    customize_world do
+      def assert_title_describes_primary_content_of_document(title, page)
+        # TODO: add your custom code here to make the check
+      end
+    end
+  end
+end
+          ERROR
+        end
+      end
+    end
+  end
+end

data/lib/bbc/a11y/cucumber_support/w3c.rb ADDED Viewed

@@ -0,0 +1,36 @@
+require 'w3c_validators'
+module BBC
+  module A11y
+    module CucumberSupport
+      class W3C
+        include W3CValidators
+        def initialize
+          @validator = MarkupValidator.new(options)
+        end
+        def validate(url)
+          @results = @validator.validate_uri(url)
+        end
+        def errors
+          @results.errors
+        end
+        private
+        def options
+          return {} unless proxy
+          { proxy_server: proxy, proxy_port: 80 }
+        end
+        def proxy
+          @proxy ||= ['http_proxy', 'https_proxy', 'HTTP_PROXY', 'HTTPS_PROXY'].map { |key| ENV[key] }.compact.first
+        end
+      end
+    end
+  end
+end