json-bloomfilter 0.0.4 → 0.0.5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    json-bloomfilter (0.0.4)
+    json-bloomfilter (0.0.5)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -1,10 +1,18 @@
-# JSON Bloomfilter
+# Serialisable (JSON) Bloom Filter
 
-A BloomFilter implementation that is serialisable to JSON and compatible between both Ruby and Javascript. Very useful when needing to train a bloom filter in one language and using it in the other.
+A bloom filter implementation that is serialisable to JSON and compatible between both Ruby and Javascript. Very useful when needing to train a bloom filter in one language and using it in the other.
 
-## Usage
+## Why?
+
+Bloom filters allow for space efficient lookups in a list, without having to store all the items in the list. This is useful for looking up tags, domain names, links, or anything else that you might want to do client side.
+
+What this Gem allows you to do is build a bloom filter server side, add all your entries to it, and then serialise the filter to JSON. On the client side you can then load up the serialised data into the Javascript version and use the bloom filter as is.
 
-### Installation
+All of this while not sending the entire list to the client, which is something you might not want to do for either security or efficiency reasons.
+
+## Installation
+
+### Ruby
 
 ```shell
 gem install json-bloomfilter
@@ -18,6 +26,18 @@ gem 'json-bloomfilter'
 
 in your Gemfile
 
+### Javascript
+
+With the gem installed run
+
+```
+json-bloomfilter install
+```
+
+and the `json-bloomfilter.min.js` will be copied to your local directory. If you are in a Rail project it will be copied to your `app/assets/javascripts` folder.
+
+## Usage
+
 ### Ruby
 
 ```ruby
@@ -43,23 +63,23 @@ filter2.test "doh" #=> probably false
 ### Javascript
 
 ```javascript
-# create a new BloomFilter and add entries
+// create a new BloomFilter and add entries
 filter = new JsonBloomFilter({ size: 100 });
 filter.add("foo");
 filter.add("bar");
-filter.test("foo"); #=> true
-filter.test("bar"); #=> true
-filter.test("doh"); #=> probably false
+filter.test("foo"); //=> true
+filter.test("bar"); //=> true
+filter.test("doh"); //=> probably false
 
-# export the filter to a hash or json
-filter.toJson();  #=> hash as JSON
-config = filter.toHash(); #=> { "size" => 100, "hashes" => 4, "seed" => 1234567890, "bits" => [...] }
+// export the filter to a hash or json
+filter.toJson();  //=> hash as JSON
+config = filter.toHash(); //=> { "size" => 100, "hashes" => 4, "seed" => 1234567890, "bits" => [...] }
 
-# use the hash to generate a new BloomFilter with the same config
+// use the hash to generate a new BloomFilter with the same config
 filter2 = new JsonBloomFilter(config);
-filter2.test("foo"); #=> true
-filter2.test("bar"); #=> true
-filter2.test("doh") #=> probably false
+filter2.test("foo"); //=> true
+filter2.test("bar"); //=> true
+filter2.test("doh") //=> probably false
 ```
 
 ### Options
@@ -76,18 +96,19 @@ Additionally you can pass along:
 
 ## Credits
 
