recommendable 2.1.0.2 → 2.1.1

data/test/recommendable/rater/hider_test.rb

@@ -0,0 +1,122 @@
+$LOAD_PATH.unshift File.expand_path('../../test', __FILE__)
+require 'test_helper'
+
+class HiderTest < MiniTest::Unit::TestCase
+  def setup
+    @user = Factory(:user)
+    @movie = Factory(:movie)
+  end
+
+  def test_that_hide_adds_to_hidden_set
+    refute_includes @user.hidden_movie_ids, @movie.id
+    @user.hide(@movie)
+    assert_includes @user.hidden_movie_ids, @movie.id
+  end
+
+  def test_that_cant_hide_already_hidden_object
+    assert @user.hide(@movie)
+    assert_nil @user.hide(@movie)
+  end
+
+  def test_that_cant_hide_unratable_object
+    basic_obj = Object.new
+    rock = Factory(:rock)
+
+    assert_raises(ArgumentError) { @user.hide(basic_obj) }
+    assert_raises(ArgumentError) { @user.hide(rock) }
+  end
+
+  def test_that_hides_returns_true_if_hidden
+    refute @user.hides?(@movie)
+    @user.hide(@movie)
+    assert @user.hides?(@movie)
+  end
+
+  def test_that_unhide_removes_item_from_hidden_set
+    @user.hide(@movie)
+    assert_includes @user.hidden_movie_ids, @movie.id
+    @user.unhide(@movie)
+    refute_includes @user.hidden_movie_ids, @movie.id
+  end
+
+  def test_that_cant_unhide_item_unless_hidden
+    assert_nil @user.unhide(@movie)
+  end
+
+  def test_that_hidden_returns_hidden_records
+    refute_includes @user.hiding, @movie
+    @user.hide(@movie)
+    assert_includes @user.hiding, @movie
+  end
+
+  def test_that_dynamic_hidden_finder_only_returns_relevant_records
+    book = Factory(:book)
+    @user.hide(@movie)
+    @user.hide(book)
+
+    refute_includes @user.hidden_movies, book
+    refute_includes @user.hidden_books, @movie
+  end
+
+  def test_that_hides_count_counts_all_hides
+    book = Factory(:book)
+    movie2 = Factory(:movie)
+
+    @user.hide(@movie)
+    @user.hide(movie2)
+    @user.hide(book)
+
+    assert_equal @user.hidden_count, 3
+  end
+
+  def test_that_dynamic_hidden_count_methods_only_count_relevant_hides
+    book = Factory(:book)
+    movie2 = Factory(:movie)
+
+    @user.hide(@movie)
+    @user.hide(movie2)
+    @user.hide(book)
+
+    assert_equal @user.hidden_movies_count, 2
+    assert_equal @user.hidden_books_count, 1
+  end
+
+  def test_that_hides_in_common_with_returns_all_common_hides
+    friend = Factory(:user)
+    movie2 = Factory(:movie)
+    book = Factory(:book)
+    book2 = Factory(:book)
+
+    @user.hide(@movie)
+    @user.hide(book)
+    @user.hide(movie2)
+    friend.hide(@movie)
+    friend.hide(book)
+    friend.hide(book2)
+
+    assert_includes @user.hiding_in_common_with(friend), @movie
+    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
+  end
+
+  def test_that_dynamic_hidden_in_common_with_only_returns_relevant_records
+    friend = Factory(:user)
+    movie2 = Factory(:movie)
+    book = Factory(:book)
+
+    @user.hide(@movie)
+    @user.hide(book)
+    friend.hide(@movie)
+    friend.hide(book)
+
+    assert_includes @user.hidden_movies_in_common_with(friend), @movie
+    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
+  end
+
+  def teardown
+    Recommendable.redis.flushdb
+  end
+end

data/test/recommendable/rater/liker_test.rb

