recommendable 1.1.7 → 2.0.0

data/.gitignore

@@ -1,57 +0,0 @@
-# RVM / rbenv version files
-.rvmrc
-.rbenv-version
-
-# rcov generated
-coverage
-
-# rdoc generated
-rdoc
-
-# yard generated
-doc
-.yardoc
-
-# bundler
-.bundle
-vendor/bundle
-
-# jeweler generated
-pkg
-
-# logging
-*.log
-
-# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
-#
-# * Create a file at ~/.gitignore
-# * Include files you want ignored
-# * Run: git config --global core.excludesfile ~/.gitignore
-#
-# After doing this, these files will be ignored in all your git projects,
-# saving you from having to 'pollute' every project you touch with them
-#
-# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
-#
-# For MacOS:
-
-.DS_Store
-
-# For TextMate
-*.tmproj
-tmtags
-
-# For emacs:
-#*~
-#\#*
-#.\#*
-
-# For vim:
-*.swp
-
-# For redcar:
-#.redcar
-
-# For rubinius:
-#*.rbc
-.rake_tasks*

data/.travis.yml

@@ -1,3 +0,0 @@
-rvm:
-  - 1.9.2
-  - 1.9.3

data/CHANGELOG.markdown

@@ -1,159 +0,0 @@
-Changelog
-=========
-
-1.1.7 (Current version)
------------------------
-* Fix #50, a method that was forgotten to time during the ignoreable => ignorable typo update
-
-1.1.6
------
-* Minor code cleanup for my benefit
-
-1.1.5
------
-* Fix #47, a problem where models could not recommend themselves
-
-1.1.4
------
-* Fix #41, a problem where Resque rake tasks were required regardless of whether or not it was bundled
-* Fix #46 by adding UniqueJob middleware for Sidekiq.
-* Added caches for an item's number of likes and dislikes received
-
-1.1.3
------
-* Update Redis.
-
-1.1.2
------
-* Fix #38, a problem with enqueueing users based on updating the score of a recommendable record
-
-1.1.1
------
-* Support for Sidekiq, Resque, DelayedJob and Rails::Queueing (issue #28)
-  * You must manually bundle Sidekiq, Resque, or DelayedJob. Rails::Queueing is available as a fallback for Rails 4.x
-* Use [apotonick/hooks](https://github.com/apotonick/hooks) to implement callbacks (issue #25). See the [detailed README](http://davidcelis.com/recommendable) for more info on usage.
-
-1.0.0
------
-* Dynamic finders now return ActiveRecord::Relations! This means you can chain other ActiveRecord query methods like so:
-
-```ruby
-current_user.recommended_posts.where(:category => "technology")
-current_user.liked_movies.limit(10)
-current_user.stashed_books.where(:author => "Cormac McCarthy")
-current_user.disliked_shows.joins(:cast_members).where('cast_members.name = Kim Kardashian')
-```
-
-* You can now specify a count for `User#recommendations`:
-
-```ruby
-current_user.recommendations(10)
-```
-
-* Bug fixes
-
-0.2.0
------
-* NOTE: This release is NOT backwards compatible. Please migrate your databases:
-
-```
-rename_column :recommendable_ignores, :ignoreable_id, :ignorable_id
-rename_column :recommendable_ignores, :ignoreable_type, :ignorable_type
-rename_table  :recommendable_stashed_items, :recommendable_stashes
-```
-
-* Fix an issue with recommendable models implemented via STI 
-* Fix a library-wide typo of "ignoreable" to "ignorable"
-
-0.1.9
------
-* Yanked due to breaking bug
-
-0.1.8
------
-* Revert changes made in 0.1.7 due to licensing
-
-0.1.7
------
-* Yanked and no longer available.
-* Attempted switch from Resque to Sidekiq
-
-0.1.6
------
-* Dynamic finders for your User class:
-
-`current_user.liked_movies`
-`current_user.disliked_shows`
-`current_user.recommended_movies`
-
-* Implement sorting of recommendable models:
-
-``` ruby
->> Movie.top(5)
-=> [#<Movie id: 14>, #<Movie id: 15>, #<Movie id: 13>, #<Movie id: 12>, #<Movie id: 11>]
->> Movie.top
-=> #<Movie id: 14>
-```
-
-* Bugfix: users/recommendable objects will now be removed from Redis upon being destroyed
-
-0.1.5
------
-* Major bugfix: similarity values were, incorrectly, being calculated as 0.0 for every user pair. Sorry!
-* The tables for all models are now all prepended with "recommendable_" to avoid possible collision. If upgrading from a previous version, please do the following:
-
-``` bash
-$ rails g migration RenameRecommendableTables
-```
-
-And paste this into your new migration:
-
-``` ruby
-class RenameRecommendableTables < ActiveRecord::Migration
-  def up
-    rename_table :likes,         :recommendable_likes
-    rename_table :dislikes,      :recommendable_dislikes
-    rename_table :ignores,       :recommendable_ignores
-    rename_table :stashed_items, :recommendable_stashed_items
-  end
-
-  def down
-    rename_table :recommendable_likes,         :likes
-    rename_table :recommendable_dislikes,      :dislikes
-    rename_table :recommendable_ignores,       :ignores
-    rename_table :recommendable_stashed_items, :stashed_items
-  end
-end
-```
-
-0.1.4
------
-* `acts_as_recommendable` is no longer needed in your models
-* Instead of declaring `acts_as_recommended_to` in your User class, please use `recommends` instead, passing in a list of your recommendable models as a list of symbols (e.g. `recommends :movies, :books`)
-* Your initializer should no longer declare the user class. This is no longer necessary and is deprecated.
-* Fix an issue that caused the unnecessary need for eager loading models in development
-* Removed aliases: `liked_records`, `liked_records_for`, `disliked_records`, and `disliked_records_for`
-* Renamed methods:
-  * `has_ignored?` => `ignored?`
-  * `has_stashed?` => `stashed?`
-* Code quality tweaks
-
-0.1.3 (current version)
------------------------
-
-* Improvements to speed of similarity calculations.
-* Added an instance method to items that act_as_recommendable, `rated_by`. This returns an array of users that like or dislike the item.
-
-0.1.2
------
-
-* 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/Gemfile

@@ -1,3 +0,0 @@
-source 'http://rubygems.org'
-# Add dependencies required to use your gem here.
-gemspec

data/Gemfile.lock

@@ -1,112 +0,0 @@
-PATH
-  remote: .
-  specs:
-    recommendable (1.1.6)
-      hooks (>= 0.2.1)
-      rails (>= 3.0.0)
-      redis (>= 2.2.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    actionmailer (3.2.8)
-      actionpack (= 3.2.8)
-      mail (~> 2.4.4)
-    actionpack (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
-      builder (~> 3.0.0)
-      erubis (~> 2.7.0)
-      journey (~> 1.0.4)
-      rack (~> 1.4.0)
-      rack-cache (~> 1.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.1.3)
-    activemodel (3.2.8)
-      activesupport (= 3.2.8)
-      builder (~> 3.0.0)
-    activerecord (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activeresource (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
-    activesupport (3.2.8)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    arel (3.0.2)
-    builder (3.0.0)
-    erubis (2.7.0)
-    hike (1.2.1)
-    hooks (0.2.1)
-    i18n (0.6.0)
-    journey (1.0.4)
-    json (1.7.4)
-    mail (2.4.4)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.19)
-    miniskirt (1.1.1)
-      activesupport (>= 2.2)
-    minitest (3.3.0)
-    multi_json (1.3.6)
-    polyglot (0.3.3)
-    rack (1.4.1)
-    rack-cache (1.2)
-      rack (>= 0.4)
-    rack-ssl (1.3.2)
-      rack
-    rack-test (0.6.1)
-      rack (>= 1.0)
-    rails (3.2.8)
-      actionmailer (= 3.2.8)
-      actionpack (= 3.2.8)
-      activerecord (= 3.2.8)
-      activeresource (= 3.2.8)
-      activesupport (= 3.2.8)
-      bundler (~> 1.0)
-      railties (= 3.2.8)
-    railties (3.2.8)
-      actionpack (= 3.2.8)
-      activesupport (= 3.2.8)
-      rack-ssl (~> 1.3.2)
-      rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (>= 0.14.6, < 2.0)
-    rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
-    redis (3.0.1)
-    shoulda (3.1.1)
-      shoulda-context (~> 1.0)
-      shoulda-matchers (~> 1.2)
-    shoulda-context (1.0.0)
-    shoulda-matchers (1.2.0)
-      activesupport (>= 3.0.0)
-    sprockets (2.1.3)
-      hike (~> 1.2)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    sqlite3 (1.3.6)
-    thor (0.15.4)
-    tilt (1.3.3)
-    treetop (1.4.10)
-      polyglot
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.33)
-    yard (0.6.8)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler
-  miniskirt
-  minitest
-  recommendable!
-  shoulda
-  sqlite3
-  yard (~> 0.6.0)

data/LICENSE.txt

@@ -1,22 +0,0 @@
-(The MIT License)
-
-Copyright (c) 2012 David Celis
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -1,135 +0,0 @@
-# Recommendable [![Build Status](https://secure.travis-ci.org/davidcelis/recommendable.png)](http://travis-ci.org/davidcelis/recommendable)
-
-Recommendable is an engine for Rails 3 applications to quickly add the ability for your users to Like/Dislike items and receive recommendations for new items. It uses Redis to store your recommendations and keep them sorted by how good the recommendation is.
-
-Requirements
-------------
-* Ruby 1.9.x
-* Rails 3.x or 4.x
-* Sidekiq or Resque (or DelayedJob)
-
-Bundling one of the queueing systems above is highly recommended to avoid having to manually refresh users' recommendations. If running on Rails 4, the built-in queueing system is supported. If you bundle [Sidekiq][sidekiq], [Resque][resque], or [DelayedJob][delayed_job], Recommendable will use your bundled queueing system instead. If bundling Resque, you should also include ['resque-loner'][resque-loner] in your Gemfile to ensure your users only get queued once (Sidekiq does this by default, and there is no current way to avoid duplicate jobs in DelayedJob).
-
-Installation
-------------
-
-Add the following to your Rails application's `Gemfile`:
-
-``` ruby
-  gem 'recommendable'
-```
-
-After bundling, run the installation generator:
-
-``` bash
-$ rails g recommendable:install
-```
-
-Double check `config/initializers/recommendable.rb` for options on configuring your Redis connection. After a user likes or dislikes something new, they are placed in a queue to have their recommendations updated. If you're using the basic Rails 4.0 queue, you don't need to do anything explicit. If using Sidekiq, Resque, or DelayedJob, start your workers from the command line:
-
-``` bash
-# sidekiq
-$ bundle exec sidekiq -q recommendable
-# resque
-$ QUEUE=recommendable rake environment resque:work
-# delayed_job
-$ rake jobs:work
-```
-
-Usage
------
-
-In your Rails model that will be receiving recommendations:
-
-``` ruby
-class User < ActiveRecord::Base
-  recommends :movies, :shows, :other_things
-  
-  # ...
-end
-```
-
-That's it! Please note, however, that you may only do this in one model at this time.
-
-For more details on how to use Recommendable once it's installed and configured, [check out the more detailed README][recommendable] or see the [documentation][documentation].
-
-Installing Redis
-----------------
-
-Recommendable requires Redis to deliver recommendations. The collaborative filtering logic is based almost entirely on set math, and Redis is blazing fast for this. _NOTE: Your redis database MUST be persistent._
-
-### Mac OS X
-
-For Mac OS X users, homebrew is by far the easiest way to install Redis. Make sure to read the caveats after installation!
-
-``` bash
-$ brew install redis
-```
-
-### Linux
-
-For Linux users, there is a package on apt-get.
-
-``` bash
-$ sudo apt-get install redis-server
-$ redis-server
-```
-
-Redis will now be running on localhost:6379. After a second, you can hit `ctrl-\` to detach and keep Redis running in the background.
-
-### Redis problems?
-
-Oops, did you kill your Redis database? Not to worry. Likes, Dislikes, Ignores,
-and StashedItems are stored as models in your regular database. As long as these
-still exist, you can regenerate the similarity values and recommendations on the
-fly. But try not to have to do it!
-
-``` ruby
-Users.all.each do |user|
-  user.send :update_similarities
-  user.send :update_recommendations
-end
-```
-
-Why not stars?
---------------
-I'll let Randall Munroe of [XKCD](http://xkcd.com/) take this one for me:
-
-[![I got lost and wandered into the world's creepiest cemetery, where the headstones just had names and star ratings. Freaked me out. When I got home I tried to leave the cemetery a bad review on Yelp, but as my hand hovered over the 'one star' button I felt this distant chill ...](http://imgs.xkcd.com/comics/star_ratings.png)](http://xkcd.com/1098/)
-
-Contributing to recommendable
------------------------------
-
-Once you've made your great commits:
-
-1. [Fork][forking] recommendable
-2. Create a feature branch
-3. Write your code (and tests please)
-4. Push to your branch's origin
-5. Create a [Pull Request][pull requests] from your branch
-6. That's it!
-
-Links
------
-* Code: `git clone git://github.com/davidcelis/recommendable.git`
-* Home: <http://github.com/davidcelis/recommendable>
-* Docs: <http://rubydoc.info/gems/recommendable/frames>
-* Bugs: <http://github.com/davidcelis/recommendable/issues>
-* Gems: <http://rubygems.org/gems/recommendable>
-
-Copyright
----------
-
-Copyright © 2012 David Celis. See LICENSE.txt for
-further details.
-
-[stars]: http://davidcelis.com/blog/2012/02/01/why-i-hate-five-star-ratings/
-[sidekiq]: https://github.com/mperham/sidekiq
-[delayed_job]: https://github.com/tobi/delayed_job
-[resque]: https://github.com/defunkt/resque
-[resque-loner]: https://github.com/jayniz/resque-loner
-[forking]: http://help.github.com/forking/
-[pull requests]: http://help.github.com/pull-requests/
-[collaborative filtering]: http://davidcelis.com/blog/2012/02/07/collaborative-filtering-with-likes-and-dislikes/
-[recommendable]: http://davidcelis.github.com/recommendable/
-[documentation]: http://rubydoc.info/gems/recommendable/frames