recommendable 0.1.2 → 0.1.3

data/CHANGELOG.markdown

@@ -0,0 +1,16 @@
+Changelog
+=========
+
+0.1.2 (current version)
+-----------------------
+
+* Fix an issue that could cause similarity values between users to be incorrect.
+* `User#common_likes_with` and `User#common_dislikes_with` now return the actual Model instances by default. Accordingly, these methods are no longer private.
+
+0.1.1
+-----
+* Introduce the "stashed item" feature. This gives the ability for users to save an item in a list to try later, while at the same time removing it from their list of recommendations. This lets your users keep getting new recommendations without necessarily having to rate what they know they want to try.
+
+0.1.0
+-----
+* Welcome to recommendable!

data/README.markdown

@@ -29,7 +29,9 @@ Add the following to your Rails application's `Gemfile`:
 
 After your `bundle install`, you can then run:
 
-    $ rails g recommendable:install (--user-class=User)
+``` bash
+$ rails g recommendable:install (--user-class=User)
+```
 
 After running the installation generator, you should double check
 `config/initializers/recommendable.rb` for options on configuring your Redis
@@ -42,7 +44,9 @@ to wait. In fact, you can run multiple resque workers if you wish.
 
 Assuming you have `redis-server` running...
 
-    $ QUEUE=recommendable rake environment resque:work
+``` bash
+$ QUEUE=recommendable rake environment resque:work
+```
 
 You can run this command multiple times if you wish to start more than one
 worker. This is the standard rake task for starting a Resque worker so, for
@@ -194,6 +198,8 @@ Movie.find_by_title('Star Wars: Episode I - The Phantom Menace').disliked_by
 #=> [#<User username: 'davidcelis'>]
 current_user.common_likes_with(friend)
 #=> [#<Movie title: '2001: A Space Odyssey', year: 1968>]
+current_user.common_likes_with(friend, :class => Show)
+#=> []
 ```
 
 `common_dislikes_with` and `disagreements_with` are available for similar use.
@@ -322,7 +328,7 @@ Links
 -----
 * Code: `git clone git://github.com/davidcelis/recommendable.git`
 * Home: <http://github.com/davidcelis/recommendable>
-* Docs: <http://rubydoc.info/gems/recommendable/0.1.0/frames>
+* Docs: <http://rubydoc.info/gems/recommendable/frames>
 * Bugs: <http://github.com/davidcelis/recommendable/issues>
 * Gems: <http://rubygems.org/gems/recommendable>
 

data/TODO

@@ -1,6 +1,5 @@
 = TODO
 
-== Next update
-
-* Make public methods to return likes/dislikes that are common between two users
+* Recalculate similarity values ONLY for users that have liked/disliked the item
+  that self just liked/disliked
 * Allow the option NOT to queue up on like/dislike/ignore?

data/app/{jobs → workers}/recommendable/recommendation_refresher.rb

@@ -3,9 +3,10 @@ module Recommendable
     include Resque::Plugins::UniqueJob
     @queue = :recommendable
     
-    def self.perform(user_id)
+    def self.perform(user_id, other_ids)
       user = Recommendable.user_class.find(user_id)
-      user.send :update_similarities
+      return if other_ids.empty?
+      user.send :update_similarities, other_ids
       user.send :update_recommendations
     end
   end

data/lib/recommendable/acts_as_recommendable.rb

@@ -22,6 +22,19 @@ module Recommendable
           def has_been_rated?
             likes.count + dislikes.count > 0
           end
+
+          # Returns an array of users that have liked or disliked this item.
+          # @return [Array] an array of users
+          def rated_by
+            liked_by + disliked_by
+          end
+          
+          # Returns an array of IDs of users that have liked or disliked this item.
+          # @return [Array] an array of user IDs
+          # @private
+          def rates_by
+            likes.map(&:user_id) + dislikes.map(&:user_id)
+          end
           
           # Used for setup purposes. Calls convenience methods to create sets
           # in redis of users that both like and dislike this object.
