acts_as_recommendable 0.0.2

data/lib/cache_fix.rb

@@ -0,0 +1,27 @@
+# Because Rails' FileStore doesn't Marshal data
+rails_ver = Rails.respond_to?(:version) ? Rails.version : Rails::VERSION::STRING
+if rails_ver == '2.1.0'
+
+  module ActiveSupport
+    module Cache
+      class FileStore < Store
+        attr_reader :cache_path
+
+        def read(name, options = nil)
+          super
+          File.open(real_file_path(name), 'rb') { |f| Marshal.load(f) } rescue nil
+        end
+
+        def write(name, value, options = nil)
+          super
+          ensure_cache_path(File.dirname(real_file_path(name)))
+          File.atomic_write(real_file_path(name), cache_path) { |f| Marshal.dump(value, f) }
+        rescue => e
+          logger.error "Couldn't create cache directory: #{name} (#{e.message})" if logger
+        end
+      
+      end
+    end
+  end
+
+end

data/lib/optimizations.rb

@@ -0,0 +1,73 @@
+require 'inline'
+module MadeByMany
+  module ActsAsRecommendable
+    class Optimizations
+      module InlineC
+        inline do |builder|
+          builder.include "<math.h>"
+          builder.include "<ruby.h>"
+          builder.c '
+          double c_sim_pearson(VALUE items, int n, VALUE prefs1, VALUE prefs2) {
+            double sum1 = 0.0;
+            double sum2 = 0.0;
+            double sum1Sq = 0.0;
+            double sum2Sq = 0.0;
+            double pSum = 0.0;
+            double num;
+            double den;
+            int i;
+
+            VALUE *items_a  = RARRAY_PTR(items);
+
+            for(i=0; i<n; i++) {
+              double prefs1_item;
+              double prefs2_item;
+
+              VALUE prefs1_item_ob;
+              VALUE prefs2_item_ob;
+
+              if (!st_lookup(RHASH(prefs1)->ntbl, items_a[i], &prefs1_item_ob)) {
+                prefs1_item = 0.0;
+              } else {
+                prefs1_item = NUM2DBL(prefs1_item_ob);
+              }
+
+              if (!st_lookup(RHASH(prefs2)->ntbl, items_a[i], &prefs2_item_ob)) {
+                prefs2_item = 0.0;
+              } else {
+                prefs2_item = NUM2DBL(prefs2_item_ob);
+              }
+
+              sum1   += prefs1_item;
+              sum2   += prefs2_item;
+              sum1Sq += pow(prefs1_item, 2);
+              sum2Sq += pow(prefs2_item, 2);
+              pSum   += prefs2_item * prefs1_item;
+            }
+
+            num = pSum - ( ( sum1 * sum2 ) / n );
+            den = sqrt( ( sum1Sq - ( pow(sum1, 2) ) / n ) * ( sum2Sq - ( pow(sum2, 2) ) / n ) );
+            if(den == 0){
+              return 0.0;
+            } else {
+              return num / den;
+            }
+          }'
+        end
+      end
+      class << self
+        include InlineC
+      end
+    end
+
+    module Logic
+      # Pearson score
+      def self.sim_pearson(prefs, items, person1, person2)
+        n = items.length
+        return 0 if n == 0
+        Optimizations.c_sim_pearson(items, n, prefs[person1], prefs[person2])
+      end
+
+    end     
+  end
+end

data/lib/railtie.rb

@@ -0,0 +1,12 @@
+require 'rails'
+
+ActiveRecord::Base.send(:include, MadeByMany::ActsAsRecommendable)
+
+
+class MadeByMany::Railtie < ::Rails::Railtie
+
+  rake_tasks do
+    load File.join(File.dirname(__FILE__), 'tasks', 'acts_as_recommendable_tasks.rake')
+    # require File.join(File.dirname(__FILE__), 'tasks', 'acts_as_recommendable_tasks.rake')
+  end
+end

data/lib/tasks/acts_as_recommendable_tasks.rake

