recommendable 1.1.7 → 2.0.0

data/lib/recommendable/rater/liker.rb

@@ -0,0 +1,122 @@
+module Recommendable
+  module Rater
+    module Liker
+      # Like an object. This will remove the item from a user's set of dislikes,
+      # or hidden items.
+      #
+      # @param [Object] obj the object to be liked
+      # @return true if object was liked successfully
+      # @raise [ArgumentError] if the passed object was not declared ratable
+      def like(obj)
+        raise(ArgumentError, 'Object has not been declared ratable.') unless obj.respond_to?(:recommendable?) && obj.recommendable?
+        return if likes?(obj)
+
+        run_hook(:before_like, obj)
+        Recommendable.redis.sadd(Recommendable::Helpers::RedisKeyMapper.liked_set_for(obj.class, id), obj.id)
+        Recommendable.redis.sadd(Recommendable::Helpers::RedisKeyMapper.liked_by_set_for(obj.class, obj.id), id)
+        run_hook(:after_like, obj)
+
+        true
+      end
+
+      # Check whether the user has liked an object.
+      #
+      # @param [Object] obj the object in question
+      # @return true if the user has liked obj, false if not
+      def likes?(obj)
+        Recommendable.redis.sismember(Recommendable::Helpers::RedisKeyMapper.liked_set_for(obj.class, id), obj.id)
+      end
+
+      # Unlike an object. This removes the object from a user's set of likes.
+      #
+      # @param [Object] obj the object to be unliked
+      # @return true if the object was liked successfully, nil if the object wasn't already liked
+      def unlike(obj)
+        return unless likes?(obj)
+
+        run_hook(:before_unlike, obj)
+        Recommendable.redis.srem(Recommendable::Helpers::RedisKeyMapper.liked_set_for(obj.class, id), obj.id)
+        Recommendable.redis.srem(Recommendable::Helpers::RedisKeyMapper.liked_by_set_for(obj.class, obj.id), id)
+        run_hook(:after_unlike, obj)
+
+        true
+      end
+
+      # Retrieve an array of objects the user has liked
+      #
+      # @return [Array] an array of records
+      def likes
+        Recommendable.config.ratable_classes.map { |klass| liked_for(klass) }.flatten
+      end
+
+      # Retrieve an array of objects both this user and another user have liked
+      #
+      # @return [Array] an array of records
+      def likes_in_common_with(user)
+        Recommendable.config.ratable_classes.map { |klass| liked_in_common_with(klass, user) }.flatten
+      end
+
+      # Get the number of items the user has liked
+      #
+      # @return [Fixnum] the number of liked items
+      def likes_count
+        Recommendable.config.ratable_classes.inject(0) do |sum, klass|
+          sum + liked_count_for(klass)
+        end
+      end
+
+      private
+
+      # Fetch IDs for objects belonging to a passed class that the user has liked
+      #
+      # @param [String, Symbol, Class] the class for which you want IDs
+      # @return [Array] an array of IDs
+      # @private
+      def liked_ids_for(klass)
+        ids = Recommendable.redis.smembers(Recommendable::Helpers::RedisKeyMapper.liked_set_for(klass, id))
+        ids.map!(&:to_i) if [:active_record, :data_mapper].include?(Recommendable.config.orm)
+        ids
+      end
+
+      # Fetch records belonging to a passed class that the user has liked
+      #
+      # @param [String, Symbol, Class] the class for which you want liked records
+      # @return [Array] an array of liked records
+      # @private
+      def liked_for(klass)
+        Recommendable.query(klass, liked_ids_for(klass))
+      end
+
+      # Get the number of items belonging to a passed class that the user has liked
+      #
+      # @param [String, Symbol, Class] the class for which you want a count of likes
+      # @return [Fixnum] the number of likes
+      # @private
+      def liked_count_for(klass)
+        Recommendable.redis.scard(Recommendable::Helpers::RedisKeyMapper.liked_set_for(klass, id))
+      end
+
+      # Get a list of records that both this user and a passed user have liked
+      #
+      # @param [User] the other user
+      # @param [String, Symbol, Class] the class of common liked items
+      # @return [Array] an array of records both users have liked
+      # @private
+      def liked_in_common_with(klass, user)
+        Recommendable.query(klass, liked_ids_in_common_with(klass, user))
+      end
+
+      # Get a list of IDs for records that both this user and a passed user have
+      # liked
+      #
+      # @param [User, Fixnum] the other user (or its ID)
+      # @param [String, Symbol, Class] the class of common liked items
+      # @return [Array] an array of IDs for records that both users have liked
+      # @private
+      def liked_ids_in_common_with(klass, user_id)
+        user_id = user_id.id if user_id.is_a?(Recommendable.config.user_class)
+        Recommendable.redis.sinter(Recommendable::Helpers::RedisKeyMapper.liked_set_for(klass, id), Recommendable::Helpers::RedisKeyMapper.liked_set_for(klass, user_id))
+      end
+    end
+  end
+end