@@ -0,0 +1,122 @@
+$LOAD_PATH.unshift File.expand_path('../../test', __FILE__)
+require 'test_helper'
+
+class LikerTest < MiniTest::Unit::TestCase
+  def setup
+    @user = Factory(:user)
+    @movie = Factory(:movie)
+  end
+
+  def test_that_like_adds_to_liked_set
+    refute_includes @user.liked_movie_ids, @movie.id
+    @user.like(@movie)
+    assert_includes @user.liked_movie_ids, @movie.id
+  end
+
+  def test_that_cant_like_already_liked_object
+    assert @user.like(@movie)
+    assert_nil @user.like(@movie)
+  end
+
+  def test_that_cant_like_unratable_object
+    basic_obj = Object.new
+    rock = Factory(:rock)
+
+    assert_raises(ArgumentError) { @user.like(basic_obj) }
+    assert_raises(ArgumentError) { @user.like(rock) }
+  end
+
+  def test_that_likes_returns_true_if_liked
+    refute @user.likes?(@movie)
+    @user.like(@movie)
+    assert @user.likes?(@movie)
+  end
+
+  def test_that_unlike_removes_item_from_liked_set
+    @user.like(@movie)
+    assert_includes @user.liked_movie_ids, @movie.id
+    @user.unlike(@movie)
+    refute_includes @user.liked_movie_ids, @movie.id
+  end
+
+  def test_that_cant_unlike_item_unless_liked
+    assert_nil @user.unlike(@movie)
+  end
+
+  def test_that_likes_returns_liked_records
+    refute_includes @user.likes, @movie
+    @user.like(@movie)
+    assert_includes @user.likes, @movie
+  end
+
+  def test_that_dynamic_liked_finder_only_returns_relevant_records
+    book = Factory(:book)
+    @user.like(@movie)
+    @user.like(book)
+
+    refute_includes @user.liked_movies, book
+    refute_includes @user.liked_books, @movie
+  end
+
+  def test_that_likes_count_counts_all_likes
+    book = Factory(:book)
+    movie2 = Factory(:movie)
+
+    @user.like(@movie)
+    @user.like(movie2)
+    @user.like(book)
+
+    assert_equal @user.likes_count, 3
+  end
+
+  def test_that_dynamic_liked_count_methods_only_count_relevant_likes
+    book = Factory(:book)
+    movie2 = Factory(:movie)
+
+    @user.like(@movie)
+    @user.like(movie2)
+    @user.like(book)
+
+    assert_equal @user.liked_movies_count, 2
+    assert_equal @user.liked_books_count, 1
+  end
+
+  def test_that_likes_in_common_with_returns_all_common_likes
+    friend = Factory(:user)
+    movie2 = Factory(:movie)
+    book = Factory(:book)
+    book2 = Factory(:book)
+
+    @user.like(@movie)
+    @user.like(book)
+    @user.like(movie2)
+    friend.like(@movie)
+    friend.like(book)
+    friend.like(book2)
+
+    assert_includes @user.likes_in_common_with(friend), @movie
+    assert_includes @user.likes_in_common_with(friend), book
+    refute_includes @user.likes_in_common_with(friend), movie2
+    refute_includes friend.likes_in_common_with(@user), book2
+  end
+
+  def test_that_dynamic_liked_in_common_with_only_returns_relevant_records
+    friend = Factory(:user)
+    movie2 = Factory(:movie)
+    book = Factory(:book)
+
+    @user.like(@movie)
+    @user.like(book)
+    friend.like(@movie)
+    friend.like(book)
+
+    assert_includes @user.liked_movies_in_common_with(friend), @movie
+    assert_includes @user.liked_books_in_common_with(friend), book
+    refute_includes @user.liked_movies_in_common_with(friend), book
+    refute_includes @user.liked_books_in_common_with(friend), @movie
+  end
+
+  def teardown
+    Recommendable.redis.flushdb
+  end
+end

data/test/recommendable/rater/recommender_test.rb

