raakt 0.1 → 0.3

data/lib/raakt.rb

@@ -1,4 +1,7 @@
-#Ruby Accessibility Analysis Kit
+# :title: Ruby Accessibility Analysis Kit
+# =Ruby Accessibility Analysis Kit
+#
+# See README for a full explanation of this library.
 
 module Raakt
   require 'rubyful_soup'
@@ -19,10 +22,10 @@ module Raakt
     "fieldmissinglabel" => "A field (with id/name '%s') is missing a corresponding label element. Make sure a label exists for all visible fields.",
     "missingframetitle" => "Missing title attribute for frame with url %s",
     "hasmetarefresh"  => "Client side redirect (meta refresh) detected. Use server side redirection instead."
-  }
+  } 
+  
+  VERSION = "0.3"
   
-  VERSION = "0.1"
-
   class ErrorMessage
   
     attr_reader :eid, :text, :note
@@ -43,20 +46,34 @@ module Raakt
   end
 
 
+
+
+
   class Test
 
+    attr_accessor :soup, :html
   
-    def initialize()
+    def initialize(html=nil)
+      @html = html
+      @soup = BeautifulSoup.new(@html) if html
     end
     
+    def feed(html)
+      @html = html || ""
+      if @html.length > 0
+        @soup = BeautifulSoup.new(@html)
+      else
+        raise "You called feed with no data. There is nothing to check."
+      end
+    end
     
-    def all(html)
+    def all
       #Do all checks
       messages = []
       
       self.methods.each do |method|
         if method[0..5] == "check_"
-          messages += self.send(method, html)
+          messages += self.send(method)
         end
       end
       
@@ -64,9 +81,9 @@ module Raakt
     end
 
   
-    def check_images(html)
-      soup = BeautifulSoup.new(html)
-      images = soup.find_all("img")
+    def check_images
+      #soup = BeautifulSoup.new(html)
+      images = @soup.find_all("img")
       messages = []
     
       for image in images:
@@ -80,9 +97,8 @@ module Raakt
     end
 
   
-    def check_title(html)
-      soup = BeautifulSoup.new(html)
-      title = soup.find("title")
+    def check_title
+      title = @soup.find("title")
       messages = []
     
       if title
@@ -98,11 +114,10 @@ module Raakt
     end
 
   
-    def check_has_heading(html)
-      soup = BeautifulSoup.new(html)
+    def check_has_heading
       messages = []  
       
-      if soup.find_all("h1").length == 0
+      if @soup.find_all("h1").length == 0
         messages << ErrorMessage.new("missingheading")
       end
       
@@ -110,15 +125,14 @@ module Raakt
     end
 
 
-    def headings(html)
-      soup = BeautifulSoup.new(html)
+    def headings
       headings = []
-      headings.push(soup.find_all("h1")) if soup.find_all("h1").length > 0
-      headings.push(soup.find_all("h2")) if soup.find_all("h2").length > 0
-      headings.push(soup.find_all("h3")) if soup.find_all("h3").length > 0
-      headings.push(soup.find_all("h4")) if soup.find_all("h4").length > 0
-      headings.push(soup.find_all("h5")) if soup.find_all("h5").length > 0
-      headings.push(soup.find_all("h6")) if soup.find_all("h6").length > 0
+      headings.push(@soup.find_all("h1")) if @soup.find_all("h1").length > 0
+      headings.push(@soup.find_all("h2")) if @soup.find_all("h2").length > 0
+      headings.push(@soup.find_all("h3")) if @soup.find_all("h3").length > 0
+      headings.push(@soup.find_all("h4")) if @soup.find_all("h4").length > 0
+      headings.push(@soup.find_all("h5")) if @soup.find_all("h5").length > 0
+      headings.push(@soup.find_all("h6")) if @soup.find_all("h6").length > 0
       
       return headings.flatten
     end
@@ -129,10 +143,10 @@ module Raakt
     end
 
     
-    def check_document_structure(html)
+    def check_document_structure
       messages = []
       currentitem = 0
-      docheadings = headings(html)
+      docheadings = headings
       
       for heading in docheadings
         if currentitem == 0
@@ -154,10 +168,10 @@ module Raakt
     end
 
     
