recommendable 2.0.4.20130313 → 2.1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9fb8bf4282ccc0eeb6ef72f38ff05c007e50229
-  data.tar.gz: 26d9e3d87b8d9059d9fa0002647d947f261f5224
+  metadata.gz: 91c45d80ed7ced8b477f8753ad6611b716e0395a
+  data.tar.gz: 7103dd3d7eb386ce8e019b45caade3139b7c8ea9
 SHA512:
-  metadata.gz: 03456dbe5383f44f54160e332d2a2375109f1d94caa57b4878842777ede88f0e50714e13611bd6e0f3d3741efc8aa07c5951834d4e09076bf5e51154a2ba992f
-  data.tar.gz: 58bda95c326eba0a1e3296d41ee4241f47a70f2773875c3bd0009ac1509b0c55db06e6185d222ad6a5b0e07e009619c7af6a248bab1aba82399895ef7fb753ad
+  metadata.gz: eca1215ebbdc0944e24a168ea6ee5a069300dbe7a7cf06051461cc4226eebcf4686ff321aacd07a932a96b08797d65c57084f52421b55ba292d4015095972c97
+  data.tar.gz: 50e043455fb3f7780727a54b7292e4c78045c3691c091ebb79af2204dc10df1e919a2255524b05210fed90186df812fe68cb20e2411cb5998e2de36f518436b5

data/lib/recommendable.rb

@@ -11,7 +11,6 @@ require 'recommendable/workers/sidekiq'
 require 'recommendable/workers/resque'
 require 'recommendable/workers/delayed_job'
 require 'recommendable/workers/torque_box'
-require 'recommendable/workers/rails'
 
 module Recommendable
   class << self

data/lib/recommendable/configuration.rb

@@ -5,43 +5,75 @@ module Recommendable
     # The ORM you are using. Currently supported: `:activerecord`, `:mongoid`, ':sequel', ':mongo-mapper' and `:datamapper`
     attr_accessor :orm
 
-    # Recommendable's connection to Redis
+    # Recommendable's connection to Redis.
+    #
+    # Default: localhost:6379/0
     attr_accessor :redis
 
-    # A prefix for all keys Recommendable uses
+    # A prefix for all keys Recommendable uses.
+    #
+    # Default: recommendable
     attr_accessor :redis_namespace
 
     # Whether or not to automatically enqueue users to have their recommendations
-    # refreshed after they like/dislike an item
+    # refreshed after they like/dislike an item.
+    #
+    # Default: true
     attr_accessor :auto_enqueue
 
-    # The name of the queue that background jobs will be placed in
-    attr_accessor :queue_name
-
     # The number of nearest neighbors (k-NN) to check when updating
     # recommendations for a user. Set to `nil` if you want to check all
-    # neighbors as opposed to a subset of the nearest ones.
+    # neighbors as opposed to a subset of the nearest ones. Set this to a lower
+    # number to improve Redis memory usage.
+    #
+    # Default: nil
     attr_accessor :nearest_neighbors
 
+    # Like kNN, but also uses some number of most dissimilar users when
+    # updating recommendations for a user. Because, hey, disagreements are
+    # just as important as agreements, right? If `nearest_neighbors` is set to
+    # `nil`, this configuration is ignored. Set this to a lower number
+    # to improve Redis memory usage.
+    #
+    # Default: nil
+    attr_accessor :furthest_neighbors
+
+    # The number of recommendations to store per user. Set this to a lower
+    # number to improve Redis memory usage.
+    #
+    # Default: 100
+    attr_accessor :recommendations_to_store
+
     attr_accessor :ratable_classes, :user_class
 
     # Default values
     def initialize
-      @redis             = Redis.new
-      @redis_namespace   = :recommendable
-      @auto_enqueue      = true
-      @queue_name        = :recommendable
-      @ratable_classes   = []
-      @nearest_neighbors = nil
+      @redis                    = Redis.new
+      @redis_namespace          = :recommendable
+      @auto_enqueue             = true
+      @ratable_classes          = []
+      @nearest_neighbors        = nil
+      @furthest_neihbors        = nil
+      @recommendations_to_store = 100
+    end
+
+    def queue_name
+      warn "Recommendable.config.queue_name has been deprecated. Jobs will always be placed in a queue named 'recommendable'."
+    end
+
+    def queue_name=(queue_name)
+      warn "Recommendable.config.queue_name has been deprecated. Jobs will always be placed in a queue named 'recommendable'."
     end
   end
 
   class << self