@@ -0,0 +1,56 @@
+namespace :recommendations do
+
+  desc 'builds the recommendations dataset'
+  task :build => [:environment] do
+    MadeByMany::ActsAsRecommendable::Logic.module_eval do
+      # This will need to change to your specific model:
+      options = User.aar_options
+      
+      puts 'Finding items...'
+
+      # You may want to optimize this SQL, like this:
+      items = options[:on_class].pluck(:id)
+      
+      prefs = {}
+      
+      puts 'Finding users...'
+      
+      # You may want to optimize this SQL
+      users = options[:class].includes(options[:on])
+      
+      pbar = ProgressBar.create(:title => 'Gen matrix', :total => items.length)
+      items.each do |item_id|
+        prefs[item_id] ||= {}
+        users.each do |user|
+          if user.aar_items_with_scores[item_id]
+            score = user.aar_items_with_scores[item_id].aar_score
+            prefs[item_id][user.id] = score
+          end
+        end
+        pbar.increment
+      end
+      pbar.finish
+      matrix = [users.collect(&:id), prefs]
+      
+      pbar = ProgressBar.create(:title => 'Gen dataset', :total => prefs.keys.length)
+      
+      if options[:split_dataset]
+        generate_dataset(options, matrix) {|item, scores|
+          Rails.cache.write("aar_#{options[:on]}_#{item}", scores)
+          pbar.inc
+        }
+      else
+        result = {}
+        generate_dataset(options, matrix) {|item, scores|
+          result[item] = scores
+          pbar.increment
+        }
+        Rails.cache.write("aar_#{options[:on]}_dataset", result)
+      end
+      
+      pbar.finish
+      
+      puts 'Rebuild successful'
+    end
+  end
+end

data/test/.gitignore

@@ -0,0 +1,3 @@
+*.sqlite3.db
+*.sqlite3
+*.log

data/test/acts_as_recommendable_test.rb

