ada_matcher 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in ada_matcher.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,17 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb"
+end
+
+desc "Generate code coverage"
+RSpec::Core::RakeTask.new(:coverage) do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec']
+end

data/ada_matcher.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ada_matcher/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ada_matcher"
+  s.version     = AdaMatcher::VERSION
+  s.authors     = ["Aaron Brown"]
+  s.email       = ["aaron@thebrownproject.com"]
+  s.homepage    = ""
+  s.summary     = %q{Adds custom rspec matchers that test watir Page objects for ADA compliance}
+  s.description = %q{Adds custom rspec matchers that test watir Page objects for ADA compliance}
+  s.license     = 'MIT'
+
+  s.rubyforge_project = "ada_matcher"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "watir-webdriver", ">0"
+  s.add_development_dependency "headless"
+#  s.add_runtime_dependency "rspec"
+end

data/lib/ada_matcher.rb

@@ -0,0 +1,145 @@
+require "ada_matcher/version"
+
+module AdaMatcher
+  
+  RSpec::Matchers.define :meet_ada_requirements do |reqs|
+    @errors = Array.new
+
+    match do |page|
+      browser = get_page_browser(page)
+      raise Exception.new("Can only test ADA on Watir::Browser and compatible objects (#{browser.class.name})") unless is_browser?(browser)
+
+      to_run = parse_args(reqs)
+      if (to_run.empty? || to_run.include?(:all))
+        @errors += image_alt(browser)
+        @errors += link_title(browser)
+        @errors += link_window_warning(browser)
+        @errors += htag_hierarchy(browser)
+        @errors += label_for(browser)
+      elsif to_run.include?(:image_alt)
+        @errors += image_alt(browser)
+      elsif to_run.include?(:link_title)
+        @errors += link_title(browser)
+      elsif to_run.include?(:link_window_warning)
+        @errors += link_window_warning(browser)
+      elsif to_run.include?(:htag_hierarchy)
+        @errors += htag_hierarchy(browser)
+      elsif to_run.include?(:label_for)
+        @errors += label_for(browser)
+      end
+
+      !(@errors.nil?) && (@errors.length == 0)
+    end
+
+    failure_message_for_should do |actual|
+      title = (actual.title || "Page")
+      "expected that page '#{title}' would meet ADA requirements, but errors were found:\n#{@errors.join("\n")}"
+    end
+
+    failure_message_for_should_not do |actual|
+      title = (actual.title || "Page")
+      "expected that page '#{title}' would not meet ADA requirements, but no errors were found.\n"
+    end
+
+    description do
+      "pass the following ADA requirements: #{to_run.inspect}"
+    end
+
+    def get_page_browser(page)
+      # "page" may be a browser object or, for example, a watir_page_helper object
+      # with a "browser" object embedded within it. Find the nested browser object
+      # and return it so we can continue in a consistent manner.
+      return page.browser if page.respond_to?(:browser)
+      return page.browser if page.instance_variable_defined?(:@browser)
+      return page.browser if page.instance_variable_defined?(:browser)
+      page
+    end
+
+    # We don't care what kind of web driver gave us "page" as long as it
+    # responds to all the API calls we need
+    def is_browser?(browser)
+      browser.respond_to?(:images) && 
+        browser.respond_to?(:links) && 
+        browser.respond_to?(:h1s) &&
+        browser.respond_to?(:h2s) &&
+        browser.respond_to?(:h3s) &&
+        browser.respond_to?(:h4s) &&
+        browser.respond_to?(:labels) &&
+        browser.respond_to?(:text_fields) &&
+        browser.respond_to?(:checkboxes) &&
+        browser.respond_to?(:file_fields) &&
+        browser.respond_to?(:radios) &&
+        browser.respond_to?(:select_lists)
+    end
+
+    def parse_args(args)
+      return [] if args.nil?
+      if args.respond_to? :to_a
+        args.to_a
+      else
+        [args]
+      end
+    end
+
+    def image_alt(page)
+      e = Array.new
+      page.images.each do |img|
+        e << "Image tag is missing 'alt' attribute: #{img.html}" if img.alt.empty?
+      end
+      e  # return error message array
+    end
+
+    def link_title(page)
+      e = Array.new
+      page.links.each do |link|
+        e << "Link tag is missing 'title' attribute: #{link.html}" if link.title.empty?
+      end
+      e  # return error message array
+    end
+
+    def link_window_warning(page)
+      e = Array.new
+      page.links.each do |link|
+        if !(link.target.empty?) && (link.title !~ /window/i)
+          e << "Link does not warn user about opening new window: #{link.html}"
+        end
+      end
+      e  # return error message array
+    end
+
+    def htag_hierarchy(page)
+      e = Array.new
+      if page.h1s.to_a.empty? && !page.h2s.to_a.empty?
+          e << "H2 tag found but no H1 found on page"
+      end
+      if page.h2s.to_a.empty? && !page.h3s.to_a.empty?
+          e << "H3 tag found but no H2 found on page"
+      end
+      if page.h3s.to_a.empty? && !page.h4s.to_a.empty?
+          e << "H4 tag found but no H3 found on page"
+      end
+
+      e  # return error message array
+    end
+
+    def label_for(page)
+      e = Array.new
+      fors = {}
+      page.labels.each do |label|
+        fors[label.for.to_s.to_sym] = 1 unless label.for.nil? || label.for.empty?
+      end
+
+      (page.text_fields.to_a + page.checkboxes.to_a + page.file_fields.to_a + page.radios.to_a + page.select_lists.to_a).each do |fld|
+        if fld.id.nil? || fld.id.to_s.empty?
+          e << "Form field without an ID or a corresponding Label: #{fld.html}"
+        else
+          e << "Form field without a corresponding Label: #{fld.html}" unless fors.has_key? fld.id.to_s.to_sym
+        end
+      end
+
+      e  # return error message array
+    end
+
+  end
+
+end