-    def check_for_nested_tables(html)
-      soup = BeautifulSoup.new(html)
+    def check_for_nested_tables
+      
       messages = []  
-      tables = soup.find_all("table")
+      tables = @soup.find_all("table")
       
       for table in tables
         if table.find_all("table").length > 0
@@ -170,10 +184,10 @@ module Raakt
     end
 
     
-    def check_tables(html)
-      soup = BeautifulSoup.new(html)
+    def check_tables
+      
       messages = []  
-      tables = soup.find_all("table")   
+      tables = @soup.find_all("table")   
       hasth = false
       currenttable = 1
       
@@ -203,11 +217,11 @@ module Raakt
     end
     
     
-    def check_for_formatting_elements(html)
-      soup = BeautifulSoup.new(html)
+    def check_for_formatting_elements
+      
       messages = []  
-      formatting_items = soup.find_all(["font", "b", "i"])
-      flicker_items = soup.find_all(["blink", "marquee"])
+      formatting_items = @soup.find_all(["font", "b", "i"])
+      flicker_items = @soup.find_all(["blink", "marquee"])
       
       if formatting_items.length > 0
           messages << ErrorMessage.new("missingsemantics")  
@@ -221,13 +235,14 @@ module Raakt
     end
     
     
-    def check_for_language_info(html)
-      soup = BeautifulSoup.new(html)
+    def check_for_language_info
       messages = []
       
-      langelements = soup.find_all(Proc.new { |element| langinfo(element).length > 1 })
+      htmlelement = @soup.find("html")
+  
+      lang = langinfo(htmlelement) || ""
       
-      if langelements.length == 0
+      unless lang.length > 1
         messages << ErrorMessage.new("missinglanginfo")
       end
       
@@ -235,9 +250,9 @@ module Raakt
     end
     
     
-    def check_link_text(html)
+    def check_link_text
       messages = []
-      links = get_links(html)
+      links = get_links
       linktexts = links.collect { |el| el[3] }
       
       for link_a in links
@@ -258,10 +273,10 @@ module Raakt
     end
         
     
-    def check_form(html)
+    def check_form
       messages = []
-      labels = get_labels(html)
-      fields = get_editable_fields(html)
+      labels = get_labels
+      fields = get_editable_fields
       
       #make sure all fields have associated labels
       
@@ -286,12 +301,12 @@ module Raakt
     end
     
     
-    def check_frames(html)
+    def check_frames
       #Verify frame titles
-      soup = BeautifulSoup.new(html)
+      
       messages = []  
-      if is_frameset(html)
-        frames = soup.find_all("frame")
+      if is_frameset
+        frames = @soup.find_all("frame")
         frame_title = ""
       
         for frame in frames
@@ -306,10 +321,10 @@ module Raakt
     end
     
     
-    def check_refresh(html)
-      soup = BeautifulSoup.new(html)
+    def check_refresh
+      
       messages = []
-      meta_elements = soup.find_all("meta")
+      meta_elements = @soup.find_all("meta")
       
       for element in meta_elements
         if element["http-equiv"] == "refresh"
@@ -349,17 +364,14 @@ module Raakt
     end
     
     
-    def get_links(html)
-      soup = BeautifulSoup.new(normalize_text(html))
-      messages = []
-      
-      linkelements = soup.find_all("a")
+    def get_links      
+      linkelements = @soup.find_all("a")
       links = []
       currentlink = 0
       
       for element in linkelements
-        title = (element['title'] || "").strip
-        linktext = (elements_to_text(element) || "").strip
+        title = normalize_text((element['title'] || "").strip)
+        linktext = normalize_text((elements_to_text(element) || "").strip)
         url = element['href']
         links << [currentlink, url, title, linktext]
         currentlink += 1
@@ -371,8 +383,13 @@ module Raakt
 
     def langinfo(element)
       langval = ""
-      if element['lang']
-        langval = element['lang']
+      
+      if element.class.to_s == 'Tag'      
+        if element['lang']
+          langval = element['lang']
+        end      
+      else
+        return nil
       end
       
       return langval
@@ -420,15 +437,13 @@ module Raakt
     end
     
     
