ccs-frontend_helpers 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ef86c828ca8a268f9af33212c8ada74ff7ba0d0b01af5fc36200ec5ad98fde1
-  data.tar.gz: 2259677fea66d59061a029ee951b4f2246a2e96adbd9d153f188054d34d213ad
+  metadata.gz: 294fb84084e25efd871cf66bf4513023648669964b1fbc026aece725bcd64c78
+  data.tar.gz: cd55ae750739c51a9561871d5d2c782a067ace1b04f7014e3b41d05349db6f68
 SHA512:
-  metadata.gz: a451c37ef27586b33004da34c9a2d709e5cc97c8af0b477a509f16175788b0de2b2368ea13c4b3a88e2221a6fc9ebf3a6c42157bb10c5acfef662d45de473db9
-  data.tar.gz: c8bf663b057106329a327c7a7d1f0219edc982f801fd34b46904de3223f3aa2c337c024569139b6dd3bf79afa62ec407a571ab9b93e010c86eb70d795207c608
+  metadata.gz: d64eb288f9595343e58ec37eec080a925928b908273c1880efd409a3cde6f9015567221838496084c03d3799dd54ea7ae10328e4c545d446d0f876b0892efb9c
+  data.tar.gz: d1c288ab82c3c78b1049a1bf8d580b515d213d52758aedf378799262efa854880eab99e69251e0cf74502bb29af8da7fa965adf6275f8755672896dc49787a43

data/.rubocop.yml

@@ -126,11 +126,13 @@ RSpec/MultipleExpectations:
     Max: 3
 
 RSpec/FilePath:
-    CustomTransform:
-        GovUKFrontend: govuk_frontend
-        GovUK: govuk
+    Enabled: false
 
 RSpec/SpecFilePathFormat:
     CustomTransform:
         GovUKFrontend: govuk_frontend
         GovUK: govuk
+
+Rails/OutputSafety:
+    Exclude:
+        - 'spec/ccs/frontend_helpers/**/*fixtures_spec.rb'

data/CHANGELOG.md

@@ -1,3 +1,38 @@
+## [0.2.0] - 2024-03-13
+
+### 💥 Breaking changes
+
+Update components to be compatible with GOV.UK Frontend v5.2
+
+For pagination, the option to enable ellipsis is now:
+```ruby
+{
+  ellipsis: true
+}
+```
+instead of:
+```ruby
+{
+  type: :ellipsis
+}
+```
+
+### 🏠 Internal changes
+
+Add tests for GOV.UK Frontend fixtures
+
+### 🆕 New features
+
+The following GOV.UK helpers have been added:
+
+- Exit this page
+- Task list
+
+## [0.1.2] - 2023-11-16
+
+Fix issue with radios component which, when passed a model or form, would treat the value as an array.
+This did not cause an issue for strings as the `include?` method still works for them but if the value was a boolean or a number then an error would be thrown.
+
 ## [0.1.1] - 2023-10-25
 
 Fix some bugs with various helpers and update dependencies

data/Gemfile

@@ -7,18 +7,19 @@ gemspec
 
 # Gems for building the package
 gem 'bundler', '~> 2.3'
-gem 'rake', '~> 13.0'
+gem 'rake', '~> 13.1'
 
 # Gems for testing the package
-gem 'capybara', '~> 3.39.2'
-gem 'rspec', '~> 3.12'
+gem 'capybara', '~> 3.40.0'
+gem 'rspec', '~> 3.13'
 gem 'simplecov', '~> 0.21'
+gem 'nokogiri-diff', '~> 0.3.0'
 
 # Gems for linting/formatting the package
-gem 'rubocop', '~> 1.57'
-gem 'rubocop-rails', '~> 2.21'
+gem 'rubocop', '~> 1.62'
+gem 'rubocop-rails', '~> 2.24'
 gem 'rubocop-rake', '~> 0.6'
-gem 'rubocop-rspec', '~> 2.24'
+gem 'rubocop-rspec', '~> 2.27'
 
 # Gems for documenting the package
 gem 'yard', '~> 0.9'

data/Gemfile.lock

@@ -1,76 +1,77 @@
 PATH
   remote: .
   specs:
