escape_utils 0.3.2 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e59c356d88fb33a0a31f0668c2e476d45bcced9
+  data.tar.gz: a8df94fbbc6f8aed27e5c59d53678f944ef782da
+SHA512:
+  metadata.gz: 980b6eef8962eac5f49e61154e1a26018c4e6a1be57a3d3c7aaa5acab8dac52076750edab093d3b0ed8ea47a00d7d222520251ed5f9a8bf6885d2e26e39d034e
+  data.tar.gz: 09ccd6442abd623df06036d418833af4d3bd1b63ee74f582f08f0537dccc7f29405ed934b7d2c0edbdab0d1c956a44946b2e8709f62ba1a214f28f814bdd1a28

data/.travis.yml

@@ -1,13 +1,8 @@
 language: ruby
 rvm:
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
   - 2.0.0
-  - ree
-  - rbx-18mode
   - rbx-19mode
 matrix:
   allow_failures:
-    - rvm: rbx-18mode
     - rvm: rbx-19mode

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source 'https://rubygems.org'
 
-gemspec
+gemspec

data/README.md

@@ -10,6 +10,8 @@ It supports HTML, URL, URI and Javascript escaping/unescaping.
 
 ## Installing
 
+Compatible with Ruby 1.9.3+
+
 ``` sh
 gem install escape_utils
 ```
@@ -18,20 +20,11 @@ gem install escape_utils
 
 escape_utils assumes all input is encoded as valid UTF-8. If you are dealing with other encodings do your best to transcode the string into a UTF-8 byte stream before handing it to escape_utils.
 
-On Ruby 1.9 this is as easy as:
 
 ``` ruby
 utf8_string = non_utf8_string.encode('UTF-8')
 ```
 
-If you're on Ruby 1.8 you can use [charlock_holmes](https://github.com/brianmario/charlock_holmes) to transcode like so:
-
-``` ruby
-# NOTE: we're assuming you know the encoding of `non_utf8_string` here.
-# if you don't, you can use the detection API of charlock_holmes
-utf8_string = CharlockHolmes::Converter.convert(non_utf8_string, other_encoding, 'UTF-8')
-```
-
 ## Usage
 
 ### HTML

data/escape_utils.gemspec

@@ -14,9 +14,11 @@ Gem::Specification.new do |s|
   s.summary = %q{Faster string escaping routines for your web apps}
   s.test_files = `git ls-files test`.split("\n")
 
+  s.required_ruby_version = "> 1.9.3"
+
   # tests
   s.add_development_dependency 'rake-compiler', ">= 0.7.5"
-  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'minitest', ">= 5.0.0"
   # benchmarks
   s.add_development_dependency 'rack'
   s.add_development_dependency 'haml'

data/ext/escape_utils/escape_utils.c

@@ -4,10 +4,9 @@
 #define RSTRING_NOT_MODIFIED
 
 #include <ruby.h>
+#include <ruby/encoding.h>
 #include "houdini.h"
 
-#ifdef HAVE_RUBY_ENCODING_H
-#include <ruby/encoding.h>
 static VALUE rb_eEncodingCompatibilityError;
 
 static VALUE eu_new_str(const char *str, size_t len)
@@ -32,14 +31,6 @@ static void check_utf8_encoding(VALUE str)
 			"Input must be UTF-8 or US-ASCII, %s given", rb_enc_name(enc));
 	}
 }
-#else
-static VALUE eu_new_str(const char *str, size_t len)
-{
-	return rb_str_new(str, len);
-}
-
-static void check_utf8_encoding(VALUE str) {}
-#endif
 
 typedef int (*houdini_cb)(gh_buf *, const uint8_t *, size_t);
 
@@ -62,6 +53,7 @@ static VALUE rb_eu_set_html_secure(VALUE self, VALUE val)
 * html_safe_string_class instance variable
 */
 static VALUE rb_html_safe_string_class;
+static VALUE rb_html_safe_string_template_object;
 
 static VALUE rb_eu_set_html_safe_string_class(VALUE self, VALUE val)
 {
@@ -71,6 +63,8 @@ static VALUE rb_eu_set_html_safe_string_class(VALUE self, VALUE val)
 		rb_raise(rb_eArgError, "%s must be a descendent of String", rb_class2name(val));
 
 	rb_html_safe_string_class = val;
+	rb_html_safe_string_template_object = rb_class_new_instance(0, NULL, rb_html_safe_string_class);
+	OBJ_FREEZE(rb_html_safe_string_template_object);
 	rb_ivar_set(self, rb_intern("@html_safe_string_class"), val);
 	return val;
 }
@@ -115,19 +109,10 @@ static VALUE rb_eu_escape_html_as_html_safe(VALUE self, VALUE str)
 		result = eu_new_str(buf.ptr, buf.size);
 		gh_buf_free(&buf);
 	} else {
-#ifdef RBASIC
-		result = rb_str_dup(str);
-#else
-		result = str;
-#endif
+		result = rb_str_new_with_class(rb_html_safe_string_template_object,
+			RSTRING_PTR(str), RSTRING_LEN(str));
 	}
 
