crown_marketplace_utils 0.1.0.beta.2 → 0.1.0.beta.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6c289917a94a2f6ee322e356590757f9963509f1a6fa7951783a780e84d5fcf
-  data.tar.gz: 63639f4f2cf082ed69432dccdd0e41ced94dc909ec397d81550169229cf6ae06
+  metadata.gz: 9bded690841ee7e1cbd50580542cbebe6ec6f1522dfa1ee4ef3da56028ada558
+  data.tar.gz: 6cddd1647d22f33db11fc6120bd2f789b908d686b0c16e5d344a7ccbf188b3c7
 SHA512:
-  metadata.gz: d5505418729cabf9849322dbbc8255c274063dca392c1cc5e3e9125db366811236efd120821b701f691fe32f28a94b19520f7a0425afb7d0bf6bc2c190025fe7
-  data.tar.gz: e243d5969928fbf7924d4b81206e77a5cfc6ce5e066aac4f7022f7495c8acc255ca0178ac43485ca4b2d7af285018b91925367f4655ab66069e49418c09a0d0f
+  metadata.gz: 051dee5a663d6355aba6d171307b7ea9965413e15c7926efa164c4ff651b9f25fa8946c66cbaa2f0be4491facfbb8dbbf366363d33d348deb8eaa5ae431aa8db
+  data.tar.gz: 7d201bfd9d0a383bf3e5bf71402f428f6eda75bd88d17c669a1f1d0649ad5029d2400ed5626b26b9bf3ffffdadbf3ddeba9b6a65fdb8c09edc26cc0683952b5e

data/.rubocop.yml

@@ -115,3 +115,10 @@ RSpec/NestedGroups:
 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,7 @@
 PATH
   remote: .
   specs:
-    crown_marketplace_utils (0.1.0.beta.2)
+    crown_marketplace_utils (0.1.0.beta.3)
       actionview (>= 6.0)
 
 GEM
@@ -72,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)
@@ -89,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)
@@ -101,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)
@@ -140,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)
@@ -185,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)
@@ -194,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.
@@ -34,24 +48,33 @@ 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
-- Accordion
 - ~~Breadcrumbs~~
 - ~~Button~~
-- Checkboxes
-- CharacterCount
+- ~~Checkboxes~~
+- ~~CharacterCount~~
 - DateInput
 - ~~Details~~
 - ~~ErrorMessage~~
-- Fieldset
+- ~~Fieldset~~
 - ~~FormGroup~~
-- Header
+- ~~Header~~
 - ~~Hint~~
-- NotificationBanner
-- Pagination
-- Radios
-- Select
-- StepByStepNavigation
-- TextInput
+- ~~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
 

data/crown_marketplace_utils.gemspec

@@ -35,14 +35,15 @@ Gem::Specification.new do |spec|
   # spec.add_dependency "example-gem", "~> 1.0"
   spec.add_dependency 'actionview', '>= 6.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_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/details.rb

@@ -19,7 +19,7 @@ module CrownMarketplaceUtils
       # @param summary_text [String] the summary text for the details element
       # @param govuk_details_options [Hash] options that will be used in customising the HTML
       #
-      # @option govuk_details_options [String] :classes additional CSS classes for the error message 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

data/lib/crown_marketplace_utils/gov_uk_helper/error_message.rb

@@ -22,7 +22,7 @@ module CrownMarketplaceUtils
       #
       # @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 added as part of the HTML
+      # @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

