initial license, changelog, readme and version

Author: brianmario

CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## 0.1.0 (June 8th, 2010)
+* initial release

MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 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.

README.rdoc

@@ -0,0 +1,58 @@
+= escape_utils
+
+Being as though we're all html escaping everything these days, why not make it faster?
+
+At the moment escape_utils supports escaping and unescaping of HTML, but I wanna add URL encoding soon
+
+It has monkey-patches for Rack::Utils, CGI, ERB::Util and Haml
+
+== Installing
+
+  gem install escape_utils
+
+== Usage
+
+=== Escaping HTML
+
+  html = `curl -s http://maps.google.com`
+  escaped_html = EscapeUtils.escape_html(html)
+
+=== Unescaping HTML
+
+  html = `curl -s http://maps.google.com`
+  escaped_html = EscapeUtils.escape_html(html)
+  html = EscapeUtils.unescape_html(escaped_html)
+
+=== Monkey Patches
+
+  require 'escape_utils/rack' # to patch Rack::Utils
+  require 'escape_utils/erb' # to patch ERB::Util
+  require 'escape_utils/cgi' # to patch CGI
+  require 'escape_utils/haml' # to patch Haml::Helpers
+
+== Benchmarks
+
+In my testing, escaping is around 10-20x faster than the pure ruby implementations in wide use today.
+While unescaping is around 24x faster than CGI.unescapeHTML - also pure ruby.
+
+This output is from my laptop using the benchmark scripts in the benchmarks folder.
+
+=== Escaping
+
+ Rack::Utils.escape_html
+  0.560000   0.040000   0.600000 (  0.589475)
+ ERB::Util.html_escape
+  0.450000   0.040000   0.490000 (  0.492893)
+ CGI.escapeHTML
+  0.460000   0.030000   0.490000 (  0.490171)
+ Haml::Helpers.html_escape
+  0.430000   0.010000   0.440000 (  0.444694)
+ EscapeUtils.escape_html
+  0.050000   0.010000   0.060000 (  0.054799)
+
+=== Unescaping
+
+ CGI.unescapeHTML
+  1.140000   0.010000   1.150000 (  1.148470)
+ EscapeUtils.unescape_html
+  0.040000   0.000000   0.040000 (  0.046166)

escape_utils.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{escape_utils}
-  s.version = "0.0.1"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Lopez"]
@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
      "VERSION",
      "benchmark/escape.rb",
      "benchmark/unescape.rb",
+     "escape_utils.gemspec",
      "ext/escape_utils.c",
      "ext/extconf.rb",
      "lib/escape_utils.rb",