bloom_filter 0.5.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Arya Asemanfar
+
+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.rdoc

@@ -0,0 +1,18 @@
+= bloom_filter
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Arya Asemanfar. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "bloom_filter"
+    gem.summary = %Q{A simple Ruby BloomFilter implementation, usable in-process or in a client-server model.}
+    gem.description = %Q{}
+    gem.email = "misterfunnyarsal@gmail.com"
+    gem.homepage = "http://github.com/arya/bloom_filter"
+    gem.authors = ["Arya Asemanfar"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    gem.add_dependency "eventmachine", ">=0.12.8"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "bloom_filter #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/bin/bloom_filter_server

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'optparse'
+require 'bloom_filter/server'
+
+options = {:host => "localhost", :port => 4111}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: bloom_filter_server -n"
+  opts.on('-n', "--estimated-items N", "Estimated number of elements in the set") do |n|
+    options[:n] = n.to_i
+  end
+
+  opts.on('-p', "--probability P", "Desired false positive probability") do |p|
+    options[:p] = p.to_f
+  end
+
+  opts.on("-i", "--interface HOST:PORT", "Host and port to listen on") do |host_port|
+    options[:host], options[:port] = host_port.split(":")
+    options[:port] = options[:port].to_i
+  end
+end.parse!
+
+
+EM.run do
+  EM.start_server(options[:host], options[:port], BloomFilter.new_server(options[:n], options[:p]))
+end

data/lib/bloom_filter.rb

@@ -0,0 +1,51 @@
+require 'zlib'
+
+class BloomFilter
+  BITS_PER_FIXNUM = 31 # this can really be more on 64-bit systems
+  DUMP_SEPARATOR = "\n"
+  
+  def self.optimal_values(estimated_elements, probability)
+    m = -(estimated_elements * Math.log(probability)) / (Math.log(2) ** 2)
+    k = 0.7 * (m / estimated_elements)
+    [m.round, k.round]
+  end
+  
+  def self.load(dumped)
+    m, k, *bits = dumped.split(DUMP_SEPARATOR).collect { |v| v.to_i }
+    new(m, k, bits)
+  end
+  
+  def initialize(m, k, bits = nil)
+    @k = k
+    @m = m
+    @bits = bits || Array.new((m.to_f / BITS_PER_FIXNUM).ceil, 0)
+  end
+  
+  def add(el)
+    @k.times do |i|
+      self.set_bit(Zlib.crc32("#{i}#{el}") % @m)
+    end
+  end
+  
+  def include?(el)
+    @k.times do |i|
+      return false if !bit_set?(Zlib.crc32("#{i}#{el}") % @m)
+    end
+    true
+  end
+  
+  def dump
+    [@m, @k, *@bits].join(DUMP_SEPARATOR)
+  end
+  
+  protected
+  def set_bit(n)
+    index, offset = n / BITS_PER_FIXNUM, n % BITS_PER_FIXNUM
+    @bits[index] |= 1 << offset
+  end
+  
+  def bit_set?(n)
+    index, offset = n / BITS_PER_FIXNUM, n % BITS_PER_FIXNUM
+    (@bits[index] & (1 << offset)) > 0
+  end
+end

data/lib/bloom_filter/client.rb

@@ -0,0 +1,86 @@
+require 'socket'
+require 'bloom_filter/protocol'
+
+class BloomFilter
+  class Client
+    PACK_N = "N"
+    def initialize(host, port, options = {})
+      @host, @port = host, port
+      @timeout = options[:timeout]
+      reconnect
+    end
+  
+    def add(el)
+      el = el.to_s
+      @socket.write("#{[el.size + 1].pack(PACK_N)}#{Protocol::ADD}#{el}")
+      timeout_or_default(false) do
+        @socket.read(@socket.read(4).unpack(PACK_N).first) == Protocol::TRUE
+      end
+    end
+    alias_method :<<, :add
+  
+    def include?(el)
+      el = el.to_s
+      @socket.write("#{[el.size + 1].pack(PACK_N)}#{Protocol::INCLUDE}#{el}")
+      timeout_or_default(true) do
+        @socket.read(@socket.read(4).unpack(PACK_N).first) == Protocol::TRUE
+      end
+    end
+  
+    def &(els)
+      if els.size == 1
+        el = els.first
+        self.include?(el) ? [el] : []
+      else
+        elements = els.collect { |el| el.to_s }.join(Protocol::DEFAULT_SEPARATOR)
+        @socket.write("#{[elements.size + 1].pack(PACK_N)}#{Protocol::INCLUDE_MANY}#{elements}")
+        
+        timeout_or_default(els) do
+          response = @socket.read(@socket.read(4).unpack(PACK_N).first)
+          result = []
+          els.size.times do |i|
+            result << els[i] if response[i,1] == Protocol::TRUE
+          end
+          result
+        end
+      end
+    end
+    
+    def dump(path, timeout = nil)
+      @socket.write("#{[path.size + 1].pack(PACK_N)}#{Protocol::DUMP}#{path}")
+      timeout_or_default(false, timeout) do
+        @socket.read(@socket.read(4).unpack(PACK_N).first) == Protocol::TRUE
+      end
+    end
+    
+    def load(path, timeout = nil)
+      @socket.write("#{[path.size + 1].pack(PACK_N)}#{Protocol::LOAD}#{path}")
+      timeout_or_default(false, timeout) do
+        @socket.read(@socket.read(4).unpack(PACK_N).first) == Protocol::TRUE
+      end
+    end
+    
+    def reconnect
+      @socket.close if @socket && !@socket.closed?
+      @socket = begin
+        TCPSocket.new(@host, @port)
+      rescue Exception => e
+        nil
+      end
+    end
+    
+    def connected?
+      !!(@socket && !@socket.closed?)
+    end
+    
+    private
+    def timeout_or_default(default, timeout = nil, &block)
+      ready = IO.select([@socket], nil, nil, timeout || @timeout)
+      if ready
+        block.call
+      else
+        default
+      end
+    end
+  end
+end

data/lib/bloom_filter/protocol.rb

@@ -0,0 +1,13 @@
+class BloomFilter
+  module Protocol
+    FALSE = "0"
+    TRUE = "1"
+    DEFAULT_SEPARATOR = ","    
+    ADD = 0
+    INCLUDE = 1
+    INCLUDE_MANY = 2
+    ADD_MANY = 3
+    DUMP = 4 # TODO
+    LOAD = 5 # TODO
+  end
+end

data/lib/bloom_filter/server.rb

@@ -0,0 +1,91 @@
+require 'bloom_filter'
+require 'bloom_filter/protocol'
+require 'eventmachine'
+
+
+class BloomFilter
+  def self.new_server(n, p)
+    klass = Class.new(Server)
+    klass.filter = BloomFilter.new(*BloomFilter.optimal_values(n, p))
+    klass
+  end
+  
+  class Server < EM::Connection
+    PACK_N = "N"
+  
+    def self.filter
+      @filter
+    end
+    
+    def self.filter=(filter)
+      @filter = filter
+    end
+    
+    def post_init
+      @buffer = nil
+      @size = nil
+    end
+
+    def receive_data(data)
+      @buffer ||= ""
+      @buffer << data
+
+      if !@size && @buffer.size > 4
+        @size, @buffer = @buffer[0,4].unpack(PACK_N).first, @buffer[4..-1]
+      end
+
+      if @size && @buffer.size >= @size
+        if @buffer.size > @size
+          request, remainder = @buffer[0, @size], @buffer[@size..-1]
+          @buffer = nil
+          @size = nil
+          process_request(request)
+
+          receive_data(remainder)
+        else
+          process_request(@buffer)
+          @buffer = nil
+          @size = nil        
+        end
+      end
+    end
+
+    def process_request(request)
+      request_type, request_body = request[0,1], request[1..-1]
+      case request_type.to_i
+      when Protocol::ADD
+        self.class.filter.add(request_body)
+        write_response(true)
+      when Protocol::ADD_MANY
+        # TODO: support specifying a delimiter
+        request_body.split(Protocol::DEFAULT_SEPARATOR).collect { |el| self.class.filter.add(el) }
+      when Protocol::INCLUDE
+        write_response(self.class.filter.include?(request_body))
+      when Protocol::INCLUDE_MANY
+        # TODO: support specifying a delimiter
+        write_response(request_body.split(Protocol::DEFAULT_SEPARATOR).collect { |el| self.class.filter.include?(el) })
+      when Protocol::DUMP
+        begin
+          File.open(request_body, "w") do |f|
+            f.write(self.class.filter.dump)
+          end
+          write_response(true)
+        rescue Exception => e
+          write_response(false)
+        end
+      when Protocol::LOAD
+        begin
+          self.class.filter = BloomFilter.load(File.read(request_body))
+          write_response(true)
+        rescue Exception => e
+          write_response(false)
+        end
+      end
+    end
+
+    def write_response(response)
+      str = Array(response).inject("") { |s, t| s << (t ? Protocol::TRUE : Protocol::FALSE) }
+      send_data([str.size].pack(PACK_N) + str)
+    end
+  end
+end

data/test/bloom_filter_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class BloomFilterTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'bloom_filter'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: bloom_filter
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+platform: ruby
+authors: 
+- Arya Asemanfar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-22 00:00:00 -08:00
+default_executable: bloom_filter_server
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.12.8
+    version: 
+description: ""
+email: misterfunnyarsal@gmail.com
+executables: 
+- bloom_filter_server
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/bloom_filter_server
+- lib/bloom_filter.rb
+- lib/bloom_filter/client.rb
+- lib/bloom_filter/protocol.rb
+- lib/bloom_filter/server.rb
+- test/bloom_filter_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/arya/bloom_filter
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A simple Ruby BloomFilter implementation, usable in-process or in a client-server model.
+test_files: 
+- test/bloom_filter_test.rb
+- test/test_helper.rb