content_block_tools 0.5.2 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe6e7c2a4c34c9af7eeee0764b6021b65b0cbaf6db769b27a16119faf9775b2e
-  data.tar.gz: 0d5664a937d3891d536c79915861d91be62b070015bddfaab625299be7f36423
+  metadata.gz: 317a33abd963522a97d5421d905b916f8c178935645081bba320b984ed0108b4
+  data.tar.gz: 9503e913fb0c5826cfbafae81e7263351e149b44009e0bb836ac1d1dc00c8ca4
 SHA512:
-  metadata.gz: ea555fd3c90f65675e1d81925cc78a1e96643cdd69104a32628a155fef2e262596dc7263c2bbe885510f4f5467b4e64e93ff9e1c86d3fe0ba39c5e0d5bdef5e6
-  data.tar.gz: bc3208ed4bab8c233385f1fbf5d4f6c5170e69cd3f051c5c85b42975297053e2f222fe24446da59d9c700f00270862da2ad31639a99e512a4abff98345e456b9
+  metadata.gz: 716b6950c8633ccc8f80eba30d685e117ce638471f9eadc5c7353e8189a2e2d0eb263e86dd4f6e340cc68d3c54b234e758fc3211ff0078e5ab0dba12c298695e
+  data.tar.gz: '078faf1ebb791e906f33744cf8dd0f3a6a8c5355c5b2296926bc68eaccff13c931df39786ac59b5af9958fbe61b7162a9868cb50edf5afb94e4b7f33a06f39d5'

data/CHANGELOG.md

@@ -7,6 +7,15 @@
   useful summary for people upgrading their application, not a replication
   of the commit log.
 
