content_block_tools 0.16.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc5c252953a643976df3b67edfeb89574770b18f19c83e8c89fe97117b9a12d3
-  data.tar.gz: 9621e75ef84f2e2ecfed5dc8e2452de47e157e1fa7ffc5448c133957733977a3
+  metadata.gz: 9a56c786b7424a15facf7bd8f34bfb17922418c109b10fb6fd1854b48c713252
+  data.tar.gz: 83a46bcfcb4e77e05dd1a245bbe009defc1f09225a877fce535b7a9a703cd8b2
 SHA512:
-  metadata.gz: f2e7e1129b8c885327926d605a8bfc0aa9556cf037b3c91ee4a4c36436cd7751646b31c5ecf65301c18520bb65efc45fdbb427e2d6d946f28d0cc63e090048be
-  data.tar.gz: c9b5aa1eae520f16eab7dd0143de7af184c7e9c07865af3054caab14cbfea1d22eaab8a85ef06bafd6363286a5b8dcbc3bdbef99a902927032ae5288d65a835d
+  metadata.gz: a407aa51ec57374cecef4f1c057b3cbcb99a248670509ea210cf453734d7343a1518513631fbc93050aa727576f3d9aa70a693151ca48c1e36379df0dcca324f
+  data.tar.gz: 9176b9453c70a7cc1a30e06463b47a97e787c0de25206300c662bcfb8329f1a7bec6244c0243944ed10307a7e81b78fc7050e51c92b7cb550d179cdafee042b4

data/.github/workflows/ci.yml

@@ -44,12 +44,32 @@ jobs:
       - run: echo "All matrix tests have passed 🚀"
 
   publish:
-    needs: test_matrix
+    needs: test
+    runs-on: ubuntu-latest
     if: ${{ github.ref == 'refs/heads/main' }}
     permissions:
       contents: write
-    uses: alphagov/govuk-infrastructure/.github/workflows/publish-rubygem.yml@main
-    with:
-      gem_name: content_block_tools
-    secrets:
-      GEM_HOST_API_KEY: ${{ secrets.ALPHAGOV_RUBYGEMS_API_KEY }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          rubygems: latest
+      - uses: actions/setup-node@v4.4.0
+        with:
+          node-version: lts/* # use the latest LTS release
+      - run: yarn install
+      - env:
+          GEM_HOST_API_KEY: ${{ secrets.ALPHAGOV_RUBYGEMS_API_KEY }}
+        run: |
+          VERSION=$(ruby -r rubygems -e "puts Gem::Specification::load('content_block_tools.gemspec').version")
+          GEM_VERSION=$(gem list --exact --remote content_block_tools)
+          
+          if [ "${GEM_VERSION}" != "content_block_tools (${VERSION})" ]; then
+            gem build content_block_tools.gemspec
+            gem push "content_block_tools-${VERSION}.gem"
+          fi
+          
+          if ! git ls-remote --tags --exit-code origin v"${VERSION}"; then
+            git tag v"${VERSION}"
+            git push --tags
+          fi

data/.gitignore

@@ -17,3 +17,4 @@ lib/.DS_Store
 spec/.DS_Store
 lib/content_block_tools/.DS_Store
 spec/content_block_tools/.DS_Store
+/node_modules

data/CHANGELOG.md

@@ -7,6 +7,15 @@
   useful summary for people upgrading their application, not a replication
   of the commit log.
 
+## 1.0.0
+
+- Add portable styling to the gem ([76](https://github.com/alphagov/govuk_content_block_tools/pull/76))
+- Update contact blocks to match design system ([76](https://github.com/alphagov/govuk_content_block_tools/pull/76))
+
+## 0.17.0
+
+- Use recipient field in address ([75](https://github.com/alphagov/govuk_content_block_tools/pull/75))
+
 ## 0.16.0
 
 - Use label as link text for contact link ([74](https://github.com/alphagov/govuk_content_block_tools/pull/74))

data/app/assets/stylesheets/blocks/_contact.scss

@@ -0,0 +1,13 @@
+@import "govuk/core/typography";
+
+.content-block--contact {
+  .content-block {
+    &__title {
+      @extend %govuk-heading-m;
+    }
+
+    &__subtitle {
+      @extend %govuk-heading-s;
+    }
+  }
+}

data/app/assets/stylesheets/content_block_tools.scss

@@ -0,0 +1,24 @@
+@import "govuk/core/lists";
+@import "govuk/core/typography";
+
+@import "blocks/contact";
+
+.content-block {
+  &__body {
+    @extend %govuk-body-m;
+  }
+
+  ul#{&}__list {
+    @extend %govuk-list;
+    margin-left: 0;
+
+    & > li {
+      list-style: none;
+      margin-bottom: govuk-spacing(1);
+    }
+  }
+
+  &__link {
+    @extend %govuk-link;
+  }
+}

data/lib/content_block_tools/engine.rb

@@ -0,0 +1,16 @@
+module ContentBlockTools
+  class Engine < ::Rails::Engine
+    isolate_namespace ContentBlockTools
+
+    initializer "content_block_tools.assets" do
+      Rails.application.config.assets.paths += %w[
+        app/assets/stylesheets
+        node_modules/govuk-frontend/dist/govuk/core
+      ]
+    end
+
+    initializer "content_block_tools.initialize_logger" do
+      ContentBlockTools.logger = Rails.logger
+    end
+  end
+end

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

@@ -11,8 +11,8 @@ module ContentBlockTools
             wrapper do
               output = []
 
-              output << content_tag(:p, class: "adr") do
-                %i[title street_address town_or_city state_or_county postal_code country].map { |field|
+              output << content_tag(:p, class: "adr content-block__body") do
+                %i[recipient street_address town_or_city state_or_county postal_code country].map { |field|
                   next if item[field].blank?
 
                   content_tag(:span, item[field], { class: class_for_field_name(field) })
@@ -27,6 +27,7 @@ module ContentBlockTools
 
           def class_for_field_name(field_name)
             {
+              recipient: "organization-name",
               street_address: "street-address",
               town_or_city: "locality",
               state_or_county: "region",
@@ -34,12 +35,6 @@ module ContentBlockTools
               country: "country-name",
             }[field_name]
           end
-
-        private
-
-          def show_title_in_field_names_context?
-            false
-          end
         end
       end
     end

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

@@ -12,26 +12,20 @@ module ContentBlockTools
           end
 
           def wrapper(&block)
-            if @rendering_context == :field_names
-              content_tag(:div, class: "contact") do
-                concat title if show_title_in_field_names_context?
-                concat yield block
-              end
-            else
-              yield block
+            content_tag(:div) do
+              concat title
+              concat yield block
             end
           end
 
           def title
-            content_tag(:p,
-                        @content_block.title,
-                        class: "govuk-!-margin-bottom-3")
-          end
-
-        private
-
-          def show_title_in_field_names_context?
-            true
+            if @rendering_context == :field_names
+              content_tag(:p,
+                          @content_block.title,
+                          class: "content-block__title")
+            else
+              content_tag(:p, item[:title], class: "content-block__subtitle")
+            end
           end
         end
       end

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

@@ -9,7 +9,7 @@ module ContentBlockTools
 
           def render
             wrapper do
-              content_tag(:div, class: "email-url-number") do
+              content_tag(:ul, class: "content-block__list") do
                 concat link
                 concat description if item[:description]
               end
@@ -17,10 +17,10 @@ module ContentBlockTools
           end
 
           def link
-            content_tag(:p) do
+            content_tag(:li) do
               content_tag(:a,
                           link_text,
-                          class: "url",
+                          class: "url content-block__link",
                           href: item[:url])
             end
           end
@@ -30,7 +30,9 @@ module ContentBlockTools
           end
 
           def description
-            render_govspeak(item[:description])
+            content_tag(:li) do
+              render_govspeak(item[:description])
+            end
           end
         end
       end

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

@@ -9,18 +9,18 @@ module ContentBlockTools
 
           def render
             wrapper do
-              content_tag(:div, class: "email-url-number") do
+              content_tag(:ul, class: "content-block__list") do
                 concat email
-                concat render_govspeak(item[:description]) if item[:description].present?
+                concat description if item[:description].present?
               end
             end
           end
 
           def email
-            content_tag(:p) do
+            content_tag(:li) do
               concat content_tag(:a,
                                  link_text,
-                                 class: "email",
+                                 class: "email content-block__link",
                                  href: "mailto:#{item[:email_address]}#{query_params}")
             end
           end
@@ -37,6 +37,12 @@ module ContentBlockTools
           def link_text
             item[:label] || item[:email_address]
           end
+
+          def description
+            content_tag(:li) do
+              render_govspeak(item[:description])
+            end
+          end
         end
       end
     end

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

@@ -9,8 +9,8 @@ module ContentBlockTools
 
           def render
             wrapper do
-              content_tag(:div, class: "email-url-number") do
-                concat title_and_description
+              content_tag(:div) do
+                concat description if item[:description].present?
                 concat number_list
                 concat video_relay_service
                 concat bsl_details
@@ -20,29 +20,12 @@ module ContentBlockTools
             end
           end
 
-          def title_and_description
-            items = [
-              (item_title if item[:title].present?),
-              (description if item[:description].present?),
-            ].compact
-
-            if items.any?
-              content_tag(:div, class: "govuk-!-margin-bottom-3") do
-                concat items.join("").html_safe
-              end
-            end
-          end
-
-          def item_title
-            content_tag(:p, item[:title], { class: "govuk-!-margin-bottom-0" })
-          end
-
           def description
-            render_govspeak(item[:description], root_class: "govuk-!-margin-top-1 govuk-!-margin-bottom-0")
+            render_govspeak(item[:description], root_class: "content-block__body")
           end
 
           def number_list
-            content_tag(:ul) do
+            content_tag(:ul, class: "content-block__list") do
               item[:telephone_numbers].each do |number|
                 concat number_list_item(number)
               end
@@ -51,7 +34,7 @@ module ContentBlockTools
 
           def number_list_item(number)
             content_tag(:li) do
-              concat content_tag(:span, number[:label])
+              concat content_tag(:span, "#{number[:label]}: ")
               concat content_tag(:span, number[:telephone_number], { class: "tel" })
             end
           end
@@ -61,20 +44,20 @@ module ContentBlockTools
 
             if video_relay_service[:show]
               content = "#{video_relay_service[:prefix]} #{video_relay_service[:telephone_number]}"
-              render_govspeak(content, root_class: "govuk-!-margin-bottom-0")
+              render_govspeak(content, root_class: "content-block__body")
             end
           end
 
           def bsl_details
             bsl_guidance = item[:bsl_guidance] || {}
 
-            render_govspeak(bsl_guidance[:value], root_class: "govuk-!-margin-bottom-0") if bsl_guidance[:show]
+            render_govspeak(bsl_guidance[:value], root_class: "content-block__body") if bsl_guidance[:show]
           end
 
           def opening_hours
             opening_hours = item[:opening_hours] || {}
 
-            render_govspeak(opening_hours[:opening_hours], root_class: "govuk-!-margin-bottom-0") if opening_hours[:show_opening_hours]
+            render_govspeak(opening_hours[:opening_hours], root_class: "content-block__body") if opening_hours[:show_opening_hours]
           end
 
           def opening_hours_list_item(item)
@@ -88,7 +71,7 @@ module ContentBlockTools
               content_tag(:p) do
                 concat content_tag(:a,
                                    call_charges[:label],
-                                   class: "govuk-link",
+                                   class: "content-block__link",
                                    href: call_charges[:call_charges_info_url])
               end
             end

data/lib/content_block_tools/presenters/contact_presenter.rb

@@ -22,16 +22,12 @@ module ContentBlockTools
     private
 
       def default_content
-        content_tag(:div, class: "contact") do
-          content_tag(:div, class: "content") do
-            content_tag(:div, class: "vcard contact-inner") do
-              concat content_tag(:p, content_block.title, class: "fn org")
-              concat render_govspeak(content_block.details[:description]) if content_block.details[:description]
-              embedded_objects.each do |object|
-                items = send(object)
-                concat(items.map { |item| presenter_for_object_type(object).new(item, content_block:).render }.join.html_safe)
-              end
-            end
+        content_tag(:div, class: "vcard") do
+          concat content_tag(:p, content_block.title, class: "fn org content-block__title")
+          concat render_govspeak(content_block.details[:description]) if content_block.details[:description]
+          embedded_objects.each do |object|
+            items = send(object)
+            concat(items.map { |item| presenter_for_object_type(object).new(item, content_block:).render }.join.html_safe)
           end
         end
       end

data/lib/content_block_tools/version.rb

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

data/lib/content_block_tools.rb

@@ -22,6 +22,8 @@ require "content_block_tools/presenters/pension_presenter"
 require "content_block_tools/content_block"
 require "content_block_tools/content_block_reference"
 
+require "content_block_tools/engine"
+
 require "content_block_tools/version"
 
 module ContentBlockTools
@@ -35,12 +37,4 @@ module ContentBlockTools
       @logger ||= Logger.new($stdout)
     end
   end
-
-  if defined?(Rails::Railtie)
-    class Railtie < Rails::Railtie
-      initializer "content_block_tools.initialize_logger" do
-        ContentBlockTools.logger = Rails.logger
-      end
-    end
-  end
 end

data/package-lock.json

@@ -0,0 +1,22 @@
+{
+  "name": "content_block_tools",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "content_block_tools",
+      "license": "MIT",
+      "dependencies": {
+        "govuk-frontend": "^5.11.1"
+      }
+    },
+    "node_modules/govuk-frontend": {
+      "version": "5.11.1",
+      "resolved": "https://registry.npmjs.org/govuk-frontend/-/govuk-frontend-5.11.1.tgz",
+      "integrity": "sha512-hJJFpaer4MZLvz/2F9RZ7xZ6FqlzpxL9aw6YWOGK3F1tn419xj2WcVXwOC8Bcj/dc/LanknbWJDGkb+IdkuhTQ==",
+      "engines": {
+        "node": ">= 4.2.0"
+      }
+    }
+  }
+}

data/package.json

@@ -0,0 +1,9 @@
+{
+  "private": true,
+  "name": "content_block_tools",
+  "description": "A suite of tools for working with GOV.UK Content Blocks",
+  "license": "MIT",
+  "dependencies": {
+    "govuk-frontend": "^5.11.1"
+  }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: content_block_tools
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 1.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
@@ -113,12 +113,15 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/assets/stylesheets/blocks/_contact.scss
+- app/assets/stylesheets/content_block_tools.scss
 - bin/console
 - bin/setup
 - content_block_tools.gemspec
 - lib/content_block_tools.rb
 - lib/content_block_tools/content_block.rb
 - lib/content_block_tools/content_block_reference.rb
+- lib/content_block_tools/engine.rb
 - lib/content_block_tools/helpers/govspeak.rb
 - lib/content_block_tools/presenters/base_presenter.rb
 - lib/content_block_tools/presenters/block_presenters/base_presenter.rb
@@ -132,6 +135,8 @@ files:
 - lib/content_block_tools/presenters/field_presenters/contact/email_address_presenter.rb
 - lib/content_block_tools/presenters/pension_presenter.rb
 - lib/content_block_tools/version.rb
+- package-lock.json
+- package.json
 homepage: https://github.com/alphagov/content_block_tools
 licenses:
 - MIT