Refactor mailers directory structure (#4128)

Simplification de la hiérarchie de vue des emails

app/controllers/new_administrateur/mail_templates_controller.rb

@@ -8,8 +8,9 @@ module NewAdministrateur
       @service = procedure.service
 
       mail_template = find_mail_template_by_slug(params[:id])
+      @rendered_template = sanitize(mail_template.body)
 
-      render(html: sanitize(mail_template.body), layout: 'mailers/notification')
+      render(template: 'notification_mailer/send_notification', layout: 'mailers/notifications_layout')
     end
 
     private

app/mailers/dossier_mailer.rb

@@ -13,7 +13,7 @@ class DossierMailer < ApplicationMailer
     subject = "Retrouvez votre brouillon pour la démarche « #{dossier.procedure.libelle} »"
 
     mail(to: dossier.user.email, subject: subject) do |format|
-      format.html { render layout: 'mailers/notification' }
+      format.html { render layout: 'mailers/notifications_layout' }
     end
   end
 
@@ -25,7 +25,7 @@ class DossierMailer < ApplicationMailer
     subject = "Nouveau message pour votre dossier nº #{dossier.id} (#{dossier.procedure.libelle})"
 
     mail(to: dossier.user.email, subject: subject) do |format|
-      format.html { render layout: 'mailers/notification' }
+      format.html { render layout: 'mailers/notifications_layout' }
     end
   end
 

app/mailers/notification_mailer.rb

@@ -6,8 +6,12 @@
 # The subject and body of a Notification can be customized by each demarche.
 #
 class NotificationMailer < ApplicationMailer
+  include ActionView::Helpers::SanitizeHelper
+
   helper ServiceHelper
 
+  layout 'mailers/notifications_layout'
+
   def send_dossier_received(dossier)
     send_notification(dossier, dossier.procedure.received_mail_template)
   end
@@ -41,12 +45,9 @@ class NotificationMailer < ApplicationMailer
     @dossier = dossier
     @service = dossier.procedure.service
     @logo_url = attach_logo(dossier.procedure)
+    @rendered_template = sanitize(body)
 
-    mail(subject: subject, to: email) do |format|
+    mail(subject: subject, to: email, template_name: 'send_notification')
-      # rubocop:disable Rails/OutputSafety
-      format.html { render(html: body.html_safe, layout: 'mailers/notification') }
-      # rubocop:enable Rails/OutputSafety
-    end
   end
 
   def create_commentaire_for_notification(dossier, subject, body)

app/models/mails/closed_mail.rb

@@ -12,9 +12,9 @@ module Mails
     def self.default_template_name_for_procedure(procedure)
       attestation_template = procedure.attestation_template
       if attestation_template&.activated?
-        "notification_mailer/closed_mail_with_attestation"
+        "notification_mailer/default_templates/closed_mail_with_attestation"
       else
-        "notification_mailer/closed_mail"
+        "notification_mailer/default_templates/closed_mail"
       end
     end
   end

app/models/mails/initiated_mail.rb

@@ -5,7 +5,7 @@ module Mails
     belongs_to :procedure
 
     SLUG = "initiated_mail"
-    DEFAULT_TEMPLATE_NAME = "notification_mailer/initiated_mail"
+    DEFAULT_TEMPLATE_NAME = "notification_mailer/default_templates/initiated_mail"
     DISPLAYED_NAME = 'Accusé de réception'
     DEFAULT_SUBJECT = 'Votre dossier nº --numéro du dossier-- a bien été reçu (--libellé démarche--)'
     DOSSIER_STATE = Dossier.states.fetch(:en_construction)

app/models/mails/received_mail.rb

@@ -5,7 +5,7 @@ module Mails
     belongs_to :procedure
 
     SLUG = "received_mail"
-    DEFAULT_TEMPLATE_NAME = "notification_mailer/received_mail"
+    DEFAULT_TEMPLATE_NAME = "notification_mailer/default_templates/received_mail"
     DISPLAYED_NAME = 'Accusé de passage en instruction'
     DEFAULT_SUBJECT = 'Votre dossier nº --numéro du dossier-- va être instruit (--libellé démarche--)'
     DOSSIER_STATE = Dossier.states.fetch(:en_instruction)

app/models/mails/refused_mail.rb

@@ -5,7 +5,7 @@ module Mails
     belongs_to :procedure
 
     SLUG = "refused_mail"
-    DEFAULT_TEMPLATE_NAME = "notification_mailer/refused_mail"
+    DEFAULT_TEMPLATE_NAME = "notification_mailer/default_templates/refused_mail"
     DISPLAYED_NAME = 'Accusé de rejet du dossier'
     DEFAULT_SUBJECT = 'Votre dossier nº --numéro du dossier-- a été refusé (--libellé démarche--)'
     DOSSIER_STATE = Dossier.states.fetch(:refuse)

app/models/mails/without_continuation_mail.rb

@@ -5,7 +5,7 @@ module Mails
     belongs_to :procedure
 
     SLUG = "without_continuation"
-    DEFAULT_TEMPLATE_NAME = "notification_mailer/without_continuation_mail"
+    DEFAULT_TEMPLATE_NAME = "notification_mailer/default_templates/without_continuation_mail"
     DISPLAYED_NAME = 'Accusé de classement sans suite'
     DEFAULT_SUBJECT = 'Votre dossier nº --numéro du dossier-- a été classé sans suite (--libellé démarche--)'
     DOSSIER_STATE = Dossier.states.fetch(:sans_suite)

app/views/dossier_mailer/notify_new_answer.html.haml

@@ -1,3 +1,6 @@
+- content_for :procedure_logo do
+  = render 'layouts/mailers/logo', url: @logo_url
+
 %p
   Bonjour,
 
@@ -10,4 +13,7 @@
 
 = round_button('Lire le message', messagerie_dossier_url(@dossier))
 
-= render partial: "layouts/mailers/signature", locals: { service: @service }
+= render 'layouts/mailers/signature', service: @service
+
+- content_for :footer do
+  = render 'layouts/mailers/service_footer', service: @service, dossier: @dossier

app/views/dossier_mailer/notify_new_draft.html.haml

@@ -1,3 +1,6 @@
+- content_for :procedure_logo do
+  = render 'layouts/mailers/logo', url: @logo_url
+
 %p
   Bonjour,
 
@@ -10,4 +13,7 @@
   à l’adresse suivante :
   = link_to dossier_url(@dossier), dossier_url(@dossier), target: '_blank', rel: 'noopener'
 
-= render partial: "layouts/mailers/signature"
+= render 'layouts/mailers/signature'
+
+- content_for :footer do
+  = render 'layouts/mailers/service_footer', service: @service, dossier: @dossier

app/views/layouts/mailers/_logo.html.haml

@@ -0,0 +1,5 @@
+- if url.present?
+  %table{ width: "100%", border: "0", cellspacing: "0", cellpadding: "0" }
+    %tr
+      %td{ align: "center" }
+        = image_tag url, height: "150", style: "display:block; max-height: 150px; max-width: 150px;"

app/views/layouts/mailers/_service_footer.html.haml

@@ -0,0 +1,34 @@
+%strong
+  Merci de ne pas répondre à cet email.
+  - if dossier.present? && dossier.messagerie_available?
+    Pour vous adresser à votre administration, passez directement par la
+    = succeed '.' do
+      = link_to 'messagerie du dossier', messagerie_dossier_url(dossier), target: '_blank', rel: 'noopener'
+
+- if service.present?
+  %table{ width: "100%", border: "0", cellspacing: "0", cellpadding: "0", style: "cursor:auto;color:#55575d;font-family:Helvetica, Arial, sans-serif;font-size:11px;line-height:22px;text-align:left;" }
+    %tr
+      %td{ width: "50%", valign: "top" }
+        %p
+          %strong Cette démarche est gérée par :
+          %br
+          = service.nom
+          %br
+          = service.organisme
+          %br
+          = service.adresse
+      %td{ width: "50%", valign: "top" }
+        %p
+          %strong Poser une question sur votre dossier :
+          %br
+          - if dossier.present? && dossier.messagerie_available?
+            = link_to 'Par la messagerie', messagerie_dossier_url(dossier), target: '_blank', rel: 'noopener'
+          - else
+            Par email :
+            = link_to service.email, "mailto:#{service.email}"
+          %br
+          Par téléphone :
+          = link_to service.telephone, "tel:#{service.telephone}"
+          %br
+          Horaires : #{ formatted_horaires(service.horaires) }
+

app/views/layouts/mailers/notification.html.haml

@@ -1,44 +0,0 @@
-- if @logo_url.present?
-  - content_for :procedure_logo do
-    %table{ width: "100%", border: "0", cellspacing: "0", cellpadding: "0" }
-      %tr
-        %td{ align: "center" }
-          = image_tag @logo_url, height: "150", style: "display:block; max-height: 150px; max-width: 150px;"
-
-- content_for :footer do
-  %strong
-    Merci de ne pas répondre à cet email.
-    - if @dossier.present? && @dossier.messagerie_available?
-      Pour vous adresser à votre administration, passez directement par la
-      = succeed '.' do
-        = link_to 'messagerie du dossier', messagerie_dossier_url(@dossier), target: '_blank', rel: 'noopener'
-
-  - if @service.present?
-    %table{ width: "100%", border: "0", cellspacing: "0", cellpadding: "0", style: "cursor:auto;color:#55575d;font-family:Helvetica, Arial, sans-serif;font-size:11px;line-height:22px;text-align:left;" }
-      %tr
-        %td{ width: "50%", valign: "top" }
-          %p
-            %strong Cette démarche est gérée par :
-            %br
-            = @service.nom
-            %br
-            = @service.organisme
-            %br
-            = @service.adresse
-        %td{ width: "50%", valign: "top" }
-          %p
-            %strong Poser une question sur votre dossier :
-            %br
-            - if @dossier.present? && @dossier.messagerie_available?
-              = link_to 'Par la messagerie', messagerie_dossier_url(@dossier), target: '_blank', rel: 'noopener'
-            - else
-              Par email :
-              = link_to @service.email, "mailto:#{@service.email}"
-            %br
-            Par téléphone :
-            = link_to @service.telephone, "tel:#{@service.telephone}"
-            %br
-            Horaires : #{ formatted_horaires(@service.horaires) }
-
-
-= render template: 'layouts/mailers/notifications_layout'

app/views/notification_mailer/default_templates/closed_mail.html.haml

@@ -7,4 +7,4 @@
 %p
   À tout moment, vous pouvez consulter votre dossier et les éventuels messages de l'administration à cette adresse : --lien dossier--
 
-= render partial: "notification_mailer/signature"
+= render partial: "notification_mailer/default_templates/signature"

app/views/notification_mailer/default_templates/closed_mail_with_attestation.html.haml

@@ -10,4 +10,4 @@
 %p
   À tout moment, vous pouvez consulter votre dossier et les éventuels messages de l'administration à cette adresse : --lien dossier--
 
-= render partial: "notification_mailer/signature"
+= render partial: "notification_mailer/default_templates/signature"

app/views/notification_mailer/default_templates/initiated_mail.html.haml

@@ -7,4 +7,4 @@
 %p
   À tout moment, vous pouvez consulter votre dossier et les éventuels messages de l'administration à cette adresse : --lien dossier--
 
-= render partial: "notification_mailer/signature"
+= render partial: "notification_mailer/default_templates/signature"

app/views/notification_mailer/default_templates/received_mail.html.haml

@@ -4,4 +4,4 @@
 %p
   Votre administration vous confirme la bonne réception de votre dossier nº --numéro du dossier--. Celui-ci sera instruit dans le délai légal déclaré par votre interlocuteur.
 
-= render partial: "notification_mailer/signature"
+= render partial: "notification_mailer/default_templates/signature"

app/views/notification_mailer/default_templates/refused_mail.html.haml

@@ -10,4 +10,4 @@
 %p
   Pour en savoir plus sur le motif du refus, vous pouvez consulter votre dossier et les éventuels messages de l'administration à cette adresse : --lien dossier--
 
-= render partial: "notification_mailer/signature"
+= render partial: "notification_mailer/default_templates/signature"

app/views/notification_mailer/default_templates/without_continuation_mail.html.haml

@@ -10,4 +10,4 @@
 %p
   Pour en savoir plus sur les raisons de ce classement sans suite, vous pouvez consulter votre dossier et les éventuels messages de l'administration à cette adresse : --lien dossier--
 
-= render partial: "notification_mailer/signature"
+= render partial: "notification_mailer/default_templates/signature"

app/views/notification_mailer/send_notification.html.haml

@@ -0,0 +1,7 @@
+- content_for :procedure_logo do
+  = render 'layouts/mailers/logo', url: @logo_url
+
+= @rendered_template
+
+- content_for :footer do
+  = render 'layouts/mailers/service_footer', service: @service, dossier: @dossier

spec/mailers/dossier_mailer_spec.rb

@@ -3,6 +3,12 @@ require "rails_helper"
 RSpec.describe DossierMailer, type: :mailer do
   let(:to_email) { 'gestionnaire@exemple.gouv.fr' }
 
+  shared_examples 'a dossier notification' do
+    it 'includes the contact informations in the footer' do
+      expect(subject.body).to include('ne pas répondre')
+    end
+  end
+
   describe '.notify_new_draft' do
     let(:dossier) { create(:dossier, procedure: build(:simple_procedure)) }
 
@@ -12,6 +18,8 @@ RSpec.describe DossierMailer, type: :mailer do
     it { expect(subject.subject).to include(dossier.procedure.libelle) }
     it { expect(subject.body).to include(dossier.procedure.libelle) }
     it { expect(subject.body).to include(dossier_url(dossier)) }
+
+    it_behaves_like 'a dossier notification'
   end
 
   describe '.notify_new_answer' do
@@ -22,6 +30,8 @@ RSpec.describe DossierMailer, type: :mailer do
     it { expect(subject.subject).to include("Nouveau message") }
     it { expect(subject.subject).to include(dossier.id.to_s) }
     it { expect(subject.body).to include(messagerie_dossier_url(dossier)) }
+
+    it_behaves_like 'a dossier notification'
   end
 
   describe '.notify_deletion_to_user' do

spec/mailers/notification_mailer_spec.rb

@@ -1,58 +1,55 @@
 require "spec_helper"
 
 RSpec.describe NotificationMailer, type: :mailer do
-  shared_examples_for "create a commentaire not notified" do
-    it do
-      expect { subject.deliver_now }.to change { Commentaire.count }.by(1)
-
-      subject.deliver_now
-      commentaire = Commentaire.last
-      expect(commentaire.body).to include(email_template.subject_for_dossier(dossier), email_template.body_for_dossier(dossier))
-      expect(commentaire.dossier).to eq(dossier)
-    end
-  end
-
   let(:user) { create(:user) }
-  let(:dossier) { create(:dossier, :with_service, :en_construction, user: user) }
+  let(:procedure) { create(:simple_procedure) }
-
+  let(:dossier) { create(:dossier, :en_construction, :for_individual, :with_service, user: user, procedure: procedure) }
-  describe '.send_notification' do
-    let(:email_template) { instance_double('email_template', subject_for_dossier: 'subject', body_for_dossier: 'body') }
-
-    subject(:mail) do
-      klass = Class.new(described_class) do
-        # We’re testing the (private) method `NotificationMailer#send_notification`.
-        #
-        # The standard trick to test a private method would be to `send(:send_notification)`, but doesn’t work here,
-        # because ActionMailer does some magic to expose public instance methods as class methods.
-        # So, we use inheritance instead to make the private method public for testing purposes.
-        def send_notification(dossier, template)
-          super
-        end
-      end
-      klass.send_notification(dossier, email_template)
-    end
-
-    it { expect(mail.subject).to eq(email_template.subject_for_dossier) }
-    it { expect(mail.body).to include(email_template.body_for_dossier) }
-    it { expect(mail.body).to have_link('messagerie') }
-
-    it_behaves_like "create a commentaire not notified"
-  end
 
   describe '.send_dossier_received' do
-    subject(:mail) { described_class.send_dossier_received(dossier) }
+    let(:email_template) { create(:received_mail, subject: 'Email subject', body: 'Your dossier was processed. Thanks.') }
-    let(:email_template) { create(:received_mail) }
 
     before do
       dossier.procedure.received_mail = email_template
     end
 
-    it do
+    subject(:mail) { described_class.send_dossier_received(dossier) }
-      expect(mail.subject).to eq(email_template.subject)
+
-      expect(mail.body).to include(email_template.body)
+    it 'creates a commentaire in the messagerie' do
+      expect { subject.deliver_now }.to change { Commentaire.count }.by(1)
+
+      commentaire = Commentaire.last
+      expect(commentaire.body).to include(email_template.subject_for_dossier(dossier), email_template.body_for_dossier(dossier))
+      expect(commentaire.dossier).to eq(dossier)
+    end
+
+    it 'renders the template' do
+      expect(mail.subject).to eq('Email subject')
+      expect(mail.body).to include('Your dossier was processed')
       expect(mail.body).to have_link('messagerie')
     end
 
-    it_behaves_like "create a commentaire not notified"
+    context 'when the template body contains tags' do
+      let(:email_template) { create(:received_mail, subject: 'Email subject', body: 'Hello --nom--, your dossier --lien dossier-- was processed.') }
+
+      it 'replaces value tags with the proper value' do
+        expect(mail.body).to have_content(dossier.individual.nom)
+      end
+
+      it 'replaces link tags with a clickable link' do
+        expect(mail.body).to have_link(dossier_url(dossier))
+      end
+    end
+
+    context 'when the template body contains HTML' do
+      let(:email_template) { create(:received_mail, body: 'Your <b>dossier</b> was processed. <iframe src="#">Foo</iframe>') }
+
+      it 'allows basic formatting tags' do
+        expect(mail.body).to include('<b>dossier</b>')
+      end
+
+      it 'sanitizes sensitive content' do
+        expect(mail.body).not_to include('iframe')
+      end
+    end
   end
 end