commendo 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01e2c317e998efe31d72e1a399d1d8eb677854a7
-  data.tar.gz: fad0b2a2c09333ef31eff3f3aaaf91c7b3d1862f
+  metadata.gz: 6882c6ed2001ecae7be9eae066e3f534beeb1559
+  data.tar.gz: 0a0982ccc0a17285537b1adfc12bfe854da6c10f
 SHA512:
-  metadata.gz: 8d0563d3909815866885f6f654c172f39675c442fb24a7306162090f848e2e50f4161aabf0fcc4f4779e474ff3b5c9902ec8d5c7cdc66db69cd7a3886f17a9bc
-  data.tar.gz: f05702dd19c5be8b6480ef4a513294c493f7138a2bb2d3c5f329fc6a734a9060660ab168f4d987f830c188142fc6bd5334c0a903b0f45024d7810ba7cb02e284
+  metadata.gz: 834aeca013589496b5e6b95a0d5ec7e327fc6192ba57e7dab7c2d8507055013058a96b354b13bb2422c21caa7cce92c0fd5f0011c60d3cb5c202b723eb94dbf4
+  data.tar.gz: d773e4c3776f66ba003cf7b7c1327a376e439f8f72480b903d1512db906c27aa55c9f01a052c11a24fbde4f4e90d7bb50b13d6494fbd963ea407d0d4807eb5fd

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 0.0.3 / 2014-03-31
+* [FEATURE] Filtering of recommendations based on tags
+
 # 0.0.2 / 2014-03-31
 * [FEATURE] Weighted groups. Incremental additions. Deletions.
 

data/lib/commendo.rb

@@ -1,8 +1,9 @@
 require 'redis'
 require 'commendo/version'
 require 'commendo/content_set'
+require 'commendo/tag_set'
 require 'commendo/weighted_group'
 
 module Commendo
-  # Your code goes here...
+
 end

data/lib/commendo/content_set.rb

@@ -2,10 +2,10 @@ module Commendo
 
   class ContentSet
 
-    attr_accessor :redis, :key_base
+    attr_accessor :redis, :key_base, :tag_set
 
-    def initialize(redis, key_base)
-      @redis, @key_base = redis, key_base
+    def initialize(redis, key_base, tag_set = nil)
+      @redis, @key_base, @tag_set = redis, key_base, tag_set
     end
 
     def add_by_group(group, *resources)
@@ -68,7 +68,19 @@ module Commendo
       similar_resources.map do |resource|
         {resource: resource[0], similarity: resource[1].to_f}
       end
+    end
+
+    def filtered_similar_to(resource, options = {})
+      similar = similar_to(resource)
+      return similar if options[:include].nil? && options[:exclude].nil?
+      similar.delete_if { |s| !options[:exclude].nil? && tags_match(s[:resource], options[:exclude]) }
+      similar.delete_if { |s| !options[:include].nil? && !tags_match(s[:resource], options[:include]) }
+      similar
+    end
 
+    def tags_match(resource, tags)
+      resource_tags = tag_set.get(resource)
+      (resource_tags & tags).length > 0
     end
 
     def similarity_key(resource)

data/lib/commendo/tag_set.rb

@@ -0,0 +1,36 @@
+module Commendo
+
+  class TagSet
+
+    attr_accessor :redis, :key_base
+
+    def initialize(redis, key_base)
+      @redis, @key_base = redis, key_base
+    end
+
+    def get(resource)
+      redis.smembers(resource_key(resource)).sort
+    end
+
+    def add(resource, *tags)
+      redis.sadd(resource_key(resource), tags)
+    end
+
+    def set(resource, *tags)
+      delete(resource)
+      add(resource, *tags)
+    end
+
+    def delete(resource)
+      redis.del(resource_key(resource))
+    end
+
+    private
+
+    def resource_key(resource)
+      "#{key_base}:#{resource}"
+    end
+
+  end
+end
+

data/lib/commendo/version.rb

@@ -1,3 +1,3 @@
 module Commendo
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/test/content_set_test.rb

@@ -66,12 +66,12 @@ module Commendo
       end
       cs.calculate_similarity
       expected = [
-        { resource:  '9', similarity: 0.5 },
-        { resource:  '6', similarity: 0.5 },
-        { resource: '12', similarity: 0.33333333333333 },
-        { resource:  '3', similarity: 0.25 },
-        { resource: '21', similarity: 0.16666666666667 },
-        { resource: '15', similarity: 0.16666666666667 }
+        {resource: '9', similarity: 0.5},
+        {resource: '6', similarity: 0.5},
+        {resource: '12', similarity: 0.33333333333333},
+        {resource: '3', similarity: 0.25},
+        {resource: '21', similarity: 0.16666666666667},
+        {resource: '15', similarity: 0.16666666666667}
       ]
       assert_equal expected, cs.similar_to(18)
     end
@@ -88,8 +88,8 @@ module Commendo
       end
       cs.calculate_similarity(0.4)
       expected = [
-        { resource:  '9', similarity: 0.5 },
-        { resource:  '6', similarity: 0.5 },
+        {resource: '9', similarity: 0.5},
+        {resource: '6', similarity: 0.5},
       ]
       assert_equal expected, cs.similar_to(18)
     end
@@ -144,16 +144,89 @@ module Commendo
       assert similar_to(cs, 10, 12)
     end
 
