Merge pull request #2600 from alphagov/support-multilingual-markdown-fields

Support multilingual markdown fields

Author: DavidBiddle

Gemfile

@@ -49,7 +49,7 @@ gem "govuk_design_system_formbuilder"
 gem "dfe-autocomplete", require: "dfe/autocomplete", github: "DFE-Digital/dfe-autocomplete", ref: "1d4cc65039e11cc3ba9e7217a719b8128d0e4d53"
 
 # Our own custom markdown renderer
-gem "govuk-forms-markdown", require: "govuk_forms_markdown", github: "alphagov/govuk-forms-markdown", tag: "0.7.0"
+gem "govuk-forms-markdown", require: "govuk_forms_markdown", github: "alphagov/govuk-forms-markdown", tag: "0.8.0"
 
 # For structured logging
 gem "lograge"

Gemfile.lock

@@ -12,10 +12,10 @@ GIT
 
 GIT
   remote: https://github.com/alphagov/govuk-forms-markdown.git
-  revision: bfc72c960427b6393ba2eacac95111b5122fc0aa
-  tag: 0.7.0
+  revision: 62bcbf4390aa4998390c1390debcbf250aa90ec0
+  tag: 0.8.0
   specs:
-    govuk-forms-markdown (0.7.0)
+    govuk-forms-markdown (0.8.0)
       redcarpet (~> 3.6)
 
 GEM
@@ -720,7 +720,7 @@ CHECKSUMS
   gds-sso (22.1.1) sha256=87da38284fe2eb98cca4f02d5f23bc01bbad7eeabe10a3c60d915628968d9122
   globalid (1.3.0) sha256=05c639ad6eb4594522a0b07983022f04aa7254626ab69445a0e493aa3786ff11
   govuk-components (5.13.1) sha256=74808d8188a7de2c5e83e5a829c5f8ac3851df27f82410a4a2444cf53c24cfe5
-  govuk-forms-markdown (0.7.0)
+  govuk-forms-markdown (0.8.0)
   govuk_design_system_formbuilder (5.13.0) sha256=126ff4af70b36f06395e8f4f09d399944bcc10e9a41c2ff7d7773e81e92ca885
   govuk_notify_rails (3.0.0) sha256=e0e1b8b0a7c47f90963034f290fb2982652aa8051a733c25c178680d44f2d7aa
   hashdiff (1.2.1) sha256=9c079dbc513dfc8833ab59c0c2d8f230fa28499cc5efb4b8dd276cf931457cd1

app/controllers/forms/welsh_translation_controller.rb

@@ -65,7 +65,7 @@ def render_preview
     def preview_html
       return t("guidance.no_guidance_added_html") if params[:markdown].blank?
 
-      GovukFormsMarkdown.render(params[:markdown])
+      GovukFormsMarkdown.render(params[:markdown], locale: "cy")
     end
 
     def welsh_enabled?

app/controllers/forms/what_happens_next_controller.rb

@@ -46,7 +46,7 @@ def what_happens_next_input_params
     def preview_html(what_happens_next_input)
       return t("guidance.no_guidance_added_html") if what_happens_next_input.what_happens_next_markdown.blank?
 
-      GovukFormsMarkdown.render(what_happens_next_input.what_happens_next_markdown, allow_headings: false)
+      GovukFormsMarkdown.render(what_happens_next_input.what_happens_next_markdown, allow_headings: false, locale: "en")
     end
   end
 end

app/controllers/pages/exit_page_controller.rb

@@ -100,6 +100,6 @@ def ensure_answer_value_present
   def preview_html(exit_page_input_object)
     return t("exit_page.no_content_added_html") if exit_page_input_object.exit_page_markdown.blank?
 
-    GovukFormsMarkdown.render(exit_page_input_object.exit_page_markdown)
+    GovukFormsMarkdown.render(exit_page_input_object.exit_page_markdown, locale: "en")
   end
 end

app/controllers/pages/guidance_controller.rb

@@ -68,7 +68,7 @@ def route_to
   def preview_html(guidance_input)
     return t("guidance.no_guidance_added_html") if guidance_input.guidance_markdown.blank?
 
-    GovukFormsMarkdown.render(guidance_input.guidance_markdown)
+    GovukFormsMarkdown.render(guidance_input.guidance_markdown, locale: "en")
   end
 
   def view_locals(current_page, guidance_input, back_link)

app/views/forms/_made_live_form.html.erb

@@ -95,10 +95,10 @@
           <%= table.with_body do |body|
             body.with_row do |row|
               row.with_cell do