-#ifdef RBASIC
-	RBASIC(result)->klass = rb_html_safe_string_class;
-#else
-	result = rb_funcall(rb_html_safe_string_class, ID_new, 1, result);
-#endif
-
 	rb_ivar_set(result, ID_at_html_safe, Qtrue);
 
 	return result;
@@ -217,16 +202,17 @@ static VALUE rb_eu_unescape_uri(VALUE self, VALUE str)
 /**
  * Ruby Extension initializer
  */
+__attribute__((visibility("default")))
 void Init_escape_utils()
 {
-#ifdef HAVE_RUBY_ENCODING_H
 	rb_eEncodingCompatibilityError = rb_const_get(rb_cEncoding, rb_intern("CompatibilityError"));
-#endif
 
 	ID_new = rb_intern("new");
 	ID_at_html_safe = rb_intern("@html_safe");
-	rb_mEscapeUtils = rb_define_module("EscapeUtils");
+	rb_global_variable(&rb_html_safe_string_class);
+	rb_global_variable(&rb_html_safe_string_template_object);
 
+	rb_mEscapeUtils = rb_define_module("EscapeUtils");
 	rb_define_method(rb_mEscapeUtils, "escape_html_as_html_safe", rb_eu_escape_html_as_html_safe, 1);
 	rb_define_method(rb_mEscapeUtils, "escape_html", rb_eu_escape_html, -1);
 	rb_define_method(rb_mEscapeUtils, "unescape_html", rb_eu_unescape_html, 1);

data/ext/escape_utils/extconf.rb

@@ -1,6 +1,6 @@
 require 'mkmf'
 
-$CFLAGS << ' -Wall -funroll-loops'
+$CFLAGS << ' -Wall -funroll-loops -fvisibility=hidden'
 $CFLAGS << ' -Wextra -O0 -ggdb3' if ENV['DEBUG']
 
 create_makefile("escape_utils/escape_utils")

data/lib/escape_utils/version.rb

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

data/script/bootstrap

@@ -0,0 +1,2 @@
+bundle install --path vendor/gems --binstubs
+bin/rake clobber clean compile

data/test/html/escape_test.rb

@@ -3,7 +3,7 @@ require File.expand_path("../../helper", __FILE__)
 class MyCustomHtmlSafeString < String
 end
 
-class HtmlEscapeTest < MiniTest::Unit::TestCase
+class HtmlEscapeTest < Minitest::Test
   def test_escape_basic_html_with_secure
     assert_equal "&lt;some_tag&#47;&gt;", EscapeUtils.escape_html("<some_tag/>")
 

data/test/html/unescape_test.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 require File.expand_path("../../helper", __FILE__)
 
-class HtmlUnescapeTest < MiniTest::Unit::TestCase
+class HtmlUnescapeTest < Minitest::Test
   def test_basic_html
     assert_equal "<some_tag/>", EscapeUtils.unescape_html("&lt;some_tag&#47;&gt;")
   end
@@ -45,4 +45,4 @@ class HtmlUnescapeTest < MiniTest::Unit::TestCase
       assert_equal Encoding.find('UTF-8'), EscapeUtils.unescape_html(escaped).encoding
     end
   end
-end
+end

data/test/html_safety_test.rb

@@ -26,7 +26,7 @@ class String
   end
 end
 
-class HtmlEscapeTest < MiniTest::Unit::TestCase
+class HtmlEscapeTest < Minitest::Test
   include EscapeUtils::HtmlSafety
 
   def test_marks_escaped_strings_safe

data/test/javascript/escape_test.rb

@@ -1,6 +1,6 @@
 require File.expand_path("../../helper", __FILE__)
 
-class JavascriptEscapeTest < MiniTest::Unit::TestCase
+class JavascriptEscapeTest < Minitest::Test
   def test_returns_empty_string_if_nil_passed
     assert_equal "", EscapeUtils.escape_javascript(nil)
   end
@@ -39,4 +39,4 @@ class JavascriptEscapeTest < MiniTest::Unit::TestCase
       assert_equal Encoding.find('UTF-8'), EscapeUtils.escape_javascript(str).encoding
     end
   end
-end
+end

data/test/javascript/unescape_test.rb

@@ -1,6 +1,6 @@
 require File.expand_path("../../helper", __FILE__)
 
-class JavascriptUnescapeTest < MiniTest::Unit::TestCase
+class JavascriptUnescapeTest < Minitest::Test
   def test_returns_empty_string_if_nil_passed
     assert_equal "", EscapeUtils.unescape_javascript(nil)
   end
@@ -43,4 +43,4 @@ class JavascriptUnescapeTest < MiniTest::Unit::TestCase
       assert_equal Encoding.find('UTF-8'), EscapeUtils.unescape_javascript(escaped).encoding
     end
   end
-end
+end

data/test/query/escape_test.rb

@@ -1,6 +1,6 @@
 require File.expand_path("../../helper", __FILE__)
 
-class QueryEscapeTest < MiniTest::Unit::TestCase
+class QueryEscapeTest < Minitest::Test
   def test_basic_url
     assert_equal "http%3A%2F%2Fwww.homerun.com%2F", EscapeUtils.escape_url("http://www.homerun.com/")
   end
@@ -47,4 +47,4 @@ class QueryEscapeTest < MiniTest::Unit::TestCase
       assert_equal Encoding.find('UTF-8'), EscapeUtils.escape_url(str).encoding
     end
   end
-end
+end

data/test/query/unescape_test.rb

@@ -1,6 +1,6 @@
 require File.expand_path("../../helper", __FILE__)
 
-class QueryUnescapeTest < MiniTest::Unit::TestCase
+class QueryUnescapeTest < Minitest::Test
   def test_basic_url
     assert_equal "http://www.homerun.com/", EscapeUtils.unescape_url("http%3A%2F%2Fwww.homerun.com%2F")
   end
@@ -49,4 +49,4 @@ class QueryUnescapeTest < MiniTest::Unit::TestCase
       assert_equal Encoding.find('UTF-8'), EscapeUtils.unescape_url(escaped).encoding
     end
   end
-end
+end

data/test/uri/escape_test.rb

@@ -1,7 +1,7 @@
 require File.expand_path("../../helper", __FILE__)
 require 'uri'
 
-class UriEscapeTest < MiniTest::Unit::TestCase
+class UriEscapeTest < Minitest::Test
   def test_uri_stdlib_compatibility
     (0..127).each do |i|
       c = i.chr
@@ -47,4 +47,4 @@ class UriEscapeTest < MiniTest::Unit::TestCase
       assert_equal Encoding.find('UTF-8'), EscapeUtils.escape_uri(str).encoding
     end
   end
-end
+end

data/test/uri/unescape_test.rb

@@ -1,6 +1,6 @@
 require File.expand_path("../../helper", __FILE__)
 
-class UriUnescapeTest < MiniTest::Unit::TestCase
+class UriUnescapeTest < Minitest::Test
   def test_doesnt_unescape_an_incomplete_escape
     assert_equal "%", EscapeUtils.unescape_uri("%")
     assert_equal "http%", EscapeUtils.unescape_uri("http%")
@@ -52,4 +52,4 @@ class UriUnescapeTest < MiniTest::Unit::TestCase
       assert_equal Encoding.find('UTF-8'), EscapeUtils.unescape_url(escaped).encoding
     end
   end
-end
+end

data/test/url/escape_test.rb

@@ -1,7 +1,7 @@
 require File.expand_path("../../helper", __FILE__)
 require 'cgi'
 
-class UriEscapeTest < MiniTest::Unit::TestCase
+class UriEscapeTest < Minitest::Test
   def test_basic_url
     assert_equal "http%3A%2F%2Fwww.homerun.com%2F", EscapeUtils.escape_url("http://www.homerun.com/")
   end
@@ -55,4 +55,4 @@ class UriEscapeTest < MiniTest::Unit::TestCase
       assert_equal Encoding.find('UTF-8'), EscapeUtils.escape_url(str).encoding
     end
   end
-end
+end

data/test/url/unescape_test.rb

@@ -1,6 +1,6 @@
 require File.expand_path("../../helper", __FILE__)
 
-class UriUnescapeTest < MiniTest::Unit::TestCase
+class UriUnescapeTest < 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/")
@@ -57,4 +57,4 @@ class UriUnescapeTest < MiniTest::Unit::TestCase
       assert_equal Encoding.find('UTF-8'), EscapeUtils.unescape_url(escaped).encoding
     end
   end
-end
+end

data/test/xml/escape_test.rb

@@ -1,6 +1,6 @@
 require File.expand_path("../../helper", __FILE__)
 
-class XmlEscapeTest < MiniTest::Unit::TestCase
+class XmlEscapeTest < Minitest::Test
   def test_basic_xml
     assert_equal "&lt;some_tag/&gt;", EscapeUtils.escape_xml("<some_tag/>")
   end

metadata

@@ -1,126 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: escape_utils
 version: !ruby/object:Gem::Version
-  version: 0.3.2
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Brian Lopez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-28 00:00:00.000000000 Z
+date: 2013-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.7.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.7.5
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: fast_xs
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: url_escape
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -172,6 +157,7 @@ files:
 - lib/escape_utils/url/uri.rb
 - lib/escape_utils/version.rb
 - lib/escape_utils/xml/builder.rb
+- script/bootstrap
 - test/helper.rb
 - test/html/escape_test.rb
 - test/html/unescape_test.rb
@@ -187,28 +173,27 @@ files:
 - test/xml/escape_test.rb
 homepage: http://github.com/brianmario/escape_utils
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --charset=UTF-8
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Faster string escaping routines for your web apps
 test_files:
 - test/helper.rb