data/lib/ada_matcher/version.rb

@@ -0,0 +1,3 @@
+module AdaMatcher
+  VERSION = "0.1.0"
+end

data/resources/bad_page.html

@@ -0,0 +1,49 @@
+<html>
+<head>
+	<title>Bad Page</title>
+</head>
+
+<body>
+
+	<h2>Section 1</h2>
+	<!-- img missing alt attribute -->
+	<a href="#" title="Stay here">
+		<img src="someimg.png"/>
+	</a>
+	<br/>
+
+	<h2>Section 2</h2>
+	<!-- link missing title attribute -->
+	<a href="#">
+		<img src="bad.png" alt="this is some alt text"/>
+	</a>
+	<br/>
+
+	<h4>H4 heading here</h4>
+	<!-- link opens in new window without warning -->
+	<a href="http://www.google.com/" title="another page" target="_blank">
+		Google
+	</a>
+	<br/>
+
+	<h2>Section 3</h2>
+	<form action="#">
+		<label for="someInput">textInput</label>
+		<input type="text" id="textInput" name="textInput"/> <br/>
+		<label for="checkboxInput">checkboxInput</label>
+		<input type="checkbox" id="checkboxInput" name="checkboxInput"/> <br/>
+		<label for="checkboxInput2">checkboxInput2</label>
+		<input type="checkbox" id="checkboxInput2" name="checkboxInput2"/> <br/>
+		<label for="doesNotMatch">selectInput</label>
+		<select id="selectInput" name="selectInput">
+			<option value="1">1</option>
+			<option value="2">2</option>
+		</select> <br/>
+		<label for="radioInput1">radioInput1</label>
+		<input type="radio" id="radioInput1" name="radioInput"/> <br/>
+		<label for="radioInput2">radioInput2</label>
+		<input type="radio" id="radioInput2" name="radioInput"/> <br/>
+	</form>
+	
+</body>
+</html>

data/resources/good_page.html

@@ -0,0 +1,41 @@
+<html>
+<head>
+	<title>Good Page</title>
+</head>
+
+<body>
+	<h1>Good Page</h1>
+
+	<h2>Section 1</h2>
+	<a href="#" title="Stay here">
+		<img src="someimg.png" alt="I am a test image"/>
+	</a>
+	<br/>
+	
+	<h2>Section 2</h2>
+	<a href="http://www.google.com/" title="another page - opens in new window" target="_blank">
+		Google
+	</a>
+	<br/>
+
+	<h2>Section 3</h2>
+	<form action="#">
+		<label for="textInput">textInput</label>
+		<input type="text" id="textInput" name="textInput"/> <br/>
+		<label for="checkboxInput">checkboxInput</label>
+		<input type="checkbox" id="checkboxInput" name="checkboxInput"/> <br/>
+		<label for="checkboxInput2">checkboxInput2</label>
+		<input type="checkbox" id="checkboxInput2" name="checkboxInput2"/> <br/>
+		<label for="selectInput">selectInput</label>
+		<select id="selectInput" name="selectInput">
+			<option value="1">1</option>
+			<option value="2">2</option>
+		</select> <br/>
+		<label for="radioInput1">radioInput1</label>
+		<input type="radio" id="radioInput1" name="radioInput"/> <br/>
+		<label for="radioInput2">radioInput2</label>
+		<input type="radio" id="radioInput2" name="radioInput"/> <br/>
+	</form>
+
+</body>
+</html>

data/spec/ada_matcher_spec.rb

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'ada_matcher'
+require 'watir-webdriver'
+require 'headless'
+
+describe "AdaMatcher" do
+  before(:all) do
+    @project_base_path = File.expand_path File.dirname(__FILE__) << "../"
+    @headless = Headless.new
+    @headless.start
+    @browser = Watir::Browser.new
+  end
+
+  after(:all) do
+    @browser.close
+    @headless.destroy
+  end
+
+  before(:each) do
+  end
+
+  after(:each) do
+  end
+
+  it "should pass ADA compliant page" do
+    @browser.goto "file://#{@project_base_path}/../resources/good_page.html"
+    @browser.should meet_ada_requirements
+    # can also say:
+    # @browser.should meet_ada_requirements(:all)
+  end
+
+  it "should fail with bad image tags" do
+    @browser.goto "file://#{@project_base_path}/../resources/bad_page.html"
+    @browser.should_not meet_ada_requirements(:image_alt)
+  end
+
+  it "should fail with bad link tags" do
+    @browser.goto "file://#{@project_base_path}/../resources/bad_page.html"
+    @browser.should_not meet_ada_requirements(:link_title)
+  end
+
+  it "should fail with new window links without warnings" do
+    @browser.goto "file://#{@project_base_path}/../resources/bad_page.html"
+    @browser.should_not meet_ada_requirements(:link_window_warning)
+  end
+
+  it "should fail if H2-H4 tags exist without lower-index H tags" do
+    @browser.goto "file://#{@project_base_path}/../resources/bad_page.html"
+    @browser.should_not meet_ada_requirements(:htag_hierarchy)
+  end
+
+  it "should fail if a Form field exists without a corresponding Label" do
+    @browser.goto "file://#{@project_base_path}/../resources/bad_page.html"
+    @browser.should_not meet_ada_requirements(:label_for)
+  end
+
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: ada_matcher
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Aaron Brown
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-26 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: watir-webdriver
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: headless
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Adds custom rspec matchers that test watir Page objects for ADA compliance
+email: 
+- aaron@thebrownproject.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- ada_matcher.gemspec
+- lib/ada_matcher.rb
+- lib/ada_matcher/version.rb
+- resources/bad_page.html
+- resources/good_page.html
+- spec/ada_matcher_spec.rb
+has_rdoc: true
+homepage: ""
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: ada_matcher
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Adds custom rspec matchers that test watir Page objects for ADA compliance
+test_files: []
+