coletivo-mongoid 0.0.3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Diógenes Falcão
+
+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.rdoc

@@ -0,0 +1,70 @@
+= coletivo-mongoid
+
+A simple Rails 3 recommendations engine for Mongoid models.
+
+Coletivo uses {Euclidean Distance}[http://en.wikipedia.org/wiki/Euclidean_distance] or {Pearson's Correlation Coefficient}[http://en.wikipedia.org/wiki/Pearson_product-moment_correlation_coefficient] to calculate the similarity between persons and their preferences.
+
+This is a fork of [coletivo](https://github.com/diogenes/coletivo), if you need ActiveRecord support, check coletivo.
+
+== Installation:
+
+  sudo gem install coletivo-mongoid
+  
+  or in your rails app, add following line in 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::Person
+    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
+
+Copyright (c) 2011 Diógenes Falcão. 
+Copyright (c) 2012 Francis Chong.
+
+See LICENSE.txt for further details.

data/lib/coletivo.rb

@@ -0,0 +1,33 @@
+require 'active_model'
+require 'active_record'
+require 'active_support'
+
+module Coletivo
+  module Models
+    autoload :Recommendable, 'coletivo/models/recommendable'
+    autoload :Person, 'coletivo/models/person'
+    autoload :PersonRating, 'coletivo/models/person_rating'
+  end
+
+  module Similarity
+    NO_SIMILARITY = -1.0..0.49
+    SIMILAR = 0.5..0.99
+    IDENTICAL = 1.0
+
+    autoload :BaseStrategy, 'coletivo/similarity/base_strategy'
+    autoload :EuclideanDistanceStrategy, 'coletivo/similarity/euclidean_distance_strategy'
+    autoload :PearsonCorrelationStrategy, 'coletivo/similarity/pearson_correlation_strategy'
+    autoload :Engine, 'coletivo/similarity/engine'
+  end
+
+  module Config
+    mattr_accessor :ratings_container
+
+    # Defaults
+    self.ratings_container = Coletivo::Models::PersonRating
+  end
+
+  if defined?(Rails)
+    require 'coletivo/rails/engine'
+  end
+end

data/lib/coletivo/models/person.rb

@@ -0,0 +1,27 @@
+module Coletivo
+  module Models
+    module Person
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        # TODO: has_own_preferences doc.
+        def has_own_preferences(options = {})
+          self.send :include, InstanceMethods
+        end
+      end # ClassMethods
+
+      module InstanceMethods
+        def rate!(rateable, weight)
+          Coletivo::Config.ratings_container.create!({
+            :person => self,
+            :rateable => rateable,
+            :weight => weight
+          })
+        end
+      end # InstanceMethods
+
+    end # Person
+  end # Models
+end

data/lib/coletivo/models/person_rating.rb

@@ -0,0 +1,27 @@
+require 'mongoid'
+
+module Coletivo
+  module Models
+    class PersonRating
+      include Mongoid::Document
+      include Mongoid::Timestamps
+
+      field :person_id, type: String
+      field :person_type, type: String
+      
+      field :rateable_id, type: String
+      field :rateable_type, type: String
+
+      field :weight, type: BigDecimal, :precision => 5, :scale => 2
+
+      belongs_to :person, :polymorphic => true
+      belongs_to :rateable, :polymorphic => true
+
+      validates :person, :rateable, :weight, :presence => true
+
+      def self.find_for_recommendation(person, rateable_type)
+        where(:rateable_type => rateable_type.to_s)
+      end
+    end
+  end
+end

data/lib/coletivo/models/recommendable.rb

@@ -0,0 +1,78 @@
+module Coletivo
+  module Models
+    module Recommendable
+      def self.included(base)
+        base.extend ClassMethods
+        base.send :include, InstanceMethods
+      end
+
+      module ClassMethods
+        def find_recommendations_for(person, options = {})
+          preferences = options[:preferences] ||=
+            load_preferences_for_recommendation(person)
+          top = predict_highest_ratings(person, preferences, options)
+          ids = top.collect(&:last)
+          where(:_id.in => ids).limit(options[:limit]).all
+        end
+
+        def map_ratings_to_preferences(ratings)
+          #TODO: (???) Item based mapping.
+          key, subkey = :person_id, :rateable_id
+          preferences = {}
+
+          ratings.each do |rating|
+            p = preferences[rating.send(key)] ||= {}
+            p[rating.send(subkey)] = rating.weight
+          end
+
+          preferences
+        end
+
+        def load_preferences_for_recommendation(person)
+          r = Coletivo::Config.ratings_container\
+                .find_for_recommendation(person, self)
+
+          map_ratings_to_preferences(r)
+        end
+
+        private
+
+        def predict_highest_ratings(person, people_preferences, options)
+          data = {}
+          people_preferences.each do |other, other_prefs|
+            next if other == person
+
+            sim = person.similarity_with(other, options)
+            next if sim <= 0
+
+            other_prefs.each do |item, weight|
+              unless people_preferences[person.id].keys.include?(item)
+                data[item] ||= {:total_similarity => 0.0, :weighted_mean => 0.0}
+                data[item][:total_similarity] += sim
+                data[item][:weighted_mean] += weight * sim
+              end
+            end
+          end
+
+          # e.g: [[5.35, "movie_2"], [2.0, "movie_4"]]
+          guessed_rating_and_id = Proc.new do |item, item_data|
+            [item_data[:weighted_mean] / item_data[:total_similarity], item]
+          end
+
+          # DESC sorting by weighted mean of ratings
+          data.collect(&guessed_rating_and_id).sort_by(&:first).reverse
+        end
+      end
+
+      module InstanceMethods
+        def similarity_with(other_id, options = {})
+          p = options[:preferences] ||
+            self.class.load_preferences_for_recommendation(self)
+
+          Coletivo::Similarity::Engine\
+            .similarity_between(self.id, other_id, p, options)
+        end
+      end
+    end # Recommendable
+  end # Models
+end

data/lib/coletivo/rails/engine.rb

@@ -0,0 +1,6 @@
+require 'coletivo'
+
+module Coletivo
+  class Engine < Rails::Engine
+  end
+end

data/lib/coletivo/similarity/base_strategy.rb

@@ -0,0 +1,25 @@
+module Coletivo
+  module Similarity
+    class BaseStrategy
+      attr_accessor :preferences
+
+      def similarity_between(one, other)
+        raise "The #similarity_between was not implemented in #{self.class}"
+      end
+
+      def train_with(people_preferences)
+        @preferences = people_preferences
+      end
+
+      protected
+
+      def shared_items_between(one, other)
+        return [] unless preferences[one] && preferences[other]
+
+        preferences[one].keys.select { |item|
+          preferences[other].keys.include? item
+        }
+      end
+    end
+  end # Similarity
+end # Coletivo

data/lib/coletivo/similarity/engine.rb

@@ -0,0 +1,22 @@
+module Coletivo
+  module Similarity
+    class Engine
+      def self.similarity_between(one, other, preferences, options = {})
+        strategy = load_strategy options[:strategy]
+        strategy.train_with(preferences)
+
+        strategy.similarity_between(one, other)
+      end
+
+      protected
+
+      def self.load_strategy(key)
+        if :pearson == key
+          Coletivo::Similarity::PearsonCorrelationStrategy.new
+        else
+          Coletivo::Similarity::EuclideanDistanceStrategy.new
+        end
+      end
+    end # Engine
+  end # Similarity
+end

data/lib/coletivo/similarity/euclidean_distance_strategy.rb

@@ -0,0 +1,18 @@
+module Coletivo
+  module Similarity
+    class EuclideanDistanceStrategy < BaseStrategy
+      def similarity_between(one, other)
+        shared = shared_items_between(one, other)
+
+        return 0 if shared.empty?
+
+        sum_of_squares = shared.inject(0.0) { |sum, item|
+          sum + (preferences[one][item] - preferences[other][item]) ** 2
+        }
+
+        1 / (1 + sum_of_squares)
+      end
+    end
+  end
+end
+

data/lib/coletivo/similarity/pearson_correlation_strategy.rb

@@ -0,0 +1,35 @@
+module Coletivo
+  module Similarity
+    class PearsonCorrelationStrategy < BaseStrategy
+      def similarity_between(one, other)
+        shared      = shared_items_between(one, other)
+        prefs_one   = preferences[one]
+        prefs_other = preferences[other]
+
+        return 0 if shared.empty?
+
+        sum_prefs_one = sum_prefs_other = sum_squares_one = \
+          sum_squares_other = p_sum = 0.0
+
+        shared.each { |item|
+          sum_prefs_one     += prefs_one[item]
+          sum_prefs_other   += prefs_other[item]
+          sum_squares_one   += prefs_one[item] ** 2
+          sum_squares_other += prefs_other[item] ** 2
+          p_sum             += prefs_one[item] * prefs_other[item]
+        }
+
+        total_shared = shared.size
+
+        numerator = p_sum - (sum_prefs_one * sum_prefs_other / total_shared)
+
+        den_one = sum_squares_one - (sum_prefs_one ** 2) / total_shared
+        den_other = sum_squares_other - (sum_prefs_other ** 2) / total_shared
+
+        denominator = Math.sqrt(den_one * den_other)
+
+        denominator == 0 ? 0 : numerator / denominator
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: coletivo-mongoid
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Francis Chong
+- Diógenes Falcão
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70162405915120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: *70162405915120
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &70162405901680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta2
+  type: :development
+  prerelease: false
+  version_requirements: *70162405901680
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70162405888800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.14
+  type: :development
+  prerelease: false
+  version_requirements: *70162405888800
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70162405862020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.2
+  type: :development
+  prerelease: false
+  version_requirements: *70162405862020
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: &70162405857100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70162405857100
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: &70162405842760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70162405842760
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: &70162405839780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70162405839780
+description: A simple Rails 3 recommendations engine using Mongoid models
+email: francis@ignition.hk
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- lib/coletivo.rb
+- lib/coletivo/models/person.rb
+- lib/coletivo/models/person_rating.rb
+- lib/coletivo/models/recommendable.rb
+- lib/coletivo/rails/engine.rb
+- lib/coletivo/similarity/base_strategy.rb
+- lib/coletivo/similarity/engine.rb
+- lib/coletivo/similarity/euclidean_distance_strategy.rb
+- lib/coletivo/similarity/pearson_correlation_strategy.rb
+- LICENSE.txt
+- README.rdoc
+homepage: http://github.com/siuying/coletivo-mongoid
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2909253334946169336
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A simple Rails 3 recommendations engine using Mongoid models
+test_files: []