+## 0.5.4
+
+- Remove old email_address and postal_address types ([38](https://github.com/alphagov/govuk_content_block_tools/pull/38))
+
+## 0.5.3
+
+- Add spacing to contact item titles ([35](https://github.com/alphagov/govuk_content_block_tools/pull/35))
+- Add new fields to contact items ([35](https://github.com/alphagov/govuk_content_block_tools/pull/35))
+
 ## 0.5.2
 
 - Use `deep_symbolize_keys` when initializing a block's details  ([31](https://github.com/alphagov/govuk_content_block_tools/pull/31))

data/README.md

@@ -19,13 +19,13 @@ or add it to your Gemfile
 To find embed code in a block of text, use `ContentBlockReference.find_all_in_document`:
 
 ```ruby
-content = "Hello - here is a embed code {{embed:content_block_email_address:be24ee44-b636-4a3e-b979-0da27b4a8e62}}"
+content = "Hello - here is a embed code {{embed:content_block_pension:be24ee44-b636-4a3e-b979-0da27b4a8e62}}"
 ContentBlockReference.find_all_in_document(content)
 # =>
 #[#<data ContentBlockTools::ContentBlockReference
-#  document_type="content_block_email_address",
+#  document_type="content_block_pension",
 #  content_id="be24ee44-b636-4a3e-b979-0da27b4a8e62",
-#  embed_code="{{embed:content_block_email_address:be24ee44-b636-4a3e-b979-0da27b4a8e62}}">]
+#  embed_code="{{embed:content_block_pension:be24ee44-b636-4a3e-b979-0da27b4a8e62}}">]
 ```
 
 ### Rendering a content block

data/lib/content_block_tools/content_block.rb

@@ -23,7 +23,7 @@ module ContentBlockTools
   #   will be used to render the content block. All supported document_types are documented in
   #   {ContentBlockTools::ContentBlockReference::SUPPORTED_DOCUMENT_TYPES}
   #   @example
-  #     content_block.document_type #=> "content_block_email_address"
+  #     content_block.document_type #=> "content_block_pension"
   #   @return [String] the document type
   #   @api public
   #
@@ -37,15 +37,13 @@ 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}}"
+  #    content_block_reference.embed_code #=> "{{embed:content_block_pension:2b92cade-549c-4449-9796-e7a3957f3a86}}"
+  #    content_block_reference.embed_code #=> "{{embed:content_block_contact: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,
     }.freeze
 

data/lib/content_block_tools/content_block_reference.rb

@@ -9,7 +9,7 @@ module ContentBlockTools
   #   will be used to render the content block. All supported document_types are documented in
   #   {ContentBlockTools::ContentBlockReference::SUPPORTED_DOCUMENT_TYPES}
   #   @example
-  #     content_block_reference.document_type #=> "content_block_email_address"
+  #     content_block_reference.document_type #=> "content_block_pension"
   #   @return [String] the document type
   #   @api public
   #
@@ -24,11 +24,11 @@ module ContentBlockTools
   # @!attribute [r] embed_code
   #   The embed_code used for a block
   #   @example
-  #     content_block_reference.embed_code #=> "{{embed:content_block_email_address:2b92cade-549c-4449-9796-e7a3957f3a86}}"
+  #     content_block_reference.embed_code #=> "{{embed:content_block_pension:2b92cade-549c-4449-9796-e7a3957f3a86}}"
   #   @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 content_block_contact].freeze
+    SUPPORTED_DOCUMENT_TYPES = %w[contact 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

@@ -10,6 +10,16 @@ module ContentBlockTools
       # A lookup of presenters for particular fields - can be overridden in a subclass
       FIELD_PRESENTERS = {}.freeze
 
+      def self.has_embedded_objects(*object_types)
+        @embedded_objects = object_types
+
+        object_types.each do |object_type|
+          define_method(object_type) do
+            embedded_objects_of_type(object_type)
+          end
+        end
+      end
+
       # Returns a new presenter object
       #
       # @param [{ContentBlockTools::ContentBlock}] content_block  A content block object
@@ -88,6 +98,14 @@ module ContentBlockTools
       def base_tag
         field_names ? :span : self.class::BASE_TAG_TYPE
       end
+
+      def embedded_objects_of_type(type)
+        content_block.details.fetch(type, {}).values
+      end
+
+      def embedded_objects
+        self.class.instance_variable_get("@embedded_objects")
+      end
     end
   end
 end

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

@@ -0,0 +1,22 @@
+module ContentBlockTools
+  module Presenters
+    module BlockPresenters
+      class BasePresenter
+        include ActionView::Context
+        include ActionView::Helpers::TextHelper
+
+        attr_reader :item
+
+        def initialize(item)
+          @item = item
+        end
+
+        def title_content
+          "#{item[:title]}: "
+        end
+
+        def render; end
+      end
+    end
+  end
+end

data/lib/content_block_tools/presenters/block_presenters/contact/address_presenter.rb

@@ -0,0 +1,21 @@
+module ContentBlockTools
+  module Presenters
+    module BlockPresenters
+      module Contact
+        class AddressPresenter < ContentBlockTools::Presenters::BlockPresenters::BasePresenter
+          def render
+            content_tag(:p, class: "govuk-body govuk-!-margin-bottom-4") do
+              [
+                item[:street_address],
+                item[:locality],
+                item[:region],
+                item[:postal_code],
+                item[:country],
+              ].compact_blank.join(",<br/>").html_safe
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/content_block_tools/presenters/block_presenters/contact/contact_form_presenter.rb

@@ -0,0 +1,19 @@
+module ContentBlockTools
+  module Presenters
+    module BlockPresenters
+      module Contact
+        class ContactFormPresenter < ContentBlockTools::Presenters::BlockPresenters::BasePresenter
+          def render
+            content_tag(:p, class: "govuk-body govuk-!-margin-bottom-4") do
+              concat content_tag(:span, title_content)
+              concat content_tag(:a,
+                                 item[:url],
+                                 class: "govuk-link",
+                                 href: item[:url])
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module ContentBlockTools
+  module Presenters
+    module BlockPresenters
+      module Contact
+        class EmailAddressPresenter < ContentBlockTools::Presenters::BlockPresenters::BasePresenter
+          def render
+            content_tag(:p, class: "govuk-body govuk-!-margin-bottom-4") do
+              concat content_tag(:span, title_content)
+              concat content_tag(:a,
+                                 item[:email_address],
+                                 class: "govuk-link",
+                                 href: "mailto:#{item[:email_address]}")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/content_block_tools/presenters/block_presenters/contact/telephone_presenter.rb

@@ -0,0 +1,19 @@
+module ContentBlockTools
+  module Presenters
+    module BlockPresenters
+      module Contact
+        class TelephonePresenter < ContentBlockTools::Presenters::BlockPresenters::BasePresenter
+          def render
+            content_tag(:p, class: "govuk-body govuk-!-margin-bottom-4") do
+              concat content_tag(:span, title_content)
+              concat content_tag(:a,
+                                 item[:telephone],
+                                 class: "govuk-link",
+                                 href: "tel:#{CGI.escape item[:telephone]}")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/content_block_tools/presenters/contact_presenter.rb

@@ -9,42 +9,22 @@ module ContentBlockTools
         email_address: ContentBlockTools::Presenters::FieldPresenters::Contact::EmailAddressPresenter,
       }.freeze
 
+      has_embedded_objects :addresses, :email_addresses, :telephones, :contact_forms
+
     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?
+          embedded_objects.each do |object|
+            items = send(object)
+            concat(items.map { |item| presenter_for_object_type(object).new(item).render }.join.html_safe)
+          end
         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
+      def presenter_for_object_type(type)
+        "ContentBlockTools::Presenters::BlockPresenters::Contact::#{type.to_s.singularize.underscore.camelize}Presenter".constantize
       end
     end
   end

data/lib/content_block_tools/version.rb

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

data/lib/content_block_tools.rb

@@ -6,10 +6,14 @@ 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/block_presenters/base_presenter"
+require "content_block_tools/presenters/block_presenters/contact/address_presenter"
+require "content_block_tools/presenters/block_presenters/contact/contact_form_presenter"
+require "content_block_tools/presenters/block_presenters/contact/email_address_presenter"
+require "content_block_tools/presenters/block_presenters/contact/telephone_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"
 
 require "content_block_tools/content_block"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: content_block_tools
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.4
 platform: ruby
 authors:
 - GOV.UK Dev
@@ -106,12 +106,15 @@ 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/block_presenters/base_presenter.rb
+- lib/content_block_tools/presenters/block_presenters/contact/address_presenter.rb
+- lib/content_block_tools/presenters/block_presenters/contact/contact_form_presenter.rb
+- lib/content_block_tools/presenters/block_presenters/contact/email_address_presenter.rb
+- lib/content_block_tools/presenters/block_presenters/contact/telephone_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
 homepage: https://github.com/alphagov/content_block_tools
 licenses:
@@ -131,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A suite of tools for working with GOV.UK Content Blocks
 test_files: []

data/lib/content_block_tools/presenters/email_address_presenter.rb

@@ -1,14 +0,0 @@
-module ContentBlockTools
-  module Presenters
-    class EmailAddressPresenter < BasePresenter
-    private
-
-      def content
-        content_tag(:a,
-                    content_block.details[:email_address],
-                    class: "govuk-link",
-                    href: "mailto:#{content_block.details[:email_address]}")
-      end
-    end
-  end
-end

data/lib/content_block_tools/presenters/postal_address_presenter.rb

@@ -1,11 +0,0 @@
-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