recommender 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6024955f742097c38d66b229a1a39c2eac7665f9a6ccaa870d93d6b5327a8b83
-  data.tar.gz: df0f2fe577d47dcc775bc1fe884da3be87f5dbcdb8c23e2e69be470937a9f91f
+  metadata.gz: f23eac1f93035fe6f01ceb18a5f62ac4062578eed8ea87f7e7ddb0781fb889af
+  data.tar.gz: 66b4a78cc848d0587f1451bff6694eba94653e91ee6a916b1a910c099636ed24
 SHA512:
-  metadata.gz: 133276891d8a885b903e8cf2512ff263b56980c7752649234281a7d38fa90dc46758da1a5b7d160919457c009854915bb0452fc7a2cd8660685c6d5ca1cec6b2
-  data.tar.gz: d035dc95292eec167e9acad8df02bca40f93084da8e5abad1aafd6d95f89e81366270cb09df843142cf8b0494ce57b5166326e62aff166880237513aaff06533
+  metadata.gz: 1291601deb871fb74aeee99f1936788daaf293757819f7440babe4881a470e500a57b366a7bd8a42d403845113d6ca707e824bd3fac0e97d13d22721635dee21
+  data.tar.gz: 5c2d3e693ef42fa4df000276213dd2e71edd72bce77c44606a6e7fa2f3be435d52f2758d3305ed648d238d7ff163f5f94eb6e13e425b525d304558caebfb5783

data/CHANGELOG.md

@@ -1,17 +1,18 @@
-\# Changelog
+# Changelog
 
-\## \[Unreleased\]
+## \[2.0.1\] - 2024-07-16
 
-\## \[2.0.0\] - 2024-06-22  
-\### Added  
-\- Feature: Similarity based on multiple associations combined with weights.  
-\- Feature: User-item recommendations based on all their items.  
-\- Feature: Recommendations based on numerical ratings.  
-\- Feature: Recommendations based on a weighted mix of various associations.
+### Added
 
-\### Changed  
-\- Internal refactoring to support the new features.
+- Feature: Similarity based on multiple associations combined with weights.
+- Feature: User-item recommendations based on all their items.
 
-\## \[0.1.0\] - 2024-06-18  
-\### Added  
-\- Initial release
+### Changed
+
+- Internal refactoring to support the new features.
+
+## \[0.1.0\] - 2024-06-18
+
+### Added
+
+- Initial release

data/README.md

@@ -8,47 +8,48 @@ The `Recommender` gem is a versatile recommendation engine built for Ruby on Rai
 - **Multiple Association Support:** Compatible with `has_and_belongs_to_many`, `has_many :through`, and `has_many` associations, allowing seamless integration with different data models.
 - **Customizable Recommendations:** Easily extendable and configurable to fit the specific needs of your application.
 - **Lightweight and Efficient:** Designed to be efficient and minimalistic, ensuring fast recommendation calculations without heavy overhead.
+- Feature: Similarity based on multiple associations combined with weights.
+- Feature: User-item recommendations based on all their items.
 
-### Installation
+### Coming soon:
 
-Add this line to your application's Gemfile:
+- Feature: Recommendations based on a weighted mix of various associations.
 
-ruby
+### Installation
 
-Copy code
+Add this line to your application's Gemfile:
 
 `gem 'recommender'`
 
 And then execute:
 
-sh
-
-Copy code
-
 `bundle install`
 
 ### Usage
 
 Include the `Recommender::Recommendation` module in your model and set the association:
 
-```
-class Album < ApplicationRecord
-  include Recommender::Recommendation
-  has_and_belongs_to_many :users
-  validates :name, presence: true, uniqueness: { case_sensitive: false }
+```ruby
+  class User < ApplicationRecord
+    include Recommender::Recommendation
+
+    has_many :movie_likes, dependent: :destroy
+    has_many :movies, through: :movie_likes
 
-  set_association :users
-end
+    validates :name, presence: true,  uniqueness: { case_sensitive: false }
+
+    set_association :movies
+  end
 ```
 
 Now you can get recommendations for an instance:
 
-```
-user = User.find(1)
-recommendations = user.recommendations(results: 5)
-recommendations.each do |recommended_album, score|
-  puts "#{recommended_album.name} - Score: #{score}"
-end
+```ruby
+  user = User.find(1)
+  recommendations = user.recommendations(results: 5)
+  recommendations.each do |recommended_movie, score|
+    puts "#{recommended_movie.name} - Score: #{score}"
+  end
 ```
 
 ### How It Works

