escape_utils 0.2.4 → 0.3.0

data/test/html_safety_test.rb

@@ -0,0 +1,46 @@
+require File.expand_path("../helper", __FILE__)
+
+class Object
+  def html_safe?
+    false
+  end
+end
+
+class TestSafeBuffer < String
+  def html_safe?
+    true
+  end
+
+  def html_safe
+    self
+  end
+
+  def to_s
+    self
+  end
+end
+
+class String
+  def html_safe
+    TestSafeBuffer.new(self)
+  end
+end
+
+class HtmlEscapeTest < MiniTest::Unit::TestCase
+  include EscapeUtils::HtmlSafety
+
+  def test_marks_escaped_strings_safe
+    escaped = _escape_html("<strong>unsafe</strong>")
+    assert_equal "&lt;strong&gt;unsafe&lt;&#47;strong&gt;", escaped
+    assert escaped.html_safe?
+  end
+
+  def test_doesnt_escape_safe_strings
+    assert_equal "<p>safe string</p>", _escape_html("<p>safe string</p>".html_safe)
+  end
+
+  def test_
+    assert_equal "5", _escape_html(5)
+    assert_equal "hello", _escape_html(:hello)
+  end
+end

data/test/javascript/escape_test.rb

@@ -0,0 +1,42 @@
+require File.expand_path("../../helper", __FILE__)
+
+class JavascriptEscapeTest < MiniTest::Unit::TestCase
+  def test_returns_empty_string_if_nil_passed
+    assert_equal "", EscapeUtils.escape_javascript(nil)
+  end
+
+  def test_quotes_and_newlines
+    assert_equal %(This \\"thing\\" is really\\n netos\\n\\n\\'), EscapeUtils.escape_javascript(%(This "thing" is really\n netos\r\n\n'))
+  end
+
+  def test_backslashes
+    assert_equal %(backslash\\\\test), EscapeUtils.escape_javascript(%(backslash\\test))
+  end
+
+  def test_closed_html_tags
+    assert_equal %(keep <open>, but dont <\\/close> tags), EscapeUtils.escape_javascript(%(keep <open>, but dont </close> tags))
+  end
+
+  if RUBY_VERSION =~ /^1.9/
+    def test_input_must_be_utf8_or_ascii
+      str = "dont </close> tags"
+
+      str.force_encoding 'ISO-8859-1'
+      assert_raises Encoding::CompatibilityError do
+        EscapeUtils.escape_javascript(str)
+      end
+
+      str.force_encoding 'UTF-8'
+      begin
+        EscapeUtils.escape_javascript(str)
+      rescue Encoding::CompatibilityError => e
+        assert_nil e, "#{e.class.name} raised, expected not to"
+      end
+    end
+
+    def test_return_value_is_tagged_as_utf8
+      str = "dont </close> tags"
+      assert_equal Encoding.find('UTF-8'), EscapeUtils.escape_javascript(str).encoding
+    end
+  end
+end

data/test/javascript/unescape_test.rb

@@ -0,0 +1,46 @@
+require File.expand_path("../../helper", __FILE__)
+
+class JavascriptUnescapeTest < MiniTest::Unit::TestCase
+  def test_returns_empty_string_if_nil_passed
+    assert_equal "", EscapeUtils.unescape_javascript(nil)
+  end
+
+  def test_quotes_and_newlines
+    assert_equal %(This "thing" is really\n netos\n\n'), EscapeUtils.unescape_javascript(%(This \\"thing\\" is really\\n netos\\n\\n\\'))
+  end
+
+  def test_backslashes
+    assert_equal %(backslash\\test), EscapeUtils.unescape_javascript(%(backslash\\\\test))
+  end
+
+  def test_closed_html_tags
+    assert_equal %(dont </close> tags), EscapeUtils.unescape_javascript(%(dont <\\/close> tags))
+  end
+
+  def test_passes_through_standalone_backslash
+    assert_equal "\\", EscapeUtils.unescape_javascript("\\")
+  end
+
+  if RUBY_VERSION =~ /^1.9/
+    def test_input_must_be_utf8_or_ascii
+      escaped = EscapeUtils.escape_javascript("dont </close> tags")
+
+      escaped.force_encoding 'ISO-8859-1'
+      assert_raises Encoding::CompatibilityError do
+        EscapeUtils.unescape_javascript(escaped)
+      end
+
+      escaped.force_encoding 'UTF-8'
+      begin
+        EscapeUtils.unescape_javascript(escaped)
+      rescue Encoding::CompatibilityError => e
+        assert_nil e, "#{e.class.name} raised, expected not to"
+      end
+    end
+
+    def test_return_value_is_tagged_as_utf8
+      escaped = EscapeUtils.escape_javascript("dont </close> tags")
+      assert_equal Encoding.find('UTF-8'), EscapeUtils.unescape_javascript(escaped).encoding
+    end
+  end
+end

