Merge pull request #35 from jeferson-sb/spaced-repetition

feat: spaced repetition
jeferson-sb · Feb 28, 2024 · e895f1e · e895f1e
2 parents c62bf9a + c3ae3ec
commit e895f1e
Show file tree

Hide file tree

Showing 19 changed files with 324 additions and 98 deletions.
diff --git a/api/Gemfile b/api/Gemfile
@@ -47,6 +47,7 @@ group :development, :test do
   gem 'rubocop-rails', '~> 2.19', require: false
   gem 'rubocop-rspec', '~> 2.22', require: false
   gem 'shoulda-matchers', '~> 5.1'
+  gem 'whenever', '~> 1.0', require: false
 end
 
 group :development do

diff --git a/api/Gemfile.lock b/api/Gemfile.lock
@@ -71,6 +71,7 @@ GEM
     bootsnap (1.16.0)
       msgpack (~> 1.2)
     builder (3.2.4)
+    chronic (0.10.2)
     concurrent-ruby (1.2.2)
     crass (1.0.6)
     date (3.3.3)
@@ -228,6 +229,8 @@ GEM
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
+    whenever (1.0.0)
+      chronic (>= 0.6.3)
     zeitwerk (2.6.7)
 
 PLATFORMS
@@ -252,6 +255,7 @@ DEPENDENCIES
   shoulda-matchers (~> 5.1)
   sqlite3 (~> 1.4)
   tzinfo-data
+  whenever (~> 1.0)
 
 RUBY VERSION
    ruby 3.2.0p0

diff --git a/api/app/controllers/exams_controller.rb b/api/app/controllers/exams_controller.rb
@@ -12,12 +12,21 @@ def index
     render json: @exams
   end
 
+  # Evaluates an exam
+  # FindOrCreate revision (if missed questions)
+  # Store the final answer for the user
   def evaluate
     @exam = Exam.find(params[:exam_id])
     questions = params[:questions]
 
     score, questions_answered_incorrectly = Exams::Evaluate.perform(questions, @exam.questions.length)
     Revisions::Create.perform(params[:exam_id], @user.id, questions_answered_incorrectly)
+    answer = Answer.find_or_create_by(
+      exam_id: params[:exam_id], 
+      user_id: @user.id, 
+      score:
+    )
+    answer.attempt
 
     render json: { score: }, status: :created
   end
@@ -56,7 +65,7 @@ def evaluate_duos
   end
 
   private
-  
+
   def create_params
     params.permit(:title, :difficulty, :version, :category_id, :question_ids)
   end

diff --git a/api/app/mailers/notification_mailer.rb b/api/app/mailers/notification_mailer.rb
@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class NotificationMailer < ApplicationMailer
+  default from: 'noreply@flashmemo.com'
+
+  def review_email
+    @user = params[:user]
+    @url  = params[:url]
+    mail(to: @user.email, subject: 'Hey, Review time!')
+  end
+end
diff --git a/api/app/models/answer.rb b/api/app/models/answer.rb
@@ -4,7 +4,23 @@ class Answer < ApplicationRecord
   belongs_to :user
   belongs_to :exam
 
+  INTERVALS = {
+    1 => 3.days,
+    2 => 1.week,
+    3 => 1.month
+  }.freeze
+
   validates :user, presence: true
   validates :exam, presence: true
   validates :score, presence: true
+
+  def attempt
+    self.last_attempted_at = Time.now
+    self.interval_level += 1 if score < 100 && interval_level < INTERVALS.keys.max
+    save
+  end
+
+  def valid_interval?
+    last_attempted_at + INTERVALS[self.interval_level] < Time.now
+  end
 end
diff --git a/api/app/views/notification_mailer/review_email.html.erb b/api/app/views/notification_mailer/review_email.html.erb
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta content='text/html; charset=UTF-8' http-equiv='Content-Type' />
+  </head>
+  <body>
+    <h1>Hey <%= @user.username %></h1>
+    <p>
+      We bring you these questions to review to <strong>reinforce</strong> your learning! 
+      Just follow <a href=<%= @url %> target="_blank" rel="noopener">this link</a>
+    </p>
+    <p>Thanks, have a great day!</p>
+  </body>
+</html>
diff --git a/api/app/views/notification_mailer/review_email.text.erb b/api/app/views/notification_mailer/review_email.text.erb
@@ -0,0 +1,7 @@
+Hey <%= @user.username %>
+==========================
+
+We bring you these questions to review to improve your learning! 
+Just follow this link: <%= @url %>
+
+Thanks, have a great day!
diff --git a/api/app/views/revisions/show.json.jbuilder b/api/app/views/revisions/show.json.jbuilder
@@ -6,4 +6,4 @@ json.user_id @revision.exam_id
 json.questions @revision.questions
 
 json.created_at @revision.created_at
-json.updated_at @revision.updated_at
+json.updated_at @revision.updated_at
diff --git a/api/config/schedule.rb b/api/config/schedule.rb
@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+env :PATH, ENV['PATH']
+set :environment, :development
+set :output, "#{path}/log/cron.log"
+
+every :day do
+  rake 'send_review_email:all'
+end
diff --git a/api/db/migrate/20240212194401_add_last_attempted_to_answers.rb b/api/db/migrate/20240212194401_add_last_attempted_to_answers.rb
@@ -0,0 +1,5 @@
+class AddLastAttemptedToAnswers < ActiveRecord::Migration[7.0]
+  def change
+    add_column :answers, :last_attempted_at, :datetime
+  end
+end
diff --git a/api/db/migrate/20240212200940_add_interval_level_to_answers.rb b/api/db/migrate/20240212200940_add_interval_level_to_answers.rb
@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddIntervalLevelToAnswers < ActiveRecord::Migration[7.0]
+  def change
+    add_column :answers, :interval_level, :integer, default: 0
+  end
+end
diff --git a/api/db/schema.rb b/api/db/schema.rb
diff --git a/api/lib/tasks/send_review_email.rake b/api/lib/tasks/send_review_email.rake
@@ -0,0 +1,13 @@
+namespace :send_review_email do
+  desc 'Send review email to answer revision'
+  task all: :environment do
+    Revision.find_each(batch_size: 100) do |rev|
+      answer = rev.exam.answer.last
+      is_enough_questions = rev.questions.length > 1
+      if answer && (is_enough_questions && answer.valid_interval?)
+        puts "[LOG] #{Time.now}: sending e-mail revision #{rev.id}"
+        NotificationMailer.with(user: rev.user_id, url: "/api/revisions/#{rev.id}").review_email.deliver_now
+      end
+    end
+  end
+end