-    def get_labels(html)
-      soup = BeautifulSoup.new(html)
-      return soup.find_all("label")
+    def get_labels
+      return @soup.find_all("label")
     end
 
 
-    def get_editable_fields(html)
-      soup = BeautifulSoup.new(html)
-      allfields = soup.find_all(["textarea", "select", "input"])
+    def get_editable_fields
+      allfields = @soup.find_all(["textarea", "select", "input"])
       fields = []
       field_type = ""
       
@@ -444,9 +459,8 @@ module Raakt
     end
         
         
-    def is_frameset(html)
-      soup = BeautifulSoup.new(html)
-      return (soup.find("frameset") != nil)
+    def is_frameset
+      return (@soup.find("frameset") != nil)
     end    
     
   end

data/tests/raakt_test.rb

@@ -9,41 +9,57 @@ class RaaktTest < Test::Unit::TestCase
   end
   
   def test_all
-    puts @raakt.all(data_full_google)
+    @raakt.feed(data_full_google)
+    assert_equal 7, @raakt.all.length
   end
   
   def test_check_images
-    assert_equal 1, @raakt.check_images(data_imagedoc1).length
-    assert_equal "missingalt", @raakt.check_images(data_imagedoc1)[0].eid    
+    @raakt.feed(data_imagedoc1)
+    assert_equal 1, @raakt.check_images.length
+    assert_equal "missingalt", @raakt.check_images[0].eid    
     
-    assert_equal 0, @raakt.check_images(data_imagedoc2).length
+    @raakt.feed(data_imagedoc2)
+    assert_equal 0, @raakt.check_images.length
     
-    assert_equal 3, @raakt.check_images(data_imagedoc3).length
+    @raakt.feed(data_imagedoc3)
+    assert_equal 3, @raakt.check_images.length
     
-    assert_equal 1, @raakt.check_images(data_imagedoc4).length
+    @raakt.feed(data_imagedoc4)
+    assert_equal 1, @raakt.check_images.length
   end
   
   def test_check_images_in_blank_doc
-    assert_equal 0, @raakt.check_images(data_empty).length    
+    @raakt.feed(data_empty)
+    assert_equal 0, @raakt.check_images.length    
   end
   
   
   def test_check_title
-    assert_equal 0, @raakt.check_title(data_xhtmldoc1).length
-    assert_equal 1, @raakt.check_title(data_empty).length
-    assert_equal "missingtitle", @raakt.check_title(data_empty)[0].eid
+    @raakt.feed(data_xhtmldoc1)
+    assert_equal 0, @raakt.check_title.length
     
-    assert_equal 1, @raakt.check_title(data_emptytitledoc).length 
-    assert_equal "emptytitle", @raakt.check_title(data_emptytitledoc)[0].eid
+    @raakt.feed(data_empty)
+    assert_equal 1, @raakt.check_title.length
+    assert_equal "missingtitle", @raakt.check_title[0].eid
     
-    assert_equal 0, @raakt.check_title(data_invalidhtmldoc1).length 
-    assert_equal 0, @raakt.check_title(data_invalidhtmldoc2).length 
+    @raakt.feed(data_emptytitledoc)
+    assert_equal 1, @raakt.check_title.length 
+    assert_equal "emptytitle", @raakt.check_title[0].eid
+    
+    @raakt.feed(data_invalidhtmldoc1)
+    assert_equal 0, @raakt.check_title.length 
+    
+    @raakt.feed(data_invalidhtmldoc2)
+    assert_equal 0, @raakt.check_title.length 
   end
   
   
   def test_headings
-    assert_equal 3, @raakt.headings(data_headingsdoc1).length
-    assert_equal 0, @raakt.headings(data_invalidhtmldoc2).length
+    @raakt.feed(data_headingsdoc1)
+    assert_equal 3, @raakt.headings.length
+    
+    @raakt.feed(data_invalidhtmldoc2)
+    assert_equal 0, @raakt.headings.length
   end
   
   def test_level
@@ -53,70 +69,118 @@ class RaaktTest < Test::Unit::TestCase
   end
   
   def test_check_has_heading
