loofah 2.3.1

data/test/integration/test_xml.rb

@@ -0,0 +1,55 @@
+require "helper"
+
+class IntegrationTestXml < Loofah::TestCase
+  context "integration test" do
+    context "xml document" do
+      context "custom scrubber" do
+        it "act as expected" do
+          xml = Loofah.xml_document <<-EOXML
+            <root>
+              <employee deceased='true'>Abraham Lincoln</employee>
+              <employee deceased='false'>Abe Vigoda</employee>
+            </root>
+          EOXML
+          bring_out_your_dead = Loofah::Scrubber.new do |node|
+            if node.name == "employee" and node["deceased"] == "true"
+              node.remove
+              Loofah::Scrubber::STOP # don't bother with the rest of the subtree
+            end
+          end
+          assert_equal 2, xml.css("employee").length
+          
+          xml.scrub!(bring_out_your_dead)
+
+          employees = xml.css "employee"
+          assert_equal 1, employees.length
+          assert_equal "Abe Vigoda", employees.first.inner_text
+        end
+      end
+    end
+
+    context "xml fragment" do
+      context "custom scrubber" do
+        it "act as expected" do
+          xml = Loofah.xml_fragment <<-EOXML
+            <employee deceased='true'>Abraham Lincoln</employee>
+            <employee deceased='false'>Abe Vigoda</employee>
+          EOXML
+          bring_out_your_dead = Loofah::Scrubber.new do |node|
+            if node.name == "employee" and node["deceased"] == "true"
+              node.remove
+              Loofah::Scrubber::STOP # don't bother with the rest of the subtree
+            end
+          end
+          assert_equal 2, xml.css("employee").length
+          
+          xml.scrub!(bring_out_your_dead)
+
+          employees = xml.css "employee"
+          assert_equal 1, employees.length
+          assert_equal "Abe Vigoda", employees.first.inner_text
+        end
+      end
+    end
+  end
+end

data/test/unit/test_api.rb

@@ -0,0 +1,142 @@
+require "helper"
+
+class UnitTestApi < Loofah::TestCase
+
+  HTML          = "<div>a</div>\n<div>b</div>"
+  XML_FRAGMENT  = "<div>a</div>\n<div>b</div>"
+  XML           = "<root>#{XML_FRAGMENT}</root>"
+
+  describe "HTML" do
+    it "creates documents" do
+      doc = Loofah.document(HTML)
+      assert_html_documentish doc
+    end
+
+    it "creates fragments" do
+      doc = Loofah.fragment(HTML)
+      assert_html_fragmentish doc
+    end
+
+    it "parses documents" do
+      doc = Loofah::HTML::Document.parse(HTML)
+      assert_html_documentish doc
+    end
+
+    it "parses document fragment" do
+      doc = Loofah::HTML::DocumentFragment.parse(HTML)
+      assert_html_fragmentish doc
+    end
+
+    it "scrubs documents" do
+      doc = Loofah.document(HTML).scrub!(:strip)
+      assert_html_documentish doc
+    end
+
+    it "scrubs fragments" do
+      doc = Loofah.fragment(HTML).scrub!(:strip)
+      assert_html_fragmentish doc
+    end
+
+    it "scrubs document nodes" do
+      doc = Loofah.document(HTML)
+      assert(node = doc.at_css("div"))
+      node.scrub!(:strip)
+    end
+
+    it "scrubs fragment nodes" do
+      doc = Loofah.fragment(HTML)
+      assert(node = doc.at_css("div"))
+      node.scrub!(:strip)
+    end
+
+    it "scrubs document nodesets" do
+      doc = Loofah.document(HTML)
+      assert(node_set = doc.css("div"))
+      assert_instance_of Nokogiri::XML::NodeSet, node_set
+      node_set.scrub!(:strip)
+    end
+
+    it "exposes serialize_root on HTML::DocumentFragment" do
+      doc = Loofah.fragment(HTML)
+      assert_equal HTML, doc.serialize_root.to_html
+    end
+
+    it "exposes serialize_root on HTML::Document" do
+      doc = Loofah.document(HTML)
+      assert_equal HTML, doc.serialize_root.children.to_html
+    end
+  end
+
+  describe "XML" do
+    it "creates documents" do
+      doc = Loofah.xml_document(XML)
+      assert_xml_documentish doc
+    end
+
+    it "creates fragments" do
+      doc = Loofah.xml_fragment(XML_FRAGMENT)
+      assert_xml_fragmentish doc
+    end
+
+    it "parses documents" do
+      doc = Loofah::XML::Document.parse(XML)
+      assert_xml_documentish doc
+    end
+
+    it "parses document fragments" do
+      doc = Loofah::XML::DocumentFragment.parse(XML_FRAGMENT)
+      assert_xml_fragmentish doc
+    end
+
+    it "scrubs documents" do
+      scrubber = Loofah::Scrubber.new { |node| }
+      doc = Loofah.xml_document(XML).scrub!(scrubber)
+      assert_xml_documentish doc
+    end
+
+    it "scrubs fragments" do
+      scrubber = Loofah::Scrubber.new { |node| }
+      doc = Loofah.xml_fragment(XML_FRAGMENT).scrub!(scrubber)
+      assert_xml_fragmentish doc
+    end
+
+    it "scrubs document nodes" do
+      doc = Loofah.xml_document(XML)
+      assert(node = doc.at_css("div"))
+      node.scrub!(:strip)
+    end
+
+    it "scrubs fragment nodes" do
+      doc = Loofah.xml_fragment(XML)
+      assert(node = doc.at_css("div"))
+      node.scrub!(:strip)
+    end
+  end
+
+  private
+
+  def assert_html_documentish(doc)
+    assert_kind_of Nokogiri::HTML::Document, doc
+    assert_kind_of Loofah::HTML::Document,   doc
+    assert_equal HTML, doc.xpath("/html/body").inner_html
+  end
+
+  def assert_html_fragmentish(doc)
+    assert_kind_of Nokogiri::HTML::DocumentFragment, doc
+    assert_kind_of Loofah::HTML::DocumentFragment,   doc
+    assert_equal HTML, doc.inner_html
+  end
+
+  def assert_xml_documentish(doc)
+    assert_kind_of Nokogiri::XML::Document, doc
+    assert_kind_of Loofah::XML::Document,   doc
+    assert_equal XML, doc.root.to_xml
+  end
+
+  def assert_xml_fragmentish(doc)
+    assert_kind_of Nokogiri::XML::DocumentFragment, doc
+    assert_kind_of Loofah::XML::DocumentFragment,   doc
+    assert_equal XML_FRAGMENT, doc.children.to_xml
+  end
+
+end