-* bitarray.rb and bitarray.coffee based on [version by Peter Cooper](https://github.com/peterc/bitarray).
-* bloomfilter.rb and bloomfilter.coffee inspired by [Ilya Grigorik's Redis Bloomfilter](https://github.com/igrigorik/bloomfilter-rb/blob/master/lib/bloomfilter/redis.rb)
-* zlib.coffee crc32 method based on the [node-crc32](https://github.com/mikepulaski/node-crc32) library and [this snippet](http://stackoverflow.com/questions/6226189/how-to-convert-a-string-to-bytearray/10132540#10132540)
+* [bitarray.rb](https://github.com/cbetta/json-bloomfilter/blob/master/lib/json/bloomfilter/bitarray.rb) and [bitarray.coffee](https://github.com/cbetta/json-bloomfilter/blob/master/coffee/bitarray.coffee) based on [version by Peter Cooper](https://github.com/peterc/bitarray).
+* [bloomfilter.rb](https://github.com/cbetta/json-bloomfilter/blob/master/lib/json/bloomfilter.rb) and [bloomfilter.coffee](https://github.com/cbetta/json-bloomfilter/blob/master/coffee/bloomfilter.coffee) inspired by [Ilya Grigorik's Redis Bloomfilter](https://github.com/igrigorik/bloomfilter-rb/blob/master/lib/bloomfilter/redis.rb)
+* [zlib.coffee](https://github.com/cbetta/json-bloomfilter/blob/master/coffee/zlib.coffee) crc32 method based on the [node-crc32](https://github.com/mikepulaski/node-crc32) library and [this snippet](http://stackoverflow.com/questions/6226189/how-to-convert-a-string-to-bytearray/10132540#10132540)
 
 ## Release notes
 
-* **0.0.4** Added JS tests
-* **0.0.3** Added Ruby tests
-* **0.0.2** First implementation of both Ruby and JS filters
-* **0.0.1** Skeleton
+* **0.0.5** Adds installer of JS file
+* **0.0.4** Adds JS tests
+* **0.0.3** Adds Ruby tests
+* **0.0.2** Adds implementation of Ruby and JS filters
+* **0.0.1** Gem skeleton
 
 ## License
 
-See LICENSE
+See [LICENSE](https://github.com/cbetta/json-bloomfilter/blob/master/LICENSE)
 

data/bin/json-bloomfilter

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+def install
+  current_dir = File.expand_path(File.dirname(__FILE__))
+  filename = "json-bloomfilter.min.js"
+  source = "#{current_dir}/../js/#{filename}"
+  target_dir = Dir.pwd
+  rails_gems = `bundle list | grep rail`
+  js_dir = "#{target_dir}/app/assets/javascripts"
+
+  if !rails_gems.empty? && File.directory?(js_dir)
+    target = "#{js_dir}/#{filename}"
+  else
+    target = "#{target_dir}/#{filename}"
+  end
+
+  puts "Copying #{filename} to #{target}"
+  `cp #{source} #{target}`
+  puts "\t...done"
+end
+
+case ARGV.first
+when "install"
+  install
+else
+  puts "No command found"
+  puts "Usage: json-bloomfilter [command]"
+  puts "Command:"
+  puts "\tinstall: installs the json-bloomfilter.min.js into your current folder"
+end

data/json-bloomfilter.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |s|
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
   s.add_development_dependency 'rspec'

data/lib/json/bloomfilter/version.rb

@@ -1,3 +1,3 @@
 class JsonBloomfilter
-  VERSION = "0.0.4" unless defined? Trifle::VERSION
+  VERSION = "0.0.5" unless defined? JsonBloomfilter::VERSION
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json-bloomfilter
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -128,7 +128,8 @@ description: A bloomfilter implementation in both Ruby and Javascript that can b
   in one language and using it in the other.
 email:
 - cbetta@gmail.com
-executables: []
+executables:
+- json-bloomfilter
 extensions: []
 extra_rdoc_files: []
 files:
@@ -139,6 +140,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/json-bloomfilter
 - coffee/bitarray.coffee
 - coffee/bloomfilter.coffee
 - coffee/zlib.coffee
@@ -150,6 +152,7 @@ files:
 - pkg/json-bloomfilter-0.0.1.gem
 - pkg/json-bloomfilter-0.0.2.gem
 - pkg/json-bloomfilter-0.0.3.gem
+- pkg/json-bloomfilter-0.0.4.gem
 - spec/javascripts/bitarray_spec.js
 - spec/javascripts/bloomfilter_spec.js
 - spec/javascripts/support/jasmine.yml
@@ -178,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4107655990555845610
+      hash: -2817910243396386153
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24