loofah 1.0.0 → 1.1.0

data/test/helper.rb

@@ -1,7 +1,17 @@
 require 'rubygems'
-require 'test/unit'
-require 'shoulda'
-require 'mocha'
+require 'rr'
+require 'minitest/unit'
+require 'minitest/spec'
+require 'minitest/autorun'
+
 require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "loofah"))
 
 puts "=> testing with Nokogiri #{Nokogiri::VERSION_INFO.inspect}"
+
+class Loofah::TestCase < MiniTest::Spec
+  include RR::Adapters::TestUnit
+
+  class << self
+    alias_method :context, :describe
+  end
+end

data/test/html5/test_sanitizer.rb

@@ -4,10 +4,9 @@
 #
 #  license text at the bottom of this file
 #
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helper'))
-require 'json'
+require "helper"
 
-class Html5TestSanitizer < Test::Unit::TestCase
+class Html5TestSanitizer < Loofah::TestCase
   include Loofah
 
   def sanitize_xhtml stream
@@ -21,11 +20,15 @@ class Html5TestSanitizer < Test::Unit::TestCase
   def check_sanitization(input, htmloutput, xhtmloutput, rexmloutput)
     ##  libxml uses double-quotes, so let's swappo-boppo our quotes before comparing.
     sane = sanitize_html(input).gsub('"',"'")
+    htmloutput.gsub!('"',"'")
+    xhtmloutput.gsub!('"',"'")
+    rexmloutput.gsub!('"',"'")
 
     ##  HTML5's parsers are shit. there's so much inconsistency with what has closing tags, etc, that
     ##  it would require a lot of manual hacking to make the tests match libxml's output.
     ##  instead, I'm taking the shotgun approach, and trying to match any of the described outputs.
-    assert((htmloutput == sane) || (rexmloutput == sane) || (xhtmloutput == sane), input)
+    assert((htmloutput == sane) || (rexmloutput == sane) || (xhtmloutput == sane),
+      %Q{given:    "#{input}"\nexpected: "#{htmloutput}"\ngot:      "#{sane}"})
   end
 
   (HTML5::WhiteList::ALLOWED_ELEMENTS).each do |tag_name|
@@ -169,18 +172,19 @@ class Html5TestSanitizer < Test::Unit::TestCase
   ##  libxml2 here, so let's rely on the unit tests above to take care
   ##  of our valid elements and attributes.
   ##
-  # Dir[File.join(File.dirname(__FILE__), 'testdata', '*.*')].each do |filename|
-  #   JSON::parse(open(filename).read).each do |test|
-  #     define_method "test_#{test['name']}" do
-  #       check_sanitization(
-  #         test['input'],
-  #         test['output'],
-  #         test['xhtml'] || test['output'],
-  #         test['rexml'] || test['output']
-  #       )
-  #     end
-  #   end
-  # end
+  require 'json'
+  Dir[File.join(File.dirname(__FILE__), '..', 'assets', 'testdata_sanitizer_tests1.dat')].each do |filename|
+    JSON::parse(open(filename).read).each do |test|
+      it "testdata sanitizer #{test['name']}" do
+        check_sanitization(
+          test['input'],
+          test['output'],
+          test['xhtml'] || test['output'],
+          test['rexml'] || test['output']
+        )
+      end
+    end
+  end
 
   ## added because we don't have any coverage above on SVG_ATTR_VAL_ALLOWS_REF
   HTML5::WhiteList::SVG_ATTR_VAL_ALLOWS_REF.each do |attr_name|  
@@ -206,7 +210,6 @@ class Html5TestSanitizer < Test::Unit::TestCase
       rexml = "<rect fill=' '></rect>"
     end
   end
-
 end
 
 # <html5_license>

data/test/integration/test_ad_hoc.rb

@@ -1,16 +1,16 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helper'))
+require "helper"
 
-class TestAdHoc < Test::Unit::TestCase
+class IntegrationTestAdHoc < Loofah::TestCase
 
   context "blank input string" do
     context "fragment" do
-      should "return a blank string" do
+      it "return a blank string" do
         assert_equal "", Loofah.scrub_fragment("", :prune).to_s
       end
     end
 
     context "document" do
-      should "return a blank string" do
+      it "return a blank string" do
         assert_equal "", Loofah.scrub_document("", :prune).root.to_s
       end
     end
@@ -49,8 +49,8 @@ class TestAdHoc < Test::Unit::TestCase
   def test_css_sanitization
     html = "<p style='background-color: url(\"http://foo.com/\") ; background-color: #000 ;' />"
     sane = Nokogiri::HTML(Loofah.scrub_fragment(html, :escape).to_xml)
