recommendify 0.0.1

data/spec/cc_matrix_shared.rb

@@ -0,0 +1,54 @@
+share_examples_for Recommendify::CCMatrix do
+
+  it "should build a sparsematrix with the correct key" do
+    @matrix.ccmatrix.redis_key.should == "recommendify-test:mymatrix:ccmatrix"
+  end
+
+  it "should increment all item counts on set addition" do
+    Recommendify.redis.hset("recommendify-test:mymatrix:items", "bar", 2)
+    @matrix.add_set("user123", ["foo", "bar"])
+    Recommendify.redis.hget("recommendify-test:mymatrix:items", "bar").to_i.should == 3
+    Recommendify.redis.hget("recommendify-test:mymatrix:items", "foo").to_i.should == 1
+  end
+
+  it "should increment all item<->item pairs on set addition" do
+    @matrix.ccmatrix["bar", "foo"] = 2
+    res = @matrix.add_set("user123", ["foo", "bar", "fnord"])
+    res.length.should == 3
+    @matrix.ccmatrix["bar", "foo"].should == 3
+    @matrix.ccmatrix["foo", "fnord"].should == 1    
+  end
+
+  it "should increment all item<->item paris on single item addition"
+  it "should increment the item count on single item addition"
+
+  it "should calculate all item<->item pairs (3)" do
+    res = @matrix.send(:all_pairs, ["foo", "bar", "fnord"])
+    res.length.should == 3
+    res.should include("bar:foo")
+    res.should include("fnord:foo")
+    res.should include("bar:fnord")
+  end
+
+  it "should calculate all item<->item pairs (6)" do
+    res = @matrix.send(:all_pairs, ["foo", "bar", "fnord", "blubb"])
+    res.length.should == 6
+    res.should include("bar:foo")
+    res.should include("fnord:foo")
+    res.should include("bar:fnord")
+    res.should include("blubb:foo")
+    res.should include("blubb:fnord")
+    res.should include("bar:blubb")
+  end
+
+  it "should return all_items" do
+    @matrix.add_set("user42", ["fnord", "blubb"])
+    @matrix.add_set("user23", ["hans", "wurst"])
+    @matrix.all_items.length.should == 4
+    @matrix.all_items.should include("wurst")
+    @matrix.all_items.should include("fnord")
+    @matrix.all_items.should include("hans")
+    @matrix.all_items.should include("wurst")
+  end
+
+end

data/spec/cosine_input_matrix_spec.rb

@@ -0,0 +1,18 @@
+require ::File.expand_path('../spec_helper', __FILE__)
+
+describe Recommendify::CosineInputMatrix do
+
+  before(:all) do
+    @matrix = Recommendify::CosineInputMatrix.new(:redis_prefix => "recommendify-test", :key => "mymatrix")
+  end
+
+  before(:each) do
+    flush_redis!
+  end
+
+  it_should_behave_like Recommendify::InputMatrix
+  it_should_behave_like Recommendify::CCMatrix
+
+  it "should calculate the correct cosine similarity (here be dragons)"
+
+end

data/spec/input_matrix_shared.rb

@@ -0,0 +1,27 @@
+share_examples_for Recommendify::InputMatrix do
+  
+  it "should build the correct keys" do
+    @matrix.redis_key.should == "recommendify-test:mymatrix"
+  end
+
+  it "should respond to add_set" do
+    @matrix.respond_to?(:add_set).should == true
+  end
+
+  it "should respond to add_single" do
+    @matrix.respond_to?(:add_single).should == true
+  end
+
+  it "should respond to similarity" do
+    @matrix.respond_to?(:similarity).should == true
+  end
+
+  it "should respond to similarities_for" do
+    @matrix.respond_to?(:similarities_for).should == true
+  end
+
+  it "should respond to all_items" do
+    @matrix.respond_to?(:all_items).should == true
+  end
+
+end

data/spec/input_matrix_spec.rb

@@ -0,0 +1,29 @@
+require ::File.expand_path('../spec_helper', __FILE__)
+
+describe Recommendify::InputMatrix do
+
+  before(:all) do
+    @matrix = Recommendify::InputMatrix.new(:redis_prefix => "recommendify-test", :key => "mymatrix")
+  end
+
+  before(:each) do
+    flush_redis!
+  end
+
+  it_should_behave_like Recommendify::InputMatrix
+
+  describe "object creation" do
+
+     it "should create an object with the correct class" do
+       obj = Recommendify::InputMatrix.create(:key => "fubar", :similarity_func => :jaccard)
+       obj.should be_a(Recommendify::JaccardInputMatrix)
+     end
+
+     it "should create an object with the correct class and pass opts" do
+       obj = Recommendify::InputMatrix.create(:key => "fubar", :similarity_func => :jaccard)
+       obj.instance_variable_get(:@opts)[:key].should == "fubar"
+     end
+
+  end
+
+end

