govuk_publishing_components 37.10.0 → 38.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88e7235efad66b3b4e58b76104ee17ffd0df45709e3a0ead2d21b3349af45514
-  data.tar.gz: 70a11adff6bea43df88c5b10bf9d0ab0934510d8a57ec7f621c50e0006e689a6
+  metadata.gz: c89df118a20566897a0947dfdea96b3be4a5347a3bff830912da9e394791d45a
+  data.tar.gz: 8d5d30cd4cb99db7bd2b5519b99c69fb8fa0c371d67d1dc79a5890cf600dbac8
 SHA512:
-  metadata.gz: 750feab9da7c02d5fd72d55e9b40a027d02000656a987316974a282dc4357832a3600670826b9a80dac4c64a087f18acc97eacab3573879e3ba46148f5b5bf08
-  data.tar.gz: db8c5538ef83cb50bcf37e11e6e5693a8995da9a2deda172dfc9591eb10a1d77c5ed54b65ecf62fab5d4233146a201556f1eb9280a37a9be693e30a94ca44297
+  metadata.gz: f92f9b333fc2535612e8da32cfe88965b5823c187db89ef9e550675164ad6441f22f064547f12b60b0032096273b8723932529228f2b7809173bf997cad4a38e
+  data.tar.gz: 86e8ad6321c63542a83157deee841a4cf4ff4ac2d2d053484ccc4ee838b10ce457014f3124797f802dccce5123847598d02df4770133867c097e3836e166478a

data/README.md

