content_block_tools 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b821972df0a116f521f39a5658515719023e8f716e4b1c2197ec9390bcbec220
-  data.tar.gz: 81ae6c7245eab5a667901a47630b24f846bad2e0034021a51ee5c9fa4922922c
+  metadata.gz: c34b07afe5921c6615c4b9e8a7411361ade415837086f38d1536c90f440f6f62
+  data.tar.gz: c71bc6c809d2633613aedd8e4b1c35d22cba35c6307ca1f12ec9da6410293678
 SHA512:
-  metadata.gz: 1d27748f20ac56e0ef0b29103d6cff133a61b72fdec00d80547094feb6f7b05cebff2be498150aed636232ae61d0e538a5eb99d5e7c0cd466c4cbeef23c57cf8
-  data.tar.gz: 6ab320367c385d02a641d4693dc393a67258d94856964d7c46a34046c78aa882752cf2c306c581ef86e8f746b963c7d41f924c35b6c1157c7b13cf34f6f26823
+  metadata.gz: d8141f6186ec06d0890dea636d293d650aa3ef3e1e69b86fa88bac0c937e61e9e3a5bd299b2e6dd66c8bd390dc7213c1b2b2a21dd7251fdae03108433b8cf0be
+  data.tar.gz: 11b9f5f84654032e9cabb1d3aed0498bebc3e1396359bde3fc56683c6a79c931f47ca753b05022e23bf86f50c35ec55427975c484eb5834e415f50a952ee2ded

data/lib/content_block_tools/content_block_reference.rb

@@ -51,13 +51,57 @@ module ContentBlockTools
       #
       # @return [Array<ContentBlockReference>] An array of content block references
       def find_all_in_document(document)
-        document.scan(ContentBlockReference::EMBED_REGEX).map do |match|
-          match = prepare_match(match)
-          ContentBlockTools.logger.info("Found Content Block Reference: #{match}")
-          ContentBlockReference.new(document_type: match[1], identifier: match[2], embed_code: match[0])
+        document.scan(EMBED_REGEX).map do |match_data|
+          ContentBlockReference.from_match_data(match_data)
         end
       end
 
+      # Converts a single embed code string into a ContentBlockReference object
+      #
+      # Parses an embed code string using {EMBED_REGEX} to extract the document type,
+      # identifier, and embed code, then creates a ContentBlockReference instance.
+      #
+      # @param embed_code [String] the embed code to parse
+      # @example Parse an embed code with a UUID
+      #   ContentBlockReference.from_string("{{embed:content_block_pension:2b92cade-549c-4449-9796-e7a3957f3a86}}")
+      #   #=> #<ContentBlockReference document_type="content_block_pension" identifier="2b92cade-549c-4449-9796-e7a3957f3a86" embed_code="{{embed:content_block_pension:2b92cade-549c-4449-9796-e7a3957f3a86}}">
+      # @example Parse an embed code with a slug
+      #   ContentBlockReference.from_string("{{embed:content_block_contact:some-slug}}")
+      #   #=> #<ContentBlockReference document_type="content_block_contact" identifier="some-slug" embed_code="{{embed:content_block_contact:some-slug}}">
+      # @return [ContentBlockReference] a new ContentBlockReference instance
+      # @raise [InvalidEmbedCodeError] if the embed_code doesn't match {EMBED_REGEX} (match_data will be nil)
+      # @see from_match_data
+      def from_string(embed_code)
+        match_data = embed_code.match(/^#{EMBED_REGEX}$/)
+        raise InvalidEmbedCodeError unless match_data
+
+        ContentBlockReference.from_match_data(match_data.captures)
+      end
+
+      # Converts match data from a regex scan into a ContentBlockReference object
+      #
+      # This method is used internally by {find_all_in_document} and {from_string} to create
+      # ContentBlockReference instances from regex match data. It normalizes the match data
+      # by replacing en/em dashes with double/triple dashes (which can occur due to Kramdown's
+      # markdown parsing) before creating the object.
+      #
+      # @param match_data [MatchData, Array] the match data from scanning with {EMBED_REGEX}
+      #   Expected to contain: [full_match, document_type, identifier, field]
+      # @example Creating from match data
+      #   match_data = "{{embed:content_block_pension:2b92cade-549c-4449-9796-e7a3957f3a86}}".match(EMBED_REGEX)
+      #   ContentBlockReference.from_match_data(match_data)
+      #   #=> #<ContentBlockReference document_type="content_block_pension" identifier="2b92cade-549c-4449-9796-e7a3957f3a86" embed_code="{{embed:content_block_pension:2b92cade-549c-4449-9796-e7a3957f3a86}}">
+      # @return [ContentBlockReference] a new ContentBlockReference instance
+      # @api private
+      # @see find_all_in_document
+      # @see from_string
+      # @see prepare_match
+      def from_match_data(match_data)
+        match = prepare_match(match_data)
+        ContentBlockTools.logger.info("Found Content Block Reference: #{match}")
+        ContentBlockReference.new(document_type: match[1], identifier: match[2], embed_code: match[0])
+      end
+
     private
 
       # This replaces an en / em dashes in content block references with double or triple dashes. This can occur

data/lib/content_block_tools/version.rb

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

data/lib/content_block_tools.rb

@@ -18,6 +18,8 @@ require "content_block_tools/version"
 
 module ContentBlockTools
   class Error < StandardError; end
+  class InvalidEmbedCodeError < StandardError; end
+
   module Presenters; end
 
   module Components

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: content_block_tools
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - GOV.UK Dev