xorcist 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 793234244f107edb7c72b40c9781eb02e9764a57
-  data.tar.gz: aeeaf63a70d085e9900d4023feb461b2e8a13518
+  metadata.gz: 2de9dd2f8528b30b41521656e48ba9b4a1e5e39f
+  data.tar.gz: d791dcdd4766e8aef412047954e1504464ee6584
 SHA512:
-  metadata.gz: dbf415060c191c8cca73230f9e78af36ef5a8e1e14fb3adb777ca8fd86fc18d590666ab2187356bd4b7d6d6394babbea90979302581d8ecd2453a27d48a0bdb1
-  data.tar.gz: bbe34eed87957f7144e5962330d42ffcc611927f353075d09854670accef29fc26a563b9e8125abb631b9c1ca184089d6d43343bf2e37fb4f3956c65cd4508c7
+  metadata.gz: d9f69c450e68d80ca5cf76d32a72930ba8e3436ef1252ada6808eebc85273d4de805579a6f60a2c9e4924c514dd6ce653d5e9fc1c634f8c33c8a9e70f39ea611
+  data.tar.gz: 859066a86e1c7879f378d202adef1c179fba1f4d6f913ac4fcd161d575a4c2e86a2926745e0e8a13a0f153fba3d862a604cc03ea89742130c9c29b5cc4a4062c

data/README.md

@@ -11,8 +11,10 @@ Blazing-fast-cross-platform-monkey-patch-free string XOR. Yes, that means JRuby
 require 'xorcist'
 
 a, b = 'a', 'b'
-Xorcist.xor(a, b)
-Xorcist.xor!(a, b)
+Xorcist.xor(a, b) # => "\u0003"
+a # => 'a'
+Xorcist.xor!(a, b) # => "\u0003"
+a # => "\u0003"
 ```
 
 You can `include Xorcist` to expose its methods:
@@ -46,30 +48,35 @@ require 'xorcist/string_methods'
 String.include(Xorcist::StringMethods)
 ```
 
+## Encodings
+
+Note the precise encoding `xor`'s output is undefined in the v1.0.x releases. In MRI `xor!` will return a string using your default encoding. With JRuby, `xor!` will return an ASCII-8BIT string.
+
 ## Benchmarks
 
