escape_utils 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e59c356d88fb33a0a31f0668c2e476d45bcced9
-  data.tar.gz: a8df94fbbc6f8aed27e5c59d53678f944ef782da
+  metadata.gz: a359a0da23b56ac37301e4ae73060dcfc4870d14
+  data.tar.gz: 2a3c9ed36204fc638605f012c3ca5a87ccc756b3
 SHA512:
-  metadata.gz: 980b6eef8962eac5f49e61154e1a26018c4e6a1be57a3d3c7aaa5acab8dac52076750edab093d3b0ed8ea47a00d7d222520251ed5f9a8bf6885d2e26e39d034e
-  data.tar.gz: 09ccd6442abd623df06036d418833af4d3bd1b63ee74f582f08f0537dccc7f29405ed934b7d2c0edbdab0d1c956a44946b2e8709f62ba1a214f28f814bdd1a28
+  metadata.gz: f862189c73f7858184a61a0e2ae78b2d344ac162022bd41ec77eb18eba6ae52a62e188d29b2b7ed2931ae47a4d6a33b2f8d6ecf82ef85e46ce1457e016897403
+  data.tar.gz: 8f4a4643def62dfd8fdb27d9d631aa452bca3e63e1672a70bcf95594f98040ccee00276d6c0abd8e90c11126b7932b6e0efcce9e7d0b2881523b6faed62cad1b

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Brian Lopez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/benchmark/html_escape.rb

@@ -1,9 +1,8 @@
 # encoding: utf-8
-$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/..')
-$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
 
 require 'rubygems'
-require 'benchmark'
+require 'bundler/setup'
+require 'benchmark/ips'
 
 require 'rack'
 require 'erb'
@@ -16,53 +15,54 @@ module HamlBench
   extend Haml::Helpers
 end
 
-times = 100
 url = "http://en.wikipedia.org/wiki/Line_of_succession_to_the_British_throne"
 html = `curl -s #{url}`
 html = html.force_encoding('utf-8') if html.respond_to?(:force_encoding)
-puts "Escaping #{html.bytesize} bytes of html #{times} times, from #{url}"
+puts "Escaping #{html.bytesize} bytes of html from #{url}"
 
-Benchmark.bmbm do |x|
-  x.report "Rack::Utils.escape_html" do
+Benchmark.ips do |x|
+  x.report "Rack::Utils.escape_html" do |times|
     times.times do
       Rack::Utils.escape_html(html)
     end
   end
 
-  x.report "Haml::Helpers.html_escape" do
+  x.report "Haml::Helpers.html_escape" do |times|
     times.times do
       HamlBench.html_escape(html)
     end
   end
 
-  x.report "ERB::Util.html_escape" do
+  x.report "ERB::Util.html_escape" do |times|
     times.times do
       ERB::Util.html_escape(html)
     end
   end
 
-  x.report "CGI.escapeHTML" do
+  x.report "CGI.escapeHTML" do |times|
     times.times do
       CGI.escapeHTML(html)
     end
   end
 