data/lib/recommender/recommendation.rb

@@ -10,47 +10,42 @@ module Recommender
       extend ClassMethods
     end
 
-    AssociationMetaData = Struct.new("AssociationMetaData", :join_table, :foreign_key, :association_foreign_key, :reflection_name, :weight)
+    AssociationMetadata = Struct.new(:join_table, :foreign_key, :association_foreign_key, :reflection_name)
 
     module ClassMethods
-      attr_accessor :association_meta_data
+      attr_accessor :association_metadata
 
-      def set_associations(associations)        
-        @association_meta_data = associations.map do |association_name, weight|          
-          reflection = reflect_on_association(association_name.to_sym)
-          raise ArgumentError, "Association '#{association_name}' not found" unless reflection
+      def set_association(association_name)
+        reflection = reflect_on_association(association_name.to_sym)
+        raise ArgumentError, "Association '#{association_name}' not found" unless reflection
 
-          build_association_meta_data(reflection, weight)
-        end
+        @association_metadata ||= build_association_metadata(reflection)
       end
 
       private
 
-      def build_association_meta_data(reflection, weight)
+      def build_association_metadata(reflection)
         case reflection
         when ActiveRecord::Reflection::HasAndBelongsToManyReflection
-          AssociationMetaData.new(
+          AssociationMetadata.new(
             reflection.join_table,
             reflection.foreign_key,
             reflection.association_foreign_key,
-            reflection.name,
-            weight
+            reflection.name
           )
         when ActiveRecord::Reflection::ThroughReflection
-          AssociationMetaData.new(
+          AssociationMetadata.new(
             reflection.through_reflection.table_name,
             reflection.through_reflection.foreign_key,
             reflection.association_foreign_key,
-            reflection.name,
-            weight
+            reflection.name
           )
         when ActiveRecord::Reflection::HasManyReflection
-          AssociationMetaData.new(
+          AssociationMetadata.new(
             reflection.klass.table_name,
             reflection.foreign_key,
             reflection.foreign_key,
             reflection.name,
-            weight
           )
         else
           raise ArgumentError, "Association '#{reflection.name}' is not a supported type"
@@ -58,33 +53,57 @@ module Recommender
       end
     end
 
-    def recommendations(results: 5)
+    def recommendations(results: 10)
       other_instances = self.class.where.not(id: id)
-      item_recommendations = other_instances.reduce(Hash.new(0)) do |acc, instance|
-        self.class.association_meta_data.each do |meta_data|          
-          self_items = send(meta_data.reflection_name).pluck(:id).to_set
-          instance_items = instance.send(meta_data.reflection_name).pluck(:id).to_set
-          common_items = self_items & instance_items
-
-          jaccard_index = common_items.size.to_f / (self_items | instance_items).size
-          dice_sorensen_coefficient = (2.0 * common_items.size) / (self_items.size + instance_items.size)
-          collaborative_weight = common_items.size.to_f / Math.sqrt(self_items.size * instance_items.size)
-
-          # Calculate weighted score for this association
-          association_weighted_score = meta_data.weight * (jaccard_index + dice_sorensen_coefficient + collaborative_weight) / 3.0
-
-          # Recommend items based on this association
-          (instance_items - common_items).each do |item_id|
-            acc[item_id] += association_weighted_score unless self_items.include?(item_id)
-          end
-        end
 
-        acc
+      self_items = associated_items.to_set
+
+      item_recommendations = calculate_recommendations(other_instances, self_items)
+
+      sorted_recommendation_ids = sort_recommendations(item_recommendations).take(results)
+
+      fetch_recommendation_objects(sorted_recommendation_ids, item_recommendations)
+    end
+
+    private
+
+    def associated_items
+      send(self.class.association_metadata.reflection_name).pluck(self.class.association_metadata.association_foreign_key)
+    end
+
+    def calculate_recommendations(other_instances, self_items)
+      other_instances.each_with_object(Hash.new(0)) do |instance, acc|
+        instance_items = instance.send(self.class.association_metadata.reflection_name).pluck(self.class.association_metadata.association_foreign_key).to_set
+        common_items = instance_items & self_items
+
+        weight = calculate_weight(common_items, instance_items, self_items)
+
+        (instance_items - common_items).each do |item_id|
+          acc[item_id] += weight unless self_items.include?(item_id)
+        end
       end
+    end
+
+    def calculate_weight(common_items, instance_items, self_items)
+      jaccard_index = common_items.size.to_f / (instance_items | self_items).size
+      dice_sorensen_coefficient = (2.0 * common_items.size) / (instance_items.size + self_items.size)
+      collaborative_weight = common_items.size.to_f / Math.sqrt(instance_items.size * self_items.size)
 
-      sorted_recommendation_ids = item_recommendations.keys.sort_by { |id| item_recommendations[id] }.reverse.take(results)
-      association_table = self.class.reflect_on_association(self.class.association_meta_data.first.reflection_name).klass
-      sorted_recommendation_ids.map { |id| [association_table.find(id), item_recommendations[id]] }
+      (jaccard_index + dice_sorensen_coefficient + collaborative_weight) / 3.0
+    end
+
+    def sort_recommendations(item_recommendations)
+      item_recommendations.keys.sort_by { |id| item_recommendations[id] }.reverse
+    end
+
+    def fetch_recommendation_objects(sorted_recommendation_ids, item_recommendations)
+      association = self.class.reflect_on_association(self.class.association_metadata.reflection_name)
+      association_table = association.klass
+
+      sorted_recommendation_ids.map do |id|
+        value = item_recommendations[id]
+        [association_table.find(id), value.is_a?(Float) && value.nan? ? 0 : value]
+      end
     end
   end
 end

data/lib/recommender/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Recommender
-  VERSION = '2.0.0'
+  VERSION = '2.0.1'
 end

data/recommender.gemspec

@@ -31,7 +31,6 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  # spec.add_runtime_dependency 'activesupport', '~> 3.0', '>= 3.0.0'
   spec.add_development_dependency "rspec", "~> 3.9.0"
   spec.add_development_dependency  "pg", "~> 1.1"
   spec.add_development_dependency "factory_bot_rails", "~> 6.2"

data/spec/test_app/Gemfile.lock

@@ -1,11 +1,9 @@
 PATH
   remote: ../..
   specs:
-    recommender (0.1.0)
-      activesupport (>= 3.0.0)
-      database_cleaner-active_record
+    recommender (2.0.0)
+      database_cleaner-active_record (~> 2.0)
       faker (~> 2.21)
-      pry-rails
       rails (~> 7.1.3)
 
 GEM
@@ -89,7 +87,6 @@ GEM
     bigdecimal (3.1.8)
     bindex (0.8.1)
     builder (3.3.0)
-    coderay (1.1.3)
     concurrent-ruby (1.3.3)
     connection_pool (2.4.1)
     crass (1.0.6)
@@ -122,7 +119,6 @@ GEM
       net-pop
       net-smtp
     marcel (1.0.4)
-    method_source (1.1.0)
     mini_mime (1.1.5)
     minitest (5.24.0)
     mutex_m (0.2.0)
@@ -143,11 +139,6 @@ GEM
     nokogiri (1.16.6-x86_64-linux)
       racc (~> 1.4)
     pg (1.5.6)
-    pry (0.14.2)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    pry-rails (0.3.9)
-      pry (>= 0.10.4)
     psych (5.1.2)
       stringio
     puma (6.4.2)

data/spec/test_app/app/models/album.rb

@@ -4,5 +4,5 @@ class Album < ApplicationRecord
   has_and_belongs_to_many :users
   validates :name, presence: true, uniqueness: { case_sensitive: false }
 
-  set_associations users: 2.0
+  set_association :users
 end

data/spec/test_app/app/models/user.rb

@@ -6,5 +6,6 @@ class User < ApplicationRecord
   has_and_belongs_to_many :albums
 
   validates :name, presence: true,  uniqueness: { case_sensitive: false }
-  set_associations movies: 3.0
+
+  set_association :movies
 end