data/test/query/escape_test.rb

@@ -0,0 +1,50 @@
+require File.expand_path("../../helper", __FILE__)
+
+class QueryEscapeTest < MiniTest::Unit::TestCase
+  def test_basic_url
+    assert_equal "http%3A%2F%2Fwww.homerun.com%2F", EscapeUtils.escape_url("http://www.homerun.com/")
+  end
+
+  def test_url_containing_tags
+    assert_equal "fo%3Co%3Ebar", EscapeUtils.escape_url("fo<o>bar")
+  end
+
+  def test_url_containing_spaces
+    assert_equal "a+space", EscapeUtils.escape_url("a space")
+    assert_equal "a+++sp+ace+", EscapeUtils.escape_url("a   sp ace ")
+  end
+
+  def test_url_of_mixed_characters
+    assert_equal "q1%212%22%27w%245%267%2Fz8%29%3F%5C", EscapeUtils.escape_url("q1!2\"'w$5&7/z8)?\\")
+  end
+
+  def test_url_with_multibyte_characters
+    matz_name = "\xE3\x81\xBE\xE3\x81\xA4\xE3\x82\x82\xE3\x81\xA8" # Matsumoto
+    assert_equal '%E3%81%BE%E3%81%A4%E3%82%82%E3%81%A8', EscapeUtils.escape_url(matz_name)
+    matz_name_sep = "\xE3\x81\xBE\xE3\x81\xA4 \xE3\x82\x82\xE3\x81\xA8" # Matsu moto
+    assert_equal '%E3%81%BE%E3%81%A4+%E3%82%82%E3%81%A8', EscapeUtils.escape_url(matz_name_sep)
+  end
+
+  if RUBY_VERSION =~ /^1.9/
+    def test_input_must_be_utf8_or_ascii
+      str = "a space"
+
+      str.force_encoding 'ISO-8859-1'
+      assert_raises Encoding::CompatibilityError do
+        EscapeUtils.escape_url(str)
+      end
+
+      str.force_encoding 'UTF-8'
+      begin
+        EscapeUtils.escape_url(str)
+      rescue Encoding::CompatibilityError => e
+        assert_nil e, "#{e.class.name} raised, expected not to"
+      end
+    end
+
+    def test_return_value_is_tagged_as_utf8
+      str = "a+space"
+      assert_equal Encoding.find('UTF-8'), EscapeUtils.escape_url(str).encoding
+    end
+  end
+end

data/test/query/unescape_test.rb

