bbc-a11y 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57852d504ecfb1f43c79ffd2aa4f351cff773313
-  data.tar.gz: 2c3e3cb185c52bda5e4eea0dc7cb85e7f39dddad
+  metadata.gz: 02a747cee79f3519c0fc2124d6069462c8d3a567
+  data.tar.gz: 2206a476f841791cb74013b54f9403c3a3da39b9
 SHA512:
-  metadata.gz: 6c804515aa01568b8c608f70ae4545d55e7bc110895f13beecd73aa97a0f00d42dc7b7badef4468260284c6635894b621c5722a8b085c153d9133774b79bdd27
-  data.tar.gz: 99a9e4ef75d72731b778b0cad73e1d5a24b6534f819ead7a537363a9dde035f61d7e73161e961a8470ca79dfc093d189d0e23e35b46f4624f223ace610603625
+  metadata.gz: c4945eae8117e5e223ac27d834d23196646f7e31b730d958fd5345d8d5928b16816ae828563304f9b9c7b6dbd7dd7aaced3fa3e1726104cc2026592f35684f43
+  data.tar.gz: 5f45f2a0bcb880de8f87edbeee24fc99b60899ab092d26495457e20ff2a77b7a8fbfcdbe615ee993270b46a139e6a760adfa69cd994529be9ed375ed9a728744

data/README.md

@@ -1,54 +1,60 @@
-# BBC Accessiblity Standards
+#BBC Accessiblity Standards
 
-This tool runs a set of tests against a given URL to verify whether it meets the 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/).
 
-## How to use
+## How to install
 
-Run the `a11y` command, passing a URL:
+bbc-a11y is packaged as a Ruby gem. You'll most likely want to create a stand-alone repo to run your accessibilty tests,
+but you can also add it as part of an existing repo.
 
-e.g.
+### Prerequisites
 