data/test/unit/test_encoding.rb

@@ -0,0 +1,20 @@
+# :coding: utf-8
+require "helper"
+
+class UnitTestEncoding < Loofah::TestCase
+  UTF8_STRING = "日本語"
+
+  if String.new.respond_to?(:encoding)
+    describe "scrub_fragment" do
+      it "sets the encoding for html" do
+        escaped = Loofah.scrub_fragment(UTF8_STRING, :escape).to_s
+        assert_equal UTF8_STRING.encoding, escaped.encoding
+      end
+
+      it "sets the encoding for xml" do
+        escaped = Loofah.scrub_xml_fragment(UTF8_STRING, :escape).to_s
+        assert_equal UTF8_STRING.encoding, escaped.encoding
+      end
+    end
+  end
+end

data/test/unit/test_helpers.rb

@@ -0,0 +1,62 @@
+require "helper"
+
+class UnitTestHelpers < Loofah::TestCase
+
+  HTML_STRING = "<div>omgwtfbbq</div>"
+
+  describe "Helpers" do
+    context ".strip_tags" do
+      it "invoke Loofah.fragment.text" do
+        mock_doc = Object.new
+        mock(Loofah).fragment(HTML_STRING) { mock_doc }
+        mock(mock_doc).text
+
+        Loofah::Helpers.strip_tags HTML_STRING
+      end
+    end
+
+    context ".sanitize" do
+      it "invoke Loofah.scrub_fragment(:strip).to_s" do
+        mock_doc = Object.new
+        mock_node = Object.new
+        mock(Loofah).fragment(HTML_STRING) { mock_doc }
+        mock(mock_doc).scrub!(:strip) { mock_doc }
+        mock(mock_doc).xpath("./form") { [mock_node] }
+        mock(mock_node).remove
+        mock(mock_doc).to_s
+
+        Loofah::Helpers.sanitize HTML_STRING
+      end
+    end
+
+    context ".sanitize_css" do
+      it "invokes HTML5lib's css scrubber" do
+        mock(Loofah::HTML5::Scrub).scrub_css("foobar")
+        Loofah::Helpers.sanitize_css("foobar")
+      end
+    end
+
+    describe "ActionView" do
+      describe "FullSanitizer#sanitize" do
+        it "calls .strip_tags" do
+          mock(Loofah::Helpers).strip_tags("foobar")
+          Loofah::Helpers::ActionView::FullSanitizer.new.sanitize "foobar"
+        end
+      end
+
+      describe "SafeListSanitizer#sanitize" do
+        it "calls .sanitize" do
+          mock(Loofah::Helpers).sanitize("foobar")
+          Loofah::Helpers::ActionView::SafeListSanitizer.new.sanitize "foobar"
+        end
+      end
+
+      describe "SafeListSanitizer#sanitize_css" do
+        it "calls .sanitize_css" do
+          mock(Loofah::Helpers).sanitize_css("foobar")
+          Loofah::Helpers::ActionView::SafeListSanitizer.new.sanitize_css "foobar"
+        end
+      end
+    end
+  end
+end

data/test/unit/test_scrubber.rb

@@ -0,0 +1,229 @@
+require "helper"
+
+class UnitTestScrubber < Loofah::TestCase
+
+  FRAGMENT = "<span>hello</span><span>goodbye</span>"
+  FRAGMENT_NODE_COUNT         = 4 # span, text, span, text
+  FRAGMENT_NODE_STOP_TOP_DOWN = 2 # span, span
+  DOCUMENT = "<html><head><link></link></head><body><span>hello</span><span>goodbye</span></body></html>"
+  DOCUMENT_NODE_COUNT         = 8 # html, head, link, body, span, text, span, text
+  DOCUMENT_NODE_STOP_TOP_DOWN = 1 # html
+
+  context "receiving a block" do
+    before do
+      @count = 0
+    end
+
+    context "returning CONTINUE" do
+      before do
+        @scrubber = Loofah::Scrubber.new do |node|
+          @count += 1
+          Loofah::Scrubber::CONTINUE
+        end
+      end
+
+      it "operate properly on a fragment" do
+        Loofah.scrub_fragment(FRAGMENT, @scrubber)
+        assert_equal FRAGMENT_NODE_COUNT, @count
+      end
+
+      it "operate properly on a document" do
+        Loofah.scrub_document(DOCUMENT, @scrubber)
+        assert_equal DOCUMENT_NODE_COUNT, @count
+      end
+    end
+
+    context "returning STOP" do
+      before do
+        @scrubber = Loofah::Scrubber.new do |node|
+          @count += 1
+          Loofah::Scrubber::STOP
+        end
+      end
+
+      it "operate as top-down on a fragment" do
+        Loofah.scrub_fragment(FRAGMENT, @scrubber)
+        assert_equal FRAGMENT_NODE_STOP_TOP_DOWN, @count
+      end
+
+      it "operate as top-down on a document" do
+        Loofah.scrub_document(DOCUMENT, @scrubber)
+        assert_equal DOCUMENT_NODE_STOP_TOP_DOWN, @count
+      end
+    end
+
+    context "returning neither CONTINUE nor STOP" do
+      before do
+        @scrubber = Loofah::Scrubber.new do |node|
+          @count += 1
+        end
+      end
+
+      it "act as if CONTINUE was returned" do
+        Loofah.scrub_fragment(FRAGMENT, @scrubber)
+        assert_equal FRAGMENT_NODE_COUNT, @count
+      end
+    end
+
+    context "not specifying direction" do
+      before do
+        @scrubber = Loofah::Scrubber.new() do |node|
+          @count += 1
+          Loofah::Scrubber::STOP
+        end
+      end
+
+      it "operate as top-down on a fragment" do
+        Loofah.scrub_fragment(FRAGMENT, @scrubber)
+        assert_equal FRAGMENT_NODE_STOP_TOP_DOWN, @count
+      end
+
+      it "operate as top-down on a document" do
+        Loofah.scrub_document(DOCUMENT, @scrubber)
+        assert_equal DOCUMENT_NODE_STOP_TOP_DOWN, @count
+      end
+    end
+
+    context "specifying top-down direction" do
+      before do
+        @scrubber = Loofah::Scrubber.new(:direction => :top_down) do |node|
+          @count += 1
+          Loofah::Scrubber::STOP
+        end
+      end
+
+      it "operate as top-down on a fragment" do
+        Loofah.scrub_fragment(FRAGMENT, @scrubber)
+        assert_equal FRAGMENT_NODE_STOP_TOP_DOWN, @count
+      end
+
+      it "operate as top-down on a document" do
+        Loofah.scrub_document(DOCUMENT, @scrubber)
+        assert_equal DOCUMENT_NODE_STOP_TOP_DOWN, @count
+      end
+    end
+
+    context "specifying bottom-up direction" do
+      before do
+        @scrubber = Loofah::Scrubber.new(:direction => :bottom_up) do |node|
+          @count += 1
+        end
+      end
+
+      it "operate as bottom-up on a fragment" do
+        Loofah.scrub_fragment(FRAGMENT, @scrubber)
+        assert_equal FRAGMENT_NODE_COUNT, @count
+      end
+
+      it "operate as bottom-up on a document" do
+        Loofah.scrub_document(DOCUMENT, @scrubber)
+        assert_equal DOCUMENT_NODE_COUNT, @count
+      end
+    end
+
+    context "invalid direction" do
+      it "raise an exception" do
+        assert_raises(ArgumentError) {
+          Loofah::Scrubber.new(:direction => :quux) { }
+        }
+      end
+    end
+
+    context "given a block taking zero arguments" do
+      before do
+        @scrubber = Loofah::Scrubber.new do
+          @count += 1
+        end
+      end
+
+      it "work anyway, shrug" do
+        Loofah.scrub_fragment(FRAGMENT, @scrubber)
+        assert_equal FRAGMENT_NODE_COUNT, @count
+      end
+    end
+  end
+
+  context "defining a new Scrubber class" do
+    before do
+      @klass = Class.new(Loofah::Scrubber) do
+        attr_accessor :count
+
+        def initialize(direction=nil)
+          @direction = direction
+          @count = 0
+        end
+
+        def scrub(node)
+          @count += 1
+          Loofah::Scrubber::STOP
+        end
+      end
+    end
+
+    context "when not specifying direction" do
+      before do
+        @scrubber = @klass.new
+        assert_nil @scrubber.direction
+      end
+
+      it "operate as top-down on a fragment" do
+        Loofah.scrub_fragment(FRAGMENT, @scrubber)
+        assert_equal FRAGMENT_NODE_STOP_TOP_DOWN, @scrubber.count
+      end
+
+      it "operate as top-down on a document" do
+        Loofah.scrub_document(DOCUMENT, @scrubber)
+        assert_equal DOCUMENT_NODE_STOP_TOP_DOWN, @scrubber.count
+      end
+    end
+
+    context "when direction is specified as top_down" do
+      before do
+        @scrubber = @klass.new(:top_down)
+        assert_equal :top_down, @scrubber.direction
+      end
+
+      it "operate as top-down on a fragment" do
+        Loofah.scrub_fragment(FRAGMENT, @scrubber)
+        assert_equal FRAGMENT_NODE_STOP_TOP_DOWN, @scrubber.count
+      end
+
+      it "operate as top-down on a document" do
+        Loofah.scrub_document(DOCUMENT, @scrubber)
+        assert_equal DOCUMENT_NODE_STOP_TOP_DOWN, @scrubber.count
+      end
+    end
+
+    context "when direction is specified as bottom_up" do
+      before do
+        @scrubber = @klass.new(:bottom_up)
+        assert_equal :bottom_up, @scrubber.direction
+      end
+
+      it "operate as bottom-up on a fragment" do
+        Loofah.scrub_fragment(FRAGMENT, @scrubber)
+        assert_equal FRAGMENT_NODE_COUNT, @scrubber.count
+      end
+
+      it "operate as bottom-up on a document" do
+        Loofah.scrub_document(DOCUMENT, @scrubber)
+        assert_equal DOCUMENT_NODE_COUNT, @scrubber.count
+      end
+    end
+  end
+
+  context "creating a new Scrubber class with no scrub method" do
+    before do
+      @klass = Class.new(Loofah::Scrubber) do
+        def initialize ; end
+      end
+      @scrubber = @klass.new
+    end
+
+    it "raise an exception" do
+      assert_raises(Loofah::ScrubberNotFound) {
+        Loofah.scrub_fragment(FRAGMENT, @scrubber)
+      }
+    end
+  end
+end