@@ -0,0 +1,52 @@
+require File.expand_path("../../helper", __FILE__)
+
+class QueryUnescapeTest < MiniTest::Unit::TestCase
+  def test_basic_url
+    assert_equal "http://www.homerun.com/", EscapeUtils.unescape_url("http%3A%2F%2Fwww.homerun.com%2F")
+  end
+
+  def test_url_containing_tags
+    assert_equal "fo<o>bar", EscapeUtils.unescape_url("fo%3Co%3Ebar")
+  end
+
+  def test_url_containing_spaces
+    assert_equal "a space", EscapeUtils.unescape_url("a+space")
+    assert_equal "a   sp ace ", EscapeUtils.unescape_url("a+++sp+ace+")
+  end
+
+  def test_url_containing_mixed_characters
+    assert_equal "q1!2\"'w$5&7/z8)?\\", EscapeUtils.unescape_url("q1%212%22%27w%245%267%2Fz8%29%3F%5C")
+  end
+
+  def test_url_containing_multibyte_characters
+    matz_name = "\xE3\x81\xBE\xE3\x81\xA4\xE3\x82\x82\xE3\x81\xA8" # Matsumoto
+    matz_name.force_encoding('UTF-8') if matz_name.respond_to?(:force_encoding)
+    assert_equal matz_name, EscapeUtils.unescape_url('%E3%81%BE%E3%81%A4%E3%82%82%E3%81%A8')
+    matz_name_sep = "\xE3\x81\xBE\xE3\x81\xA4 \xE3\x82\x82\xE3\x81\xA8" # Matsu moto
+    matz_name_sep.force_encoding('UTF-8') if matz_name_sep.respond_to?(:force_encoding)
+    assert_equal matz_name_sep, EscapeUtils.unescape_url('%E3%81%BE%E3%81%A4+%E3%82%82%E3%81%A8')
+  end
+
+  if RUBY_VERSION =~ /^1.9/
+    def test_input_must_be_valid_utf8_or_ascii
+      escaped = EscapeUtils.unescape_url("a+space")
+
+      escaped.force_encoding 'ISO-8859-1'
+      assert_raises Encoding::CompatibilityError do
+        EscapeUtils.unescape_url(escaped)
+      end
+
+      escaped.force_encoding 'UTF-8'
+      begin
+        EscapeUtils.unescape_url(escaped)
+      rescue Encoding::CompatibilityError => e
+        assert_nil e, "#{e.class.name} raised, expected not to"
+      end
+    end
+
+    def test_return_value_is_tagged_as_utf8
+      escaped = EscapeUtils.escape_url("a space")
+      assert_equal Encoding.find('UTF-8'), EscapeUtils.unescape_url(escaped).encoding
+    end
+  end
+end

data/test/uri/escape_test.rb

@@ -0,0 +1,50 @@
+require File.expand_path("../../helper", __FILE__)
+require 'uri'
+
+class UriEscapeTest < MiniTest::Unit::TestCase
+  def test_uri_stdlib_compatibility
+    (0..127).each do |i|
+      c = i.chr
+      assert_equal URI.escape(c), EscapeUtils.escape_uri(c)
+    end
+  end
+
+  def test_uri_containing_tags
+    assert_equal "fo%3Co%3Ebar", EscapeUtils.escape_uri("fo<o>bar")
+  end
+
+  def test_uri_containing_spaces
+    assert_equal "a%20space", EscapeUtils.escape_uri("a space")
+    assert_equal "a%20%20%20sp%20ace%20", EscapeUtils.escape_uri("a   sp ace ")
+  end
+
+  def test_multibyte_characters
+    matz_name = "\xE3\x81\xBE\xE3\x81\xA4\xE3\x82\x82\xE3\x81\xA8" # Matsumoto
+    assert_equal '%E3%81%BE%E3%81%A4%E3%82%82%E3%81%A8', EscapeUtils.escape_uri(matz_name)
+    matz_name_sep = "\xE3\x81\xBE\xE3\x81\xA4 \xE3\x82\x82\xE3\x81\xA8" # Matsu moto
+    assert_equal '%E3%81%BE%E3%81%A4%20%E3%82%82%E3%81%A8', EscapeUtils.escape_uri(matz_name_sep)
+  end
+
+  if RUBY_VERSION =~ /^1.9/
+    def test_input_must_be_utf8_or_ascii
+      str = "fo<o>bar"
+
+      str.force_encoding 'ISO-8859-1'
+      assert_raises Encoding::CompatibilityError do
+        EscapeUtils.escape_uri(str)
+      end
+
+      str.force_encoding 'UTF-8'
+      begin
+        EscapeUtils.escape_uri(str)
+      rescue Encoding::CompatibilityError => e
+        assert_nil e, "#{e.class.name} raised, expected not to"
+      end
+    end
+
+    def test_return_value_is_tagged_as_utf8
+      str = "fo<o>bar"
+      assert_equal Encoding.find('UTF-8'), EscapeUtils.escape_uri(str).encoding
+    end
+  end
+end

data/test/uri/unescape_test.rb

