bbc-a11y 0.0.12 → 0.0.13

data/lib/bbc/a11y/cucumber_support/matchers.rb

@@ -1,21 +0,0 @@
-require 'rspec/matchers'
-module BBC
-  module A11y
-    module CucumberSupport
-      RSpec::Matchers.define :have_title_attribute_or_associated_label_tag do
-        match do |element|
-          if !element['title'].nil?
-            return true
-          end
-          if id = element['id']
-            return true if element.find_xpath("//*[for=#{id}]")
-          end
-          if element.find_xpath("..")[0].name == "label"
-            return true
-          end
-          false
-        end
-      end
-    end
-  end
-end

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

@@ -1,94 +0,0 @@
-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 all_elements_matching(*selectors)
-          results = selectors.map { |selector| browser.all(selector) }
-          # A Capybara::Result looks like an array, but it's not. Turn them into plain
-          # old nodes
-          results.map { |result| result.map { |element| element } }.flatten
-        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_elements_with_tabindex_greater_than(max)
-          bad_nodes = browser.all('[tabindex]').select { |node| node['tabindex'].to_i > max }
-          expect(bad_nodes).to be_empty
-        end
-
-        def must_not_have_elements_with_tabindex(tabindex, except: [])
-          nodes_with_tabindex = browser.all('[tabindex]').select { |node| node['tabindex'].to_i == tabindex }
-          bad_nodes = nodes_with_tabindex.reject { |node| except.include? node.tag_name }
-          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

@@ -1,28 +0,0 @@
-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

@@ -1,36 +0,0 @@
-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

data/spec/bbc/a11y/cucumber_support/heading_hierarchy_spec.rb

@@ -1,162 +0,0 @@
-require 'bbc/a11y/cucumber_support/heading_hierarchy'
-require 'capybara'
-
-module BBC::A11y::CucumberSupport
-  describe HeadingHierarchy do
-
-    let(:hierarchy) do
-      HeadingHierarchy.new(page)
-    end
-
-    let(:page) do
-      # patch Capybara::String to look just enough like a real Capybara::Session to work
-      page = Capybara.string(html)
-      source = html
-      page.define_singleton_method(:source) { source }
-      page
-    end
-
-    describe '#validate' do
-
-      context 'a simple, valid h1-h6 hierachy' do
-        let(:html) { <<-HTML }
-        <html>
-          <body>
-            <h1>Heading 1</h1>
-            <h2>Heading 2</h2>
-            <h3>Heading 3</h3>
-            <h4>Heading 4</h4>
-            <h5>Heading 5</h5>
-            <h6>Heading 6</h6>
-          </body>
-        </html>
-        HTML
-
-        it 'passes' do
-          expect { hierarchy.validate }.not_to raise_error
-        end
-      end
-
-      context 'an invalid h1-h3 hierarchy' do
-        let(:html) { <<-HTML }
-        <html>
-          <body>
-            <h1>Heading 1</h1>
-            <h3>Heading 3</h3>
-            <h2>Heading 2</h2>
-          </body>
-        </html>
-        HTML
-
-        it 'fails' do
-          expect { hierarchy.validate }.to raise_error("Headings were not in order: h1, **h3**, h2")
-        end
-      end
-
-      context 'an hierarchy that skips back up from h4 to h2' do
-        let(:html) { <<-HTML }
-        <html>
-          <body>
-            <h1>Heading 1</h1>
-            <h2>Heading 2</h2>
-            <h3>Heading 3</h3>
-            <h4>Heading 4</h4>
-            <h2>Heading 2b</h2>
-            <h3>Heading 3b</h3>
-          </body>
-        </html>
-        HTML
-
-        it 'passes' do
-          expect { hierarchy.validate }.not_to raise_error
-        end
-      end
-
-
-    end
-
-    describe "#to_s" do
-      context 'an hierarchy that skips back up from h4 to h2' do
-        let(:html) { <<-HTML }
-        <html>
-          <body>
-            <h1>Heading 1</h1>
-            <h2>Heading 2</h2>
-            <h3>Heading 3</h3>
-            <h4>Heading 4</h4>
-            <h2>Heading 2b</h2>
-            <h3>Heading 3b</h3>
-          </body>
-        </html>
-        HTML
-
-        it 'renders a nested hierarchy' do
-          expected = <<-TEXT
-h1
-  h2
-    h3
-      h4
-  h2
-    h3
-TEXT
-          expect( hierarchy.to_s ).to eq expected.strip
-        end
-      end
-    end
-
-    context "hidden headings" do
-      let(:html) { <<-HTML }
-        <html>
-          <body>
-            <h1 style="display:none">Heading 1</h1>
-          </body>
-        </html>
-      HTML
-
-      it "sees them" do
-        expect( hierarchy.to_s ).to eq "h1"
-      end
-
-    end
-
-    context "headings within a script tag" do
-      # e.g. template elements too
-      let(:html) { <<-HTML }
-        <html>
-          <body>
-            <h1>Heading 1</h1>
-            <script>
-              var stuff = "<h2>Heading 2</h2>";
-            </script>
-          </body>
-        </html>
-      HTML
-
-      it "ignores them" do
-        expect( hierarchy.to_s ).to eq "h1"
-      end
-    end
-
-    context "with headings before the first h1" do
-      # rules only apply to headings after the main h1
-      let(:html) { <<-HTML }
-        <html>
-          <body>
-            <h3>Ignore me</h3>
-            <h1>Heading 1</h1>
-            <h2>Heading 2</h2>
-          </body>
-        </html>
-      HTML
-
-      it "ignores them" do
-          expected = <<-TEXT
-h1
-  h2
-TEXT
-        expect( hierarchy.to_s ).to eq expected.strip
-      end
-    end
-
-  end
-end

