Vouchers for user promotion - Part 2: Redemption

.config/commands/utils.justfile

@@ -0,0 +1,71 @@
+# Prints this help message
+[private]
+help:
+    @just --list --justfile {{source_file()}}
+
+# Generates entity-relationship diagrams (ERD) of the database
+erd:
+    #!/usr/bin/env bash
+
+    # Make sure the mampf dev container is running
+    cd {{justfile_directory()}}/docker/development/
+    if [ -z "$(docker compose ps --services --filter 'status=running' | grep mampf)" ]; then
+        echo "The mampf dev container is not running. Please start it first (use 'just docker')."
+        exit 1
+    fi
+
+    mkdir -p {{justfile_directory()}}/tmp/erd/
+
+    # ▶ Generate ERDs
+    # Customize it with options from here: https://voormedia.github.io/rails-erd/customise.html
+    # Also see the output from: 'bundle exec erd --help' (inside the dev container)
+
+    # Ignore some tables
+    ignored_thredded="Thredded::Post,Thredded::UserPostNotification,Thredded::PrivateUser,Thredded::UserPrivateTopicReadState,Thredded::PrivateTopic,Thredded::MessageboardUser,Thredded::PrivatePost,Thredded:UserDetail,Thredded::MessageboardGroup,Thredded::Messageboard,Thredded::Category,Thredded::TopicCategory,Thredded::Topic,Thredded::UserTopicReadState,Thredded::UserTopicFollow,Thredded::NotificationsForFollowedTopics,Thredded::MessageboardNotificationsForFollowedTopics,Thredded::UserPreference,Thredded::UserMessageboardPreference,Thredded::NotificationsForPrivateTopics,Thredded::PostModerationRecord,Thredded::UserDetail"
+    ignored_translation="Mobility::Backends::ActiveRecord::Table::Translation,Subject::Translation,Program::Translation,Division::Translation"
+    ignored_commontator="Commontable,Votable,Subscriber,Creator"
+    other_ignored="ActionMailbox::Record,ActionText::Record,ActiveStorage::Record,Sluggable,FriendlyId::Slug,ApplicationRecord,InteractionsRecord"
+    exclude_default="${ignored_thredded},${ignored_translation},${ignored_commontator},${other_ignored}"
+
+    # 🌟 Overview with attributes (warnings will be printed only here)
+    docker compose exec -it mampf rake erd \
+        title=false filename=/usr/src/app/tmp/erd/mampf-erd-overview-with-attributes \
+        inheritance=false polymorphism=true indirect=false attributes=content \
+        exclude="${exclude_default}"
+
+    # 🌟 Generic Overview
+    docker compose exec -it mampf rake erd warn=false \
+        title=false filename=/usr/src/app/tmp/erd/mampf-erd-overview \
+        inheritance=false polymorphism=true indirect=false attributes=false \
+        exclude="${exclude_default}"
+
+    # 🌟 Vouchers
+    docker compose exec -it mampf rake erd warn=false \
+        title="Vouchers" filename=/usr/src/app/tmp/erd/mampf-erd-vouchers \
+        inheritance=true polymorphism=true indirect=true attributes=content \
+        exclude="${exclude_default},Teachable,Editable" \
+        only="User,Claim,Voucher,Redemption,Lecture,Tutorial,Talk"
+
+    # 🌟 Tutorials
+    docker compose exec -it mampf rake erd warn=false \
+        title="Tutorials" filename=/usr/src/app/tmp/erd/mampf-erd-tutorials \
+        inheritance=true polymorphism=true indirect=true attributes=content \
+        exclude="${exclude_default},Claimable,Editable,Teachable" \
+        only="User,Lecture,Tutorial,Submission,Assignment,TutorTutorialJoin,UserSubmissionJoin"
+
+    # 🌟 Courses
+    docker compose exec -it mampf rake erd warn=false \
+        title="Courses" filename=/usr/src/app/tmp/erd/mampf-erd-courses \
+        inheritance=true polymorphism=true indirect=true attributes=content \
+        exclude="${exclude_default},Claimable,Editable" \
+        only="Subject,Program,Division,DivisionCourseJoin,Course,Lecture,CourseSelfJoin,Lesson"
+
+    # 🌟 Lectures
+    docker compose exec -it mampf rake erd warn=false \
+        title="Lectures" filename=/usr/src/app/tmp/erd/mampf-erd-lectures \
+        inheritance=true polymorphism=true indirect=true attributes=content \
+        exclude="${exclude_default},Claimable,Editable,Teachable" \
+        only="Lecture,Lesson,Chapter,Section,Item,LessonSectionJoin,Term"
+
+    echo "📂 Diagrams are ready for you in the folder {{justfile_directory()}}/tmp/erd/"
+    echo "🔀 For the meanings of the arrows, refer to https://voormedia.github.io/rails-erd/gallery.html#notations"

.justfile

