govspeak 8.4.1 → 8.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fee9ba67d010cc01d04d929c4995d48be18802a9cc263eb766e4fb5dd64ea04
-  data.tar.gz: 62206016e1f736157da903662d696438da0406e497d53c6dc0a2574a0cc3555c
+  metadata.gz: 5a417c917e3816a6dc8f1dd69adb0264a6b89d679fa0fe40342e853913140885
+  data.tar.gz: 666d01ec5fc952dea1a2445aca9a29662b4208b6baf68833610a33487030249a
 SHA512:
-  metadata.gz: 3aacba8ee80a9e26f59042d100d74611aef458e90fcdd9b0f5070eb780f25b19a7c28d549ad147afe0af66c802394b134430d5a0d568c2bfd051ef4e2b3582b2
-  data.tar.gz: 1fd96e90cb895b1e48f5b678ea63258ac092058aadaff415400785be8ed2654b8dda08975e70e9e7beba8ff5d2bd564d90cca41331e3f00b6d0d0803b8e25140
+  metadata.gz: b140b11ff35bc4698a2f0a485556c5992abde565fd9fc1bdea76d2cb9f8494956a2f5038cda47e29e14fa18dad85b0e190f403f4362c76b263c56e248f50bbdf
+  data.tar.gz: 9f4f534254cf22208c8c71016f8b35ca0dc4908a07026ff034857ec4c33b6a192389e4c110d55c0231f54f5aa3b4177e6384f4a9ae22e25d51de80afc8c57e45

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+### 8.5.1
+
+* Rename embed-related code to `content block`
+* Do not attempt to parse embed codes if `content_blocks` option is missing
+
+### 8.5.0
+
+* Support embeds in Govspeak
+
 ## 8.4.1
 * Do not pin version of govuk_publishing_components
 

data/README.md

