RubyGems - walters - Versions diffs - 0.1.0-java - Mend

walters 0.1.0-java

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (22) hide show

data/LICENSE +14 -0
data/LICENSE-EscapeUtils.txt +20 -0
data/LICENSE-houdini.txt +14 -0
data/README.md +52 -0
data/Rakefile +71 -0
data/benchmark/html_clean_escape.rb +81 -0
data/benchmark/html_escape.rb +78 -0
data/lib/walters.rb +2 -0
data/lib/walters/html/cgi.rb +12 -0
data/lib/walters/html/erb.rb +13 -0
data/lib/walters/html/haml.rb +10 -0
data/lib/walters/html/html_safety.rb +19 -0
data/lib/walters/html/rack.rb +11 -0
data/lib/walters/javascript/action_view.rb +11 -0
data/lib/walters/version.rb +3 -0
data/lib/walters/walters.rb +23 -0
data/lib/walters/walters_ext.jar +0 -0
data/lib/walters/walters_xni.rb +109 -0
data/spec/spec_helper.rb +8 -0
data/spec/walters/html_escape_spec.rb +58 -0
data/spec/walters/javascript_escape_spec.rb +49 -0
metadata +66 -0

data/LICENSE ADDED Viewed

@@ -0,0 +1,14 @@
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+      http://www.apache.org/licenses/LICENSE-2.0
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+  This software also contains code licensed under the GNU General Public License version 2 with a linking exception.

data/LICENSE-EscapeUtils.txt ADDED Viewed

@@ -0,0 +1,20 @@
+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.

data/LICENSE-houdini.txt ADDED Viewed

@@ -0,0 +1,14 @@
+Copyright (C) 2012 Vicent Martí
+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/README.md ADDED Viewed