-    attr_accessor :config
-
     def configure
       @config ||= Configuration.new
       yield @config
     end
+
+    def config
+      @config ||= Configuration.new
+    end
   end
 end

data/lib/recommendable/helpers/calculations.rb

@@ -67,6 +67,13 @@ module Recommendable
             Recommendable.redis.zadd(similarity_set, similarity_between(user_id, id), id)
           end
 
+          if knn = Recommendable.config.nearest_neighbors
+            length = Recommendable.redis.zcard(similarity_set)
+            kfn = Recommendable.config.furthest_neighbors || 0
+
+            Recommendable.redis.zremrangebyrank(similarity_set, kfn, length - knn - 1)
+          end
+
           true
         end
 
@@ -110,6 +117,11 @@ module Recommendable
             end
 
             Recommendable.redis.del(temp_set)
+
+            if number_recommendations = Recommendable.config.recommendations_to_store
+              length = Recommendable.redis.zcard(recommended_set)
+              Recommendable.redis.zremrangebyrank(recommended_set, 0, length - number_recommendations - 1)
+            end
           end
 
           true

data/lib/recommendable/ratable.rb

@@ -29,7 +29,6 @@ module Recommendable
             warn "Model #{self} is not using a supported ORM. You must handle removal from Redis manually when destroying instances."
           end
 
-
           # Whether or not items belonging to this class can be recommended.
           #
           # @return true if a user class `recommends :this`
@@ -58,26 +57,28 @@ module Recommendable
           # Completely removes this item from redis. Called from a before_destroy hook.
           # @private
           def remove_from_recommendable!
+            sets  = [] # SREM needed
+            zsets = [] # ZREM needed
+            keys  = [] # DEL  needed
             # Remove this item from the score zset
-            Recommendable.redis.zrem(Recommendable::Helpers::RedisKeyMapper.score_set_for(self.class), id)
+            zsets << Recommendable::Helpers::RedisKeyMapper.score_set_for(self.class)
 
             # Remove this item's liked_by/disliked_by sets
-            %w[liked_by disliked_by].each do |action|
-              set = Recommendable::Helpers::RedisKeyMapper.send("#{action}_set_for", self.class, id)
-              Recommendable.redis.del(set)
-            end
+            keys << Recommendable::Helpers::RedisKeyMapper.liked_by_set_for(self.class, id)
+            keys << Recommendable::Helpers::RedisKeyMapper.disliked_by_set_for(self.class, id)
 
             # Remove this item from any user's like/dislike/hidden/bookmark sets
             %w[liked disliked hidden bookmarked].each do |action|
-              set = Recommendable::Helpers::RedisKeyMapper.send("#{action}_set_for", self.class, id)
-              Recommendable.redis.keys(set).each do |set|
-                Recommendable.redis.srem(set, id)
-              end
+              sets += Recommendable.redis.keys(Recommendable::Helpers::RedisKeyMapper.send("#{action}_set_for", self.class, '*'))
             end
 
             # Remove this item from any user's recommendation zset
-            Recommendable.redis.keys(Recommendable::Helpers::RedisKeyMapper.recommended_set_for(self.class, '*')).each do |zset|
-              Recommendable.redis.zrem(zset, id)
+            zsets += Recommendable.redis.keys(Recommendable::Helpers::RedisKeyMapper.recommended_set_for(self.class, '*'))
+
+            Recommendable.redis.pipelined do |redis|
+              sets.each { |set| redis.srem(set, id) }
+              zsets.each { |zset| redis.zrem(zset, id) }
+              redis.del(*keys)
             end
           end
         end

data/lib/recommendable/rater/recommender.rb

@@ -36,31 +36,34 @@ module Recommendable
       # Removes a user from Recommendable. Called internally on a before_destroy hook.
       # @private
       def remove_from_recommendable!
-        # Remove this user's similarity ZSET
-        Recommendable.redis.del(Recommendable::Helpers::RedisKeyMapper.similarity_set_for(id))
+        sets  = [] # SREM needed
+        zsets = [] # ZREM needed
+        keys  = [] # DEL  needed
 
         # Remove from other users' similarity ZSETs