-Disclaimer: these are run from my craptop. Run 'em yourself with `bin/benchmark`.
+Disclaimer: these are run from my craptop. Run 'em yourself with `bin/benchmark`. You'll need to have [`benchmark-ips`](https://github.com/evanphx/benchmark-ips) installed.
 
 ### MRI 2.2.1
 
 ```
 Calculating -------------------------------------
-                ruby    11.136k i/100ms
-             xorcist    71.472k i/100ms
+                ruby    26.378k i/100ms
+             xorcist    73.291k i/100ms
 -------------------------------------------------
-                ruby    144.198k (± 1.3%) i/s -    723.840k
-             xorcist      2.155M (± 0.7%) i/s -     10.792M
+                ruby    376.513k (± 0.5%) i/s -      1.899M
+             xorcist      2.150M (± 3.9%) i/s -     10.774M
 ```
 
 ### JRuby 1.7.19
 
 ```
+Picked up JAVA_TOOL_OPTIONS: -javaagent:/usr/share/java/jayatanaag.jar 
 Calculating -------------------------------------
-                ruby   142.000  i/100ms
-             xorcist    88.006k i/100ms
+                ruby    31.795k i/100ms
+             xorcist   118.084k i/100ms
 -------------------------------------------------
-                ruby      3.113k (±32.6%) i/s -     11.218k in   5.781000s
-             xorcist      3.184M (±32.9%) i/s -     12.321M
+                ruby    978.078k (±11.2%) i/s -      4.801M
+             xorcist      3.897M (±14.1%) i/s -     19.012M
 ```
 
 ## Installation
@@ -98,7 +105,8 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Special Thanks To...
 
- - [Steve Sloan][http://www.finagle.org] for his [fast_xor gem][https://github.com/CodeMonkeySteve/fast_xor] from which most of the tests are borrowed
- - [James Coglan][http://jcoglan.com] for his [guide on writing a JRuby Java extension][https://blog.jcoglan.com/2012/08/02/your-first-ruby-native-extension-java/]
+ - [Steve Sloan](http://www.finagle.org) for his [fast_xor gem](https://github.com/CodeMonkeySteve/fast_xor) from which most of the tests are borrowed
+ - [James Coglan](http://jcoglan.com) for his [guide on writing a JRuby Java extension](https://blog.jcoglan.com/2012/08/02/your-first-ruby-native-extension-java/)
+ - [Thomas Leitner](https://github.com/gettalong) for a faster pure Ruby XOR implementation that's used in the benchmark
  - To all [contributers](https://github.com/fny/xorcist/graphs/contributors)! :beers:
 

data/ext/xorcist/xorcist.c

@@ -1,4 +1,4 @@
-#include "ruby.h"
+#include <ruby.h>
 
 VALUE Xorcist = Qnil;
 

data/lib/xorcist/version.rb

@@ -1,3 +1,3 @@
 module Xorcist
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xorcist
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Faraz Yashar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-13 00:00:00.000000000 Z
+date: 2015-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,16 +56,16 @@ dependencies:
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.5
 description: Blazing-fast-cross-platform-monkey-patch-free string XOR. Yes, that means
   JRuby too.
 email:
@@ -76,17 +76,12 @@ extensions:
 extra_rdoc_files: []
 files:
 - README.md
-- ext/xorcist/Xorcist.java
-- ext/xorcist/XorcistService.java
 - ext/xorcist/extconf.rb
 - ext/xorcist/xorcist.c
 - lib/xorcist.rb
 - lib/xorcist/refinements.rb
 - lib/xorcist/string_methods.rb
 - lib/xorcist/version.rb
-- test/refinements_test.rb
-- test/test_helper.rb
-- test/xorcist_test.rb
 homepage: https://github.com/fny/xorcist
 licenses:
 - MIT

data/ext/xorcist/Xorcist.java

@@ -1,22 +0,0 @@
-import org.jruby.anno.JRubyMethod;
-import org.jruby.runtime.ThreadContext;
-import org.jruby.runtime.builtin.IRubyObject;
-import org.jruby.RubyString;
-import org.jruby.util.ByteList;
-
-public class Xorcist {
-    @JRubyMethod(name = "xor!", module = true)
-    public static RubyString xorInPlace(ThreadContext context, IRubyObject self, RubyString x, RubyString y) {
-        byte[] xBytes = x.getBytes();
-        byte[] yBytes = y.getBytes();
-
-        int length = yBytes.length < xBytes.length ? yBytes.length : xBytes.length;
-
-        for(int i = 0; i < length; i++) {
-            xBytes[i] = (byte) (xBytes[i] ^ yBytes[i]);
-        }
-
-        x.setValue(new ByteList(xBytes));
-        return x;
-    }
-}

data/ext/xorcist/XorcistService.java

@@ -1,14 +0,0 @@
-import java.io.IOException;
-
-import org.jruby.Ruby;
-import org.jruby.RubyModule;
-import org.jruby.runtime.load.BasicLibraryService;
-
-public class XorcistService implements BasicLibraryService {
-    @Override
-    public boolean basicLoad(final Ruby runtime) throws IOException {
-        RubyModule xorcist = runtime.defineModule("Xorcist");
-        xorcist.defineAnnotatedMethods(Xorcist.class);
-        return true;
-    }
-}

data/test/refinements_test.rb

@@ -1,23 +0,0 @@
-require 'test_helper'
-
-if RUBY_ENGINE != 'jruby' && RUBY_ENGINE != 'rbx' && RUBY_VERSION >= '2.0.0'
-  require 'xorcist/refinements'
-
-  class RefinementsTest < Minitest::Test
-    using Xorcist::Refinements
-
-    def test_xor
-      assert_equal ZERO, X.xor(X)
-      assert_equal ONE,  X.xor(INVX)
-      assert_equal X,    X.xor(ZERO)
-      assert_equal INVX, X.xor(ONE)
-    end
-
-    def test_xor_in_place
-      a = "String"
-      b = a
-      b.xor!(X)
-      assert_equal(a, b)
-    end
-  end
-end

data/test/test_helper.rb

@@ -1,11 +0,0 @@
-require 'xorcist'
-
-require 'minitest'
-require 'minitest/autorun'
-require 'minitest/pride'
-
-LEN  = 16
-ZERO = ([0x00].pack('C') * LEN).freeze
-ONE  = ([0xFF].pack('C') * LEN).freeze
-X    = (0...LEN).collect { rand 256 }.pack('C*').freeze
-INVX = (0...LEN).collect { |i| X[i].ord ^ 0xFF }.pack('C*').freeze

data/test/xorcist_test.rb

@@ -1,42 +0,0 @@
-require 'test_helper'
-
-class XorcistTest < Minitest::Test
-  include Xorcist
-
-  def test_xor
-    assert_equal ZERO, xor(X, X)
-    assert_equal ONE,  xor(X, INVX)
-    assert_equal X,    xor(X, ZERO)
-    assert_equal INVX, xor(X, ONE)
-  end
-
-  def test_xor_in_place
-    a = "String"
-    b = a
-    xor!(b, X)
-    assert_equal(a, b)
-  end
-
-  #
-  # Tests for different string storage behaviors in MRI.
-  # See http://patshaughnessy.net/2012/1/4/never-create-ruby-strings-longer-than-23-characters
-  # for details.
-  # Might as well run them in other Rubies too.
-  #
-
-  def test_embedded_string
-    a = "Embedded string"
-    assert a.size <= 23
-    b = a.dup
-    xor!(b, X)
-    refute_equal(a, b)
-  end
-
-  def test_heap_string
-    a = "A very long string that's stored on the heap"
-    assert a.size > 24
-    b = a.dup
-    xor!(b, X*2)
-    refute_equal(a, b)
-  end
-end