recommendable 2.1.2 → 2.1.3

data/test/factories.rb

@@ -7,6 +7,12 @@ Factory.define(:movie) do |f|
   f.year  { '200%d'.to_i }
 end
 
+Factory.define(:documentary) do |f|
+  f.title '%{year}: A Space Documentary'
+  f.year  { '200%d'.to_i }
+  f.type 'Documentary'
+end
+
 Factory.define(:book) do |f|
   f.title  'Harry Potter Vol. %d'
   f.author 'J.K. Rowling'
@@ -15,3 +21,17 @@ end
 Factory.define(:rock) do |f|
   f.name 'Boring Specimen No. %d'
 end
+
+Factory.define(:vehicle) do |f|
+  f.color 'blue'
+end
+
+Factory.define(:car) do |f|
+  f.type 'Car'
+  f.color 'red'
+end
+
+Factory.define(:boat) do |f|
+  f.type 'Boat'
+  f.color 'white'
+end

data/test/recommendable/helpers/calculations_test.rb

@@ -5,7 +5,8 @@ class CalculationsTest < MiniTest::Unit::TestCase
   def setup
     @user = Factory(:user)
     5.times  { |x| instance_variable_set(:"@user#{x+1}",  Factory(:user))  }
-    10.times { |x| instance_variable_set(:"@movie#{x+1}", Factory(:movie)) }
+    5.times { |x| instance_variable_set(:"@movie#{x+1}", Factory(:movie)) }
+    5.upto(9) { |x| instance_variable_set(:"@movie#{x+1}", Factory(:documentary)) }
     10.times { |x| instance_variable_set(:"@book#{x+1}",  Factory(:book))  }
 
     [@movie1, @movie2, @movie3, @book4, @book5, @book6].each { |obj| @user.like(obj) }

data/test/recommendable/helpers/redis_key_mapper_test.rb

@@ -37,4 +37,69 @@ class RedisKeyMapperTest < MiniTest::Unit::TestCase
   def test_output_of_score_set_for
     assert_equal Recommendable::Helpers::RedisKeyMapper.score_set_for(Movie), 'recommendable:movies:scores'
   end
+
+  def test_output_of_liked_set_for_subclass_of_ratable
+    assert_equal Recommendable::Helpers::RedisKeyMapper.liked_set_for(Documentary, 1), 'recommendable:users:1:liked_movies'
+  end
+
+  def test_output_of_disliked_set_for_subclass_of_ratable
+    assert_equal Recommendable::Helpers::RedisKeyMapper.disliked_set_for(Documentary, 1), 'recommendable:users:1:disliked_movies'
+  end
+
+  def test_output_of_hidden_set_for_subclass_of_ratable
+    assert_equal Recommendable::Helpers::RedisKeyMapper.hidden_set_for(Documentary, 1), 'recommendable:users:1:hidden_movies'
+  end
+
+  def test_output_of_bookmarked_set_for_subclass_of_ratable
+    assert_equal Recommendable::Helpers::RedisKeyMapper.bookmarked_set_for(Documentary, 1), 'recommendable:users:1:bookmarked_movies'
+  end
+
+  def test_output_of_recommended_set_for_subclass_of_ratable
+    assert_equal Recommendable::Helpers::RedisKeyMapper.recommended_set_for(Documentary, 1), 'recommendable:users:1:recommended_movies'
+  end
+
+  def test_output_of_liked_by_set_for_subclass_of_ratable
+    assert_equal Recommendable::Helpers::RedisKeyMapper.liked_by_set_for(Documentary, 1), 'recommendable:movies:1:liked_by'
+  end
+
+  def test_output_of_disliked_by_set_for_subclass_of_ratable
+    assert_equal Recommendable::Helpers::RedisKeyMapper.disliked_by_set_for(Documentary, 1), 'recommendable:movies:1:disliked_by'
+  end
+
+  def test_output_of_score_set_for_subclass_of_ratable
+    assert_equal Recommendable::Helpers::RedisKeyMapper.score_set_for(Documentary), 'recommendable:movies:scores'
+  end
+
+  def test_output_of_liked_set_for_ratable_subclass_of_nonratable
+    assert_equal Recommendable::Helpers::RedisKeyMapper.liked_set_for(Car, 1), 'recommendable:users:1:liked_cars'
+  end
+
+  def test_output_of_disliked_set_for_ratable_subclass_of_nonratable
+    assert_equal Recommendable::Helpers::RedisKeyMapper.disliked_set_for(Car, 1), 'recommendable:users:1:disliked_cars'
+  end
+
+  def test_output_of_hidden_set_for_ratable_subclass_of_nonratable
+    assert_equal Recommendable::Helpers::RedisKeyMapper.hidden_set_for(Car, 1), 'recommendable:users:1:hidden_cars'
+  end
+
+  def test_output_of_bookmarked_set_for_ratable_subclass_of_nonratable
+    assert_equal Recommendable::Helpers::RedisKeyMapper.bookmarked_set_for(Car, 1), 'recommendable:users:1:bookmarked_cars'
+  end
+
+  def test_output_of_recommended_set_for_ratable_subclass_of_nonratable
+    assert_equal Recommendable::Helpers::RedisKeyMapper.recommended_set_for(Car, 1), 'recommendable:users:1:recommended_cars'
+  end
+
+  def test_output_of_liked_by_set_for_ratable_subclass_of_nonratable
+    assert_equal Recommendable::Helpers::RedisKeyMapper.liked_by_set_for(Car, 1), 'recommendable:cars:1:liked_by'
+  end
+
+  def test_output_of_disliked_by_set_for_ratable_subclass_of_nonratable
+    assert_equal Recommendable::Helpers::RedisKeyMapper.disliked_by_set_for(Car, 1), 'recommendable:cars:1:disliked_by'
+  end
+
+  def test_output_of_score_set_for_ratable_subclass_of_nonratable
+    assert_equal Recommendable::Helpers::RedisKeyMapper.score_set_for(Car), 'recommendable:cars:scores'
+  end
+
 end

