fast_blank 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23b988d318c1c1da6a788a6d0c3b1f7f0f65e6ca
+  data.tar.gz: ba4ef389e4cebb24ba9ac8e1fc8c5d263b817d94
+SHA512:
+  metadata.gz: 88222e2184cf6394fd34fb5840e8ca30013e68cac6ea2f0a5408252eafe97a121db72baa42ec10bee14d7ae1ccced2f66974fcfa76c3d999f989050fe183b118
+  data.tar.gz: 74e3a6270528702e72428564215614a81564e2a475dfe797db27ebb5780d9cb8e452f7fc458767cbfea9a127de0ab6607879733bbee6e8916c8ac72231c55693

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,57 @@
+### String blank? Ruby Extension
+
+`fast_blank` is a simple extension which provides a fast implementation of active support's string#blank? function
+
+### How do you use it?
+
+    require 'fast_blank'
+
+### How fast is "Fast"?
+
+
+About 5-9x faster than current active support, on my machine (your mileage my vary):
+
+    $ ./benchmark
+
+```
+                          user     system      total        real
+                                            user     system      total        real
+Fast Blank 0    :                       0.070000   0.000000   0.070000 (  0.075247)
+Fast Blank (Active Support)  0    :     0.080000   0.000000   0.080000 (  0.075029)
+Slow Blank 0    :                       0.500000   0.000000   0.500000 (  0.503026)
+Fast Blank 6    :                       0.200000   0.000000   0.200000 (  0.191480)
+Fast Blank (Active Support)  6    :     0.180000   0.000000   0.180000 (  0.179891)
+Slow Blank 6    :                       0.660000   0.000000   0.660000 (  0.658604)
+Fast Blank 14    :                      0.080000   0.010000   0.090000 (  0.086371)
+Fast Blank (Active Support)  14    :    0.130000   0.000000   0.130000 (  0.129258)
+Slow Blank 14    :                      0.890000   0.000000   0.890000 (  0.886140)
+Fast Blank 24    :                      0.150000   0.000000   0.150000 (  0.158151)
+Fast Blank (Active Support)  24    :    0.140000   0.000000   0.140000 (  0.149284)
+Slow Blank 24    :                      0.900000   0.000000   0.900000 (  0.899663)
+Fast Blank 136    :                     0.130000   0.000000   0.130000 (  0.125831)
+Fast Blank (Active Support)  136    :   0.150000   0.000000   0.150000 (  0.148948)
+Slow Blank 136    :                     0.900000   0.000000   0.900000 (  0.899885)
+
+
+```
+
+
+Additionally, this gem allocates no strings during the test, making it less of a GC burden.
+
+
+###Compatability note:
+
+fast_blank implements string.blank? as MRI would have it implemented, meaning it has 100% parity with `String#strip.length == 0`.
+
+
+Active Supports version looks also at 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.
+
+fast_blank also provides blank_as? which is a 100% compatible blank? replacement.
+
+Author: Sam Saffron sam.saffron@gmail.com  
+http://github.com/SamSaffron/fast_blank    
+License: MIT  
+
+
+(gem template based on https://github.com/CodeMonkeySteve/fast_xor )

data/benchmark

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+$: << File.dirname(__FILE__)+'/lib'
+require 'benchmark'
+require 'fast_blank'
+
+class String
+  # active support implementation
+  def slow_blank?
+    self !~ /[^[:space:]]/
+  end
+end
+
+
+n = 1000000
+
+
+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"
+]
+
+strings.each do |s|
+  raise "failed on #{s.inspect}" if s.blank? != s.slow_blank?
+end
+
+Benchmark.bmbm  do |x|
+  strings.each do |s|
+    x.report("Fast Blank #{s.length}    :") do  n.times { s.blank? }  end
+    x.report("Fast Blank (Active Support)  #{s.length}    :") do  n.times { s.blank_as? }  end
+    x.report("Slow Blank #{s.length}    :") do  n.times { s.slow_blank? }  end
+    #x.report("Empty #{s.length}    :") do  n.times { s.empty? }  end
+  end
+end

data/ext/fast_blank/extconf.rb

@@ -0,0 +1,2 @@
+require 'mkmf'
+create_makefile 'fast_blank'

data/ext/fast_blank/fast_blank.c

@@ -0,0 +1,83 @@
+#include <stdio.h>
+#include <ruby.h>
+#include <ruby/encoding.h>
+#include <ruby/re.h>
+
+#define STR_ENC_GET(str) rb_enc_from_index(ENCODING_GET(str))
+
+/* Backward compatibility with Ruby 1.8 */
+#ifndef RSTRING_PTR
+#define RSTRING_PTR(s) (RSTRING(s)->ptr)
+#endif
+#ifndef RSTRING_LEN
+#define RSTRING_LEN(s) (RSTRING(s)->len)
+#endif
+
+const unsigned int as_blank[26] = {9, 0xa, 0xb, 0xc, 0xd,
+  0x20, 0x85, 0xa0, 0x1680, 0x180e, 0x2000, 0x2001,
+  0x2002, 0x2003, 0x2004, 0x2005, 0x2006, 0x2007, 0x2008,
+  0x2009, 0x200a, 0x2028, 0x2029, 0x202f, 0x205f, 0x3000
+};
+
+static VALUE
+rb_str_blank_as(VALUE str)
+{
+  rb_encoding *enc;
+  char *s, *e;
+  int i;
+  int found;
+
+  enc = STR_ENC_GET(str);
+  s = RSTRING_PTR(str);
+  if (!s || RSTRING_LEN(str) == 0) return Qtrue;
+
+  e = RSTRING_END(str);
+  while (s < e) {
+	  int n;
+	  unsigned int cc = rb_enc_codepoint_len(s, e, &n, enc);
+
+    found = 0;
+    for(i=0;i<26;i++){
+      unsigned int current = as_blank[i];
+      if(current == cc) {
+        found = 1;
+        break;
+      }
+      if(cc < current){
+        break;
+      }
+    }
+
+	  if (!found) return Qfalse;
+    s += n;
+  }
+  return Qtrue;
+}
+
+static VALUE
+rb_str_blank(VALUE str)
+{
+  rb_encoding *enc;
+  char *s, *e;
+
+  enc = STR_ENC_GET(str);
+  s = RSTRING_PTR(str);
+  if (!s || RSTRING_LEN(str) == 0) return Qtrue;
+
+  e = RSTRING_END(str);
+  while (s < e) {
+	  int n;
+	  unsigned int cc = rb_enc_codepoint_len(s, e, &n, enc);
+
+	  if (!rb_isspace(cc) && cc != 0) return Qfalse;
+    s += n;
+  }
+  return Qtrue;
+}
+
+
+void Init_fast_blank( void )
+{
+  rb_define_method(rb_cString, "blank?", rb_str_blank, 0);
+  rb_define_method(rb_cString, "blank_as?", rb_str_blank_as, 0);
+}

data/spec/fast_blank_spec.rb

@@ -0,0 +1,51 @@
+require 'fast_blank'
+
+class ::String
+  def blank2?
+    self !~ /[^[:space:]]/
+  end
+end
+
+describe String do
+  it "works" do
+    "".blank?.should == true
+    " ".blank?.should == true
+    "\r\n".blank?.should == 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?
+        "#{i.to_s(16)} #{c.blank_as?}".should == "#{i.to_s(16)} #{c.blank2?}"
+      end
+    end
+
+
+    (256).times do |i|
+      c = i.chr('ASCII') rescue nil
+      unless c.nil?
+        "#{i.to_s(16)} #{c.blank_as?}".should == "#{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?
+        "#{i.to_s(16)} #{c.strip.length == 0}".should == "#{i.to_s(16)} #{c.blank?}"
+      end
+    end
+  end
+
+  it "treats \u0000 correctly" do
+    # odd I know
+    "\u0000".strip.length.should == 0
+    "\u0000".blank_as?.should be_false
+    "\u0000".blank?.should be_true
+  end
+
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: fast_blank
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sam Saffron
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Provides a C-optimized method for determining if a string is blank
+email: sam.saffron@gmail.com
+executables: []
+extensions:
+- ext/fast_blank/extconf.rb
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- benchmark
+- lib/.gemkeep
+- ext/fast_blank/fast_blank.c
+- ext/fast_blank/extconf.rb
+- spec/fast_blank_spec.rb
+homepage: ''
+licenses: []
+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.0.2
+signing_key: 
+specification_version: 4
+summary: Fast String blank? implementation
+test_files:
+- spec/fast_blank_spec.rb