@@ -0,0 +1,55 @@
+require File.expand_path("../../helper", __FILE__)
+
+class UriUnescapeTest < MiniTest::Unit::TestCase
+  def test_doesnt_unescape_an_incomplete_escape
+    assert_equal "%", EscapeUtils.unescape_uri("%")
+    assert_equal "http%", EscapeUtils.unescape_uri("http%")
+  end
+
+  def test_uri_containing_tags
+    assert_equal "fo<o>bar", EscapeUtils.unescape_uri("fo%3Co%3Ebar")
+  end
+
+  def test_uri_containing_spaces
+    assert_equal "a space", EscapeUtils.unescape_uri("a%20space")
+    assert_equal "a   sp ace ", EscapeUtils.unescape_uri("a%20%20%20sp%20ace%20")
+    assert_equal "a+space", EscapeUtils.unescape_uri("a+space")
+  end
+
+  def test_uri_containing_mixed_characters
+    assert_equal "q1!2\"'w$5&7/z8)?\\", EscapeUtils.unescape_uri("q1%212%22%27w%245%267%2Fz8%29%3F%5C")
+    assert_equal "q1!2\"'w$5&7/z8)?\\", EscapeUtils.unescape_uri("q1!2%22'w$5&7/z8)?%5C")
+  end
+
+  def test_uri_containing_multibyte_charactes
+    matz_name = "\xE3\x81\xBE\xE3\x81\xA4\xE3\x82\x82\xE3\x81\xA8" # Matsumoto
+    matz_name.force_encoding('UTF-8') if matz_name.respond_to?(:force_encoding)
+    assert_equal matz_name, EscapeUtils.unescape_uri('%E3%81%BE%E3%81%A4%E3%82%82%E3%81%A8')
+    matz_name_sep = "\xE3\x81\xBE\xE3\x81\xA4 \xE3\x82\x82\xE3\x81\xA8" # Matsu moto
+    matz_name_sep.force_encoding('UTF-8') if matz_name_sep.respond_to?(:force_encoding)
+    assert_equal matz_name_sep, EscapeUtils.unescape_uri('%E3%81%BE%E3%81%A4%20%E3%82%82%E3%81%A8')
+  end
+
+  if RUBY_VERSION =~ /^1.9/
+    def test_input_must_be_valid_utf8_or_ascii
+      escaped = EscapeUtils.escape_uri("fo<o>bar")
+
+      escaped.force_encoding 'ISO-8859-1'
+      assert_raises Encoding::CompatibilityError do
+        EscapeUtils.unescape_url(escaped)
+      end
+
+      escaped.force_encoding 'UTF-8'
+      begin
+        EscapeUtils.unescape_url(escaped)
+      rescue Encoding::CompatibilityError => e
+        assert_nil e, "#{e.class.name} raised, expected not to"
+      end
+    end
+
+    def test_return_value_is_tagged_as_utf8
+      escaped = EscapeUtils.escape_uri("a space")
+      assert_equal Encoding.find('UTF-8'), EscapeUtils.unescape_url(escaped).encoding
+    end
+  end
+end

data/test/url/escape_test.rb

@@ -0,0 +1,58 @@
+require File.expand_path("../../helper", __FILE__)
+require 'cgi'
+
+class UriEscapeTest < MiniTest::Unit::TestCase
+  def test_basic_url
+    assert_equal "http%3A%2F%2Fwww.homerun.com%2F", EscapeUtils.escape_url("http://www.homerun.com/")
+  end
+
+  def test_cgi_stdlib_compatibility
+    (0..127).each do |i|
+      c = i.chr
+      assert_equal CGI.escape(c), EscapeUtils.escape_url(c)
+    end
+  end
+
+  def test_url_containing_tags
+    assert_equal "fo%3Co%3Ebar", EscapeUtils.escape_url("fo<o>bar")
+  end
+
+  def test_url_containing_spaces
+    assert_equal "a+space", EscapeUtils.escape_url("a space")
+    assert_equal "a+++sp+ace+", EscapeUtils.escape_url("a   sp ace ")
+  end
+
+  def test_url_containing_mixed_characters
+    assert_equal "q1%212%22%27w%245%267%2Fz8%29%3F%5C", EscapeUtils.escape_url("q1!2\"'w$5&7/z8)?\\")
+  end
+
+  def test_multibyte_characters
+    matz_name = "\xE3\x81\xBE\xE3\x81\xA4\xE3\x82\x82\xE3\x81\xA8" # Matsumoto
+    assert_equal '%E3%81%BE%E3%81%A4%E3%82%82%E3%81%A8', EscapeUtils.escape_url(matz_name)
+    matz_name_sep = "\xE3\x81\xBE\xE3\x81\xA4 \xE3\x82\x82\xE3\x81\xA8" # Matsu moto
+    assert_equal '%E3%81%BE%E3%81%A4+%E3%82%82%E3%81%A8', EscapeUtils.escape_url(matz_name_sep)
+  end
+
+  if RUBY_VERSION =~ /^1.9/
+    def test_input_must_be_utf8_or_ascii
+      str = "fo<o>bar"
+
+      str.force_encoding 'ISO-8859-1'
+      assert_raises Encoding::CompatibilityError do
+        EscapeUtils.escape_url(str)
+      end
+
+      str.force_encoding 'UTF-8'
+      begin
+        EscapeUtils.escape_url(str)
+      rescue Encoding::CompatibilityError => e
+        assert_nil e, "#{e.class.name} raised, expected not to"
+      end
+    end
+
+    def test_return_value_is_tagged_as_utf8
+      str = "fo<o>bar"
+      assert_equal Encoding.find('UTF-8'), EscapeUtils.escape_url(str).encoding
+    end
+  end
+end

