berns 3.0.2 → 3.1.0

data/ext/berns/extconf.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 require 'mkmf'
 
+$CFLAGS = '-O3 -msse4' # rubocop:disable Style/GlobalVars
+
+dir_config('berns')
 create_header
 create_makefile 'berns/berns'

data/ext/berns/hescape.c

@@ -0,0 +1,167 @@
+#include <stdio.h>
+#include <string.h>
+#include <stdlib.h>
+#include "hescape.h"
+
+#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 uint8_t *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 uint8_t*
+ensure_allocated(uint8_t *buf, size_t size, size_t *asize)
+{
+  if (size < *asize)
+    return buf;
+
+  size_t new_size;
+  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);
+
+  *asize = new_size;
+  return realloc(buf, new_size);
+}
+
+#ifdef __SSE4_2__
+static size_t
+find_char_fast(const char *buf, size_t i, size_t size, __m128i range, size_t range_size, int *found)
+{
+  size_t left = (size - i) & ~15;
+  do {
+    __m128i b16 = _mm_loadu_si128((void *)(buf + i));
+    int index = _mm_cmpestri(range, range_size, 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
+
+static inline size_t
+append_pending_buf(uint8_t *rbuf, size_t rbuf_i, const uint8_t *buf, size_t buf_i, size_t esize)
+{
+  memcpy(rbuf + rbuf_i, buf + (rbuf_i - esize), buf_i - (rbuf_i - esize));
+  return buf_i + esize;
+}
+
+static inline size_t
+append_escaped_buf(uint8_t *rbuf, size_t rbuf_i, size_t esc_i, size_t *esize)
+{
+  memcpy(rbuf + rbuf_i, ESCAPED_STRING[esc_i], ESC_LEN(esc_i));
+  *esize += ESC_LEN(esc_i) - 1;
+  return rbuf_i + ESC_LEN(esc_i);
+}
+
+size_t
+hesc_escape_html(uint8_t **dest, const uint8_t *buf, size_t size)
+{
+  size_t asize = 0, esc_i, esize = 0, i = 0, rbuf_i = 0;
+  const uint8_t *esc;
+  uint8_t *rbuf = NULL;
+
+# ifdef __SSE4_2__
+  __m128i escapes5 = _mm_loadu_si128((const __m128i *)"\"&'<>");
+  while (likely(size - i >= 16)) {
+    int found = 0;
+    if (unlikely((esc_i = HTML_ESCAPE_TABLE[buf[i]]) == 0)) {
+      i = find_char_fast(buf, i, size, escapes5, 5, &found);
+      if (!found) break;
+      esc_i = HTML_ESCAPE_TABLE[buf[i]];
+    }
+    rbuf = ensure_allocated(rbuf, sizeof(uint8_t) * (size + esize + ESC_LEN(esc_i) + 1), &asize);
+    rbuf_i = append_pending_buf(rbuf, rbuf_i, buf, i, esize);
+    rbuf_i = append_escaped_buf(rbuf, rbuf_i, esc_i, &esize);
+    i++;
+  }
+# endif
+
+  while (i < size) {
+    // Loop here to skip non-escaped characters fast.
+    while (i < size && (esc_i = HTML_ESCAPE_TABLE[buf[i]]) == 0)
+      i++;
+
+    if (esc_i) {
+      rbuf = ensure_allocated(rbuf, sizeof(uint8_t) * (size + esize + ESC_LEN(esc_i) + 1), &asize);
+      rbuf_i = append_pending_buf(rbuf, rbuf_i, buf, i, esize);
+      rbuf_i = append_escaped_buf(rbuf, rbuf_i, esc_i, &esize);
+    }
+    i++;
+  }
+
+  if (rbuf_i == 0) {
+    // Return given buf and size if there are no escaped characters.
+    *dest = (uint8_t *)buf;
+    return size;
+  } else {
+    append_pending_buf(rbuf, rbuf_i, buf, size, esize);
+    rbuf[size + esize] = '\0';
+
+    *dest = rbuf;
+    return size + esize;
+  }
+}

data/ext/berns/hescape.h

@@ -0,0 +1,21 @@
+#ifndef HESCAPE_H
+#define HESCAPE_H
+
+#include <sys/types.h>
+#include <stdint.h>
+
+/*
+ * Replace characters according to the following rules.
+ * Note that this function can handle only ASCII-compatible string.
+ *
+ * " => &quot;
+ * & => &amp;
+ * ' => &#39;
+ * < => &lt;
+ * > => &gt;
+ *
+ * @return size of dest. If it's larger than len, dest is required to be freed.
+ */
+extern size_t hesc_escape_html(uint8_t **dest, const uint8_t *src, size_t size);
+
+#endif

data/lib/berns.rb

@@ -1,6 +1,4 @@
 # frozen_string_literal: true
-require 'cgi/escape'
-
 require 'berns/berns'
 require 'berns/version'
 

data/lib/berns/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Berns
-  VERSION = '3.0.2'
+  VERSION = '3.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: berns
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Taylor Beck
@@ -9,16 +9,16 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-15 00:00:00.000000000 Z
+date: 2021-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: cgi
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -26,7 +26,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -40,7 +40,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -54,7 +54,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -68,7 +68,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake-compiler
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -82,7 +82,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -96,7 +96,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-minitest
+  name: rubocop-packaging
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -146,19 +146,14 @@ extensions:
 - ext/berns/extconf.rb
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".github/workflows/main.yml"
-- ".gitignore"
-- ".rubocop.yml"
-- CHANGELOG.org
-- Gemfile
 - LICENSE.txt
 - README.org
-- Rakefile
-- berns.gemspec
 - ext/berns/berns.c
 - ext/berns/extconf.rb
+- ext/berns/hescape.c
+- ext/berns/hescape.h
 - lib/berns.rb
+- lib/berns/berns.so
 - lib/berns/version.rb
 homepage: https://github.com/evanleck/berns
 licenses:

data/.editorconfig

@@ -1,20 +0,0 @@
-# http://EditorConfig.org
-# This is the top most config file.
-root = true
-
-# All files
-[*]
-
-# Unix-style newlines with a newline ending every file
-end_of_line = lf
-insert_final_newline = true
-
-# Character set
-charset = utf-8
-
-# Trim extra whitespace.
-trim_trailing_whitespace = true
-
-# Soft tabs and 2 spaces.
-indent_style = space
-indent_size = 2

data/.github/workflows/main.yml

@@ -1,24 +0,0 @@
-name: Ruby
-
-on: [push,pull_request]
-
-jobs:
-  test:
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, macos-latest]
-        ruby-version: ['3.0', 2.7, 2.6, 2.5]
-
-    runs-on: ${{ matrix.os }}
-    steps:
-    - uses: actions/checkout@v2
-
-    - name: Set up Ruby ${{ matrix.ruby-version }}
-      uses: ruby/setup-ruby@v1
-      with:
-        bundler-cache: true
-        ruby-version: ${{ matrix.ruby-version }}
-
-    - name: Run tests & lint
-      run: bundle exec rake

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.rubocop.yml

@@ -1,58 +0,0 @@
-# http://rubocop.readthedocs.io
-# https://github.com/bbatsov/rubocop/blob/master/config/enabled.yml
-require:
-  - rubocop-minitest
-  - rubocop-performance
-  - rubocop-rake
-
-AllCops:
-  DisplayCopNames: true
-  DisplayStyleGuide: true
-  ExtraDetails: true
-  NewCops: enable
-  TargetRubyVersion: 2.5
-
-Layout/ParameterAlignment:
-  EnforcedStyle: with_fixed_indentation
-
-Layout/EmptyLineAfterMagicComment:
-  Enabled: false
-
-Layout/FirstHashElementIndentation:
-  EnforcedStyle: consistent
-
-Layout/MultilineOperationIndentation:
-  EnforcedStyle: indented
-
-Layout/SpaceInsideStringInterpolation:
-  EnforcedStyle: space
-
-Layout/LineLength:
-  Enabled: false
-
-Metrics/AbcSize:
-  Enabled: false
-
-Metrics/BlockLength:
-  Enabled: false
-
-Metrics/ClassLength:
-  Enabled: false
-
-Metrics/CyclomaticComplexity:
-  Enabled: false
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/ModuleLength:
-  Enabled: false
-
-Metrics/PerceivedComplexity:
-  Enabled: false
-
-Style/IfUnlessModifier:
-  Enabled: false
-
-Style/Next:
-  MinBodyLength: 8

data/CHANGELOG.org

@@ -1,138 +0,0 @@
-* Berns Changelog
-
-** 3.0.2
-
-Ensure all returned strings are UTF-8 encoded.
-
-** 3.0.1
-
-Fix a regression when content blocks are nil. They should be treated the same as
-if they are not there instead of throwing an error.
-
-** 3.0.0
-
-Version 3.0 is another mostly API-compatible refactor of Berns, this time in
-blazing fast C! I debated simply calling this version 2.1.0 but because it's a
-complete rewrite it didn't seem right to do a simple point release and there may
-be corner cases that I've not accounted for in this new C-backed version.
-
-Running the same benchmarks as from 2.0 but pitting 2.0 against 3.0 yields some
-great speed improvements, particularly for the =empty= and =simple= cases.
-
-/These benchmarks were performed on a desktop with a AMD Ryzen 5 3600X 6-Core
-Processor running Linux Mint 20.1 and kernel 5.4./
-
-Before:
-
-#+begin_example
- empty      1.668M (± 0.6%) i/s -      8.356M in   5.011099s
-simple    442.102k (± 1.3%) i/s -      2.214M in   5.008068s
-nested    267.716k (± 0.4%) i/s -      1.357M in   5.068747s
-#+end_example
-
-After:
-
-#+begin_example
- empty      3.573M (± 1.2%) i/s -     17.881M in   5.005001s
-simple    840.631k (± 0.6%) i/s -      4.253M in   5.059771s
-nested    267.281k (± 0.5%) i/s -      1.347M in   5.037887s
-#+end_example
-
-With both empty and simple attributes we see performance effectively double, and
-with nested attributes performance remains more or less the same.
-
-This is another set of fairly contrived benchmarks, testing a singleton method,
-=void= call, and =element= call against each other.
-
-Before:
-
-#+begin_example
-            br      3.061M (± 0.8%) i/s -     15.613M in   5.100154s
-    void("br")      6.141M (± 1.4%) i/s -     30.990M in   5.047338s
-element("div")      2.789M (± 0.6%) i/s -     14.171M in   5.080626s
-#+end_example
-
-After:
-
-#+begin_example
-            br      8.155M (± 1.0%) i/s -     41.339M in   5.069681s
-    void("br")      9.782M (± 1.5%) i/s -     49.096M in   5.020114s
-element("div")      6.769M (± 1.1%) i/s -     33.983M in   5.021362s
-#+end_example
-
-Lastly, benchmarking =to_attributes= with the following hash as the only
-argument shows about double the performance with 3.0.
-
-#+begin_src ruby
-ATTRS = { this: 'tag', should: 'work', data: { foo: 'bar', bar: { baz: 'foo' } } }.freeze
-#+end_src
-
-Before:
-
-#+begin_example
-to_attributes    228.829k (± 1.3%) i/s -      1.159M in   5.065714s
-#+end_example
-
-After:
-
-#+begin_example
-to_attributes    457.387k (± 1.2%) i/s -      2.305M in   5.041036s
-#+end_example
-
-** 2.0.0
-
-Version 2.0 is a mostly API-compatible refactor of all of the core
-methods that make up Berns. The goal is to improve performance, mostly
-using mutable strings and inlining variables that were otherwise short
-lived.
-
-In addition, the target Ruby version has been raised to 2.5 or later.
-2.4 has reached its end of life.
-
-Running this benchmarking code:
-
-#+begin_src ruby
-Benchmark.ips do |x|
-  x.report('empty') { Berns.element(:a) { 'Link to something' } }
-  x.report('simple') { Berns.element(:a, { href: 'Something', class: 'my-class' }) { 'Link to something' } }
-  x.report('nested') { Berns.element(:a, { href: 'Something', class: 'my-class', data: { something: 'Else' } }) { 'Link to something' } }
-
-  x.compare!
-end
-#+end_src
-
-Before:
-
-#+begin_example
- empty    993.521k (± 1.7%) i/s -      5.062M in   5.096368s
-simple    340.795k (± 0.4%) i/s -      1.729M in   5.074101s
-nested    215.160k (± 1.0%) i/s -      1.081M in   5.025324s
-#+end_example
-
-After:
-
-#+begin_example
- empty      1.769M (± 1.9%) i/s -      9.012M in   5.094973s
-simple    441.020k (± 1.0%) i/s -      2.233M in   5.063326s
-nested    280.255k (± 3.0%) i/s -      1.400M in   5.001009s
-#+end_example
-
-With empty attributes we see ~ 100% increase in iterations per second,
-with simple attributes we see ~ 30% increase in the same, and with
-nested attributes we see ~ 30% increase as well.
-
-** 1.3.0
-
-With version 1.3, nested HTML attributes can be created with nil keys
-and boolean values to produce e.g. "data-foo data-foo-bar='whatever'"
-from =data: { foo: { nil => true, bar: 'whatever' } }=
-
-** 1.2.0 - 1.2.2
-
-Starting with version 1.2, Berns will now HTML-escape all attribute
-values using =CGI.escapeHTML=. This should prevent attribute values from
-escaping themselves and injecting HTML into the DOM.
-
-** 1.1.0
-
-- Add =#sanitize= method.