-                GovukFormsMarkdown.render(form_document.what_happens_next_markdown).html_safe
+                GovukFormsMarkdown.render(form_document.what_happens_next_markdown, locale: "en").html_safe
               end
               row.with_cell do
-                GovukFormsMarkdown.render(welsh_form_document.what_happens_next_markdown).html_safe
+                GovukFormsMarkdown.render(welsh_form_document.what_happens_next_markdown, locale: "cy").html_safe
               end
             end
           end %>
@@ -108,7 +108,7 @@
     <% else %>
       <h3 class="govuk-heading-m"><%= t('.what_happens_next') %></h3>
       <div class="app-preview-area">
-        <%= GovukFormsMarkdown.render(form_document.what_happens_next_markdown).html_safe %>
+        <%= GovukFormsMarkdown.render(form_document.what_happens_next_markdown, locale: "en").html_safe %>
       </div>
       <%= govuk_details(summary_text: t('.what_is_what_happens_next'), text: t('.what_happens_next_description')) %>
     <% end %>

db/seeds.rb

@@ -454,8 +454,8 @@
     support_email_cy: "welsh-your.email+fakedata84701@gmail.com.gov.uk",
     support_phone: "08000800",
     support_phone_cy: "welsh 08000800",
-    what_happens_next_markdown: "Test",
-    what_happens_next_markdown_cy: "Prawf",
+    what_happens_next_markdown: "If you have not received a response within 5 working days, [contact our user support team](https://example.com).",
+    what_happens_next_markdown_cy: "Os nad ydych wedi derbyn ymateb o fewn 5 diwrnod gwaith, [cysylltwch â'n tîm cymorth defnyddwyr](https://example.com).",
     share_preview_completed: true,
     available_languages: %w[en cy],
     welsh_completed: true,

spec/requests/forms/welsh_translation_controller_spec.rb

@@ -22,11 +22,8 @@
       get welsh_translation_path(id)
     end
 
-    it "returns 200" do
-      expect(response).to have_http_status(:ok)
-    end
-
     it "renders the template" do
+      expect(response).to have_http_status(:ok)
       expect(response).to render_template(:new)
     end
 
@@ -54,31 +51,17 @@
     let(:params) { { forms_welsh_translation_input: { form:, mark_complete:, name_cy: "Gwneud cais am drwydded jyglo", privacy_policy_url_cy: "https://juggling.gov.uk/privacy_policy/cy", page_translations_attributes: } } }
 
     context "when 'Yes' is selected" do
-      it "updates the form" do
+      it "updates the form, pages and conditions" do
         expect {
           post(welsh_translation_create_path(id), params:)
         }.to change { form.reload.welsh_completed }.to(true)
+        .and change { form.pages.first.reload.question_text_cy }.to("Ydych chi'n adnewyddu trwydded?")
+        .and change { condition.reload.exit_page_heading_cy }.to("Nid ydych yn gymwys")
       end
 
-      it "updates the form's pages" do
-        expect {
-          post(welsh_translation_create_path(id), params:)
-        }.to change { form.pages.first.reload.question_text_cy }.to("Ydych chi'n adnewyddu trwydded?")
-      end
-
-      it "updates the form's conditions" do
-        expect {
-          post(welsh_translation_create_path(id), params:)
-        }.to change { condition.reload.exit_page_heading_cy }.to("Nid ydych yn gymwys")
-      end
-
-      it "redirects to the form" do
+      it "redirects to the form task list and displays a success banner including text about being marked complete" do
         post(welsh_translation_create_path(id), params:)
         expect(response).to redirect_to(form_path(id))
-      end
-
-      it "displays a success banner including text about being marked complete" do
-        post(welsh_translation_create_path(id), params:)
         expect(flash[:success]).to eq(I18n.t("banner.success.form.welsh_translation_saved_and_completed"))
       end
     end
@@ -87,80 +70,49 @@
       let(:mark_complete) { "false" }
       let(:form) { create(:form, :ready_for_routing, welsh_completed: true) }
 
-      it "updates the form" do
+      it "updates the form and redirects to the form task list" do
         expect {
           post(welsh_translation_create_path(id), params:)
         }.to change { form.reload.welsh_completed }.to(false)
       end
 
-      it "redirects to the form" do
+      it "redirects to the form and displays a success banner without text about being marked complete" do
         post(welsh_translation_create_path(id), params:)
         expect(response).to redirect_to(form_path(id))
-      end
-
-      it "displays a success banner without text about being marked complete" do
-        post(welsh_translation_create_path(id), params:)
         expect(flash[:success]).to eq(I18n.t("banner.success.form.welsh_translation_saved"))
       end
     end
 
     context "when no value is selected" do
       let(:mark_complete) { "" }
 
