xorcist 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 793234244f107edb7c72b40c9781eb02e9764a57
+  data.tar.gz: aeeaf63a70d085e9900d4023feb461b2e8a13518
+SHA512:
+  metadata.gz: dbf415060c191c8cca73230f9e78af36ef5a8e1e14fb3adb777ca8fd86fc18d590666ab2187356bd4b7d6d6394babbea90979302581d8ecd2453a27d48a0bdb1
+  data.tar.gz: bbe34eed87957f7144e5962330d42ffcc611927f353075d09854670accef29fc26a563b9e8125abb631b9c1ca184089d6d43343bf2e37fb4f3956c65cd4508c7

data/README.md

@@ -0,0 +1,104 @@
+# Xorcist :ghost:
+
+[![Gem Version](https://badge.fury.io/rb/xorcist.svg)](http://badge.fury.io/rb/xorcist)
+[![Build Status](https://travis-ci.org/fny/xorcist.svg?branch=master)](https://travis-ci.org/fny/xorcist)
+
+Blazing-fast-cross-platform-monkey-patch-free string XOR. Yes, that means JRuby too.
+
+## Usage
+
+```ruby
+require 'xorcist'
+
+a, b = 'a', 'b'
+Xorcist.xor(a, b)
+Xorcist.xor!(a, b)
+```
+
+You can `include Xorcist` to expose its methods:
+
+```ruby
+require 'xorcist'
+include Xorcist
+
+a, b = 'a', 'b'
+xor(a, b)
+xor!(a, b)
+```
+
+Refinements on `String` are also available:
+
+```ruby
+require 'xorcist'
+require 'xorcist/refinements'
+using Xorcist::Refinements
+
+a, b = 'a', 'b'
+a.xor(b)
+a.xor!(b)
+```
+
+You can also monkey patch `String` if you're into that:
+
+```ruby
+require 'xorcist'
+require 'xorcist/string_methods'
+String.include(Xorcist::StringMethods)
+```
+
+## Benchmarks
+
+Disclaimer: these are run from my craptop. Run 'em yourself with `bin/benchmark`.
+
+### MRI 2.2.1
+
+```
+Calculating -------------------------------------
+                ruby    11.136k i/100ms
+             xorcist    71.472k i/100ms
+-------------------------------------------------
+                ruby    144.198k (± 1.3%) i/s -    723.840k
+             xorcist      2.155M (± 0.7%) i/s -     10.792M
+```
+
+### JRuby 1.7.19
+
+```
+Calculating -------------------------------------
+                ruby   142.000  i/100ms
+             xorcist    88.006k i/100ms
+-------------------------------------------------
+                ruby      3.113k (±32.6%) i/s -     11.218k in   5.781000s
+             xorcist      3.184M (±32.9%) i/s -     12.321M
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xorcist'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xorcist
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fny/xorcist. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## 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/]
+ - To all [contributers](https://github.com/fny/xorcist/graphs/contributors)! :beers:
+

data/ext/xorcist/Xorcist.java

@@ -0,0 +1,22 @@
+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

@@ -0,0 +1,14 @@
+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/ext/xorcist/extconf.rb

@@ -0,0 +1,4 @@
+require 'mkmf'
+extension_name = 'xorcist'
+dir_config(extension_name)
+create_makefile(extension_name)

data/ext/xorcist/xorcist.c

@@ -0,0 +1,36 @@
+#include "ruby.h"
+
+VALUE Xorcist = Qnil;
+
+void Init_xorcist();
+
+VALUE xor_in_place(VALUE x, VALUE y, VALUE self);
+
+VALUE xor_in_place(VALUE self, VALUE x, VALUE y) {
+    const char *src = 0;
+    char *dest = 0;
+    size_t len;
+    size_t y_len;
+
+    rb_str_modify(x);
+    dest = RSTRING_PTR(x);
+    len = RSTRING_LEN(x);
+
+    src = RSTRING_PTR(y);
+    y_len = RSTRING_LEN(y);
+
+    if (y_len < len) {
+        len = y_len;
+    }
+
+    for (; len--; ++dest, ++src) {
+        *dest ^= *src;
+    }
+
+    return x;
+}
+
+void Init_xorcist() {
+    Xorcist = rb_define_module("Xorcist");
+    rb_define_module_function(Xorcist, "xor!", xor_in_place, 2);
+}

data/lib/xorcist.rb

@@ -0,0 +1,15 @@
+require 'xorcist/version'
+
+if RUBY_ENGINE == 'jruby'
+  require 'jruby'
+  require File.expand_path('../xorcist.jar', __FILE__)
+else
+  require File.expand_path('../xorcist.so', __FILE__)
+end
+
+module Xorcist
+  module_function
+  def xor(x, y)
+    xor!(x.dup, y)
+  end
+end

data/lib/xorcist/refinements.rb

@@ -0,0 +1,9 @@
+require 'xorcist/string_methods'
+
+module Xorcist
+  module Refinements
+    refine String do
+      include Xorcist::StringMethods
+    end
+  end
+end

data/lib/xorcist/string_methods.rb

@@ -0,0 +1,11 @@
+module Xorcist
+  module StringMethods
+    def xor(other)
+      Xorcist.xor(self, other)
+    end
+
+    def xor!(other)
+      Xorcist.xor!(self, other)
+    end
+  end
+end

data/lib/xorcist/version.rb

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

data/test/refinements_test.rb

@@ -0,0 +1,23 @@
+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

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,42 @@
+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

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: xorcist
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Faraz Yashar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.7.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  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: Blazing-fast-cross-platform-monkey-patch-free string XOR. Yes, that means
+  JRuby too.
+email:
+- faraz.yashar@gmail.com
+executables: []
+extensions:
+- ext/xorcist/extconf.rb
+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
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Blazing-fast-cross-platform-monkey-patch-free string XOR
+test_files: []