commendo 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5d32053e7810788416b8a9d1c42937bff79462b
-  data.tar.gz: aa65282bdfbe68311fdc140fcbbe59dabc029c92
+  metadata.gz: 1f16a2f22f2afbdf32e7242ee821fca56ba8c690
+  data.tar.gz: c77c52106e8df36b855f41eb2c6bbd0d0f82bbbe
 SHA512:
-  metadata.gz: 316b145f9abc4370d0e621e2e374ae9105fe61f9f647b150a1acca82b4818be46bd994eac011cba57d6560bf8c8e5430d0b6a7e09634c313ea09723cd2f35662
-  data.tar.gz: f9d134bf294c9abd189af50400948d4dc2fed55e5fb925e3f39cc714fa6090cc4c67bac3dd896e0c40bcde730549deebe4b3525d9ec520c6432882beec0e7afa
+  metadata.gz: 86cd12a3d567df7dc14bc77767d4297fca094fa4d0987bd8eb6674103c77455afc383a2933a2fa947e75b2ede3b07dd244379bf1b8ce5530b6d0e662c9830868
+  data.tar.gz: e327b49f232971ecb94c1e8bbec2e1ebf06673cdc596e2bc1a8722238fbc0316d24d84582d30a39769224288119e764cd473252c73184ee4d1b4fe190b62aea1

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 0.0.6 / 2014-04-01
+* [FEATURE] Weighted groups now accept array of resources and return combined similarity scores
+
 # 0.0.5 / 2014-03-31
 * [FEATURE] Can now accept array of resources and return combined similarity scores
 

data/lib/commendo/content_set.rb

@@ -86,17 +86,12 @@ module Commendo
 
     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]) }