@@ -0,0 +1,52 @@
+walters [![Build Status](https://travis-ci.org/wmeissner/walters.png)](https://travis-ci.org/wmeissner/walters)
+======
+[Walters](https://github.com/wmeissner/walters) is a fast HTML (and href, uri, xml, javascript) escaping library for JRuby.
+It is optimised for the non-escaping case - i.e. where the input string contains no characters requiring escaping.
+### Example usage
+    jruby-1.7.4.dev :001 > require 'walters'
+     => true
+    jruby-1.7.4.dev :002 > Walters.escape_html('<html>')
+     => "&lt;html&gt;"
+The same extension can also be used from the legacy CRuby VM for compatibility.
+    2.0.0p0 :001 > require 'walters'
+     => true
+    2.0.0p0 :002 > Walters.escape_html('<html>')
+     => "&lt;html&gt;"
+### Benchmarks
+Escaping 1000 bytes of text requiring escaping 1000000 times under jruby-1.7.4:
+                                user     system      total        real
+    Rack::Utils.escape_html    89.980000   0.230000  90.210000 ( 90.272000)
+    Haml::Helpers.html_escape  50.420000   0.170000  50.590000 ( 51.147000)
+    ERB::Util.html_escape      44.650000   0.130000  44.780000 ( 45.518000)
+    CGI.escapeHTML             36.230000   0.090000  36.320000 ( 36.358000)
+    String#gsub                35.490000   0.090000  35.580000 ( 35.587000)
+    Walters.escape_html        10.090000   0.030000  10.120000 ( 10.126000)
+Escaping 1000 bytes of html-free text 1000000 times under jruby-1.7.4:
+                               user     system      total        real
+    Rack::Utils.escape_html     3.530000   0.010000   3.540000 (  3.601000)
+    Haml::Helpers.html_escape   4.140000   0.010000   4.150000 (  4.196000)
+    ERB::Util.html_escape      11.710000   0.030000  11.740000 ( 11.876000)
+    CGI.escapeHTML              3.440000   0.010000   3.450000 (  3.548000)
+    String#gsub                 3.470000   0.000000   3.470000 (  3.531000)
+    Walters.escape_html         0.660000   0.010000   0.670000 (  0.663000)
+### Punching ducks
+There are monkey-patching shims supplied that replace common html escaping functions with calls to the Walters escape_html function.
+e.g. to patch Rack::Utils.escape_html to use Walters.escape_html:
+    require 'walters/html/rack'
+### Credits
+The escaping routines are based on C code from the [Houdini](https://github.com/vmg/houdini) project, and the specs, benchmarks and monkey patches come from the [escape_utils](https://github.com/brianmario/escape_utils) project

data/Rakefile ADDED Viewed

@@ -0,0 +1,71 @@
+require 'rake/clean'
+require 'rubygems/package_task'
+require 'rubygems/tasks'
+def gem_spec
+  @gem_spec ||= Gem::Specification.load('walters.gemspec')
+end
+TEST_DEPS = []
+if defined?(JRUBY_VERSION)
+  require 'ant'
+  jar_file = 'lib/walters/walters_ext.jar'
+  CLEAN.include jar_file
+  TEST_DEPS << jar_file
+  gem_spec.files << jar_file
+  directory 'pkg/classes'
+  CLEAN.include 'pkg/classes'
+  desc 'Compile the JRuby extension'
+  task :compile => FileList['pkg/classes', 'jruby-ext/src/**/*.java'] do |t|
+    ant.javac :srcdir => 'jruby-ext/src', :destdir => t.prerequisites.first,
+              :source => '1.6', :target => '1.6', :debug => true, :includeantruntime => false,
+              :classpath => '${java.class.path}:${sun.boot.class.path}'
+  end
+  desc 'Build the jar'
+  file jar_file => :compile do |t|
+    ant.jar :basedir => 'pkg/classes', :destfile => t.name, :includes => '**/*.class'
+  end
+  task :jar => jar_file
+end
+Gem::Tasks.new do |t|
+  t.scm.tag.format = '%s'
+end
+task :specs do
+  sh %{#{Gem.ruby} -w -Ilib -S rspec spec}
+end
+namespace 'java' do
+  java_gem_spec = Gem::Specification.new do |s|
+    s.name = gem_spec.name
+    s.version = gem_spec.version
+    s.author = gem_spec.author
+    s.email = gem_spec.email
+    s.homepage = gem_spec.homepage
+    s.summary = gem_spec.summary
+    s.description = gem_spec.description
+    s.files = %w(LICENSE LICENSE-EscapeUtils.txt LICENSE-houdini.txt README.md Rakefile)
+    s.files << Dir['{lib,spec,benchmark}/**/*.rb']
+    s.files << 'lib/walters/walters_ext.jar'
+    s.has_rdoc = false
+    s.license = gem_spec.license
+    s.platform = 'java'
+  end
+  Gem::PackageTask.new(java_gem_spec) do |pkg|
+    pkg.need_zip = true
+    pkg.need_tar = true
+    pkg.package_dir = 'pkg'
+  end
+  task :gem => 'lib/walters/walters_ext.jar'
+end
+task 'gem:java' => 'java:gem'

data/benchmark/html_clean_escape.rb ADDED Viewed

@@ -0,0 +1,81 @@
+# encoding: utf-8
+# This file contains code based on the EscapeUtils project.  See the file LICENSE-EscapeUtils.txt for details.
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/..')
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+require 'rubygems'
+require 'benchmark'
+require 'rack'
+require 'erb'
+require 'cgi'
+require 'haml'
+require 'walters'
+unless defined?(JRUBY_VERSION)
+  require 'fast_xs'
+  require 'escape_utils'
+end
+module HamlBench
+  extend Haml::Helpers
+end
+times = 1000_000
+url = "http://en.wikipedia.org/wiki/Line_of_succession_to_the_British_throne"
+html = ((('a'..'z').to_a.join('') + ('A'..'Z').to_a.join('')) * 100)[0...1000]
+html = html.force_encoding('utf-8') if html.respond_to?(:force_encoding)
+puts "Escaping #{html.bytesize} bytes of html #{times} times, from #{url}"
+Benchmark.bmbm do |x|
+  x.report "Rack::Utils.escape_html" do
+    times.times do
+      Rack::Utils.escape_html(html)
+    end
+  end
+  x.report "Haml::Helpers.html_escape" do
+    times.times do
+      HamlBench.html_escape(html)
+    end
+  end
+  x.report "ERB::Util.html_escape" do
+    times.times do
+      ERB::Util.html_escape(html)
+    end
+  end
+  x.report "CGI.escapeHTML" do
+    times.times do
+      CGI.escapeHTML(html)
+    end
+  end
+  x.report "String#gsub" do
+    html_escape = { '&' => '&amp;',  '>' => '&gt;',   '<' => '&lt;', '"' => '&quot;', "'" => '&#39;' }
+    times.times do
+      html.gsub(/[&"'><]/, html_escape)
+    end
+  end
+  x.report "Walters.escape_html" do
+    times.times do
+      Walters.escape_html(html)
+    end
+  end
+  unless defined?(JRUBY_VERSION)
+    #x.report "fast_xs_extra#fast_xs_html" do
+    #  times.times do
+    #    html.fast_xs_html
+    #  end
+    #end
+    #
+    x.report "EscapeUtils.escape_html" do
+      times.times do
+        EscapeUtils.escape_html(html)
+      end
+    end
+  end
+end

data/benchmark/html_escape.rb ADDED Viewed

@@ -0,0 +1,78 @@
+# encoding: utf-8
+# This file contains code based on the EscapeUtils project.  See the file LICENSE-EscapeUtils.txt for details.
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/..')
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+require 'rubygems'
+require 'benchmark'
+require 'rack'
+require 'erb'
+require 'cgi'
+require 'haml'
+require 'walters'
+unless defined?(JRUBY_VERSION)
+  require 'fast_xs'
+  require 'escape_utils'
+end
+module HamlBench
+  extend Haml::Helpers
+end
+times = 1000_000
+url = "http://en.wikipedia.org/wiki/Line_of_succession_to_the_British_throne"
+html = `curl -s #{url}`[0...1000]
+html = html.force_encoding('utf-8') if html.respond_to?(:force_encoding)
+# Warm up java code
+10_000_000.times { Walters.escape_html('fubar foo<bar>\'/&""') }
+puts "Escaping #{html.bytesize} bytes of html #{times} times, from #{url}"
+Benchmark.bmbm do |x|
+  x.report "Rack::Utils.escape_html" do
+    times.times do
+      Rack::Utils.escape_html(html)
+    end
+  end
+  x.report "Haml::Helpers.html_escape" do
+    times.times do
+      HamlBench.html_escape(html)
+    end
+  end
+  x.report "ERB::Util.html_escape" do
+    times.times do
+      ERB::Util.html_escape(html)
+    end
+  end
+  x.report "CGI.escapeHTML" do
+    times.times do
+      CGI.escapeHTML(html)
+    end
+  end
+  x.report "String#gsub" do
+    html_escape = { '&' => '&amp;',  '>' => '&gt;',   '<' => '&lt;', '"' => '&quot;', "'" => '&#39;' }
+    times.times do
+      html.gsub(/[&"'><]/, html_escape)
+    end
+  end
+  x.report "Walters.escape_html" do
+    times.times do
+      Walters.escape_html(html)
+    end
+  end
+  unless defined?(JRUBY_VERSION)
+    x.report "EscapeUtils.escape_html" do
+      times.times do
+        EscapeUtils.escape_html(html)
+      end
+    end
+  end
+end

data/lib/walters.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ require_relative 'walters/walters'
2	+ require_relative 'walters/version'

data/lib/walters/html/cgi.rb ADDED Viewed

@@ -0,0 +1,12 @@
+# This file contains code based on the EscapeUtils project.  See the file LICENSE-EscapeUtils.txt for details.
+require_relative 'html_safety'
+module CGI
+  extend ::Walters::HtmlSafety
+  extend ::Walters::HtmlUnescape
+  class << self
+    alias escapeHTML walters_escape_html
+    alias unescapeHTML walters_unescape_html
+  end
+end

data/lib/walters/html/erb.rb ADDED Viewed

@@ -0,0 +1,13 @@
+# This file contains code based on the EscapeUtils project.  See the file LICENSE-EscapeUtils.txt for details.
+require_relative 'html_safety'
+class ERB
+  module Util
+    include ::Walters::HtmlSafety
+    alias html_escape walters_escape_html
+    alias h html_escape
+    module_function :h
+    module_function :html_escape
+  end
+end

data/lib/walters/html/haml.rb ADDED Viewed

@@ -0,0 +1,10 @@
+# This file contains code based on the EscapeUtils project.  See the file LICENSE-EscapeUtils.txt for details.
+require_relative 'html_safety'
+module Haml
+  module Helpers
+    include ::Walters::HtmlSafety
+    alias html_escape walters_escape_html
+  end
+end

data/lib/walters/html/html_safety.rb ADDED Viewed

@@ -0,0 +1,19 @@
+# This file contains code based on the EscapeUtils project.  See the file LICENSE-EscapeUtils.txt for details.
+require 'walters'
+module Walters
+  module HtmlSafety
+    if ''.respond_to? :html_safe?
+      def walters_escape_html(s)
+        if s.html_safe?
+          s.to_s.html_safe
+        else
+          Walters.escape_html(s).html_safe
+        end
+      end
+    else
+      include ::Walters::HtmlEscape
+    end
+  end
+end

data/lib/walters/html/rack.rb ADDED Viewed

@@ -0,0 +1,11 @@
+# This file contains code based on the EscapeUtils project.  See the file LICENSE-EscapeUtils.txt for details.
+require_relative 'html_safety'
+module Rack
+  module Utils
+    include ::Walters::HtmlSafety
+    alias escape_html walters_escape_html
+    module_function :escape_html
+  end
+end

data/lib/walters/javascript/action_view.rb ADDED Viewed

@@ -0,0 +1,11 @@
+# This file contains code based on the EscapeUtils project.  See the file LICENSE-EscapeUtils.txt for details.
+require 'walters'
+module ActionView
+  module Helpers
+    module JavaScriptHelper
+      include ::Walters::JavaScriptEscape
+      alias escape_javascript walters_escape_javascript
+    end
+  end
+end

data/lib/walters/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module Walters
+  VERSION = '0.1.0'
+end

data/lib/walters/walters.rb ADDED Viewed

@@ -0,0 +1,23 @@
+#
+# Copyright (C) 2013 Wayne Meissner
+#
+# This file is part of the Walters project (http://github.com/wmeissner/walters).
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+if defined?(JRUBY_VERSION)
+  require 'walters/walters_ext'
+else
+  require_relative 'walters_xni'
+end

data/lib/walters/walters_ext.jar ADDED Viewed

Binary file

data/lib/walters/walters_xni.rb ADDED Viewed

@@ -0,0 +1,109 @@
+#
+# Copyright (C) 2013 Wayne Meissner
+#
+# This file is part of the Walters project (http://github.com/wmeissner/walters).
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+require 'xni'
+module Walters
+  extend XNI::Extension
+  extension 'walters'
+  class Buffer < XNI::DataObject
+    custom_finalizer
+    native :initialize, [ :uint ], :void
+    native :cstring, [], :cstring
+    native :escape_html, [ :cstring, :uint], :bool
+    native :escape_html0, [ :cstring, :uint, :bool ], :bool
+    native :unescape_html, [ :cstring, :uint], :bool
+    native :escape_xml, [ :cstring, :uint], :bool
+    native :escape_uri, [ :cstring, :uint], :bool
+    native :escape_url, [ :cstring, :uint], :bool
+    native :escape_href, [ :cstring, :uint], :bool
+    native :unescape_uri, [ :cstring, :uint], :bool
+    native :unescape_url, [ :cstring, :uint], :bool
+    native :escape_js, [ :cstring, :uint], :bool
+    native :unescape_js, [ :cstring, :uint], :bool
+  end
+  native :free_cstring, [ :pointer ], :void
+  native :read_cstring, [ :pointer ], :cstring
+  native :_escape_html, [ :cstring, :uint, :bool], :pointer
+  native :_unescape_html, [ :cstring, :uint], :pointer
+  native :_escape_xml, [ :cstring, :uint], :pointer
+  native :_escape_uri, [ :cstring, :uint], :pointer
+  native :_escape_url, [ :cstring, :uint], :pointer
+  native :_escape_href, [ :cstring, :uint], :pointer
+  native :_unescape_uri, [ :cstring, :uint], :pointer
+  native :_unescape_url, [ :cstring, :uint], :pointer
+  native :_escape_js, [ :cstring, :uint], :pointer
+  native :_unescape_js, [ :cstring, :uint], :pointer
+  class << self
+    private
+    def cstring(ptr, str)
+      if ptr
+        begin
+          str = read_cstring(ptr)
+        ensure
+          free_cstring(ptr)
+        end
+      end
+      str
+    end
+  end
+  def self.escape_html(src, secure = true)
+    cstring _escape_html(src, src.length, secure), src
+  end
+  def self.unescape_html(src)
+    cstring _unescape_html(src, src.length), src
+  end
+  def self.escape_xml(src)
+    cstring _escape_xml(src, src.length), src
+  end
+  def self.escape_uri(src)
+    cstring _escape_uri(src, src.length), src
+  end
+  def self.escape_url(src)
+    cstring _escape_url(src, src.length), src
+  end
+  def self.escape_href(src)
+    cstring _escape_href(src, src.length), src
+  end
+  def self.unescape_uri(src)
+    cstring _unescape_uri(src, src.length), src
+  end
+  def self.unescape_url(src)
+    cstring _unescape_url(src, src.length), src
+  end
+  def self.escape_js(src)
+    cstring _escape_js(src, src.length), src
+  end
+  def self.unescape_js(src)
+    cstring _unescape_js(src, src.length), src
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,8 @@
+# encoding: UTF-8
+if defined?(JRUBY_VERSION)
+  system "cd #{File.expand_path('../..', __FILE__)} && ruby -S rake jar"
+else
+  system "cd #{File.expand_path('../../xni-ext', __FILE__)} && ruby -S rake"
+end
+require 'walters'

data/spec/walters/html_escape_spec.rb ADDED Viewed

@@ -0,0 +1,58 @@
+# encoding: UTF-8
+#
+# Copyright (C) 2013 Wayne Meissner
+#
+# This file is part of the Walters project (http://github.com/wmeissner/walters).
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# This file contains code based on the EscapeUtils project.  See the file LICENSE-EscapeUtils.txt for details.
+#
+require File.expand_path('../../spec_helper.rb', __FILE__)
+describe 'html escape' do
+  it 'double quotes' do
+    Walters.escape_html("<some_tag some_attr=\"some value\"/>").should == '&lt;some_tag some_attr=&quot;some value&quot;&#47;&gt;'
+  end
+  it 'single quotes' do
+    Walters.escape_html("<some_tag some_attr='some value'/>").should == '&lt;some_tag some_attr=&#39;some value&#39;&#47;&gt;'
+  end
+  it 'ampersand' do
+    Walters.escape_html('<b>Bourbon & Branch</b>').should == '&lt;b&gt;Bourbon &amp; Branch&lt;&#47;b&gt;'
+  end
+  it 'original returned if no escaping required' do
+    str = 'foobar'
+    Walters.escape_html(str).should equal str
+  end
+  it 'all tags escaped' do
+    Walters.escape_html('&<>"\'/').should == '&amp;&lt;&gt;&quot;&#39;&#47;'
+  end
+  it 'plain text followed by tag' do
+    Walters.escape_html('foobar<1>').should == 'foobar&lt;1&gt;'
+  end
+  it 'non-utf8 input' do
+    lambda { Walters.escape_html('<b>Bourbon & Branch</b>'.encode('ISO-8859-1')) }.should raise_error Encoding::CompatibilityError
+  end
+  it 'returned value has same encoding as original' do
+    str = '<b>Bourbon & Branch</b>'.encode('utf-8')
+    Walters.escape_html(str).encoding.should == str.encoding
+  end
+end

data/spec/walters/javascript_escape_spec.rb ADDED Viewed

@@ -0,0 +1,49 @@
+# encoding: UTF-8
+#
+# Copyright (C) 2013 Wayne Meissner
+#
+# This file is part of the Walters project (http://github.com/wmeissner/walters).
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# This file contains code based on the EscapeUtils project.  See the file LICENSE-EscapeUtils.txt for details.
+#
+describe 'javascript' do
+  it 'quotes and newlines' do
+    Walters.escape_javascript(%(This "thing" is really\n netos\r\n\n')).should == %(This \\"thing\\" is really\\n netos\\n\\n\\')
+  end
+  it 'backslash' do
+    Walters.escape_javascript(%(backslash\\test)).should == %(backslash\\\\test)
+  end
+  it 'closed html tags' do
+    Walters.escape_javascript(%(keep <open>, but dont </close> tags)).should == %(keep <open>, but dont <\\/close> tags)
+  end
+  it 'original returned if no escaping required' do
+    str = 'foobar'
+    Walters.escape_javascript(str).should equal str
+  end
+  it 'input must be utf8' do
+    lambda { Walters.escape_javascript('dont </close> tags'.encode('ISO-8859-1')) }.should raise_error(Encoding::CompatibilityError)
+  end
+  it 'return value has same encoding as input' do
+    str = "dont </close> tags"
+    Walters.escape_javascript(str).encoding.should == Encoding.find('UTF-8')
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: walters
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease:
+platform: java
+authors:
+- Wayne Meissner
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-05-02 00:00:00.000000000 Z
+dependencies: []
+description: JRuby wrapper for Houdini html escaping library
+email: wmeissner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- LICENSE-EscapeUtils.txt
+- LICENSE-houdini.txt
+- README.md
+- Rakefile
+- lib/walters.rb
+- lib/walters/version.rb
+- lib/walters/walters.rb
+- lib/walters/walters_xni.rb
+- lib/walters/html/cgi.rb
+- lib/walters/html/erb.rb
+- lib/walters/html/haml.rb
+- lib/walters/html/html_safety.rb
+- lib/walters/html/rack.rb
+- lib/walters/javascript/action_view.rb
+- spec/spec_helper.rb
+- spec/walters/html_escape_spec.rb
+- spec/walters/javascript_escape_spec.rb
+- benchmark/html_clean_escape.rb
+- benchmark/html_escape.rb
+- lib/walters/walters_ext.jar
+homepage: http://wiki.github.com/wmeissner/walters
+licenses:
+- Apache 2.0
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: JRuby wrapper for Houdini
+test_files: []