data/lib/recommendable/rater/recommender.rb

@@ -0,0 +1,68 @@
+module Recommendable
+  module Rater
+    module Recommender
+      # Get a list of raters that have been found to be the most similar to
+      # self. They are sorted by the calculated similarity value.
+      #
+      # @param [Fixnum] count the number of users to return (defaults to 10)
+      # @return [Array] An array of instances of your user class
+      def similar_raters(count = 10)
+        ids = Recommendable.redis.zrevrange(Recommendable::Helpers::RedisKeyMapper.similarity_set_for(id), 0, count - 1)
+        Recommendable.query(self.class, ids).sort_by { |user| ids.index(user.id.to_s) }
+      end
+
+      private
+
+      # Fetch a list of recommendations for a passed class.
+      #
+      # @param [String, Symbol, Class] klass the class from which to get recommendations
+      # @param [Fixnum] count the number of recommendations to fetch (defaults to 10)
+      # @return [Array] a list of things this person's gonna love
+      def recommended_for(klass, count = 10)
+        recommended_set = Recommendable::Helpers::RedisKeyMapper.recommended_set_for(klass, self.id)
+        return Recommendable.query(klass, []) unless rated_anything? && Recommendable.redis.zcard(recommended_set) > 0
+
+        ids = Recommendable.redis.zrevrange(recommended_set, 0, count - 1)
+        Recommendable.query(klass, ids)
+      end
+
+      # Removes an item from a user's set of recommendations
+      # @private
+      def unrecommend(obj)
+        Recommendable.redis.zrem(Recommendable::Helpers::RedisKeyMapper.recommended_set_for(obj.class, id), obj.id)
+        true
+      end
+
+      # 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))
+
+        # Remove from other users' similarity ZSETs
+        Recommendable.redis.keys(Recommendable::Helpers::RedisKeyMapper.similarity_set_for('*')).each do |zset|
+          Recommendable.redis.zrem(zset, id)
+        end
+
+        # 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
+
+          # 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))
+        end
+      end
+    end
+  end
+end

data/lib/recommendable/version.rb

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

data/lib/recommendable/workers/delayed_job.rb

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

data/lib/recommendable/workers/rails.rb

@@ -0,0 +1,16 @@
+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

data/lib/recommendable/workers/resque.rb

@@ -0,0 +1,13 @@
+module Recommendable
+  module Workers
+    class Resque
+      include ::Resque::Plugins::UniqueJob if defined?(::Resque::Plugins::UniqueJob)
+      @queue = :recommendable
+
+      def self.perform(user_id)
+        Recommendable::Helpers::Calculations.update_similarities_for(user_id)
+        Recommendable::Helpers::Calculations.update_recommendations_for(user_id)
+      end
+    end
+  end
+end

data/lib/recommendable/workers/sidekiq.rb

@@ -0,0 +1,13 @@
+module Recommendable
+  module Workers
+    class Sidekiq
+      include ::Sidekiq::Worker
+      sidekiq_options :unique => true, :queue => :recommendable
+
+      def perform(user_id)
+        Recommendable::Helpers::Calculations.update_similarities_for(user_id)
+        Recommendable::Helpers::Calculations.update_recommendations_for(user_id)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: recommendable
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,58 +9,58 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-28 00:00:00.000000000 Z
+date: 2012-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 3.0.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 2.2.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
-  name: miniskirt
+  name: hooks
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 0.2.1
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -76,23 +76,23 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: miniskirt
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -114,151 +114,81 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :runtime
+        version: 3.1.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.2.0
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: hooks
+  name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.2.1
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.2.1
-description: Allow a model (typically User) to Like and/or Dislike models in your
-  app. Generate recommendations quickly using redis.
-email: david@davidcelis.com
+        version: '0'
+description: ! 'A Like/Dislike recommendation engine for Ruby apps using Redis.
+
+'
+email:
+- david@davidcelis.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
-- CHANGELOG.markdown
-- Gemfile
-- Gemfile.lock
-- LICENSE.txt
-- README.markdown
-- Rakefile
-- TODO
-- app/models/recommendable/dislike.rb
-- app/models/recommendable/ignore.rb
-- app/models/recommendable/like.rb
-- app/models/recommendable/stash.rb
-- app/workers/recommendable/delayed_job_worker.rb
-- app/workers/recommendable/rails_worker.rb
-- app/workers/recommendable/resque_worker.rb
-- app/workers/recommendable/sidekiq_worker.rb
-- config/routes.rb
-- db/migrate/20120124193723_create_likes.rb
-- db/migrate/20120124193728_create_dislikes.rb
-- db/migrate/20120127092558_create_ignores.rb
-- db/migrate/20120131173909_create_stashes.rb
-- lib/generators/recommendable/USAGE
-- lib/generators/recommendable/install_generator.rb
-- lib/generators/recommendable/templates/initializer.rb
-- lib/recommendable.rb
-- lib/recommendable/acts_as_recommendable.rb
-- lib/recommendable/acts_as_recommended_to.rb
-- lib/recommendable/engine.rb
-- lib/recommendable/exceptions.rb
+- lib/recommendable/configuration.rb
+- lib/recommendable/helpers/calculations.rb
+- lib/recommendable/helpers/queriers.rb
+- lib/recommendable/helpers/redis_key_mapper.rb
 - lib/recommendable/helpers.rb