data/test/recommendable/ratable_test.rb

@@ -6,15 +6,24 @@ class RatableTest < MiniTest::Unit::TestCase
     @movie = Factory(:movie)
     @book = Factory(:book)
     @rock = Factory(:rock)
+    @vehicle = Factory(:vehicle)
   end
 
   def test_recommendable_predicate_works
     assert Movie.recommendable?
     assert @movie.recommendable?
+    assert Documentary.recommendable?
+    assert Factory(:documentary).recommendable?
     assert Book.recommendable?
     assert @book.recommendable?
     refute Rock.recommendable?
     refute @rock.recommendable?
+    assert Car.recommendable?
+    assert Factory(:car).recommendable?
+    refute Vehicle.recommendable?
+    refute @vehicle.recommendable?
+    refute Boat.recommendable?
+    refute Factory(:boat).recommendable?
   end
 
   def test_rated_predicate_works
@@ -24,7 +33,7 @@ class RatableTest < MiniTest::Unit::TestCase
     assert @movie.rated?
   end
 
-  def test_top_scope_returns_best_things
+  def test_top_scope_deprecated_syntax_returns_best_things
     @book2 = Factory(:book)
     @book3 = Factory(:book)
     @user = Factory(:user)
@@ -41,6 +50,56 @@ class RatableTest < MiniTest::Unit::TestCase
     assert_equal top[2], @book
   end
 
+  def test_top_scope_returns_best_things
+    @book2 = Factory(:book)
+    @book3 = Factory(:book)
+    @user = Factory(:user)
+    @friend = Factory(:user)
+
+    @user.like(@book2)
+    @friend.like(@book2)
+    @user.like(@book3)
+    @user.dislike(@book)
+
+    top = Book.top(:count => 3)
+    assert_equal top[0], @book2
+    assert_equal top[1], @book3
+    assert_equal top[2], @book
+  end
+
+  def test_top_scope_returns_best_things_for_ratable_base_class
+    @movie2 = Factory(:movie)
+    @doc = Factory(:documentary)
+    @user = Factory(:user)
+    @friend = Factory(:user)
+
+    @user.like(@doc)
+    @friend.like(@doc)
+    @user.like(@movie2)
+    @user.dislike(@movie)
+
+    top = Movie.top(:count => 3)
+    assert_equal top[0], @doc
+    assert_equal top[1], @movie2
+    assert_equal top[2], @movie
+  end
+
+  def test_top_scope_returns_best_things_with_start
+    @movie2 = Factory(:movie)
+    @doc = Factory(:documentary)
+    @user = Factory(:user)
+    @friend = Factory(:user)
+
+    @user.like(@doc)
+    @friend.like(@doc)
+    @user.like(@movie2)
+    @user.dislike(@movie)
+
+    top = Movie.top(:count =>2, :offset => 1)
+    assert_equal top[0], @movie2
+    assert_equal top[1], @movie
+  end
+
   def test_removed_from_recommendable_upon_destruction
     @user = Factory(:user)
     @friend = Factory(:user)
@@ -72,6 +131,33 @@ class RatableTest < MiniTest::Unit::TestCase
     assert_empty @buddy.bookmarked_books
   end
 