data/lib/crown_marketplace_utils/gov_uk_helper/field/character_count.rb

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+
+require_relative 'textarea'
+
+module CrownMarketplaceUtils
+  module GovUkHelper
+    module Field
+      # = GOV.UK Character count
+      #
+      # This helper is used for generating the character count component from the
+      # {https://design-system.service.gov.uk/components/character-count GDS - Components - Character count}
+      #
+      # This is a wrapper around a Textarea module and so makes use of the methods in {Textarea}
+
+      module CharacterCount
+        include Textarea
+
+        # Generates the HTML for the GOV.UK character count component.
+        # It works by warpping the govuk_textarea in HTML which will trigger the JavaScript to do the character count.
+        #
+        # @param attribute [String, Symbol] the attribute of the character count text area
+        # @param error_message [String] the error message to be displayed
+        # @param govuk_character_count_options [Hash] options that will be used for the parts of the form group, label, hint, textarea and the character count
+        #
+        # @option govuk_character_count_options [Hash] :form_group_options see {govuk_field}
+        # @option govuk_character_count_options [Hash] :label see {govuk_field}
+        # @option govuk_character_count_options [Hash] :hint see {govuk_field}
+        # @option govuk_character_count_options [Hash] :textarea_options see {govuk_textarea}
+        # @option govuk_character_count_options [Hash] :character_count_options ({}) the options that will be used when rendering the textarea.
+        #                                                                            See {_govuk_character_count} for more details.
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK chracter count
+        #                                     which can then be rendered on the page
+
+        def govuk_character_count(attribute, error_message = nil, **govuk_character_count_options)
+          _govuk_character_count(attribute, **govuk_character_count_options) do |govuk_text_textarea_options|
+            govuk_textarea(attribute, error_message, **govuk_text_textarea_options)
+          end
+        end
+
+        # Generates the HTML for the GOV.UK character count component.
+        # It works by warpping the govuk_textarea in HTML which will trigger the JavaScript to do the character count.
+        #
+        # @param attribute [String, Symbol] the attribute of the character count
+        # @param error_message [String] the error message to be displayed
+        # @param govuk_character_count_options [Hash] options that will be used for the parts of the form group, label, hint and textarea
+        #
+        # @option govuk_character_count_options [Hash] :form_group_options see {govuk_field}
+        # @option govuk_character_count_options [Hash] :label see {govuk_field}
+        # @option govuk_character_count_options [Hash] :hint see {govuk_field}
+        # @option govuk_character_count_options [Hash] :textarea_options see {govuk_textarea}
+        # @option govuk_character_count_options [Hash] :character_count_options ({}) the options that will be used when rendering the textarea.
+        #                                                                            See {_govuk_character_count} for more details.
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK chracter count
+        #                                     which can then be rendered on the page
+
+        # Generates the HTML for the GOV.UK textarea component using an ActionView::Helpers::FormBuilder.
+        # Unlike {#govuk_textarea}, the method will be able to automatically determine if the error message needs to be shown.
+        #
+        # @param form [ActionView::Helpers::FormBuilder] :form the form builder used to create the character count textarea
+        # @param attribute [String, Symbol] the attribute of the character count text area
+        # @param govuk_character_count_options [Hash] options that will be used for the parts of the form group, label, hint, textarea and the character count
+        #
+        # @option govuk_character_count_options [Hash] :form_group_options see {govuk_field_with_form}
+        # @option govuk_character_count_options [Hash] :label see {govuk_field_with_form}
+        # @option govuk_character_count_options [Hash] :hint see {govuk_field_with_form}
+        # @option govuk_character_count_options [Hash] :textarea_options see {govuk_textarea_with_form}
+        # @option govuk_character_count_options [Hash] :character_count_options ({}) the options that will be used when rendering the textarea.
+        #                                                                            See {_govuk_character_count} for more details.
+        #
+        # @return (see govuk_character_count)
+
+        def govuk_character_count_with_form(form, attribute, **govuk_character_count_options)
+          _govuk_character_count(attribute, **govuk_character_count_options) do |govuk_text_textarea_options|
+            govuk_textarea_with_form(form, attribute, **govuk_text_textarea_options)
+          end
+        end
+
+        private
+
+        # Wrapper method used by {govuk_character_count} and {govuk_character_count_with_form} to generate the character count HTML
+        #
+        # @param attribute [String, Symbol] the attribute of the character count
+        # @param govuk_character_count_options [Hash] options that will be used in customising the HTML.
+        #                                             This includes everything described in {govuk_character_count} and {govuk_character_count_with_form}
+        #                                             with the addition of the +:character_count_options+ which are described below
+        #
+        # @option govuk_character_count_options [String] :maxlength (required) - if +maxwords+ is set, this is not required.
+        #                                                           The maximum number of characters.
+        #                                                           If +maxwords+ is provided, the +maxlength+ option will be ignored.
+        # @option govuk_character_count_options [String] :maxwords (required) - if maxlength is set, this is not required.
+        #                                                          The maximum number of words.
+        #                                                          If +maxwords+ is provided, the +maxlength+ option will be ignored.
+        # @option govuk_character_count_options [String] :threshold the percentage value of the limit at which point the count message is displayed.
+        #                                                           If this attribute is set, the count message will be hidden by default.
+        # @option govuk_text_textarea_options [Hash] :fallback_hint ({}) additional parameters that will be used to create the hint containing the character count text.
+        #                                                                This includes all the options in {govuk_hint} plus +:count_message+.
+        #                                                                This will replace the default text for the count message.
+        #                                                                If you want the count number to appear, put %<count>s in the string and it will be replaced with the number
+        #
+        # @yield the textarea HTML generated by {govuk_character_count} or {govuk_character_count_with_form}
+        #
+        # @yieldparam govuk_text_textarea_options [Hash] the options used in the textarea called by {govuk_character_count} or {govuk_character_count_with_form}
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the chracter count which wrpas arround {govuk_character_count} or {govuk_character_count_with_form}
+
+        def _govuk_character_count(attribute, **govuk_character_count_options)
+          deep_init_hash(govuk_character_count_options, :textarea_options, :attributes, :aria)
+          govuk_character_count_options[:textarea_options][:attributes][:aria][:describedby] = [govuk_character_count_options.dig(:textarea_options, :attributes, :aria, :describedby), "#{attribute}-hint-info"].compact.join(' ')
+
+          govuk_character_count_options[:textarea_options][:classes] = [govuk_character_count_options[:textarea_options][:classes], 'govuk-js-character-count'].compact
+
+          tag.div(class: 'govuk-character-count', **get_character_count_attributes(**govuk_character_count_options)) do
+            capture do
+              concat(yield(govuk_character_count_options))
+              concat(character_count_hint(attribute, **govuk_character_count_options))
+            end
+          end
+        end
+
+        # Generates the fallback hint HTML for {_govuk_character_count}
+        #
+        # @param (see _govuk_character_count)
+        #
+        # @option (see _govuk_character_count)
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the fullback hint used in {_govuk_character_count}
+
+        def character_count_hint(attribute, **govuk_character_count_options)
+          fallback_hint_length = govuk_character_count_options[:character_count_options][:maxwords] || govuk_character_count_options[:character_count_options][:maxlength]
+          fallback_hint_default = "You can enter up to %<count>s #{govuk_character_count_options[:character_count_options][:maxwords] ? 'words' : 'characters'}"
+
+          deep_init_hash(govuk_character_count_options, :character_count_options, :fallback_hint, :attributes)
+
+          fallback_hint_text = format(govuk_character_count_options[:character_count_options][:fallback_hint][:count_message] || fallback_hint_default, count: fallback_hint_length)
+
+          govuk_character_count_options[:character_count_options][:fallback_hint][:classes] = [govuk_character_count_options.dig(:character_count_options, :fallback_hint, :classes), 'govuk-character-count__message']
+          govuk_character_count_options[:character_count_options][:fallback_hint][:attributes].merge!(id: "#{attribute}-hint-info")
+
+          govuk_hint(fallback_hint_text, **govuk_character_count_options[:character_count_options][:fallback_hint])
+        end
+
+        # Generates a hash with the character count attributes used in {_govuk_character_count}
+        #
+        # @param govuk_character_count_options [Hash] options that will be used in customising the HTML.
+        #                                             This includes everything described in {govuk_character_count} and {govuk_character_count_with_form}
+        #                                             with the addition of the +:character_count_options+ which are described below
+        #
+        # @option (see _govuk_character_count)
+        #
+        # @return [Hash] contains the HTMl attributes used in {_govuk_character_count}
+
+        def get_character_count_attributes(**govuk_character_count_options)
+          govuk_character_count_attributes = { data: { module: 'govuk-character-count' } }
+
+          %i[maxlength threshold maxwords].each do |data_attribute|
+            govuk_character_count_attributes[:data][data_attribute] = govuk_character_count_options[:character_count_options][data_attribute].to_s if govuk_character_count_options[:character_count_options][data_attribute]
+          end
+
+          govuk_character_count_attributes
+        end
+
+        # Method to initialise hashes within hashes if it is not already initialised
+        #
+        # @param hash [Hash] the hash that is going to be initialised
+        # @param keys [Array] the keys that are going to be initialised in the hash
+        #
+        # @example When the hash is completely empty
+        #   hash = { }
+        #   keys = [:a, :b, :c]
+        #
+        #   deep_init_hash(hash, *keys)
+        #
+        #   hash = { a: { b: { c: { } } } }
+        #
+        # @example When the hash has already been initialised
+        #   hash = { a: { b: { d: 'hello' } } }
+        #   keys = [:a, :b, :c]
+        #
+        #   deep_init_hash(hash, *keys)
+        #
+        #   hash = { a: { b: { d: 'hello', c: { } } } }
+
+        def deep_init_hash(hash, *keys)
+          current_hash = hash
+
+          keys.each { |key| current_hash = (current_hash[key] ||= {}) }
+        end
+      end
+    end
+  end
+end