-    assert_equal 1, @raakt.check_has_heading(data_empty).length
-    assert_equal "missingheading", @raakt.check_has_heading(data_empty)[0].eid
-    assert_equal 0, @raakt.check_has_heading(data_headingsdoc1).length
-    assert_equal 0, @raakt.check_has_heading(data_headingsdoc9).length
+    @raakt.feed(data_empty)
+    assert_equal 1, @raakt.check_has_heading.length
+    assert_equal "missingheading", @raakt.check_has_heading[0].eid
+    
+    @raakt.feed(data_headingsdoc1)
+    assert_equal 0, @raakt.check_has_heading.length
+    
+    @raakt.feed(data_headingsdoc9)
+    assert_equal 0, @raakt.check_has_heading.length
     
-    assert_equal 1, @raakt.check_has_heading(data_invalidhtmldoc2).length
-    assert_equal "missingheading", @raakt.check_has_heading(data_invalidhtmldoc2)[0].eid
+    @raakt.feed(data_invalidhtmldoc2)
+    assert_equal 1, @raakt.check_has_heading.length
+    assert_equal "missingheading", @raakt.check_has_heading[0].eid
   end
   
   def test_check_document_structure
-    assert_equal 0, @raakt.check_document_structure(data_headingsdoc1).length
-    assert_equal 1, @raakt.check_document_structure(data_headingsdoc3).length
-    assert_equal "firsthnoth1", @raakt.check_document_structure(data_headingsdoc3)[0].eid
-    assert_equal "wronghstructure", @raakt.check_document_structure(data_headingsdoc4)[0].eid
-    assert_equal "firsthnoth1", @raakt.check_document_structure(data_headingsdoc5)[0].eid
-    assert_equal "wronghstructure", @raakt.check_document_structure(data_headingsdoc5)[1].eid
-    assert_equal 0, @raakt.check_document_structure(data_headingsdoc6).length
-    assert_equal 0, @raakt.check_document_structure("").length
+    
+    @raakt.feed(data_headingsdoc1)
+    assert_equal 0, @raakt.check_document_structure.length
+    
+    @raakt.feed(data_headingsdoc3)
+    assert_equal 1, @raakt.check_document_structure.length
+    assert_equal "firsthnoth1", @raakt.check_document_structure[0].eid
+    
+    @raakt.feed(data_headingsdoc4)
+    assert_equal "wronghstructure", @raakt.check_document_structure[0].eid
+    
+    @raakt.feed(data_headingsdoc5)
+    assert_equal "firsthnoth1", @raakt.check_document_structure[0].eid
+    assert_equal "wronghstructure", @raakt.check_document_structure[1].eid
+    
+    @raakt.feed(data_headingsdoc6)
+    assert_equal 0, @raakt.check_document_structure.length
+    
+    @raakt.feed(data_empty)
+    assert_equal 0, @raakt.check_document_structure.length
   end
   
   
   def test_check_for_nested_tables
-    assert_equal 0, @raakt.check_for_nested_tables(data_tabledoc1).length
-    assert_equal 0, @raakt.check_for_nested_tables(data_tabledoc2).length
-    assert_equal 1, @raakt.check_for_nested_tables(data_tabledoc3).length
-    assert_equal 0, @raakt.check_for_nested_tables(data_tabledoc4).length
-    assert_equal 1, @raakt.check_for_nested_tables(data_tabledoc5).length
-    assert_equal "hasnestedtables", @raakt.check_for_nested_tables(data_tabledoc3)[0].eid
+    @raakt.feed(data_tabledoc1)
+    assert_equal 0, @raakt.check_for_nested_tables.length
+    
+    @raakt.feed(data_tabledoc2)
+    assert_equal 0, @raakt.check_for_nested_tables.length
+    
+    @raakt.feed(data_tabledoc3)
+    assert_equal 1, @raakt.check_for_nested_tables.length
+    assert_equal "hasnestedtables", @raakt.check_for_nested_tables[0].eid
+    
+    @raakt.feed(data_tabledoc4)
+    assert_equal 0, @raakt.check_for_nested_tables.length
+    
+    @raakt.feed(data_tabledoc5)
+    assert_equal 1, @raakt.check_for_nested_tables.length
   end
   
   def test_check_tables