data/spec/bbc/a11y/cucumber_support/matchers_spec.rb

@@ -1,52 +0,0 @@
-require 'bbc/a11y/cucumber_support/matchers'
-require 'capybara'
-
-module BBC::A11y::CucumberSupport
-  describe 'matchers' do
-    let(:page) do
-      Capybara.string(html)
-    end
-
-    describe '#have_title_attribute_or_associated_label_tag' do
-      context 'a form field with a title attribute' do
-        let(:element) { Capybara.string(<<-HTML).find('input') }
-        <input type="text" name="q" title="Search the BBC" />
-        HTML
-        it 'passes' do
-          expect(element).to have_title_attribute_or_associated_label_tag
-        end
-      end
-
-      context 'a form field with a label, associated by `for` attribute' do
-        let(:element) { Capybara.string(<<-HTML).find('input') }
-        <label for="search">Search the BBC</label>
-        <input type="text" id="search" name="q" />
-        HTML
-        it 'passes' do
-          expect(element).to have_title_attribute_or_associated_label_tag
-        end
-      end
-
-      context 'a form field within a label' do
-        let(:element) { Capybara.string(<<-HTML).find('input') }
-        <label for="search">
-          Search the BBC
-          <input type="text" name="q" />
-        </label>
-        HTML
-        it 'passes' do
-          expect(element).to have_title_attribute_or_associated_label_tag
-        end
-      end
-
-      context "a form field without associated label tag or title attribute" do
-        let(:element) { Capybara.string(<<-HTML).find('input') }
-        <input type="text" name="name" />
-        HTML
-        it 'fails' do
-          expect(element).not_to have_title_attribute_or_associated_label_tag
-        end
-      end
-    end
-  end
-end

data/spec/bbc/a11y/cucumber_support/page_spec.rb

