content_block_tools 0.4.6 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e547141a41ea1ed3c613e2ba8a8282fefd49f84ab64e2339c60a0f2d7acb2146
-  data.tar.gz: 88018c79e26b77f59f9d154a4cd575763ac4f245a68b87631d96bfb4ac746263
+  metadata.gz: a8de300ea972686e97b1fcbe422979f9a3876060ae7e69d575b8270e65c0c509
+  data.tar.gz: 4db995f515fdbcb10c22695f03e74ba7d0d5c2f037b9870c52e274a54bee7674
 SHA512:
-  metadata.gz: 79c0c6daa97869493fa5a82d79378ead1347ece9705f55d8cf8403234cfb153e615941f99d9964c07956e47999a48532b9d9fe5d57335b64ace4f28d2cf9d6b1
-  data.tar.gz: e577a337138cf151795aa95d1d3f6e1a0ba30ba896e475f68e94adaf985351ec2967e7609b53e40992a59ff56b1f0548135587e01037ede80a04a418191d178f
+  metadata.gz: c74f391d6df0c5feee05dfbfafdb59576a99226029252c849a8a5714b44ea87a09fc54b4583e0de5424ccb9dfcc131d02c8477b309c3230c9536e8cb09e191df
+  data.tar.gz: b24e0e97e96edd7791cf586282c740feb13a2832a0d1c59234f93539e2b8b652851a387675a147703ac10ca041120c0ac150af803dad49e7cc6a1dcac5fc3dcc

data/CHANGELOG.md

@@ -7,6 +7,15 @@
   useful summary for people upgrading their application, not a replication
   of the commit log.
 
