escape_utils 0.1.4 → 0.1.5

data/lib/escape_utils.rb

@@ -4,5 +4,7 @@ require 'escape_utils_ext'
 
 EscapeUtils.send(:extend, EscapeUtils)
 module EscapeUtils
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
+
+  autoload :HtmlSafety, 'escape_utils/html_safety'
 end

data/lib/escape_utils/html/cgi.rb

@@ -1,7 +1,13 @@
 # encoding: utf-8
 
 class CGI
-  def self.escapeHTML(s)
-    EscapeUtils.escape_html(s.to_s)
+  extend ::EscapeUtils::HtmlSafety
+
+  class << self
+    alias escapeHTML _escape_html
+
+    def unescapeHTML(s)
+      EscapeUtils.unescape_html(s)
+    end
   end
 end

data/lib/escape_utils/html/erb.rb

@@ -2,10 +2,9 @@
 
 class ERB
   module Util
-    def html_escape(s)
-      EscapeUtils.escape_html(s.to_s)
-    end
+    include ::EscapeUtils::HtmlSafety
 
+    alias html_escape _escape_html
     alias h html_escape
     module_function :h
     module_function :html_escape

data/lib/escape_utils/html/haml.rb

@@ -2,8 +2,8 @@
 
 module Haml
   module Helpers
-    def html_escape(s)
-      EscapeUtils.escape_html(s.to_s)
-    end
+    include ::EscapeUtils::HtmlSafety
+
+    alias html_escape _escape_html
   end
 end

data/lib/escape_utils/html/rack.rb

@@ -2,11 +2,9 @@
 
 module Rack
   module Utils
-    def escape_html(s)
-      EscapeUtils.escape_html(s.to_s)
-    end
-    def self.escape_html(s)
-      EscapeUtils.escape_html(s.to_s)
-    end
+    include ::EscapeUtils::HtmlSafety
+
+    alias escape_html _escape_html
+    module_function :escape_html
   end
 end

data/lib/escape_utils/html_safety.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+module EscapeUtils
+  module HtmlSafety
+    if "".respond_to? :html_safe?
+      def _escape_html(s)
+        if s.html_safe?
+          s.to_s.html_safe
+        else
+          EscapeUtils.escape_html(s.to_s).html_safe
+        end
+      end
+    else
+      def _escape_html(s)
+        EscapeUtils.escape_html(s.to_s)
+      end
+    end
+  end
+end

data/lib/escape_utils/url/cgi.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+class CGI
+  def self.escape(s)
+    EscapeUtils.escape_url(s)
+  end
+  def self.unescape(s)
+    EscapeUtils.unescape_url(s)
+  end
+end

data/lib/escape_utils/url/erb.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+class ERB
+  module Util
+    def url_encode(s)
+      EscapeUtils.escape_url(s)
+    end
+    alias u url_encode
+    module_function :u
+    module_function :url_encode
+  end
+end

data/lib/escape_utils/url/rack.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+module Rack
+  module Utils
+    def escape(url)
+      EscapeUtils.escape_url(url)
+    end
+    def unescape(url)
+      EscapeUtils.unescape_url(url)
+    end
+    module_function :escape
+    module_function :unescape
+  end
+end

data/spec/html/escape_spec.rb

@@ -7,19 +7,19 @@ describe EscapeUtils, "escape_html" do
   end
 
   it "should escape a basic html tag" do
-    EscapeUtils.escape_html("<some_tag/>").should eql("&lt;some_tag/&gt;")
+    EscapeUtils.escape_html("<some_tag/>").should eql("&lt;some_tag&#47;&gt;")
   end
 
   it "should escape double-quotes" do
-    EscapeUtils.escape_html("<some_tag some_attr=\"some value\"/>").should eql("&lt;some_tag some_attr=&quot;some value&quot;/&gt;")
+    EscapeUtils.escape_html("<some_tag some_attr=\"some value\"/>").should eql("&lt;some_tag some_attr=&quot;some value&quot;&#47;&gt;")
   end
 
   it "should escape single-quotes" do
-    EscapeUtils.escape_html("<some_tag some_attr='some value'/>").should eql("&lt;some_tag some_attr=&#39;some value&#39;/&gt;")
+    EscapeUtils.escape_html("<some_tag some_attr='some value'/>").should eql("&lt;some_tag some_attr=&#39;some value&#39;&#47;&gt;")
   end
 
   it "should escape the & character" do
-    EscapeUtils.escape_html("<b>Bourbon & Branch</b>").should eql("&lt;b&gt;Bourbon &amp; Branch&lt;/b&gt;")
+    EscapeUtils.escape_html("<b>Bourbon & Branch</b>").should eql("&lt;b&gt;Bourbon &amp; Branch&lt;&#47;b&gt;")
   end
 
   if RUBY_VERSION =~ /^1.9/

data/spec/html/unescape_spec.rb

@@ -7,19 +7,19 @@ describe EscapeUtils, "unescape_html" do
   end
 
   it "should unescape a basic html tag" do
-    EscapeUtils.unescape_html("&lt;some_tag/&gt;").should eql("<some_tag/>")
+    EscapeUtils.unescape_html("&lt;some_tag&#47;&gt;").should eql("<some_tag/>")
   end
 
   it "should unescape double-quotes" do
-    EscapeUtils.unescape_html("&lt;some_tag some_attr=&quot;some value&quot;/&gt;").should eql("<some_tag some_attr=\"some value\"/>")
+    EscapeUtils.unescape_html("&lt;some_tag some_attr=&quot;some value&quot;&#47;&gt;").should eql("<some_tag some_attr=\"some value\"/>")
   end
 
   it "should unescape single-quotes" do
-    EscapeUtils.unescape_html("&lt;some_tag some_attr=&#39;some value&#39;/&gt;").should eql("<some_tag some_attr='some value'/>")
+    EscapeUtils.unescape_html("&lt;some_tag some_attr=&#39;some value&#39;&#47;&gt;").should eql("<some_tag some_attr='some value'/>")
   end
 
   it "should unescape the & character" do
-    EscapeUtils.unescape_html("&lt;b&gt;Bourbon &amp; Branch&lt;/b&gt;").should eql("<b>Bourbon & Branch</b>")
+    EscapeUtils.unescape_html("&lt;b&gt;Bourbon &amp; Branch&lt;&#47;b&gt;").should eql("<b>Bourbon & Branch</b>")
   end
 
   if RUBY_VERSION =~ /^1.9/

data/spec/html_safety_spec.rb

@@ -0,0 +1,49 @@
+# encoding: UTF-8
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper.rb')
+
+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
+
+include EscapeUtils::HtmlSafety
+
+describe EscapeUtils::HtmlSafety do
+
+  it "should escape unsafe strings and make them safe" do
+    escaped = _escape_html("<strong>unsafe</strong>")
+    escaped.should eql("&lt;strong&gt;unsafe&lt;&#47;strong&gt;")
+    escaped.should be_html_safe
+  end
+
+  it "shouldn't escape safe strings" do
+    _escape_html("<p>safe string</p>".html_safe).should eql("<p>safe string</p>")
+  end
+
+  it "should work with non strings" do
+    _escape_html(5).should eql("5")
+    _escape_html(:hello).should eql("hello")
+  end
+
+end

data/spec/javascript/escape_spec.rb

@@ -12,7 +12,7 @@ describe EscapeUtils, "escape_javascript" do
   end
 
   it "should escape quotes and newlines" do
-    EscapeUtils.escape_javascript(%(This "thing" is really\n netos')).should eql(%(This \\"thing\\" is really\\n netos\\'))
+    EscapeUtils.escape_javascript(%(This "thing" is really\n netos\r\n\n')).should eql(%(This \\"thing\\" is really\\n netos\\n\\n\\'))
   end
 
   it "should escape backslashes" do

data/spec/javascript/unescape_spec.rb

