bbc-a11y 0.0.12 → 0.0.13

data/lib/bbc/a11y/cli.rb

@@ -1,72 +1,60 @@
 require 'bbc/a11y/configuration'
-require 'bbc/a11y'
+require 'bbc/a11y/linter'
+require 'open-uri'
+require 'capybara'
+require 'colorize'
 
 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(runner)
-        trap_interrupt
-        runner.new(settings, cucumber_args).call
-      rescue TestsFailed
-        exit 1
-      rescue MissingArgument => error
-        exit_with_message "You missed an argument: #{error.message}", HELP
-      end
-
-      private
-
-      def settings
-        return Configuration.for_urls(a11y_args) if a11y_args.any?
-        A11y.until_version('0.1.0') do
-          exit_with_message "Please rename your .a11y.rb configuration file to a11y.rb" if File.exist?(".a11y.rb")
+      def call
+        all_errors = []
+        settings.pages.each do |page_settings|
+          errors = check_standards_for(page_settings)
+          if errors.empty?
+            stdout.puts "✓ #{page_settings.url}".colorize(:green)
+          else
+            stdout.puts "✗ #{page_settings.url}".colorize(:red)
+            stdout.puts errors.map { |error|
+              "  - #{error}"
+            }.join("\n")
+          end
+          all_errors += errors
         end
-        Configuration.parse(File.expand_path("a11y.rb"))
+        exit 1 unless all_errors.empty?
+      rescue Configuration::ParseError => error
+        exit_with_message error.message
       end
 
-      def a11y_args
-        if args.find_index('--')
-          args[0..(args.find_index('--') - 1)]
-        else
-          args
-        end
-      end
+      private
 
-      def cucumber_args
-        return [] unless args.include?('--')
-        args[(args.find_index('--') + 1)..-1]
+      def check_standards_for(page_settings)
+        standards = Standards.for(page_settings)
+        html = open(page_settings.url).read
+        Linter.new(Capybara.string(html), standards).run.errors.to_a
       end
 
-      def trap_interrupt
-        trap('INT') do
-          exit!(1) if Cucumber.wants_to_quit
-          Cucumber.wants_to_quit = true
-          STDERR.puts "\nExiting... Interrupt again to exit immediately."
-        end
+      def settings
+        return Configuration.for_urls(@args) if @args.any?
+        configuration_file = File.expand_path("a11y.rb")
+        Configuration.parse(configuration_file)
       end
 
       def exit_with_message(*messages)
-        messages.each { |message| puts message }
-        raise SystemExit
+        messages.each { |message| stderr.puts message }
+        exit 1
       end
 
       attr_reader :stdin, :stderr, :stdout, :args
       private :stdin, :stderr, :stdout, :args
 
       HELP = %{
-Usage: a11y [-- cucumber-args]
-
-cucumber-args   - Arguments to pass to Cucumber when running the tests. See cucumber --help
-                  for details.
+Usage: a11y [url]
 }
 
     end

data/lib/bbc/a11y/configuration.rb

@@ -1,19 +1,20 @@
+require 'pathname'
+
 module BBC
   module A11y
 
     def self.configure(&block)
-      @settings = Configuration::DSL.new(block).settings
+      Configuration::DSL.new(block).settings
     end
 
-    def self.configuration
-      @settings ||= Configuration::Settings.new
+    # TODO: add tests for this?
+    def self.configure_from_file(filename)
+      Configuration::DSL.new(File.read(filename), filename).settings
     end
 
     module Configuration
-      def self.parse(file)
-        require file
-        # the file should call BBC::A11y.configure
-        BBC::A11y.configuration
+      def self.parse(filename)
+        BBC::A11y.configure_from_file(filename)
       end
 
       def self.for_urls(urls)
@@ -21,6 +22,28 @@ module BBC
         Settings.new.with_pages(page_settings)
       end
 
+      ParseError = Class.new(StandardError) do
+        def message
+           file, line = backtrace.first.split(":")[0..1]
+           file = Pathname.new(file).relative_path_from(Pathname.new(Dir.pwd))
+           line = line.to_i
+           source_snippet = File.read(file).lines.each_with_index.map { |content, index|
+             indent = (index == line - 1) ? "=> " : "   "
+             indent + content
+           }[line - 2..line]
+
+           [
+             "There was an error reading your configuration file at line #{line} of '#{file}'",
+             "",
+             source_snippet,
+             "",
+             super,
+             "",
+             "For help learning the configuration DSL, please visit https://github.com/cucumber-ltd/bbc-a11y"
+           ]
+        end
+      end
+
       class Settings
         attr_reader :before_all_hooks,
           :after_all_hooks,
