RubyGems - govuk_publishing_components - Versions diffs - 24.17.0 → 24.18.0 - Mend

govuk_publishing_components 24.17.0 → 24.18.0

Files changed (8) hide show

checksums.yaml +4 -4
data/README.md +25 -76
data/app/views/govuk_publishing_components/components/_radio.html.erb +3 -0
data/app/views/govuk_publishing_components/components/docs/layout_footer.yml +8 -0
data/app/views/govuk_publishing_components/components/docs/radio.yml +10 -0
data/lib/govuk_publishing_components/presenters/public_layout_helper.rb +8 -0
data/lib/govuk_publishing_components/version.rb +1 -1
metadata +2 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c57ef1405fbd96f5987dc24d795eb197a2682388ba0f3ccd4d09e933a5c0e8d2
-  data.tar.gz: 1213a4f3a3ac27a30ddba5a3f265607a1ff2970a5ee47896759c50986ab16f19
+  metadata.gz: 61e7fb8fb022f0732bc0ffdc8626fcce56f7728d3d36027b67ee5a86faef7e63
+  data.tar.gz: b4e5fc6caa343d11430891f9dfb4ffc575f45a402e3bafea20af2be76ed04e9b
 SHA512:
-  metadata.gz: f769ee68de178a08f866be215ed3c01a9a113c83cc56c120dbb47093659dfeeda6e4ca5f20d576b000125efaff11423a034a4931a138f31fcf95b6fae6c91809
-  data.tar.gz: 6aa9cd20cc9e8bd4c3a5c377bb863ec02704bbbf8eddf9f28153b102b0c32b001b5f23ca7539a453b67cdc7b551447e762c6ff1a47114a20581e876e1ed083f4
+  metadata.gz: 5df1326ef3d37fca25e48f3c7c4abb7aa69b2b787c9c319a1021e7bb2dc912e0ab940abbf3d430207b6b5c8e87d9b35b1cde87921e07471c298c0c16b7a3cab7
+  data.tar.gz: 9c4ac815e5f75c77a6239abfe5adf448f39c3e93b8b94e27a084233caa0240672a963420ac8ad8a9671c15bb49ba99a34e0b37f8516268e9b140bc2dd8116e87

data/README.md CHANGED Viewed