-    a11y http://bbc.co.uk
+[Install Ruby](https://www.ruby-lang.org/en/documentation/installation/) and then:
 
-You can also pass arguments to Cucumber (which is used internally) by separating the arguments with `--`. Everything
-after the `--` is passed directly to Cucumber. For example, to skip the tests that require manual interraction:
+    gem install bundler
 
-    a11y http://bbc.co.uk -- -t ~@manual
+### Adding a11y to your project's Gemfile
 
-## How to install
+Create or amend your your project's `Gemfile` to include this line:
 
-A11y is packaged as a Ruby gem, but is not yet available on the public Rubygems server. To install it, you'll need to either build it by hand, or add a reference to the github source in your Gemfile.
+    gem 'bbc-a11y`
 
-### Prerequisites
+Now install the gem:
 
-Install Ruby and `gem install bundler`.
+    bundle install
 
-### Adding a11y to your project's Gemfile
+## Configuration
 
-Open your project's `Gemfile` and this line:
+You'll need to configure a11y with a set of URLs to run the checks against. Create a file `.a11y.rb` in the root of your project that looks something like this:
 
-    gem 'bbc-a11y`, git: 'git@github.com:mattwynne/bbc-a11y.git'
+```
+BBC::A11y.configure do
+  page "http://bbc.co.uk"
+  page "http://bbc.co.uk/news"
+end
+```
 
-Now install the gem:
+### Skipping scenarios
 
-    bundle install --binstubs
+Nobody's perfect. Use `skip_scenario` in the configuration to opt-out of certain checks.
 
-*Note:* You'll need to make sure every user who wants to run `bundle install` (including your continuous integration environment) has at least read access to this Github project.
+```
+BBC::A11y.configure do
+  page "http://bbc.co.uk" do
+    skip_scenario "W3C"
+  end
 
-### Build and install the gem manually
+  page "http://bbc.co.uk/news"
+end
+```
 
-This will install the `a11y` tool globally on your machine.
+A11y will skip any scenarios from the specifications whose name contains that string.
 
-1. Clone this repository
-2. Install dependencies
+## Running it
 
-    ~~~
-    cd bbc-a11y
-    bundle install
-    ~~~
+Once you're configured, you can run the tests using the `a11y` command:
 
-3. Install the gem
+    bundle exec a11y
 
-    ~~~
-    bundle exec rake install
-    ~~~
+This will pick up your `.a11y.rb` configuration file and run the a11y features on each page specified in your configuration. 
+Output is printed to the console.

data/Rakefile

@@ -8,5 +8,6 @@ task :unit do
 end
 
 task :acceptance do
-  sh "cd example && rake"
+  sh "cd examples/local-web-app && rake"
+  sh "cd examples/bbc-pages && rake"
 end

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

@@ -0,0 +1,6 @@
+BBC::A11y.configure do
+
+  page "http://bbc.co.uk/news"
+  page "http://bbc.co.uk/mundo"
+
+end

data/examples/bbc-pages/Gemfile

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

data/examples/bbc-pages/Rakefile

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

data/examples/local-web-app/Rakefile

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

data/features/step_definitions/page_steps.rb

@@ -2,7 +2,7 @@ When(/^I visit the page$/) do
   browser.visit settings.url
 end
 
-When(/^I view the page with JavaScript and CSS disabled$/) do
+When(/^I view the page with JavaScript disabled$/) do
   disable_javascript_and_css
   browser.visit settings.url
 end

data/features/support/capybara.rb

@@ -2,12 +2,6 @@ require 'capybara'
 require 'capybara/dsl'
 require 'capybara/poltergeist'
 
-#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 = :poltergeist
 
@@ -28,7 +22,25 @@ module BBC
       end
 
       def disable_javascript_and_css
-        skip_this_scenario
+        unless Capybara.drivers.keys.include?(:without_js)
+          skip_this_scenario <<-ERROR
+You need to define a non-javascript driver for Capybara in order to run this scenario. Here's an example you could use:
+
+    require 'capybara/selenium'
+    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
+
+You can put this code into your .a11y.rb file
+
+You'll also need to add the `selenium-webdriver` gem to your Gemfile.
+          ERROR
+        else
+          Capybara.current_driver = :without_js
+        end
       end
     end
 

data/features/support/skipper.rb

@@ -1,5 +1,5 @@
 Before do |test_case|
   if settings.scenarios_to_skip.any? { |name| test_case.name.match name }
-    skip_this_scenario
+    skip_this_scenario "Configured to be skipped"
   end
 end

data/lib/bbc/a11y/cli.rb

@@ -29,17 +29,16 @@ module BBC
       end
 
       def cucumber_args
-        return unless args.include?('--')
-        args[args.find_index('--')+1..-1].join(' ')
+        return [] unless args.include?('--')
+        args[args.find_index('--')+1..-1]
       end
 
       attr_reader :stdin, :stderr, :stdout, :args
       private :stdin, :stderr, :stdout, :args
 
       HELP = %{
-Usage: a11y url-to-test [-- cucumber-args]
+Usage: a11y [-- 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.
 }

data/lib/bbc/a11y/cucumber_runner.rb

@@ -6,7 +6,19 @@ require 'colorize'
 
 module BBC
   module A11y
+    module ConsoleWriter
+      def underline(text, character="-")
+        [text, character * text.length].join("\n")
+      end
+
+      def indent(spaces, text)
+        text.split("\n").map { |line| (" " * spaces) + line }.join("\n")
+      end
+    end
+
     class CucumberFormatter
+      include ConsoleWriter
+
       def initialize(*args)
         @current_feature = nil
       end
@@ -14,27 +26,41 @@ module BBC
       def before_test_case(test_case)
         on_new_feature(test_case) do |feature|
           puts
-          puts "#{feature.name}"
-          puts "#{"-" * feature.name.length}"
+          puts underline(feature.name)
           puts
         end
-        print "  - #{test_case.name} "
+        print "  - #{test_case.name}... "
+        @step_results = []
+      end
+
+      def after_test_step(test_step, result)
+        @step_results << [test_step, result]
       end
 
       def after_test_case(test_case, result)
         colour = ResultColour.new(result)
         print colour.apply_to(result.to_s)
-        if result.failed? || result.pending? || result.skipped?
+        if !result.passed?
+          puts
           puts
+          print_scenario
           puts
-          puts colour.apply_to(result.exception.message.to_s)
-          puts colour.apply_to(result.exception.backtrace.join("\n"))
+          puts indent(4, colour.apply_to(result.exception.message.to_s))
+          if result.failed?
+            puts indent(4, colour.apply_to(result.exception.backtrace.join("\n")))
+          end
         end
         puts
       end
 
       private
 
+      def print_scenario
+        @step_results.each do |step, result|
+          step.describe_source_to(StepsPrinter.new, result)
+        end
+      end
+
       def colour(result)
         ResultColour.new(result).apply_to(result.to_s)
       end
@@ -47,6 +73,27 @@ module BBC
         end
       end
 
+      class StepsPrinter
+        include ConsoleWriter
+
+        def before_hook(*)
+        end
+
+        def scenario(*)
+        end
+
+        def feature(*)
+        end
+
+        def after_hook(*)
+        end
+
+        def step(step, result)
+          colour = ResultColour.new(result)
+          puts indent(6, colour.apply_to("#{step.keyword}#{step.name}"))
+        end
+      end
+
       class ResultColour
         def initialize(result)
           @color = :white
@@ -87,8 +134,11 @@ module BBC
     end
 
     class CucumberRunner
+      include ConsoleWriter
+
       def initialize(settings, cucumber_args)
         @settings = settings
+        @cucumber_args = cucumber_args
       end
 
       def call
@@ -112,7 +162,7 @@ module BBC
         @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!([
+        @configuration.parse!(@cucumber_args + [
                               features_path,
                               "--format", "BBC::A11y::CucumberFormatter"])
         @configuration
@@ -129,8 +179,7 @@ module BBC
       def print_page_header(page_settings)
         puts
         puts
-        puts "BBC Accesibility: #{page_settings.url}"
-        puts "=" * "BBC Accesibility: #{page_settings.url}".length
+        underline("BBC Accesibility: #{page_settings.url}")
       end
 
     end

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

@@ -9,17 +9,17 @@ 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
+    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
 
-    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

data/lib/bbc/a11y/version

@@ -1 +1 @@
-0.0.5
+0.0.6

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bbc-a11y
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Matt Wynne
@@ -167,13 +167,16 @@ files:
 - Rakefile
 - bbc-a11y.gemspec
 - bin/a11y
-- example/.a11y.rb
-- example/Gemfile
-- example/Rakefile
-- example/config.ru
-- example/public/missing_header.html
-- example/public/perfect.html
-- example/readme.md
+- examples/bbc-pages/.a11y.rb
+- examples/bbc-pages/Gemfile
+- examples/bbc-pages/Rakefile
+- examples/local-web-app/.a11y.rb
+- examples/local-web-app/Gemfile
+- examples/local-web-app/Rakefile
+- 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/01_core-purpose.md
 - features/02_validation.feature
 - features/03_javascript.feature
@@ -240,7 +243,7 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: bbc-a11y-0.0.5
+summary: bbc-a11y-0.0.6
 test_files:
 - features/01_core-purpose.md
 - features/02_validation.feature

data/example/Rakefile

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