@@ -0,0 +1,124 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class Book < ActiveRecord::Base
+  has_many :user_books
+  has_many :users, :through => :user_books
+end
+
+class UserBook < ActiveRecord::Base
+  belongs_to :book
+  belongs_to :user
+end
+
+class User < ActiveRecord::Base
+  has_many :user_books
+  has_many :books, :through => :user_books
+  acts_as_recommendable :books, :through => :user_books
+end
+
+
+class ActsAsRecommendableTest < ActiveSupport::TestCase
+  
+  def setup
+    @users = (1..10).collect { |n| User.create(:name => "Patient #{n}") }
+    @books = (1..20).collect { |n| Book.create(:name => "Book #{n}") }
+
+    (1..8).collect { |n| UserBook.create(:user_id => 1, :book_id => n) }    
+    [2, 4, 5, 7, 8].collect { |n| UserBook.create(:user_id => 2, :book_id => n) }
+    [3, 4, 5, 6].collect { |n| UserBook.create(:user_id => 3, :book_id => n) }
+    [9, 10, 11].collect { |n| UserBook.create(:user_id => 4, :book_id => n) }
+    [9, 10].collect { |n| UserBook.create(:user_id => 5, :book_id => n) }
+    [1, 2, 19, 20].collect { |n| UserBook.create(:user_id => 6, :book_id => n) }
+    [1, 2, 20].collect { |n| UserBook.create(:user_id => 7, :book_id => n) }
+    [12, 13, 14, 15, 1, 10, 20].collect { |n| UserBook.create(:user_id => 8, :book_id => n) }
+    [12, 13, 1, 10, 20].collect { |n| UserBook.create(:user_id => 9, :book_id => n) }
+    [14, 1, 10, 20].collect { |n| UserBook.create(:user_id => 10, :book_id => n) }
+  end
+  
+  def test_available_methods
+    user = User.find(@users[0].id)
+    assert_not_nil user
+    assert_respond_to user, :similar_users
+    assert_respond_to user, :recommended_books
+  end
+  
+  def test_similar_users
+    sim_users = get_sim_users
+    assert_not_nil sim_users
+  end
+  
+  def test_similar_users_format
+    sim_users = get_sim_users
+    assert_kind_of Array, sim_users
+    assert_kind_of User, sim_users.first
+    assert_kind_of Numeric, sim_users.first.similar_score
+  end
+  
+  def test_similar_users_results
+    sim_users = get_sim_users
+    assert sim_users.include?(User.find(2))
+    assert_respond_to sim_users[0], :similar_score
+    assert !sim_users.include?(User.find(5))
+  end
+  
+  def test_similar_users_scores
+    sim_users = get_sim_users
+    assert_respond_to sim_users[0], :similar_score
+    assert sim_users[0].similar_score > 0
+  end
+
+  def test_recommended_books
+    recommended_books = get_recommend_books
+    assert_not_nil recommended_books
+  end
+  
+  def test_recommended_books_format
+    recommended_books = get_recommend_books
+    assert_kind_of Array, recommended_books
+    assert_kind_of Book, recommended_books.first
+    assert_kind_of Numeric, recommended_books.first.recommendation_score
+  end
+  
+  def test_recommended_books_results
+    recommended_books = get_recommend_books
+    assert_equal true, recommended_books.include?(Book.find(3))
+    assert recommended_books.find {|b| b == Book.find(3) }.recommendation_score > 0
+  end
+  
+  def test_recommended_books_scores
+    recommended_books = get_recommend_books
+    assert_respond_to recommended_books[0], :recommendation_score
+    assert recommended_books[0].recommendation_score > 0
+  end
+  
+  def test_dataset
+    use_dataset {
+      MadeByMany::ActsAsRecommendable::Logic.module_eval do
+        generate_dataset(User.aar_options) {|item, scores|
+          Rails.cache.write("aar_#{User.aar_options[:on]}_#{item}", scores)
+        }
+      end
+      recommended_books = get_recommend_books
+      assert_equal true, recommended_books.include?(Book.find(3))
+      assert recommended_books.find {|b| b == Book.find(3) }.recommendation_score > 0
+    }
+  end
+  
+  private
+    def use_dataset
+      User.aar_options[:use_dataset] = true
+      yield
+      User.aar_options[:use_dataset] = false
+    end  
+  
+    def get_sim_users
+      user = User.find(1)
+      user.similar_users
+    end
+    
+    def get_recommend_books
+      user = User.find(2)
+      user.recommended_books
+    end
+  
+end

data/test/database.yml

@@ -0,0 +1,18 @@
+sqlite:
+  :adapter: sqlite
+  :database: acts_as_recommendable.sqlite.db
+sqlite3:
+  :adapter: sqlite3
+  :database: acts_as_recommendable.sqlite3.db
+postgresql:
+  :adapter: postgresql
+  :username: postgres
+  :password: postgres
+  :database: acts_as_recommendable_test
+  :min_messages: ERROR
+mysql:
+  :adapter: mysql
+  :host: localhost
+  :username: rails
+  :password:
+  :database: acts_as_recommendable_test

data/test/fixtures/books.yml

@@ -0,0 +1,81 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+
+no_time_for_goodbye:
+    id: 1
+    name: No Time For Goodbye
+
+the_outcast:
+    id: 2
+    name: The Outcast
+    
+the_forgotten_garden:
+    id: 3
+    name: The Forgotten Garden
+    
+the_road_home:
+    id: 4
+    name: The Road Home
+    
+east_of_the_sun:
+    id: 5
+    name: East of the Sun
+    
+the_kite_runner:
+    id: 6
+    name: The Kite Runner
+    
+the_book_thief:
+    id: 7
+    name: The Book Thief
+    
+watchmen:
+    id: 8
+    name: The Watchmen
+    
+down_river:
+    id: 9
+    name: Down River
+    
+the_ghost:
+    id: 10
+    name: The Ghost
+    
+the_secret:
+    id: 11
+    name: The Secret
+    
+eclipse:
+    id: 12
+    name: Eclipse
+    
+twilight:
+    id: 13
+    name: Twilight
+    
+the_memory_garden:
+    id: 14
+    name: The Memory Garden
+    
+the_discovery_of_france:
+    id: 15
+    name: The Discovery of France
+    
+devil_may_care:
+    id: 16
+    name: Devil May Care
+    
+new_moon:
+    id: 17
+    name: New Moon
+    
+the_return:
+    id: 18
+    name: The Return
+    
+wife_in_the_north:
+    id: 19
+    name: Wife in the North
+    
+fractured:
+    id: 20
+    name: Fractured