data/spec/jaccard_input_matrix_spec.rb

@@ -0,0 +1,78 @@
+require ::File.expand_path('../spec_helper', __FILE__)
+
+describe Recommendify::JaccardInputMatrix do
+
+  before(:all) do
+    @matrix = Recommendify::JaccardInputMatrix.new(:redis_prefix => "recommendify-test", :key => "mymatrix")
+  end
+
+  before(:each) do
+    flush_redis!
+  end
+
+  it_should_behave_like Recommendify::InputMatrix
+  it_should_behave_like Recommendify::CCMatrix
+
+  it "should calculate the correct jaccard index" do
+    @matrix.send(:calculate_jaccard, 
+      ["foo", "bar", "fnord", "blubb"],
+      ["bar", "fnord", "shmoo", "snafu"]
+    ).should == 2.0/6.0
+  end
+
+  it "should calculate the correct similarity between to items" do
+    add_two_item_test_data!(@matrix)
+    # sim(fnord,blubb) = (users(fnord) & users(blub)) / (users(fnord) + users(blubb))
+    # => {user42 user48} / {user42 user46 user48 user50} + {user42 user44 user48}
+    # => {user42 user48} / {user42 user44 user46 user48 user50}
+    # => 2 / 5 => 0.4
+    @matrix.similarity("fnord", "blubb").should == 0.4
+    @matrix.similarity("blubb", "fnord").should == 0.4
+  end
+
+  it "should calculate all similarities for an item (1/3)" do
+    add_three_item_test_data!(@matrix)
+    res = @matrix.similarities_for("fnord")
+    res.length.should == 2
+    res.should include ["shmoo", 0.75]
+    res.should include ["blubb", 0.4]
+  end
+
+  it "should calculate all similarities for an item (2/3)" do
+    add_three_item_test_data!(@matrix)
+    res = @matrix.similarities_for("shmoo")
+    res.length.should == 2
+    res.should include ["blubb", 0.2]
+    res.should include ["fnord", 0.75]
+  end
+
+
+  it "should calculate all similarities for an item (3/3)" do
+    add_three_item_test_data!(@matrix)
+    res = @matrix.similarities_for("blubb")
+    res.length.should == 2
+    res.should include ["shmoo", 0.2]
+    res.should include ["fnord", 0.4]
+  end
+
+private
+
+  def add_two_item_test_data!(matrix)
+    matrix.add_set("user42", ["fnord", "blubb"])
+    matrix.add_set("user44", ["blubb"])
+    matrix.add_set("user46", ["fnord"])
+    matrix.add_set("user48", ["fnord", "blubb"])
+    matrix.add_set("user50", ["fnord"])
+  end
+
+  def add_three_item_test_data!(matrix)
+    matrix.add_set("user42", ["fnord", "blubb", "shmoo"])
+    matrix.add_set("user44", ["blubb"])
+    matrix.add_set("user46", ["fnord", "shmoo"])
+    matrix.add_set("user48", ["fnord", "blubb"])
+    matrix.add_set("user50", ["fnord", "shmoo"])
+  end
+
+end
+
+

data/spec/recommendify_spec.rb

@@ -0,0 +1,28 @@
+require ::File.expand_path('../spec_helper', __FILE__)
+
+describe Recommendify do
+
+  it "should store a redis connection" do
+    Recommendify.redis = "asd"
+    Recommendify.redis.should == "asd"
+  end
+
+  it "should raise an exception if unconfigured redis connection is accessed" do
+    Recommendify.redis = nil
+    lambda{ ecommendify.redis }.should raise_error
+  end
+
+  it "should capitalize a string" do
+    Recommendify.capitalize("fuubar").should == "Fuubar"
+    Recommendify.capitalize("fuUBar").should == "Fuubar"
+    Recommendify.capitalize("FUUBAR").should == "Fuubar"
+    Recommendify.capitalize("Fuubar").should == "Fuubar"
+  end
+
+  it "should constantize a string" do
+    obj = Recommendify.constantize("JaccardInputMatrix")
+    # should_be doesn't work here...
+    obj.inspect.should == "Recommendify::JaccardInputMatrix"
+  end
+
+end

data/spec/similarity_matrix_spec.rb

