Add warning message for supplemental content

Refs #445
x-govuk · Dec 9, 2023 · 6c4b545 · 6c4b545
1 parent 349383e
commit 6c4b545
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/lib/govuk_design_system_formbuilder/containers/supplemental.rb b/lib/govuk_design_system_formbuilder/containers/supplemental.rb
@@ -10,6 +10,8 @@ def initialize(builder, object_name, attribute_name, content)
       def html
         return if @content.blank?
 
+        Rails.logger.warn("Supplemental content is deprecated and support will soon be removed. See https://github.com/x-govuk/govuk-form-builder/issues/445")
+
         tag.div(id: supplemental_id) { @content }
       end
 

diff --git a/spec/support/shared/shared_block_examples.rb b/spec/support/shared/shared_block_examples.rb
@@ -25,6 +25,15 @@
         with_tag('p', text: block_p)
       end
     end
+
+    describe "deprecation warning message" do
+      before { allow(Rails).to receive_message_chain(:logger, :warn).with(any_args).and_return(true) }
+
+      specify 'logs a deprecation warning' do
+        subject
+        expect(Rails.logger).to have_received(:warn).with(/Supplemental content is deprecated/)
+      end
+    end
   end
 
   context 'when no block is supplied' do