hescape 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8582fcf14d0eddac5df90d5bf8463c85e32e277b
+  data.tar.gz: 6ace6ba41e38ec0b154caca8f7d05f82833bfbf6
+SHA512:
+  metadata.gz: 048d1fbe3fb8559035577e9ccdb8bb60c9d08ba907494a53f455dde6bf79dc98a4e5e699f4118c2ea5e49690908f0aacf2949bda39ca45e0fc8d3ecc0312154e
+  data.tar.gz: b3c16e9a04736b0b3f023e7029684485789ccb9722e383e31edf6899709f4604e179a30e152179494aade4aebcf0e60789be9071690eb3b07d0ad975cf5712eb

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hescape.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Takashi Kokubun
+
+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

@@ -0,0 +1,21 @@
+# hescape-ruby [![wercker status](https://app.wercker.com/status/c75c229e77ca1a27a7e70189b6d7aed8/s/master "wercker status")](https://app.wercker.com/project/byKey/c75c229e77ca1a27a7e70189b6d7aed8)
+
+A gem to use [hescape](https://github.com/k0kubun/hescape) from Ruby, which is fast HTML escape implementation using SSE instructions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hescape'
+```
+
+## Usage
+
+```ruby
+Hescape.escape_html(%[<>"'&]) #=> "&lt;&gt;&quot;&#39;&amp;"
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/extensiontask"
+
+task :build => :compile
+
+Rake::ExtensionTask.new("hescape") do |ext|
+  ext.lib_dir = "lib/hescape"
+end
+
+task :default => [:clobber, :compile, :spec]

data/benchmark/benchmark.rb

@@ -0,0 +1,23 @@
+require 'benchmark/ips'
+require 'escape_utils'
+require 'hescape'
+require 'cgi/escape' # Require Ruby 2.3+
+
+Benchmark.ips do |x|
+  str = ENV['ESCAPE_STRING'] || "https://github.com/k0kubun/hescape-ruby"
+  puts "escaping: #{str}"
+
+  escape_table = {
+    "'" => ''',
+    '&' => '&',
+    '"' => '"',
+    '<' => '&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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hescape"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ext/hescape/extconf.rb

@@ -0,0 +1,5 @@
+require "mkmf"
+
+$CFLAGS << ' -msse4'
+
+create_makefile("hescape/hescape")

data/ext/hescape/hescape.c

@@ -0,0 +1,190 @@
+#include <stdio.h>
+#include <string.h>
+#include <sys/types.h>
+#include "hescape.h"
+#include <ruby/encoding.h>
+
+VALUE rb_mHescape;
+
+#ifdef __SSE4_2__
+# ifdef _MSC_VER
+#  include <nmmintrin.h>
+# else
+#  include <x86intrin.h>
+# endif
+#endif
+
+#if __GNUC__ >= 3
+# define likely(x) __builtin_expect(!!(x), 1)
+# define unlikely(x) __builtin_expect(!!(x), 0)
+#else
+# define likely(x) (x)
+# define unlikely(x) (x)
+#endif
+
+static const char *ESCAPED_STRING[] = {
+  "",
+  "&quot;",
+  "&amp;",
+  "&#39;",
+  "&lt;",
+  "&gt;",
+};
+
+// This is strlen(ESCAPED_STRING[x]) optimized specially.
+// Mapping: 1 => 6, 2 => 5, 3 => 5, 4 => 4, 5 => 4
+#define ESC_LEN(x) ((13 - x) / 2)
+
+/*
+ * Given ASCII-compatible character, return index of ESCAPED_STRING.
+ *
+ * " (34) => 1 (&quot;)
+ * & (38) => 2 (&amp;)
+ * ' (39) => 3 (&#39;)
+ * < (60) => 4 (&lt;)
+ * > (62) => 5 (&gt;)
+ */
+static const char HTML_ESCAPE_TABLE[] = {
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 1, 0, 0, 0, 2, 3, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 5, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+};
+
+static char*
+ensure_allocated(char *buf, size_t size, size_t *asize)
+{
+  size_t new_size;
+
+  if (size < *asize)
+    return buf;
+
+  if (*asize == 0) {
+    new_size = size;
+  } else {
+    new_size = *asize;
+  }
+
+  // Increase buffer size by 1.5x if realloced multiple times.
+  while (new_size < size)
+    new_size = (new_size << 1) - (new_size >> 1);
+
+  // Round allocation up to multiple of 8.
+  new_size = (new_size + 7) & ~7;
+
+  *asize = new_size;
+  return realloc(buf, new_size);
+}
+
+#ifdef __SSE4_2__
+static size_t
+find_escape_fast(const char *buf, size_t i, size_t size, int *found)
+{
+  static const char escapes[] = "\"&'<>";
+
+  if (likely(size - i >= 16)) {
+    __m128i escapes5 = _mm_loadu_si128((const __m128i *)escapes);
+    size_t left = (size - i) & ~15;
+    do {
+      __m128i b16 = _mm_loadu_si128((void *)buf);
+      int index = _mm_cmpestri(escapes5, 5, b16, 16, _SIDD_CMP_EQUAL_ANY);
+      if (unlikely(index != 16)) {
+        i += index;
+        *found = 1;
+        break;
+      }
+      i += 16;
+      left -= 16;
+    } while(likely(left != 0));
+  }
+  return i;
+}
+#endif
+
+size_t
+hesc_escape_html(char **dest, const char *buf, size_t size)
+{
+  size_t asize = 0, esc_i, esize = 0, i = 0, rbuf_end = 0;
+  const char *esc;
+  char *rbuf = NULL;
+
+# define DO_ESCAPE() { \
+    esc = ESCAPED_STRING[esc_i]; \
+    rbuf = ensure_allocated(rbuf, sizeof(char) * (size + esize + ESC_LEN(esc_i) + 1), &asize); \
+    memmove(rbuf + rbuf_end, buf + (rbuf_end - esize), i - (rbuf_end - esize)); \
+    memmove(rbuf + i + esize, esc, ESC_LEN(esc_i)); \
+    rbuf_end = i + esize + ESC_LEN(esc_i); \
+    esize += ESC_LEN(esc_i) - 1; \
+  }
+
+# ifdef __SSE4_2__
+  int found = 0;
+  while (i < size) {
+    i = find_escape_fast(buf, i, size, &found);
+    if (!found) break;
+
+    esc_i = HTML_ESCAPE_TABLE[(unsigned char)buf[i]];
+    if (i < size && esc_i) DO_ESCAPE();
+    i++;
+  }
+# endif
+
+  while (i < size) {
+    // Loop here to skip non-escaped characters fast.
+    while (i < size && (esc_i = HTML_ESCAPE_TABLE[(unsigned char)buf[i]]) == 0)
+      i++;
+
+    if (i < size && esc_i) DO_ESCAPE();
+    i++;
+  }
+
+  if (rbuf_end == 0) {
+    // Return given buf and size if there are no escaped characters.
+    *dest = (char *)buf;
+    return size;
+  } else {
+    // Copy pending characters including NULL character.
+    memmove(rbuf + rbuf_end, buf + (rbuf_end - esize), (size + 1) - (rbuf_end - esize));
+
+    *dest = rbuf;
+    return size + esize;
+  }
+}
+
+static VALUE
+rb_escape_html(RB_UNUSED_VAR(VALUE self), VALUE value)
+{
+  char *buf;
+  unsigned int size;
+  VALUE str;
+
+  Check_Type(value, T_STRING);
+  str = rb_convert_type(value, T_STRING, "String", "to_s");
+
+  size = hesc_escape_html(&buf, RSTRING_PTR(str), RSTRING_LEN(str));
+  if (size > RSTRING_LEN(str)) {
+    str = rb_enc_str_new(buf, size, rb_utf8_encoding());
+    free((void *)buf);
+  }
+
+  return str;
+}
+
+void
+Init_hescape(void)
+{
+  rb_mHescape = rb_define_module("Hescape");
+  rb_define_singleton_method(rb_mHescape, "escape_html", rb_escape_html, 1);
+}

data/ext/hescape/hescape.h

@@ -0,0 +1,6 @@
+#ifndef HESCAPE_H
+#define HESCAPE_H 1
+
+#include "ruby.h"
+
+#endif /* HESCAPE_H */

data/hescape.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hescape/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hescape"
+  spec.version       = Hescape::VERSION
+  spec.authors       = ["Takashi Kokubun"]
+  spec.email         = ["takashikkbn@gmail.com"]
+
+  spec.summary       = %q{Fast HTML escape utility}
+  spec.description   = %q{Fast HTML escape utility}
+  spec.homepage      = "https://github.com/k0kubun/hescape-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.extensions    = ["ext/hescape/extconf.rb"]
+
+  spec.add_development_dependency "benchmark-ips"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "escape_utils"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake-compiler"
+end

data/lib/hescape.rb

@@ -0,0 +1,6 @@
+require "hescape/version"
+require "hescape/hescape"
+
+module Hescape
+  # Your code goes here...
+end

data/lib/hescape/version.rb

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

data/wercker.yml

@@ -0,0 +1,16 @@
+box: ruby
+build:
+  steps:
+    - bundle-install
+    - script:
+        name: compile
+        code: bundle exec rake compile
+    - script:
+        name: "[bench] no escape"
+        code: ESCAPE_STRING="https://github.com/k0kubun/hescape-ruby" bundle exec ruby benchmark/benchmark.rb
+    - script:
+        name: "[bench] short escape"
+        code: ESCAPE_STRING="<script />" bundle exec ruby benchmark/benchmark.rb
+    - script:
+        name: "[bench] long escape"
+        code: ESCAPE_STRING="<<<<<<<<<<>>>>>>>>>&&&&&&&&&&\"\"\"\"\"\"'''''" bundle exec ruby benchmark/benchmark.rb

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: hescape
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takashi Kokubun
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-14 00:00:00.000000000 Z
+dependencies:
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: escape_utils
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  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: Fast HTML escape utility
+email:
+- takashikkbn@gmail.com
+executables: []
+extensions:
+- ext/hescape/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmark/benchmark.rb
+- bin/console
+- bin/setup
+- ext/hescape/extconf.rb
+- ext/hescape/hescape.c
+- ext/hescape/hescape.h
+- hescape.gemspec
+- lib/hescape.rb
+- lib/hescape/version.rb
+- wercker.yml
+homepage: https://github.com/k0kubun/hescape-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Fast HTML escape utility
+test_files: []