coletivo-mongoid

A simple Rails 3 recommendations engine for Mongoid models.

Coletivo uses Euclidean Distance or Pearson’s Correlation Coefficient to calculate the similarity between persons and their preferences.

This is a fork of coletivo, if you need ActiveRecord support, check coletivo.

Installation:

sudo gem install coletivo-mongoid

or in your rails app, add following line to Gemfile:

gem "coletivo-mongoid"

Usage:

At your Rails model that represents a person (can be an User, Member, or something like that):

class User
  include Mongoid::Document
  include Coletivo::Models::Person
  include Coletivo::Models::Recommendable
  has_own_preferences

  # ...
end

At your models that represent something that can be recommend (such as Movie):

class Movie
  include Mongoid::Document
  include Coletivo::Models::Recommendable

  # ...
end

So, a person can rate things:

current_user = User.create(:name => 'Diogenes')
movie = Movie.create(:name => 'The Tourist', :year => 2010)

current_user.rate!(movie, 4.5)

And after a lot of ratings… recommendations:

Movie.find_recommendations_for(current_user) # => movies and more movies...

By default, the similarity strategy used is Euclidean Distance, but you can change that passing the strategy option:

Movie.find_recommendations_for(current_user, :strategy => :pearson)

Contributing to coletivo-mongoid

Check out the latest master to make sure the feature hasn’t been implemented or the bug hasn’t been fixed yet
Check out the issue tracker to make sure someone already hasn’t requested it and/or contributed it
Fork the project
Start a feature/bugfix branch
Commit and push until you are happy with your contribution
Make sure to add tests for it. This is important so I don’t break it in a future version unintentionally.
Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

See LICENSE.txt for further details.