Add rich text field to school profile

Author: richardpattinson

app/models/organisation.rb

@@ -6,6 +6,8 @@ class Organisation < ApplicationRecord
   include PgSearch::Model
   extend FriendlyId
 
+  has_rich_text :description
+
   SPECIAL_SCHOOL_TYPES = ["Community special school", "Foundation special school", "Non-maintained special school", "Academy special converter", "Academy special sponsor led", "Free schools special"].freeze
   NON_FAITH_RELIGIOUS_CHARACTER_TYPES = ["", "None", "Does not apply", "null"].freeze
   OUT_OF_SCOPE_DETAILED_SCHOOL_TYPES = ["Further education", "Other independent school", "Miscellaneous", "Special post 16 institution", "Other independent special school", "Higher education institutions", "Welsh establishment"].freeze
@@ -144,7 +146,7 @@ def has_ofsted_report?
   end
 
   def profile_complete?
-    %i[email description safeguarding_information logo photo url].all? { |attribute| send(attribute).present? }
+    %i[email safeguarding_information logo photo url].all? { |attr| send(attr).present? } && description.body.present?
   end
 
   def self.update_all_searchable_content!

app/views/publishers/organisations/_organisation.html.slim

@@ -44,7 +44,7 @@
   - summary_list.with_row(html_attributes: { id: "description" }) do |row|
     - row.with_key text: t("publishers.organisations.organisation.description.label.#{organisation.school? ? :school : :organisation}")
     - row.with_value do
-      = required_profile_info(value: truncate(organisation.description, length: 130), missing_prompt: t("publishers.organisations.organisation.description.missing_prompt.#{organisation.school? ? :school : :organisation}"))
+      = required_profile_info(value: sanitize(organisation.description.to_s), missing_prompt: t("publishers.organisations.organisation.description.missing_prompt.#{organisation.school? ? :school : :organisation}"))
     - row.with_action text: t("buttons.change"), href: edit_publishers_organisation_description_path(organisation), classes: "govuk-link--no-visited-state", visually_hidden_text: t("publishers.organisations.organisation.description.label.#{organisation.school? ? :school : :organisation}")
 
   - summary_list.with_row(html_attributes: { id: "safeguarding_information" }) do |row|

app/views/publishers/organisations/description/edit.html.slim

@@ -12,9 +12,16 @@
   - if params["vacancy_id"]
     = f.hidden_field "vacancy_id", value: params["vacancy_id"]
 
-  = f.govuk_text_area :description,
-    label: { text: t("helpers.label.publishers_organisation_form.description", organisation_type: organisation_type_basic(@organisation)), size: "s" },
-    hint: { text: t("helpers.hint.publishers_organisation_form.description", organisation_type: organisation_type_basic(@organisation)) },
-    rows: 10
+  .govuk-form-group
+    = f.label :description, t("helpers.label.publishers_organisation_form.description", organisation_type: organisation_type_basic(@organisation)), class: "govuk-label govuk-label--s"
+
+    .govuk-hint
+      = t("helpers.hint.publishers_organisation_form.description", organisation_type: organisation_type_basic(@organisation))
+
+    div class="school-description-form"
+      = f.rich_text_area :description, aria: { label: t("helpers.label.publishers_organisation_form.description"), required: true }, class: "govuk-!-margin-bottom-6"
+
+      noscript
+        = f.govuk_text_area :description, rows: 10, class: "govuk-!-margin-bottom-6"
 
   = f.govuk_submit t("buttons.save_changes")

lib/tasks/migrate_school_description_to_rich_text.rake

@@ -0,0 +1,15 @@
+desc "Migrates organisation descriptions from legacy string column to ActionText"
+task migrate_school_description_to_rich_text: :environment do
+  Organisation.find_each do |org|
+    legacy_text = org.read_attribute(:description)
+
+    next if legacy_text.blank? || org.description.present?
+
+    begin
+      org.update!(description: legacy_text)
+    rescue StandardError => e
+      Rails.logger.error "Error migrating Organisation #{org.id}: #{e.message}"
+    end
+  end
+  puts "Migration complete."
+end

spec/lib/tasks/migrate_descriptions_rake_task_spec.rb