@@ -39,7 +52,7 @@ module Recommendable
             Recommendable.redis.del "#{self.class}:#{id}:disliked_by"
           end
 
-          private :likes, :dislikes, :ignores, :stashes,
+          private :likes, :dislikes, :ignores, :stashes, :rates_by,
                   :create_recommendable_sets, :destroy_recommendable_sets
         end
       end

data/lib/recommendable/acts_as_recommended_to.rb

@@ -42,12 +42,9 @@ module Recommendable
       def like(object)
         raise RecordNotRecommendableError unless object.recommendable?
         return if likes?(object)
-        undislike(object)
-        unstash(object)
-        unignore(object)
-        unpredict(object)
+        completely_unrecommend(object)
         likes.create!(:likeable_id => object.id, :likeable_type => object.class.to_s)
-        Resque.enqueue RecommendationRefresher, self.id
+        Resque.enqueue RecommendationRefresher, self.id, object.send(:rates_by)
         true
       end
       
@@ -65,7 +62,7 @@ module Recommendable
       # @return true if object is unliked, nil if nothing happened
       def unlike(object)
         if likes.where(:likeable_id => object.id, :likeable_type => object.class.to_s).first.try(:destroy)
-          Resque.enqueue RecommendationRefresher, self.id
+          Resque.enqueue RecommendationRefresher, self.id, object.send(:rates_by)
           true
         end
       end
@@ -114,12 +111,9 @@ module Recommendable
       def dislike(object)
         raise RecordNotRecommendableError unless object.recommendable?
         return if dislikes?(object)
-        unlike(object)
-        unstash(object)
-        unignore(object)
-        unpredict(object)
+        completely_unrecommend(object)
         dislikes.create!(:dislikeable_id => object.id, :dislikeable_type => object.class.to_s)
-        Resque.enqueue RecommendationRefresher, self.id
+        Resque.enqueue RecommendationRefresher, self.id, object.send(:rates_by)
         true
       end
       
@@ -137,7 +131,7 @@ module Recommendable
       # @return true if object is removed from self's dislikes, nil if nothing happened
       def undislike(object)
         if dislikes.where(:dislikeable_id => object.id, :dislikeable_type => object.class.to_s).first.try(:destroy)
-          Resque.enqueue RecommendationRefresher, self.id
+          Resque.enqueue RecommendationRefresher, self.id, object.send(:rates_by)
           true
         end
       end
@@ -252,10 +246,7 @@ module Recommendable
       def ignore(object)
         raise RecordNotRecommendableError unless object.recommendable?
         return if has_ignored?(object)
-        unlike(object)
-        undislike(object)
-        unstash(object)
-        unpredict(object)
+        completely_unrecommend(object)
         ignores.create!(:ignoreable_id => object.id, :ignoreable_type => object.class.to_s)
         true
       end
@@ -309,10 +300,6 @@ module Recommendable
     end
     
     module RecommendationMethods
-      def self.acts_as_recommended_to? ; true ; end
-
-      def can_receive_recommendations? ; self.class.acts_as_recommended_to? ; end
-
       # Checks to see if self has already liked or disliked a passed object.
       # 
       # @param [Object] object the object you want to check
@@ -362,15 +349,13 @@ module Recommendable
 
         unioned_predictions = "#{self.class}:#{id}:predictions"
         Recommendable.redis.zunionstore unioned_predictions, Recommendable.recommendable_classes.map {|klass| predictions_set_for(klass)}
-        return [] if Recommendable.redis.zcard(unioned_predictions) == 0
         
         recommendations = Recommendable.redis.zrevrange(unioned_predictions, 0, options[:count]).map do |object|
           klass, id = object.split(":")
           klass.constantize.find(id)
         end
         
-        Recommendable.redis.del unioned_predictions
-        return recommendations
+        Recommendable.redis.del(unioned_predictions) and return recommendations
       end
       
       # Get a list of recommendations for self on a single recommendable type.
@@ -385,16 +370,16 @@ module Recommendable
         defaults = { :count => 10 }
         options = defaults.merge options
         
-        recommendations = []
-        return recommendations if likes_for(klass).count + dislikes_for(klass).count == 0 || Recommendable.redis.zcard(predictions_set_for(klass)) == 0
+        return [] if likes_for(klass).count + dislikes_for(klass).count == 0 || Recommendable.redis.zcard(predictions_set_for(klass)) == 0
       
+        recommendations = []
         i = 0
         until recommendations.size == options[:count]
           prediction = Recommendable.redis.zrevrange(predictions_set_for(klass), i, i).first
           return recommendations unless prediction # User might not have enough recommendations to return
           
           object = klassify(klass).find(prediction.split(":")[1])
-          recommendations << object unless has_ignored?(object)
+          recommendations << object
           i += 1
         end
       
@@ -414,7 +399,7 @@ module Recommendable
       #
       # @param [Object] object the object to fetch the probability for
       # @return [Float] the likelihood of self disliking the passed object
-      # @see #probability of liking
+      # @see {#probability_of_liking}
       def probability_of_disliking(object)
         -probability_of_liking(object)
       end
@@ -434,7 +419,7 @@ module Recommendable
         rater.create_recommended_to_sets
         agreements = common_likes_with(rater, :return_records => false).size
         agreements += common_dislikes_with(rater, :return_records => false).size
-        disagreements = disagreements_with(rater).size
+        disagreements = disagreements_with(rater, :return_records => false).size
         
         similarity = (agreements - disagreements).to_f / (likes.count + dislikes.count)
         rater.destroy_recommended_to_sets
@@ -462,7 +447,7 @@ module Recommendable
             in_common = Recommendable.redis.sinter(likes_set_for(klass), rater.likes_set_for(klass))
 
             if options[:return_records]
-              klassify(klass).find in_common if options[:return_records]
+              klassify(klass).find in_common
             else
               in_common.map {|id| "#{klassify(klass)}:#{id}"}
             end
@@ -491,7 +476,7 @@ module Recommendable
             in_common = Recommendable.redis.sinter(dislikes_set_for(klass), rater.dislikes_set_for(klass))
 
             if options[:return_records]
-              klassify(klass).find in_common if options[:return_records]
+              klassify(klass).find in_common
             else
               in_common.map {|id| "#{klassify(klass)}:#{id}"}
             end
@@ -562,13 +547,14 @@ module Recommendable
       # other users. This is called in the Resque job to refresh recommendations.
       #
       # @private
-      def update_similarities
+      def update_similarities(rater_ids = nil)
         return unless has_rated_anything?
         create_recommended_to_sets
+        rater_ids ||= Recommendable.user_class.select(:id).map!(&:id)
         
-        Recommendable.user_class.find_each do |rater|
+        Recommendable.user_class.find(rater_ids).each do |rater|
           next if self == rater || !rater.can_rate?
-          Recommendable.redis.zadd similarity_set, similarity_with(rater), "#{rater.id}"
+          Recommendable.redis.zadd similarity_set, similarity_with(rater), rater.id
         end
         
         destroy_recommended_to_sets
@@ -644,6 +630,21 @@ module Recommendable
         end
       end
 
+      # Used internally during liking/disliking/stashing/ignoring objects. This
+      # will prep an object to be liked, disliked, etc. by making sure that self
+      # doesn't already have this item in their list of likes, dislikes, stashed
+      # items or ignored items.
+      #
+      # param [Object] object the object to destroy Recommendable models for
+      # @private
+      def completely_unrecommend(object)
+        unlike(object)
+        undislike(object)
+        unstash(object)
+        unignore(object)
+        unpredict(object)
+      end
+
       protected :likes_set_for, :dislikes_set_for, :create_recommended_to_sets,
                 :destroy_recommended_to_sets
 

data/lib/recommendable/railtie.rb

@@ -2,5 +2,14 @@ module Recommendable
   class Railtie < Rails::Railtie
     ActiveRecord::Base.send :include, Recommendable::ActsAsRecommendedTo
     ActiveRecord::Base.send :include, Recommendable::ActsAsRecommendable
