content_block_tools 0.4.5 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8dcdb3b81c3bba801688a197e2f9208ed17e8432f1d4c96215d3591bca746708
-  data.tar.gz: 81b3aab74207c5d64a687f4c7cff7e309b8fca6a8da68b19a74e183a09f809c3
+  metadata.gz: 725d9ca90871eddcb941443e561d75eddd4f583b0820c13ce7a76fb383902f3d
+  data.tar.gz: e07516f4eb350605d598bf40c1ff093c1e43c1a4d874431a26c06624776e41bc
 SHA512:
-  metadata.gz: 8f0169d5727462ad30dd9888a9bfc8421dac428e8c9203e7d4b00c5f3dcc093751addb500d6b1fa4d5b334e5cf3fcb118366e9615b0c1b57c95c998a082d85bf
-  data.tar.gz: d64fdbcef11a2de0279f01d4aca052b7aaed794669cbc24a2d8d3f8cef21e5855c3523f9e363d9db9f4376190f655fc2370debfafadb272904d83f15d51eeb10
+  metadata.gz: fbd1d8d4b92d256863f0a92dd5034dc832552610455b93240ff4d49ffdc310160a2b6847e9355d7ce07ca90d803d10109a56d6644503d7893f74e0fb9260c82e
+  data.tar.gz: a93c861b548f16d213391bfa13658d36071f07c2bfb6972e50942b3c8338a2ba9cf03b54fd9cdf4c5c4d843f474b25db4378d33bd2d453bd0b90c9d7ef6c6028

data/CHANGELOG.md

@@ -7,6 +7,13 @@
   useful summary for people upgrading their application, not a replication
   of the commit log.
 
+## 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))
+
 ## 0.4.5
 
 - Add handling for incorrect field names and some logging ([24](https://github.com/alphagov/govuk_content_block_tools/pull/24))

data/content_block_tools.gemspec

@@ -27,7 +27,7 @@ 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 "rubocop-govuk", "5.1.4"
 
   spec.add_dependency "actionview", ">= 6"
 end

data/lib/content_block_tools/content_block.rb

@@ -36,10 +36,10 @@ 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 = {

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
@@ -28,11 +30,20 @@ module ContentBlockTools
     # An array of the supported document types
     SUPPORTED_DOCUMENT_TYPES = %w[contact content_block_email_address content_block_postal_address content_block_pension].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`
@@ -40,10 +51,9 @@ module ContentBlockTools
       #
       # @return [Array<ContentBlockReference>] An array of content block references
       def find_all_in_document(document)
-        ContentBlockTools.logger.info("Finding embedded content")
         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/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: content_block_tools
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.5.0
 platform: ruby
 authors:
 - GOV.UK Dev
 bindir: exe
 cert_chain: []
-date: 2025-03-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -43,14 +43,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.3
+        version: 5.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.3
+        version: 5.1.4
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
@@ -114,7 +114,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: []