fast_bitset 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f257a199fff980744ceef1b86cce05184f0c5989
+  data.tar.gz: a29eca895c4d5230939aaa3266c630b55b605b14
+SHA512:
+  metadata.gz: 27135de3fc4405d6fb72ce09bc73cae66ca9df436f423d497dca8aba5615cfb5b81a37db1ee9f0bf8b7e3b9540460345940c28c2d96e3dadd28c82c27f0554fd
+  data.tar.gz: 025cb57d7be070c63f46eef2740cc992f392643fb80e898151c69e31274fcdcb01cbf3d6ed08c8305f15c7bd926ef86d50f4717781b01617e0e6eae37ffcb419

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+*.bundle
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fast_bitset.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Darcy Laycock
+
+MIT License
+
+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,29 @@
+# FastBitset
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fast_bitset'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fast_bitset
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/fast_bitset/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/extensiontask"
+require 'rspec/core/rake_task'
+
+Rake::ExtensionTask.new("fast_bitset") do |ext|
+  ext.lib_dir = "lib/fast_bitset"
+end
+
+RSpec::Core::RakeTask.new(:spec)
+task default: [:compile, :spec]

data/ext/fast_bitset/extconf.rb

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

data/ext/fast_bitset/fast_bitset.c

@@ -0,0 +1,45 @@
+#include "ruby.h"
+#include "./fast_bitset.h"
+
+VALUE FastBitsetModule = Qnil;
+
+VALUE rb_fast_bitset_get_ids(VALUE self, VALUE bitstring) {
+  VALUE ids = rb_ary_new();
+
+  Check_Type(bitstring, T_STRING);
+
+
+  char *ids_input = RSTRING_PTR(bitstring);
+  int length      = RSTRING_LEN(bitstring);
+
+  int base = 0;
+
+  char current;
+  int i, j;
+
+  for(i = 0; i < length; i++) {
+    current = ids_input[i];
+
+
+    for(j = 0; j < 8; j++) {
+      char bitmask = (1<<(7-j));
+      if(bitmask & current) {
+        rb_ary_push(ids, INT2NUM(base + j));
+      } 
+    }
+
+    base += 8;
+  }
+
+  return ids;
+}
+
+void rb_init_fast_bitset() {
+  rb_define_module_function(FastBitsetModule, "native_bitstring_to_ids", rb_fast_bitset_get_ids, 1);
+}
+
+void Init_fast_bitset()
+{
+    FastBitsetModule = rb_define_module("FastBitset");
+    rb_init_fast_bitset();
+}

data/ext/fast_bitset/fast_bitset.h

@@ -0,0 +1,5 @@
+#include "ruby.h"
+
+void rb_init_fast_bitset();
+
+VALUE rb_fast_bitset_get_ids(VALUE self, VALUE bitstring);

data/fast_bitset.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fast_bitset/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fast_bitset"
+  spec.version       = FastBitset::VERSION
+  spec.authors       = ["Darcy Laycock", "Matt Delves", "Matt Allen"]
+  spec.email         = ["sutto@sutto.net"]
+  spec.summary       = %q{Fast Bit String to Ruby Arrays of IDs, using C for magical speediness. Perfect for use with Redis Bit sets}
+  spec.homepage      = "https://github.com/Sutto/fast_bitset"
+  spec.license       = "MIT"
+
+  spec.platform      = Gem::Platform::RUBY
+  spec.extensions    = Dir["ext/**/extconf.rb"]
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+
+  spec.add_development_dependency "rake-compiler"
+  spec.add_development_dependency "rspec", "~> 2.0"
+end

data/lib/fast_bitset/version.rb

@@ -0,0 +1,3 @@
+module FastBitset
+  VERSION = "0.0.1"
+end

data/lib/fast_bitset.rb

@@ -0,0 +1,32 @@
+require "fast_bitset/version"
+
+module FastBitset
+
+  def self.pure_bitstring_to_ids(value)
+    unless value.is_a?(String)
+      raise TypeError.new("wrong argument type #{value.class} (expected String)")
+    end
+    offset = 0
+    ids    = []
+    return ids if value.nil?
+    value.each_byte do |byte|
+      7.downto(0) do |i|
+        value = (1<<i)
+        ids << offset if (value & byte) == value
+        offset += 1
+      end
+    end
+    ids
+  end
+
+  begin
+    # Load the native version.
+    require 'fast_bitset/fast_bitset'
+    class << self
+      alias bitstring_to_ids native_bitstring_to_ids
+    end
+  rescue LoadError
+    alias bitstring_to_ids pure_bitstring_to_ids
+  end
+
+end

data/spec/fast_bitset_spec.rb

@@ -0,0 +1,51 @@
+require 'rspec'
+require 'fast_bitset'
+
+describe FastBitset do
+
+  shared_examples_for 'a bit set implementation' do
+
+    it 'raises an error with a non string' do
+      expect { convert(0) }.to raise_error TypeError
+      expect { convert(nil) }.to raise_error TypeError
+    end
+
+    it 'works with empty strings' do
+      expect(convert("")).to eq []
+    end
+
+    it 'works with trivial cases' do
+      expect(convert(0b11111111.chr)).to eq [0, 1, 2, 3, 4, 5, 6, 7]
+      expect(convert(0b00000000.chr)).to eq []
+      expect(convert(0b11111110.chr)).to eq [0, 1, 2, 3, 4, 5, 6]
+      expect(convert(0b11100000.chr)).to eq [0, 1, 2]
+      expect(convert(0b10000001.chr)).to eq [0, 7]
+      expect(convert(0b01011011.chr)).to eq [1, 3, 4, 6, 7]
+    end
+
+    it 'works with complex cases' do
+      expect(convert("\x0F\x0F")).to eq [4, 5, 6, 7, 12, 13, 14, 15]
+      expect(convert("\x00\x00")).to eq []
+      expect(convert("\x00\x0F")).to eq (12..15).to_a
+      expect(convert("\x00\x01")).to eq [15]
+      expect(convert("\xFF\xFF")).to eq (0..15).to_a
+    end
+
+    it 'works with amusing emoji' do
+      # Test Data courtesy @mattallen
+      expect(convert("💩")).to eq [0, 1, 2, 3, 8, 11, 12, 13, 14, 15, 16, 19, 22, 24, 26, 28, 31]
+    end
+
+  end
+
+  describe '.native_bitstring_to_ids' do
+    def convert(value); FastBitset.native_bitstring_to_ids(value); end
+    it_behaves_like 'a bit set implementation'
+  end
+
+  describe '.pure_bitstring_to_ids' do
+    def convert(value); FastBitset.pure_bitstring_to_ids(value); end
+    it_behaves_like 'a bit set implementation'
+  end
+
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: fast_bitset
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Darcy Laycock
+- Matt Delves
+- Matt Allen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- sutto@sutto.net
+executables: []
+extensions:
+- ext/fast_bitset/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/fast_bitset/extconf.rb
+- ext/fast_bitset/fast_bitset.c
+- ext/fast_bitset/fast_bitset.h
+- fast_bitset.gemspec
+- lib/fast_bitset.rb
+- lib/fast_bitset/version.rb
+- spec/fast_bitset_spec.rb
+homepage: https://github.com/Sutto/fast_bitset
+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: Fast Bit String to Ruby Arrays of IDs, using C for magical speediness. Perfect
+  for use with Redis Bit sets
+test_files:
+- spec/fast_bitset_spec.rb