data/test/fixtures/user_books.yml

@@ -0,0 +1,189 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+
+one_one:
+    user_id: 1
+    book_id: 1
+
+one_two:
+    user_id: 1
+    book_id: 2
+    
+one_three:
+    user_id: 1
+    book_id: 3
+    
+one_four:
+    user_id: 1
+    book_id: 4
+    
+one_five:
+    user_id: 1
+    book_id: 5
+    
+one_six:
+    user_id: 1
+    book_id: 6
+    
+one_seven:
+    user_id: 1
+    book_id: 7
+    
+one_eight:
+    user_id: 1
+    book_id: 8
+    
+two_one:
+    user_id: 2
+    book_id: 1
+
+two_two:
+    user_id: 2
+    book_id: 2
+    
+two_four:
+    user_id: 2
+    book_id: 4
+    
+two_five:
+    user_id: 2
+    book_id: 5
+    
+    
+two_seven:
+    user_id: 2
+    book_id: 7
+    
+two_eight:
+    user_id: 2
+    book_id: 8
+    
+three_three:
+    user_id: 3
+    book_id: 3
+    
+three_four:
+    user_id: 3
+    book_id: 4
+    
+three_five:
+    user_id: 3
+    book_id: 5
+    
+three_six:
+    user_id: 3
+    book_id: 6
+
+four_one:
+    user_id: 4
+    book_id: 9
+
+four_two:
+    user_id: 4
+    book_id: 10
+    
+four_three:
+    user_id: 4
+    book_id: 11
+    
+five_one:
+    user_id: 5
+    book_id: 9
+
+five_two:
+    user_id: 5
+    book_id: 10
+    
+six_one:
+    user_id: 6
+    book_id: 1
+
+six_two:
+    user_id: 6
+    book_id: 2
+    
+six_three:
+    user_id: 6
+    book_id: 19
+    
+six_four:
+    user_id: 6
+    book_id: 20
+    
+seven_one:
+    user_id: 7
+    book_id: 1
+
+seven_two:
+    user_id: 7
+    book_id: 2
+    
+seven_four:
+    user_id: 7
+    book_id: 20
+
+eight_one:
+    user_id: 8
+    book_id: 12
+
+eight_two:
+    user_id: 8
+    book_id: 13
+    
+eight_three:
+    user_id: 8
+    book_id: 14
+    
+eight_four:
+    user_id: 8
+    book_id: 15
+    
+eight_five:
+    user_id: 8
+    book_id: 1
+    
+eight_six:
+    user_id: 8
+    book_id: 10
+    
+eight_seven:
+    user_id: 8
+    book_id: 20
+    
+nine_one:
+    user_id: 9
+    book_id: 12
+
+nine_two:
+    user_id: 9
+    book_id: 13
+    
+
+nine_five:
+    user_id: 9
+    book_id: 1
+    
+nine_six:
+    user_id: 9
+    book_id: 10
+    
+nine_seven:
+    user_id: 9
+    book_id: 20
+    
+ten_three:
+    user_id: 10
+    book_id: 14
+    
+ten_five:
+    user_id: 10
+    book_id: 1
+    
+ten_six:
+    user_id: 10
+    book_id: 10
+    
+ten_seven:
+    user_id: 10
+    book_id: 20
+    
+