recommender 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 755889264ba0de9061b5c58e1eb8692f181338f08c2a770bed34ca74693e7142
+  data.tar.gz: 8968a8eeca32885854a5fc082d739377874edc3e1b826486e2cbc21560253e3f
+SHA512:
+  metadata.gz: c9378374d88fc1b4e6d7ba84e3bd3a0fa6fe80a5f3c2e5e9d588f33c6254e04213d8880f9481c3e7dbed17bc265552a7b45c97a1d3fdb911e687f060f37b6d00
+  data.tar.gz: 8f1596d387176345185dd693399b3817279343e30ad03e6b73b42e0a8b0105caf91b9330f767384aa3aa98fa8578f80dea871499b961f184185acd9fe59bef3c

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-06-18
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at danielmutubait@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Mutuba
+
+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.md

@@ -0,0 +1,39 @@
+# Recommender
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/recommender`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/recommender. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/recommender/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Recommender project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/recommender/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+task default: :spec

data/lib/recommender/recommendation.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Recommender
+  module Recommendation
+    extend ActiveSupport::Concern
+  
+    included do
+      extend ClassMethods
+    end
+  
+    AssociationMetadata = Struct.new(:join_table, :foreign_key, :association_foreign_key, :reflection_name)
+  
+    module ClassMethods
+      attr_accessor :association_metadata
+  
+      def set_association(association_name)
+        reflection = reflect_on_association(association_name.to_sym)
+        raise ArgumentError, "Association '#{association_name}' not found" unless reflection
+              
+        self.association_metadata = build_association_metadata(reflection)
+      end
+  
+      private
+  
+      def build_association_metadata(reflection)
+        case reflection
+        when ActiveRecord::Reflection::HasAndBelongsToManyReflection
+          AssociationMetadata.new(
+            reflection.join_table,
+            reflection.foreign_key,
+            reflection.association_foreign_key,
+            reflection.name
+          )
+        when ActiveRecord::Reflection::ThroughReflection
+          AssociationMetadata.new(
+            reflection.through_reflection.table_name,
+            reflection.through_reflection.foreign_key,
+            reflection.association_foreign_key,
+            reflection.name
+          )
+        when ActiveRecord::Reflection::HasManyReflection
+          AssociationMetadata.new(
+            reflection.klass.table_name, # reflection.name.to_s.pluralize,
+            reflection.foreign_key,
+            reflection.foreign_key,
+            reflection.name
+          )
+        else
+          raise ArgumentError, "Association '#{reflection.name}' is not a supported type"
+        end
+      end
+    end
+  
+    def recommendations(results: 5)
+      other_instances = self.class.where.not(id: id)
+      self_items = send(self.class.association_metadata.reflection_name).pluck(:id).to_set
+
+      item_recommendations = other_instances.reduce(Hash.new(0)) do |acc, instance|
+        instance_items = instance.send(self.class.association_metadata.reflection_name).pluck(:id).to_set
+        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)
+        weight = (jaccard_index + dice_sorensen_coefficient + collaborative_weight) / 3.0
+        (instance_items - common_items).each do |item_id|
+          # Exclude items that are already liked by the user
+          acc[item_id] += weight unless self_items.include?(item_id)
+        end
+        acc
+      end
+  
+      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_metadata.reflection_name).klass
+      sorted_recommendation_ids.map { |id| [association_table.find(id), item_recommendations[id]] }
+    end
+  end
+end

data/lib/recommender/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Recommender
+  VERSION = "0.1.0"
+end

data/lib/recommender.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# recommender/lib/recommender.rb
+require_relative "recommender/version"
+require 'recommender/recommendation'
+
+module Recommender
+  class Error < StandardError; end
+
+end

data/sig/recommender.rbs

@@ -0,0 +1,4 @@
+module Recommender
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/spec/factories/albums.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :album do
+    name { Faker::Music.album }
+    trait :with_default_names do
+      album_names = [
+        "The Very Best of Kool & The Gang",
+        "Born in the Wild",
+        "Where the Butterflies Go in the Rain",
+        "All the Best: The Hits",
+        "On the Radio: Greatest Hits, Vol. I & II",
+        "Confessions (Expanded Edition)",
+        "The Best Of Bill Withers: Lean On Me",
+        "The Ultimate Collection (Remastered)"
+      ]
+  
+      album_names.each do |album_name|
+        Album.find_or_create_by(name: album_name)
+      end
+    end
+  end
+end

data/spec/factories/movie_likes.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :movie_like do
+    association :user
+    association :movie
+  end
+end

data/spec/factories/movies.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :movie do
+    name { Faker::Movie.title }
+  end
+end

data/spec/factories/users.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :user do
+    name { Faker::TvShows::GameOfThrones.character }
+
+    trait :with_movie_likes do
+      after(:create) do |user|
+        movies = [
+          "Avengers: Infinity War",
+          "Star Wars: The Force Awakens",
+          "Marvel’s The Avengers",
+          "Star Wars: The Last Jedi",
+          "The Dark Knight",
+          "Beauty and the Beast",
+          "Finding Dory",
+          "Pirates of the Caribbean: Dead Man’s Chest"
+        ]
+
+        movies.each do |movie_name|
+          movie = Movie.find_or_create_by(name: movie_name)
+          user.movie_likes.create(movie: movie)
+        end
+      end
+    end
+  end
+end

data/spec/recommender/recommendation_spec.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+# spec/recommender/recommendation_spec.rb
+
+require_relative "../spec_helper"
+
+RSpec.describe Recommender::Recommendation, type: :module do
+  describe "#recommendations ThroughReflection" do
+    let(:first_user_with_movies) { create(:user, :with_movie_likes) }
+    let(:second_user_with_movies) { create(:user, :with_movie_likes) }
+    let(:third_user_with_movies) { create(:user, :with_movie_likes) }
+    let(:first_movie) { create(:movie, name: "Stranger Things") }
+    let(:second_movie) { create(:movie, name: "3 Body Problem") }
+
+    it "has a version number" do
+      expect(Recommender::VERSION).not_to be nil
+    end
+    it "returns recommended movies based on similarity measures" do
+      first_user_with_movies.movies << first_movie
+      first_user_with_movies.movies << second_movie
+      recommendations = second_user_with_movies.recommendations
+      recommended_movies = recommendations.map { |recommendation| recommendation.first }
+      expect(recommended_movies).to include(first_movie)
+      expect(recommended_movies).to include(second_movie)
+    end
+
+    it "returns no recommendations if there are no similar users" do
+      third_user = create(:user)
+      expect(third_user.recommendations).to be_empty
+    end
+
+    it "returns no recommendations if the user has no liked movies" do
+      new_user = create(:user)
+      expect(new_user.recommendations).to be_empty
+    end
+
+    it "does not include duplicate movies in recommendations" do
+      first_user_with_movies.movies << first_movie
+      first_user_with_movies.movies << second_movie
+      recommendations = second_user_with_movies.recommendations
+      recommended_movie_ids = recommendations.map { |recommendation| recommendation.first.id }
+      expect(recommended_movie_ids.uniq.size).to eq(recommended_movie_ids.size)
+    end
+
+    it "respects the maximum number of recommendations limit" do
+      first_user_with_movies.movies << first_movie
+      first_user_with_movies.movies << second_movie
+      recommendations = second_user_with_movies.recommendations(results: 1)
+      expect(recommendations.size).to eq(1)
+    end
+
+    it "distributes similarity scores correctly" do
+      first_user_with_movies.movies << first_movie
+      first_user_with_movies.movies << second_movie
+      third_user_with_movies.movies << second_movie
+      recommendations = second_user_with_movies.recommendations()
+      expect(recommendations.size).to eq(2)
+      # Extract the ratings from the recommendations
+      recommended_movie_ratings = recommendations.map { |_, rating| [ rating] }.flatten
+      # Ensure the ratings are not the same
+      expect(recommended_movie_ratings[1]).not_to eq(recommended_movie_ratings[0])
+      expect(recommended_movie_ratings[0] > recommended_movie_ratings[1]).to be(true)
+      # Check that the second_movie appears first in the rating list
+      expect(recommendations[0][0]).to eq(second_movie)
+    end
+
+    it "handles edge cases gracefully" do
+      single_user = create(:user, :with_movie_likes)
+      expect(single_user.recommendations).to be_empty
+
+      empty_system = User.destroy_all
+      new_user = create(:user)
+      expect(new_user.recommendations).to be_empty
+    end
+  end
+
+  describe "#recommendations HasAndBelongsToManyReflection" do
+    let!(:first_user) { create(:user) }
+    let!(:second_user) { create(:user) }
+    let(:first_album) { create(:album, :with_default_names) }
+    let(:second_album) { create(:album, :with_default_names) }
+    let(:third_album) { create(:album, :with_default_names) }
+    let(:latest_album) { create(:album, name: "CRASH") }
+    let(:trending_album) { create(:album, name: "Gold: Lionel Richie / Commodores") }
+
+    before do
+      first_user.albums << first_album
+      first_user.albums << second_album
+      first_user.albums << trending_album
+      second_user.albums << first_album
+      second_user.albums << second_album
+    end
+    
+    it "returns recommended albums based on similarity measures" do
+      recommendations = trending_album.recommendations
+      album_user_recommendations = recommendations.map { |recommendation| recommendation.first }
+      expect(album_user_recommendations).to include(second_user)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "recommender"
+require 'factory_bot_rails'
+require "faker"
+require 'database_cleaner/active_record'
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../test_app/config/environment.rb', __FILE__)
+
+factories_path = File.expand_path("../spec/factories/**/*.rb", __dir__)
+Dir[factories_path].sort.each { |file| require file }
+Dir[Rails.root.join('spec', '**', '*.rb')].sort.each { |file| require file }
+
+RSpec.configure do |config|
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  config.include FactoryBot::Syntax::Methods
+
+  config.before(:suite) do
+    FactoryBot.find_definitions
+  end
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.before(:suite) do
+    FactoryBot.find_definitions
+  end
+
+  config.before(:each) do
+    # Ensure a clean state for each test
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

data/spec/test_app/Dockerfile

@@ -0,0 +1,58 @@
+# syntax = docker/dockerfile:1
+
+# Make sure RUBY_VERSION matches the Ruby version in .ruby-version and Gemfile
+ARG RUBY_VERSION=3.2.2
+FROM registry.docker.com/library/ruby:$RUBY_VERSION-slim as base
+
+# Rails app lives here
+WORKDIR /rails
+
+# Set production environment
+ENV RAILS_ENV="production" \
+    BUNDLE_DEPLOYMENT="1" \
+    BUNDLE_PATH="/usr/local/bundle" \
+    BUNDLE_WITHOUT="development"
+
+
+# Throw-away build stage to reduce size of final image
+FROM base as build
+
+# Install packages needed to build gems
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y build-essential git libpq-dev pkg-config
+
+# Install application gems
+COPY Gemfile Gemfile.lock ./
+RUN bundle install && \
+    rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git
+
+# Copy application code
+COPY . .
+
+# Precompiling assets for production without requiring secret RAILS_MASTER_KEY
+RUN SECRET_KEY_BASE_DUMMY=1 ./bin/rails assets:precompile
+
+
+# Final stage for app image
+FROM base
+
+# Install packages needed for deployment
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y curl postgresql-client && \
+    rm -rf /var/lib/apt/lists /var/cache/apt/archives
+
+# Copy built artifacts: gems, application
+COPY --from=build /usr/local/bundle /usr/local/bundle
+COPY --from=build /rails /rails
+
+# Run and own only the runtime files as a non-root user for security
+RUN useradd rails --create-home --shell /bin/bash && \
+    chown -R rails:rails db log tmp
+USER rails:rails
+
+# Entrypoint prepares the database.
+ENTRYPOINT ["/rails/bin/docker-entrypoint"]
+
+# Start the server by default, this can be overwritten at runtime
+EXPOSE 3000
+CMD ["./bin/rails", "server"]

data/spec/test_app/Gemfile

@@ -0,0 +1,41 @@
+source "https://rubygems.org"
+
+ruby "3.2.2"
+
+# Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main"
+gem "rails", "~> 7.1.3", ">= 7.1.3.4"
+
+# The original asset pipeline for Rails [https://github.com/rails/sprockets-rails]
+gem "sprockets-rails"
+
+# Use postgresql as the database for Active Record
+gem "pg", "~> 1.1"
+
+# Use the Puma web server [https://github.com/puma/puma]
+gem "puma", ">= 5.0"
+
+# Use Kredis to get higher-level data types in Redis [https://github.com/rails/kredis]
+# gem "kredis"
+
+# Use Active Model has_secure_password [https://guides.rubyonrails.org/active_model_basics.html#securepassword]
+# gem "bcrypt", "~> 3.1.7"
+gem 'recommender', path: '../../../recommender'
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem "tzinfo-data", platforms: %i[ windows jruby ]
+
+group :development, :test do
+  # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem
+  gem "debug", platforms: %i[ mri windows ]
+end
+
+group :development do
+  # Use console on exceptions pages [https://github.com/rails/web-console]
+  gem "web-console"
+
+  # Add speed badges [https://github.com/MiniProfiler/rack-mini-profiler]
+  # gem "rack-mini-profiler"
+
+  # Speed up commands on slow machines / big apps [https://github.com/rails/spring]
+  # gem "spring"
+end
+