-    puts @raakt.check_tables(data_tabledoc4).to_s
-    assert_equal 0, @raakt.check_tables(data_tabledoc4).length
-    assert_equal 0, @raakt.check_tables(data_tabledoc1).length
-    assert_equal 2, @raakt.check_tables(data_tabledoc2).length
+    @raakt.feed(data_tabledoc4)
+    assert_equal 0, @raakt.check_tables.length
+    
+    @raakt.feed(data_tabledoc1)
+    assert_equal 0, @raakt.check_tables.length
+    
+    @raakt.feed(data_tabledoc2)
+    assert_equal 2, @raakt.check_tables.length
   end
   
   
   def test_check_for_formatting_elements
-    assert_equal 1, @raakt.check_for_formatting_elements(data_invalidelements1).length
-    assert_equal "boldused", @raakt.check_for_formatting_elements(data_invalidelements1)[0].eid
+    @raakt.feed(data_invalidelements1)
+    assert_equal 1, @raakt.check_for_formatting_elements.length
+    assert_equal "boldused", @raakt.check_for_formatting_elements[0].eid
   end
   
   
   def test_check_for_language_info
-    assert_equal 0, @raakt.check_for_language_info(data_xhtmldoc1).length
-    assert_equal 1, @raakt.check_for_language_info(data_tabledoc2).length
-    assert_equal 1, @raakt.check_for_language_info(data_tablelayoutdoc).length    
+    @raakt.feed(data_xhtmldoc1)
+    assert_equal 0, @raakt.check_for_language_info.length
+    
+    @raakt.feed(data_tabledoc2)
+    assert_equal 1, @raakt.check_for_language_info.length
+    
+    @raakt.feed(data_tablelayoutdoc)
+    assert_equal 1, @raakt.check_for_language_info.length   
+    
   end
   
   
   def test_check_link_text
-    assert_equal 1, @raakt.check_link_text(data_linkdoc1).length
-    assert_equal "ambiguouslinktext", @raakt.check_link_text(data_linkdoc1)[0].eid
-    assert_equal 0, @raakt.check_link_text(data_linkdoc3).length
-    assert_equal 0, @raakt.check_link_text(data_linkdoc2).length
-    assert_equal 1, @raakt.check_link_text(data_linkdoc4).length
+    @raakt.feed(data_linkdoc1)
+    assert_equal 1, @raakt.check_link_text.length
+    assert_equal "ambiguouslinktext", @raakt.check_link_text[0].eid
+    
+    @raakt.feed(data_linkdoc3)
+    assert_equal 0, @raakt.check_link_text.length
+    
+    @raakt.feed(data_linkdoc2)
+    assert_equal 0, @raakt.check_link_text.length
+    
+    @raakt.feed(data_linkdoc4)
+    assert_equal 1, @raakt.check_link_text.length
   end
   
   
   def test_get_links
-    assert_equal 8, @raakt.get_links(data_linkdoc1).length
-    assert_equal 2, @raakt.get_links(data_linkdoc4).length
-    assert_equal "Read more", @raakt.get_links(data_linkdoc4)[0][3]
+    @raakt.feed(data_linkdoc1)
+    assert_equal 8, @raakt.get_links.length
+    
+    @raakt.feed(data_linkdoc4)
+    assert_equal 2, @raakt.get_links.length
+    assert_equal "Read more", @raakt.get_links[0][3]
   end
   
   def test_img_to_text
@@ -170,55 +234,88 @@ class RaaktTest < Test::Unit::TestCase
   
   
   def test_get_labels
-    assert_equal 1, @raakt.get_labels(data_fielddoc1).length
-    assert_equal 1, @raakt.get_labels(data_fielddoc2).length
-    assert_equal 2, @raakt.get_labels(data_fielddoc3).length
+    @raakt.feed(data_fielddoc1)
+    assert_equal 1, @raakt.get_labels.length
+    
+    @raakt.feed(data_fielddoc2)
+    assert_equal 1, @raakt.get_labels.length
+    
+    @raakt.feed(data_fielddoc3)
+    assert_equal 2, @raakt.get_labels.length
   end
   
   
   def test_get_editable_fields