@@ -1,103 +1,52 @@
-GOV.UK Publishing Components
+# GOV.UK Publishing Components
 [![status](https://badgen.net/github/status/alphagov/govuk_publishing_components/master)](https://ci.integration.publishing.service.gov.uk/job/govuk_publishing_components/job/master/)
 [![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/)
-=====================
-GOV.UK Publishing Components is a Ruby gem to document and distribute components for GOV.UK applications.
+A Ruby gem to document and distribute components for GOV.UK applications. It provides:
-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.
-## How to
-- [Install and use this gem](/docs/install-and-use.md)
-- [Use a component in your application](/docs/use-components.md)
-- [Generate a new component](/docs/generate-a-new-component.md)
-- [Develop a component](/docs/develop-component.md)
-- [Run the component guide](/docs/run-component-guide.md)
-- [Move a component from an application to the gem](/docs/moving-components-upstream-into-this-gem.md)
-- [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)
-## Architecture / structure
-![](https://docs.google.com/drawings/d/e/2PACX-1vRj6JM7cQvngDl3Gr_U9G4xga2gsU7Z-d2qHHQcsBdjsW4WaC9_eQdryBJIS69cLkrY7S0fK9BcrPSF/pub?w=960&amp;h=720)
-[Source](https://docs.google.com/drawings/d/1N8-kbyCN_xOvvshN6d2HnQz5i5Bqed2WIatI3Nj9gNQ/edit)
-There are 2 types of helper classes in this app:
-- [AppHelpers](lib/govuk_publishing_components/app_helpers). Are exposed to the applications using this gem. They should be documented using RDoc.
-- [Component Presenters](lib/govuk_publishing_components/presenters). Anything in these classes is only for use within the components. They should be marked `@private`.
+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).
-## Relationship with GOV.UK Design System
+## Technical documentation
-GOV.UK Publishing Components also makes [GOV.UK Design System](https://design-system.service.gov.uk/) styles and components available to GOV.UK's frontend applications. This gem consumes [GOV.UK Frontend](https://github.com/alphagov/govuk-frontend) via [Yarn](https://classic.yarnpkg.com/).
+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.
-## Browser and assistive technology support
+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.
-GOV.UK Publishing Components shares the same standards in terms of browser and assistive technology support with [GOV.UK Frontend](https://github.com/alphagov/govuk-frontend#browser-and-assistive-technology-support).
-## Documentation
-[See the rubydoc.info documentation](http://www.rubydoc.info/gems/govuk_publishing_components)
-## Working locally
-### Install dependencies
-As well as the Ruby, you will also need the [Yarn package manager](https://classic.yarnpkg.com/en/docs/install/) to allow installing [npm](https://npmjs.com) dependencies.
-Install the application's dependencies with:
+### Running the test suite
 ```sh
-bundle install
-yarn install
+bundle exec rake
 ```
-### Running a local app with a local gem
-The GDS Developer Docs has a [guide on local frontend development](https://docs.publishing.service.gov.uk/manual/local-frontend-development.html) that covers setting up a local app to use the local version of the components gem in Docker and using the `./startup.sh` script.
+To run JavaScript tests (only):
-### Running tests
-The default rake task runs all the linting and test tasks:
-```sh
-bin/rake
 ```
-Javascript is tested using Jasmine and the [Jasmine gem](https://github.com/pivotal/jasmine-gem). Tests can be run either in the browser or on the command line via the dummy app’s tasks:
-```sh
-# browser
+# run JS tests in browser
 bin/rake app:jasmine
-# command line
+# run JS tests on command line
 bin/rake app:jasmine:ci
 ```
-### Viewing the component guide
-View the component guide in your browser with:
-```sh
-./startup.sh
-```
-The guide should be available at http://localhost:3212
-### View documentation
-Preview documentation in your browser with:
-```sh
-bundle exec yard server --reload
-```
+### Further documentation
+- [Install and use this gem](docs/install-and-use.md)
+- [Use a component in your application](docs/use-components.md)
+- [Generate a new component](docs/generate-a-new-component.md)
+- [Testing a component](docs/testing-components.md)
+- [Move a component from an application to the gem](docs/moving-components-upstream-into-this-gem.md)
+- [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)
+- [Code documentation on rubydoc.info](http://www.rubydoc.info/gems/govuk_publishing_components)
+- [Component conventions](docs/component_conventions.md)
+- [Component principles](docs/component_principles.md)
 ## Licence

data/app/views/govuk_publishing_components/components/_radio.html.erb CHANGED Viewed

@@ -1,4 +1,5 @@
 <%
+  local_assigns[:margin_bottom] ||= 6
   shared_helper = GovukPublishingComponents::Presenters::SharedHelper.new(local_assigns)
   id ||= nil
   id_prefix ||= "radio-#{SecureRandom.hex(4)}"
@@ -27,6 +28,7 @@
   hint ||= nil
   error_message ||= nil
   error_items ||= []
+  margin_bottom = margin_bottom ||= 6
   has_error = error_message || error_items.any?
   hint_id = "hint-#{SecureRandom.hex(4)}" if hint
@@ -34,6 +36,7 @@
   form_group_css_classes = %w(govuk-form-group)
   form_group_css_classes << "govuk-form-group--error" if has_error
+  form_group_css_classes << shared_helper.get_margin_bottom
   radio_classes = %w(govuk-radios)
   radio_classes << "govuk-radios--small" if small

data/app/views/govuk_publishing_components/components/docs/layout_footer.yml CHANGED Viewed

@@ -109,10 +109,14 @@ examples:
         items:
           - href: '/help'
             text: Help
+          - href: '/help/privacy-notice'
+            text: Privacy
           - href: '/help/cookies'
             text: Cookies
           - href: '/contact'
             text: Contact
+          - href: '/help/accessibility-statement'
+            text: Accessibility statement
           - href: '/help/terms-conditions'
             text: Terms and conditions
           - href: '/cymraeg'
@@ -150,10 +154,14 @@ examples:
         items:
           - href: '/help'
             text: Help
+          - href: '/help/privacy-notice'
+            text: Privacy
           - href: '/help/cookies'
             text: Cookies
           - href: '/contact'
             text: Contact
+          - href: '/help/accessibility-statement'
+            text: Accessibility statement
           - href: '/help/terms-conditions'
             text: Terms and conditions
           - href: '/cymraeg'

data/app/views/govuk_publishing_components/components/docs/radio.yml CHANGED Viewed

@@ -65,6 +65,16 @@ examples:
         text: "Use GOV.UK Verify"
         hint_text: "You'll have an account if you've already proved your identity with a certified company, such as the Post Office."
         bold: true
+  with_bottom_margin:
+    description: "The component accepts a number for margin bottom from 0 to 9 (0px to 60px) using the [GOV.UK Frontend spacing scale](https://design-system.service.gov.uk/styles/spacing/#the-responsive-spacing-scale). It defaults to a margin bottom of 30px (6)."
+    data:
+      name: "radio-group"
+      margin_bottom: 9
+      items:
+      - value: "government-gateway"
+        text: "Use Government Gateway"
+      - value: "govuk-verify"
+        text: "Use GOV.UK Verify"
   with_hint_on_form_group:
     data:
       name: "radio-group-error"

data/lib/govuk_publishing_components/presenters/public_layout_helper.rb CHANGED Viewed

@@ -330,10 +330,18 @@ module GovukPublishingComponents
             href: "/help",
             text: "Help",
           },
+          {
+            href: "/help/privacy-notice",
+            text: "Privacy",
+          },
           {
             href: "/help/cookies",
             text: "Cookies",
           },
+          {
+            href: "/help/accessibility-statement",
+            text: "Accessibility statement",
+          },
           {
             href: "/contact",
             text: "Contact",

data/lib/govuk_publishing_components/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = "24.17.0".freeze
+  VERSION = "24.18.0".freeze
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 24.17.0
+  version: 24.18.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-29 00:00:00.000000000 Z
+date: 2021-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_app_config