@@ -0,0 +1,39 @@
+# encoding: UTF-8
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper.rb')
+
+describe EscapeUtils, "unescape_javascript" do
+  it "should respond to unescape_javascript" do
+    EscapeUtils.should respond_to(:unescape_javascript)
+  end
+
+  # these are from the ActionView tests
+  it "should return an empty string if passed nil" do
+    EscapeUtils.unescape_javascript(nil).should eql("")
+  end
+
+  it "should unescape quotes and newlines" do
+    EscapeUtils.unescape_javascript(%(This \\"thing\\" is really\\n netos\\n\\n\\')).should eql(%(This "thing" is really\n netos\n\n'))
+  end
+
+  it "should unescape backslashes" do
+    EscapeUtils.unescape_javascript(%(backslash\\\\test)).should eql(%(backslash\\test))
+  end
+
+  it "should unescape closed html tags" do
+    EscapeUtils.unescape_javascript(%(dont <\\/close> tags)).should eql(%(dont </close> tags))
+  end
+
+  if RUBY_VERSION =~ /^1.9/
+    it "should default to utf-8 if Encoding.default_internal is nil" do
+      Encoding.default_internal = nil
+      EscapeUtils.unescape_javascript(%(dont <\\/close> tags)).encoding.should eql(Encoding.find('utf-8'))
+    end
+
+    it "should use Encoding.default_internal" do
+      Encoding.default_internal = Encoding.find('utf-8')
+      EscapeUtils.unescape_javascript(%(dont <\\/close> tags)).encoding.should eql(Encoding.default_internal)
+      Encoding.default_internal = Encoding.find('us-ascii')
+      EscapeUtils.unescape_javascript(%(dont <\\/close> tags)).encoding.should eql(Encoding.default_internal)
+    end
+  end
+end

data/spec/url/escape_spec.rb

