govspeak 8.5.0 → 8.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23ac40c67eb46b8265549568542bc48bb0cb96fe47c8b217a1e6135789ab2134
-  data.tar.gz: 26d7a270ab0163d056c0fefff53548727019128456deab21409ee3b3ae6e01eb
+  metadata.gz: bdccda451ed897f8e9dcdc5b845116287f98bb610694119b6726933b7ed333bc
+  data.tar.gz: '01086d9d20ea2b65b35a5f73f59eaf05c20a342709e0cb8e8a7fc3c405848f0b'
 SHA512:
-  metadata.gz: e637261f8a573479a054e8cdcba539ed296c4c9a1d70c263ff4caea059faf80992806332922259da0d52983013a4c302a11bed5421b12534f6d1de6b105d9620
-  data.tar.gz: fa04e11f539f372793d6420f9dcdc81964d244530f3d9e397f0587ca22fac9e66e41b85d79cd224c88f187946bddeb04f9afdfe223328240c353b060bb45fba2
+  metadata.gz: 2b34067b3f5b8959f3df01d930ab18d905b4adbeb054651d1f6b3a4b4e1f995963bc2f5b861c3f638b2f9b63664ea800f1e0f25126daaeefab8d5503baac6e74
+  data.tar.gz: c50604d92a25d02f0a05024d3e35e79fa4c9e7aacd996270d216dd0ccb3c3a284bffdbfae2334c583f410340ea3cf91b865e74a3dc6d79337f3caf74d863623a

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+### 8.6.0
+
+* Remove embed functionality ([#358](https://github.com/alphagov/govspeak/pull/358))
+
+### 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

data/README.md

@@ -608,34 +608,6 @@ will output
 </div>
 ```
 
-### Content blocks
-
-Authors can embed different types of [supported content](https://github.com/alphagov/govspeak/blob/main/lib/govspeak/embedded_content.rb#L3) created by the Content Block Manager
-
-```
-{{embed:content_block_email_address:d308f561-e5ee-45b5-90b2-3ac36a23fad9}}
-```
-
-with options provided
-
-```
-{
-  embeds: [
-    {
-      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/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "8.5.0".freeze
+  VERSION = "8.6.0".freeze
 end

data/lib/govspeak.rb

@@ -14,14 +14,11 @@ require "govspeak/structured_header_extractor"
 require "govspeak/html_validator"
 require "govspeak/html_sanitizer"
 require "govspeak/blockquote_extra_quote_remover"
-require "govspeak/embed_extractor"
-require "govspeak/embedded_content"
 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/embed_presenter"
 require "govspeak/presenters/h_card_presenter"
 require "govspeak/presenters/image_presenter"
 require "govspeak/presenters/attachment_image_presenter"
@@ -40,7 +37,7 @@ module Govspeak
     @extensions = []
 
     attr_accessor :images
-    attr_reader :attachments, :contacts, :links, :locale, :embeds
+    attr_reader :attachments, :contacts, :links, :locale
 
     def self.to_html(source, options = {})
       new(source, options).to_html
@@ -60,7 +57,6 @@ module Govspeak
       @attachments = Array.wrap(options.delete(:attachments))
       @links = Array.wrap(options.delete(:links))
       @contacts = Array.wrap(options.delete(:contacts))
-      @embeds = Array.wrap(options.delete(:embeds))
       @locale = options.fetch(:locale, "en")
       @options = { input: PARSER_CLASS_NAME,
                    sanitize: true,
@@ -259,13 +255,6 @@ module Govspeak
       render_image(AttachmentImagePresenter.new(attachment))
     end
 
-    extension("embeds", Govspeak::EmbeddedContent::EMBED_REGEX) do |_embed_code, _document_type, content_id|
-      embed = embeds.detect { |e| e[:content_id] == content_id }
-      next "" unless embed
-
-      EmbedPresenter.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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 8.5.0
+  version: 8.6.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-21 00:00:00.000000000 Z
+date: 2024-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -250,8 +250,6 @@ files:
 - config/address_formats.yml
 - lib/govspeak.rb
 - lib/govspeak/blockquote_extra_quote_remover.rb
-- lib/govspeak/embed_extractor.rb
-- lib/govspeak/embedded_content.rb
 - lib/govspeak/header_extractor.rb
 - lib/govspeak/html_sanitizer.rb
 - lib/govspeak/html_validator.rb
@@ -260,7 +258,6 @@ files:
 - lib/govspeak/presenters/attachment_image_presenter.rb
 - lib/govspeak/presenters/attachment_presenter.rb
 - lib/govspeak/presenters/contact_presenter.rb
-- lib/govspeak/presenters/embed_presenter.rb
 - lib/govspeak/presenters/h_card_presenter.rb
 - lib/govspeak/presenters/image_presenter.rb
 - lib/govspeak/structured_header_extractor.rb
@@ -309,14 +306,12 @@ files:
 - locales/zh-tw.yml
 - locales/zh.yml
 - test/blockquote_extra_quote_remover_test.rb
-- test/embed_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_embeds_test.rb
 - test/govspeak_extract_contact_content_ids_test.rb
 - test/govspeak_footnote_test.rb
 - test/govspeak_images_bang_test.rb
@@ -355,14 +350,12 @@ specification_version: 4
 summary: Markup language for single domain
 test_files:
 - test/blockquote_extra_quote_remover_test.rb
-- test/embed_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_embeds_test.rb
 - test/govspeak_extract_contact_content_ids_test.rb
 - test/govspeak_footnote_test.rb
 - test/govspeak_images_bang_test.rb

data/lib/govspeak/embed_extractor.rb

@@ -1,17 +0,0 @@
-module Govspeak
-  class EmbedExtractor
-    def initialize(document)
-      @document = document
-    end
-
-    def content_references
-      @content_references ||= @document.scan(EmbeddedContent::EMBED_REGEX).map { |match|
-        EmbeddedContent.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/embedded_content.rb

@@ -1,15 +0,0 @@
-module Govspeak
-  class EmbeddedContent
-    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/presenters/embed_presenter.rb

@@ -1,32 +0,0 @@
-require "action_view"
-require "htmlentities"
-
-module Govspeak
-  class EmbedPresenter
-    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/test/embed_extractor_test.rb

@@ -1,59 +0,0 @@
-require "test_helper"
-
-class EmbedExtractorTest < Minitest::Test
-  extend Minitest::Spec::DSL
-
-  describe "EmbedExtractor" do
-    subject { Govspeak::EmbedExtractor.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_embeds_test.rb

@@ -1,84 +0,0 @@
-require "test_helper"
-
-class GovspeakEmbedsTest < 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
-    embed = {
-      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, embeds: [embed]).to_html
-
-    expected = "<p><span class=\"embed embed-content_block_email_address\" id=\"embed_#{content_id}\">#{embed[: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
-    embed = {
-      content_id:,
-      document_type: "contact",
-      title: "foo",
-    }
-    govspeak = "{{embed:contact:#{content_id}}}"
-
-    rendered = Govspeak::Document.new(govspeak, embeds: [embed]).to_html
-
-    expected = "<p><span class=\"embed embed-contact\" id=\"embed_#{content_id}\">#{embed[:title]}</span></p>"
-
-    assert_equal compress_html(expected), compress_html(rendered)
-  end
-
-  it "ignores missing embeds" do
-    govspeak = "{{embed:contact:#{content_id}}}"
-
-    rendered = Govspeak::Document.new(govspeak, embeds: []).to_html
-
-    assert_equal compress_html(""), compress_html(rendered)
-  end
-
-  it "supports multiple embeds" do
-    embeds = [
-      {
-        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:#{embeds[0][:content_id]}}}
-
-Here is an email address: {{embed:content_block_email_address:#{embeds[1][:content_id]}}}
-    )
-
-    rendered = Govspeak::Document.new(govspeak, embeds:).to_html
-
-    expected = """
-      <p>Here is a contact: <span class=\"embed embed-contact\" id=\"embed_#{embeds[0][:content_id]}\">#{embeds[0][:title]}</span></p>
-      <p>Here is an email address: <span class=\"embed embed-content_block_email_address\" id=\"embed_#{embeds[1][:content_id]}\">#{embeds[1][:details][:email_address]}</span></p>
-    """
-
-    assert_equal compress_html(expected), compress_html(rendered)
-  end
-end