@@ -0,0 +1,93 @@
+require ::File.expand_path('../spec_helper', __FILE__)
+
+describe Recommendify::SimilarityMatrix do
+
+  before(:each) do
+    flush_redis!
+    @matrix = Recommendify::SimilarityMatrix.new(:redis_prefix => "recommendify-test", :key => "mymatrix")
+  end
+
+  describe "sorted sets per item" do
+
+    it "should store member similarities" do
+      @matrix.update("item_foo", [["item_bar", 0.7], ["item_fnord", 0.3]])
+      @matrix.write_queue["item_foo"].length.should == 2
+    end
+
+    it "should store member similarities uniquely" do
+      @matrix.update("item_fnord", [["item_bar", 0.7], ["item_bar", 0.3]])
+      @matrix.write_queue["item_fnord"].length.should == 1
+    end
+
+    it "should store member similarities uniquely and sum the scores" do
+      @matrix.update("item_fnord", [["item_bar", 0.7], ["item_bar", 0.3]])
+      @matrix.write_queue["item_fnord"].should == {"item_bar" => 1.0}
+    end
+
+    it "should store multiple member similarities uniquely and sum the scores" do
+      @matrix.update("item_fnord", [["item_bar", 0.7], ["item_bar", 0.3], ["item_foo", 0.75]])
+      @matrix.write_queue["item_fnord"].should == {"item_bar" => 1.0, "item_foo" => 0.75}
+    end
+
+    it "should store multiple member similarities uniquely and sum the scores on multiple updates" do
+      @matrix.update("item_fnord", [["item_bar", 0.7], ["item_foo", 0.75]])
+      @matrix.update("item_fnord", [["item_fnord", 0.3], ["item_bar", 0.3], ["item_foo", 0.75]])
+      @matrix.write_queue["item_fnord"].should == {"item_bar" => 1.0, "item_foo" => 1.5, "item_fnord" => 0.3}
+    end
+
+    it "should retrieve the members" do
+      @matrix.update("item_fnord", [["item_bar", 0.7], ["item_bar", 0.3], ["item_foo", 0.75]])
+      @matrix["item_fnord"].should == {"item_bar" => 1.0, "item_foo" => 0.75}
+    end
+
+  end
+
+  describe "serialization/loading to/from redis" do
+
+    it "should serialize a member of the write_queue correctly" do
+      @matrix.update("item_fnord", [["item_fnord", 0.3], ["item_bar", 0.3], ["item_foo", 0.75]])
+      @matrix.update("item_fnord", [["item_bar", 0.7], ["item_bar", 0.3]])
+      @matrix.send(:serialize_item, "item_fnord").should == "item_bar:1.3|item_foo:0.75|item_fnord:0.3"
+    end
+
+    it "should write the n-most similar members and scores to redis on commit_item!" do
+      @matrix.update("item_fnord", [["item_fnord", 0.3], ["item_bar", 0.3], ["item_foo", 0.75]])
+      @matrix.update("item_fnord", [["item_bar", 0.7], ["item_bar", 0.3]])
+      @matrix.commit_item!("item_fnord")
+      Recommendify.redis.hget("recommendify-test:mymatrix", "item_fnord").should == "item_bar:1.3|item_foo:0.75|item_fnord:0.3"
+    end
+
+    it "should not write more than max_neighbors scores to redis on commit_item!" do
+      60.times{ |n| @matrix.update("item_fnord", [["item_#{n}", n.to_f/100.0]]) }
+      @matrix.commit_item!("item_fnord")
+      Recommendify.redis.hget("recommendify-test:mymatrix", "item_fnord").split("|").length.should == 50
+    end
+
+    it "should not write more neighbors with zero-scores to redis on commit_item!" do
+      @matrix.update("item_fnord", [["item_fnord", 0.0], ["item_bar", 0.3], ["item_foo", 0.75]])
+      @matrix.update("item_fnord", [["item_bar", 0.7], ["item_bar", 0.3]])
+      @matrix.commit_item!("item_fnord")
+      Recommendify.redis.hget("recommendify-test:mymatrix", "item_fnord").split("|").length.should == 2
+    end
+
+    it "should clear the item from the write_queue after commit_item!" do
+      60.times{ |n| @matrix.update("item_fnord", [["item_#{n}", n.to_f/100.0]]) }
+      @matrix.write_queue["item_fnord"].length.should == 60
+      @matrix.commit_item!("item_fnord")
+      @matrix.write_queue["item_fnord"].length.should == 0
+    end
+
+    it "should retrieve the n-most similar neighbors after stored" do
+      Recommendify.redis.hset("recommendify-test:mymatrix", "item_fnord", "item_blubb:0.6|item_foo:0.4")
+      @matrix["item_fnord"].keys.should include("item_blubb")
+      @matrix["item_fnord"].keys.should include("item_foo")
+    end
+
+    it "should retrieve the n-most similar neighbors after stored with scores" do
+      Recommendify.redis.hset("recommendify-test:mymatrix", "item_fnord", "item_blubb:0.6|item_foo:0.4")
+      @matrix["item_fnord"].should == {"item_blubb" => 0.6, "item_foo" => 0.4}
+    end
+
+  end
+
+end

