Coursemology/coursemology2

View on GitHub
app/services/course/survey/reminder_service.rb

Summary

Maintainability
A
1 hr
Test Coverage
# frozen_string_literal: true
class Course::Survey::ReminderService
  include Course::ReminderServiceConcern

  class << self
    delegate :closing_reminder, to: :new
    delegate :send_closing_reminder, to: :new
  end

  def closing_reminder(survey, token)
    email_enabled = survey.course.email_enabled(:surveys, :closing_reminder)
    return unless survey.closing_reminder_token == token && survey.published?
    return unless email_enabled.phantom || email_enabled.regular

    send_closing_reminder(survey)
  end

  def send_closing_reminder(survey, include_phantom: true, include_unsubscribed: false)
    students = uncompleted_subscribed_students(survey, include_phantom, include_unsubscribed)
    unless students.empty?
      closing_reminder_students(survey, students)
      closing_reminder_staff(survey, students)
    end
    survey.update_attribute(:closing_reminded_at, Time.zone.now)
  end

  private

  # Send reminder emails to each student who hasn't submitted.
  #
  # @param [Course::Survey] survey The survey to query.
  def closing_reminder_students(survey, recipients)
    recipients.each do |recipient|
      Course::Mailer.survey_closing_reminder_email(recipient.user, survey).deliver_later
    end
  end

  # Send an email to each instructor with a list of students who haven't submitted.
  #
  # @param [Course::Survey] survey The survey to query.
  def closing_reminder_staff(survey, students)
    course_instructors = survey.course.instructors.includes(:user)
    student_list = name_list(students)
    email_enabled = survey.course.email_enabled(:surveys, :closing_reminder_summary)
    course_instructors.each do |instructor|
      is_disabled_as_phantom = instructor.phantom? && !email_enabled.phantom
      is_disabled_as_regular = !instructor.phantom? && !email_enabled.regular
      next if is_disabled_as_phantom || is_disabled_as_regular
      next if instructor.email_unsubscriptions.where(course_settings_email_id: email_enabled.id).exists?

      Course::Mailer.survey_closing_summary_email(instructor.user, survey, student_list).deliver_later
    end
  end

  # Returns a Set of students who have not completed the given survey and subscribe to the survey email.
  #
  # @param [Course::Survey] survey The survey to query.
  # @param [Boolean] include_phantom Whether to include phantom students in the reminder email.
  # @param [Boolean] include_unsubscribed Whether to include unsubscribed students in the reminder (forced reminder).
  # @return [Set<CourseUser>] Set of CourseUsers who have not finished the survey.
  def uncompleted_subscribed_students(survey, include_phantom, include_unsubscribed)
    course_users = survey.course.course_users.student
    email_enabled = survey.course.email_enabled(:surveys, :closing_reminder)
    # Eager load :user as it's needed for the recipient email.
    students = if (email_enabled.regular && !email_enabled.phantom) || !include_phantom
                 course_users.without_phantom_users.includes(:user)
               elsif email_enabled.phantom && !email_enabled.regular
                 course_users.phantom.includes(:user)
               else
                 course_users.includes(:user)
               end

    submitted =
      survey.responses.submitted.includes(experience_points_record: { course_user: :user }).
      map(&:course_user)
    return Set.new(students) - Set.new(submitted) if include_unsubscribed

    unsubscribed = students.joins(:email_unsubscriptions).
                   where('course_user_email_unsubscriptions.course_settings_email_id = ?', email_enabled.id)
    Set.new(students) - Set.new(unsubscribed) - Set.new(submitted)
  end
end