-- lib/recommendable/railtie.rb
+- lib/recommendable/orm/active_record.rb
+- lib/recommendable/orm/data_mapper.rb
+- lib/recommendable/orm/mongo_mapper.rb
+- lib/recommendable/orm/mongoid.rb
+- lib/recommendable/ratable/dislikable.rb
+- lib/recommendable/ratable/likable.rb
+- lib/recommendable/ratable.rb
+- lib/recommendable/rater/bookmarker.rb
+- lib/recommendable/rater/disliker.rb
+- lib/recommendable/rater/hider.rb
+- lib/recommendable/rater/liker.rb
+- lib/recommendable/rater/recommender.rb
+- lib/recommendable/rater.rb
 - lib/recommendable/version.rb
-- lib/sidekiq/middleware/client/unique_jobs.rb
-- lib/sidekiq/middleware/server/unique_jobs.rb
-- lib/tasks/recommendable_tasks.rake
-- recommendable.gemspec
-- script/rails
-- spec/configuration_spec.rb
-- spec/dummy/README.rdoc
-- spec/dummy/Rakefile
-- spec/dummy/app/assets/javascripts/application.js
-- spec/dummy/app/assets/stylesheets/application.css
-- spec/dummy/app/controllers/application_controller.rb
-- spec/dummy/app/helpers/application_helper.rb
-- spec/dummy/app/mailers/.gitkeep
-- spec/dummy/app/models/.gitkeep
-- spec/dummy/app/models/bully.rb
-- spec/dummy/app/models/movie.rb
-- spec/dummy/app/models/php_framework.rb
-- spec/dummy/app/models/user.rb
-- spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/config.ru
-- spec/dummy/config/application.rb
-- spec/dummy/config/boot.rb
-- spec/dummy/config/database.yml
-- spec/dummy/config/environment.rb
-- spec/dummy/config/environments/development.rb
-- spec/dummy/config/environments/production.rb
-- spec/dummy/config/environments/test.rb
-- spec/dummy/config/initializers/backtrace_silencers.rb
-- spec/dummy/config/initializers/inflections.rb
-- spec/dummy/config/initializers/mime_types.rb
-- spec/dummy/config/initializers/recommendable.rb
-- spec/dummy/config/initializers/secret_token.rb
-- spec/dummy/config/initializers/session_store.rb
-- spec/dummy/config/initializers/wrap_parameters.rb
-- spec/dummy/config/locales/en.yml
-- spec/dummy/config/routes.rb
-- spec/dummy/db/migrate/20120128005553_create_likes.recommendable.rb
-- spec/dummy/db/migrate/20120128005554_create_dislikes.recommendable.rb
-- spec/dummy/db/migrate/20120128005555_create_ignores.recommendable.rb
-- spec/dummy/db/migrate/20120128020228_create_users.rb
-- spec/dummy/db/migrate/20120128020413_create_movies.rb
-- spec/dummy/db/migrate/20120128024632_create_php_frameworks.rb
-- spec/dummy/db/migrate/20120128024804_create_bullies.rb
-- spec/dummy/db/migrate/20120131195416_create_stashes.recommendable.rb
-- spec/dummy/db/schema.rb
-- spec/dummy/lib/assets/.gitkeep
-- spec/dummy/log/.gitkeep
-- spec/dummy/public/404.html
-- spec/dummy/public/422.html
-- spec/dummy/public/500.html
-- spec/dummy/public/favicon.ico
-- spec/dummy/recommendable_dummy_development
-- spec/dummy/recommendable_dummy_test
-- spec/dummy/script/rails
-- spec/factories.rb
-- spec/models/dislike_spec.rb
-- spec/models/ignore_spec.rb
-- spec/models/like_spec.rb
-- spec/models/movie_spec.rb
-- spec/models/stash_spec.rb
-- spec/models/user_benchmark_spec.rb
-- spec/models/user_spec.rb
-- spec/spec_helper.rb
-homepage: http://github.com/davidcelis/recommendable
+- lib/recommendable/workers/delayed_job.rb
+- lib/recommendable/workers/rails.rb
+- lib/recommendable/workers/resque.rb
+- lib/recommendable/workers/sidekiq.rb
+- lib/recommendable.rb
+homepage: https://github.com/davidcelis/recommendable
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -281,5 +211,6 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Add like-based and/or dislike-based recommendations to your app.
+summary: A Like/Dislike recommendation engine for Ruby apps using Redis
 test_files: []
+has_rdoc: yard