+## 0.5.1
+
+- Update dependencies
+- Create a presenter for Contact Blocks ([30](https://github.com/alphagov/govuk_content_block_tools/pull/30))
+
+## 0.5.0
+
+- Support Content ID aliases ([27](https://github.com/alphagov/govuk_content_block_tools/pull/27))
+
 ## 0.4.6
 - Remove noisy log ([25](https://github.com/alphagov/govuk_content_block_tools/pull/25))
 

data/content_block_tools.gemspec

@@ -27,7 +27,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "rake", "13.2.1"
   spec.add_development_dependency "rspec", "3.13.0"
-  spec.add_development_dependency "rubocop-govuk", "5.0.3"
+  spec.add_development_dependency "rspec-html-matchers", "0.10.0"
+  spec.add_development_dependency "rubocop-govuk", "5.1.6"
 
   spec.add_dependency "actionview", ">= 6"
 end

data/lib/content_block_tools/content_block.rb

@@ -36,13 +36,14 @@ module ContentBlockTools
   #
   # @!attribute [r] embed_code
   #  The embed_code used for a block containing optional field name
-  #   @example
-  #     content_block_reference.embed_code #=> "{{embed:content_block_email_address:2b92cade-549c-4449-9796-e7a3957f3a86}}"
-  #     content_block_reference.embed_code #=> "{{embed:content_block_postal_address:2b92cade-549c-4449-9796-e7a3957f3a86/field_name}}"
-  #   @return [String]
+  #  @example
+  #    content_block_reference.embed_code #=> "{{embed:content_block_email_address:2b92cade-549c-4449-9796-e7a3957f3a86}}"
+  #    content_block_reference.embed_code #=> "{{embed:content_block_postal_address:2b92cade-549c-4449-9796-e7a3957f3a86/field_name}}"
+  #  @return [String]
   class ContentBlock < Data
     # A lookup of presenters for particular content block types
     CONTENT_PRESENTERS = {
+      "content_block_contact" => ContentBlockTools::Presenters::ContactPresenter,
       "content_block_email_address" => ContentBlockTools::Presenters::EmailAddressPresenter,
       "content_block_postal_address" => ContentBlockTools::Presenters::PostalAddressPresenter,
       "content_block_pension" => ContentBlockTools::Presenters::PensionPresenter,

data/lib/content_block_tools/content_block_reference.rb

@@ -1,5 +1,5 @@
 module ContentBlockTools
-  ContentBlockReference = Data.define(:document_type, :content_id, :embed_code)
+  ContentBlockReference = Data.define(:document_type, :identifier, :embed_code)
 
   # Defines a reference pointer for a Content Block
   #
@@ -13,10 +13,12 @@ module ContentBlockTools
   #   @return [String] the document type
   #   @api public
   #
-  # @!attribute [r] content_id
-  #   The content UUID for a block
+  # @!attribute [r] identifier
+  #   The identifier for a block - can be a UUID or a slug. The UUID will refer to the `content_id` of a block
+  #   within Publishing API, while the slug will refer to a block's Content ID alias.
   #   @example
-  #     content_block_reference.id #=> "2b92cade-549c-4449-9796-e7a3957f3a86"
+  #     content_block_reference.identifier #=> "2b92cade-549c-4449-9796-e7a3957f3a86"
+  #     content_block_reference.identifier #=> "some-slug"
   #   @return [String]
   #
   # @!attribute [r] embed_code
@@ -26,13 +28,22 @@ module ContentBlockTools
   #   @return [String]
   class ContentBlockReference < Data
     # An array of the supported document types
-    SUPPORTED_DOCUMENT_TYPES = %w[contact content_block_email_address content_block_postal_address content_block_pension].freeze
+    SUPPORTED_DOCUMENT_TYPES = %w[contact content_block_email_address content_block_postal_address content_block_pension content_block_contact].freeze
     # The regex used to find UUIDs
-    UUID_REGEX = /([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})/
+    UUID_REGEX = /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/
+    # The regex used to find content ID aliases
+    CONTENT_ID_ALIAS_REGEX = /[a-z0-9-]+/
     # The regex to find optional field names after the UUID, begins with '/'
     FIELD_REGEX = /(\/[a-z0-9_\-\/]*)?/
     # The regex used when scanning a document using {ContentBlockTools::ContentBlockReference.find_all_in_document}
-    EMBED_REGEX = /({{embed:(#{SUPPORTED_DOCUMENT_TYPES.join('|')}):#{UUID_REGEX}#{FIELD_REGEX}}})/
+    EMBED_REGEX = /({{embed:(#{SUPPORTED_DOCUMENT_TYPES.join('|')}):(#{UUID_REGEX}|#{CONTENT_ID_ALIAS_REGEX})#{FIELD_REGEX}}})/
+
+    # Returns if the identifier is an alias
+    #
+    # @return Boolean
+    def identifier_is_alias?
+      !identifier.match?(UUID_REGEX)
+    end
 
     class << self
       # Finds all content block references within a document, using `ContentBlockReference::EMBED_REGEX`
@@ -42,7 +53,7 @@ module ContentBlockTools
       def find_all_in_document(document)
         document.scan(ContentBlockReference::EMBED_REGEX).map do |match|
           ContentBlockTools.logger.info("Found Content Block Reference: #{match}")
-          ContentBlockReference.new(document_type: match[1], content_id: match[2], embed_code: match[0])
+          ContentBlockReference.new(document_type: match[1], identifier: match[2], embed_code: match[0])
         end
       end
     end

data/lib/content_block_tools/presenters/base_presenter.rb

@@ -1,11 +1,15 @@
 module ContentBlockTools
   module Presenters
     class BasePresenter
+      include ActionView::Context
       include ActionView::Helpers::TagHelper
 
       # The default HTML tag to wrap the presented response in - can be overridden in a subclass
       BASE_TAG_TYPE = :span
 
+      # A lookup of presenters for particular fields - can be overridden in a subclass
+      FIELD_PRESENTERS = {}.freeze
+
       # Returns a new presenter object
       #
       # @param [{ContentBlockTools::ContentBlock}] content_block  A content block object
@@ -22,7 +26,7 @@ module ContentBlockTools
       # @return [string] A HTML representation of the content block
       def render
         content_tag(
-          BASE_TAG_TYPE,
+          base_tag,
           content,
           class: %W[content-embed content-embed__#{content_block.document_type}],
           data: {
@@ -62,17 +66,28 @@ module ContentBlockTools
           ContentBlockTools.logger.warn("Content not found for content block #{content_block.content_id} and fields #{field_names}")
           content_block.embed_code
         else
-          content
+          presenter = field_presenter || ContentBlockTools::Presenters::FieldPresenters::BasePresenter
+          presenter.new(content).render
         end
       end
 
       def field_names
-        embed_code_match = ContentBlockReference::EMBED_REGEX.match(content_block.embed_code)
-        if embed_code_match.present?
-          all_fields = embed_code_match[4]&.reverse&.chomp("/")&.reverse
-          all_fields&.split("/")&.map(&:to_sym)
+        @field_names ||= begin
+          embed_code_match = ContentBlockReference::EMBED_REGEX.match(content_block.embed_code)
+          if embed_code_match.present?
+            all_fields = embed_code_match[4]&.reverse&.chomp("/")&.reverse
+            all_fields&.split("/")&.map(&:to_sym)
+          end
         end
       end
+
+      def field_presenter
+        @field_presenter ||= field_names ? self.class::FIELD_PRESENTERS[field_names.last] : nil
+      end
+
+      def base_tag
+        field_names ? :span : self.class::BASE_TAG_TYPE
+      end
     end
   end
 end

data/lib/content_block_tools/presenters/contact_presenter.rb

@@ -0,0 +1,51 @@
+module ContentBlockTools
+  module Presenters
+    class ContactPresenter < BasePresenter
+      include ActionView::Helpers::TextHelper
+
+      BASE_TAG_TYPE = :div
+
+      FIELD_PRESENTERS = {
+        email_address: ContentBlockTools::Presenters::FieldPresenters::Contact::EmailAddressPresenter,
+      }.freeze
+
+    private
+
+      def default_content
+        content_tag(:div, class: "contact") do
+          concat content_tag(:p, content_block.title, class: "govuk-body")
+          concat(email_addresses.map { |email_address| email_address_content(email_address) }.join.html_safe) if email_addresses.any?
+          concat(phone_numbers.map { |phone_number| phone_number_content(phone_number) }.join.html_safe) if phone_numbers.any?
+        end
+      end
+
+      def email_address_content(email_address)
+        content_tag(:p, class: "govuk-body govuk-!-margin-bottom-4") do
+          concat content_tag(:span, email_address[:title])
+          concat content_tag(:a,
+                             email_address[:email_address],
+                             class: "govuk-link",
+                             href: "mailto:#{email_address[:email_address]}")
+        end
+      end
+
+      def phone_number_content(phone_number)
+        content_tag(:p, class: "govuk-body govuk-!-margin-bottom-4") do
+          concat content_tag(:span, phone_number[:title])
+          concat content_tag(:a,
+                             phone_number[:telephone],
+                             class: "govuk-link",
+                             href: "tel:#{CGI.escape phone_number[:telephone]}")
+        end
+      end
+
+      def email_addresses
+        content_block.details[:email_addresses]&.values
+      end
+
+      def phone_numbers
+        content_block.details[:telephones]&.values
+      end
+    end
+  end
+end

data/lib/content_block_tools/presenters/email_address_presenter.rb

@@ -4,7 +4,10 @@ module ContentBlockTools
     private
 
       def content
-        content_block.details[:email_address]
+        content_tag(:a,
+                    content_block.details[:email_address],
+                    class: "govuk-link",
+                    href: "mailto:#{content_block.details[:email_address]}")
       end
     end
   end

data/lib/content_block_tools/presenters/field_presenters/base_presenter.rb

@@ -0,0 +1,20 @@
+module ContentBlockTools
+  module Presenters
+    module FieldPresenters
+      class BasePresenter
+        include ActionView::Context
+        include ActionView::Helpers::TagHelper
+
+        attr_reader :field
+
+        def initialize(field)
+          @field = field
+        end
+
+        def render
+          field
+        end
+      end
+    end
+  end
+end

data/lib/content_block_tools/presenters/field_presenters/contact/email_address_presenter.rb

@@ -0,0 +1,13 @@
+module ContentBlockTools
+  module Presenters
+    module FieldPresenters
+      module Contact
+        class EmailAddressPresenter < BasePresenter
+          def render
+            content_tag(:a, field, class: "govuk-link", href: "mailto:#{field}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/content_block_tools/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ContentBlockTools
-  VERSION = "0.4.6"
+  VERSION = "0.5.1"
 end

data/lib/content_block_tools.rb

@@ -3,7 +3,11 @@
 require "action_view"
 require "uri"
 
+require "content_block_tools/presenters/field_presenters/base_presenter"
+require "content_block_tools/presenters/field_presenters/contact/email_address_presenter"
+
 require "content_block_tools/presenters/base_presenter"
+require "content_block_tools/presenters/contact_presenter"
 require "content_block_tools/presenters/email_address_presenter"
 require "content_block_tools/presenters/postal_address_presenter"
 require "content_block_tools/presenters/pension_presenter"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: content_block_tools
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.5.1
 platform: ruby
 authors:
 - GOV.UK Dev
 bindir: exe
 cert_chain: []
-date: 2025-03-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -37,20 +37,34 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.13.0
+- !ruby/object:Gem::Dependency
+  name: rspec-html-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: rubocop-govuk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.3
+        version: 5.1.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.3
+        version: 5.1.6
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
@@ -92,7 +106,10 @@ files:
 - lib/content_block_tools/content_block.rb
 - lib/content_block_tools/content_block_reference.rb
 - lib/content_block_tools/presenters/base_presenter.rb
+- lib/content_block_tools/presenters/contact_presenter.rb
 - lib/content_block_tools/presenters/email_address_presenter.rb
+- lib/content_block_tools/presenters/field_presenters/base_presenter.rb
+- lib/content_block_tools/presenters/field_presenters/contact/email_address_presenter.rb
 - lib/content_block_tools/presenters/pension_presenter.rb
 - lib/content_block_tools/presenters/postal_address_presenter.rb
 - lib/content_block_tools/version.rb
@@ -114,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.5
+rubygems_version: 3.6.8
 specification_version: 4
 summary: A suite of tools for working with GOV.UK Content Blocks
 test_files: []