-    def test_accepts_tag_collection
-      skip
+    def test_filters_include_by_tag_collection
+      redis = Redis.new(db: 15)
+      redis.flushdb
+      ts = TagSet.new(redis, 'CommendoTests:tags')
+      cs = ContentSet.new(redis, 'CommendoTests', ts)
+      (3..23).each do |group|
+        (3..23).each do |res|
+          cs.add(res, group) if res % group == 0
+          ts.add(res, 'mod3') if res.modulo(3).zero?
+          ts.add(res, 'mod4') if res.modulo(4).zero?
+          ts.add(res, 'mod5') if res.modulo(5).zero?
+        end
+      end
+      cs.calculate_similarity
+
+      actual = cs.filtered_similar_to(10, include: ['mod5'])
+      assert_equal 3, actual.length
+      assert contains_resource('5', actual)
+      assert contains_resource('15', actual)
+      assert contains_resource('20', actual)
+
     end
 
-    def test_filters_by_tag_collection
-      skip
+    def test_filters_exclude_by_tag_collection
+      redis = Redis.new(db: 15)
+      redis.flushdb
+      ts = TagSet.new(redis, 'CommendoTests:tags')
+      cs = ContentSet.new(redis, 'CommendoTests', ts)
+      (3..23).each do |group|
+        (3..23).each do |res|
+          cs.add(res, group) if res % group == 0
+          ts.add(res, 'mod3') if res.modulo(3).zero?
+          ts.add(res, 'mod4') if res.modulo(4).zero?
+          ts.add(res, 'mod5') if res.modulo(5).zero?
+        end
+      end
+      cs.calculate_similarity
+
+      actual = cs.filtered_similar_to(10, exclude: ['mod3'])
+      assert_equal 2, actual.length
+      assert contains_resource('5', actual)
+      assert contains_resource('20', actual)
+      refute contains_resource('15', actual)
+
+    end
+
+    def test_filters_includes_and_exclude_by_tag_collection
+      redis = Redis.new(db: 15)
+      redis.flushdb
+      ts = TagSet.new(redis, 'CommendoTests:tags')
+      cs = ContentSet.new(redis, 'CommendoTests', ts)
+      (3..23).each do |group|
+        (3..23).each do |res|
+          cs.add(res, group) if res % group == 0
+          ts.add(res, 'mod3') if res.modulo(3).zero?
+          ts.add(res, 'mod4') if res.modulo(4).zero?
+          ts.add(res, 'mod5') if res.modulo(5).zero?
+        end
+      end
+      cs.calculate_similarity
+
+      actual = cs.filtered_similar_to(12, include: ['mod4'], exclude: ['mod3', 'mod5'])
+      assert_equal 3, actual.length
+
+      refute contains_resource('6', actual)
+      refute contains_resource('18', actual)
+      assert contains_resource('4', actual)
+      refute contains_resource('3', actual)
+      refute contains_resource('9', actual)
+      assert contains_resource('8', actual)
+      refute contains_resource('21', actual)
+      assert contains_resource('16', actual)
+      refute contains_resource('15', actual)
+      refute contains_resource('20', actual)
+
     end
 
     def similar_to(cs, resource, similar)
-      cs.similar_to(resource).select { |sim| sim[:resource] == "#{similar}" }.length > 0
+      contains_resource(similar, cs.similar_to(resource))
+    end
+
+    def contains_resource(resource, similarities)
+      similarities.select { |sim| sim[:resource] == "#{resource}" }.length > 0
     end
 
   end

data/test/tag_set_test.rb

@@ -0,0 +1,48 @@
+gem 'minitest'
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'minitest/mock'
+require 'mocha/setup'
+require 'commendo'
+
+module Commendo
+
+  class TagSetTest < Minitest::Test
+
+    def test_adds_tags_for_resource
+      redis = Redis.new(db: 15)
+      redis.flushdb
+      ts = TagSet.new(redis, 'TagSetTest')
+      assert_equal [], ts.get(1)
+      ts.add(1, 'foo', 'bar', 'baz')
+      assert_equal ['bar', 'baz','foo'], ts.get(1)
+      ts.add(1, 'qux', 'qip')
+      assert_equal ['bar', 'baz', 'foo', 'qip', 'qux'], ts.get(1)
+    end
+
+    def test_sets_tags_for_resource
+      redis = Redis.new(db: 15)
+      redis.flushdb
+      ts = TagSet.new(redis, 'TagSetTest')
+      assert_equal [], ts.get(1)
+      ts.set(1, 'foo', 'bar', 'baz')
+      assert_equal ['bar', 'baz', 'foo'], ts.get(1)
+      ts.set(1, 'qux', 'qip')
+      assert_equal ['qip', 'qux'], ts.get(1)
+    end
+
+    def test_deletes_tags_for_resource
+      redis = Redis.new(db: 15)
+      redis.flushdb
+      ts = TagSet.new(redis, 'TagSetTest')
+      ts.set(1, 'foo', 'bar', 'baz')
+      ts.set(2, 'qux', 'qip')
+      assert_equal ['bar', 'baz', 'foo'], ts.get(1)
+      assert_equal ['qip', 'qux'], ts.get(2)
+      ts.delete(1)
+      assert_equal [], ts.get(1)
+      assert_equal ['qip', 'qux'], ts.get(2)
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commendo
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Rob Styles
@@ -111,9 +111,11 @@ files:
 - lib/commendo.rb
 - lib/commendo/content_set.rb
 - lib/commendo/similarity.lua
+- lib/commendo/tag_set.rb
 - lib/commendo/version.rb
 - lib/commendo/weighted_group.rb
 - test/content_set_test.rb
+- test/tag_set_test.rb
 - test/weighted_group_test.rb
 homepage: ''
 licenses:
@@ -141,5 +143,6 @@ specification_version: 4
 summary: A Jaccard-similarity recommender using Redis sets
 test_files:
 - test/content_set_test.rb
+- test/tag_set_test.rb
 - test/weighted_group_test.rb
 has_rdoc: