fast_blank 1.0.1-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1c72ae742348e8648feb70ef9fecb367c7e1586764b3708e89621938ec7ec88c
+  data.tar.gz: 85226b0fdb4c4e5b124e2292d32f0826d1d116b2d9b324fff3ce5bde53496c35
+SHA512:
+  metadata.gz: 0655db9256f773dad6d67c5741c20a35b32892c165e19f89e3550c8fc21d66f93be21640bcdacfb73bac30b09c89edf5851bf1c98c5c815d30a465fc72b439cf
+  data.tar.gz: e798ec0bdda4880cc50d9950a0b3e9928eba66e2084cba329b8293dc8170eacf0d2a31b74f5ee66c1cfa65c78e3d0b6a3ddfe39c99a208b2743a260f8a21d48d

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2006-2009 Steve Sloan
+
+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,146 @@
+### `String#blank?` Ruby Extension
+
+[![Gem Version](https://badge.fury.io/rb/fast_blank.png)](http://badge.fury.io/rb/fast_blank) [![Build Status](https://travis-ci.org/SamSaffron/fast_blank.png?branch=master)](https://travis-ci.org/SamSaffron/fast_blank)
+
+`fast_blank` is a simple C extension which provides a fast implementation of [Active Support's `String#blank?` method](http://api.rubyonrails.org/classes/String.html#method-i-blank-3F).
+
+### How do you use it?
+
+    require 'fast_blank'
+
+or add it to your Bundler Gemfile
+
+    gem 'fast_blank'
+
+### How fast is "Fast"?
+
+About 1.2–20x faster than Active Support on my machine (your mileage my vary, depends on string length):
+
+```
+$ bundle exec ./benchmark
+
+================== Test String Length: 0 ==================
+Calculating -------------------------------------
+          Fast Blank   225.251k i/100ms
+  Fast ActiveSupport   225.676k i/100ms
+          Slow Blank   110.934k i/100ms
+      New Slow Blank   221.792k i/100ms
+-------------------------------------------------
+          Fast Blank     29.673M (± 2.7%) i/s -    148.215M
+  Fast ActiveSupport     28.249M (± 3.5%) i/s -    141.048M
+          Slow Blank      2.158M (± 3.3%) i/s -     10.872M
+      New Slow Blank     23.558M (± 3.2%) i/s -    117.772M
+
+Comparison:
+          Fast Blank: 29673200.1 i/s
+  Fast ActiveSupport: 28248894.5 i/s - 1.05x slower
+      New Slow Blank: 23557900.0 i/s - 1.26x slower
+          Slow Blank:  2157787.7 i/s - 13.75x slower
+
+
+================== Test String Length: 6 ==================
+Calculating -------------------------------------
+          Fast Blank   201.185k i/100ms
+  Fast ActiveSupport   205.076k i/100ms
+          Slow Blank   102.061k i/100ms
+      New Slow Blank   123.087k i/100ms
+-------------------------------------------------
+          Fast Blank     13.894M (± 2.3%) i/s -     69.409M
+  Fast ActiveSupport     14.627M (± 3.5%) i/s -     73.212M
+          Slow Blank      1.943M (± 2.3%) i/s -      9.798M
+      New Slow Blank      2.796M (± 1.8%) i/s -     14.032M
+
+Comparison:
+  Fast ActiveSupport: 14627063.7 i/s
+          Fast Blank: 13893631.2 i/s - 1.05x slower
+      New Slow Blank:  2795783.3 i/s - 5.23x slower
+          Slow Blank:  1943025.9 i/s - 7.53x slower
+
+
+================== Test String Length: 14 ==================
+Calculating -------------------------------------
+          Fast Blank   220.004k i/100ms
+  Fast ActiveSupport   219.716k i/100ms
+          Slow Blank   147.399k i/100ms
+      New Slow Blank   106.651k i/100ms
+-------------------------------------------------
+          Fast Blank     24.949M (± 3.0%) i/s -    124.742M
+  Fast ActiveSupport     24.491M (± 3.3%) i/s -    122.382M
+          Slow Blank      4.292M (± 1.6%) i/s -     21.520M
+      New Slow Blank      2.115M (± 2.4%) i/s -     10.665M
+
+Comparison:
+          Fast Blank: 24948558.8 i/s
+  Fast ActiveSupport: 24491245.1 i/s - 1.02x slower
+          Slow Blank:  4292490.5 i/s - 5.81x slower
+      New Slow Blank:  2115097.6 i/s - 11.80x slower
+
+
+================== Test String Length: 24 ==================
+Calculating -------------------------------------
+          Fast Blank   206.555k i/100ms
+  Fast ActiveSupport   208.513k i/100ms
+          Slow Blank   137.733k i/100ms
+      New Slow Blank   101.215k i/100ms
+-------------------------------------------------
+          Fast Blank     16.761M (± 2.7%) i/s -     83.861M
+  Fast ActiveSupport     17.710M (± 3.2%) i/s -     88.618M
+          Slow Blank      3.744M (± 2.0%) i/s -     18.732M
+      New Slow Blank      1.962M (± 2.7%) i/s -      9.818M
+
+Comparison:
+  Fast ActiveSupport: 17709936.5 i/s
+          Fast Blank: 16760839.7 i/s - 1.06x slower
+          Slow Blank:  3744048.4 i/s - 4.73x slower
+      New Slow Blank:  1961831.1 i/s - 9.03x slower
+
+
+================== Test String Length: 136 ==================
+Calculating -------------------------------------
+          Fast Blank   201.772k i/100ms
+  Fast ActiveSupport   189.120k i/100ms
+          Slow Blank   129.439k i/100ms
+      New Slow Blank    90.677k i/100ms
+-------------------------------------------------
+          Fast Blank     16.718M (± 2.8%) i/s -     83.534M
+  Fast ActiveSupport     17.617M (± 3.6%) i/s -     87.941M
+          Slow Blank      3.725M (± 3.0%) i/s -     18.639M
+      New Slow Blank      1.940M (± 4.8%) i/s -      9.702M
+
+Comparison:
+  Fast ActiveSupport: 17616782.1 i/s
+          Fast Blank: 16718307.8 i/s - 1.05x slower
+          Slow Blank:  3725097.6 i/s - 4.73x slower
+      New Slow Blank:  1940271.2 i/s - 9.08x slower
+
+
+```
+
+Additionally, this gem allocates no strings during the test, making it less of a GC burden.
+
+### Compatibility note:
+
+`fast_blank` supports MRI Ruby 1.9.3, 2.0, 2.1, and 2.2, as well as Rubinius 2.x. Earlier versions of MRI are untested.
+
+`fast_blank` implements `String#blank?` as MRI would have implemented it, meaning it has 100% parity with `String#strip.length == 0`.
+
+Active Support's version also considers Unicode spaces.  For example, `"\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200A\u202F\u205F\u3000".blank?` is true in Active Support even though `fast_blank` would treat it as *not* blank.  Therefore, `fast_blank` also provides `blank_as?` which is a 100%-compatible Active Support `blank?` replacement.
+
+### Credits
+
+* Author: Sam Saffron (sam.saffron@gmail.com)
+* https://github.com/SamSaffron/fast_blank
+* License: MIT
+* Gem template based on [CodeMonkeySteve/fast_xor](https://github.com/CodeMonkeySteve/fast_xor)
+
+### Change log:
+
+1.0.1:
+  - Minor, avoid warnings if redefining blank?
+
+1.0.0:
+  - Adds Ruby 2.2 support ([@tjschuck](https://github.com/tjschuck) — [#9](https://github.com/SamSaffron/fast_blank/pull/9))
+
+0.0.2:
+  - Removed rake dependency ([@tmm1](https://github.com/tmm1) — [#2](https://github.com/SamSaffron/fast_blank/pull/2))
+  - Unrolled internal loop to improve perf ([@tmm1](https://github.com/tmm1) — [#2](https://github.com/SamSaffron/fast_blank/pull/2))

data/benchmark

@@ -0,0 +1,166 @@
+#!/usr/bin/env ruby
+$: << File.dirname(__FILE__)+'/lib'
+require 'benchmark/ips'
+require 'fast_blank'
+
+class String
+  # active support implementation
+  def slow_blank?
+    /\A[[:space:]]*\z/ === self
+  end
+
+  def new_slow_blank?
+    empty? || !(/[[:^space:]]/ === self)
+  end
+end
+
+test_strings = [
+  "",
+  "\r\n\r\n  ",
+  "this is a test",
+  "   this is a longer test",
+  "   this is a longer test
+      this is a longer test
+      this is a longer test
+      this is a longer test
+      this is a longer test"
+]
+
+test_strings.each do |s|
+  raise "failed on #{s.inspect}" if s.blank? != s.slow_blank?
+  raise "failed on #{s.inspect}" if s.blank? != s.new_slow_blank?
+end
+
+test_strings.each do |s|
+  puts "\n================== Test String Length: #{s.length} =================="
+  Benchmark.ips do |x|
+    x.report("Fast Blank") do |times|
+      i = 0
+      while i < times
+        s.blank?
+        i += 1
+      end
+    end
+
+    x.report("Fast ActiveSupport") do |times|
+      i = 0
+      while i < times
+        s.blank_as?
+        i += 1
+      end
+    end
+
+    x.report("Slow Blank") do |times|
+      i = 0
+      while i < times
+        s.slow_blank?
+        i += 1
+      end
+    end
+
+    x.report("New Slow Blank") do |times|
+      i = 0
+      while i < times
+        s.new_slow_blank?
+        i += 1
+      end
+    end
+
+    x.compare!
+  end
+end
+
+# ================== Test String Length: 0 ==================
+# Calculating -------------------------------------
+#           Fast Blank   225.251k i/100ms
+#   Fast ActiveSupport   225.676k i/100ms
+#           Slow Blank   110.934k i/100ms
+#       New Slow Blank   221.792k i/100ms
+# -------------------------------------------------
+#           Fast Blank     29.673M (± 2.7%) i/s -    148.215M
+#   Fast ActiveSupport     28.249M (± 3.5%) i/s -    141.048M
+#           Slow Blank      2.158M (± 3.3%) i/s -     10.872M
+#       New Slow Blank     23.558M (± 3.2%) i/s -    117.772M
+#
+# Comparison:
+#           Fast Blank: 29673200.1 i/s
+#   Fast ActiveSupport: 28248894.5 i/s - 1.05x slower
+#       New Slow Blank: 23557900.0 i/s - 1.26x slower
+#           Slow Blank:  2157787.7 i/s - 13.75x slower
+#
+#
+# ================== Test String Length: 6 ==================
+# Calculating -------------------------------------
+#           Fast Blank   201.185k i/100ms
+#   Fast ActiveSupport   205.076k i/100ms
+#           Slow Blank   102.061k i/100ms
+#       New Slow Blank   123.087k i/100ms
+# -------------------------------------------------
+#           Fast Blank     13.894M (± 2.3%) i/s -     69.409M
+#   Fast ActiveSupport     14.627M (± 3.5%) i/s -     73.212M
+#           Slow Blank      1.943M (± 2.3%) i/s -      9.798M
+#       New Slow Blank      2.796M (± 1.8%) i/s -     14.032M
+#
+# Comparison:
+#   Fast ActiveSupport: 14627063.7 i/s
+#           Fast Blank: 13893631.2 i/s - 1.05x slower
+#       New Slow Blank:  2795783.3 i/s - 5.23x slower
+#           Slow Blank:  1943025.9 i/s - 7.53x slower
+#
+#
+# ================== Test String Length: 14 ==================
+# Calculating -------------------------------------
+#           Fast Blank   220.004k i/100ms
+#   Fast ActiveSupport   219.716k i/100ms
+#           Slow Blank   147.399k i/100ms
+#       New Slow Blank   106.651k i/100ms
+# -------------------------------------------------
+#           Fast Blank     24.949M (± 3.0%) i/s -    124.742M
+#   Fast ActiveSupport     24.491M (± 3.3%) i/s -    122.382M
+#           Slow Blank      4.292M (± 1.6%) i/s -     21.520M
+#       New Slow Blank      2.115M (± 2.4%) i/s -     10.665M
+#
+# Comparison:
+#           Fast Blank: 24948558.8 i/s
+#   Fast ActiveSupport: 24491245.1 i/s - 1.02x slower
+#           Slow Blank:  4292490.5 i/s - 5.81x slower
+#       New Slow Blank:  2115097.6 i/s - 11.80x slower
+#
+#
+# ================== Test String Length: 24 ==================
+# Calculating -------------------------------------
+#           Fast Blank   206.555k i/100ms
+#   Fast ActiveSupport   208.513k i/100ms
+#           Slow Blank   137.733k i/100ms
+#       New Slow Blank   101.215k i/100ms
+# -------------------------------------------------
+#           Fast Blank     16.761M (± 2.7%) i/s -     83.861M
+#   Fast ActiveSupport     17.710M (± 3.2%) i/s -     88.618M
+#           Slow Blank      3.744M (± 2.0%) i/s -     18.732M
+#       New Slow Blank      1.962M (± 2.7%) i/s -      9.818M
+#
+# Comparison:
+#   Fast ActiveSupport: 17709936.5 i/s
+#           Fast Blank: 16760839.7 i/s - 1.06x slower
+#           Slow Blank:  3744048.4 i/s - 4.73x slower
+#       New Slow Blank:  1961831.1 i/s - 9.03x slower
+#
+#
+# ================== Test String Length: 136 ==================
+# Calculating -------------------------------------
+#           Fast Blank   201.772k i/100ms
+#   Fast ActiveSupport   189.120k i/100ms
+#           Slow Blank   129.439k i/100ms
+#       New Slow Blank    90.677k i/100ms
+# -------------------------------------------------
+#           Fast Blank     16.718M (± 2.8%) i/s -     83.534M
+#   Fast ActiveSupport     17.617M (± 3.6%) i/s -     87.941M
+#           Slow Blank      3.725M (± 3.0%) i/s -     18.639M
+#       New Slow Blank      1.940M (± 4.8%) i/s -      9.702M
+#
+# Comparison:
+#   Fast ActiveSupport: 17616782.1 i/s
+#           Fast Blank: 16718307.8 i/s - 1.05x slower
+#           Slow Blank:  3725097.6 i/s - 4.73x slower
+#       New Slow Blank:  1940271.2 i/s - 9.08x slower
+#

data/ext/java/com/headius/jruby/fast_blank/FastBlankLibrary.java

@@ -0,0 +1,119 @@
+package com.headius.jruby.fast_blank;
+
+import org.jcodings.Encoding;
+import org.jruby.Ruby;
+import org.jruby.RubyString;
+import org.jruby.anno.JRubyMethod;
+import org.jruby.runtime.ThreadContext;
+import org.jruby.runtime.builtin.IRubyObject;
+import org.jruby.runtime.load.Library;
+import org.jruby.util.ByteList;
+import org.jruby.util.StringSupport;
+import org.jruby.util.io.EncodingUtils;
+
+public class FastBlankLibrary implements Library {
+    public void load(Ruby runtime, boolean wrap) {
+        runtime.getString().defineAnnotatedMethods(FastBlankLibrary.class);
+    }
+
+    @JRubyMethod(name = "blank_as?")
+    public static IRubyObject blank_as_p(ThreadContext context, IRubyObject self) {
+        Encoding enc;
+        int s, e;
+        byte[] sBytes;
+
+        Ruby runtime = context.runtime;
+
+        RubyString str = (RubyString) self;
+        enc = str.getEncoding();
+        ByteList sByteList = str.getByteList();
+        sBytes = sByteList.unsafeBytes();
+        s = sByteList.begin();
+        if (str.size() == 0) return context.tru;
+
+        e = s + sByteList.realSize();
+        int[] n = {0};
+        while (s < e) {
+            int cc = EncodingUtils.encCodepointLength(runtime, sBytes, s, e, n, enc);
+
+            switch (cc) {
+                case 9:
+                case 0xa:
+                case 0xb:
+                case 0xc:
+                case 0xd:
+                case 0x20:
+                case 0x85:
+                case 0xa0:
+                case 0x1680:
+                case 0x2000:
+                case 0x2001:
+                case 0x2002:
+                case 0x2003:
+                case 0x2004:
+                case 0x2005:
+                case 0x2006:
+                case 0x2007:
+                case 0x2008:
+                case 0x2009:
+                case 0x200a:
+                case 0x2028:
+                case 0x2029:
+                case 0x202f:
+                case 0x205f:
+                case 0x3000:
+                    /* found */
+                    break;
+                default:
+                    return context.fals;
+            }
+            s += n[0];
+        }
+        return context.tru;
+    }
+
+    @JRubyMethod(name = "blank?")
+    public static IRubyObject blank_p(ThreadContext context, IRubyObject self) {
+        RubyString str = (RubyString) self;
+
+        if (str.size() == 0) return context.tru;
+
+        ByteList sByteList = str.getByteList();
+        byte[] sBytes = sByteList.unsafeBytes();
+        int s = sByteList.begin();
+        int e = s + sByteList.realSize();
+
+        // Move to slower path if the string contains non 7-bit ASCII.
+        if (str.getCodeRange() != StringSupport.CR_7BIT) return blankSlow(context, sBytes, s, e, str.getEncoding());
+
+        for (int i = s; i < e; i++) {
+            if (!isSpace(sBytes[i])) return context.fals;
+        }
+
+        return context.tru;
+    }
+
+    private static boolean isSpace(byte c) {
+        return c == ' ' || ('\t' <= c && c <= '\r') || c == '\0';
+    }
+
+    private static IRubyObject blankSlow(ThreadContext context, byte[] bytes, int s, int e, Encoding enc) {
+        Ruby runtime = context.runtime;
+        int[] n = {0};
+
+        while (s < e) {
+            int cc = EncodingUtils.encCodepointLength(runtime, bytes, s, e, n, enc);
+
+            if (!isSpaceCodepoint(cc) && cc != 0) return context.fals;
+            s += n[0];
+        }
+
+        return context.tru;
+    }
+
+    // MRI: rb_isspace
+    private static boolean isSpaceCodepoint(int codepoint) {
+        long c = codepoint & 0xFFFFFFFF;
+        return c == ' ' || ('\t' <= c && c <= '\r');
+    }
+}

data/lib/fast_blank.rb

@@ -0,0 +1,12 @@
+class ::String
+  # Explicitly undefine method before redefining to avoid Ruby warnings.
+  undef_method(:blank?) if method_defined?(:blank?)
+end
+
+case RUBY_ENGINE
+  when 'jruby'
+    require 'fast_blank.jar'
+    JRuby::Util.load_ext("com.headius.jruby.fast_blank.FastBlankLibrary")
+  else
+    require 'fast_blank.so'
+end

data/spec/fast_blank_spec.rb

@@ -0,0 +1,57 @@
+$VERBOSE = true
+
+class ::String
+  # Stub the original method to make sure it is redefined correctly.
+  def blank?
+    raise NotImplementedError
+  end
+
+  def blank2?
+    /\A[[:space:]]*\z/ === self
+  end
+end
+
+require 'fast_blank'
+
+describe String do
+  it "works" do
+    expect("".blank?).to eq(true)
+    expect(" ".blank?).to eq(true)
+    expect("\r\n".blank?).to eq(true)
+    "\r\n\v\f\r\s\u0085".blank? == true
+  end
+
+  it "provides a parity with active support function" do
+    (16*16*16*16).times do |i|
+      c = i.chr('UTF-8') rescue nil
+      unless c.nil?
+        expect("#{i.to_s(16)} #{c.blank_as?}").to eq("#{i.to_s(16)} #{c.blank2?}")
+      end
+    end
+
+
+    (256).times do |i|
+      c = i.chr('ASCII') rescue nil
+      unless c.nil?
+        expect("#{i.to_s(16)} #{c.blank_as?}").to eq("#{i.to_s(16)} #{c.blank2?}")
+      end
+    end
+  end
+
+  it "has parity with strip.length" do
+    (256).times do |i|
+      c = i.chr('ASCII') rescue nil
+      unless c.nil?
+        expect("#{i.to_s(16)} #{c.strip.length == 0}").to eq("#{i.to_s(16)} #{c.blank?}")
+      end
+    end
+  end
+
+  it "treats \u0000 correctly" do
+    # odd I know
+    expect("\u0000".strip.length).to eq(0)
+    expect("\u0000".blank_as?).to be_falsey
+    expect("\u0000".blank?).to be_truthy
+  end
+
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: fast_blank
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: java
+authors:
+- Sam Saffron
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rake-compiler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: benchmark-ips
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides a C-optimized method for determining if a string is blank
+email: sam.saffron@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- benchmark
+- ext/java/com/headius/jruby/fast_blank/FastBlankLibrary.java
+- lib/.gemkeep
+- lib/fast_blank.jar
+- lib/fast_blank.rb
+- spec/fast_blank_spec.rb
+homepage: https://github.com/SamSaffron/fast_blank
+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: []
+rubygems_version: 3.2.29
+signing_key:
+specification_version: 4
+summary: Fast String blank? implementation
+test_files:
+- spec/fast_blank_spec.rb