@@ -39,30 +62,44 @@ module BBC
       end
 
       class PageSettings
-        attr_reader :url, :scenarios_to_skip, :world_extensions
+        attr_reader :url
+        attr_reader :skipped_standards
 
-        def initialize(url, scenarios_to_skip = [], world_extensions = [])
+        def initialize(url, skipped_standards=[])
           @url = url
-          @scenarios_to_skip = scenarios_to_skip
-          @world_extensions = world_extensions
+          @skipped_standards = skipped_standards
           freeze
         end
 
-        def skip_test_case?(test_case)
-          @scenarios_to_skip.any? { |pattern| test_case.name.match pattern }
+        def merge(other)
+          self.class.new(url, skipped_standards + other.skipped_standards)
         end
 
-        def merge(other)
-          self.class.new(url, scenarios_to_skip + other.scenarios_to_skip, world_extensions + other.world_extensions)
+        def skip_standard?(standard)
+          @skipped_standards.any? { |pattern|
+            pattern.match(standard.name)
+          }
         end
       end
 
       class DSL
         attr_reader :settings
-        def initialize(block)
+
+        def initialize(config, config_filename = nil)
           @settings = Settings.new
           @general_page_settings = []
-          instance_eval &block
+          begin
+            if config_filename
+              instance_eval config, config_filename
+            else
+              instance_eval &config
+            end
+          rescue NoMethodError => error
+            method_name = error.message.scan(/\`(.*)'/)[0][0]
+            raise Configuration::ParseError, "`#{method_name}` is not part of the configuration language", error.backtrace
+          rescue => error
+            raise Configuration::ParseError, error.message, error.backtrace
+          end
           @settings = settings.with_pages(apply_general_settings(settings.pages))
         end
 
@@ -102,13 +139,10 @@ module BBC
           instance_eval &block if block
         end
 
-        def skip_scenario(name)
-          @settings.scenarios_to_skip << name
+        def skip_standard(pattern)
+          @settings.skipped_standards << pattern
         end
 
-        def customize_world(&block)
-          @settings.world_extensions << Module.new(&block)
-        end
       end
 
     end

data/lib/bbc/a11y/linter.rb

@@ -0,0 +1,42 @@
+require 'bbc/a11y/standards'
+
+module BBC
+  module A11y
+
+    class Linter
+      def initialize(page, standards=Standards.all)
+        @page = page
+        @standards = standards
+      end
+
+      def run
+        errors = []
+        @standards.each do |standard|
+          standard.new(@page).call(errors)
+        end
+        LintResult.new(errors)
+      end
+    end
+
+    class LintResult
+      def initialize(errors)
+        @errors = errors
+      end
+
+      def passed?
+        @errors.empty?
+      end
+
+      def failed?
+        !passed?
+      end
+
+      def to_s
+        @errors.map(&:to_s).join("\n")
+      end
+
+      attr_reader :errors
+    end
+
+  end
+end

data/lib/bbc/a11y/standards.rb

@@ -0,0 +1,43 @@
+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'
+
+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
+        ]
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,20 @@
+module BBC
+  module A11y
+    module Standards
+      class ExactlyOneMainHeading
+        def initialize(page)
+          @page = page
+        end
+
+        def call(errors)
+          count = @page.all('h1').size
+          if count != 1
+            errors << "A document must have exactly one heading." +
+                      " Found #{count} h1 elements."
+          end
+        end
+
+      end
+    end
+  end
+end

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

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

@@ -0,0 +1,39 @@
+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]), 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

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

@@ -0,0 +1,21 @@
+module BBC
+  module A11y
+    module Standards
+      class FormSubmitButtons
+        def initialize(page)
+          @page = page
+        end
+
+        def call(errors)
+          @page.all("form").each do |form|
+            submits = form.all("input[type=submit]")
+            if submits.empty?
+              errors << "Form has no submit button: #{form.path}"
+            end
+          end
+        end
+
+      end
+    end
+  end
+end