content_block_tools 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 725d9ca90871eddcb941443e561d75eddd4f583b0820c13ce7a76fb383902f3d
-  data.tar.gz: e07516f4eb350605d598bf40c1ff093c1e43c1a4d874431a26c06624776e41bc
+  metadata.gz: fe6e7c2a4c34c9af7eeee0764b6021b65b0cbaf6db769b27a16119faf9775b2e
+  data.tar.gz: 0d5664a937d3891d536c79915861d91be62b070015bddfaab625299be7f36423
 SHA512:
-  metadata.gz: fbd1d8d4b92d256863f0a92dd5034dc832552610455b93240ff4d49ffdc310160a2b6847e9355d7ce07ca90d803d10109a56d6644503d7893f74e0fb9260c82e
-  data.tar.gz: a93c861b548f16d213391bfa13658d36071f07c2bfb6972e50942b3c8338a2ba9cf03b54fd9cdf4c5c4d843f474b25db4378d33bd2d453bd0b90c9d7ef6c6028
+  metadata.gz: ea555fd3c90f65675e1d81925cc78a1e96643cdd69104a32628a155fef2e262596dc7263c2bbe885510f4f5467b4e64e93ff9e1c86d3fe0ba39c5e0d5bdef5e6
+  data.tar.gz: bc3208ed4bab8c233385f1fbf5d4f6c5170e69cd3f051c5c85b42975297053e2f222fe24446da59d9c700f00270862da2ad31639a99e512a4abff98345e456b9

data/CHANGELOG.md

@@ -7,6 +7,15 @@
   useful summary for people upgrading their application, not a replication
   of the commit log.
 
+## 0.5.2
+
+- Use `deep_symbolize_keys` when initializing a block's details  ([31](https://github.com/alphagov/govuk_content_block_tools/pull/31))
+
+## 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))

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.1.4"
+  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

@@ -43,6 +43,7 @@ module ContentBlockTools
   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,
@@ -59,7 +60,7 @@ module ContentBlockTools
     end
 
     def details
-      to_h[:details].symbolize_keys
+      to_h[:details].deep_symbolize_keys
     end
   end
 end

data/lib/content_block_tools/content_block_reference.rb

@@ -28,7 +28,7 @@ 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}/
     # The regex used to find content ID aliases

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.5.0"
+  VERSION = "0.5.2"
 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: content_block_tools
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - GOV.UK Dev
@@ -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.1.4
+        version: 5.1.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.1.4
+        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