bk 0.0.1 → 1.0.0

data/Gemfile

@@ -1,8 +1,2 @@
-# A sample Gemfile
 source "http://rubygems.org"
-
-gem "text"
-
-group :test do
-  gem "test-unit"
-end
+gemspec

data/README.md

@@ -1,57 +1,78 @@
 # BK-Tree implementation in Ruby
 
-If you don’t know what a BK-tree is, these links should provide a good explanation and introduction.
+BK-trees can be used to efficiently locate strings' best matches from within a
+large set. If you don’t know what a BK-tree is, these links should provide a
+good explanation and introduction.
 
 * [Damn Cool Algorithms, Part 1: BK-Trees](http://blog.notdot.net/2007/4/Damn-Cool-Algorithms-Part-1-BK-Trees)
 * [Fast Approximate String Matching in a Dictionary](http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.21.3317)
 
+
+## Installation
+
+BK is available as a Ruby gem:
+
+    gem install bk
+
 ## Usage
 
-    require "bk"
-    tree = BK::Tree.new # Use the default Levenshtein distance algorithm
+```ruby
+require "bk"
+tree = BK::Tree.new # Use the default Levenshtein distance algorithm
+```
 
 Add items to the tree:
 
-    tree.add "cat"
-    tree.add "dog"
-    tree.add "monkey"
-    tree.add "donkey"
+```ruby
+tree.add "cat"
+tree.add "dog"
+tree.add "monkey"
+tree.add "donkey"
+```
 
 Find all items within distance 1 of ‘munkey’:
 
-    tree.query("munkey", 1)
-    # => {"monkey"=>1} 
+```ruby
+tree.query("munkey", 1)
+# => {"monkey"=>1}
+```
 
 Find all items within distance 2 of ‘munkey’:
 
-    tree.query("munkey", 2)
-    # => {"donkey"=>2, "monkey"=>1}
+```ruby
+tree.query("munkey", 2)
+# => {"donkey"=>2, "monkey"=>1}
+```
 
 You can specify a custom distance algorithm by passing an object that responds
 to `call(a, b)` with a number:
 
-    custom_algorithm = lambda{ |a, b|
-      Text::Levenshtein.distance(a, b)
-    }
+```ruby
+custom_algorithm = lambda{ |a, b|
+  Text::Levenshtein.distance(a, b)
+}
 
-    tree = BK::Tree.new(custom_algorithm)
+# or, more tersely:
+
+custom_algorithm = Text::Levenshtein.public_method(:distance)
+
+tree = BK::Tree.new(custom_algorithm)
+```
 
 Note that the result *must* satisfy the
 _triangle inequality_, i.e. _d(x,z) ≤ d(x,y) + d(y,z)_.
 
 The precomputed tree can be exported to and reimported later from an IO-like object:
 
-    File.open("tree", "wb") do |f|
-      tree.export(f)
-    end
-
-    File.open("tree", "rb") do |f|
-      tree = BK::Tree.import(f)
-    end
+```ruby
+File.open("tree", "wb") do |f|
+  tree.export(f)
+end
 
-## Dependencies
-
-* [text](http://rubygems.org/gems/text) version 0.2.0 or newer.
+File.open("tree", "rb") do |f|
+  tree = BK::Tree.import(f)
+end
+```
 
 ## Performance
 
@@ -75,3 +96,15 @@ As the threshold increases, the benefit is reduced. At threshold 3:
 
 * Memory usage: around 6 MB for a 20,000-word tree.
 * Maximum tree depth is limited by the stack.
+
+## Testing
+
+    rake test
+
+...or, for specific tests:
+
+    ruby -Itest test/test_building_tree.rb
+
+## Licensing
+
+MIT (see COPYING.txt)

data/lib/bk/version.rb

@@ -1,3 +1,3 @@
 module BK
-  VERSION = '0.0.1'
+  VERSION = '1.0.0'
 end

data/test/common.rb

@@ -0,0 +1,4 @@
+lib = File.expand_path("../../lib", __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require "test/unit"

data/test/test_building_tree.rb

@@ -1,5 +1,4 @@
-$:.unshift( File.join( File.dirname(__FILE__), '..', 'lib' ))
-require 'test/unit'
+require 'common'
 require 'bk'
 require 'bk/dump'
 

data/test/test_import_and_export.rb

@@ -1,5 +1,4 @@
-$:.unshift( File.join( File.dirname(__FILE__), '..', 'lib' ))
-require 'test/unit'
+require 'common'
 require 'bk'
 require 'stringio'
 

data/test/test_querying_tree.rb

@@ -1,5 +1,4 @@
-$:.unshift( File.join( File.dirname(__FILE__), '..', 'lib' ))
-require 'test/unit'
+require 'common'
 require 'bk'
 
 class BKTreeQueryAccuracyTest < Test::Unit::TestCase
@@ -33,6 +32,7 @@ class BKTreeSearchSpaceTest < Test::Unit::TestCase
     def initialize
       @history = []
       @counting = false
+      @recording = false
     end
 
     def call(a, b)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-13 00:00:00.000000000Z
+date: 2012-07-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: text
-  requirement: &70195843345880 !ruby/object:Gem::Requirement
+  requirement: &2152922040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70195843345880
+  version_requirements: *2152922040
 - !ruby/object:Gem::Dependency
-  name: test-unit
-  requirement: &70195843345460 !ruby/object:Gem::Requirement
+  name: rake
+  requirement: &2152921620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70195843345460
+  version_requirements: *2152921620
 description: Burkhard Keller Tree implementation in Ruby
 email: pbattley@gmail.com
 executables: []
@@ -47,7 +47,7 @@ files:
 - lib/bk.rb
 - samples/graph.rb
 - samples/performance.rb
-- test/test_all.rb
+- test/common.rb
 - test/test_building_tree.rb
 - test/test_import_and_export.rb
 - test/test_querying_tree.rb
@@ -76,7 +76,7 @@ signing_key:
 specification_version: 3
 summary: Burkhard Keller Tree implementation in Ruby
 test_files:
-- test/test_all.rb
+- test/common.rb
 - test/test_building_tree.rb
 - test/test_import_and_export.rb
 - test/test_querying_tree.rb

data/test/test_all.rb

@@ -1,3 +0,0 @@
-Dir[ File.join( File.dirname(__FILE__), '*.rb' )].each do |f|
-  require f
-end