bloomer 0.0.5 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 683b2bd1b28f30606dd8f96ab85ea18a98e1a198d38b10f823563ba6893d1454
+  data.tar.gz: 8f26b8793a08d01b401d727fc0371990f948d2e69d01cdcb1d2e1dc83e742830
+SHA512:
+  metadata.gz: 53af08a56920e8d6e146a44032151facc1e507c3bb9b21e0a9a203c60339039b2e0e9241a79cdafcb1d6f90ef326e8202252163af811e70373c30608ba3fa2f2
+  data.tar.gz: ce375fc18e7531cb2b6455df625034cf0881db9294a41945a9ef1789f2aa649ae7d8037a2205bc32e34113be765bc7f3e71c7b3be06a1cd7e47cb1553552c7ac

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 script: bundle exec rake
 rvm:
-  - 1.8.7
-  - 1.9.3
-  - jruby-18mode # JRuby in 1.8 mode
-  - jruby-19mode # JRuby in 1.9 mode
+  - 2.5.1
+  - 2.4.4
+  - jruby-9.1.17.0
+  - jruby-9.2.0.0

data/README.md

@@ -1,32 +1,36 @@
 # Bloomer: Bloom filters with elastic
 
-[![Build Status](https://secure.travis-ci.org/mceachen/bloomer.png)](http://travis-ci.org/mceachen/bloomer)
+[![Gem Version](https://badge.fury.io/rb/bloomer.svg)](https://badge.fury.io/rb/bloomer)
+[![Build Status](https://secure.travis-ci.org/mceachen/bloomer.svg)](http://travis-ci.org/mceachen/bloomer)
 
-[Bloom filters](http://en.wikipedia.org/wiki/Bloom_filter) are great for quickly checking to see if
-a given string has been seen before--in constant time, and using a fixed amount of RAM, as long
-as you know the expected number of elements up front. If you add more than ```capacity``` elements to the filter,
-accuracy for ```include?``` will drop below ```false_positive_probability```.
+[Bloom filters](http://en.wikipedia.org/wiki/Bloom_filter) are great for quickly
+checking to see if a given string has been seen before--in constant time, and
+using a fixed amount of RAM, as long as you know the expected number of elements
+up front. If you add more than `capacity` elements to the filter, accuracy for
+`include?` will drop below `false_positive_probability`.
 
-[Scalable Bloom Filters](http://gsd.di.uminho.pt/members/cbm/ps/dbloom.pdf) maintain a maximal ```false_positive_probability```
-by using additional RAM as needed.
+[Scalable Bloom Filters](http://gsd.di.uminho.pt/members/cbm/ps/dbloom.pdf)
+maintain a maximal `false_positive_probability` by using additional RAM as
+needed.
 
-```Bloomer``` is a Bloom Filter. ```Bloomer::Scalable``` is a Scalable Bloom Filter.
+`Bloomer` is a Bloom Filter. `Bloomer::Scalable` is a Scalable Bloom Filter.
 
-Keep in mind that **false positives with Bloom filters are expected**, with a specified probability rate.
-False negatives, however, are not. In other words,
+Keep in mind that **false positives with Bloom filters are expected**, with a
+specified probability rate. False negatives, however, are not. In other words,
 
-* if ```include?``` returns *false*, that string has *certainly not* been ```add```ed
-* if ```include?``` returns *true*, it *might* mean that string was ```add```ed (depending on the
-```false_positive_probability``` parameter provided to the constructor).
+- if `include?` returns _false_, that string has _certainly not_ been `add`ed
+- if `include?` returns _true_, it _might_ mean that string was `add`ed
+  (depending on the `false_positive_probability` parameter provided to the
+  constructor).
 
 This implementation is unique in that Bloomer
 
-* supports scalable bloom filters (SBF)
-* uses triple hash chains (see [the paper](http://www.ccs.neu.edu/home/pete/pub/bloom-filters-verification.pdf))
-* can marshal state quickly
-* has rigorous tests
-* is pure ruby
-* does not require EM or Redis or something else unrelated to simply implementing a bloom filter
+- supports scalable bloom filters (SBF)
+- uses triple hash chains (see [the paper](http://www.ccs.neu.edu/home/pete/pub/bloom-filters-verification.pdf))
+- can marshal state quickly
+- has rigorous tests
+- is pure ruby
+- does not require EM or Redis or something else unrelated to simply implementing a bloom filter
 
 ## Usage
 
@@ -52,30 +56,57 @@ bf.include? "badda"
 #=> false
 ```
 
-Serialization is through [Marshal](http://ruby-doc.org/core-1.8.7/Marshal.html):
+Serialization can be done using
+[MessagePack](https://github.com/msgpack/msgpack-ruby):
+
+Notice, you'll need to require `bloomer/msgpackable` to enable serialization.
 
 ```ruby
+require 'bloomer/msgpackable'
 b = Bloomer.new(10)
 b.add("a")
-s = Marshal.dump(b)
-new_b = Marshal.load(s)
+s = b.to_msgpack
+new_b = Bloomer.from_msgpack(s)
 new_b.include? "a"
 #=> true
 ```
 
+The original class will be preserved regardless of calling
+`Bloomer.from_msgpack(s)` or `Bloomer::Scalable.from_msgpack(s)`:
+
+```ruby
+require 'bloomer/msgpackable'
+b = Bloomer::Scalable.new
+b.add("a")
+s = b.to_msgpack
+new_b = Bloomer.from_msgpack(s)
+new_b.class == Bloomer::Scalable
+#=> true
+```
+
 ## Changelog
 
+### 1.0.0
+
+- Using msgpack for more secure deserialization. Marshal.load still works but is
+  not recommended
+
 ### 0.0.5
-* Switched from rspec to minitest
+
+- Switched from rspec to minitest
 
 ### 0.0.4
-* Fixed gem packaging
+
+- Fixed gem packaging
 
 ### 0.0.3
-* Added support for scalable bloom filters (SBF)
+
+- Added support for scalable bloom filters (SBF)
 
 ### 0.0.2
-* Switch to triple-hash chaining (simpler, faster, and better false-positive rate)
+
+- Switch to triple-hash chaining (simpler, faster, and better false-positive rate)
 
 ### 0.0.1
-* Bloom, there it is.
+
+- Bloom, there it is.

data/bloomer.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency "bitarray"
+  s.add_dependency "msgpack"
   s.add_development_dependency "rake"
   s.add_development_dependency "yard"
   s.add_development_dependency "minitest"

data/lib/bloomer/msgpackable.rb

@@ -0,0 +1,65 @@
+require "msgpack"
+
+module Msgpackable
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  def to_msgpack
+    self.class.msgpack_factory.dump self
+  end
+
+  module ClassMethods
+    def from_msgpack(data)
+      msgpack_factory.load(data)
+    end
+
+    def msgpack_factory
+      @msgpack_factory ||= ::MessagePack::Factory.new.tap do |factory|
+        factory.register_type(0x01, ::Bloomer)
+        factory.register_type(0x02, ::Bloomer::Scalable)
+        factory.freeze
+      end
+    end
+  end
+end
+
+# Patch Bloomer and Scalable to make them msgpackable
+class Bloomer
+  include Msgpackable
+
+  def to_msgpack_ext
+    self.class.msgpack_factory.dump([@capacity, @count, @k, @ba.size, @ba.field])
+  end
+
+  def from_msgpack_ext(capacity, count, k, ba_size, ba_field)
+    @capacity, @count, @k = capacity, count, k
+    @ba = BitArray.new(ba_size, ba_field)
+  end
+
+  def self.from_msgpack_ext(data)
+    values = msgpack_factory.load(data)
+    ::Bloomer.new(values[1]).tap do |b|
+      b.from_msgpack_ext(*values)
+    end
+  end
+
+  class Scalable
+    include Msgpackable
+
+    def to_msgpack_ext
+      self.class.msgpack_factory.dump([@false_positive_probability, @bloomers])
+    end
+
+    def from_msgpack_ext(false_positive_probability, bloomers)
+      @false_positive_probability, @bloomers = false_positive_probability, bloomers
+    end
+
+    def self.from_msgpack_ext(data)
+      false_positive_probability, bloomers = msgpack_factory.load(data)
+      ::Bloomer::Scalable.new.tap do |b|
+        b.from_msgpack_ext(false_positive_probability, bloomers)
+      end
+    end
+  end
+end

data/lib/bloomer/version.rb

@@ -1,3 +1,3 @@
 class Bloomer
-  VERSION = "0.0.5"
+  VERSION = "1.0.0"
 end

data/test/bloomer_test.rb

@@ -1,6 +1,7 @@
 require "test_helper"
 
 C = ('a'..'z').to_a
+
 def rand_word(length = 8)
   C.shuffle.first(length).join # not random enough to cause hits.
 end
@@ -43,6 +44,20 @@ def test_marshal_state(b)
   inputs.each { |ea| new_b.must_include(ea) }
 end
 
+def test_msgpackable(b)
+  require "bloomer/msgpackable"
+  inputs = b.capacity.times.collect { rand_word }
+  inputs.each { |ea| b.add(ea) }
+  packed = b.to_msgpack
+  new_b = b.class.from_msgpack(packed)
+  new_b.count.must_equal b.count
+  new_b.capacity.must_equal b.capacity
+  inputs.each { |ea| new_b.must_include(ea) }
+  dump = Marshal.dump(b)
+  packed.size.must_be :<, dump.size
+  b.class.must_equal new_b.class
+end
+
 def test_simple(b)
   b.add("a").must_equal true
   b.add("a").must_equal false
@@ -68,6 +83,11 @@ describe Bloomer do
     test_marshal_state(b)
   end
 
+  it "serializes and deserializes correctly" do
+    b = Bloomer.new(10, 0.001)
+    test_msgpackable(b)
+  end
+
   it "results in similar-to-expected false positives" do
     max_false_prob = 0.001
     size = 50_000
@@ -88,6 +108,12 @@ describe Bloomer::Scalable do
     test_marshal_state(b)
   end
 
+  it "serializes and deserializes correctly" do
+    b = Bloomer::Scalable.new(10, 0.001)
+    100.times.each { b.add(rand_word) }
+    test_msgpackable(b)
+  end
+
   it "results in similar-to-expected false positives" do
     max_false_prob = 0.001
     size = 10_000

metadata

@@ -1,94 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: bloomer
 version: !ruby/object:Gem::Version
-  version: 0.0.5
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Matthew McEachen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-25 00:00:00.000000000 Z
+date: 2018-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bitarray
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  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
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Bloom filters and Scalable Bloom filters (SBF) in pure ruby
@@ -98,48 +101,39 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - MIT-LICENSE
 - README.md
 - Rakefile
 - bloomer.gemspec
 - lib/bloomer.rb
+- lib/bloomer/msgpackable.rb
 - lib/bloomer/version.rb
 - test/bloomer_test.rb
 - test/test_helper.rb
 homepage: https://github.com/mceachen/bloomer
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2624379326334183946
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2624379326334183946
 requirements: []
 rubyforge_project: bloomer
-rubygems_version: 1.8.21
+rubygems_version: 2.7.7
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Bloom filters and Scalable Bloom filters (SBF) in pure ruby
-test_files:
-- test/bloomer_test.rb
-- test/test_helper.rb
-has_rdoc: 
+test_files: []