@@ -4,50 +4,64 @@
 [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 [![Stylelint Style Guide](https://img.shields.io/badge/code_style-stylelint-brightgreen.svg)](https://github.com/alphagov/stylelint-config-gds/)
 
-A Ruby gem to document and distribute components for GOV.UK applications. It provides:
+govuk_publishing_components is a Ruby gem to document and distribute components for GOV.UK applications. It provides:
 
 - a shared library of components
 - helpers to generate component payloads
 - an application to preview components and provide guidance
 - [GOV.UK Design System](https://design-system.service.gov.uk/) styles and components (via [GOV.UK Frontend](https://github.com/alphagov/govuk-frontend))
 
-Components should be added to this gem if they are required in more than one application, otherwise they should be added to that application. All components should meet the same standards of browser and assistive technology support described in [GOV.UK Frontend](https://github.com/alphagov/govuk-frontend#browser-and-assistive-technology-support).
+Only add a component to this gem if it is required in more than one application. Please do not add application-specific components to govuk_publishing_components.
+
+All components should meet the accessibility standards for browser and assistive technology support described in [GOV.UK Frontend](https://github.com/alphagov/govuk-frontend#browser-and-assistive-technology-support).
 
 ## Technical documentation
 
-You can use the [GOV.UK Docker environment](https://github.com/alphagov/govuk-docker) or the local `startup.sh` script to run the app. Read the [guidance on local frontend development](https://docs.publishing.service.gov.uk/manual/local-frontend-development.html) to find out more about each approach, before you get started.
+### Run the application
+
+```sh
+./startup.sh
+```
 
-If you are using GOV.UK Docker, remember to combine it with the commands that follow. See the [GOV.UK Docker usage instructions](https://github.com/alphagov/govuk-docker#usage) for examples.
+See also [Local frontend development](https://docs.publishing.service.gov.uk/manual/local-frontend-development.html).
 
-### Running the test suite
+### Run the test suite
 
 ```sh
+bundle install
+yarn install
 bundle exec rake
 ```
 
-To run JavaScript tests (only):
+### Run the JavaScript tests alone
 
-```sh
-# run JS tests in browser
-yarn run jasmine:browser
+With text-only output to the terminal:
 
-# run JS tests on command line
+```sh
 yarn run jasmine:ci
 ```
 
-### Using the gem
+With output viewable in a browser at <http://localhost:8888/>:
+
+```sh
+yarn run jasmine:browser
+```
+
+You need to restart the `jasmine:browser` test server for it to pick up any changes to JavaScript code.
+
+### Use the gem
 
 - [Install and use this gem](docs/install-and-use.md)
 - [Use a component in your application](docs/use-components.md)
 - [Test a branch of the gem](docs/test-a-branch-of-the-gem.md)
 
-### Managing the gem
+### Manage the gem
 
 - [Publish/release a new version of the gem](docs/publishing-to-rubygems.md)
 - [Keep this gem in sync with the Design System](docs/upgrade-govuk-frontend.md)
 - [Move a component from an application to the gem](docs/moving-components-upstream-into-this-gem.md)
 
-### Making components
+### Make a new component
 
 - [Generate a new component](docs/generate-a-new-component.md)
 - [Component conventions](docs/component_conventions.md)
@@ -55,12 +69,12 @@ yarn run jasmine:ci
 
 ### Further documentation
 
-- [Testing a component](docs/testing-components.md)
+- [Test a component](docs/testing-components.md)
 - [Component auditing](docs/auditing.md)
 - [Code documentation on rubydoc.info](http://www.rubydoc.info/gems/govuk_publishing_components)
 - [Our analytics approach](docs/analytics-ga4/analytics.md)
 
-More documentation can be found in the [docs directory](docs/).
+There is more documentation in the [docs directory](docs/).
 
 ## Licence
 

data/app/assets/config/govuk_publishing_components_sassc-rails_manifest.js

@@ -73,7 +73,6 @@
 //= link govuk_publishing_components/components/_search.css
 //= link govuk_publishing_components/components/_select.css
 //= link govuk_publishing_components/components/_share-links.css
-//= link govuk_publishing_components/components/_show-password.css
 //= link govuk_publishing_components/components/_signup-link.css
 //= link govuk_publishing_components/components/_single-page-notification-button.css
 //= link govuk_publishing_components/components/_skip-link.css

data/app/assets/stylesheets/govuk_publishing_components/_all_components.scss

@@ -70,7 +70,6 @@ $govuk-new-link-styles: true;
 @import "components/search";
 @import "components/select";
 @import "components/share-links";
-@import "components/show-password";
 @import "components/signup-link";
 @import "components/single-page-notification-button";
 @import "components/skip-link";

data/app/models/govuk_publishing_components/component_docs.rb

@@ -45,9 +45,7 @@ module GovukPublishingComponents
     end
 
     def parse_documentation(file)
-      # Psych 4's YAML.unsafe_load_file === Psych 3's YAML.load_file
-      # but until we drop support for Ruby 2.7 and Ruby 3.0, we need to support both major versions of Psych
-      yaml = YAML.respond_to?(:unsafe_load_file) ? YAML.unsafe_load_file(file) : YAML.load_file(file)
+      yaml = YAML.load_file(file, aliases: true, permitted_classes: [Symbol, Time])
       { id: File.basename(file, ".yml") }.merge(yaml).with_indifferent_access
     end
 

data/app/views/govuk_publishing_components/components/_layout_super_navigation_header.html.erb

@@ -350,11 +350,22 @@
           </h3>
           <div class="govuk-grid-row">
             <div class="govuk-grid-column-full">
+              <%
+                form_attributes = {
+                  event_name: "search",
+                  type: "header menu bar",
+                  section: "Search GOV.UK",
+                  action: "search",
+                  url: "/search/all",
+                  index_section: 3,
+                  index_section_count: 3,
+                }.to_json
+              %>
               <form
                 class="gem-c-layout-super-navigation-header__search-form"
                 id="search"
                 data-module="ga4-form-tracker"
-                data-ga4-form='{ "event_name": "search", "type": "header menu bar", "section": "Search GOV.UK", "action": "search", "url": "/search/all" }'
+                data-ga4-form="<%= form_attributes %>"
                 data-ga4-form-include-text
                 data-ga4-form-no-answer-undefined
                 action="<%= absolute_links_helper.make_url_absolute('/search') %>"

data/app/views/govuk_publishing_components/components/docs/contextual_footer.yml

@@ -22,16 +22,13 @@ examples:
       content_item:
         title: "A content item"
         links:
-          topics:
+          mainstream_browse_pages:
           - title: Apprenticeships, 14 to 19 education and training for work
             base_path: /browse/education/find-course
-            document_type: topic
+            document_type: mainstream_browse_page
           - title: Finding a job
             base_path: /browse/working/finding-job
-            document_type: topic
-          - title: Apprenticeships
-            base_path: /topic/further-education-skills/apprenticeships
-            document_type: topic
+            document_type: mainstream_browse_page
           topical_events:
           - title: UK-China High-Level People to People Dialogue 2017
             base_path: /government/topical-events/uk-china-high-level-people-to-people-dialogue-2017
@@ -76,16 +73,13 @@ examples:
       content_item:
         title: "A content item"
         links:
-          topics:
+          mainstream_browse_pages:
           - title: Apprenticeships, 14 to 19 education and training for work
             base_path: /browse/education/find-course
-            document_type: topic
+            document_type: mainstream_browse_page
           - title: Finding a job
             base_path: /browse/working/finding-job
-            document_type: topic
-          - title: Apprenticeships
-            base_path: /topic/further-education-skills/apprenticeships
-            document_type: topic
+            document_type: mainstream_browse_page
           topical_events:
           - title: UK-China High-Level People to People Dialogue 2017
             base_path: /government/topical-events/uk-china-high-level-people-to-people-dialogue-2017

data/app/views/govuk_publishing_components/components/docs/related_navigation.yml

@@ -19,20 +19,6 @@ examples:
               base_path: /training-study-work-your-rights
             - title: Careers helpline for teenagers
               base_path: /careers-helpline-for-teenagers
-  with_curated_topics:
-    data:
-      content_item:
-        links:
-          topics:
-            - title: Apprenticeships, 14 to 19 education and training for work
-              base_path: /browse/education/find-course
-              document_type: topic
-            - title: Finding a job
-              base_path: /browse/working/finding-job
-              document_type: topic
-            - title: Apprenticeships
-              base_path: /topic/further-education-skills/apprenticeships
-              document_type: topic
   with_mainstream_browse_pages:
     data:
       content_item:
@@ -53,24 +39,8 @@ examples:
             base_path: /transport/driving-instruction-and-driving-lessons
             phase: live
             document_type: taxon
-  with_curated_topics_and_mainstream_browse_pages:
-    description: Currated topics and mainstream browse pages are combined.
-    data:
-      content_item:
-        links:
-          mainstream_browse_pages:
-          - title: Driving licences
-            base_path: /browse/driving/driving-licences
-            document_type: mainstream_browse_page
-          - title: Driving tests and learning to drive or ride
-            base_path: /browse/driving/learning-to-drive
-            document_type: mainstream_browse_page
-          topics:
-          - title: Cars
-            base_path: /topic/driving-tests-and-learning-to-drive/car
-            document_type: topic
-  with_curated_topics_and_mainstream_browse_pages_and_taxons:
-    description: Currated topics and mainstream browse pages take precedence over the sidewide topic taxonomy.
+  with_mainstream_browse_pages_and_taxons:
+    description: Mainstream browse pages take precedence over the sidewide topic taxonomy.
     data:
       content_item:
         links:
@@ -86,10 +56,6 @@ examples:
             base_path: /transport/driving-instruction-and-driving-lessons
             phase: live
             document_type: taxon
-          topics:
-          - title: Cars
-            base_path: /topic/driving-tests-and-learning-to-drive/car
-            document_type: topic
   with_collections:
     data:
       content_item:
@@ -218,7 +184,7 @@ examples:
             - title: Find an apprenticeship (French)
               base_path: /apply-apprenticeship.fr
               locale: fr
-          topics:
+          mainstream_browse_pages:
             - title: Apprenticeships, 14 to 19 education and training for work (Korean)
               base_path: /browse/education/find-course.ko
               document_type: topic
@@ -263,16 +229,13 @@ examples:
               base_path: /training-study-work-your-rights
             - title: Careers helpline for teenagers
               base_path: /careers-helpline-for-teenagers
-          topics:
+          mainstream_browse_pages:
             - title: Apprenticeships, 14 to 19 education and training for work
               base_path: /browse/education/find-course
-              document_type: topic
+              document_type: mainstream_browse_page
             - title: Finding a job
               base_path: /browse/working/finding-job
-              document_type: topic
-            - title: Apprenticeships
-              base_path: /topic/further-education-skills/apprenticeships
-              document_type: topic
+              document_type: mainstream_browse_page
           topical_events:
             - title: UK-China High-Level People to People Dialogue 2017
               base_path: /government/topical-events/uk-china-high-level-people-to-people-dialogue-2017
@@ -319,16 +282,13 @@ examples:
               base_path: /training-study-work-your-rights
             - title: Careers helpline for teenagers
               base_path: /careers-helpline-for-teenagers
-          topics:
+          mainstream_browse_pages:
             - title: Apprenticeships, 14 to 19 education and training for work
               base_path: /browse/education/find-course
-              document_type: topic
+              document_type: mainstream_browse_page
             - title: Finding a job
               base_path: /browse/working/finding-job
-              document_type: topic
-            - title: Apprenticeships
-              base_path: /topic/further-education-skills/apprenticeships
-              document_type: topic
+              document_type: mainstream_browse_page
           topical_events:
             - title: UK-China High-Level People to People Dialogue 2017
               base_path: /government/topical-events/uk-china-high-level-people-to-people-dialogue-2017

data/config/locales/ar.yml

@@ -181,13 +181,6 @@ ar:
     share_links:
       all_opens_in_new_tab:
       opens_in_new_tab:
-    show_password:
-      announce_hide: كلمة مرورك مخفيَّة
-      announce_show: كلمة مرورك معروضة
-      hide: إخفاء
-      hide_password: إخفاء كلمة المرور
-      show: إظهار
-      show_password: إظهار كلمة المرور
     single_page_notification_button:
       subscribe_text:
       unsubscribe_text:

data/config/locales/az.yml

@@ -178,13 +178,6 @@ az:
     share_links:
       all_opens_in_new_tab:
       opens_in_new_tab:
-    show_password:
-      announce_hide: Şifrəniz gizlədilib
-      announce_show: Şifrəniz göstərilir
-      hide: Gizlət
-      hide_password: Şifrəni gizlət
-      show: Göstər
-      show_password: Şifrəni göstər
     single_page_notification_button:
       subscribe_text:
       unsubscribe_text:

data/config/locales/be.yml

@@ -184,13 +184,6 @@ be:
     share_links:
       all_opens_in_new_tab:
       opens_in_new_tab:
-    show_password:
-      announce_hide: Ваш пароль схаваны
-      announce_show: Ваш пароль адлюстроўваецца
-      hide: Схаваць
-      hide_password: Схаваць пароль
-      show: Паказаць
-      show_password: Адлюстраваць пароль
     single_page_notification_button:
       subscribe_text:
       unsubscribe_text:

data/config/locales/bg.yml

@@ -182,13 +182,6 @@ bg:
     share_links:
       all_opens_in_new_tab:
       opens_in_new_tab:
-    show_password:
-      announce_hide: Вашата парола е скрита
-      announce_show: Вашата парола е видима
-      hide: Скриване
-      hide_password: Скриване на паролата
-      show: Показване
-      show_password: Показване на паролата
     single_page_notification_button:
       subscribe_text:
       unsubscribe_text:

data/config/locales/bn.yml

@@ -179,13 +179,6 @@ bn:
     share_links:
       all_opens_in_new_tab:
       opens_in_new_tab:
-    show_password:
-      announce_hide: আপনার পাসওয়ার্ড লুকানো
-      announce_show: আপনার পাসওয়ার্ড দেখানো হয়েছে
-      hide: লুকিয়ে রাখুন
-      hide_password: পাসওয়ার্ড লুকিয়ে রাখুন
-      show: দেখান
-      show_password: পাসওয়ার্ড প্রদর্শন করুন
     single_page_notification_button:
       subscribe_text:
       unsubscribe_text:

data/config/locales/cs.yml

@@ -183,13 +183,6 @@ cs:
     share_links:
       all_opens_in_new_tab:
       opens_in_new_tab:
-    show_password:
-      announce_hide: Vaše heslo je skryté
-      announce_show: Zobrazí se vaše heslo
-      hide: Skrýt
-      hide_password: Skrýt heslo
-      show: Zobrazit
-      show_password: Zobrazit heslo
     single_page_notification_button:
       subscribe_text:
       unsubscribe_text:

data/config/locales/cy.yml

@@ -182,13 +182,6 @@ cy:
     share_links:
       all_opens_in_new_tab: Bydd rhannu yn agor y dudalen hon mewn tab newydd
       opens_in_new_tab:
-    show_password:
-      announce_hide: Mae eich cyfrinair wedi'i guddio
-      announce_show: Mae eich cyfrinair yn cael ei ddangos
-      hide: Cuddio
-      hide_password: Cuddio'r cyfrinair
-      show: Dangos
-      show_password: Dangos y cyfrinair
     single_page_notification_button:
       subscribe_text:
       unsubscribe_text:

data/config/locales/da.yml

@@ -179,13 +179,6 @@ da:
     share_links:
       all_opens_in_new_tab:
       opens_in_new_tab:
-    show_password:
-      announce_hide: Din adgangskode er skjult
-      announce_show: Din adgangskode vises
-      hide: Skjul
-      hide_password: skjul adgangskode
-      show: Vise
-      show_password: Skjul adgangskode
     single_page_notification_button:
       subscribe_text:
       unsubscribe_text:

data/config/locales/de.yml

@@ -182,13 +182,6 @@ de:
     share_links:
       all_opens_in_new_tab:
       opens_in_new_tab:
-    show_password:
-      announce_hide: Ihr Passwort ist ausgeblendet
-      announce_show: Ihr Passwort ist eingeblendet
-      hide: Ausblenden
-      hide_password: Passwort ausblenden
-      show: Anzeigen
-      show_password: Passwort anzeigen
     single_page_notification_button:
       subscribe_text:
       unsubscribe_text:

data/config/locales/dr.yml

@@ -180,13 +180,6 @@ dr:
     share_links:
       all_opens_in_new_tab:
       opens_in_new_tab:
-    show_password:
-      announce_hide: رمز عبور شما مخفی شده است
-      announce_show: رمز عبور شما نشان داده شده است
-      hide: مخفی کردن
-      hide_password: رمز عبور را مخفی نمایید
-      show: نمایش دهید
-      show_password: رمز عبور را نمایش دهید
     single_page_notification_button:
       subscribe_text:
       unsubscribe_text:

data/config/locales/el.yml

@@ -178,13 +178,6 @@ el:
     share_links:
       all_opens_in_new_tab:
       opens_in_new_tab:
-    show_password:
-      announce_hide: Ο κωδικός πρόσβασής σας είναι κρυμμένος
-      announce_show: Ο κωδικός πρόσβασής σας εμφανίζεται
-      hide: Απόκρυψη
-      hide_password: Απόκρυψη κωδικού πρόσβασης
-      show: Εμφάνιση
-      show_password: Εμφάνιση κωδικού πρόσβασης
     single_page_notification_button:
       subscribe_text:
       unsubscribe_text:

data/config/locales/en.yml

@@ -293,13 +293,6 @@ en:
     share_links:
       all_opens_in_new_tab: The following links open in a new tab
       opens_in_new_tab: "(opens in new tab)"
-    show_password:
-      announce_hide: Your password is hidden
-      announce_show: Your password is shown
-      hide: Hide
-      hide_password: Hide password
-      show: Show
-      show_password: Show password
     single_page_notification_button:
       subscribe_text: Get emails about this page
       unsubscribe_text: Stop getting emails about this page

data/config/locales/es-419.yml

@@ -178,13 +178,6 @@ es-419:
     share_links:
       all_opens_in_new_tab:
       opens_in_new_tab:
-    show_password:
-      announce_hide: Su contraseña está oculta
-      announce_show: Se muestra su contraseña
-      hide: Ocultar
-      hide_password: Ocultar contraseña
-      show: Mostrar
-      show_password: Mostrar contraseña
     single_page_notification_button:
       subscribe_text:
       unsubscribe_text:

data/config/locales/es.yml

@@ -178,13 +178,6 @@ es:
     share_links:
       all_opens_in_new_tab:
       opens_in_new_tab:
-    show_password:
-      announce_hide: La contraseña está oculta
-      announce_show: Se muestra su contraseña
-      hide: Ocultar
-      hide_password: Ocultar contraseña
-      show: Mostrar
-      show_password: Mostrar contraseña
     single_page_notification_button:
       subscribe_text:
       unsubscribe_text:

data/config/locales/et.yml

@@ -181,13 +181,6 @@ et:
     share_links:
       all_opens_in_new_tab:
       opens_in_new_tab:
-    show_password:
-      announce_hide: Teie parool on peidetud
-      announce_show: Teie parooli kuvatakse
-      hide: Peida
-      hide_password: Peida parool
-      show: Kuva
-      show_password: Kuva parool
     single_page_notification_button:
       subscribe_text:
       unsubscribe_text:

data/config/locales/fa.yml

@@ -177,13 +177,6 @@ fa:
     share_links:
       all_opens_in_new_tab:
       opens_in_new_tab:
-    show_password:
-      announce_hide: رمز عبور شما مخفی شده است
-      announce_show: رمز عبور شما نمایش داده شده است
-      hide: مخفی کردن
-      hide_password: مخفی کردن رمز عبور
-      show: نمایش
-      show_password: نمایش رمز عبور
     single_page_notification_button:
       subscribe_text:
       unsubscribe_text:

data/config/locales/fi.yml

@@ -180,13 +180,6 @@ fi:
     share_links:
       all_opens_in_new_tab:
       opens_in_new_tab:
-    show_password:
-      announce_hide: Salasanasi on piilotettu
-      announce_show: Salasanasi näytetään
-      hide: Piilottaa
-      hide_password: Piilota salasana
-      show: Näytä
-      show_password: Näytä salasana
     single_page_notification_button:
       subscribe_text:
       unsubscribe_text:

data/config/locales/fr.yml

@@ -178,13 +178,6 @@ fr:
     share_links:
       all_opens_in_new_tab:
       opens_in_new_tab:
-    show_password:
-      announce_hide: Votre mot de passe est masqué
-      announce_show: Votre mot de passe est affiché
-      hide: Masquer
-      hide_password: Masquer le mot de passe
-      show: Afficher
-      show_password: Afficher le mot de passe
     single_page_notification_button:
       subscribe_text:
       unsubscribe_text:

data/config/locales/gd.yml

@@ -180,13 +180,6 @@ gd:
     share_links:
       all_opens_in_new_tab:
       opens_in_new_tab:
-    show_password:
-      announce_hide: Tá do chuid focal i bhfolach
-      announce_show: Taispeántar do chuid focal
-      hide: Cheilt
-      hide_password: Folaigh pasfhocal
-      show: Taispeántas
-      show_password: Taispeáin pasfhocal
     single_page_notification_button:
       subscribe_text:
       unsubscribe_text:

data/config/locales/gu.yml

@@ -178,13 +178,6 @@ gu:
     share_links:
       all_opens_in_new_tab:
       opens_in_new_tab:
-    show_password:
-      announce_hide: તમારો પાસવર્ડ હાઈડ કરેલ છે
-      announce_show: તમારો પાસવર્ડ દર્શાવ્યો છે
-      hide: હાઈડ
-      hide_password: પાસવર્ડ હાઈડ કરો
-      show: દર્શાવો
-      show_password: પાસવર્ડ દર્શાવો
     single_page_notification_button:
       subscribe_text:
       unsubscribe_text:

data/config/locales/he.yml

@@ -178,13 +178,6 @@ he:
     share_links:
       all_opens_in_new_tab:
       opens_in_new_tab:
-    show_password:
-      announce_hide: הסיסמה שלך מוסתרת
-      announce_show: הסיסמה שלך מוצגת
-      hide: הסתר
-      hide_password: הסתר סיסמה
-      show: הצג
-      show_password: הצג סיסמה
     single_page_notification_button:
       subscribe_text:
       unsubscribe_text:

data/config/locales/hi.yml

@@ -178,13 +178,6 @@ hi:
     share_links:
       all_opens_in_new_tab:
       opens_in_new_tab:
-    show_password:
-      announce_hide: आपका पासवर्ड छिपा है
-      announce_show: आपका पासवर्ड प्रदर्शित है
-      hide: छिपाएं
-      hide_password: पासवर्ड छिपाएं
-      show: दिखाएं
-      show_password: पासवर्ड दिखाएं
     single_page_notification_button:
       subscribe_text:
       unsubscribe_text: