content_block_tools 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0096d08b83ee59a496db42789c353d5066bb67fb578e5488f43db2763fc6bb98'
-  data.tar.gz: 65f13b4c646f846aabb2fb04df55ea8ae1f9859946dfa547e4be9a9990e166a0
+  metadata.gz: 9d0b492495818ff1ae3a52098b3386bb9f5665fa2c8aca6b260d244305d9f8d6
+  data.tar.gz: 4c67d72795c6345aab7619d81213293c537a7d95bb7b8fa015f8c6d1d1ff6ca0
 SHA512:
-  metadata.gz: 5bf713af8e94445479cd22a74262c8f83ce15c5c850ce14242a3398c717f8c6a74bcc7eb40ae9c1ea41095d232a03cef9a5d1e9430b6259d243f6e644de67e2a
-  data.tar.gz: 3a7f1dc2923151056018c517d2adf8ea9c0be93254b6bf41d3fbb6f9111e46d925afc38f1d934cc5245aede7d827d842c2c5eb70e728fb2c4cdbcef6bec212f4
+  metadata.gz: 68ea93d11e33b68f51c0a4893d95266cf46fcf09ab5faaff2487a83ee40c4790045610f9d055a21da9bb7d59cf266b36c9b35b397f5bbec393b6bf9778e364db
+  data.tar.gz: 9dae479a604a0be374db8bd8267e62c231c00e4f2da39e20d7e60de9131d7580fe4035bd1518fe9b4a94ebb6f2ed25315dc86872b9241e2f76884cd3d539ab9e

data/CHANGELOG.md

@@ -7,6 +7,12 @@
   useful summary for people upgrading their application, not a replication
   of the commit log.
 
+## 0.4.0
+
+* BREAKING: allow support for field names in block's embed code. new ContentBlocks now require an embed code argument. (
+  [17]
+  (https://github.com/alphagov/govuk_content_block_tools/pull/17))
+
 ## 0.3.1
 
 * Support any Rails version `>= 6` ([#10](https://github.com/alphagov/govuk_content_block_tools/pull/10))

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.2"
+  spec.add_development_dependency "rubocop-govuk", "5.0.3"
 
   spec.add_dependency "actionview", ">= 6"
 end

data/lib/content_block_tools/content_block.rb

@@ -1,5 +1,5 @@
 module ContentBlockTools
-  ContentBlock = Data.define(:content_id, :title, :document_type, :details)
+  ContentBlock = Data.define(:content_id, :title, :document_type, :details, :embed_code)
 
   # Defines a Content Block
   #
@@ -33,10 +33,18 @@ module ContentBlockTools
   #   content_block.details #=> { email_address: "foo@example.com" }
   #  @return [Hash] the details
   #  @api public
+  #
+  # @!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]
   class ContentBlock < Data
     # A lookup of presenters for particular content block types
     CONTENT_PRESENTERS = {
       "content_block_email_address" => ContentBlockTools::Presenters::EmailAddressPresenter,
+      "content_block_postal_address" => ContentBlockTools::Presenters::PostalAddressPresenter,
     }.freeze
 
     # Calls the appropriate presenter class to return a HTML representation of a content

data/lib/content_block_tools/content_block_reference.rb

@@ -26,11 +26,13 @@ module ContentBlockTools
   #   @return [String]
   class ContentBlockReference < Data
     # An array of the supported document types
-    SUPPORTED_DOCUMENT_TYPES = %w[contact content_block_email_address].freeze
+    SUPPORTED_DOCUMENT_TYPES = %w[contact content_block_email_address content_block_postal_address].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})/
+    # The regex to find optional field names after the UUID, begins with '/'
+    FIELD_REGEX = /(\/.*)?/
     # The regex used when scanning a document using {ContentBlockTools::ContentBlockReference.find_all_in_document}
-    EMBED_REGEX = /({{embed:(#{SUPPORTED_DOCUMENT_TYPES.join('|')}):#{UUID_REGEX}}})/
+    EMBED_REGEX = /({{embed:(#{SUPPORTED_DOCUMENT_TYPES.join('|')}):#{UUID_REGEX}#{FIELD_REGEX}}})/
 
     class << self
       # Finds all content block references within a document, using `ContentBlockReference::EMBED_REGEX`

data/lib/content_block_tools/presenters/base_presenter.rb

@@ -29,21 +29,43 @@ module ContentBlockTools
             content_block: "",
             document_type: content_block.document_type,
             content_id: content_block.content_id,
+            field_names: field_names&.join(","),
           },
         )
       end
 
     private
 
+      attr_reader :content_block
+
       # The default representation of the content block - this can be overridden in a subclass
+      # by overriding the content, default_content or content_for_fields methods
       #
       # @return [string] A representation of the content block to be wrapped in the base_tag in
       # {#content}
       def content
+        if field_names.present?
+          content_for_fields
+        else
+          default_content
+        end
+      end
+
+      def default_content
         content_block.title
       end
 
-      attr_reader :content_block
+      def content_for_fields
+        content_block.details.dig(*field_names)
+      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)
+        end
+      end
     end
   end
 end

data/lib/content_block_tools/presenters/postal_address_presenter.rb

@@ -0,0 +1,11 @@
+module ContentBlockTools
+  module Presenters
+    class PostalAddressPresenter < BasePresenter
+    private
+
+      def default_content
+        "#{content_block.details[:line_1]}, #{content_block.details[:town_or_city]}, #{content_block.details[:postcode]}"
+      end
+    end
+  end
+end

data/lib/content_block_tools/version.rb

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

data/lib/content_block_tools.rb

@@ -5,6 +5,7 @@ require "uri"
 
 require "content_block_tools/presenters/base_presenter"
 require "content_block_tools/presenters/email_address_presenter"
+require "content_block_tools/presenters/postal_address_presenter"
 
 require "content_block_tools/content_block"
 require "content_block_tools/content_block_reference"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: content_block_tools
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - GOV.UK Dev
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-25 00:00:00.000000000 Z
+date: 2025-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -44,14 +43,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.2
+        version: 5.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.2
+        version: 5.0.3
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +65,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6'
-description: 
 email:
 - govuk-dev@digital.cabinet-office.gov.uk
 executables: []
@@ -94,12 +92,12 @@ files:
 - lib/content_block_tools/content_block_reference.rb
 - lib/content_block_tools/presenters/base_presenter.rb
 - lib/content_block_tools/presenters/email_address_presenter.rb
+- lib/content_block_tools/presenters/postal_address_presenter.rb
 - lib/content_block_tools/version.rb
 homepage: https://github.com/alphagov/content_block_tools
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -114,8 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key: 
+rubygems_version: 3.6.3
 specification_version: 4
 summary: A suite of tools for working with GOV.UK Content Blocks
 test_files: []