-  x.report "String#gsub" do
+  x.report "String#gsub" do |times|
     html_escape = { '&' => '&amp;',  '>' => '&gt;',   '<' => '&lt;', '"' => '&quot;', "'" => '&#39;' }
     times.times do
       html.gsub(/[&"'><]/, html_escape)
     end
   end
 
-  x.report "fast_xs_extra#fast_xs_html" do
+  x.report "fast_xs_extra#fast_xs_html" do |times|
     times.times do
       html.fast_xs_html
     end
   end
 
-  x.report "EscapeUtils.escape_html" do
+  x.report "EscapeUtils.escape_html" do |times|
     times.times do
       EscapeUtils.escape_html(html)
     end
   end
+
+  x.compare!
 end

data/benchmark/html_unescape.rb

@@ -1,9 +1,8 @@
 # encoding: utf-8
-$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/..')
-$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
 
 require 'rubygems'
-require 'benchmark'
+require 'bundler/setup'
+require 'benchmark/ips'
 
 require 'cgi'
 require 'haml'
@@ -13,23 +12,24 @@ module HamlBench
   extend Haml::Helpers
 end
 
-times = 100
 url = "http://en.wikipedia.org/wiki/Line_of_succession_to_the_British_throne"
 html = `curl -s #{url}`
 html = html.force_encoding('binary') if html.respond_to?(:force_encoding)
 escaped_html = EscapeUtils.escape_html(html)
-puts "Unescaping #{escaped_html.bytesize} bytes of escaped html #{times} times, from #{url}"
+puts "Unescaping #{escaped_html.bytesize} bytes of escaped html, from #{url}"
 
-Benchmark.bmbm do |x|
-  x.report "CGI.unescapeHTML" do
+Benchmark.ips do |x|
+  x.report "CGI.unescapeHTML" do |times|
     times.times do
       CGI.unescapeHTML(escaped_html)
     end
   end
 
-  x.report "EscapeUtils.unescape_html" do
+  x.report "EscapeUtils.unescape_html" do |times|
     times.times do
       EscapeUtils.unescape_html(escaped_html)
     end
   end
-end
+
+  x.compare!
+end

data/benchmark/javascript_escape.rb

@@ -1,9 +1,8 @@
 # encoding: utf-8
-$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/..')
-$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
 
 require 'rubygems'
-require 'benchmark'
+require 'bundler/setup'
+require 'benchmark/ips'
 
 require 'action_view'
 require 'escape_utils'
@@ -12,22 +11,23 @@ class ActionPackBench
   extend ActionView::Helpers::JavaScriptHelper
 end
 
-times = 100
 url = "http://ajax.googleapis.com/ajax/libs/dojo/1.4.3/dojo/dojo.xd.js.uncompressed.js"
 javascript = `curl -s #{url}`
 javascript = javascript.force_encoding('utf-8') if javascript.respond_to?(:force_encoding)
-puts "Escaping #{javascript.bytesize} bytes of javascript #{times} times, from #{url}"
+puts "Escaping #{javascript.bytesize} bytes of javascript, from #{url}"
 
-Benchmark.bmbm do |x|
-  x.report "ActionView::Helpers::JavaScriptHelper#escape_javascript" do
+Benchmark.ips do |x|
+  x.report "ActionView::Helpers::JavaScriptHelper#escape_javascript" do |times|
     times.times do
       ActionPackBench.escape_javascript(javascript)
     end
   end
 
-  x.report "EscapeUtils.escape_javascript" do
+  x.report "EscapeUtils.escape_javascript" do |times|
     times.times do
       EscapeUtils.escape_javascript(javascript)
     end
   end
-end
+
+  x.compare!
+end

data/benchmark/javascript_unescape.rb

@@ -1,23 +1,21 @@
 # encoding: utf-8
-$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/..')
-$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
 
 require 'rubygems'
-require 'benchmark'
+require 'bundler/setup'
+require 'benchmark/ips'
 
 require 'escape_utils'
 
-times = 100
 url = "http://ajax.googleapis.com/ajax/libs/dojo/1.4.3/dojo/dojo.xd.js.uncompressed.js"
 javascript = `curl -s #{url}`
 javascript = javascript.force_encoding('utf-8') if javascript.respond_to?(:force_encoding)
 escaped_javascript = EscapeUtils.escape_javascript(javascript)
-puts "Escaping #{escaped_javascript.bytesize} bytes of javascript #{times} times, from #{url}"
+puts "Escaping #{escaped_javascript.bytesize} bytes of javascript, from #{url}"
 
-Benchmark.bmbm do |x|
-  x.report "EscapeUtils.escape_javascript" do
+Benchmark.ips do |x|
+  x.report "EscapeUtils.escape_javascript" do |times|
     times.times do
       EscapeUtils.unescape_javascript(escaped_javascript)
     end
   end
-end
+end

data/benchmark/url_escape.rb

@@ -1,9 +1,8 @@
 # encoding: utf-8
-$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/..')
-$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
 
 require 'rubygems'
-require 'benchmark'
+require 'bundler/setup'
+require 'benchmark/ips'
 
 require 'rack'
 require 'erb'
@@ -12,45 +11,46 @@ require 'url_escape'
 require 'fast_xs_extra'
 require 'escape_utils'
 
-times = 10_000
 url = "https://www.yourmom.com/cgi-bin/session.cgi?sess_args=mYHcEA  dh435dqUs0moGHeeAJTSLLbdbcbd9ef----,574b95600e9ab7d27eb0bf524ac68c27----"
 url = url.force_encoding('us-ascii') if url.respond_to?(:force_encoding)
-puts "Escaping a #{url.bytesize} byte URL #{times} times"
+puts "Escaping a #{url.bytesize} byte URL times"
 
-Benchmark.bmbm do |x|
-  x.report "ERB::Util.url_encode" do
+Benchmark.ips do |x|
+  x.report "ERB::Util.url_encode" do |times|
     times.times do
       ERB::Util.url_encode(url)
     end
   end
 
-  x.report "Rack::Utils.escape" do
+  x.report "Rack::Utils.escape" do |times|
     times.times do
       Rack::Utils.escape(url)
     end
   end
 
-  x.report "CGI.escape" do
+  x.report "CGI.escape" do |times|
     times.times do
       CGI.escape(url)
     end
   end
 
-  x.report "URLEscape#escape" do
+  x.report "URLEscape#escape" do |times|
     times.times do
       URLEscape.escape(url)
     end
   end
 
-  x.report "fast_xs_extra#fast_xs_url" do
+  x.report "fast_xs_extra#fast_xs_url" do |times|
     times.times do
       url.fast_xs_url
     end
   end
 
-  x.report "EscapeUtils.escape_url" do
+  x.report "EscapeUtils.escape_url" do |times|
     times.times do
       EscapeUtils.escape_url(url)
     end
   end
-end
+
+  x.compare!
+end

data/benchmark/url_unescape.rb

@@ -1,9 +1,8 @@
 # encoding: utf-8
-$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/..')
-$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
 
 require 'rubygems'
-require 'benchmark'
+require 'bundler/setup'
+require 'benchmark/ips'
 
 require 'rack'
 require 'cgi'
@@ -11,40 +10,41 @@ require 'url_escape'
 require 'fast_xs_extra'
 require 'escape_utils'
 
-times = 10_000
 url = "https://www.yourmom.com/cgi-bin/session.cgi?sess_args=mYHcEA  dh435dqUs0moGHeeAJTSLLbdbcbd9ef----,574b95600e9ab7d27eb0bf524ac68c27----"
 url = url.force_encoding('us-ascii') if url.respond_to?(:force_encoding)
 escaped_url = EscapeUtils.escape_url(url)
-puts "Escaping a #{url.bytesize} byte URL #{times} times"
+puts "Escaping a #{url.bytesize} byte URL"
 
-Benchmark.bmbm do |x|
-  x.report "Rack::Utils.unescape" do
+Benchmark.ips do |x|
+  x.report "Rack::Utils.unescape" do |times|
     times.times do
       Rack::Utils.unescape(escaped_url)
     end
   end
-  
-  x.report "CGI.unescape" do
+
+  x.report "CGI.unescape" do |times|
     times.times do
       CGI.unescape(escaped_url)
     end
   end
-  
-  x.report "URLEscape#unescape" do
+
+  x.report "URLEscape#unescape" do |times|
     times.times do
       URLEscape.unescape(escaped_url)
     end
   end
 
-  x.report "fast_xs_extra#fast_uxs_cgi" do
+  x.report "fast_xs_extra#fast_uxs_cgi" do |times|
     times.times do
       url.fast_uxs_cgi
     end
   end
 
-  x.report "EscapeUtils.unescape_url" do
+  x.report "EscapeUtils.unescape_url" do |times|
     times.times do
       EscapeUtils.unescape_url(escaped_url)
     end
   end
-end
+
+  x.compare!
+end

data/benchmark/xml_escape.rb

@@ -1,29 +1,29 @@
 # encoding: utf-8
-$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/..')
-$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
 
 require 'rubygems'
-require 'benchmark'
+require 'bundler/setup'
+require 'benchmark/ips'
 
-require 'builder'
+require 'fast_xs'
 require 'escape_utils'
 
-times = 100
 url = "http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml"
 xml = `curl -s #{url}`
 xml = xml.force_encoding('binary') if xml.respond_to?(:force_encoding)
-puts "Escaping #{xml.bytesize} bytes of xml #{times} times, from #{url}"
+puts "Escaping #{xml.bytesize} bytes of xml, from #{url}"
 
-Benchmark.bmbm do |x|
-  x.report "Builder::String.to_xs" do
+Benchmark.ips do |x|
+  x.report "fast_xs" do |times|
     times.times do
-      xml.to_xs
+      xml.fast_xs
     end
   end
 
-  x.report "EscapeUtils.escape_xml" do
+  x.report "EscapeUtils.escape_xml" do |times|
     times.times do
       EscapeUtils.escape_xml(xml)
     end
   end
+
+  x.compare!
 end

data/escape_utils.gemspec

@@ -7,23 +7,25 @@ Gem::Specification.new do |s|
   s.email = %q{seniorlopez@gmail.com}
   s.extensions = ["ext/escape_utils/extconf.rb"]
   s.files = `git ls-files`.split("\n")
-  s.homepage = %q{http://github.com/brianmario/escape_utils}
+  s.homepage = %q{https://github.com/brianmario/escape_utils}
+  s.license = %q{MIT}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.4.2}
   s.summary = %q{Faster string escaping routines for your web apps}
+  s.description = %q{Quickly perform HTML, URL, URI and Javascript escaping/unescaping}
   s.test_files = `git ls-files test`.split("\n")
 
-  s.required_ruby_version = "> 1.9.3"
+  s.required_ruby_version = ">= 1.9.3"
 
   # tests
   s.add_development_dependency 'rake-compiler', ">= 0.7.5"
   s.add_development_dependency 'minitest', ">= 5.0.0"
   # benchmarks
+  s.add_development_dependency 'benchmark-ips'
   s.add_development_dependency 'rack'
   s.add_development_dependency 'haml'
   s.add_development_dependency 'fast_xs'
   s.add_development_dependency 'actionpack'
   s.add_development_dependency 'url_escape'
 end
-

data/ext/escape_utils/buffer.c

@@ -242,7 +242,7 @@ void gh_buf_attach(gh_buf *buf, char *ptr, size_t asize)
 
 int gh_buf_cmp(const gh_buf *a, const gh_buf *b)
 {
-	int result = memcmp(a->ptr, b->ptr, (a->size < b->size) ? a->size : b->size);
+	int result = memcmp(a->ptr, b->ptr, MIN(a->size, b->size));
 	return (result != 0) ? result :
 		(a->size < b->size) ? -1 : (a->size > b->size) ? 1 : 0;
 }

data/ext/escape_utils/escape_utils.c

@@ -96,6 +96,11 @@ rb_eu__generic(VALUE str, houdini_cb do_escape)
 /**
  * HTML methods
  */
+static VALUE new_html_safe_string(const char *ptr, size_t len)
+{
+	return rb_str_new_with_class(rb_html_safe_string_template_object, ptr, len);
+}
+
 static VALUE rb_eu_escape_html_as_html_safe(VALUE self, VALUE str)
 {
 	VALUE result;
@@ -106,11 +111,10 @@ static VALUE rb_eu_escape_html_as_html_safe(VALUE self, VALUE str)
 	check_utf8_encoding(str);
 
 	if (houdini_escape_html0(&buf, (const uint8_t *)RSTRING_PTR(str), RSTRING_LEN(str), secure)) {
-		result = eu_new_str(buf.ptr, buf.size);
+		result = new_html_safe_string(buf.ptr, buf.size);
 		gh_buf_free(&buf);
 	} else {
-		result = rb_str_new_with_class(rb_html_safe_string_template_object,
-			RSTRING_PTR(str), RSTRING_LEN(str));
+		result = new_html_safe_string(RSTRING_PTR(str), RSTRING_LEN(str));
 	}
 
 	rb_ivar_set(result, ID_at_html_safe, Qtrue);
@@ -198,6 +202,19 @@ static VALUE rb_eu_unescape_uri(VALUE self, VALUE str)
 	return rb_eu__generic(str, &houdini_unescape_uri);
 }
 
+/**
+ * URI component methods
+ */
+static VALUE rb_eu_escape_uri_component(VALUE self, VALUE str)
+{
+	return rb_eu__generic(str, &houdini_escape_uri_component);
+}
+
+static VALUE rb_eu_unescape_uri_component(VALUE self, VALUE str)
+{
+	return rb_eu__generic(str, &houdini_unescape_uri_component);
+}
+
 
 /**
  * Ruby Extension initializer
@@ -223,6 +240,8 @@ void Init_escape_utils()
 	rb_define_method(rb_mEscapeUtils, "unescape_url", rb_eu_unescape_url, 1);
 	rb_define_method(rb_mEscapeUtils, "escape_uri", rb_eu_escape_uri, 1);
 	rb_define_method(rb_mEscapeUtils, "unescape_uri", rb_eu_unescape_uri, 1);
+	rb_define_method(rb_mEscapeUtils, "escape_uri_component", rb_eu_escape_uri_component, 1);
+	rb_define_method(rb_mEscapeUtils, "unescape_uri_component", rb_eu_unescape_uri_component, 1);
 
 	rb_define_singleton_method(rb_mEscapeUtils, "html_secure=", rb_eu_set_html_secure, 1);
 	rb_define_singleton_method(rb_mEscapeUtils, "html_safe_string_class=", rb_eu_set_html_safe_string_class, 1);

data/ext/escape_utils/houdini.h

@@ -30,9 +30,11 @@ extern int houdini_escape_html0(gh_buf *ob, const uint8_t *src, size_t size, int
 extern int houdini_unescape_html(gh_buf *ob, const uint8_t *src, size_t size);
 extern int houdini_escape_xml(gh_buf *ob, const uint8_t *src, size_t size);
 extern int houdini_escape_uri(gh_buf *ob, const uint8_t *src, size_t size);
+extern int houdini_escape_uri_component(gh_buf *ob, const uint8_t *src, size_t size);
 extern int houdini_escape_url(gh_buf *ob, const uint8_t *src, size_t size);
 extern int houdini_escape_href(gh_buf *ob, const uint8_t *src, size_t size);
 extern int houdini_unescape_uri(gh_buf *ob, const uint8_t *src, size_t size);
+extern int houdini_unescape_uri_component(gh_buf *ob, const uint8_t *src, size_t size);
 extern int houdini_unescape_url(gh_buf *ob, const uint8_t *src, size_t size);
 extern int houdini_escape_js(gh_buf *ob, const uint8_t *src, size_t size);
 extern int houdini_unescape_js(gh_buf *ob, const uint8_t *src, size_t size);

data/ext/escape_utils/houdini_html_u.c

@@ -57,7 +57,7 @@ unescape_ent(gh_buf *ob, const uint8_t *src, size_t size)
 				codepoint = (codepoint * 16) + ((src[i] | 32) % 39 - 9);
 		}
 
-		if (i < size && src[i] == ';') {
+		if (i < size && src[i] == ';' && codepoint) {
 			gh_buf_put_utf8(ob, codepoint);
 			return i + 1;
 		}

data/ext/escape_utils/houdini_uri_e.c

@@ -43,10 +43,10 @@ static const char URI_SAFE[] = {
 };
 
 static int
-escape(gh_buf *ob, const uint8_t *src, size_t size, int is_url)
+escape(gh_buf *ob, const uint8_t *src, size_t size,
+	const char *safe_table, bool escape_plus)
 {
 	static const uint8_t hex_chars[] = "0123456789ABCDEF";
-	const char *safe_table = is_url ? URL_SAFE : URI_SAFE;
 
 	size_t  i = 0, org;
 	uint8_t hex_str[3];
@@ -73,7 +73,7 @@ escape(gh_buf *ob, const uint8_t *src, size_t size, int is_url)
 		if (i >= size)
 			break;
 
-		if (src[i] == ' ' && is_url) {
+		if (src[i] == ' ' && escape_plus) {
 			gh_buf_putc(ob, '+');
 		} else {
 			hex_str[1] = hex_chars[(src[i] >> 4) & 0xF];
@@ -90,12 +90,18 @@ escape(gh_buf *ob, const uint8_t *src, size_t size, int is_url)
 int
 houdini_escape_uri(gh_buf *ob, const uint8_t *src, size_t size)
 {
-	return escape(ob, src, size, 0);
+	return escape(ob, src, size, URI_SAFE, false);
+}
+
+int
+houdini_escape_uri_component(gh_buf *ob, const uint8_t *src, size_t size)
+{
+	return escape(ob, src, size, URL_SAFE, false);
 }
 
 int
 houdini_escape_url(gh_buf *ob, const uint8_t *src, size_t size)
 {
-	return escape(ob, src, size, 1);
+	return escape(ob, src, size, URL_SAFE, true);
 }
 

data/ext/escape_utils/houdini_uri_u.c

@@ -7,18 +7,18 @@
 #define hex2c(c) ((c | 32) % 39 - 9)
 
 static int
-unescape(gh_buf *ob, const uint8_t *src, size_t size, int is_url)
+unescape(gh_buf *ob, const uint8_t *src, size_t size, bool unescape_plus)
 {
 	size_t  i = 0, org;
 
 	while (i < size) {
 		org = i;
-		while (i < size && src[i] != '%')
+		while (i < size && src[i] != '%' && src[i] != '+')
 			i++;
 
 		if (likely(i > org)) {
 			if (unlikely(org == 0)) {
-				if (i >= size && !is_url)
+				if (i >= size)
 					return 0;
 
 				gh_buf_grow(ob, HOUDINI_UNESCAPED_SIZE(size));
@@ -31,7 +31,10 @@ unescape(gh_buf *ob, const uint8_t *src, size_t size, int is_url)
 		if (i >= size)
 			break;
 
-		i++;
+		if (src[i++] == '+') {
+			gh_buf_putc(ob, unescape_plus ? ' ' : '+');
+			continue;
+		}
 
 		if (i + 1 < size && _isxdigit(src[i]) && _isxdigit(src[i + 1])) {
 			unsigned char new_char = (hex2c(src[i]) << 4) + hex2c(src[i + 1]);
@@ -42,24 +45,24 @@ unescape(gh_buf *ob, const uint8_t *src, size_t size, int is_url)
 		}
 	}
 
-	if (is_url) {
-		char *find = (char *)gh_buf_cstr(ob);
-		while ((find = strchr(find, '+')) != NULL)
-			*find = ' ';
-	}
-
 	return 1;
 }
 
 int
 houdini_unescape_uri(gh_buf *ob, const uint8_t *src, size_t size)
 {
-	return unescape(ob, src, size, 0);
+	return unescape(ob, src, size, false);
+}
+
+int
+houdini_unescape_uri_component(gh_buf *ob, const uint8_t *src, size_t size)
+{
+	return unescape(ob, src, size, false);
 }
 
 int
 houdini_unescape_url(gh_buf *ob, const uint8_t *src, size_t size)
 {
-	return unescape(ob, src, size, 1);
+	return unescape(ob, src, size, true);
 }
 

data/lib/escape_utils/version.rb

@@ -1,3 +1,3 @@
 module EscapeUtils
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/test/html/escape_test.rb

@@ -56,6 +56,18 @@ class HtmlEscapeTest < Minitest::Test
     EscapeUtils.html_safe_string_class = klass_before
   end
 
+  def test_returns_custom_string_class_when_string_requires_escaping
+    klass_before = EscapeUtils.html_safe_string_class
+    EscapeUtils.html_safe_string_class = MyCustomHtmlSafeString
+
+    str = EscapeUtils.escape_html_as_html_safe("<script>")
+    assert_equal "&lt;script&gt;", str
+    assert_equal MyCustomHtmlSafeString, str.class
+    assert_equal true, str.instance_variable_get(:@html_safe)
+  ensure
+    EscapeUtils.html_safe_string_class = klass_before
+  end
+
   def test_html_safe_string_class_descends_string
     assert_raises ArgumentError do
       EscapeUtils.html_safe_string_class = Hash

data/test/uri/escape_test.rb

@@ -25,6 +25,14 @@ class UriEscapeTest < Minitest::Test
     assert_equal '%E3%81%BE%E3%81%A4%20%E3%82%82%E3%81%A8', EscapeUtils.escape_uri(matz_name_sep)
   end
 
+  def test_uri_containing_pluses
+    assert_equal "a+plus", EscapeUtils.escape_uri("a+plus")
+  end
+
+  def test_uri_containing_slashes
+    assert_equal "a/slash", EscapeUtils.escape_uri("a/slash")
+  end
+
   if RUBY_VERSION =~ /^1.9/
     def test_input_must_be_utf8_or_ascii
       str = "fo<o>bar"

data/test/uri/unescape_test.rb

@@ -30,18 +30,29 @@ class UriUnescapeTest < Minitest::Test
     assert_equal matz_name_sep, EscapeUtils.unescape_uri('%E3%81%BE%E3%81%A4%20%E3%82%82%E3%81%A8')
   end
 
+  def test_uri_containing_pluses
+    assert_equal "a+plus", EscapeUtils.unescape_uri("a%2Bplus")
+  end
+
+  def test_escape_unescape_roundtrip
+    (0..127).each do |index|
+      char = index.chr
+      assert_equal char, EscapeUtils.unescape_uri(EscapeUtils.escape_uri(char))
+    end
+  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)
+        EscapeUtils.unescape_uri(escaped)
       end
 
       escaped.force_encoding 'UTF-8'
       begin
-        EscapeUtils.unescape_url(escaped)
+        EscapeUtils.unescape_uri(escaped)
       rescue Encoding::CompatibilityError => e
         assert_nil e, "#{e.class.name} raised, expected not to"
       end
@@ -49,7 +60,7 @@ class UriUnescapeTest < Minitest::Test
 
     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
+      assert_equal Encoding.find('UTF-8'), EscapeUtils.unescape_uri(escaped).encoding
     end
   end
 end

data/test/uri_component/escape_test.rb

@@ -0,0 +1,68 @@
+require File.expand_path("../../helper", __FILE__)
+require 'cgi'
+
+class UriComponentEscapeTest < Minitest::Test
+  def test_basic_url
+    assert_equal "http%3A%2F%2Fwww.homerun.com%2F", EscapeUtils.escape_uri_component("http://www.homerun.com/")
+  end
+
+  def test_cgi_equivalence
+    (0..127).each do |i|
+      c = i.chr
+      # Escaping URI path components should match CGI parameter escaping, except
+      # spaces should be escaped as "%20" instead of "+"
+      assert_equal CGI.escape(c).sub("+", "%20"), EscapeUtils.escape_uri_component(c)
+    end
+  end
+
+  def test_uri_component_containing_tags
+    assert_equal "fo%3Co%3Ebar", EscapeUtils.escape_uri_component("fo<o>bar")
+  end
+
+  def test_uri_component_containing_tags_containing_spaces
+    assert_equal "a%20space", EscapeUtils.escape_uri_component("a space")
+    assert_equal "a%20%20%20sp%20ace%20", EscapeUtils.escape_uri_component("a   sp ace ")
+  end
+
+  def test_uri_component_containing_mixed_characters
+    assert_equal "q1%212%22%27w%245%267%2Fz8%29%3F%5C", EscapeUtils.escape_uri_component("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_uri_component(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_component(matz_name_sep)
+  end
+
+  def test_uri_component_containing_pluses
+    assert_equal "a%2Bplus", EscapeUtils.escape_uri_component("a+plus")
+  end
+
+  def test_uri_component_containing_slashes
+    assert_equal "a%2Fslash", EscapeUtils.escape_uri_component("a/slash")
+  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_component(str)
+      end
+
+      str.force_encoding 'UTF-8'
+      begin
+        EscapeUtils.escape_uri_component(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_component(str).encoding
+    end
+  end
+end

data/test/uri_component/unescape_test.rb

@@ -0,0 +1,71 @@
+require File.expand_path("../../helper", __FILE__)
+
+class UriComponentUnescapeTest < Minitest::Test
+  def test_basic_url
+    assert_equal "http://www.homerun.com/", EscapeUtils.unescape_uri_component("http%3A%2F%2Fwww.homerun.com%2F")
+    assert_equal "http://www.homerun.com/", EscapeUtils.unescape_uri_component("http://www.homerun.com/")
+  end
+
+  def test_doesnt_unescape_an_incomplete_escape
+    assert_equal "%", EscapeUtils.unescape_uri_component("%")
+    assert_equal "http%", EscapeUtils.unescape_uri_component("http%")
+  end
+
+  def test_uri_component_containing_tags
+    assert_equal "fo<o>bar", EscapeUtils.unescape_uri_component("fo%3Co%3Ebar")
+  end
+
+  def test_uri_component_containing_spaces
+    assert_equal "a space", EscapeUtils.unescape_uri_component("a%20space")
+    assert_equal "a   sp ace ", EscapeUtils.unescape_uri_component("a%20%20%20sp%20ace%20")
+  end
+
+  def test_uri_component_containing_pluses
+    assert_equal "a+plus", EscapeUtils.unescape_uri_component("a%2Bplus")
+    assert_equal "a+plus", EscapeUtils.unescape_uri_component("a+plus")
+  end
+
+  def test_escape_unescape_roundtrip
+    (0..127).each do |index|
+      char = index.chr
+      assert_equal char, EscapeUtils.unescape_uri_component(EscapeUtils.escape_uri_component(char))
+    end
+  end
+
+  def test_uri_component_containing_mixed_characters
+    assert_equal "q1!2\"'w$5&7/z8)?\\", EscapeUtils.unescape_uri_component("q1%212%22%27w%245%267%2Fz8%29%3F%5C")
+    assert_equal "q1!2\"'w$5&7/z8)?\\", EscapeUtils.unescape_uri_component("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_uri_component('%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_component('%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_component("fo<o>bar")
+
+      escaped.force_encoding 'ISO-8859-1'
+      assert_raises Encoding::CompatibilityError do
+        EscapeUtils.unescape_uri_component(escaped)
+      end
+
+      escaped.force_encoding 'UTF-8'
+      begin
+        EscapeUtils.unescape_uri_component(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_component("fo<o>bar")
+      assert_equal Encoding.find('UTF-8'), EscapeUtils.unescape_uri_component(escaped).encoding
+    end
+  end
+end

data/test/url/escape_test.rb

@@ -1,7 +1,7 @@
 require File.expand_path("../../helper", __FILE__)
 require 'cgi'
 
-class UriEscapeTest < Minitest::Test
+class UrlEscapeTest < Minitest::Test
   def test_basic_url
     assert_equal "http%3A%2F%2Fwww.homerun.com%2F", EscapeUtils.escape_url("http://www.homerun.com/")
   end
@@ -33,6 +33,14 @@ class UriEscapeTest < Minitest::Test
     assert_equal '%E3%81%BE%E3%81%A4+%E3%82%82%E3%81%A8', EscapeUtils.escape_url(matz_name_sep)
   end
 
+  def test_url_containing_pluses
+    assert_equal "a%2Bplus", EscapeUtils.escape_url("a+plus")
+  end
+
+  def test_url_containing_slashes
+    assert_equal "a%2Fslash", EscapeUtils.escape_url("a/slash")
+  end
+
   if RUBY_VERSION =~ /^1.9/
     def test_input_must_be_utf8_or_ascii
       str = "fo<o>bar"

data/test/url/unescape_test.rb

@@ -1,6 +1,6 @@
 require File.expand_path("../../helper", __FILE__)
 
-class UriUnescapeTest < Minitest::Test
+class UrlUnescapeTest < Minitest::Test
   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/")
@@ -35,9 +35,20 @@ class UriUnescapeTest < Minitest::Test
     assert_equal matz_name_sep, EscapeUtils.unescape_url('%E3%81%BE%E3%81%A4%20%E3%82%82%E3%81%A8')
   end
 
+  def test_url_containing_pluses
+    assert_equal "a+plus", EscapeUtils.unescape_url("a%2Bplus")
+  end
+
+  def test_escape_unescape_roundtrip
+    (0..127).each do |index|
+      char = index.chr
+      assert_equal char, EscapeUtils.unescape_url(EscapeUtils.escape_url(char))
+    end
+  end
+
   if RUBY_VERSION =~ /^1.9/
     def test_input_must_be_valid_utf8_or_ascii
-      escaped = EscapeUtils.escape_uri("fo<o>bar")
+      escaped = EscapeUtils.escape_url("fo<o>bar")
 
       escaped.force_encoding 'ISO-8859-1'
       assert_raises Encoding::CompatibilityError do
@@ -53,7 +64,7 @@ class UriUnescapeTest < Minitest::Test
     end
 
     def test_return_value_is_tagged_as_utf8
-      escaped = EscapeUtils.escape_uri("fo<o>bar")
+      escaped = EscapeUtils.escape_url("fo<o>bar")
       assert_equal Encoding.find('UTF-8'), EscapeUtils.unescape_url(escaped).encoding
     end
   end

metadata

@@ -1,125 +1,138 @@
 --- !ruby/object:Gem::Specification
 name: escape_utils
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Brian Lopez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-29 00:00:00.000000000 Z
+date: 2015-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.5
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: fast_xs
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: url_escape
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description: Quickly perform HTML, URL, URI and Javascript escaping/unescaping
 email: seniorlopez@gmail.com
 executables: []
 extensions:
 - ext/escape_utils/extconf.rb
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
-- CHANGELOG.md
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
-- MIT-LICENSE
+- LICENSE
 - README.md
 - Rakefile
 - benchmark/html_escape.rb
@@ -168,30 +181,33 @@ files:
 - test/query/unescape_test.rb
 - test/uri/escape_test.rb
 - test/uri/unescape_test.rb
+- test/uri_component/escape_test.rb
+- test/uri_component/unescape_test.rb
 - test/url/escape_test.rb
 - test/url/unescape_test.rb
 - test/xml/escape_test.rb
-homepage: http://github.com/brianmario/escape_utils
-licenses: []
+homepage: https://github.com/brianmario/escape_utils
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options:
-- --charset=UTF-8
+- "--charset=UTF-8"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Faster string escaping routines for your web apps
@@ -206,6 +222,8 @@ test_files:
 - test/query/unescape_test.rb
 - test/uri/escape_test.rb
 - test/uri/unescape_test.rb
+- test/uri_component/escape_test.rb
+- test/uri_component/unescape_test.rb
 - test/url/escape_test.rb
 - test/url/unescape_test.rb
 - test/xml/escape_test.rb

data/CHANGELOG.md

@@ -1,75 +0,0 @@
-# Changelog
-
-## 0.3.2 (February 28th, 2013)
-* fix rbx compatibility
-* add EscapeUtils.html_safe_string_class
-* add EscapeUtils.escape_html_as_html_safe
-
-## 0.3.1 (February 26th, 2013)
-* fixed compilation on Windows
-
-## 0.3.0 (February 26th, 2013)
-* add xml escaping support
-* in Ruby 1.9 - escape_utils now requires the input string be UTF-8
-* update upstream houdini to pull in some speed optimizations
-* a couple of other perf tweaks
-* switched to minitest
-
-## 0.2.4 (September 7th, 2011)
-* swap out custom escaping routines for houdini - https://github.com/tanoku/houdini
-* add RSTRING_NOT_MODIFIED define for a Rubinius speedup
-
-## 0.2.3 (March 9th, 2011)
-* change encoding strategy to simply return strings in the encoding the input string was in, not taking into account Encoding.default_internal
-
-## 0.2.2 (February 25th, 2011)
-* minor fix for Rubinius compatibility
-
-## 0.2.1 (February 21st, 2011)
-* fix buffer over read in unescape_url and unescape_uri
-
-## 0.2.0 (February 8th, 2011)
-* fixed a couple of compilation warnings on 1.9.3
-* moved to rspec2
-* remove hard-conversion to utf-8 to preserve the string's original encoding
-* moved to rake-compiler, Bundler
-* pass through incompletely escaped data on unescaping
-* added tilde to escape_{uri,url}specs (It's a difference between CGI.escape and URI.escape)
-* escape_uri and escape_url now match their Ruby counterparts
-** escape_uri is used where URI.escape is, and escape_url is used where CGI.escape is used.
-* performance and memory usage optimizations
-
-## 0.1.9 (October 15th, 2010)
-* add a flag as an optional 2nd parameter to EscapeUtils.escape_html to disable/enable the escaping of the '/' character. Defaults to the new flag EscapeUtils.html_secure
-
-## 0.1.8 (September 29th, 2010)
-* fix URI escaping one last time ;)
-
-## 0.1.7 (September 29th, 2010)
-* fix URI escaping to act according to the RFC
-* add specs for URL escaping
-
-## 0.1.6 (September 6th, 2010)
-* support for URI escaping added (thanks to @joshbuddy)
-* bugfix to ensure we don't drop opening tags during escape_javascript (thanks to @nagybence)
-
-## 0.1.5 (July 13th, 2010)
-* add URL escaping and unescaping
-* major refactor of HTML and Javascript escaping and unescaping logic for a decent speed up
-* HTML escaping now takes html_safe? into account (for Rails/ActiveSupport users) - thanks yury!
-
-## 0.1.4 (June 9th, 2010)
-* ensure strings are passed in from monkey-patches
-
-## 0.1.3 (June 9th, 2010)
-* cleaned some code up, removing duplication
-* moved to a more flexible character encoding scheme using Encoding.defaut_internal for 1.9 users
-
-## 0.1.2 (June 8th, 2010)
-* forgot to add the ActionView monkey patch for JS escaping ;)
-
-## 0.1.1 (June 8th, 2010)
-* added javascript escaping
-
-## 0.1.0 (June 8th, 2010)
-* initial release

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2010-2013 Brian Lopez - http://github.com/brianmario
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.