hescape 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8582fcf14d0eddac5df90d5bf8463c85e32e277b
-  data.tar.gz: 6ace6ba41e38ec0b154caca8f7d05f82833bfbf6
+SHA256:
+  metadata.gz: d9ee8060d3f4a049a27ea234820dc709212b3bc7fc65eb9ec68cb16d8916d9c1
+  data.tar.gz: aed8550ea57d0a43a701c5c9d016d1f7104173aeb5d0dbbdb6c0480262bd9577
 SHA512:
-  metadata.gz: 048d1fbe3fb8559035577e9ccdb8bb60c9d08ba907494a53f455dde6bf79dc98a4e5e699f4118c2ea5e49690908f0aacf2949bda39ca45e0fc8d3ecc0312154e
-  data.tar.gz: b3c16e9a04736b0b3f023e7029684485789ccb9722e383e31edf6899709f4604e179a30e152179494aade4aebcf0e60789be9071690eb3b07d0ad975cf5712eb
+  metadata.gz: 65978b80e047b7a59eec90463e153e4d2e9526d3b972be5231f5d02a2606b83e413ce0dc7bc81c825e3483847d833b3ae1d97cad58248e63d10802366ece009c
+  data.tar.gz: 41f9109130c0e0e1211f587b2e54a2d2167c9b84ddbc56bff38b3a46e76fc400e045bbc2836525b5b7a4416eb92521f159b8c33b9aadc9b857267e740c76ef72

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/README.md

@@ -2,6 +2,76 @@
 
 A gem to use [hescape](https://github.com/k0kubun/hescape) from Ruby, which is fast HTML escape implementation using SSE instructions.
 
+## Benchmark
+
+See [the result](https://app.wercker.com/k0kubun/hescape-ruby/runs/build/57b09e1de8960a01001b3811) of [this benchmark](https://github.com/k0kubun/hescape-ruby/blob/v0.1.0/benchmark/benchmark.rb). Followings are the result of:
+
+```ruby
+Benchmark.ips do |x|
+  str = ENV['ESCAPE_STRING']
+  puts "escaping: #{str}"
+
+  escape_table = { "'" => '&#39;', '&' => '&amp;', '"' => '&quot;', '<' => '&lt;', '>' => '&gt;', }
+
+  x.report('gsub')         { str.gsub(/['&\"<>]/, escape_table) }
+  x.report('escape_utils') { EscapeUtils.escape_html(str, false) }
+  x.report('cgi/escape')   { CGI.escapeHTML(str) }
+  x.report('hescape')      { Hescape.escape_html(str) }
+  x.compare!
+end
+```
+
+### No escape
+```
+escaping: https://github.com/k0kubun/hescape-ruby
+Calculating -------------------------------------
+                gsub      2.392M (± 1.0%) i/s -     11.983M in   5.010225s
+        escape_utils      2.365M (± 0.3%) i/s -     11.896M in   5.031031s
+          cgi/escape      3.787M (± 8.0%) i/s -     18.965M in   5.037529s
+             hescape      7.515M (± 0.3%) i/s -     37.736M in   5.021293s
+
+Comparison:
+             hescape:  7515215.8 i/s
+          cgi/escape:  3787425.3 i/s - 1.98x  slower
+                gsub:  2391950.1 i/s - 3.14x  slower
+        escape_utils:  2364604.2 i/s - 3.18x  slower
+```
+
+### Short escape
+Note: If given string is short, hescape skips SSE instruction. But it's fast.
+
+```
+escaping: <script />
+Calculating -------------------------------------
+                gsub    586.604k (± 1.8%) i/s -      2.941M in   5.015840s
+        escape_utils      2.948M (± 0.3%) i/s -     14.781M in   5.014237s
+          cgi/escape      2.646M (± 1.7%) i/s -     13.226M in   5.000218s
+             hescape      3.731M (± 0.3%) i/s -     18.661M in   5.001429s
+
+Comparison:
+             hescape:  3731246.4 i/s
+        escape_utils:  2947868.9 i/s - 1.27x  slower
+          cgi/escape:  2645937.6 i/s - 1.41x  slower
+                gsub:   586604.3 i/s - 6.36x  slower
+```
+
+### Long escape
+
+```
+escaping: <<<<<<<<<<>>>>>>>>>&&&&&&&&&&""""""'''''
+Calculating -------------------------------------
+                gsub     66.181k (± 0.4%) i/s -    331.968k in   5.016150s
+        escape_utils    749.600k (± 8.1%) i/s -      3.762M in   5.053210s
+          cgi/escape    720.474k (± 1.6%) i/s -      3.628M in   5.037395s
+             hescape    754.412k (± 8.2%) i/s -      3.801M in   5.070904s
+
+Comparison:
+             hescape:   754411.6 i/s
+        escape_utils:   749600.4 i/s - same-ish: difference falls within error
+          cgi/escape:   720473.5 i/s - same-ish: difference falls within error
+                gsub:    66181.0 i/s - 11.40x  slower
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/Rakefile

@@ -1,5 +1,6 @@
 require "bundler/gem_tasks"
 require "rake/extensiontask"
+require "rspec/core/rake_task"
 
 task :build => :compile
 
@@ -8,3 +9,13 @@ Rake::ExtensionTask.new("hescape") do |ext|
 end
 
 task :default => [:clobber, :compile, :spec]
+
+begin
+  require "rspec/core/rake_task"
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :spec => :build
+rescue LoadError
+  # no rspec available
+end

data/ext/hescape/hescape.c

@@ -98,17 +98,18 @@ find_escape_fast(const char *buf, size_t i, size_t size, int *found)
     __m128i escapes5 = _mm_loadu_si128((const __m128i *)escapes);
     size_t left = (size - i) & ~15;
     do {
-      __m128i b16 = _mm_loadu_si128((void *)buf);
+      __m128i b16 = _mm_loadu_si128((void *)(buf + i));
       int index = _mm_cmpestri(escapes5, 5, b16, 16, _SIDD_CMP_EQUAL_ANY);
       if (unlikely(index != 16)) {
         i += index;
         *found = 1;
-        break;
+        return i;
       }
       i += 16;
       left -= 16;
     } while(likely(left != 0));
   }
+  *found = 0;
   return i;
 }
 #endif

data/hescape.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "escape_utils"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rake-compiler"
+  spec.add_development_dependency "rspec", "~> 3.5"
 end

data/lib/hescape/version.rb

@@ -1,3 +1,3 @@
 module Hescape
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/wercker.yml

@@ -5,6 +5,9 @@ build:
     - script:
         name: compile
         code: bundle exec rake compile
+    - script:
+        name: spec
+        code: bundle exec rake spec
     - script:
         name: "[bench] no escape"
         code: ESCAPE_STRING="https://github.com/k0kubun/hescape-ruby" bundle exec ruby benchmark/benchmark.rb

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hescape
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-14 00:00:00.000000000 Z
+date: 2019-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
 description: Fast HTML escape utility
 email:
 - takashikkbn@gmail.com
@@ -89,6 +103,7 @@ extensions:
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -123,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Fast HTML escape utility