+      return similar if @tag_set.nil? || options[:include].nil? && options[:exclude].nil?
+      similar.delete_if { |s| !options[:exclude].nil? && @tag_set.matches(s[:resource], *options[:exclude]) }
+      similar.delete_if { |s| !options[:include].nil? && !@tag_set.matches(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)
       "#{similar_key_base}:#{resource}"
     end
@@ -137,7 +132,6 @@ module Commendo
       "#{key_base}:groups"
     end
 
-
     def group_key(group)
       "#{group_key_base}:#{group}"
     end

data/lib/commendo/tag_set.rb

@@ -21,6 +21,11 @@ module Commendo
       add(resource, *tags)
     end
 
+    def matches(resource, *tags)
+      resource_tags = get(resource)
+      (resource_tags & tags).length > 0
+    end
+
     def delete(resource)
       redis.del(resource_key(resource))
     end

data/lib/commendo/version.rb

@@ -1,3 +1,3 @@
 module Commendo
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/lib/commendo/weighted_group.rb

@@ -2,18 +2,21 @@ module Commendo
 
   class WeightedGroup
 
-    attr_accessor :content_sets, :redis, :key_base
+    attr_accessor :content_sets, :redis, :key_base, :tag_set
 
     def initialize(redis, key_base, *content_sets)
       @content_sets, @redis, @key_base = content_sets, redis, key_base
     end
 
     def similar_to(resource)
-      keys = content_sets.map do |cs|
-        cs[:cs].similarity_key(resource)
-      end
-      weights = content_sets.map do |cs|
-        cs[:weight]
+      resources = resource.kind_of?(Array) ? resource : [resource]
+      keys = []
+      weights = []
+      content_sets.each do |cs|
+        resources.each do |resource|
+          keys << cs[:cs].similarity_key(resource)
+          weights << cs[:weight]
+        end
       end
       tmp_key = "#{key_base}:tmp:#{SecureRandom.uuid}"
       redis.zunionstore(tmp_key, keys, weights: weights)
@@ -26,6 +29,14 @@ module Commendo
 
     end
 
+    def filtered_similar_to(resource, options = {})
+      similar = similar_to(resource)
+      return similar if @tag_set.nil? || options[:include].nil? && options[:exclude].nil?
+      similar.delete_if { |s| !options[:exclude].nil? && @tag_set.matches(s[:resource], *options[:exclude]) }
+      similar.delete_if { |s| !options[:include].nil? && !@tag_set.matches(s[:resource], *options[:include]) }
+      similar
+    end
+
   end
 
 end

data/test/tag_set_test.rb

@@ -44,5 +44,26 @@ module Commendo
       assert_equal ['qip', 'qux'], ts.get(2)
     end
 
+    def test_matches_tags
+      redis = Redis.new(db: 15)
+      redis.flushdb
+      ts = TagSet.new(redis, 'TagSetTest')
+      ts.set(1, 'foo', 'bar', 'baz')
+      ts.set(2, 'qux', 'qip')
+
+      assert ts.matches(1, 'foo')
+      assert ts.matches(1, 'bar', 'baz')
+      assert ts.matches(1, 'bar', 'baz', 'foo')
+      refute ts.matches(1, 'qux')
+      refute ts.matches(1, 'qip')
+
+      refute ts.matches(2, 'foo')
+      refute ts.matches(2, 'bar', 'baz')
+      refute ts.matches(2, 'bar', 'baz', 'foo')
+      assert ts.matches(2, 'qux', 'qip')
+      assert ts.matches(2, 'qux')
+      assert ts.matches(2, 'qip')
+    end
+
   end
 end

data/test/weighted_group_test.rb

@@ -9,21 +9,36 @@ module Commendo
 
   class WeightedGroupTest < Minitest::Test
 
-    def test_calls_each_content_set
-      redis = Redis.new(db: 15)
-      redis.flushdb
-      cs1 = ContentSet.new(redis, 'CommendoTests:ContentSet1')
-      cs2 = ContentSet.new(redis, 'CommendoTests:ContentSet2')
-      cs3 = ContentSet.new(redis, 'CommendoTests:ContentSet3')
+    def setup
+      super
+      @redis ||= Redis.new(db: 15)
+      @redis.flushdb
+      @tag_set = TagSet.new(@redis, 'CommendoTests:Tags')
+      @cs1 = ContentSet.new(@redis, 'CommendoTests:ContentSet1', @tag_set)
+      @cs2 = ContentSet.new(@redis, 'CommendoTests:ContentSet2', @tag_set)
+      @cs3 = ContentSet.new(@redis, 'CommendoTests:ContentSet3', @tag_set)
       (3..23).each do |group|
         (3..23).each do |res|
-          cs1.add_by_group(group, res) if (res % group == 0) && (res % 2 == 0)
-          cs2.add_by_group(group, res) if (res % group == 0) && (res % 3 == 0)
-          cs3.add_by_group(group, res) if (res % group == 0) && (res % 6 == 0)
+          @cs1.add_by_group(group, res) if (res % group == 0) && (res % 2 == 0)
+          @cs2.add_by_group(group, res) if (res % group == 0) && (res % 3 == 0)
+          @cs3.add_by_group(group, res) if (res % group == 0) && (res % 6 == 0)
+          @tag_set.add(res, 'mod3') if res.modulo(3).zero?
+          @tag_set.add(res, 'mod4') if res.modulo(4).zero?
+          @tag_set.add(res, 'mod5') if res.modulo(5).zero?
+          @tag_set.add(res, 'mod7') if res.modulo(7).zero?
         end
       end
-      [cs1, cs2, cs3].each { |cs| cs.calculate_similarity }
-      weighted_group = WeightedGroup.new(redis, 'CommendoTests:WeightedGroup', { cs: cs1, weight: 1.0 },  { cs: cs2, weight: 10.0 },  { cs: cs3, weight: 100.0 } )
+      [@cs1, @cs2, @cs3].each { |cs| cs.calculate_similarity }
+    end
+
+    def test_calls_each_content_set
+      weighted_group = WeightedGroup.new(
+        @redis,
+        'CommendoTests:WeightedGroup',
+        {cs: @cs1, weight: 1.0},
+        {cs: @cs2, weight: 10.0},
+        {cs: @cs3, weight: 100.0}
+      )
       expected = [
         {resource: '6', similarity: 55.5},
         {resource: '12', similarity: 36.963},
@@ -35,12 +50,107 @@ module Commendo
       assert_equal expected, weighted_group.similar_to(18)
     end
 
+    def test_filters_include_recommendations
+      weighted_group = WeightedGroup.new(
+        @redis,
+        'CommendoTests:WeightedGroup',
+        {cs: @cs1, weight: 1.0},
+        {cs: @cs2, weight: 10.0},
+        {cs: @cs3, weight: 100.0}
+      )
+      expected = [{resource: '15', similarity: 1.67}]
+      weighted_group.tag_set = @tag_set
+      assert_equal expected, weighted_group.filtered_similar_to(18, include: ['mod5'])
+    end
+
+    def test_filters_exclude_recommendations
+      weighted_group = WeightedGroup.new(
+        @redis,
+        'CommendoTests:WeightedGroup',
+        {cs: @cs1, weight: 1.0},
+        {cs: @cs2, weight: 10.0},
+        {cs: @cs3, weight: 100.0}
+      )
+      expected = [
+        {resource: '6', similarity: 55.5},
+        {resource: '12', similarity: 36.963},
+        {resource: '9', similarity: 5.0},
+        {resource: '3', similarity: 2.5}
+      ]
+      weighted_group.tag_set = @tag_set
+      assert_equal expected, weighted_group.filtered_similar_to(18, exclude: ['mod5', 'mod7'])
+    end
+
+    def test_filters_include_and_exclude_recommendations
+      weighted_group = WeightedGroup.new(
+        @redis,
+        'CommendoTests:WeightedGroup',
+        {cs: @cs1, weight: 100.0},
+        {cs: @cs2, weight: 10.0},
+        {cs: @cs3, weight: 1.0}
+      )
+      expected = [
+        {resource: '16', similarity: 66.7},
+        {resource: '4', similarity: 50.0},
+        {resource: '12', similarity: 20.0}
+      ]
+      weighted_group.tag_set = @tag_set
+      assert_equal expected, weighted_group.filtered_similar_to(8, include: ['mod4'], exclude: ['mod5'])
+    end
+
+    def test_similar_to_mutliple_items
+      weighted_group = WeightedGroup.new(
+        @redis,
+        'CommendoTests:WeightedGroup',
+        {cs: @cs1, weight: 100.0},
+        {cs: @cs2, weight: 10.0},
+        {cs: @cs3, weight: 1.0}
+      )
+      expected = [
+        {resource: '12', similarity: 83.0},
+        {resource: '18', similarity: 58.0},
+        {resource: '8', similarity: 50.0},
+        {resource: '16', similarity: 33.3},
+        {resource: '20', similarity: 25.0},
+        {resource: '9', similarity: 8.33},
+        {resource: '21', similarity: 5.83},
+        {resource: '15', similarity: 5.83},
+        {resource: '6', similarity: 5.0},
+        {resource: '3', similarity: 5.0}
+      ]
+      weighted_group.tag_set = @tag_set
+      assert_equal expected, weighted_group.similar_to([3,4,5,6,7])
+    end
+
+    def test_filtered_similar_to_mutliple_items
+      weighted_group = WeightedGroup.new(
+        @redis,
+        'CommendoTests:WeightedGroup',
+        {cs: @cs1, weight: 100.0},
+        {cs: @cs2, weight: 10.0},
+        {cs: @cs3, weight: 1.0}
+      )
+      expected = [
+        {resource: '12', similarity: 83.0},
+        #{resource: '18', similarity: 58.0},
+        {resource: '8', similarity: 50.0},
+        {resource: '16', similarity: 33.3},
+        #{resource: '20', similarity: 25.0},
+        #{resource: '9', similarity: 8.33},
+        #{resource: '21', similarity: 5.83},
+        #{resource: '15', similarity: 5.83},
+        #{resource: '6', similarity: 5.0},
+        #{resource: '3', similarity: 5.0}
+      ]
+      weighted_group.tag_set = @tag_set
+      assert_equal expected, weighted_group.filtered_similar_to([3,4,5,6,7], include: ['mod4'], exclude: ['mod5'])
+    end
+
     def test_precalculates
       skip
     end
 
 
-
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: commendo
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Rob Styles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-31 00:00:00.000000000 Z
+date: 2014-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis