content_block_tools 0.17.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4c641c9036c389a69525715b7e71149166f7511ab1de92f4c15ad95b16d62dd
-  data.tar.gz: a607de42bbe8f3b0fe1906d46743e1f73486ea792b1a2cb1374084afa398f4f5
+  metadata.gz: 303ef0531bd34af3c6fed983f6499fb92ae8d7fec11c24de52100c98d69df522
+  data.tar.gz: 8f67a22466a4f793841c531ddbf2d327edb6e101b83cf2d06cd8e17fd016597d
 SHA512:
-  metadata.gz: d711299258a6a6156ba85240bc67143989ace9485999bc41f6e45510294a61418622bfa329eaf6f8b2f693b2a816008cdffaf53e899660e8ba63d8fc8f043bee
-  data.tar.gz: a83c41c21a95b2f35c67a2be4ceead0ff6c1fe5d11e3993fa902456063667c519b9750f45175a0306627980581a9d55bda1b24a8b27a0b6bb8b04bb80bd0234c
+  metadata.gz: be10abe78f1cb2f27c5654b825c1e21f7f438989192ca8074bfd2f83df9b5473631364be9921e04335b1e279769ad0d68157a63a9fc084972e6fa40327f73d33
+  data.tar.gz: fffde505300407592077524618116174b5872395e4abcd78ef5ee43daf619f50d2217588fc6e309d5fa1c5a1fa56e89b0f6e621d7ce83f98be945f8ff8712b84

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,7 +11,7 @@ module ContentBlockTools
             wrapper do
               output = []
 
-              output << content_tag(:p, class: "adr") do
+              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?
 
@@ -35,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.17.0"
+  VERSION = "1.0.1"
 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/node_modules/govuk-frontend/README.md

@@ -0,0 +1,92 @@
+# GOV.UK Frontend
+
+GOV.UK Frontend contains the code you need to start building a user interface
+for government platforms and services.
+
+See live examples of GOV.UK Frontend components, and guidance on when to use
+them in your service, in the [GOV.UK Design System](https://www.gov.uk/design-system).
+
+## Contact the team
+
+GOV.UK Frontend is maintained by a team at Government Digital Service. If you want to know more about GOV.UK Frontend, please email the [Design System
+team](mailto:govuk-design-system-support@digital.cabinet-office.gov.uk) or get in touch with them on [Slack](https://ukgovernmentdigital.slack.com/messages/govuk-design-system).
+
+## Quick start
+
+There are 2 ways to start using GOV.UK Frontend in your app.
+
+Once installed, you will be able to use the code from the examples in the
+[GOV.UK Design System](https://www.gov.uk/design-system) in your service.
+
+### 1. Install with npm (recommended)
+
+We recommend [installing GOV.UK Frontend using node package manager
+(npm)](https://frontend.design-system.service.gov.uk/installing-with-npm/).
+
+### 2. Install by using compiled files
+
+You can also [download the compiled and minified assets (CSS, JavaScript) from
+GitHub](https://frontend.design-system.service.gov.uk/installing-from-dist/).
+
+## Importing styles
+
+You need to import the GOV.UK Frontend styles into the main Sass file in your
+project. You should place the below code before your own Sass rules (or Sass
+imports) if you want to override GOV.UK Frontend with your own styles.
+
+To import add the below to your Sass file:
+
+```scss
+@import "node_modules/govuk-frontend/dist/govuk/all";
+```
+
+[More details on importing styles](https://frontend.design-system.service.gov.uk/importing-css-assets-and-javascript/#css)
+
+## Importing JavaScript
+
+Some of the JavaScript included in GOV.UK Frontend improves the usability and
+accessibility of the components. You should make sure that you are importing and
+initialising JavaScript in your application. This will ensure all users can use it successfully.
+
+You can include JavaScript for all components by copying both `govuk-frontend.min.js` and `govuk-frontend.min.js.map` from `node_modules/govuk-frontend/dist/govuk/` into your application and referencing the JavaScript directly:
+
+```html
+<script type="module" src="{path-to-javascript}/govuk-frontend.min.js"></script>
+```
+
+Next you need to import and initialise GOV.UK Frontend by adding:
+
+```html
+<script type="module">
+  import { initAll } from '{path-to-javascript}/govuk-frontend.min.js'
+  initAll()
+</script>
+```
+
+[More details on importing JavaScript and advanced options](https://frontend.design-system.service.gov.uk/importing-css-assets-and-javascript/#javascript)
+
+## Importing assets
+
+In order to import GOV.UK Frontend images and fonts to your project, you should configure your application to reference or copy the relevant GOV.UK Frontend assets.
+
+[More details on importing assets](https://frontend.design-system.service.gov.uk/importing-css-assets-and-javascript/#font-and-image-assets)
+
+## Getting updates
+
+To be notified when there’s a new release, you can either:
+
+- [watch the govuk-frontend Github repository](https://help.github.com/en/articles/watching-and-unwatching-repositories)
+- join the [#govuk-design-system channel on cross-government Slack](https://ukgovernmentdigital.slack.com/app_redirect?channel=govuk-design-system)
+
+Find out how to [update with npm](https://frontend.design-system.service.gov.uk/updating-with-npm/).
+
+## Licence
+
+Unless stated otherwise, the codebase is released under the MIT License. This
+covers both the codebase and any sample code in the documentation. The
+documentation is &copy; Crown copyright and available under the terms of the
+Open Government 3.0 licence.
+
+## Contribution guidelines
+
+If you want to help us build GOV.UK Frontend, view our [contribution guidelines](/CONTRIBUTING.md).

data/node_modules/govuk-frontend/dist/govuk/_base.scss

@@ -0,0 +1,5 @@
+@import "settings/index";
+@import "tools/index";
+@import "helpers/index";
+
+/*# sourceMappingURL=_base.scss.map */

data/node_modules/govuk-frontend/dist/govuk/_base.scss.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/govuk/_base.scss"],"names":[],"mappings":"AAAA,wBAAwB;AACxB,qBAAqB;AACrB,uBAAuB","file":"_base.scss","sourcesContent":["@import \"settings/index\";\n@import \"tools/index\";\n@import \"helpers/index\";\n"]}