raakt 0.5.5 → 0.5.6

data/CHANGELOG

@@ -0,0 +1,2 @@
+v0.5.6. Updating to new version of Rubygems to make installation simpler. Docs
+fixes (Oh _why where are you?). No new functionality.

data/LICENSE

@@ -0,0 +1,11 @@
+
+Copyright (c) 2007, Peter Krantz (http://www.peterkrantz.com)
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+    * Neither the name of Peter Krantz nor the names of contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Manifest

@@ -0,0 +1,102 @@
+CHANGELOG
+LICENSE
+Manifest
+README
+TODO
+examples/acctest.rb
+examples/crawlandtest.rb
+examples/list_site_urls.rb
+examples/seleniumrc_example.rb
+examples/svarta_listan.rb
+examples/watir_example.rb
+lib/iso_language_codes.rb
+lib/raakt.rb
+raakt.gemspec
+rakefile
+service/files/base.css
+service/files/button-left.png
+service/files/button-right.png
+service/files/grad.png
+service/files/jquery-131.js
+service/files/round-br.png
+service/files/round-tl.png
+service/files/round-tr.png
+service/files/tab-tl.png
+service/files/tab-tr.png
+service/files/test.js
+service/files/textbg.png
+service/files/w3c.png
+service/index.rhtml
+service/server.rb
+tests/areadoc1.htm
+tests/areadoc2.htm
+tests/areadoc3.htm
+tests/bdoc.htm
+tests/charset_nocharset_specified.htm
+tests/charset_utf8.htm
+tests/difficult_words1.htm
+tests/difficult_words2.htm
+tests/difficult_words3.htm
+tests/difficult_words4.htm
+tests/difficult_words5.htm
+tests/difficult_words6.htm
+tests/difficult_words7.htm
+tests/embeddoc1.htm
+tests/empty.htm
+tests/emptytitledoc.htm
+tests/fielddoc1.htm
+tests/fielddoc2.htm
+tests/fielddoc3.htm
+tests/flickerdoc1.htm
+tests/formdoc1.htm
+tests/formdoc2.htm
+tests/formdoc3.htm
+tests/framedoc1.htm
+tests/framedoc2.htm
+tests/full_berg.htm
+tests/full_google.htm
+tests/headingsdoc1.htm
+tests/headingsdoc10.htm
+tests/headingsdoc2.htm
+tests/headingsdoc3.htm
+tests/headingsdoc4.htm
+tests/headingsdoc5.htm
+tests/headingsdoc6.htm
+tests/headingsdoc7.htm
+tests/headingsdoc8.htm
+tests/headingsdoc9.htm
+tests/imagedoc1.htm
+tests/imagedoc2.htm
+tests/imagedoc3.htm
+tests/imagedoc4.htm
+tests/inputimgdoc1.htm
+tests/invalidelements1.htm
+tests/invalidhtmldoc1.htm
+tests/invalidhtmldoc2.htm
+tests/invalidxhtmldoc1.htm
+tests/langinfodoc1.htm
+tests/langinfodoc2.htm
+tests/linkdoc1.htm
+tests/linkdoc2.htm
+tests/linkdoc3.htm
+tests/linkdoc4.htm
+tests/metarefreshdoc1.htm
+tests/metarefreshdoc2.htm
+tests/metarefreshdoc3.htm
+tests/nestedcomment.htm
+tests/nestedtabledoc.htm
+tests/newlinetext.txt
+tests/raakt_test.rb
+tests/scriptdoc1.htm
+tests/scriptdoc2.htm
+tests/tabledoc1.htm
+tests/tabledoc2.htm
+tests/tabledoc3.htm
+tests/tabledoc4.htm
+tests/tabledoc5.htm
+tests/tabledoc6.htm
+tests/tabledoc7.htm
+tests/tablelayoutdoc.htm
+tests/test_helper.rb
+tests/xhtmldoc1.htm
+Rakefile

data/README

@@ -0,0 +1,83 @@
+
+RAAKT - The Ruby Accessibility Analysis Kit
+
+Copyright (c) 2006, Peter Krantz (http://www.peterkrantz.com)
+All rights reserved.
+
+License: See LICENSE file.
+
+RAAKT is a toolkit to find accessibility issues in HTML documents. RAAKT can be used as part of a an automatic test procedure or as a standalone module for mass validation of all pages in a site. RAAKT is based on PAAKT the Python Accessibility Analysis Kit.
+
+The following checks are done:
+
+check_document_structure
+check_tables
+check_for_formatting_elements
+check_has_heading
+check_form
+check_link_text
+check_title
+check_frames
+check_images
+check_refresh
+check_for_nested_tables
+check_for_language_info
+
+RAAKT output is in the form of an array of error message objects. An error message object has an id which can be used to find out more about the specific error.
+
+To run unit tests for raakt, see the raakt_test.rb file in the tests folder. Some of the tests access remote documents over the internet. To include remote tests, run the test suite with the "includeremote" parameter:
+
+	> ruby raakt_test.rb includeremote
+
+
+CONTRIBUTIONS
+
+Patch to use hpricot by Derek Perrault.
+
+MORE INFO 
+
+For more information about RAAKT, please contact peter dot krantz at gmail dot com or see http://peterkrantz.com/projects/raakt
+
+To use RAAKT as a command line tool (see acctest.rb in the examples dir of the installed gem):
+
+
+	# This is a sample command line script that uses the raakt gem to test a html document.
+	require 'rubygems'
+	require 'net/http'
+	require 'uri'
+	require 'raakt'
+
+	#Parse command line url argument
+	url = ARGV[0] || ""
+
+	if url.length == 0
+	  puts "\nRuby Accessibility Analysis Kit\n\n  Usage: raakt <url>\n  Example: raakt http://www.rubylang.org/en"
+	  return
+	else
+	  #Clean the url and make sure protocol and trailing slash is available
+	  url = "http://" + url unless url[0..3] == "http"
+	end
+
+	#Get html for the url specified (does not follow redirects)
+	puts "Fetching #{url}...\n"
+	uri = URI.parse(url)
+	res = Net::HTTP.start(uri.host, uri.port) {|http|
+	  http.get(uri.path)
+	}
+
+	# Set up the RAAKT test
+	raakttest = Raakt::Test.new(res.body)
+
+	#Run all checks and print result to the console
+	result = raakttest.all
+
+	if result.length > 0
+	  puts "Accessibility problems detected:"
+	  puts result
+	else
+	  puts "No measurable accessibility problems were detected."
+	end
+
+
+
+

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('raakt') do |s|
+  s.name = 'raakt'
+  s.summary = 'A toolkit to find basic accessibility issues in HTML documents.'
+  s.runtime_dependencies = ["hpricot >=0.6"]
+  s.has_rdoc = true
+  s.ruby_version = '>= 1.8.2'
+  s.files = FileList['lib/*.rb', 'tests/*'].to_a
+  s.test_files = Dir.glob('tests/raakt_test.rb')
+  s.author = "Peter Krantz"
+  s.email = "peter.krantzNODAMNSPAM@gmail.com"
+  s.url = "http://www.peterkrantz.com/raakt/wiki/"
+  s.ignore_pattern = ["examples", "pkg", "service"]
+end
+

data/TODO

@@ -0,0 +1,9 @@
+TODO
+----
+- Standalone web server interface for local testing
+- check for xml:lang as well
+
+
+DONE
+----
+- Pluggable wordlist support to find diffcult words that should be avoided (e.g. "svarta listan" for Swedish)

data/examples/acctest.rb

@@ -0,0 +1,42 @@
+# This is a sample command line script that uses the raakt gem to test a html document. Please install the mechanize gem before running this script.
+require 'mechanize'
+require File.dirname(__FILE__) + '/../lib/raakt' #or just 'raakt' of you have installed the gem
+
+#Parse command line url argument to get URL
+url = ARGV[0] || ""
+
+if url.length == 0
+  puts "\nRuby Accessibility Analysis Kit Example\n\n  Usage: ruby acctest.rb <url>\n  Example: ruby acctest.rb http://www.rubylang.org/en\n\nView source for this file for example usage."
+  exit
+end
+
+#Get html for the url specified (does not follow redirects)
+puts "Fetching #{url}...\n"
+
+#Allow for bastard-sized asp.net view state attribute values...
+Hpricot.buffer_size = 262144
+
+#Set up mechanize agent
+agent = WWW::Mechanize.new
+agent.pluggable_parser.default = Hpricot
+
+# Set user_agent string
+# See possible values here:
+# http://mechanize.rubyforge.org/classes/WWW/Mechanize.html#constants-list
+agent.user_agent_alias = 'Mac Safari' 
+
+# Get the page
+page = agent.get(url)
+
+# Set up the RAAKT test and pass html and headers
+raakttest = Raakt::Test.new(page.body, page.header.to_hash)
+
+#Run all checks and print result to the console
+result = raakttest.all
+
+if result.length > 0
+  puts "Accessibility problems detected:"
+  puts result
+else
+  puts "No measurable accessibility problems were detected."
+end

data/examples/crawlandtest.rb

@@ -0,0 +1,64 @@
+require 'net/http'
+require 'uri'
+
+class SiteCrawler
+
+	def initialize(url)
+		@site_uri = URI.parse(url)
+		@site_uri.path = "/" if @site_uri.path == ""
+		@visited = Hash.new
+		@queue = Array.new
+		addPath(@site_uri.path)
+		puts "Initialized site crawl for #{@site_uri}"
+	end
+
+
+	def addPath(path)
+		@queue.push path
+		@visited[path] = false
+	end
+	
+	
+	def getPage(path)
+		begin
+			uri = @site_uri.clone
+			uri.path = uri.path + path if path != "/"
+			puts "getting #{uri}"
+			response = Net::HTTP.get_response(uri)
+		rescue Exception
+			puts "Error: #{$!}"
+			return ""
+		end
+		return response.body
+	end
+	
+	
+	def queueLocalLinks(html)
+		html.scan(/<a href\s*=\s*["']([^"]+)"/i) {|w|
+			uri = URI.parse("#{w}")
+			if !@visited.has_key?(uri.path) and (uri.relative? or uri.host == @site_uri.host)
+				addPath(uri.path)
+			end
+		}
+	end
+	
+	
+	def crawlSite()
+		while (!@queue.empty?)
+			uri = @queue.shift
+			page = getPage(uri)
+			yield uri, page
+			queueLocalLinks(page)
+			@visited[uri] = true
+		end
+	end
+end
+
+
+sc = SiteCrawler.new(ARGV[0])
+@pages = Array.new
+sc.crawlSite { |url, page_text|
+	puts url
+	@pages << url
+	 # SITE_INDEX <<{ :url => url, :context => page_text }
+}

data/examples/list_site_urls.rb

@@ -0,0 +1,12 @@
+require '../lib/simplecrawler.rb'
+
+# Set up a new crawler
+sc = SimpleCrawler::Crawler.new(ARGV[0])
+sc.skip_patterns = ["\\.doc$", "\\.pdf$", "\\.xls$", "\\.pdf$", "\\.zip$"]
+
+sc.crawl { |document|
+
+	# List links for entire site
+	puts document.uri
+
+}

data/examples/seleniumrc_example.rb

@@ -0,0 +1,21 @@
+require 'spec'
+require 'selenium'
+require 'raakt'
+
+context 'Test Google' do
+  setup do
+    @sel = Selenium::SeleniumDriver.new("localhost", 4444, "*iexplore", "http://www.google.com", 15000)
+    @sel.start
+  end
+		
+  specify'assert start page accessibility' do
+    @sel.open("http://www.google.com/webhp")
+	raakttest = Raakt::Test.new(@sel.get_html_source)
+	result = raakttest.all
+	result.should be([])
+  end
+	
+  teardown do
+    @sel.stop
+  end
+end

data/examples/svarta_listan.rb

@@ -0,0 +1,100 @@
+# This is an example wordlist to use with the check_difficult_words test.
+# It is in the form of a hash where the key is the phrase to look for and the value
+# is the recommended alternative word/phrase.
+#
+# In swedish: Denna ordlista är baserad på "Svarta listan- Ord och fraser 
+# som kan ersättas i författningsspråk". Ordlistan ges ut av rättschefen
+# i Statsrådsberedningen och har utarbetats av språkexperterna på 
+# Justitiedepartementets granskningsenhet.
+#
+# För mer information se: http://www.regeringen.se/sb/d/243/a/19775
+
+SVARTA_LISTAN = {
+	"anhängiggöra" => "Skriv hellre 'väcka/inleda'.",
+	"anbringa" => "Skriv hellre 'sätta upp/sätta på/placera/fästa (på något)'.",
+	"anmana" => "Skriv hellre 'uppmana'.",
+	"anmaning" => "Skriv hellre 'uppmaning'.",
+	"anmoda" => "Skriv hellre 'uppmana'.",
+	"anmodan" => "Skriv hellre 'uppmaning'.",
+	"anmodas" => "Skriv hellre 'uppmanas'.",
+	"avbida" => "Skriv hellre 'invänta/vänta (på)/avvakta'.",
+	"avbidan" => "Skriv hellre 'väntan'.",
+	"avge" => "Skriv hellre 'ge (bud), lämna (anbud, rapport m.m.)'.",
+	"avnämare" => "Skriv hellre 'användare/mottagare/konsument/kund'.",
+	"avskrift" => "Skriv hellre 'kopia'.",
+	"avsända" => "Skriv hellre 'sända/skicka (i väg)'.",
+	"belägen" => "Skriv hellre 'ligger (i)'.",
+	"bereda" => "Skriv hellre 'ge/låta'.",
+	"beskaffenhet" => "Skriv hellre 'art/slag/sort'.",
+	"utan dröjsmål" => "Skriv hellre 'genast/omedelbart/snarast/möjligt'.",
+	"därvid" => "Skriv hellre 'då/i det sammanhanget'.",
+	"efterkomma" => "Skriv hellre 'lyda/följa'.",
+	"efterlevas" => "Skriv hellre 'följas'.",
+	"eljest" => "Skriv hellre 'annars/annat/på annat sätt/av andra skäl/i övrigt/av någon annan anledning'.",
+	"envar" => "Skriv hellre 'var och en'.",
+	"ettvart" => "Skriv hellre 'vart och ett'.",
+	"erfara" => "Skriv hellre 'få veta'.",
+	"erfordra" => "Skriv hellre 'behövs/krävs/är nödvändigt'.",
+	"erfordras" => "Skriv hellre 'behövs/krävs/är nödvändigt'.",
+	"erforderliga" => "Skriv hellre 'behövs/krävs/är nödvändigt'.",
+	"erforderlig" => "Skriv hellre 'nödvändig/tillräcklig'.",
+	"erhålla" => "Skriv hellre 'få'.",
+	"erinran" => "Skriv hellre 'upplysning (om)'.",
+	"erinra" => "Skriv hellre 'invända'.",
+	"erlägga" => "Skriv hellre 'betala'.",
+	"foga" => "Skriv hellre 'lämna (in) (tillsammans med)'.",
+	"föranleda" => "Skriv hellre 'det finns'.",
+	"föranleder" => "Skriv hellre 'det finns'.",
+	"föranstalta" => "Skriv hellre 'ordna så/ordna med/sörja för/se till'.",
+	"förebringa" => "Skriv hellre 'lägga fram/lämna'.",
+	"föreligga" => "Skriv hellre 'finnas'.",
+	"föreligger" => "Skriv hellre 'det finns'.",
+	"företa" => "Skriv hellre 'göra'.",
+	"förete" => "Skriv hellre 'visa (upp)'.",
+	"förfaller till betalning" => "Skriv hellre '(senast) skall betalas'.",
+	"förfara" => "Skriv hellre '(skall) göra'.",
+	"förflutit" => "Skriv hellre 'det har gått'.",
+	"förordna" => "Skriv hellre 'besluta/bestämma/utse'.",
+	"försorg" => "Skriv hellre 'se till att'.",
+	"förutskicka" => "Skriv hellre 'meddela på förhand/i förväg'.",
+	"handha" => "Skriv hellre 'ha hand om/sköta'.",
+	"hemställa" => "Skriv hellre 'begära/föreslå'.",
+	"hörsamma" => "Skriv hellre 'följa/lyda/rätta sig efter'.",
+	"ikläda" => "Skriv hellre 'ta på'.",
+	"inhämta" => "Skriv hellre 'skaffa'.",
+	"inkomma med" => "Skriv hellre 'lämna in/skicka in/sända över'.",
+	"jämförlig" => "Skriv hellre 'liknande'.",
+	"jämka" => "Skriv hellre 'sänka/minska/sätta ned/ner/(för)ändra'.",
+	"lagfaren" => "Skriv hellre 'vara jurist/som avlagt jur.kand. examen/med jur.kand.-examen'.",
+	"lagrum" => "Skriv hellre 'bestämmelse/paragraf'.",
+	"lända till förfång" => "Skriv hellre 'skada/vara till skada'.",
+	"medge anstånd" => "Skriv hellre 'bevilja anstånd'.",
+	"nyttja" => "Skriv hellre 'använda'.",
+	"nöjaktig" => "Skriv hellre 'godtagbar/som får godtas'.",
+	"olägenhet" => "Skriv hellre 'besvär/problem'.",
+	"oundgänglig" => "Skriv hellre 'nödvändig/absolut'.",
+	"påkalla" => "Skriv hellre 'begära/kräva'.",
+	"utom riket" => "Skriv hellre 'utomlands/utanför Sverige'.",
+	"rådrum" => "Skriv hellre 'tid (på sig)'.",
+	"stadfästa" => "Skriv hellre 'godkänna, fastställa, bekräfta'.",
+	"stadgas" => "Skriv hellre 'föreskrivs'.",
+	"såvitt avser" => "Skriv hellre 'när det gäller/i fråga om'.",
+	"tillkommer" => "Skriv hellre 'har'.",
+	"tillskapa" => "Skriv hellre 'bilda, inrätta, skapa'.",
+	"tillställa" => "Skriv hellre 'lämna/ge/sända/skicka till'.",
+	"tillställas" => "Skriv hellre 'lämna/ge/sända/skicka till'.",
+	"underlåta" => "Skriv hellre 'låta bli/inte'.",
+	"uppbära" => "Skriv hellre 'få/ha'.",
+	"ersättning utgår" => "Skriv hellre 'ersättningen betalas (ut)/lämnas'.",
+	"utröna" => "Skriv hellre 'ta reda på/klarlägga'.",
+	"vederlag" => "Skriv hellre 'ersättning/motprestation'.",
+	"ådöma" => "Skriv hellre 'döma till/döma ut'.",
+	"ådömas" => "Skriv hellre 'dömas till/dömas ut'.",
+	"åligger" => "Skriv hellre 'är skyldig (att)/skall/har'.",
+	"åligganden" => "Skriv hellre 'skyldigheter'.",
+	"åsätta" => "Skriv hellre 'fastställa'.",
+	"åsatts" => "Skriv hellre 'fastställts'.",
+	"åtnjuta" => "Skriv hellre 'få/ha/beviljas'.",
+	"åtnjuter" => "Skriv hellre 'har'.",
+	"åtnjutit" => "Skriv hellre 'fått'.",
+}