@@ -0,0 +1,115 @@
+$LOAD_PATH.unshift File.expand_path('../../test', __FILE__)
+require 'test_helper'
+
+class RecommenderTest < 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)) }
+    10.times { |x| instance_variable_set(:"@book#{x+1}",  Factory(:book))  }
+
+    [@movie1, @movie2, @movie3, @book4, @book5, @book6].each { |obj| @user.like(obj) }
+    [@book1, @book2, @book3, @movie4, @movie5, @movie6].each { |obj| @user.dislike(obj) }
+
+    # @user.similarity_with(@user2) should ==  1.0
+    [@movie1, @movie2, @movie3, @book4, @book5, @book6, @book7, @book8, @movie9, @movie10].each { |obj| @user2.like(obj) }
+    [@book1, @book2, @book3, @movie4, @movie5, @movie6, @movie8, @movie8, @book9, @book10].each { |obj| @user2.dislike(obj) }
+
+    # @user.similarity_with(@user4) should ==  0.25
+    [@movie1, @movie2, @movie3, @book4, @book5, @book6].each { |obj| @user4.like(obj) }
+    [@book1, @book2, @book3].each { |obj| @user4.like(obj) }
+
+    # @user.similarity_with(@user3) should ==  0.0
+    [@movie1, @movie2, @movie3].each { |obj| @user3.like(obj) }
+    [@book1, @book2, @book3].each { |obj| @user3.like(obj) }
+
+    # @user.similarity_with(@user1) should == -0.25
+    [@movie1, @movie2, @movie3].each { |obj| @user1.like(obj) }
+    [@book1, @book2, @book3, @movie4, @movie5, @movie6].each { |obj| @user1.like(obj) }
+
+    # @user.similarity_with(@user5) should == -1.0
+    [@movie1, @movie2, @movie3, @book4, @book5, @book6].each { |obj| @user5.dislike(obj) }
+    [@book1, @book2, @book3, @movie4, @movie5, @movie6].each { |obj| @user5.like(obj) }
+
+    Recommendable::Helpers::Calculations.update_similarities_for(@user.id)
+    Recommendable::Helpers::Calculations.update_recommendations_for(@user.id)
+  end
+
+  def test_similar_raters_returns_sorted_similar_users
+    similar_raters = @user.similar_raters(5)
+
+    assert_equal similar_raters[0], @user2
+    assert_equal similar_raters[1], @user4
+    assert_equal similar_raters[2], @user3
+    assert_equal similar_raters[3], @user1
+    assert_equal similar_raters[4], @user5
+  end
+
+  def test_recommended_for_only_returns_relevant_recommendations
+    [@book7, @book8, @book9, @book10].each  { |book|  refute_includes @user.recommended_movies, book }
+    [@movie7, @movie8, @movie9, @movie10].each { |movie| refute_includes @user.recommended_books, movie }
+  end
+
+  def test_that_it_is_removed_from_recommendable_after_destroy
+    Recommendable::Helpers::Calculations.update_similarities_for(@user2.id)
+
+    @user.hide(@movie10)
+    @user.hide(@book10)
+    @user.bookmark(@movie9)
+    @user.bookmark(@book9)
+
+    sets = [
+      @user.liked_movie_ids,
+      @user.disliked_movie_ids,
+      @user.liked_book_ids,
+      @user.disliked_book_ids,
+      @user.hidden_movie_ids,
+      @user.hidden_book_ids,
+      @user.bookmarked_movie_ids,
+      @user.bookmarked_book_ids,
+      @user.recommended_movies,
+      @user.recommended_books,
+      @user.similar_raters
+    ]
+
+    sets.each { |set| refute_empty set }
+    assert_includes @user2.similar_raters(5), @user
+
+    redis_sets = [
+      Recommendable::Helpers::RedisKeyMapper.liked_set_for(Movie, @user.id),
+      Recommendable::Helpers::RedisKeyMapper.liked_set_for(Book, @user.id),
+      Recommendable::Helpers::RedisKeyMapper.disliked_set_for(Movie, @user.id),
+      Recommendable::Helpers::RedisKeyMapper.disliked_set_for(Book, @user.id),
+      Recommendable::Helpers::RedisKeyMapper.hidden_set_for(Movie, @user.id),
+      Recommendable::Helpers::RedisKeyMapper.hidden_set_for(Book, @user.id),
+      Recommendable::Helpers::RedisKeyMapper.bookmarked_set_for(Movie, @user.id),
+      Recommendable::Helpers::RedisKeyMapper.bookmarked_set_for(Book, @user.id),
+    ]
+
+    redis_zsets = [
+      Recommendable::Helpers::RedisKeyMapper.recommended_set_for(Movie, @user.id),
+      Recommendable::Helpers::RedisKeyMapper.recommended_set_for(Book, @user.id),
+      Recommendable::Helpers::RedisKeyMapper.similarity_set_for(@user.id)
+    ]
+
+    id = @user.id
+    @user.destroy
+
+    redis_sets.each  { |set|  assert_equal Recommendable.redis.scard(set),  0 }
+    redis_zsets.each { |zset| assert_equal Recommendable.redis.zcard(zset), 0 }
+
+    [@movie1, @movie2, @movie3, @book4, @book5, @book6].each do |obj|
+      refute_includes obj.liked_by_ids, id.to_s
+    end
+
+    [@book1, @book2, @book3, @movie4, @movie5, @movie6].each do |obj|
+      refute_includes obj.disliked_by_ids, id.to_s
+    end
+
+    refute_includes @user2.similar_raters(5).map(&:id), id
+  end
+
+  def teardown
+    Recommendable.redis.flushdb
+  end
+end

data/test/recommendable/rater_test.rb

