crown_marketplace_utils 0.1.0.beta.1 → 0.1.0.beta.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06b0933612954153f5c6a0a37d666db46ad61709d6ce33705790b3f2906101ec
-  data.tar.gz: d8622845984e64cabf38557e3c0045cadf2265975c8a38a5bac6ab25ffd93119
+  metadata.gz: 9bded690841ee7e1cbd50580542cbebe6ec6f1522dfa1ee4ef3da56028ada558
+  data.tar.gz: 6cddd1647d22f33db11fc6120bd2f789b908d686b0c16e5d344a7ccbf188b3c7
 SHA512:
-  metadata.gz: 34d668ad1d821617e5cd81d9d040e32d5d9e503eb0e68c55757ecf945a1b38e25a59c3c08fadb4d15dd3158b7a238b1e933066748f3b7f3e5801574bea4474de
-  data.tar.gz: a5c067665e8af0370c960d7868af516aeb3b8d86453aa94c732841a6824d3cb32ed3d400be26e81608b643eff119f44b30b7a0fdb8d13c6715c59bcf00daa18f
+  metadata.gz: 051dee5a663d6355aba6d171307b7ea9965413e15c7926efa164c4ff651b9f25fa8946c66cbaa2f0be4491facfbb8dbbf366363d33d348deb8eaa5ae431aa8db
+  data.tar.gz: 7d201bfd9d0a383bf3e5bf71402f428f6eda75bd88d17c669a1f1d0649ad5029d2400ed5626b26b9bf3ffffdadbf3ddeba9b6a65fdb8c09edc26cc0683952b5e

data/.rspec

@@ -1,3 +1,2 @@
---format documentation
 --color
 --require spec_helper

data/.rubocop.yml

@@ -108,3 +108,17 @@ Style/OptionalBooleanParameter:
 
 RSpec/VerifiedDoubleReference:
     Enabled: false
+
+RSpec/NestedGroups:
+    Max: 5
+
+RSpec/ExampleLength:
+    Exclude:
+        - 'spec/crown_marketplace_utils/gov_uk_helper/**/*'
+
+Rails/DynamicFindBy:
+  Whitelist:
+    - find_by_id
+
+RSpec/MultipleExpectations:
+    Max: 3

data/Gemfile

@@ -4,7 +4,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in crown_marketplace_utils.gemspec
 gemspec
-
-gem 'rake', '~> 13.0'
-
-gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    crown_marketplace_utils (0.1.0.beta.1)
+    crown_marketplace_utils (0.1.0.beta.3)
+      actionview (>= 6.0)
 
 GEM
   remote: https://rubygems.org/
@@ -71,8 +72,19 @@ GEM
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     builder (3.2.4)
+    capybara (3.38.0)
+      addressable
+      matrix
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (>= 1.5, < 3.0)
+      xpath (~> 3.2)
     concurrent-ruby (1.1.10)
     crass (1.0.6)
     diff-lcs (1.5.0)
@@ -88,6 +100,7 @@ GEM
     mail (2.7.1)
       mini_mime (>= 0.1.1)
     marcel (1.0.2)
+    matrix (0.4.2)
     method_source (1.0.0)
     mini_mime (1.1.2)
     minitest (5.16.3)
@@ -100,13 +113,14 @@ GEM
     net-smtp (0.3.2)
       net-protocol
     nio4r (2.5.8)
-    nokogiri (1.13.8-x86_64-darwin)
+    nokogiri (1.13.9-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.13.8-x86_64-linux)
+    nokogiri (1.13.9-x86_64-linux)
       racc (~> 1.4)
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
+    public_suffix (5.0.0)
     racc (1.6.0)
     rack (2.2.4)
     rack-test (2.0.2)
@@ -139,40 +153,40 @@ GEM
       zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.0)
+    regexp_parser (2.6.1)
     rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.1)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.1)
-    rubocop (1.36.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.39.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.20.1, < 2.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.21.0)
+    rubocop-ast (1.23.0)
       parser (>= 3.1.1.0)
-    rubocop-rails (2.16.1)
+    rubocop-rails (2.17.3)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.33.0, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.13.2)
+    rubocop-rspec (2.15.0)
       rubocop (~> 1.33)
     ruby-progressbar (1.11.0)
     thor (1.2.1)
@@ -184,6 +198,8 @@ GEM
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
     yard (0.9.28)
       webrick (~> 1.7.0)
     zeitwerk (2.6.1)
@@ -193,16 +209,16 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  bundler
+  bundler (~> 2.3)
+  capybara (~> 3.38.0)
   crown_marketplace_utils!
