Rename SpamReport to UserContentReport

arkirchner · arkirchner · commit def5481bb11a · 2025-07-17T16:50:43.000+02:00
Not only Spam will be reported. Any user content can be
reported. Mailer name was adjusted to fit the naming convention.
diff --git a/app/controllers/comments_controller.rb b/app/controllers/comments_controller.rb
@@ -65,7 +65,7 @@ def destroy
   def report
     authorize!
 
-    ReportMailer.with(reported_content: @comment).report_content.deliver_later
+    UserContentReportMailer.with(reported_content: @comment).report_content.deliver_later
 
     head :no_content
   end
diff --git a/app/controllers/request_for_comments_controller.rb b/app/controllers/request_for_comments_controller.rb
@@ -166,7 +166,7 @@ def create
   def report
     authorize!
 
-    ReportMailer.with(reported_content: @request_for_comment).report_content.deliver_later
+    UserContentReportMailer.with(reported_content: @request_for_comment).report_content.deliver_later
 
     redirect_to @request_for_comment, notice: t('.reported'), status: :see_other
   end
diff --git a/app/mailers/report_mailer.rb b/app/mailers/report_mailer.rb
diff --git a/app/mailers/user_content_report_mailer.rb b/app/mailers/user_content_report_mailer.rb
@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class UserContentReportMailer < ApplicationMailer
+  default to: CodeOcean::Config.new(:code_ocean).read.dig(:content_moderation, :report_emails)
+
+  def report_content
+    @user_content_report = UserContentReport.new(reported_content: params.fetch(:reported_content))
+
+    mail(subject: I18n.t('user_content_report_mailer.report_content.subject', human_model_name: @user_content_report.human_model_name))
+  end
+end
diff --git a/app/models/user_content_report.rb b/app/models/user_content_report.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class SpamReport
+class UserContentReport
   def initialize(reported_content:)
     unless [Comment, RequestForComment].include?(reported_content.class)
       raise("#{reported_content.model_name} is not configured for spam reports.")
diff --git a/app/views/report_mailer/report_content.html.slim b/app/views/report_mailer/report_content.html.slim
diff --git a/app/views/report_mailer/report_content.text.slim b/app/views/report_mailer/report_content.text.slim
diff --git a/app/views/user_content_report_mailer/report_content.html.slim b/app/views/user_content_report_mailer/report_content.html.slim
@@ -0,0 +1,6 @@
+h3 = t('.prolog')
+blockquote style="white-space: pre-wrap;" = @user_content_report.reported_message
+p = t('.take_action')
+p = link_to(request_for_comment_url(@user_content_report.related_request_for_comment), request_for_comment_url(@user_content_report.related_request_for_comment))
+- if @user_content_report.course_url.present?
+  p = link_to(t('.authentication'), @user_content_report.course_url)
diff --git a/app/views/user_content_report_mailer/report_content.text.slim b/app/views/user_content_report_mailer/report_content.text.slim
@@ -0,0 +1,12 @@
+== t('.prolog')
+== "\n\n"
+== @user_content_report.reported_message.lines.map { "> #{it}" }.join
+== "\n\n"
+== t('.take_action')
+== "\n\n"
+== request_for_comment_url(@user_content_report.related_request_for_comment)
+== "\n\n"
+- if @user_content_report.course_url.present?
+  == t('.authentication')
+  == "\n\n"
+  == @user_content_report.course_url
diff --git a/config/locales/de/user_content_report.yml b/config/locales/de/user_content_report.yml
@@ -1,6 +1,6 @@
 ---
 de:
-  report_mailer:
+  user_content_report_mailer:
     report_content:
       authentication: Kurs-URL für die LTI-Authentifizierung.
       prolog: 'Die folgenden Inhalte wurden als unangemessen gemeldet:'
diff --git a/config/locales/en/user_content_report.yml b/config/locales/en/user_content_report.yml
@@ -1,6 +1,6 @@
 ---
 en:
-  report_mailer:
+  user_content_report_mailer:
     report_content:
       authentication: Course URL for LTI authentication.
       prolog: 'The following content has been reported as inappropriate:'
diff --git a/spec/mailers/previews/report_mailer_preview.rb b/spec/mailers/previews/report_mailer_preview.rb
@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-class ReportMailerPreview < ActionMailer::Preview
+class UserContentReportMailerPreview < ActionMailer::Preview
   def report
     rfc = FactoryBot.build_stubbed(:rfc)
 
-    ReportMailer.with(reported_content: rfc).report_content
+    UserContentReportMailer.with(reported_content: rfc).report_content
   end
 end
diff --git a/spec/mailers/user_content_report_mailer_spec.rb b/spec/mailers/user_content_report_mailer_spec.rb
@@ -2,7 +2,7 @@
 
 require 'rails_helper'
 
-RSpec.describe ReportMailer do
+RSpec.describe UserContentReportMailer do
   describe '#report_content' do
     subject(:mail) { described_class.with(reported_content:).report_content }
 
@@ -12,12 +12,12 @@
     let(:course_url) { 'https://example.com/course/1' }
 
     before do
-      stamp_report = instance_double(SpamReport,
+      user_content_report = instance_double(UserContentReport,
         human_model_name:,
         reported_message:,
         related_request_for_comment: instance_double(RequestForComment),
         course_url:)
-      allow(SpamReport).to receive(:new).with(reported_content:).and_return(stamp_report)
+      allow(UserContentReport).to receive(:new).with(reported_content:).and_return(user_content_report)
     end
 
     it 'sets the correct sender' do
@@ -30,7 +30,7 @@
     end
 
     it 'sets the correct subject' do
-      expect(mail.subject).to eq(I18n.t('report_mailer.report_content.subject', human_model_name:))
+      expect(mail.subject).to eq(I18n.t('user_content_report_mailer.report_content.subject', human_model_name:))
     end
 
     it 'includes the LTI retrun URL for course authentication' do
diff --git a/spec/models/user_content_report_spec.rb b/spec/models/user_content_report_spec.rb
@@ -2,7 +2,7 @@
 
 require 'rails_helper'
 
-RSpec.describe SpamReport do
+RSpec.describe UserContentReport do
   describe '#related_request_for_comment' do
     it 'returns the RfC when the RfC itself is reported' do
       rfc = build_stubbed(:rfc)
diff --git a/spec/request/comments_spec.rb b/spec/request/comments_spec.rb
@@ -13,7 +13,7 @@
 
   it 'sends an email to let admins know about the report' do
     expect { post(report_comment_path(comment)) }
-      .to have_enqueued_mail(ReportMailer, :report_content)
+      .to have_enqueued_mail(UserContentReportMailer, :report_content)
       .with(params: {reported_content: comment}, args: [])
   end
 end
diff --git a/spec/request/request_for_comments_spec.rb b/spec/request/request_for_comments_spec.rb
@@ -13,7 +13,7 @@
 
   it 'sends an email to let admins know about the report' do
     expect { post(report_request_for_comment_path(rfc)) }
-      .to have_enqueued_mail(ReportMailer, :report_content)
+      .to have_enqueued_mail(UserContentReportMailer, :report_content)
       .with(params: {reported_content: rfc}, args: [])
   end
 end