+
+    # Force load models if in a non-development environment and not caching classes
+    config.after_initialize do |app|
+      force_load_models if !Rails.env.development? && !app.config.cache_classes
+    end
+
+    def self.force_load_models
+      Dir["#{ Rails.root }/app/models/**/*.rb"].each { |m| load m }
+    end
   end
 end

data/lib/recommendable/version.rb

@@ -1,3 +1,3 @@
 module Recommendable
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/recommendable.gemspec

@@ -4,7 +4,7 @@ require File.expand_path('lib/recommendable/version')
 Gem::Specification.new do |s|
   s.name = "recommendable"
   s.version = Recommendable::VERSION
-  s.date = "2012-01-28"
+  s.date = Time.now.strftime('%Y-%m-%d')
   
   s.authors = ["David Celis"]
   s.email = "david@davidcelis.com"

data/spec/models/user_benchmark_spec.rb

@@ -35,8 +35,8 @@ class UserBenchmarkSpec < MiniTest::Unit::TestCase
           @users.sample.send(@actions.sample, m)
         end
   
-        @user.update_similarities
-        @user.update_recommendations
+        @user.send :update_similarities
+        @user.send :update_recommendations
         Recommendable.redis.flushdb
 
         User.delete_all

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: recommendable
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-28 00:00:00.000000000 Z
+date: 2012-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70238498735420 !ruby/object:Gem::Requirement
+  requirement: &70109049948340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70238498735420
+  version_requirements: *70109049948340
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70238498734880 !ruby/object:Gem::Requirement
+  requirement: &70109049964200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70238498734880
+  version_requirements: *70109049964200
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70238498734380 !ruby/object:Gem::Requirement
+  requirement: &70109049963440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70238498734380
+  version_requirements: *70109049963440
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70238498749840 !ruby/object:Gem::Requirement
+  requirement: &70109049962620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *70238498749840
+  version_requirements: *70109049962620
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70238498749020 !ruby/object:Gem::Requirement
+  requirement: &70109049961560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70238498749020
+  version_requirements: *70109049961560
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70238498748140 !ruby/object:Gem::Requirement
+  requirement: &70109049959600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70238498748140
+  version_requirements: *70109049959600
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70238498746940 !ruby/object:Gem::Requirement
+  requirement: &70109049958960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70238498746940
+  version_requirements: *70109049958960
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70238498745320 !ruby/object:Gem::Requirement
+  requirement: &70109049957640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70238498745320
+  version_requirements: *70109049957640
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70238498744040 !ruby/object:Gem::Requirement
+  requirement: &70109049971980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,10 +109,10 @@ dependencies:
         version: 2.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70238498744040
+  version_requirements: *70109049971980
 - !ruby/object:Gem::Dependency
   name: resque
-  requirement: &70238498758460 !ruby/object:Gem::Requirement
+  requirement: &70109049971120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +120,10 @@ dependencies:
         version: 1.19.0
   type: :runtime
   prerelease: false
-  version_requirements: *70238498758460
+  version_requirements: *70109049971120
 - !ruby/object:Gem::Dependency
   name: resque-loner
-  requirement: &70238498757620 !ruby/object:Gem::Requirement
+  requirement: &70109049969980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -131,7 +131,7 @@ dependencies:
         version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70238498757620
+  version_requirements: *70109049969980
 description: Allow a model (typically User) to Like and/or Dislike models in your
   app. Generate recommendations quickly using redis.
 email: david@davidcelis.com
@@ -141,17 +141,18 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.markdown
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.markdown
 - Rakefile
 - TODO
-- app/jobs/recommendable/recommendation_refresher.rb
 - app/models/recommendable/dislike.rb
 - app/models/recommendable/ignore.rb
 - app/models/recommendable/like.rb
 - app/models/recommendable/stashed_item.rb
+- app/workers/recommendable/recommendation_refresher.rb
 - config/routes.rb
 - db/migrate/20120124193723_create_likes.rb
 - db/migrate/20120124193728_create_dislikes.rb