-      it "does not update the form" do
-        expect {
-          post(welsh_translation_create_path(id), params:)
-        }.not_to(change { form.reload.welsh_completed })
-      end
-
-      it "does not update the form's pages" do
+      it "does not update the form, pages or conditions" do
         expect {
           post(welsh_translation_create_path(id), params:)
-        }.not_to(change { form.pages.first.reload.question_text_cy })
+        }.to not_change { form.reload.welsh_completed }
+        .and not_change { form.pages.first.reload.question_text_cy }
+        .and(not_change { condition.reload.exit_page_markdown_cy })
       end
 
-      it "does not update the form's conditions" do
-        expect {
-          post(welsh_translation_create_path(id), params:)
-        }.not_to(change { condition.reload.exit_page_markdown_cy })
-      end
-
-      it "returns a 422" do
+      it "returns a 422, re-renders the page with an error, and does not display a success banner" do
         post(welsh_translation_create_path(id), params:)
-        expect(response).to have_http_status(:unprocessable_content)
-      end
 
-      it "re-renders the page with an error" do
-        post(welsh_translation_create_path(id), params:)
+        expect(response).to have_http_status(:unprocessable_content)
         expect(response).to render_template(:new)
         expect(response.body).to include(I18n.t("activemodel.errors.models.forms/welsh_translation_input.attributes.mark_complete.blank"))
-      end
-
-      it "does not display a success banner" do
-        post(welsh_translation_create_path(id), params:)
         expect(flash).to be_empty
       end
     end
 
     context "when the user is not authorized" do
       let(:current_user) { build :user }
 
-      it "does not update the form" do
-        expect {
-          post(welsh_translation_create_path(id), params:)
-        }.not_to(change { form.reload.welsh_completed })
-      end
-
-      it "does not update the form's pages" do
-        expect {
-          post(welsh_translation_create_path(id), params:)
-        }.not_to(change { form.pages.first.reload.question_text_cy })
-      end
-
-      it "does not update the form's conditions" do
+      it "does not update the form, pages or conditions" do
         expect {
           post(welsh_translation_create_path(id), params:)
-        }.not_to(change { condition.reload.exit_page_heading_cy })
+        }.to not_change { form.reload.welsh_completed }
+        .and not_change { form.pages.first.reload.question_text_cy }
+        .and(not_change { condition.reload.exit_page_markdown_cy })
       end
 
       it "returns 403" do
@@ -172,22 +124,12 @@
     context "when the welsh feature is not enabled for the group" do
       let(:welsh_enabled) { false }
 
-      it "does not update the form" do
-        expect {
-          post(welsh_translation_create_path(id), params:)
-        }.not_to(change { form.reload.welsh_completed })
-      end
-
-      it "does not update the form's pages" do
+      it "does not update the form, pages or conditions" do
         expect {
           post(welsh_translation_create_path(id), params:)
-        }.not_to(change { form.pages.first.reload.question_text_cy })
-      end
-
-      it "does not update the form's conditions" do
-        expect {
-          post(welsh_translation_create_path(id), params:)
-        }.not_to(change { condition.reload.exit_page_heading_cy })
+        }.to not_change { form.reload.welsh_completed }
+        .and not_change { form.pages.first.reload.question_text_cy }
+        .and(not_change { condition.reload.exit_page_markdown_cy })
       end
 
       it "redirects to the form" do
@@ -306,4 +248,29 @@
       end
     end
   end
+
+  describe "#render_preview" do
+    let(:markdown) { "[Markdown](https://example.com)" }
+
+    before do
+      post welsh_translation_render_preview_path(form_id: form.id), params: { markdown: }
+    end
+
+    it "returns a JSON object containing the converted HTML" do
+      expect(response).to have_http_status(:ok)
+      expect(response.body).to eq({
+        preview_html: "<p class=\"govuk-body\"><a href=\"https://example.com\" class=\"govuk-link\" rel=\"noreferrer noopener\" target=\"_blank\">Markdown (agor mewn tab newydd)</a></p>",
+        errors: [],
+      }.to_json)
+    end
+
+    context "when markdown is blank" do
+      let(:markdown) { "" }
+
+      it "returns a JSON object containing the converted HTML" do
+        expect(response).to have_http_status(:ok)
+        expect(response.body).to eq({ preview_html: I18n.t("guidance.no_guidance_added_html"), errors: [] }.to_json)
+      end
+    end
+  end
 end