-    assert_match(/#000/, sane.inner_html)
-    assert_no_match(/foo\.com/, sane.inner_html)
+    assert_match %r/#000/,    sane.inner_html
+    refute_match %r/foo\.com/, sane.inner_html
   end
 
   def test_fragment_with_no_tags
@@ -148,8 +148,8 @@ mso-bidi-language:#0400;}
 
   def test_document_whitewash_on_microsofty_markup
     whitewashed = Loofah.document(MSWORD_HTML).scrub!(:whitewash)
-    assert_contains whitewashed.to_s, %r(<p>Foo <b>BOLD</b></p>)
-    assert_equal "<p>Foo <b>BOLD</b></p>", whitewashed.xpath("/html/body/*").to_s
+    assert_match %r(<p>Foo <b>BOLD</b></p>), whitewashed.to_s
+    assert_equal "<p>Foo <b>BOLD</b></p>",   whitewashed.xpath("/html/body/*").to_s
   end
 
   def test_return_empty_string_when_nothing_left

data/test/integration/test_helpers.rb

@@ -1,15 +1,15 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helper'))
+require "helper"
 
-class TestHelpers < Test::Unit::TestCase
+class IntegrationTestHelpers < Loofah::TestCase
   context "#strip_tags" do
     context "on safe markup" do
-      should "strip out tags" do
+      it "strip out tags" do
         assert_equal "omgwtfbbq!!1!", Loofah::Helpers.strip_tags("<div>omgwtfbbq</div><span>!!1!</span>")
       end
     end
 
     context "on hack attack" do
-      should "strip escape html entities" do
+      it "strip escape html entities" do
         bad_shit = "&lt;script&gt;alert('evil')&lt;/script&gt;"
         assert_equal bad_shit, Loofah::Helpers.strip_tags(bad_shit)
       end
@@ -18,14 +18,14 @@ class TestHelpers < Test::Unit::TestCase
 
   context "#sanitize" do
     context "on safe markup" do
-      should "render the safe html" do
+      it "render the safe html" do
         html = "<div>omgwtfbbq</div><span>!!1!</span>"
         assert_equal html, Loofah::Helpers.sanitize(html)
       end
     end
 
     context "on hack attack" do
-      should "strip the unsafe tags" do
+      it "strip the unsafe tags" do
         assert_equal "alert('evil')<span>w00t</span>", Loofah::Helpers.sanitize("<script>alert('evil')</script><span>w00t</span>")
       end
     end

data/test/integration/test_html.rb

@@ -1,28 +1,30 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helper'))
+require "helper"
 
-class TestHtml < Test::Unit::TestCase
+class IntegrationTestHtml < Loofah::TestCase
   context "html fragment" do
     context "#to_s" do
-      should "not include head tags (like style)" do
+      it "not include head tags (like style)" do
+        skip "depends on nokogiri version"
         html = Loofah.fragment "<style>foo</style><div>bar</div>"
         assert_equal "<div>bar</div>", html.to_s
       end
     end
 
     context "#text" do
-      should "not include head tags (like style)" do
+      it "not include head tags (like style)" do
+        skip "depends on nokogiri version"
         html = Loofah.fragment "<style>foo</style><div>bar</div>"
         assert_equal "bar", html.text
       end
     end
 
     context "#to_text" do
-      should "add newlines before and after block elements" do
+      it "add newlines before and after block elements" do
         html = Loofah.fragment "<div>tweedle<h1>beetle</h1>bottle<span>puddle</span>paddle<div>battle</div>muddle</div>"
         assert_equal "\ntweedle\nbeetle\nbottlepuddlepaddle\nbattle\nmuddle\n", html.to_text
       end
 
-      should "remove extraneous whitespace" do
+      it "remove extraneous whitespace" do
         html = Loofah.fragment "<div>tweedle\n\n\t\n\s\nbeetle</div>"
         assert_equal "\ntweedle\n\nbeetle\n", html.to_text
       end
@@ -30,18 +32,18 @@ class TestHtml < Test::Unit::TestCase
   end
 
   context "html document" do
-    should "not include head tags (like style)" do
+    it "not include head tags (like style)" do
       html = Loofah.document "<style>foo</style><div>bar</div>"
       assert_equal "bar", html.text
     end
 
     context "#to_text" do
-      should "add newlines before and after block elements" do
+      it "add newlines before and after block elements" do
         html = Loofah.document "<div>tweedle<h1>beetle</h1>bottle<span>puddle</span>paddle<div>battle</div>muddle</div>"
         assert_equal "\ntweedle\nbeetle\nbottlepuddlepaddle\nbattle\nmuddle\n", html.to_text
       end
 
-      should "remove extraneous whitespace" do
+      it "remove extraneous whitespace" do
         html = Loofah.document "<div>tweedle\n\n\t\n\s\nbeetle</div>"
         assert_equal "\ntweedle\n\nbeetle\n", html.to_text
       end

data/test/integration/test_scrubbers.rb

@@ -1,6 +1,6 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helper'))
+require "helper"
 
-class TestScrubbers < Test::Unit::TestCase
+class IntegrationTestScrubbers < Loofah::TestCase
 
   INVALID_FRAGMENT = "<invalid>foo<p>bar</p>bazz</invalid><div>quux</div>"
   INVALID_ESCAPED  = "&lt;invalid&gt;foo&lt;p&gt;bar&lt;/p&gt;bazz&lt;/invalid&gt;<div>quux</div>"
@@ -23,7 +23,7 @@ class TestScrubbers < Test::Unit::TestCase
   context "Document" do
     context "#scrub!" do
       context ":escape" do
-        should "escape bad tags" do
+        it "escape bad tags" do
           doc = Loofah::HTML::Document.parse "<html><body>#{INVALID_FRAGMENT}</body></html>"
           result = doc.scrub! :escape
 
@@ -33,7 +33,7 @@ class TestScrubbers < Test::Unit::TestCase
       end
 
       context ":prune" do
-        should "prune bad tags" do
+        it "prune bad tags" do
           doc = Loofah::HTML::Document.parse "<html><body>#{INVALID_FRAGMENT}</body></html>"
           result = doc.scrub! :prune
 
@@ -43,7 +43,7 @@ class TestScrubbers < Test::Unit::TestCase
       end
 
       context ":strip" do
-        should "strip bad tags" do
+        it "strip bad tags" do
           doc = Loofah::HTML::Document.parse "<html><body>#{INVALID_FRAGMENT}</body></html>"
           result = doc.scrub! :strip
 
@@ -53,7 +53,7 @@ class TestScrubbers < Test::Unit::TestCase
       end
 
       context ":whitewash" do
-        should "whitewash the markup" do
+        it "whitewash the markup" do
           doc = Loofah::HTML::Document.parse "<html><body>#{WHITEWASH_FRAGMENT}</body></html>"
           result = doc.scrub! :whitewash
 
@@ -63,7 +63,7 @@ class TestScrubbers < Test::Unit::TestCase
       end
 
       context ":nofollow" do
-        should "add a 'nofollow' attribute to hyperlinks" do
+        it "add a 'nofollow' attribute to hyperlinks" do
           doc = Loofah::HTML::Document.parse "<html><body>#{NOFOLLOW_FRAGMENT}</body></html>"
           result = doc.scrub! :nofollow
 
@@ -74,17 +74,17 @@ class TestScrubbers < Test::Unit::TestCase
     end
 
     context "#scrub_document" do
-      should "be a shortcut for parse-and-scrub" do
-        mock_doc = mock
-        Loofah.expects(:document).with(:string_or_io).returns(mock_doc)
-        mock_doc.expects(:scrub!).with(:method)
+      it "be a shortcut for parse-and-scrub" do
+        mock_doc = Object.new
+        mock(Loofah).document(:string_or_io) { mock_doc }
+        mock(mock_doc).scrub!(:method)
 
         Loofah.scrub_document(:string_or_io, :method)
       end
     end
 
     context "#text" do
-      should "leave behind only inner text with html entities still escaped" do
+      it "leave behind only inner text with html entities still escaped" do
         doc = Loofah::HTML::Document.parse "<html><body>#{ENTITY_HACK_ATTACK}</body></html>"
         result = doc.text
 
@@ -92,7 +92,7 @@ class TestScrubbers < Test::Unit::TestCase
       end
 
       context "with encode_special_chars => false" do
-        should "leave behind only inner text with html entities unescaped" do
+        it "leave behind only inner text with html entities unescaped" do
           doc = Loofah::HTML::Document.parse "<html><body>#{ENTITY_HACK_ATTACK}</body></html>"
           result = doc.text(:encode_special_chars => false)
 
@@ -101,7 +101,7 @@ class TestScrubbers < Test::Unit::TestCase
       end
 
       context "with encode_special_chars => true" do
-        should "leave behind only inner text with html entities still escaped" do
+        it "leave behind only inner text with html entities still escaped" do
           doc = Loofah::HTML::Document.parse "<html><body>#{ENTITY_HACK_ATTACK}</body></html>"
           result = doc.text(:encode_special_chars => true)
 
@@ -111,38 +111,38 @@ class TestScrubbers < Test::Unit::TestCase
     end
 
     context "#to_s" do
-      should "generate HTML" do
+      it "generate HTML" do
         doc = Loofah.scrub_document "<html><head><title>quux</title></head><body><div>foo</div></body></html>", :prune
-        assert_not_nil doc.xpath("/html").first
-        assert_not_nil doc.xpath("/html/head").first
-        assert_not_nil doc.xpath("/html/body").first
+        refute_nil doc.xpath("/html").first
+        refute_nil doc.xpath("/html/head").first
+        refute_nil doc.xpath("/html/body").first
 
         string = doc.to_s
-        assert_contains string, /<!DOCTYPE/
-        assert_contains string, /<html>/
-        assert_contains string, /<head>/
-        assert_contains string, /<body>/
+        assert_match %r/<!DOCTYPE/, string
+        assert_match %r/<html>/, string
+        assert_match %r/<head>/, string
+        assert_match %r/<body>/, string
       end
     end
 
     context "#serialize" do
-      should "generate HTML" do
+      it "generate HTML" do
         doc = Loofah.scrub_document "<html><head><title>quux</title></head><body><div>foo</div></body></html>", :prune
-        assert_not_nil doc.xpath("/html").first
-        assert_not_nil doc.xpath("/html/head").first
-        assert_not_nil doc.xpath("/html/body").first
+        refute_nil doc.xpath("/html").first
+        refute_nil doc.xpath("/html/head").first
+        refute_nil doc.xpath("/html/body").first
 
         string = doc.serialize
-        assert_contains string, /<!DOCTYPE/
-        assert_contains string, /<html>/
-        assert_contains string, /<head>/
-        assert_contains string, /<body>/
+        assert_match %r/<!DOCTYPE/, string
+        assert_match %r/<html>/, string
+        assert_match %r/<head>/, string
+        assert_match %r/<body>/, string
       end
     end
 
     context "Node" do
       context "#scrub!" do
-        should "only scrub subtree" do
+        it "only scrub subtree" do
           xml = Loofah.document <<-EOHTML
            <html><body>
              <div class='scrub'>
@@ -155,15 +155,15 @@ class TestScrubbers < Test::Unit::TestCase
           EOHTML
           node = xml.at_css "div.scrub"
           node.scrub!(:prune)
-          assert_contains         xml.to_s, /I should remain/
-          assert_does_not_contain xml.to_s, /I should be removed/
+          assert_match %r/I should remain/,     xml.to_s
+          refute_match %r/I should be removed/, xml.to_s
         end
       end
     end
 
     context "NodeSet" do
       context "#scrub!" do
-        should "only scrub subtrees" do
+        it "only scrub subtrees" do
           xml = Loofah.document <<-EOHTML
             <html><body>
               <div class='scrub'>
@@ -180,9 +180,9 @@ class TestScrubbers < Test::Unit::TestCase
           node_set = xml.css "div.scrub"
           assert_equal 2, node_set.length
           node_set.scrub!(:prune)
-          assert_contains         xml.to_s, /I should remain/
-          assert_does_not_contain xml.to_s, /I should be removed/
-          assert_does_not_contain xml.to_s, /I should also be removed/
+          assert_match %r/I should remain/,          xml.to_s
+          refute_match %r/I should be removed/,      xml.to_s
+          refute_match %r/I should also be removed/, xml.to_s
         end
       end
     end
@@ -191,7 +191,7 @@ class TestScrubbers < Test::Unit::TestCase
   context "DocumentFragment" do
     context "#scrub!" do
       context ":escape" do
-        should "escape bad tags" do
+        it "escape bad tags" do
           doc = Loofah::HTML::DocumentFragment.parse "<div>#{INVALID_FRAGMENT}</div>"
           result = doc.scrub! :escape
 
@@ -201,7 +201,7 @@ class TestScrubbers < Test::Unit::TestCase
       end
 
       context ":prune" do
-        should "prune bad tags" do
+        it "prune bad tags" do
           doc = Loofah::HTML::DocumentFragment.parse "<div>#{INVALID_FRAGMENT}</div>"
           result = doc.scrub! :prune
 
@@ -211,7 +211,7 @@ class TestScrubbers < Test::Unit::TestCase
       end
 
       context ":strip" do
-        should "strip bad tags" do
+        it "strip bad tags" do
           doc = Loofah::HTML::DocumentFragment.parse "<div>#{INVALID_FRAGMENT}</div>"
           result = doc.scrub! :strip
 
@@ -221,7 +221,7 @@ class TestScrubbers < Test::Unit::TestCase
       end
 
       context ":whitewash" do
-        should "whitewash the markup" do
+        it "whitewash the markup" do
           doc = Loofah::HTML::DocumentFragment.parse "<div>#{WHITEWASH_FRAGMENT}</div>"
           result = doc.scrub! :whitewash
 
@@ -231,7 +231,7 @@ class TestScrubbers < Test::Unit::TestCase
       end
 
       context ":nofollow" do
-        should "add a 'nofollow' attribute to hyperlinks" do
+        it "add a 'nofollow' attribute to hyperlinks" do
           doc = Loofah::HTML::DocumentFragment.parse "<div>#{NOFOLLOW_FRAGMENT}</div>"
           result = doc.scrub! :nofollow
 
@@ -242,17 +242,17 @@ class TestScrubbers < Test::Unit::TestCase
     end
 
     context "#scrub_fragment" do
-      should "be a shortcut for parse-and-scrub" do
-        mock_doc = mock
-        Loofah.expects(:fragment).with(:string_or_io).returns(mock_doc)
-        mock_doc.expects(:scrub!).with(:method)
+      it "be a shortcut for parse-and-scrub" do
+        mock_doc = Object.new
+        mock(Loofah).fragment(:string_or_io) { mock_doc }
+        mock(mock_doc).scrub!(:method)
 
         Loofah.scrub_fragment(:string_or_io, :method)
       end
     end
 
     context "#text" do
-      should "leave behind only inner text with html entities still escaped" do
+      it "leave behind only inner text with html entities still escaped" do
         doc = Loofah::HTML::DocumentFragment.parse "<div>#{ENTITY_HACK_ATTACK}</div>"
         result = doc.text
 
@@ -260,7 +260,7 @@ class TestScrubbers < Test::Unit::TestCase
       end
 
       context "with encode_special_chars => false" do
-        should "leave behind only inner text with html entities unescaped" do
+        it "leave behind only inner text with html entities unescaped" do
           doc = Loofah::HTML::DocumentFragment.parse "<div>#{ENTITY_HACK_ATTACK}</div>"
           result = doc.text(:encode_special_chars => false)
 
@@ -269,7 +269,7 @@ class TestScrubbers < Test::Unit::TestCase
       end
 
       context "with encode_special_chars => true" do
-        should "leave behind only inner text with html entities still escaped" do
+        it "leave behind only inner text with html entities still escaped" do
           doc = Loofah::HTML::DocumentFragment.parse "<div>#{ENTITY_HACK_ATTACK}</div>"
           result = doc.text(:encode_special_chars => true)
 
@@ -279,15 +279,15 @@ class TestScrubbers < Test::Unit::TestCase
     end
 
     context "#to_s" do
-      should "not remove entities" do
+      it "not remove entities" do
         string = Loofah.scrub_fragment(ENTITY_FRAGMENT, :prune).to_s
-        assert_contains string, /this is &lt;/
+        assert_match %r/this is &lt;/, string
       end
     end
 
     context "Node" do
       context "#scrub!" do
-        should "only scrub subtree" do
+        it "only scrub subtree" do
           xml = Loofah.fragment <<-EOHTML
             <div class='scrub'>
               <script>I should be removed</script>
@@ -298,15 +298,15 @@ class TestScrubbers < Test::Unit::TestCase
           EOHTML
           node = xml.at_css "div.scrub"
           node.scrub!(:prune)
-          assert_contains         xml.to_s, /I should remain/
-          assert_does_not_contain xml.to_s, /I should be removed/
+          assert_match %r(I should remain),     xml.to_s
+          refute_match %r(I should be removed), xml.to_s
         end
       end
     end
 
     context "NodeSet" do
       context "#scrub!" do
-        should "only scrub subtrees" do
+        it "only scrub subtrees" do
           xml = Loofah.fragment <<-EOHTML
             <div class='scrub'>
               <script>I should be removed</script>
@@ -321,9 +321,9 @@ class TestScrubbers < Test::Unit::TestCase
           node_set = xml.css "div.scrub"
           assert_equal 2, node_set.length
           node_set.scrub!(:prune)
-          assert_contains         xml.to_s, /I should remain/
-          assert_does_not_contain xml.to_s, /I should be removed/
-          assert_does_not_contain xml.to_s, /I should also be removed/
+          assert_match %r/I should remain/,          xml.to_s
+          refute_match %r/I should be removed/,      xml.to_s
+          refute_match %r/I should also be removed/, xml.to_s
         end
       end
     end