rejectu 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b6567f2dd67415c2a817e5907895310439af685
+  data.tar.gz: 0dc65aa88bb81341421d8eabf548e05b6352a882
+SHA512:
+  metadata.gz: af3e3a94fc5650dfe55669461efa16b42fc0bf617b3e08c8165152aaaebfe2345184a570fdd6e8b9278063b2d82f870a3893a54966d026640779154aed108849
+  data.tar.gz: a987555733a255e82adc2ff41fa6f4fa712b4db0e11f6ad0693bc7780c9c50da5e91ad409fa5c1ef8cdba3052dd5febd8bf565bac185b2a50a0eff1cc7487ba6

data/.gitignore

@@ -0,0 +1,5 @@
+/.bundle/
+/lib/rejectu/*.so
+/lib/rejectu/*.bundle
+/tmp/*
+*.gem

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,18 @@
+PATH
+  remote: .
+  specs:
+    rejectu (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.3.2)
+    rake-compiler (0.9.2)
+      rake
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake-compiler (~> 0.9)
+  rejectu!

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Scott Francis <scott.francis@shopify.com>
+
+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,23 @@
+## Rejectu
+
+A simple Ruby extension that verifies that a UTF-8 string does not contain any characters from supplementary planes (code points >= `U+10000`).
+
+### Features
+
+- C extension that uses SSE2 for webscale
+
+### Usage
+
+```ruby
+require 'rejectu/rejectu'
+
+Rejectu.valid? "happy! \xf2\xa4\xb7\xa4" # false
+Rejectu.valid? "really happy!" # true
+Rejectu.valid? "this should be good too \xe2\x84\xa2" # true
+
+Rejectu.scrub "happy! \xf2\xa4\xb7\xa4" # => "happy! ?"
+```
+
+### Limitations
+
+- The replacement character for `scrub` currently cannot be configured

data/Rakefile

@@ -0,0 +1,32 @@
+task :default => :test
+
+# ==========================================================
+# Packaging
+# ==========================================================
+
+GEMSPEC = eval(File.read('rejectu.gemspec'))
+
+require 'rubygems/package_task'
+Gem::PackageTask.new(GEMSPEC) do |pkg|
+end
+
+# ==========================================================
+# Ruby Extension
+# ==========================================================
+
+require 'rake/extensiontask'
+Rake::ExtensionTask.new('rejectu', GEMSPEC) do |ext|
+  ext.ext_dir = 'ext/rejectu'
+  ext.lib_dir = 'lib/rejectu'
+end
+task :build => :compile
+
+# ==========================================================
+# Testing
+# ==========================================================
+
+require 'rake/testtask'
+Rake::TestTask.new 'test' do |t|
+  t.test_files = FileList['test/test_*.rb']
+end
+task :test => :build

data/ext/rejectu/extconf.rb

@@ -0,0 +1,5 @@
+require 'mkmf'
+
+$CFLAGS = "-O3"
+
+create_makefile('rejectu/rejectu')

data/ext/rejectu/rejectu.c

@@ -0,0 +1,197 @@
+#include <ruby.h>
+#include <ruby/encoding.h>
+#ifdef __SSE2__
+#include <emmintrin.h>
+#endif
+
+static VALUE mRejectu = Qnil;
+static VALUE idEncoding, idTo_s;
+
+static inline int
+has_utf8_supplementary_planes(__m128i v)
+{
+  v = _mm_srli_epi16(v, 4);
+  v = _mm_cmpeq_epi16(v, _mm_set1_epi16(0x0f));
+  return _mm_movemask_epi8(v) == 0 ? 0 : 1;
+}
+
+static inline void
+validate_utf8_input(VALUE str)
+{
+  VALUE encoding;
+
+  Check_Type(str, T_STRING);
+
+  encoding = rb_funcall(rb_funcall(str, idEncoding, 0), idTo_s, 0);
+  if (TYPE(encoding) != T_STRING || strcmp(RSTRING_PTR(encoding), "UTF-8") != 0) {
+    rb_raise(rb_eArgError, "input string is not UTF-8");
+  }
+}
+
+static VALUE
+is_valid(VALUE self, VALUE str)
+{
+  unsigned char *p, *end;
+  long len, remain;
+#ifdef __SSE2__
+  __m128i chunk, part;
+  int mask;
+#endif
+
+  validate_utf8_input(str);
+
+  len = RSTRING_LEN(str);
+  p = RSTRING_PTR(str);
+  end = RSTRING_END(str);
+
+#ifdef __SSE2__
+  /* advance p until it's 16 byte aligned */
+  while (((uintptr_t) p & 0xf) != 0 && p < end) {
+    if ((*p & 0xf0) == 0xf0) {
+      return Qfalse;
+    }
+    p++;
+  }
+
+  while (p < end) {
+    if (end - p < 16)
+      break;
+
+    chunk = _mm_load_si128((__m128i *) p);
+    /* check if the top bit of any of the bytes is set, which is 1 if the character is multibyte */
+    mask = _mm_movemask_epi8(chunk);
+    if (mask) {
+      /*
+       * If there's a multi-bye character somewhere in this chunk, we need to check if it's a codepoint
+       * from the supplementary plane (11110xxx 10xxxxxx 10xxxxxx 10xxxxxx).
+       *
+       * 1) Unpack the chunk into two halves (16-bit integers)
+       * 2) Shift each 16-bit integer 4 bits to the right
+       * 3) Check if the value is 0xf (first four bits set to 1)
+       * 4) Check the high bit of each 8-bit integer
+       *
+       * If the result of step 4 is non-zero, the part has a supplementary plane character.
+       *
+       * Example: the string "hello test! \xf0\x9f\x98\x80" (13 characters, 16 bytes)
+       *
+       * UTF-8 representation:
+       * h        e        l        l        o        <space>  t        e
+       * 01101000 01100001 01101100 01101100 01101111 00100000 01110100 01100001
+       *
+       * s        t        !        <space>  😀 GRINNING FACE (1F600)
+       * 01110011 01110100 00100001 00100000 11110000 10011111 10011000 10000000
+       *
+       * Low part:
+       *
+       * 1) Compare the low part into 16 bit values   = 0x00680065006c006c006f002000740065
+       * 2) Shift each 16 bit value to the right by 4 = 0x00060006000600060006000000070006
+       * 3) Compare each 16 bit value to 0xf          = 0x00000000000000000000000000000000
+       * 4) Check the high bit of each 8-bit value    = 0
+       *
+       * No supplementary plane characters in this part
+       *
+       * High part:
+       *
+       * 1) Compare the low part into 16 bit values   = 0x007300740021002000f0009f00980080
+       * 2) Shift each 16 bit value to the right by 4 = 0x0007000700020002000f000900090008
+       * 3) Compare each 16 bit value to 0xf          = 0x0000000000000000ffff000000000000
+       * 4) Check the high bit of each 8-bit value    = 0xc0 (0b0000000011000000)
+       *
+       * The result is non-zero, so this part has a supplementary plane character.
+       *
+       */
+      if (has_utf8_supplementary_planes(_mm_unpacklo_epi8(chunk, _mm_setzero_si128())) ||
+          has_utf8_supplementary_planes(_mm_unpackhi_epi8(chunk, _mm_setzero_si128()))) {
+        return Qfalse;
+      }
+    }
+
+    p += 16;
+  }
+#endif
+
+  remain = end - p;
+  while (remain) {
+    if ((*p & 0xf0) == 0xf0) {
+      return Qfalse;
+    }
+    p++;
+    remain = end - p;
+  }
+
+  return Qtrue;
+}
+
+static VALUE
+do_scrub(VALUE str)
+{
+  VALUE out_str;
+  unsigned char *p, *end, *out_start, *out;
+  long len, out_len;
+
+  validate_utf8_input(str);
+
+  len = RSTRING_LEN(str);
+  p = RSTRING_PTR(str);
+  end = RSTRING_END(str);
+
+  out_start = out = (unsigned char *) malloc(len);
+  if (!out_start) {
+    rb_raise(rb_eNoMemError, "out of memory");
+  }
+
+  while (p < end) {
+    if ((*p & 0xf0) == 0xf0) {
+      if ((*p & 0xfc) == 0xfc) {
+        p += 6;
+      } else if ((*p & 0xf8) == 0xf8) {
+        p += 5;
+      } else {
+        p += 4;
+      }
+      *out++ = '?';
+    } else {
+      *out++ = *p++;
+    }
+  }
+  *out = '\0';
+
+  out_str = rb_enc_str_new(out_start, out - out_start, rb_utf8_encoding());
+  free(out_start);
+
+  return out_str;
+}
+
+static VALUE
+scrub(VALUE self, VALUE str)
+{
+  if (is_valid(self, str) == Qtrue) {
+    return rb_enc_str_new(RSTRING_PTR(str), RSTRING_LEN(str), rb_utf8_encoding());
+  }
+  return do_scrub(str);
+}
+
+static VALUE
+scrub_bang(VALUE self, VALUE str)
+{
+  VALUE repl;
+  if (is_valid(self, str) == Qtrue) {
+    return str;
+  }
+  repl = do_scrub(str);
+  if (!NIL_P(repl)) rb_str_replace(str, repl);
+  return str;
+}
+
+void
+Init_rejectu()
+{
+  mRejectu = rb_define_module("Rejectu");
+
+  rb_define_singleton_method(mRejectu, "valid?", is_valid, 1);
+  rb_define_singleton_method(mRejectu, "scrub", scrub, 1);
+  rb_define_singleton_method(mRejectu, "scrub!", scrub_bang, 1);
+
+  idEncoding = rb_intern("encoding");
+  idTo_s = rb_intern("to_s");
+}