+  def test_ratable_subclass_object_removed_from_recommendable_upon_destruction
+    @doc = Factory(:documentary)
+    @user = Factory(:user)
+    @friend = Factory(:user)
+    @buddy = Factory(:user)
+    @stranger = Factory(:user)
+    @user.like(@doc)
+    @friend.dislike(@doc)
+    @buddy.hide(@doc)
+    @stranger.bookmark(@doc)
+
+    liked_by_set = Recommendable::Helpers::RedisKeyMapper.liked_by_set_for(@doc.class, @doc.id)
+    disliked_by_set = Recommendable::Helpers::RedisKeyMapper.disliked_by_set_for(@doc.class, @doc.id)
+    [liked_by_set, disliked_by_set].each { |set| assert_equal Recommendable.redis.scard(set), 1 }
+
+    assert @user.likes?(@doc)
+    assert @friend.dislikes?(@doc)
+    assert @buddy.hides?(@doc)
+
+    @doc.destroy
+
+    [liked_by_set, disliked_by_set].each { |set| assert_equal Recommendable.redis.scard(set), 0 }
+
+    assert_empty @buddy.hidden_movies
+    assert_empty @stranger.bookmarked_books
+  end
+
   def teardown
     Recommendable.redis.flushdb
   end

data/test/recommendable/rater/bookmarker_test.rb

@@ -5,6 +5,7 @@ class BookmarkerTest < MiniTest::Unit::TestCase
   def setup
     @user = Factory(:user)
     @movie = Factory(:movie)
+    @doc = Factory(:documentary)
   end
 
   def test_that_bookmark_adds_to_bookmarked_set
@@ -13,6 +14,12 @@ class BookmarkerTest < MiniTest::Unit::TestCase
     assert_includes @user.bookmarked_movie_ids, @movie.id
   end
 
+  def test_that_bookmark_adds_subclass_bookmarks_to_bookmarked_set
+    refute_includes @user.bookmarked_movie_ids, @doc.id
+    @user.bookmark(@doc)
+    assert_includes @user.bookmarked_movie_ids, @doc.id
+  end
+
   def test_that_cant_bookmark_already_bookmarked_object
     assert @user.bookmark(@movie)
     assert_nil @user.bookmark(@movie)
@@ -39,6 +46,13 @@ class BookmarkerTest < MiniTest::Unit::TestCase
     refute_includes @user.bookmarked_movie_ids, @movie.id
   end
 
+  def test_that_unbookmark_removes_subclass_item_from_bookmarked_set
+    @user.bookmark(@doc)
+    assert_includes @user.bookmarked_movie_ids, @doc.id
+    @user.unbookmark(@doc)
+    refute_includes @user.bookmarked_movie_ids, @doc.id
+  end
+
   def test_that_cant_unbookmark_item_unless_bookmarked
     assert_nil @user.unbookmark(@movie)
   end
@@ -47,6 +61,10 @@ class BookmarkerTest < MiniTest::Unit::TestCase
     refute_includes @user.bookmarks, @movie
     @user.bookmark(@movie)
     assert_includes @user.bookmarks, @movie
+
+    refute_includes @user.bookmarks, @doc
+    @user.bookmark(@doc)
+    assert_includes @user.bookmarks, @doc
   end
 
   def test_that_dynamic_bookmarked_finder_only_returns_relevant_records
@@ -65,8 +83,9 @@ class BookmarkerTest < MiniTest::Unit::TestCase
     @user.bookmark(@movie)
     @user.bookmark(movie2)
     @user.bookmark(book)
+    @user.bookmark(@doc)
 
-    assert_equal @user.bookmarks_count, 3
+    assert_equal @user.bookmarks_count, 4
   end
 
   def test_that_dynamic_bookmarked_count_methods_only_count_relevant_bookmarks
@@ -75,9 +94,10 @@ class BookmarkerTest < MiniTest::Unit::TestCase
 
     @user.bookmark(@movie)
     @user.bookmark(movie2)
+    @user.bookmark(@doc)
     @user.bookmark(book)
 
-    assert_equal @user.bookmarked_movies_count, 2
+    assert_equal @user.bookmarked_movies_count, 3
     assert_equal @user.bookmarked_books_count, 1
   end
 
@@ -90,11 +110,14 @@ class BookmarkerTest < MiniTest::Unit::TestCase
     @user.bookmark(@movie)
     @user.bookmark(book)
     @user.bookmark(movie2)
+    @user.bookmark(@doc)
     friend.bookmark(@movie)
     friend.bookmark(book)
     friend.bookmark(book2)
+    friend.bookmark(@doc)
 
     assert_includes @user.bookmarks_in_common_with(friend), @movie
+    assert_includes @user.bookmarks_in_common_with(friend), @doc
     assert_includes @user.bookmarks_in_common_with(friend), book
     refute_includes @user.bookmarks_in_common_with(friend), movie2
     refute_includes friend.bookmarks_in_common_with(@user), book2
@@ -106,14 +129,18 @@ class BookmarkerTest < MiniTest::Unit::TestCase
     book = Factory(:book)
 
     @user.bookmark(@movie)
+    @user.bookmark(@doc)
     @user.bookmark(book)
     friend.bookmark(@movie)
     friend.bookmark(book)
+    friend.bookmark(@doc)
 
     assert_includes @user.bookmarked_movies_in_common_with(friend), @movie
+    assert_includes @user.bookmarked_movies_in_common_with(friend), @doc
     assert_includes @user.bookmarked_books_in_common_with(friend), book
     refute_includes @user.bookmarked_movies_in_common_with(friend), book
     refute_includes @user.bookmarked_books_in_common_with(friend), @movie
+    refute_includes @user.bookmarked_books_in_common_with(friend), @doc
   end
 
   def teardown

data/test/recommendable/rater/disliker_test.rb

@@ -5,6 +5,7 @@ class DislikerTest < MiniTest::Unit::TestCase
   def setup
     @user = Factory(:user)
     @movie = Factory(:movie)
+    @doc = Factory(:documentary)
   end
 
   def test_that_dislike_adds_to_disliked_set
@@ -13,6 +14,12 @@ class DislikerTest < MiniTest::Unit::TestCase
     assert_includes @user.disliked_movie_ids, @movie.id
   end
 
+  def test_that_dislike_adds_subclass_dislikes_to_disliked_set
+    refute_includes @user.disliked_movie_ids, @doc.id
+    @user.dislike(@doc)
+    assert_includes @user.disliked_movie_ids, @doc.id
+  end
+
   def test_that_cant_dislike_already_disliked_object
     assert @user.dislike(@movie)
     assert_nil @user.dislike(@movie)
@@ -39,6 +46,13 @@ class DislikerTest < MiniTest::Unit::TestCase
     refute_includes @user.disliked_movie_ids, @movie.id
   end
 
+  def test_that_undislike_removes_subclass_item_from_disliked_set
+    @user.dislike(@doc)
+    assert_includes @user.disliked_movie_ids, @doc.id
+    @user.undislike(@doc)
+    refute_includes @user.disliked_movie_ids, @doc.id
+  end
+
   def test_that_cant_undislike_item_unless_disliked
     assert_nil @user.undislike(@movie)
   end
@@ -47,6 +61,10 @@ class DislikerTest < MiniTest::Unit::TestCase
     refute_includes @user.dislikes, @movie
     @user.dislike(@movie)
     assert_includes @user.dislikes, @movie
+
+    refute_includes @user.dislikes, @doc
+    @user.dislike(@doc)
+    assert_includes @user.dislikes, @doc
   end
 
   def test_that_dynamic_disliked_finder_only_returns_relevant_records
@@ -65,8 +83,9 @@ class DislikerTest < MiniTest::Unit::TestCase
     @user.dislike(@movie)
     @user.dislike(movie2)
     @user.dislike(book)
+    @user.dislike(@doc)
 
-    assert_equal @user.dislikes_count, 3
+    assert_equal @user.dislikes_count, 4
   end
 
   def test_that_dynamic_disliked_count_methods_only_count_relevant_dislikes
@@ -75,9 +94,10 @@ class DislikerTest < MiniTest::Unit::TestCase
 
     @user.dislike(@movie)
     @user.dislike(movie2)
+    @user.dislike(@doc)
     @user.dislike(book)
 
-    assert_equal @user.disliked_movies_count, 2
+    assert_equal @user.disliked_movies_count, 3
     assert_equal @user.disliked_books_count, 1
   end
 
@@ -90,11 +110,14 @@ class DislikerTest < MiniTest::Unit::TestCase
     @user.dislike(@movie)
     @user.dislike(book)
     @user.dislike(movie2)
+    @user.dislike(@doc)
     friend.dislike(@movie)
     friend.dislike(book)
     friend.dislike(book2)
+    friend.dislike(@doc)
 
     assert_includes @user.dislikes_in_common_with(friend), @movie
+    assert_includes @user.dislikes_in_common_with(friend), @doc
     assert_includes @user.dislikes_in_common_with(friend), book
     refute_includes @user.dislikes_in_common_with(friend), movie2
     refute_includes friend.dislikes_in_common_with(@user), book2
@@ -106,14 +129,18 @@ class DislikerTest < MiniTest::Unit::TestCase
     book = Factory(:book)
 
     @user.dislike(@movie)
+    @user.dislike(@doc)
     @user.dislike(book)
     friend.dislike(@movie)
+    friend.dislike(@doc)
     friend.dislike(book)
 
     assert_includes @user.disliked_movies_in_common_with(friend), @movie
+    assert_includes @user.disliked_movies_in_common_with(friend), @doc
     assert_includes @user.disliked_books_in_common_with(friend), book
     refute_includes @user.disliked_movies_in_common_with(friend), book
     refute_includes @user.disliked_books_in_common_with(friend), @movie
+    refute_includes @user.disliked_books_in_common_with(friend), @doc
   end
 
   def teardown

data/test/recommendable/rater/hider_test.rb

@@ -5,6 +5,7 @@ class HiderTest < MiniTest::Unit::TestCase
   def setup
     @user = Factory(:user)
     @movie = Factory(:movie)
+    @doc = Factory(:documentary)
   end
 
   def test_that_hide_adds_to_hidden_set
@@ -13,6 +14,12 @@ class HiderTest < MiniTest::Unit::TestCase
     assert_includes @user.hidden_movie_ids, @movie.id
   end
 
+  def test_that_like_adds_subclass_hides_to_hidden_set
+    refute_includes @user.hidden_movie_ids, @doc.id
+    @user.hide(@doc)
+    assert_includes @user.hidden_movie_ids, @doc.id
+  end
+
   def test_that_cant_hide_already_hidden_object
     assert @user.hide(@movie)
     assert_nil @user.hide(@movie)
@@ -39,6 +46,13 @@ class HiderTest < MiniTest::Unit::TestCase
     refute_includes @user.hidden_movie_ids, @movie.id
   end
 
+  def test_that_unhide_removes_subclass_item_from_hidden_set
+    @user.hide(@doc)
+    assert_includes @user.hidden_movie_ids, @doc.id
+    @user.unhide(@doc)
+    refute_includes @user.hidden_movie_ids, @doc.id
+  end
+
   def test_that_cant_unhide_item_unless_hidden
     assert_nil @user.unhide(@movie)
   end
@@ -47,6 +61,10 @@ class HiderTest < MiniTest::Unit::TestCase
     refute_includes @user.hiding, @movie
     @user.hide(@movie)
     assert_includes @user.hiding, @movie
+
+    refute_includes @user.hiding, @doc
+    @user.hide(@doc)
+    assert_includes @user.hiding, @doc
   end
 
   def test_that_dynamic_hidden_finder_only_returns_relevant_records
@@ -65,8 +83,9 @@ class HiderTest < MiniTest::Unit::TestCase
     @user.hide(@movie)
     @user.hide(movie2)
     @user.hide(book)
+    @user.hide(@doc)
 
-    assert_equal @user.hidden_count, 3
+    assert_equal @user.hidden_count, 4
   end
 
   def test_that_dynamic_hidden_count_methods_only_count_relevant_hides
@@ -90,11 +109,14 @@ class HiderTest < MiniTest::Unit::TestCase
     @user.hide(@movie)
     @user.hide(book)
     @user.hide(movie2)
+    @user.hide(@doc)
     friend.hide(@movie)
     friend.hide(book)
     friend.hide(book2)
+    friend.hide(@doc)
 
     assert_includes @user.hiding_in_common_with(friend), @movie
+    assert_includes @user.hiding_in_common_with(friend), @doc
     assert_includes @user.hiding_in_common_with(friend), book
     refute_includes @user.hiding_in_common_with(friend), movie2
     refute_includes friend.hiding_in_common_with(@user), book2
@@ -106,14 +128,18 @@ class HiderTest < MiniTest::Unit::TestCase
     book = Factory(:book)
 
     @user.hide(@movie)
+    @user.hide(@doc)
     @user.hide(book)
     friend.hide(@movie)
+    friend.hide(@doc)
     friend.hide(book)
 
     assert_includes @user.hidden_movies_in_common_with(friend), @movie
+    assert_includes @user.hidden_movies_in_common_with(friend), @doc
     assert_includes @user.hidden_books_in_common_with(friend), book
     refute_includes @user.hidden_movies_in_common_with(friend), book
     refute_includes @user.hidden_books_in_common_with(friend), @movie
+    refute_includes @user.hidden_books_in_common_with(friend), @doc
   end
 
   def teardown