@@ -0,0 +1,52 @@
+# encoding: UTF-8
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper.rb')
+
+describe EscapeUtils, "escape_url" do
+  it "should respond to escape_url" do
+    EscapeUtils.should respond_to(:escape_url)
+  end
+
+  it "should escape a basic url" do
+    EscapeUtils.escape_url("http://www.homerun.com/").should eql("http%3A%2F%2Fwww.homerun.com%2F")
+  end
+
+  # NOTE: from Rack's test suite
+  it "should escape a url containing tags" do
+    EscapeUtils.escape_url("fo<o>bar").should eql("fo%3Co%3Ebar")
+  end
+
+  # NOTE: from Rack's test suite
+  it "should escape a url with spaces" do
+    EscapeUtils.escape_url("a space").should eql("a+space")
+    EscapeUtils.escape_url("a   sp ace ").should eql("a+++sp+ace+")
+  end
+
+  # NOTE: from Rack's test suite
+  it "should escape a string of mixed characters" do
+    EscapeUtils.escape_url("q1!2\"'w$5&7/z8)?\\").should eql("q1%212%22%27w%245%267%2Fz8%29%3F%5C")
+  end
+
+  # NOTE: from Rack's test suite
+  it "should escape correctly for multibyte characters" do
+    matz_name = "\xE3\x81\xBE\xE3\x81\xA4\xE3\x82\x82\xE3\x81\xA8".unpack("a*")[0] # Matsumoto
+    matz_name.force_encoding("UTF-8") if matz_name.respond_to? :force_encoding
+    EscapeUtils.escape_url(matz_name).should eql('%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".unpack("a*")[0] # Matsu moto
+    matz_name_sep.force_encoding("UTF-8") if matz_name_sep.respond_to? :force_encoding
+    EscapeUtils.escape_url(matz_name_sep).should eql('%E3%81%BE%E3%81%A4+%E3%82%82%E3%81%A8')
+  end
+
+  if RUBY_VERSION =~ /^1.9/
+    it "should default to utf-8 if Encoding.default_internal is nil" do
+      Encoding.default_internal = nil
+      EscapeUtils.escape_url("http://www.homerun.com/").encoding.should eql(Encoding.find('utf-8'))
+    end
+
+    it "should use Encoding.default_internal" do
+      Encoding.default_internal = Encoding.find('utf-8')
+      EscapeUtils.escape_url("http://www.homerun.com/").encoding.should eql(Encoding.default_internal)
+      Encoding.default_internal = Encoding.find('us-ascii')
+      EscapeUtils.escape_url("http://www.homerun.com/").encoding.should eql(Encoding.default_internal)
+    end
+  end
+end

data/spec/url/unescape_spec.rb

@@ -0,0 +1,52 @@
+# encoding: UTF-8
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper.rb')
+
+describe EscapeUtils, "unescape_url" do
+  it "should respond to unescape_url" do
+    EscapeUtils.should respond_to(:unescape_url)
+  end
+
+  it "should unescape a basic url" do
+    EscapeUtils.unescape_url("http%3A%2F%2Fwww.homerun.com%2F").should eql("http://www.homerun.com/")
+  end
+
+  # NOTE: from Rack's test suite
+  it "should unescape a url containing tags" do
+    EscapeUtils.unescape_url("fo%3Co%3Ebar").should eql("fo<o>bar")
+  end
+
+  # NOTE: from Rack's test suite
+  it "should unescape a url with spaces" do
+    EscapeUtils.unescape_url("a+space").should eql("a space")
+    EscapeUtils.unescape_url("a+++sp+ace+").should eql("a   sp ace ")
+  end
+
+  # NOTE: from Rack's test suite
+  it "should unescape a string of mixed characters" do
+    EscapeUtils.unescape_url("q1%212%22%27w%245%267%2Fz8%29%3F%5C").should eql("q1!2\"'w$5&7/z8)?\\")
+  end
+
+  # NOTE: from Rack's test suite
+  it "should unescape correctly for multibyte characters" do
+    matz_name = "\xE3\x81\xBE\xE3\x81\xA4\xE3\x82\x82\xE3\x81\xA8".unpack("a*")[0] # Matsumoto
+    matz_name.force_encoding("UTF-8") if matz_name.respond_to? :force_encoding
+    EscapeUtils.unescape_url('%E3%81%BE%E3%81%A4%E3%82%82%E3%81%A8').should eql(matz_name)
+    matz_name_sep = "\xE3\x81\xBE\xE3\x81\xA4 \xE3\x82\x82\xE3\x81\xA8".unpack("a*")[0] # Matsu moto
+    matz_name_sep.force_encoding("UTF-8") if matz_name_sep.respond_to? :force_encoding
+    EscapeUtils.unescape_url('%E3%81%BE%E3%81%A4+%E3%82%82%E3%81%A8').should eql(matz_name_sep)
+  end
+
+  if RUBY_VERSION =~ /^1.9/
+    it "should default to utf-8 if Encoding.default_internal is nil" do
+      Encoding.default_internal = nil
+      EscapeUtils.unescape_url("http%3A%2F%2Fwww.homerun.com%2F").encoding.should eql(Encoding.find('utf-8'))
+    end
+
+    it "should use Encoding.default_internal" do
+      Encoding.default_internal = Encoding.find('utf-8')
+      EscapeUtils.unescape_url("http%3A%2F%2Fwww.homerun.com%2F").encoding.should eql(Encoding.default_internal)
+      Encoding.default_internal = Encoding.find('us-ascii')
+      EscapeUtils.unescape_url("http%3A%2F%2Fwww.homerun.com%2F").encoding.should eql(Encoding.default_internal)
+    end
+  end
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: escape_utils
 version: !ruby/object:Gem::Version 
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Brian Lopez
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-09 00:00:00 -07:00
+date: 2010-07-13 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -36,6 +37,9 @@ files:
 - benchmark/html_escape.rb
 - benchmark/html_unescape.rb
 - benchmark/javascript_escape.rb
+- benchmark/javascript_unescape.rb
+- benchmark/url_escape.rb
+- benchmark/url_unescape.rb
 - escape_utils.gemspec
 - ext/escape_utils.c
 - ext/extconf.rb
@@ -44,13 +48,21 @@ files:
 - lib/escape_utils/html/erb.rb
 - lib/escape_utils/html/haml.rb
 - lib/escape_utils/html/rack.rb
+- lib/escape_utils/html_safety.rb
 - lib/escape_utils/javascript/action_view.rb
+- lib/escape_utils/url/cgi.rb
+- lib/escape_utils/url/erb.rb
+- lib/escape_utils/url/rack.rb
 - spec/html/escape_spec.rb
 - spec/html/unescape_spec.rb
+- spec/html_safety_spec.rb
 - spec/javascript/escape_spec.rb
+- spec/javascript/unescape_spec.rb
 - spec/rcov.opts
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/url/escape_spec.rb
+- spec/url/unescape_spec.rb
 has_rdoc: true
 homepage: http://github.com/brianmario/escape_utils
 licenses: []
@@ -62,28 +74,36 @@ require_paths:
 - lib
 - ext
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Faster string escaping routines for your web apps
 test_files: 
 - spec/html/escape_spec.rb
 - spec/html/unescape_spec.rb
+- spec/html_safety_spec.rb
 - spec/javascript/escape_spec.rb
+- spec/javascript/unescape_spec.rb
 - spec/spec_helper.rb
+- spec/url/escape_spec.rb
+- spec/url/unescape_spec.rb