-        Recommendable.redis.keys(Recommendable::Helpers::RedisKeyMapper.similarity_set_for('*')).each do |zset|
-          Recommendable.redis.zrem(zset, id)
-        end
+        zsets += Recommendable.redis.keys(Recommendable::Helpers::RedisKeyMapper.similarity_set_for('*'))
+
+        # Remove this user's similarity ZSET
+        keys << Recommendable::Helpers::RedisKeyMapper.similarity_set_for(id)
 
         # For each ratable class...
         Recommendable.config.ratable_classes.each do |klass|
           # Remove this user from any class member's liked_by/disliked_by sets
-          Recommendable.redis.keys(Recommendable::Helpers::RedisKeyMapper.liked_by_set_for(klass, '*')).each do |set|
-            Recommendable.redis.srem(set, id)
-          end
-
-          Recommendable.redis.keys(Recommendable::Helpers::RedisKeyMapper.disliked_by_set_for(klass, '*')).each do |set|
-            Recommendable.redis.srem(set, id)
-          end
+          sets += Recommendable.redis.keys(Recommendable::Helpers::RedisKeyMapper.liked_by_set_for(klass, '*'))
+          sets += Recommendable.redis.keys(Recommendable::Helpers::RedisKeyMapper.disliked_by_set_for(klass, '*'))
 
           # Remove this user's liked/disliked/hidden/bookmarked/recommended sets for the class
-          Recommendable.redis.del(Recommendable::Helpers::RedisKeyMapper.liked_set_for(klass, id))
-          Recommendable.redis.del(Recommendable::Helpers::RedisKeyMapper.disliked_set_for(klass, id))
-          Recommendable.redis.del(Recommendable::Helpers::RedisKeyMapper.hidden_set_for(klass, id))
-          Recommendable.redis.del(Recommendable::Helpers::RedisKeyMapper.bookmarked_set_for(klass, id))
-          Recommendable.redis.del(Recommendable::Helpers::RedisKeyMapper.recommended_set_for(klass, id))
+          keys << Recommendable::Helpers::RedisKeyMapper.liked_set_for(klass, id)
+          keys << Recommendable::Helpers::RedisKeyMapper.disliked_set_for(klass, id)
+          keys << Recommendable::Helpers::RedisKeyMapper.hidden_set_for(klass, id)
+          keys << Recommendable::Helpers::RedisKeyMapper.bookmarked_set_for(klass, id)
+          keys << Recommendable::Helpers::RedisKeyMapper.recommended_set_for(klass, id)
+        end
+
+        Recommendable.redis.pipelined do |redis|
+          sets.each { |set| redis.srem(set, id) }
+          zsets.each { |zset| redis.zrem(zset, id) }
+          redis.del(*keys)
         end
       end
     end

data/lib/recommendable/version.rb

@@ -1,8 +1,8 @@
 module Recommendable
   MAJOR = 2
-  MINOR = 0
-  PATCH = 4
-  PRE   = 20130313
+  MINOR = 1
+  PATCH = 0
+  PRE   = 1
 
   VERSION = [MAJOR, MINOR, PATCH, PRE].compact.join '.'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recommendable
 version: !ruby/object:Gem::Version
-  version: 2.0.4.20130313
+  version: 2.1.0.1
 platform: ruby
 authors:
 - David Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-13 00:00:00.000000000 Z
+date: 2013-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -165,7 +165,6 @@ files:
 - lib/recommendable/rater.rb
 - lib/recommendable/version.rb
 - lib/recommendable/workers/delayed_job.rb
-- lib/recommendable/workers/rails.rb
 - lib/recommendable/workers/resque.rb
 - lib/recommendable/workers/sidekiq.rb
 - lib/recommendable/workers/torque_box.rb

data/lib/recommendable/workers/rails.rb

@@ -1,16 +0,0 @@
-module Recommendable
-  module Workers
-    class Rails
-      attr_accessor :user_id
-
-      def initialize(user_id)
-        @user_id = user_id
-      end
-
-      def run
-        Recommendable::Helpers::Calculations.update_similarities_for(user_id)
-        Recommendable::Helpers::Calculations.update_recommendations_for(user_id)
-      end
-    end
-  end
-end