@@ -0,0 +1,29 @@
+$LOAD_PATH.unshift File.expand_path('../../test', __FILE__)
+require 'test_helper'
+
+class RaterTest < MiniTest::Unit::TestCase
+  def setup
+    @user = Factory(:user)
+  end
+
+  def test_that_it_belongs_to_recommendables_user_class
+    assert_instance_of Recommendable.config.user_class, @user
+  end
+
+  def test_that_its_class_responds_to_recommendable_hooks
+    %w[like dislike hide bookmark].each do |action|
+      assert_respond_to @user.class, "before_#{action}"
+      assert_respond_to @user.class, "before_un#{action}"
+      assert_respond_to @user.class, "after_#{action}"
+      assert_respond_to @user.class, "after_un#{action}"
+    end
+  end
+
+  def test_that_rated_anything_is_false_by_default
+    refute @user.rated_anything?
+  end
+
+  def teardown
+    Recommendable.redis.flushdb
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,25 @@
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path('../dummy/config/environment.rb', __FILE__)
+require 'rails/test_help'
+
+require 'minitest/unit'
+require 'minitest/pride'
+require 'minitest/autorun'
+
+require 'database_cleaner'
+
+require 'miniskirt'
+require 'factories'
+
+require 'recommendable'
+
+DatabaseCleaner.strategy = :transaction
+Rails.backtrace_cleaner.remove_silencers!
+
+DatabaseCleaner.start
+
+MiniTest::Unit.after_tests do
+  DatabaseCleaner.clean
+  Recommendable.redis.flushdb
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recommendable
 version: !ruby/object:Gem::Version
-  version: 2.1.0.2
+  version: 2.1.1
 platform: ruby
 authors:
 - David Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-14 00:00:00.000000000 Z
+date: 2013-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -169,8 +169,54 @@ files:
 - lib/recommendable/workers/sidekiq.rb
 - lib/recommendable/workers/torque_box.rb
 - lib/recommendable.rb
+- test/dummy/app/models/book.rb
+- test/dummy/app/models/movie.rb
+- test/dummy/app/models/rock.rb
+- test/dummy/app/models/user.rb
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/database.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/recommendable.rb
+- test/dummy/config/initializers/secret_token.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/routes.rb
+- test/dummy/config.ru
+- test/dummy/db/development.sqlite3
+- test/dummy/db/migrate/20121006052300_create_users.rb
+- test/dummy/db/migrate/20121006052339_create_movies.rb
+- test/dummy/db/migrate/20121007212545_create_rocks.rb
+- test/dummy/db/migrate/20121007213144_create_books.rb
+- test/dummy/db/schema.rb
+- test/dummy/db/seeds.rb
+- test/dummy/db/test.sqlite3
+- test/dummy/db/test.sqlite3-journal
+- test/dummy/log/test.log
+- test/dummy/Rakefile
+- test/dummy/script/rails
+- test/factories.rb
+- test/recommendable/helpers/calculations_test.rb
+- test/recommendable/helpers/redis_key_mapper_test.rb
+- test/recommendable/ratable/dislikable_test.rb
+- test/recommendable/ratable/likable_test.rb
+- test/recommendable/ratable_test.rb
+- test/recommendable/rater/bookmarker_test.rb
+- test/recommendable/rater/disliker_test.rb
+- test/recommendable/rater/hider_test.rb
+- test/recommendable/rater/liker_test.rb
+- test/recommendable/rater/recommender_test.rb
+- test/recommendable/rater_test.rb
+- test/test_helper.rb
 homepage: https://github.com/davidcelis/recommendable
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -192,5 +238,50 @@ rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
 summary: A Like/Dislike recommendation engine for Ruby apps using Redis
-test_files: []
+test_files:
+- test/dummy/app/models/book.rb
+- test/dummy/app/models/movie.rb
+- test/dummy/app/models/rock.rb
+- test/dummy/app/models/user.rb
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/database.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/recommendable.rb
+- test/dummy/config/initializers/secret_token.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/routes.rb
+- test/dummy/config.ru
+- test/dummy/db/development.sqlite3
+- test/dummy/db/migrate/20121006052300_create_users.rb
+- test/dummy/db/migrate/20121006052339_create_movies.rb
+- test/dummy/db/migrate/20121007212545_create_rocks.rb
+- test/dummy/db/migrate/20121007213144_create_books.rb
+- test/dummy/db/schema.rb
+- test/dummy/db/seeds.rb
+- test/dummy/db/test.sqlite3
+- test/dummy/db/test.sqlite3-journal
+- test/dummy/log/test.log
+- test/dummy/Rakefile
+- test/dummy/script/rails
+- test/factories.rb
+- test/recommendable/helpers/calculations_test.rb
+- test/recommendable/helpers/redis_key_mapper_test.rb
+- test/recommendable/ratable/dislikable_test.rb
+- test/recommendable/ratable/likable_test.rb
+- test/recommendable/ratable_test.rb
+- test/recommendable/rater/bookmarker_test.rb
+- test/recommendable/rater/disliker_test.rb
+- test/recommendable/rater/hider_test.rb
+- test/recommendable/rater/liker_test.rb
+- test/recommendable/rater/recommender_test.rb
+- test/recommendable/rater_test.rb
+- test/test_helper.rb
 has_rdoc: yard