data/rejectu.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name = 'rejectu'
+  s.version = '0.0.1'
+  s.summary = 'Detects if a UTF-8 string supplementary plane code points'
+  s.description = <<-DOC
+    This gem detects if a UTF-8 encoded string contains characters from the UTF-8 supplementary
+    plane (code points >= U+10000).
+  DOC
+  s.homepage = 'https://github.com/csfrancis/rejectu'
+  s.authors = 'Scott Francis'
+  s.email   = 'scott.francis@shopify.com'
+  s.license = 'MIT'
+
+  s.files = `git ls-files`.split("\n")
+  s.extensions = ['ext/rejectu/extconf.rb']
+  s.add_development_dependency 'rake-compiler', '~> 0.9'
+end

data/test/test_rejectu.rb

@@ -0,0 +1,86 @@
+require 'test/unit'
+require 'rejectu/rejectu'
+
+class TestRejectu < Test::Unit::TestCase
+  def test_valid_only_accepts_string
+    assert_raises TypeError do
+      Rejectu.valid?(Object.new)
+    end
+  end
+
+  def test_valid_returns_boolean
+    assert Rejectu.valid? "test string"
+  end
+
+  def test_valid_short_string
+    assert Rejectu.valid? "test"
+  end
+
+  def test_invalid_string
+    refute Rejectu.valid? "\xf2\xa4\xb7\xa4 test string"
+  end
+
+  def test_invalid_string2
+    refute Rejectu.valid? "teststri\xf2\xa4\xb7\xa4"
+  end
+
+  def test_invalid_string3
+    refute Rejectu.valid? "teststri12\xf2\xa4\xb7\xa4"
+  end
+
+  def test_non_utf8_string
+    assert_raises ArgumentError do
+      Rejectu.valid? "hello world".encode("ISO-8859-1")
+    end
+  end
+
+  def test_longer_valid_utf8_string
+    s = <<-END
+      Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt
+      ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco
+      laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in
+      voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat
+      non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+    END
+    assert Rejectu.valid? s
+  end
+
+  def test_longer_utf8_string
+    s = <<-END
+      Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt
+      ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco
+      laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in
+      voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat
+      non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. \xf2\xa4\xb7\xa4
+    END
+    refute Rejectu.valid? s
+  end
+
+  def test_longer_utf8_string2
+    s = <<-END
+      Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt
+      ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco
+      laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in
+      voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat
+      non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+      \xf2\xa4\xb7\xa4
+      Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt
+      ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco
+      laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in
+      voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat
+      non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+    END
+    refute Rejectu.valid? s
+  end
+
+  def test_scrub
+    assert_equal "? test string", Rejectu.scrub("\xf2\xa4\xb7\xa4 test string")
+  end
+
+  def test_scrub!
+    s = "\xf2\xa4\xb7\xa4 test string"
+    assert_equal "? test string", Rejectu.scrub!(s)
+    assert_equal "? test string", s
+  end
+
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: rejectu
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Scott Francis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: |2
+      This gem detects if a UTF-8 encoded string contains characters from the UTF-8 supplementary
+      plane (code points >= U+10000).
+email: scott.francis@shopify.com
+executables: []
+extensions:
+- ext/rejectu/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- ext/rejectu/extconf.rb
+- ext/rejectu/rejectu.c
+- rejectu.gemspec
+- test/test_rejectu.rb
+homepage: https://github.com/csfrancis/rejectu
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Detects if a UTF-8 string supplementary plane code points
+test_files: []