-    ccs-frontend_helpers (0.1.1)
+    ccs-frontend_helpers (0.2.0)
       rails (>= 6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.1.1)
-      actionpack (= 7.1.1)
-      activesupport (= 7.1.1)
+    actioncable (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
       zeitwerk (~> 2.6)
-    actionmailbox (7.1.1)
-      actionpack (= 7.1.1)
-      activejob (= 7.1.1)
-      activerecord (= 7.1.1)
-      activestorage (= 7.1.1)
-      activesupport (= 7.1.1)
+    actionmailbox (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activejob (= 7.1.3.2)
+      activerecord (= 7.1.3.2)
+      activestorage (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
       mail (>= 2.7.1)
       net-imap
       net-pop
       net-smtp
-    actionmailer (7.1.1)
-      actionpack (= 7.1.1)
-      actionview (= 7.1.1)
-      activejob (= 7.1.1)
-      activesupport (= 7.1.1)
+    actionmailer (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      actionview (= 7.1.3.2)
+      activejob (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
       mail (~> 2.5, >= 2.5.4)
       net-imap
       net-pop
       net-smtp
       rails-dom-testing (~> 2.2)
-    actionpack (7.1.1)
-      actionview (= 7.1.1)
-      activesupport (= 7.1.1)
+    actionpack (7.1.3.2)
+      actionview (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
       nokogiri (>= 1.8.5)
+      racc
       rack (>= 2.2.4)
       rack-session (>= 1.0.1)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    actiontext (7.1.1)
-      actionpack (= 7.1.1)
-      activerecord (= 7.1.1)
-      activestorage (= 7.1.1)
-      activesupport (= 7.1.1)
+    actiontext (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activerecord (= 7.1.3.2)
+      activestorage (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
       globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (7.1.1)
-      activesupport (= 7.1.1)
+    actionview (7.1.3.2)
+      activesupport (= 7.1.3.2)
       builder (~> 3.1)
       erubi (~> 1.11)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    activejob (7.1.1)
-      activesupport (= 7.1.1)
+    activejob (7.1.3.2)
+      activesupport (= 7.1.3.2)
       globalid (>= 0.3.6)
-    activemodel (7.1.1)
-      activesupport (= 7.1.1)
-    activerecord (7.1.1)
-      activemodel (= 7.1.1)
-      activesupport (= 7.1.1)
+    activemodel (7.1.3.2)
+      activesupport (= 7.1.3.2)
+    activerecord (7.1.3.2)
+      activemodel (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
       timeout (>= 0.4.0)
-    activestorage (7.1.1)
-      actionpack (= 7.1.1)
-      activejob (= 7.1.1)
-      activerecord (= 7.1.1)
-      activesupport (= 7.1.1)
+    activestorage (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activejob (= 7.1.3.2)
+      activerecord (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
       marcel (~> 1.0)
-    activesupport (7.1.1)
+    activesupport (7.1.3.2)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -80,41 +81,40 @@ GEM
       minitest (>= 5.1)
       mutex_m
       tzinfo (~> 2.0)
-    addressable (2.8.4)
+    addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
-    base64 (0.1.1)
-    bigdecimal (3.1.4)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
     builder (3.2.4)
-    capybara (3.39.2)
+    capybara (3.40.0)
       addressable
       matrix
       mini_mime (>= 0.1.3)
-      nokogiri (~> 1.8)
+      nokogiri (~> 1.11)
       rack (>= 1.6.0)
       rack-test (>= 0.6.3)
       regexp_parser (>= 1.5, < 3.0)
       xpath (~> 3.2)
-    concurrent-ruby (1.2.2)
+    concurrent-ruby (1.2.3)
     connection_pool (2.4.1)
     crass (1.0.6)
-    date (3.3.3)
-    diff-lcs (1.5.0)
+    date (3.3.4)
+    diff-lcs (1.5.1)
     docile (1.4.0)
-    drb (2.1.1)
-      ruby2_keywords
+    drb (2.2.1)
     erubi (1.12.0)
     globalid (1.2.1)
       activesupport (>= 6.1)
-    i18n (1.14.1)
+    i18n (1.14.4)
       concurrent-ruby (~> 1.0)
-    io-console (0.6.0)
-    irb (1.8.3)
+    io-console (0.7.2)
+    irb (1.11.2)
       rdoc
-      reline (>= 0.3.8)
-    json (2.6.3)
+      reline (>= 0.4.2)
+    json (2.7.1)
     language_server-protocol (3.17.0.3)
-    loofah (2.21.4)
+    loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
     mail (2.8.1)
@@ -125,31 +125,34 @@ GEM
     marcel (1.0.2)
     matrix (0.4.2)
     mini_mime (1.1.5)
-    minitest (5.20.0)
-    mutex_m (0.1.2)
-    net-imap (0.4.2)
+    minitest (5.22.2)
+    mutex_m (0.2.0)
+    net-imap (0.4.10)
       date
       net-protocol
     net-pop (0.1.2)
       net-protocol
-    net-protocol (0.2.1)
+    net-protocol (0.2.2)
       timeout
-    net-smtp (0.4.0)
+    net-smtp (0.4.0.1)
       net-protocol
-    nio4r (2.5.9)
-    nokogiri (1.15.4-x86_64-darwin)
+    nio4r (2.7.0)
+    nokogiri (1.16.2-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.15.4-x86_64-linux)
+    nokogiri (1.16.2-x86_64-linux)
       racc (~> 1.4)
-    parallel (1.23.0)
-    parser (3.2.2.4)
+    nokogiri-diff (0.3.0)
+      nokogiri (~> 1.5)
+      tdiff (~> 0.4)
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
-    psych (5.1.1.1)
+    psych (5.1.2)
       stringio
-    public_suffix (5.0.1)
-    racc (1.7.1)
-    rack (3.0.8)
+    public_suffix (5.0.4)
+    racc (1.7.3)
+    rack (3.0.9.1)
     rack-session (2.0.0)
       rack (>= 3.0.0)
     rack-test (2.1.0)
@@ -157,20 +160,20 @@ GEM
     rackup (2.1.0)
       rack (>= 3)
       webrick (~> 1.8)
-    rails (7.1.1)
-      actioncable (= 7.1.1)
-      actionmailbox (= 7.1.1)
-      actionmailer (= 7.1.1)
-      actionpack (= 7.1.1)
-      actiontext (= 7.1.1)
-      actionview (= 7.1.1)
-      activejob (= 7.1.1)
-      activemodel (= 7.1.1)
-      activerecord (= 7.1.1)
-      activestorage (= 7.1.1)
-      activesupport (= 7.1.1)
+    rails (7.1.3.2)
+      actioncable (= 7.1.3.2)
+      actionmailbox (= 7.1.3.2)
+      actionmailer (= 7.1.3.2)
+      actionpack (= 7.1.3.2)
+      actiontext (= 7.1.3.2)
+      actionview (= 7.1.3.2)
+      activejob (= 7.1.3.2)
+      activemodel (= 7.1.3.2)
+      activerecord (= 7.1.3.2)
+      activestorage (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
       bundler (>= 1.15.0)
-      railties (= 7.1.1)
+      railties (= 7.1.3.2)
     rails-dom-testing (2.2.0)
       activesupport (>= 5.0.0)
       minitest
@@ -178,74 +181,74 @@ GEM
     rails-html-sanitizer (1.6.0)
       loofah (~> 2.21)
       nokogiri (~> 1.14)
-    railties (7.1.1)
-      actionpack (= 7.1.1)
-      activesupport (= 7.1.1)
+    railties (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
       irb
       rackup (>= 1.0.0)
       rake (>= 12.2)
       thor (~> 1.0, >= 1.2.2)
       zeitwerk (~> 2.6)
     rainbow (3.1.1)
-    rake (13.0.6)
-    rdoc (6.5.0)
+    rake (13.1.0)
+    rdoc (6.6.2)
       psych (>= 4.0.0)
-    regexp_parser (2.8.2)
-    reline (0.3.9)
+    regexp_parser (2.9.0)
+    reline (0.4.2)
       io-console (~> 0.5)
     rexml (3.2.6)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.1)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.3)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.57.1)
-      base64 (~> 0.1.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.62.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.4)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.29.0)
-      parser (>= 3.2.1.0)
-    rubocop-capybara (2.19.0)
+    rubocop-ast (1.31.2)
+      parser (>= 3.3.0.4)
+    rubocop-capybara (2.20.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.25.1)
       rubocop (~> 1.41)
-    rubocop-factory_bot (2.24.0)
-      rubocop (~> 1.33)
-    rubocop-rails (2.21.2)
+    rubocop-rails (2.24.0)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.33.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.24.1)
-      rubocop (~> 1.33)
+    rubocop-rspec (2.27.1)
+      rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    stringio (3.0.8)
+    stringio (3.1.0)
+    tdiff (0.4.0)
     thor (1.3.0)
-    timeout (0.4.0)
+    timeout (0.4.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
@@ -255,8 +258,8 @@ GEM
     websocket-extensions (0.1.5)
     xpath (3.2.0)
       nokogiri (~> 1.8)
-    yard (0.9.34)
-    zeitwerk (2.6.12)
+    yard (0.9.36)
+    zeitwerk (2.6.13)
 
 PLATFORMS
   x86_64-darwin-19
@@ -265,14 +268,15 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.3)
-  capybara (~> 3.39.2)
+  capybara (~> 3.40.0)
   ccs-frontend_helpers!
-  rake (~> 13.0)
-  rspec (~> 3.12)
-  rubocop (~> 1.57)
-  rubocop-rails (~> 2.21)
+  nokogiri-diff (~> 0.3.0)
+  rake (~> 13.1)
+  rspec (~> 3.13)
+  rubocop (~> 1.62)
+  rubocop-rails (~> 2.24)
   rubocop-rake (~> 0.6)
-  rubocop-rspec (~> 2.24)
+  rubocop-rspec (~> 2.27)
   simplecov (~> 0.21)
   yard (~> 0.9)
 

data/README.md

@@ -8,6 +8,17 @@ This project contains two applications (both use the Ruby on Rails framework):
 - [Crown Marketplace](https://github.com/Crown-Commercial-Service/crown-marketplace)
 - [Crown Marketplace Legacy](https://github.com/Crown-Commercial-Service/crown-marketplace-legacy)
 
+## Compatibility
+
+The following table shows the version of CCS Frontend Helpers that you should use for your targeted version of GOV.UK Frontend:
+
+| CCS Frontend Helpers Version | Target GOV.UK Frontend Version |
+| ----------------------------- | ------------------------------ |
+| [0.2.0](https://github.com/tim-s-ccs/ccs-frontend_helpers/releases/tag/v0.2.0) | [5.2.0](https://github.com/alphagov/govuk-frontend/releases/tag/v5.2.0) |
+| [0.1.2](https://github.com/tim-s-ccs/ccs-frontend_helpers/releases/tag/v0.1.2) | [4.7.0](https://github.com/alphagov/govuk-frontend/releases/tag/v4.7.0) |
+
+Any other versions of GOV.UK Frontend not shown above _may_ still be compatible, but have not been specifically tested and verified.
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:

data/lib/ccs/components/govuk/accordion/section/content.rb

@@ -41,7 +41,7 @@ module CCS
             # @return [ActiveSupport::SafeBuffer]
 
             def render
-              tag.div(class: 'govuk-accordion__section-content', id: "#{accordion_id}-content-#{index}", aria: { labelledby: "#{accordion_id}-heading-#{index}" }) do
+              tag.div(class: 'govuk-accordion__section-content', id: "#{accordion_id}-content-#{index}") do
                 section[:content] || tag.p(section[:text], class: 'govuk-body')
               end
             end

data/lib/ccs/components/govuk/accordion.rb

@@ -28,6 +28,12 @@ module CCS
         #
         # @option options [String] :classes additional CSS classes for the accordion HTML
         # @option options [Integer] :heading_level (2) heading level, from 1 to 6
+        # @option options [String] :hide_all_sections_text The text content of the ‘Hide all sections’ button at the top of the accordion when all sections are expanded
+        # @option options [String] :hide_section_text The text content of the ‘Hide’ button within each section of the accordion, which is visible when the section is expanded
+        # @option options [String] :hide_section_aria_label_text  Text made available to assistive technologies, like screen-readers, as the final part of the toggle’s accessible name when the section is expanded. Defaults to "Hide this section".
+        # @option options [String] :show_all_sections_text The text content of the ‘Show all sections’ button at the top of the accordion when at least one section is collapsed
+        # @option options [String] :show_section_text The text content of the ‘Show’ button within each section of the accordion, which is visible when the section is collapsed
+        # @option options [String] :show_section_aria_label_text Text made available to assistive technologies, like screen-readers, as the final part of the toggle’s accessible name when the section is collapsed. Defaults to "Show this section".
         # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
 
         def initialize(accordion_id:, accordion_sections:, **options)
@@ -36,6 +42,11 @@ module CCS
           @options[:attributes][:id] = accordion_id
           @options[:heading_level] ||= 2
 
+          %i[hide_all_sections hide_section hide_section_aria_label show_all_sections show_section show_section_aria_label].each do |data_attribute|
+            data_attribute_name = :"#{data_attribute}_text"
+            @options[:attributes][:data][:"i18n.#{data_attribute.to_s.gsub('_', '-')}"] = options[data_attribute_name] if options[data_attribute_name]
+          end
+
           @accordion_sections = accordion_sections.map.with_index(1) { |accordion_section, index| Section.new(section: accordion_section, accordion_id: accordion_id, index: index, heading_level: @options[:heading_level]) }
         end
 

data/lib/ccs/components/govuk/button.rb

@@ -32,7 +32,10 @@ module CCS
         def initialize(text:, **options)
           super(**options)
 
-          @options[:attributes][:class] << ' govuk-button--disabled' if @options[:attributes][:disabled]
+          if @options[:attributes][:disabled]
+            @options[:attributes][:aria] ||= {}
+            @options[:attributes][:aria][:disabled] = true
+          end
           @options[:attributes][:class] << ' govuk-button--start' if @options[:is_start_button]
 
           @text = text

data/lib/ccs/components/govuk/cookie_banner/action.rb

@@ -46,6 +46,7 @@ module CCS
             if href && options[:attributes][:type] != :button
               link_to(text, href, **options[:attributes])
             else
+              options[:attributes][:type] ||= :button
               Button.new(text: text, href: href, context: context, **options).render
             end
           end

data/lib/ccs/components/govuk/cookie_banner/message.rb

@@ -56,7 +56,7 @@ module CCS
                 tag.div(class: 'govuk-grid-column-two-thirds') do
                   concat(tag.h2(heading_text, class: 'govuk-cookie-banner__heading govuk-heading-m')) if heading_text
                   concat(tag.div(class: 'govuk-cookie-banner__content') do
-                    content || tag.p(text, class: 'govuk-body')
+                    content || tag.p(text, class: 'govuk-body') if content || text
                   end)
                 end
               end)

data/lib/ccs/components/govuk/details.rb

@@ -46,7 +46,7 @@ module CCS
 
         # The default attributes for the details
 
-        DEFAULT_ATTRIBUTES = { class: 'govuk-details', data: { module: 'govuk-details' } }.freeze
+        DEFAULT_ATTRIBUTES = { class: 'govuk-details' }.freeze
       end
     end
   end

data/lib/ccs/components/govuk/error_message.rb

@@ -33,7 +33,7 @@ module CCS
         def initialize(message:, attribute:, **options)
           super(**options)
 
-          @options[:attributes][:id] ||= "#{attribute}-error"
+          @options[:attributes][:id] ||= "#{attribute}-error" if attribute
 
           @message = message
           @attribute = attribute
@@ -46,7 +46,10 @@ module CCS
 
         def render
           tag.p(**options[:attributes]) do
-            concat(tag.span("#{visually_hidden_text}: ", class: 'govuk-visually-hidden')) if visually_hidden_text.present?
+            if visually_hidden_text.present?
+              concat(tag.span("#{visually_hidden_text}:", class: 'govuk-visually-hidden'))
+              concat(' ')
+            end
             concat(message)
           end
         end