design_system 0.13.2 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b15fc1d9069ff953d3c5baf06ed285124f3180a8f94f1d87f833e775f503a6b6
-  data.tar.gz: 3c0bef7989f9c981c1fbbcd7f70fbd975fc066bdc9d28eba2105f8b3f68876fa
+  metadata.gz: e985fe0cfcfbfc619222a57c2501acff5e4172e0eb8b3767069c0f1f66f8541d
+  data.tar.gz: 72436a314d93ae0f3f35089969cb0e2a1524c156373dedbd059112e11340a1be
 SHA512:
-  metadata.gz: 470212f3e39cb92659245dea5de02e076dde7850da074aa285bf12ea4931a318f056eba3385297d540cd9a3a2ee52edba5966528e89d2c76faab808ca107b952
-  data.tar.gz: 93d919f3d60f766ef8fb9e3d5fd0dddc3ed8407364e2b5336a55dc9c7dbaf6902b1f25be633bd1cc2c9398a923a2e793fcd39fe17150f6e8c9416d9fb004f673
+  metadata.gz: e9eeff12697761fdf1542041c31b4b85acdfc29bd01682da6cb06a3a711482ed532271837328faf7ee2f2cd552349a73d481e7a6f5717a2207d267584e6ddc14
+  data.tar.gz: 7c19fed7bbfee92c6e585615bfb8d956d1ac8ff38c2938b32d634dac0125084a3756b43d5cc81c143491c5eeae62f7320705bfab6d283ae88fb791099315691b

data/README.md

@@ -80,7 +80,40 @@ bundle exec rake js:build
 
 ## Contributing
 
-Contribution directions go here.
+### Setting up
+
+This project uses [mise](https://mise.jdx.dev/) to manage Ruby. With mise installed, run `mise install` from the project root to install the Ruby version pinned in `.ruby-version`. Then install the gems:
+
+```bash
+bundle install
+```
+
+To run the dummy app or the accessibility workflows locally, also install the dummy app's Node packages:
+
+```bash
+cd test/dummy && npm install
+```
+
+### Running the tests
+
+```bash
+bin/rails test
+```
+
+The suite runs against the dummy app at `test/dummy`. On a fresh checkout the test helper compiles Dart Sass automatically on the first run; subsequent runs are fast.
+
+### Running the dummy app
+
+```bash
+cd test/dummy
+bin/dev
+```
+
+This starts the Rails server alongside `dartsass:watch`, so styles rebuild as you edit.
+
+### CI
+
+`bin/rails test` runs on every push and pull request via the `Test` workflow. Accessibility (`wcag2aa`, `wcag2aaa`) and inclusive-language checks run separately.
 
 Created using:
 

data/app/helpers/design_system_helper.rb

@@ -78,8 +78,8 @@ module DesignSystemHelper
     DesignSystem::Registry.builder(brand, 'notification', self).render_alert(message, &)
   end
 
-  def ds_notice(message = nil, header: nil, type: :information, &)
-    DesignSystem::Registry.builder(brand, 'notification', self).render_notice(message, header:, type:, &)
+  def ds_notice(message = nil, type: :information, content_heading: { text: nil, tag: :h3 }, &)
+    DesignSystem::Registry.builder(brand, 'notification', self).render_notice(message, type:, content_heading:, &)
   end
 
   def ds_heading(text, level: 2, **options)

data/lib/design_system/generic/builders/notification.rb

@@ -5,6 +5,7 @@ module DesignSystem
     module Builders
       # This class provides generic methods to display notifications.
       class Notification < Base
+        include ActionView::Helpers::OutputSafetyHelper
         include ActionView::Helpers::SanitizeHelper
 
         def render_alert(msg = nil, &)
@@ -16,19 +17,22 @@ module DesignSystem
           end
         end
 
-        def render_notice(msg = nil, header: nil, type: :information, &)
+        def render_notice(msg = nil, type: :information, content_heading: { text: nil, tag: :h3 }, &)
           @context.instance_variable_set(:@link_context, :notification_banner)
 
-          raise ArgumentError,
-                "Invalid notification type: #{type}. Must be one of: #{notification_type_hash.keys.join(', ')}" unless notification_type_hash.key?(type)
+          unless notification_type_hash.key?(type)
+            raise ArgumentError,
+                  "Invalid notification type: #{type}. Must be one of: #{notification_type_hash.keys.join(', ')}"
+          end
 
-          header ||= notification_type_hash.dig(type, :header)
+          header = notification_type_hash.dig(type, :header)
+
+          content_body = block_given? ? capture(&) : msg
 
-          content_to_display = block_given? ? capture(&) : msg
           content_tag(:div, class: notification_type_hash.dig(type, :class), role: notification_type_hash.dig(type, :role),
                             'aria-labelledby': "#{brand}-notification-banner-title",
                             'data-module': "#{brand}-notification-banner") do
-            banner_tile(header) + banner_content(content_to_display)
+            banner_tile(header) + banner_content(content_body, content_heading:)
           end
         end
 
@@ -41,10 +45,19 @@ module DesignSystem
           end
         end
 
-        def banner_content(content)
+        def banner_content(content_body, content_heading: {})
           content_tag(:div, class: "#{brand}-notification-banner__content") do
-            content_tag(:p, content,
-                        class: "#{brand}-notification-banner__heading")
+            content = []
+
+            if content_heading.present? && content_heading[:text].present?
+              tag = content_heading[:tag] || :h3
+              raise ArgumentError, "Invalid content_heading tag: #{tag}.}" unless tag.in?(%i[h3 p])
+
+              content << content_tag(tag, content_heading[:text], class: "#{brand}-notification-banner__heading")
+            end
+            content << content_body if content_body.present?
+
+            safe_join(content)
           end
         end
 

data/lib/design_system/version.rb

@@ -1,3 +1,3 @@
 module DesignSystem
-  VERSION = '0.13.2'.freeze
+  VERSION = '0.14.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: design_system
 version: !ruby/object:Gem::Version
-  version: 0.13.2
+  version: 0.14.0
 platform: ruby
 authors:
 - Filis Liu
@@ -479,7 +479,7 @@ files:
 - lib/tasks/design_system_tasks.rake
 - lib/tasks/govuk.rake
 - lib/tasks/nhsuk.rake
-- public/design_system/static/design_system-0.13.2/design_system.js
+- public/design_system/static/design_system-0.14.0/design_system.js
 - public/design_system/static/govuk-frontend-5.11.1/fonts/bold-affa96571d-v2.woff
 - public/design_system/static/govuk-frontend-5.11.1/fonts/bold-b542beb274-v2.woff2
 - public/design_system/static/govuk-frontend-5.11.1/fonts/light-94a07e06a1-v2.woff2