@@ -608,6 +608,34 @@ will output
 </div>
 ```
 
+### Content blocks
+
+Authors can embed different types of [supported content](https://github.com/alphagov/govspeak/blob/main/lib/govspeak/content_block.rb#L3) created by the Content Block Manager
+
+```
+{{embed:content_block_email_address:d308f561-e5ee-45b5-90b2-3ac36a23fad9}}
+```
+
+with options provided
+
+```
+{
+  content_blocks: [
+    {
+      content_id: "d308f561-e5ee-45b5-90b2-3ac36a23fad9",
+      title: "Government Digital Service",
+      details: { email_address: "test@example.com" },
+    }
+  ]
+}
+```
+
+will output
+
+```html
+<span class="embed_content_block_email_address" id="embed_d308f561-e5ee-45b5-90b2-3ac36a23fad9">test@example.com</span>
+```
+
 ### Button
 
 An accessible way to add button links into content, that can also allow cross domain tracking with [Google Analytics](https://support.google.com/analytics/answer/7372977?hl=en)

data/lib/govspeak/content_block.rb

@@ -0,0 +1,15 @@
+module Govspeak
+  class ContentBlock
+    SUPPORTED_DOCUMENT_TYPES = %w[contact content_block_email_address].freeze
+    UUID_REGEX = /([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})/
+    EMBED_REGEX = /({{embed:(#{SUPPORTED_DOCUMENT_TYPES.join('|')}):#{UUID_REGEX}}})/
+
+    attr_reader :document_type, :content_id, :embed_code
+
+    def initialize(document_type:, content_id:, embed_code:)
+      @document_type = document_type
+      @content_id = content_id
+      @embed_code = embed_code
+    end
+  end
+end

data/lib/govspeak/content_block_extractor.rb

@@ -0,0 +1,17 @@
+module Govspeak
+  class ContentBlockExtractor
+    def initialize(document)
+      @document = document
+    end
+
+    def content_references
+      @content_references ||= @document.scan(ContentBlock::EMBED_REGEX).map { |match|
+        ContentBlock.new(document_type: match[1], content_id: match[2], embed_code: match[0])
+      }.uniq
+    end
+
+    def content_ids
+      @content_ids ||= content_references.map(&:content_id)
+    end
+  end
+end

data/lib/govspeak/presenters/content_block_presenter.rb

@@ -0,0 +1,32 @@
+require "action_view"
+require "htmlentities"
+
+module Govspeak
+  class ContentBlockPresenter
+    include ActionView::Helpers::TagHelper
+
+    attr_reader :embed
+
+    def initialize(embed)
+      @embed = ActiveSupport::HashWithIndifferentAccess.new(embed)
+    end
+
+    def content_id
+      embed[:content_id]
+    end
+
+    def document_type
+      embed[:document_type]
+    end
+
+    def render
+      body = if document_type == "content_block_email_address"
+               embed.dig(:details, :email_address)
+             else
+               embed[:title]
+             end
+
+      content_tag(:span, body, class: "embed embed-#{document_type}", id: "embed_#{content_id}")
+    end
+  end
+end

data/lib/govspeak/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "8.4.1".freeze
+  VERSION = "8.5.1".freeze
 end

data/lib/govspeak.rb

@@ -14,11 +14,14 @@ require "govspeak/structured_header_extractor"
 require "govspeak/html_validator"
 require "govspeak/html_sanitizer"
 require "govspeak/blockquote_extra_quote_remover"
+require "govspeak/content_block_extractor"
+require "govspeak/content_block"
 require "govspeak/post_processor"
 require "govspeak/link_extractor"
 require "govspeak/template_renderer"
 require "govspeak/presenters/attachment_presenter"
 require "govspeak/presenters/contact_presenter"
+require "govspeak/presenters/content_block_presenter"
 require "govspeak/presenters/h_card_presenter"
 require "govspeak/presenters/image_presenter"
 require "govspeak/presenters/attachment_image_presenter"
@@ -37,7 +40,7 @@ module Govspeak
     @extensions = []
 
     attr_accessor :images
-    attr_reader :attachments, :contacts, :links, :locale
+    attr_reader :attachments, :contacts, :links, :locale, :content_blocks
 
     def self.to_html(source, options = {})
       new(source, options).to_html
@@ -57,6 +60,7 @@ module Govspeak
       @attachments = Array.wrap(options.delete(:attachments))
       @links = Array.wrap(options.delete(:links))
       @contacts = Array.wrap(options.delete(:contacts))
+      @content_blocks = Array.wrap(options.delete(:content_blocks))
       @locale = options.fetch(:locale, "en")
       @options = { input: PARSER_CLASS_NAME,
                    sanitize: true,
@@ -255,6 +259,15 @@ module Govspeak
       render_image(AttachmentImagePresenter.new(attachment))
     end
 
+    extension("content blocks", Govspeak::ContentBlock::EMBED_REGEX) do |embed_code, _document_type, content_id|
+      next embed_code if content_blocks.empty?
+
+      embed = content_blocks.detect { |e| e[:content_id] == content_id }
+      next "" unless embed
+
+      ContentBlockPresenter.new(embed).render
+    end
+
     # As of version 1.12.0 of Kramdown the block elements (div & figcaption)
     # inside this html block will have it's < > converted into HTML Entities
     # when ever this code is used inside block level elements.

data/test/content_block_extractor_test.rb

@@ -0,0 +1,59 @@
+require "test_helper"
+
+class ContentBlockExtractorTest < Minitest::Test
+  extend Minitest::Spec::DSL
+
+  describe "ContentBlockExtractor" do
+    subject { Govspeak::ContentBlockExtractor.new(document) }
+
+    describe "when there is no embedded content" do
+      let(:document) { "foo" }
+
+      describe "#content_references" do
+        it "returns an empty array" do
+          assert_equal [], subject.content_references
+        end
+      end
+
+      describe "#content_ids" do
+        it "returns an empty array" do
+          assert_equal [], subject.content_ids
+        end
+      end
+    end
+
+    describe "when there is embedded content" do
+      let(:contact_uuid) { SecureRandom.uuid }
+      let(:content_block_email_address_uuid) { SecureRandom.uuid }
+
+      let(:document) do
+        """
+        {{embed:contact:#{contact_uuid}}}
+        {{embed:content_block_email_address:#{content_block_email_address_uuid}}}
+      """
+      end
+
+      describe "#content_references" do
+        it "returns all references" do
+          result = subject.content_references
+
+          assert_equal 2, result.count
+
+          assert_equal "contact", result[0].document_type
+          assert_equal contact_uuid, result[0].content_id
+          assert_equal "{{embed:contact:#{contact_uuid}}}", result[0].embed_code
+
+          assert_equal "content_block_email_address", result[1].document_type
+          assert_equal content_block_email_address_uuid, result[1].content_id
+          assert_equal "{{embed:content_block_email_address:#{content_block_email_address_uuid}}}", result[1].embed_code
+        end
+      end
+
+      describe "#content_ids" do
+        it "returns all uuids as an array" do
+          assert_equal [contact_uuid, content_block_email_address_uuid], subject.content_ids
+        end
+      end
+    end
+  end
+end

data/test/govspeak_content_blocks_test.rb

@@ -0,0 +1,98 @@
+require "test_helper"
+
+class GovspeakContentBlocksTest < Minitest::Test
+  extend Minitest::Spec::DSL
+
+  def compress_html(html)
+    html.gsub(/[\n\r]+\s*/, "")
+  end
+
+  let(:content_id) { SecureRandom.uuid }
+
+  it "renders an email address when present in options[:embeds]" do
+    content_block = {
+      content_id:,
+      document_type: "content_block_email_address",
+      title: "foo",
+      details: {
+        email_address: "foo@example.com",
+      },
+    }
+    govspeak = "{{embed:content_block_email_address:#{content_id}}}"
+
+    rendered = Govspeak::Document.new(govspeak, content_blocks: [content_block]).to_html
+
+    expected = "<p><span class=\"embed embed-content_block_email_address\" id=\"embed_#{content_id}\">#{content_block[:details][:email_address]}</span></p>"
+
+    assert_equal compress_html(expected), compress_html(rendered)
+  end
+
+  it "renders the title when the document type is a contact" do
+    content_block = {
+      content_id:,
+      document_type: "contact",
+      title: "foo",
+    }
+    govspeak = "{{embed:contact:#{content_id}}}"
+
+    rendered = Govspeak::Document.new(govspeak, content_blocks: [content_block]).to_html
+
+    expected = "<p><span class=\"embed embed-contact\" id=\"embed_#{content_id}\">#{content_block[:title]}</span></p>"
+
+    assert_equal compress_html(expected), compress_html(rendered)
+  end
+
+  it "removes embed code if a content block cannot be found" do
+    content_block = {
+      content_id: SecureRandom.uuid,
+      document_type: "contact",
+      title: "foo",
+    }
+
+    govspeak = "{{embed:contact:#{content_id}}}"
+
+    rendered = Govspeak::Document.new(govspeak, content_blocks: [content_block]).to_html
+
+    assert_equal compress_html(""), compress_html(rendered)
+  end
+
+  it "retains an embed code if content_blocks are not specified" do
+    govspeak = "{{embed:contact:#{content_id}}}"
+
+    rendered = Govspeak::Document.new(govspeak).to_html
+
+    assert_equal compress_html("<p>#{govspeak}</p>"), compress_html(rendered)
+  end
+
+  it "supports multiple embeds" do
+    content_blocks = [
+      {
+        content_id: SecureRandom.uuid,
+        document_type: "contact",
+        title: "foo",
+      },
+      {
+        content_id: SecureRandom.uuid,
+        document_type: "content_block_email_address",
+        title: "foo",
+        details: {
+          email_address: "foo@example.com",
+        },
+      },
+    ]
+
+    govspeak = %(Here is a contact: {{embed:contact:#{content_blocks[0][:content_id]}}}
+
+Here is an email address: {{embed:content_block_email_address:#{content_blocks[1][:content_id]}}}
+    )
+
+    rendered = Govspeak::Document.new(govspeak, content_blocks:).to_html
+
+    expected = """
+      <p>Here is a contact: <span class=\"embed embed-contact\" id=\"embed_#{content_blocks[0][:content_id]}\">#{content_blocks[0][:title]}</span></p>
+      <p>Here is an email address: <span class=\"embed embed-content_block_email_address\" id=\"embed_#{content_blocks[1][:content_id]}\">#{content_blocks[1][:details][:email_address]}</span></p>
+    """
+
+    assert_equal compress_html(expected), compress_html(rendered)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 8.4.1
+  version: 8.5.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-10 00:00:00.000000000 Z
+date: 2024-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -250,6 +250,8 @@ files:
 - config/address_formats.yml
 - lib/govspeak.rb
 - lib/govspeak/blockquote_extra_quote_remover.rb
+- lib/govspeak/content_block.rb
+- lib/govspeak/content_block_extractor.rb
 - lib/govspeak/header_extractor.rb
 - lib/govspeak/html_sanitizer.rb
 - lib/govspeak/html_validator.rb
@@ -258,6 +260,7 @@ files:
 - lib/govspeak/presenters/attachment_image_presenter.rb
 - lib/govspeak/presenters/attachment_presenter.rb
 - lib/govspeak/presenters/contact_presenter.rb
+- lib/govspeak/presenters/content_block_presenter.rb
 - lib/govspeak/presenters/h_card_presenter.rb
 - lib/govspeak/presenters/image_presenter.rb
 - lib/govspeak/structured_header_extractor.rb
@@ -306,12 +309,14 @@ files:
 - locales/zh-tw.yml
 - locales/zh.yml
 - test/blockquote_extra_quote_remover_test.rb
+- test/content_block_extractor_test.rb
 - test/govspeak_attachment_link_test.rb
 - test/govspeak_attachment_test.rb
 - test/govspeak_attachments_image_test.rb
 - test/govspeak_attachments_inline_test.rb
 - test/govspeak_button_test.rb
 - test/govspeak_contacts_test.rb
+- test/govspeak_content_blocks_test.rb
 - test/govspeak_extract_contact_content_ids_test.rb
 - test/govspeak_footnote_test.rb
 - test/govspeak_images_bang_test.rb
@@ -344,18 +349,20 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.21
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
 summary: Markup language for single domain
 test_files:
 - test/blockquote_extra_quote_remover_test.rb
+- test/content_block_extractor_test.rb
 - test/govspeak_attachment_link_test.rb
 - test/govspeak_attachment_test.rb
 - test/govspeak_attachments_image_test.rb
 - test/govspeak_attachments_inline_test.rb
 - test/govspeak_button_test.rb
 - test/govspeak_contacts_test.rb
+- test/govspeak_content_blocks_test.rb
 - test/govspeak_extract_contact_content_ids_test.rb
 - test/govspeak_footnote_test.rb
 - test/govspeak_images_bang_test.rb