data/spec/sparse_matrix_spec.rb

@@ -0,0 +1,78 @@
+require ::File.expand_path('../spec_helper', __FILE__)
+
+describe Recommendify::SparseMatrix do
+
+  before(:all) do
+    @sm = Recommendify::SparseMatrix.new(:redis_prefix => "recommendify-test", :key => "mysparsematrix")
+  end
+
+  before(:each) do
+    flush_redis!
+  end
+  
+  it "should build the correct keys" do
+    @sm.redis_key.should == "recommendify-test:mysparsematrix"
+  end
+
+  it "should retrieve a value" do
+    Recommendify.redis.hset("recommendify-test:mysparsematrix", "bar:foo", 43)
+    @sm["bar", "foo"].to_i.should == 43
+  end
+
+  it "should retrieve a value regardless of parameter order" do
+    Recommendify.redis.hset("recommendify-test:mysparsematrix", "one:two", 14)
+    @sm["one", "two"].to_i.should == 14
+    @sm["two", "one"].to_i.should == 14
+  end
+
+  it "should store a value" do
+    @sm["bar", "foo"] = 123
+    Recommendify.redis.hget("recommendify-test:mysparsematrix", "bar:foo").to_i.should == 123
+  end
+
+  it "should store a value regardless of parameter order" do
+    @sm["foo", "bar"] = 126
+    Recommendify.redis.hget("recommendify-test:mysparsematrix", "bar:foo").to_i.should == 126
+  end
+
+  it "should return 0 if the key is not found" do
+    @sm["not", "set"].should == 0
+  end
+
+  it "should increment a value" do
+    @sm["foo", "bar"] = 1000
+    @sm.incr("foo", "bar")
+    Recommendify.redis.hget("recommendify-test:mysparsematrix", "bar:foo").to_i.should == 1001
+  end
+
+  it "should increment a value regardless of parameter order" do
+    @sm["foo", "bar"] = 2000
+    @sm.incr("bar", "foo")
+    Recommendify.redis.hget("recommendify-test:mysparsematrix", "bar:foo").to_i.should == 2001
+  end
+
+  it "should not create unneseccary keys" do
+    @sm["foo", "bar"] = 90
+    @sm["5asd6", "bar"] = 260
+    @sm["foo", "bar"] = 45
+    @sm["foo", "jefs"] = 26
+    Recommendify.redis.hkeys("recommendify-test:mysparsematrix").length.should == 3
+  end
+
+  it "should create a key if the value is not 0" do
+    @sm["foo", "jefs"] = 26
+    Recommendify.redis.hkeys("recommendify-test:mysparsematrix").length.should == 1
+  end
+
+  it "should not create a key if the value is 0" do
+    @sm["foo", "jefs"] = 0
+    Recommendify.redis.hkeys("recommendify-test:mysparsematrix").length.should == 0
+  end
+
+  it "should delete a key if the value is set to 0" do
+    Recommendify.redis.hset("recommendify-test:mysparsematrix", "bar:foo", 43)
+    @sm["bar", "foo"] = 0
+    Recommendify.redis.hkeys("recommendify-test:mysparsematrix").length.should == 0
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+require "rspec"
+require "redis"
+
+require ::File.expand_path('../../lib/recommendify', __FILE__)
+
+require ::File.expand_path('../input_matrix_shared.rb', __FILE__)
+require ::File.expand_path('../cc_matrix_shared.rb', __FILE__)
+
+def flush_redis!
+  Recommendify.redis = Redis.new
+  Recommendify.redis.keys("recommendify-test*").each do |k|
+    Recommendify.redis.del(k)
+  end
+end
+
+class Recommendify::Base
+
+  def redis_prefix
+    "recommendify-test"
+  end
+
+end
+
+
+class TestRecommender < Recommendify::Base
+
+  input_matrix :jaccard_one, 
+    :similarity_func => :jaccard
+
+end
+
+class Recommendify::TestInputMatrix
+  
+  def initialize(opts)
+  	@opts = opts
+  end
+
+  def method_missing(method, *args)
+  	@opts[method]
+  end
+
+end