data/test/url/unescape_test.rb

@@ -0,0 +1,60 @@
+require File.expand_path("../../helper", __FILE__)
+
+class UriUnescapeTest < MiniTest::Unit::TestCase
+  def test_basic_url
+    assert_equal "http://www.homerun.com/", EscapeUtils.unescape_url("http%3A%2F%2Fwww.homerun.com%2F")
+    assert_equal "http://www.homerun.com/", EscapeUtils.unescape_url("http://www.homerun.com/")
+  end
+
+  def test_doesnt_unescape_an_incomplete_escape
+    assert_equal "%", EscapeUtils.unescape_url("%")
+    assert_equal "http%", EscapeUtils.unescape_url("http%")
+  end
+
+  def test_url_containing_tags
+    assert_equal "fo<o>bar", EscapeUtils.unescape_url("fo%3Co%3Ebar")
+  end
+
+  def test_url_containing_spaces
+    assert_equal "a space", EscapeUtils.unescape_url("a%20space")
+    assert_equal "a   sp ace ", EscapeUtils.unescape_url("a%20%20%20sp%20ace%20")
+    assert_equal "a space", EscapeUtils.unescape_url("a+space")
+  end
+
+  def test_url_containing_mixed_characters
+    assert_equal "q1!2\"'w$5&7/z8)?\\", EscapeUtils.unescape_url("q1%212%22%27w%245%267%2Fz8%29%3F%5C")
+    assert_equal "q1!2\"'w$5&7/z8)?\\", EscapeUtils.unescape_url("q1!2%22'w$5&7/z8)?%5C")
+  end
+
+  def test_multibyte_characters
+    matz_name = "\xE3\x81\xBE\xE3\x81\xA4\xE3\x82\x82\xE3\x81\xA8" # Matsumoto
+    matz_name.force_encoding('UTF-8') if matz_name.respond_to?(:force_encoding)
+    assert_equal matz_name, EscapeUtils.unescape_url('%E3%81%BE%E3%81%A4%E3%82%82%E3%81%A8')
+    matz_name_sep = "\xE3\x81\xBE\xE3\x81\xA4 \xE3\x82\x82\xE3\x81\xA8" # Matsu moto
+    matz_name_sep.force_encoding('UTF-8') if matz_name_sep.respond_to?(:force_encoding)
+    assert_equal matz_name_sep, EscapeUtils.unescape_url('%E3%81%BE%E3%81%A4%20%E3%82%82%E3%81%A8')
+  end
+
+  if RUBY_VERSION =~ /^1.9/
+    def test_input_must_be_valid_utf8_or_ascii
+      escaped = EscapeUtils.escape_uri("fo<o>bar")
+
+      escaped.force_encoding 'ISO-8859-1'
+      assert_raises Encoding::CompatibilityError do
+        EscapeUtils.unescape_url(escaped)
+      end
+
+      escaped.force_encoding 'UTF-8'
+      begin
+        EscapeUtils.unescape_url(escaped)
+      rescue Encoding::CompatibilityError => e
+        assert_nil e, "#{e.class.name} raised, expected not to"
+      end
+    end
+
+    def test_return_value_is_tagged_as_utf8
+      escaped = EscapeUtils.escape_uri("fo<o>bar")
+      assert_equal Encoding.find('UTF-8'), EscapeUtils.unescape_url(escaped).encoding
+    end
+  end
+end