@@ -13,6 +13,9 @@ mod test ".config/commands/test.justfile"
 # Docker-related commands
 mod docker ".config/commands/docker.justfile"
 
+# Some utils, e.g. ERD-generation etc.
+mod utils ".config/commands/utils.justfile"
+
 # Opens the MaMpf wiki in the default browser
 wiki:
     #!/usr/bin/env bash

.vscode/settings.json

@@ -102,12 +102,32 @@
     //////////////////////////////////////
     // Spell Checker
     //////////////////////////////////////
+    "cSpell.enabled": true,
+    "cSpell.ignorePaths": [
+        "node_modules",
+        ".git"
+    ],
+    "cSpell.language": "en,de",
     "cSpell.words": [
+        "activerecord",
+        "ajax",
         "commontator",
+        "cospeaker",
+        "cospeakers",
+        "datetime",
         "factorybot",
         "helpdesk",
         "katex",
+        "preselection",
+        "selectize",
         "Timecop",
-        "turbolinks"
-    ]
+        "turbolinks",
+        "uncached",
+        "whitespaces"
+    ],
+    "cSpell.enableFiletypes": [
+        "ruby"
+        // Other filetypes are handled by the default spell checker
+    ],
+    "cSpell.maxNumberOfProblems": 10000
 }

app/abilities/user_ability.rb

@@ -14,11 +14,7 @@ def initialize(user)
       user.admin? || (!user.generic? && user == given_user)
     end
 
-    can :fill_user_select, User do
-      user.active_teachable_editor?
-    end
-
-    can :list_generic_users, User do
+    can [:fill_user_select, :list_generic_users], User do
       user.admin?
     end
   end

app/abilities/voucher_ability.rb

@@ -7,5 +7,7 @@ def initialize(user)
     can [:create, :invalidate], Voucher do |voucher|
       user.can_update_personell?(voucher.lecture)
     end
+
+    can [:verify, :redeem, :cancel], Voucher
   end
 end

app/controllers/application_controller.rb

@@ -8,6 +8,7 @@ class ApplicationController < ActionController::Base
   before_action :authenticate_user!
   before_action :set_locale
   after_action :store_interaction, if: :user_signed_in?
+  before_action :set_current_user
 
   etag { current_user.try(:id) }
 
@@ -135,4 +136,9 @@ def cookie_locale_param
     def available_locales
       I18n.available_locales.map(&:to_s)
     end
+
+    # https://stackoverflow.com/a/69313330/
+    def set_current_user
+      Current.user = current_user
+    end
 end

app/controllers/cypress/i18n_controller.rb

@@ -10,16 +10,16 @@ def create
 
       substitutions = {}
       if params[:substitutions].present?
-        unless params[:substitutions].is_a?(Hash)
-          msg = "Argument `substitution` must be a hash indicating the substitutions."
-          msg += " But we got: '#{params[:substitutions]}'"
+        begin
+          substitutions = params[:substitutions].to_unsafe_hash.symbolize_keys
+        rescue NoMethodError
+          msg = "Argument `substitution` is '#{params[:substitutions]}'."
+          msg += " We cannot convert that to  a hash."
           raise(ArgumentError, msg)
         end
-        substitutions = params[:substitutions].to_unsafe_hash.symbolize_keys
       end
 
       i18n_key = params[:i18n_key]
-
       render json: I18n.t(i18n_key, **substitutions), status: :created
     end
   end

app/controllers/cypress/user_creator_controller.rb

@@ -16,6 +16,9 @@ def create
 
       user = User.create(name: "#{role} Cypress #{random_hash}",
                          email: "#{role}-#{random_hash}@mampf.cypress",
+                         # Note that some Cypress tests rely on the username
+                         # beginning with "cy" (!)
+                         name_in_tutorials: "cy-#{role}-#{random_hash}",
                          password: CYPRESS_PASSWORD, consents: true, admin: is_admin,
                          locale: I18n.default_locale)
       user.confirm

app/controllers/lecture_notifier.rb

@@ -0,0 +1,45 @@
+module LectureNotifier
+  extend self
+
+  def notify_new_editor_by_mail(editor, lecture)
+    LectureNotificationMailer.with(recipient: editor,
+                                   locale: editor.locale,
+                                   lecture: lecture)
+                             .new_editor_email.deliver_later
+  end
+
+  def notify_about_teacher_change_by_mail(lecture, previous_teacher)
+    notify_new_teacher_by_mail(lecture)
+    notify_previous_teacher_by_mail(previous_teacher, lecture)
+  end
+
+  def notify_cospeakers_by_mail(speaker, talks)
+    talks.each do |talk|
+      talk.speakers.each do |cospeaker|
+        next if cospeaker == speaker
+
+        LectureNotificationMailer.with(recipient: cospeaker,
+                                       locale: cospeaker.locale,
+                                       talk: talk,
+                                       speaker: speaker)
+                                 .new_speaker_email.deliver_later
+      end
+    end
+  end
+
+  private
+
+    def notify_new_teacher_by_mail(lecture)
+      LectureNotificationMailer.with(recipient: lecture.teacher,
+                                     locale: lecture.teacher.locale,
+                                     lecture: lecture)
+                               .new_teacher_email.deliver_later
+    end
+
+    def notify_previous_teacher_by_mail(previous_teacher, lecture)
+      LectureNotificationMailer.with(recipient: previous_teacher,
+                                     locale: previous_teacher.locale,
+                                     lecture: lecture)
+                               .previous_teacher_email.deliver_later
+    end
+end