@@ -0,0 +1,46 @@
+require "rails_helper"
+
+RSpec.describe "migrate_school_description_to_rich_text" do
+  include_context "rake"
+
+  let!(:school) { create(:school) }
+
+  before do
+    Rake::Task["migrate_school_description_to_rich_text"].reenable
+
+    school.rich_text_description&.destroy!
+    school.update_column(:description, "Legacy text description")
+  end
+
+  # rubocop:disable RSpec/NamedSubject
+  it "migrates the legacy string to ActionText" do
+    expect {
+      subject.invoke
+    }.to change(ActionText::RichText, :count).by(1)
+
+    expect(school.reload.description.to_plain_text).to eq("Legacy text description")
+  end
+
+  it "does not overwrite existing rich text" do
+    school.reload.update!(description: "Modern Rich Text")
+
+    expect {
+      subject.invoke
+    }.not_to change(ActionText::RichText, :count)
+
+    expect(school.reload.description.to_plain_text).to eq("Modern Rich Text")
+  end
+
+  it "logs an error if the migration fails for a specific organisation" do
+    school.reload
+    allow(Organisation).to receive(:find_each).and_yield(school)
+    allow(school).to receive(:update!).and_raise(StandardError, "Database timeout")
+
+    expect(Rails.logger).to receive(:error).with("Error migrating Organisation #{school.id}: Database timeout")
+
+    expect {
+      subject.invoke
+    }.not_to change(ActionText::RichText, :count)
+  end
+  # rubocop:enable RSpec/NamedSubject
+end

spec/system/publishers/publishers_can_manage_a_profile_spec.rb

@@ -110,8 +110,10 @@
           click_link("Change")
         end
 
-        expect(find_field("publishers_organisation_description_form[description]").value).to eq(organisation.description)
+        expected_text = organisation.description.body.to_plain_text
 
+        expect(find_field("publishers_organisation_description_form[description]").value)
+          .to eq("#{expected_text}\n")
         fill_in "publishers_organisation_description_form[description]", with: school_description
         click_on I18n.t("buttons.save_changes")
 
@@ -135,7 +137,10 @@
           click_link("Change")
         end
 
-        expect(find_field("publishers_organisation_description_form[description]").value).to eq(organisation.description)
+        expected_text = organisation.description.body.to_plain_text
+
+        expect(find_field("publishers_organisation_description_form[description]").value)
+          .to eq("#{expected_text}\n")
 
         fill_in "publishers_organisation_description_form[description]", with: new_trust_description
         click_on I18n.t("buttons.save_changes")
@@ -152,7 +157,10 @@
           click_link("Change")
         end
 
-        expect(find_field("publishers_organisation_description_form[description]").value).to eq(school1.description)
+        expected_text = school1.description.body.to_plain_text
+
+        expect(find_field("publishers_organisation_description_form[description]").value)
+          .to eq("#{expected_text}\n")
 
         fill_in "publishers_organisation_description_form[description]", with: new_school_description
         click_on I18n.t("buttons.save_changes")

spec/views/organisations/show.html.slim_spec.rb

@@ -78,7 +78,7 @@
     end
 
     it "displays the organisation's description" do
-      expect(show_view).to have_content(organisation.description)
+      expect(show_view).to have_content(organisation.description.to_plain_text)
     end
 
     it "displays the organisation's safeguarding information" do

spec/views/publishers/organisations/preview.html.slim_spec.rb

@@ -16,7 +16,7 @@
     end
 
     it "displays the organisation's description" do
-      expect(rendered).to have_content(organisation.description)
+      expect(rendered).to have_content(organisation.description.to_plain_text)
     end
 
     it "displays the organisation's safeguarding information" do
@@ -48,7 +48,7 @@
     end
 
     it "displays the organisation's description" do
-      expect(rendered).to have_content(organisation.description)
+      expect(rendered).to have_content(organisation.description.to_plain_text)
     end
 
     it "displays the organisation's safeguarding information" do
@@ -82,7 +82,7 @@
       end
 
       it "displays the organisation's description" do
-        expect(rendered).to have_content(school_one.description)
+        expect(rendered).to have_content(school_one.description.to_plain_text)
       end
 
       it "displays the organisation's safeguarding information" do