@@ -1,197 +0,0 @@
-require 'bbc/a11y/cucumber_support/page'
-require 'capybara'
-
-module BBC::A11y::CucumberSupport
-  describe Page do
-    let(:page) do
-      Page.new(Capybara.string(html))
-    end
-
-    describe '#all_elements_matching' do
-      context 'with multiple matches' do
-        let(:html) { <<-HTML }
-        <html>
-          <ul>
-            <li><p></li>
-            <li></li>
-          </ul>
-        </html>
-        HTML
-        it 'returns each element that matches' do
-          expect(page.all_elements_matching('li', 'p').length).to eq 3
-        end
-      end
-    end
-
-    describe '#must_have_lang_attribute' do
-      context 'with no lang attribute' do
-        let(:html) { <<-HTML }
-        <html>
-        </html>
-        HTML
-
-        it 'fails' do
-          expect { page.must_have_lang_attribute }.to raise_error(
-            RSpec::Expectations::ExpectationNotMetError, 
-            %{expected to find css "html[lang]" but there were no matches})
-        end
-      end
-
-      context 'with a lang attribute' do
-        let(:html) { <<-HTML }
-        <html lang="en-GB">
-        </html>
-        HTML
-
-        it 'passes' do
-          expect { page.must_have_lang_attribute }.not_to raise_error
-        end
-      end
-    end
-
-    describe '#must_have_lang_attribute_of' do
-      let(:html) { <<-HTML }
-      <html lang="en-GB">
-      </html>
-      HTML
-
-      it 'passes for a matching lang attribute' do
-        expect { page.must_have_lang_attribute_of('en') }.not_to raise_error
-      end
-
-      it 'fails for the wrong language code' do
-        expect { page.must_have_lang_attribute_of('fr') }.to raise_error(RSpec::Expectations::ExpectationNotMetError)
-      end
-    end
-
-    describe "#must_have_no_elements_with_title_attribute_content_repeated_within" do
-      context "when an element has the same title attribute as its contents" do
-        let(:html) { <<-HTML }
-        <html>
-          <body>
-            <a title="News">News</a>
-          </body>
-        </html>
-        HTML
-
-        it "fails" do
-          expect { page.must_have_no_elements_with_title_attribute_content_repeated_within }.
-            to raise_error(RSpec::Expectations::ExpectationNotMetError)
-        end
-      end
-
-      context "when an element has a valid title" do
-        let(:html) { <<-HTML }
-        <html>
-          <body>
-            <img title="A picture of a cat">
-          </body>
-        </html>
-        HTML
-
-        it "passes" do
-          expect { page.must_have_no_elements_with_title_attribute_content_repeated_within }.
-            not_to raise_error
-        end
-      end
-
-    end
-
-    describe "#must_have_no_form_fields_with_label_and_title" do
-      context "a form field with both label and title" do
-        let(:html) { <<-HTML }
-        <html>
-          <body>
-            <form>
-              <label for="name">Your name</label>
-              <input id="name" title="Your name please">
-            </form>
-          </body>
-        </html>
-        HTML
-
-        it "fails" do
-          expect { page.must_have_no_form_fields_with_label_and_title }.
-            to raise_error(RSpec::Expectations::ExpectationNotMetError)
-        end
-      end
-    end
-
-    describe "#must_not_have_any_elements_with_tabindex_greater_than" do
-      context "an element with a tabindex value of 1" do
-        let(:html) { <<-HTML }
-        <html>
-          <body>
-            <a tabindex="1">Important</a>
-          </body>
-        </html>
-        HTML
-
-        it "fails for zero" do
-          expect { page.must_not_have_any_elements_with_tabindex_greater_than 0 }.
-            to raise_error(RSpec::Expectations::ExpectationNotMetError)
-        end
-
-        it "passes for 1" do
-          expect { page.must_not_have_any_elements_with_tabindex_greater_than 0 }.
-            to raise_error(RSpec::Expectations::ExpectationNotMetError)
-        end
-      end
-    end
-
-    describe "#must_not_have_elements_with_tabindex" do
-
-      context "an element that's in the list of exceptions" do
-        let(:html) { <<-HTML }
-        <html>
-          <body>
-            <a tabindex="0">Important</a>
-          </body>
-        </html>
-        HTML
-
-        it "passes" do
-          expect { page.must_not_have_elements_with_tabindex(0, except: 'a') }.not_to raise_error
-        end
-      end
-
-      context "an element not in the list of exceptions" do
-        let(:html) { <<-HTML }
-        <html>
-          <body>
-            <p tabindex="0">Important</a>
-          </body>
-        </html>
-        HTML
-
-        it "fails" do
-          expect { page.must_not_have_elements_with_tabindex(0, except: 'a') }.
-            to raise_error(RSpec::Expectations::ExpectationNotMetError)
-        end
-      end
-
-      context "a different tabindex value" do
-        let(:html) { <<-HTML }
-        <html>
-          <body>
-            <p tabindex="-1">Important</a>
-          </body>
-        </html>
-        HTML
-
-        it "passes" do
-          expect { page.must_not_have_elements_with_tabindex(0, except: 'a') }.not_to raise_error
-        end
-      end
-    end
-
-    describe '#to_s' do
-      let(:html) { "<html><body><h1>Header</h1><p>More stuff</p></body></html>" }
-
-      it 'renders the visible text on the page' do
-        expect(page.to_s).to eq "HeaderMore stuff"
-      end
-    end
-
-  end
-end