app/controllers/lectures_controller.rb

@@ -66,15 +66,16 @@ def edit
 
   def create
     @lecture = Lecture.new(lecture_params)
+    @lecture.teacher = current_user unless current_user.admin?
     authorize! :create, @lecture
     @lecture.save
     if @lecture.valid?
       @lecture.update(sort: "special") if @lecture.course.term_independent
       # set organizational_concept to default
       set_organizational_defaults
-      # set lenguage to default language
+      # set language to default language
       set_language
-      # depending on where the create action was trriggered from, return
+      # depending on where the create action was triggered from, return
       # to admin index view or edit course view
       unless params[:lecture][:from] == "course"
         redirect_to administration_path,
@@ -105,10 +106,7 @@ def update
       recipients = User.where(id: new_ids)
 
       recipients.each do |r|
-        NotificationMailer.with(recipient: r,
-                                locale: r.locale,
-                                lecture: @lecture)
-                          .new_editor_email.deliver_later
+        LectureNotifier.notify_new_editor_by_mail(r, @lecture)
       end
     end
 
@@ -336,9 +334,10 @@ def lecture_params
                         :submission_max_team_size, :submission_grace_period,
                         :annotations_status]
       if action_name == "update" && current_user.can_update_personell?(@lecture)
-        allowed_params.push(:teacher_id, { editor_ids: [] })
+        allowed_params.push({ editor_ids: [] })
       end
-      allowed_params.push(:course_id, :teacher_id, { editor_ids: [] }) if action_name == "create"
+      allowed_params.push(:course_id, { editor_ids: [] }) if action_name == "create"
+      allowed_params.push(:teacher_id) if current_user.admin?
       params.require(:lecture).permit(allowed_params)
     end
 

app/controllers/vouchers_controller.rb

@@ -26,9 +26,35 @@ def invalidate
     end
   end
 
+  def verify
+    @voucher = Voucher.find_voucher_by_hash(params[:secure_hash])
+    respond_to do |format|
+      if @voucher
+        format.js
+        format.html { head :no_content }
+      else
+        error_message = I18n.t("controllers.voucher_invalid")
+        format.js { render "error", locals: { error_message: error_message } }
+        format.html { redirect_to edit_profile_path, alert: error_message }
+      end
+    end
+  end
+
   def redeem
-    # TODO: this will be dealt with in the corresponding 2nd PR
-    render js: "alert('Voucher redeemed!')"
+    voucher = Voucher.find_voucher_by_hash(params[:secure_hash])
+    if voucher
+      voucher.redeem(params.permit(tutorial_ids: [], talk_ids: []))
+      redirect_to edit_profile_path, notice: success_message(voucher)
+    else
+      handle_invalid_voucher
+    end
+  end
+
+  def cancel
+    respond_to do |format|
+      format.html { redirect_to edit_profile_path }
+      format.js
+    end
   end
 
   private
@@ -50,6 +76,18 @@ def set_related_data
       I18n.locale = @lecture.locale
     end
 
+    def success_message(voucher)
+      if voucher.tutor?
+        I18n.t("controllers.become_tutor_success")
+      elsif voucher.editor?
+        I18n.t("controllers.become_editor_success")
+      elsif voucher.teacher?
+        I18n.t("controllers.become_teacher_success")
+      elsif voucher.speaker?
+        I18n.t("controllers.become_speaker_success")
+      end
+    end
+
     def handle_successful_save(format)
       format.html { redirect_to edit_lecture_path(@lecture, anchor: "people") }
       format.js
@@ -80,4 +118,12 @@ def handle_voucher_not_found
         end
       end
     end
+
+    def handle_invalid_voucher
+      error_message = I18n.t("controllers.voucher_invalid")
+      respond_to do |format|
+        format.js { render "error", locals: { error_message: error_message } }
+        format.html { redirect_to edit_profile_path, alert: error_message }
+      end
+    end
 end

app/helpers/application_helper.rb

@@ -327,4 +327,10 @@ def get_class_for_any_path(paths)
   def get_class_for_any_path_startswith(paths)
     paths.any? { |path| request.path.starts_with?(path) } ? ACTIVE_CSS_CLASS : ""
   end
+
+  def truncate_result(result, length = 40)
+    result.first(length).tap do |truncated|
+      return truncated.length < length ? truncated : "#{truncated}..."
+    end
+  end
 end