-    assert_equal 1, @raakt.get_editable_fields(data_fielddoc1).length
-    assert_equal 2, @raakt.get_editable_fields(data_fielddoc2).length
-    assert_equal 3, @raakt.get_editable_fields(data_fielddoc3).length
+    @raakt.feed(data_fielddoc1)
+    assert_equal 1, @raakt.get_editable_fields.length
+    
+    @raakt.feed(data_fielddoc2)
+    assert_equal 2, @raakt.get_editable_fields.length
+    
+    @raakt.feed(data_fielddoc3)
+    assert_equal 3, @raakt.get_editable_fields.length
   end
   
   
   def test_check_form
-    assert_equal 0, @raakt.check_form(data_fielddoc1).length
-    assert_equal 1, @raakt.check_form(data_fielddoc2).length
-    assert_equal "fieldmissinglabel", @raakt.check_form(data_fielddoc2)[0].eid
-    assert_equal 1, @raakt.check_form(data_fielddoc3).length
-    assert_equal "fieldmissinglabel", @raakt.check_form(data_fielddoc3)[0].eid
+    @raakt.feed(data_fielddoc1)
+    assert_equal 0, @raakt.check_form.length
+    
+    @raakt.feed(data_fielddoc2)
+    assert_equal 1, @raakt.check_form.length
+    assert_equal "fieldmissinglabel", @raakt.check_form[0].eid
+    
+    @raakt.feed(data_fielddoc3)
+    assert_equal 1, @raakt.check_form.length
+    assert_equal "fieldmissinglabel", @raakt.check_form[0].eid
   end
   
   
   def test_is_frameset
-    assert @raakt.is_frameset(data_framedoc1)
-    assert @raakt.is_frameset(data_framedoc2)
-    assert !@raakt.is_frameset(data_xhtmldoc1)
+    @raakt.feed(data_framedoc1)
+    assert @raakt.is_frameset
+    
+    @raakt.feed(data_framedoc2)
+    assert @raakt.is_frameset
+    
+    @raakt.feed(data_xhtmldoc1)
+    assert !@raakt.is_frameset
   end
   
   
   def test_check_frames
-    assert_equal 3, @raakt.check_frames(data_framedoc1).length
-    assert_equal 0, @raakt.check_frames(data_framedoc2).length
+    @raakt.feed(data_framedoc1)
+    assert_equal 3, @raakt.check_frames.length
+    
+    @raakt.feed(data_framedoc2)
+    assert_equal 0, @raakt.check_frames.length
   end
   
   
   def test_check_for_formatting_elements
-    invaliderrs = @raakt.check_for_formatting_elements(data_invalidelements1)
+    @raakt.feed(data_invalidelements1)
+    invaliderrs = @raakt.check_for_formatting_elements
     assert_equal 2, invaliderrs.length
     assert_equal "missingsemantics", invaliderrs[0].eid
     assert_equal "hasflicker", invaliderrs[1].eid
-    assert_equal 0, @raakt.check_for_formatting_elements(data_xhtmldoc1).length
+    
+    @raakt.feed(data_xhtmldoc1)
+    assert_equal 0, @raakt.check_for_formatting_elements.length
   end
   
   
   def test_refresh
-    assert_equal 1, @raakt.check_refresh(data_metarefreshdoc1).length
-    assert_equal 1, @raakt.check_refresh(data_metarefreshdoc2).length
-    assert_equal 1, @raakt.check_refresh(data_metarefreshdoc3).length
-    assert_equal 0, @raakt.check_refresh(data_xhtmldoc1).length
+    @raakt.feed(data_metarefreshdoc1)
+    assert_equal 1, @raakt.check_refresh.length
+    
+    @raakt.feed(data_metarefreshdoc2)
+    assert_equal 1, @raakt.check_refresh.length
+    
+    @raakt.feed(data_metarefreshdoc3)
+    assert_equal 1, @raakt.check_refresh.length
+    
+    @raakt.feed(data_xhtmldoc1)
+    assert_equal 0, @raakt.check_refresh.length
   end
   
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: raakt
 version: !ruby/object:Gem::Version 
-  version: "0.1"
-date: 2006-07-11 00:00:00 +02:00
+  version: "0.3"
+date: 2006-07-13 00:00:00 +02:00
 summary: A toolkit to find accessibility issues in HTML documents.
 require_paths: 
 - lib