-  rails
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop
-  rubocop-rails
-  rubocop-rake
-  rubocop-rspec
-  yard
+  rails (>= 6.0)
+  rspec (~> 3.12)
+  rubocop (~> 1.36)
+  rubocop-rails (~> 2.16)
+  rubocop-rake (~> 0.6)
+  rubocop-rspec (~> 2.13)
+  yard (~> 0.9)
 
 BUNDLED WITH
    2.3.12

data/README.md

@@ -20,9 +20,23 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-To use this gem, simply at it to your Gemfile (as described above) and you will have access to the methods in the GovUkHelper once you restart your server.
+To use this gem, simply add it to your Gemfile (as described above).
+
+### GOV.UK Helper
+
+To include the helper methods from the `GovUkHelper` module, you can include it in your `app/helpers/application_helper.rb` like so:
+
+```ruby
+module ApplicationHelper
+  include CrownMarketplaceUtils::GovUkHelper
+end 
+```
+
+This will give you access to a variety of [GDS components](https://design-system.service.gov.uk/components) to use in your application views.
+These are based on the components found in [GOV.UK Frontend v4.3.1](https://github.com/alphagov/govuk-frontend/releases/tag/v4.3.1).
 
 Documentation for the helper methods can be found at [LINK TO RDOCS](#)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -33,6 +47,35 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 At the moment this Gem only contains view helpers. It would be good in the future to add other kinds of modules to this gem so that they can be shared and managed in one place.
 
+### Helpers to create
+- ~~Breadcrumbs~~
+- ~~Button~~
+- ~~Checkboxes~~
+- ~~CharacterCount~~
+- DateInput
+- ~~Details~~
+- ~~ErrorMessage~~
+- ~~Fieldset~~
+- ~~FormGroup~~
+- ~~Header~~
+- ~~Hint~~
+- ~~Label~~
+- ~~NotificationBanner~~
+- ~~Pagination~~
+- ~~Radios~~
+- ~~Select~~
+- ~~StepByStepNavigation~~
+- ~~TextArea~~
+- ~~TextInput~~
+- ~~Tag~~
+
+### CCS Helpers to look at after first release
+- Accordion
+- CCS Panel
+- CCS Header
+- Conditioanl Checkboxes
+- Conditioanl Radios
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/tim-s-ccs/crown_marketplace_utils.

data/crown_marketplace_utils.gemspec

@@ -33,14 +33,17 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rails'
-  spec.add_development_dependency 'rspec', '~> 3.2'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-rails'
-  spec.add_development_dependency 'rubocop-rake'
-  spec.add_development_dependency 'rubocop-rspec'
-  spec.add_development_dependency 'yard'
+  spec.add_dependency 'actionview', '>= 6.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.3'
+  spec.add_development_dependency 'capybara', '~> 3.38.0'
+  spec.add_development_dependency 'rails', '>= 6.0'
+  spec.add_development_dependency 'rspec', '~> 3.12'
+  spec.add_development_dependency 'rubocop', '~> 1.36'
+  spec.add_development_dependency 'rubocop-rails', '~> 2.16'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.13'
+  spec.add_development_dependency 'yard', '~> 0.9'
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/crown_marketplace_utils/gov_uk_helper/breadcrumbs.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'action_view'
+
+module CrownMarketplaceUtils
+  module GovUkHelper
+    # = GOV.UK Breadcrumbs
+    #
+    # This helper is used for generating the breadcrumbs component from the
+    # {https://design-system.service.gov.uk/components/breadcrumbs GDS - Components - Breadcrumbs}
+
+    module Breadcrumbs
+      include ActionView::Context
+      include ActionView::Helpers::TagHelper
+      include ActionView::Helpers::TextHelper
+      include ActionView::Helpers::UrlHelper
+
+      # Generates the HTML for the GOV.UK breadcrumbs component
+      #
+      # @param govuk_breadcrumb_items [Array<Hash>] An array of links for the breadcrumbs list. See {#govuk_breadcrumb_link} for details of the items in the array.
+      # @param govuk_breadcrumbs_options [Hash] options that will be used in customising the HTML
+      #
+      # @option govuk_breadcrumbs_options [String] :classes additional CSS classes for the breadcrums HTML
+      # @option govuk_breadcrumbs_options [Boolean] :collapse_on_mobile indicates if it is to colapse breadcrumbs on mobile
+      # @option govuk_breadcrumbs_options [Hash] :attributes any additional attributes that will added as part of the HTML
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Breadcrumbs
+      #                                     which can then be rendered on the page
+
+      def govuk_breadcrumbs(govuk_breadcrumb_items, **govuk_breadcrumbs_options)
+        govuk_breadcrumbs_classes = ['govuk-breadcrumbs']
+        govuk_breadcrumbs_classes << govuk_breadcrumbs_options[:classes]
+        govuk_breadcrumbs_classes << 'govuk-breadcrumbs--collapse-on-mobile' if govuk_breadcrumbs_options[:collapse_on_mobile]
+        govuk_breadcrumbs_options[:attributes] ||= {}
+
+        tag.div(class: govuk_breadcrumbs_classes, **govuk_breadcrumbs_options[:attributes]) do
+          tag.ol(class: 'govuk-breadcrumbs__list') do
+            capture do
+              govuk_breadcrumb_items.each { |govuk_breadcrumb_item| concat(govuk_breadcrumb_link(govuk_breadcrumb_item)) }
+            end
+          end
+        end
+      end
+
+      private
+
+      # Generates the HTML for each link in the breadcrumbs.
+      # It is called by {#govuk_breadcrumbs} which will pass in the breadcrum item.
+      #
+      # @param govuk_breadcrumb_item [Hash] a hash containg options for the breadcrumb item
+      #
+      # @option govuk_breadcrumb_item [String] :text the text for the link
+      # @option govuk_breadcrumb_item [String] :link the URI for the link. If blank it is assumed that this item relates to current page
+      # @option govuk_breadcrumb_item [Hash] :attributes any additional attributes that will added as part of the HTML.
+      #                                                  If the link is blank then it defaults to +{ aria: { current: 'page' } }+
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Breadcrumb list item
+
+      def govuk_breadcrumb_link(govuk_breadcrumb_item)
+        govuk_breadcrumb_item[:attributes] ||= {}
+
+        if govuk_breadcrumb_item[:link].present?
+          tag.li(class: 'govuk-breadcrumbs__list-item', **govuk_breadcrumb_item[:attributes]) do
+            link_to govuk_breadcrumb_item[:text], govuk_breadcrumb_item[:link], class: 'govuk-breadcrumbs__link'
+          end
+        else
+          (govuk_breadcrumb_item[:attributes][:aria] ||= {}).merge!({ current: 'page' })
+
+          tag.li(class: 'govuk-breadcrumbs__list-item', **govuk_breadcrumb_item[:attributes]) do
+            govuk_breadcrumb_item[:text]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/crown_marketplace_utils/gov_uk_helper/button.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require 'action_view'
+
+module CrownMarketplaceUtils
+  module GovUkHelper
+    # = GOV.UK Button
+    #
+    # This helper is used for generating the button component from the
+    # {https://design-system.service.gov.uk/components/button GDS - Components - Button}
+
+    module Button
+      include ActionView::Context
+      include ActionView::Helpers::TagHelper
+      include ActionView::Helpers::TextHelper
+      include ActionView::Helpers::UrlHelper
+      include ActionView::Helpers::FormTagHelper
+
+      # Generates the HTML for the GOV.UK button component
+      #
+      # @param text [String] the text that will be shown in the button
+      # @param type [Symbol] the type of button that will be created.
+      #                      - :a will create a anchor tag
+      #                      - :submit will create a input with type submit
+      #                      - all other values will create a button with the type specified
+      # @param govuk_button_options [Hash] options that will be used in customising the HTML
+      #
+      # @option govuk_button_options [String] :classes additional CSS classes for the button HTML
+      # @option govuk_button_options [Boolean] :is_start_button indicates if it is a start button
+      # @option govuk_button_options [String] :href the URI that will be used in anchor tag (only used if type is +:a+)
+      # @option govuk_button_options [ActionView::Helpers::FormBuilder] :form the form builder used to create the submit button (only used if type is +:submit+)
+      # @option govuk_button_options [Hash] :attributes ({ data: { module: 'govuk-button' } }) any additional attributes that will added as part of the HTML
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Button
+      #                                     which can then be rendered on the page
+
+      def govuk_button(text, type = :a, **govuk_button_options)
+        govuk_button_classes = ['govuk-button']
+        govuk_button_classes << govuk_button_options[:classes]
+        govuk_button_options[:attributes] ||= {}
+        govuk_button_classes << 'govuk-button--disabled' if govuk_button_options[:attributes][:disabled]
+        (govuk_button_options[:attributes][:data] ||= {}).merge!({ module: 'govuk-button' })
+
+        button_method = case type
+                        when :a
+                          :govuk_button_link
+                        when :submit
+                          :govuk_button_submit
+                        else
+                          :govuk_button_button
+                        end
+
+        send(button_method, text, type, govuk_button_classes, **govuk_button_options)
+      end
+
+      private
+
+      # Generates the HTML for the GOV.UK button component as an anchor tag.
+      # It is called by {#govuk_button} which will pass in the parameters, including any defaults.
+      #
+      # @param text [String] the text that will be shown in the button
+      # @param _type [Symbol] unused as type has already been determined
+      # @param classes [String] additional CSS classes for the button HTML
+      # @param govuk_button_options [Hash] options that will be used in customising the HTML
+      #
+      # @option govuk_button_options [Boolean] :is_start_button indicates if it is a start button
+      # @option govuk_button_options [String] :href the URI that will be used in anchor tag
+      # @option govuk_button_options [Hash] :attributes any additional attributes that will added as part of the HTML
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Button as an anchor element
+      #                                     which can then be rendered on the page
+
+      def govuk_button_link(text, _type, classes, **govuk_button_options)
+        link_to(govuk_button_options[:href], class: classes, role: :button, draggable: false, **govuk_button_options[:attributes]) do
+          concat(text)
+          concat(govuk_start_button_icon) if govuk_button_options[:is_start_button]
+        end
+      end
+
+      # Generates the HTML for the GOV.UK button component as a button.
+      # It is called by {#govuk_button} which will pass in the parameters, including any defaults.
+      #
+      # @param text [String] the text that will be shown in the button
+      # @param type [Symbol] the type of attribute of the button
+      # @param classes [String] additional CSS classes for the button HTML
+      # @param govuk_button_options [Hash] options that will be used in customising the HTML
+      #
+      # @option govuk_button_options [Boolean] :is_start_button indicates if it is a start button
+      # @option govuk_button_options [Hash] :attributes any additional attributes that will added as part of the HTML
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Button as a button element
+      #                                     which can then be rendered on the page
+
+      def govuk_button_button(text, type, classes, **govuk_button_options)
+        button_tag(class: classes, type: type, **govuk_button_options[:attributes]) do
+          concat(text)
+          concat(govuk_start_button_icon) if govuk_button_options[:is_start_button]
+        end
+      end
+
+      # Generates the HTML for the GOV.UK button component as an input.
+      # It is called by {#govuk_button} which will pass in the parameters, including any defaults.
+      #
+      # @param text [String] the text that will be shown in the input
+      # @param _type [Symbol] unused as type has already been determined
+      # @param classes [String] additional CSS classes for the button HTML
+      # @param govuk_button_options [Hash] options that will be used in customising the HTML
+      #
+      # @option govuk_button_options [ActionView::Helpers::FormBuilder] :form the form builder used to create the submit button
+      # @option govuk_button_options [Hash] :attributes any additional attributes that will added as part of the HTML
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Button as an input element
+      #                                     which can then be rendered on the page
+
+      def govuk_button_submit(text, _type, classes, **govuk_button_options)
+        govuk_button_options[:form].submit(text, class: classes, **govuk_button_options[:attributes])
+      end
+
+      # Generates the arrow for the start button option as part of {#govuk_button}
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the arrow for the start button
+
+      def govuk_start_button_icon
+        tag.svg(class: 'govuk-button__start-icon', xmlns: 'http://www.w3.org/2000/svg', width: 17.5, height: 19, viewBox: '0 0 33 40', aria: { hidden: true }, focusable: false) do
+          tag.path(fill: 'currentColor', d: 'M0 0h13l20 20-20 20H0l20-20z')
+        end
+      end
+    end
+  end
+end

data/lib/crown_marketplace_utils/gov_uk_helper/details.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'action_view'
+
 module CrownMarketplaceUtils
   module GovUkHelper
     # = GOV.UK Details
@@ -8,26 +10,30 @@ module CrownMarketplaceUtils
     # {https://design-system.service.gov.uk/components/details GDS - Components - Details}
 
     module Details
+      include ActionView::Context
+      include ActionView::Helpers::TagHelper
+      include ActionView::Helpers::TextHelper
+
       # Generates the HTML for the GOV.UK Details component
       #
       # @param summary_text [String] the summary text for the details element
-      # @param details_options [Hash] options that will be used in customising the HTML
+      # @param govuk_details_options [Hash] options that will be used in customising the HTML
       #
-      # @option details_options [String] :classes additional CSS classes for the error message HTML
-      # @option details_options [Hash] :attributes ({ data: { module: 'govuk-details' } }) any additional attributes that will added as part of the HTML
+      # @option govuk_details_options [String] :classes additional CSS classes for the details HTML
+      # @option govuk_details_options [Hash] :attributes ({ data: { module: 'govuk-details' } }) any additional attributes that will added as part of the HTML
       #
       # @yield HTML that will be contained within the 'govuk-details__text' div
       #
       # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Details
       #                                     which can then be rendered on the page
 
-      def govuk_details(summary_text, **details_options, &block)
+      def govuk_details(summary_text, **govuk_details_options, &block)
         govuk_details_classes = ['govuk-details']
-        govuk_details_classes << details_options[:classes]
-        details_options[:attributes] ||= {}
-        (details_options[:attributes][:data] ||= {}).merge!({ module: 'govuk-details' })
+        govuk_details_classes << govuk_details_options[:classes]
+        govuk_details_options[:attributes] ||= {}
+        (govuk_details_options[:attributes][:data] ||= {}).merge!({ module: 'govuk-details' })
 
-        tag.details(class: govuk_details_classes, **details_options[:attributes]) do
+        tag.details(class: govuk_details_classes, **govuk_details_options[:attributes]) do
           capture do
             concat(tag.summary(tag.span(summary_text, class: 'govuk-details__summary-text'), class: 'govuk-details__summary'))
             concat(tag.div(class: 'govuk-details__text', &block))

data/lib/crown_marketplace_utils/gov_uk_helper/error_message.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'action_view'
+
 module CrownMarketplaceUtils
   module GovUkHelper
     # = GOV.UK Error Message
@@ -8,25 +10,30 @@ module CrownMarketplaceUtils
     # {https://design-system.service.gov.uk/components/error-message GDS - Components - Error message}
 
     module ErrorMessage
+      include ActionView::Context
+      include ActionView::Helpers::TagHelper
+      include ActionView::Helpers::TextHelper
+
       # Generates the HTML for the GOV.UK Error message component
       #
       # @param message [String] the message to be displayed
       # @param attribute [String, Symbol] the attribute that has an error
-      # @param error_message_options [Hash] options that will be used in customising the HTML
+      # @param govuk_error_message_options [Hash] options that will be used in customising the HTML
       #
-      # @option error_message_options [String] :classes additional CSS classes for the error message HTML
-      # @option error_message_options [String] :visually_hidden_text ('Error') visualy hidden text before the error message
-      # @option error_message_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+      # @option govuk_error_message_options [String] :classes additional CSS classes for the error message HTML
+      # @option govuk_error_message_options [String] :visually_hidden_text ('Error') visualy hidden text before the error message
+      # @option govuk_error_message_options [Hash] :attributes ({}) any additional attributes that will be added as part of the HTML
       #
       # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Error message
       #                                     which can then be rendered on the page
 
-      def govuk_error_message(message, attribute, **error_message_options)
+      def govuk_error_message(message, attribute, **govuk_error_message_options)
         class_list = ['govuk-error-message']
-        class_list << error_message_options[:classes]
-        visually_hidden_text = error_message_options[:visually_hidden_text] || 'Error'
+        class_list << govuk_error_message_options[:classes]
+        visually_hidden_text = govuk_error_message_options[:visually_hidden_text] || 'Error'
+        govuk_error_message_options[:attributes] ||= {}
 
-        tag.p(id: "#{attribute}-error", class: class_list, **(error_message_options[:attributes] || {})) do
+        tag.p(id: "#{attribute}-error", class: class_list, **govuk_error_message_options[:attributes]) do
           capture do
             concat(tag.span("#{visually_hidden_text}: ", class: 'govuk-visually-hidden')) if visually_hidden_text.present?
             concat(message)
@@ -38,14 +45,14 @@ module CrownMarketplaceUtils
       #
       # @param model [ActiveModel] model that will be used to find the error message
       # @param attribute [String, Symbol] the attribute that has an error
-      # @param error_message_options [Hash] options that will be used in customising the HTML
+      # @param govuk_error_message_options [Hash] options that will be used in customising the HTML
       #
       # @option (see #govuk_error_message)
       #
       # @return (see #govuk_error_message)
 
-      def govuk_error_message_with_model(model, attribute, **error_message_options)
-        govuk_error_message(model.errors[attribute].first, attribute, **error_message_options)
+      def govuk_error_message_with_model(model, attribute, **govuk_error_message_options)
+        govuk_error_message(model.errors[attribute].first, attribute, **govuk_error_message_options)
       end
     end
   end