ccs-frontend_helpers 0.1.0 → 0.1.1.rc.1

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

@@ -0,0 +1,55 @@
+require_relative '../base'
+require_relative 'cookie_banner/message'
+
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK Cookie Banner
+      #
+      # This is used to generate the cookie banner component from the
+      # {https://design-system.service.gov.uk/components/cookie-banner GDS - Components - Cookie banner}
+      #
+      # @!attribute [r] messages
+      #   @return [Array<Message>] An array of the initialised cookie banner messages
+
+      class CookieBanner < Base
+        private
+
+        attr_reader :messages
+
+        public
+
+        # @param messages [Array<Hash>] An array of messages for the cookie banner.
+        #                               See {Components::GovUK::CookieBanner::Message#initialize Message#initialize} for details of the items in the array.
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option options [String] :classes additional CSS classes for the cookie banner HTML
+        # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+
+        def initialize(messages:, **options)
+          super(**options)
+
+          (@options[:attributes][:data] ||= {})[:nosnippet] = 'true'
+          @options[:attributes][:role] = 'region'
+          (@options[:attributes][:aria] ||= {})[:label] ||= 'Cookie banner'
+
+          @messages = messages.map { |message| Message.new(context: @context, **message) }
+        end
+
+        # Generates the HTML for the GOV.UK Cookie banner component
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.div(**options[:attributes]) do
+            messages.each { |message| concat(message.render) }
+          end
+        end
+
+        # The default attributes for the cookie banner
+
+        DEFAULT_ATTRIBUTES = { class: 'govuk-cookie-banner' }.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+require_relative '../base'
+
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK Details
+      #
+      # This is used to generate the details component from the
+      # {https://design-system.service.gov.uk/components/details GDS - Components - Details}
+      #
+      # @!attribute [r] summary_text
+      #   @return [String] Summary text for the details element
+
+      class Details < Base
+        private
+
+        attr_reader :summary_text
+
+        public
+
+        # @param summary_text [String] the summary text for the details element
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option options [String] :classes additional CSS classes for the details HTML
+        # @option options [Hash] :attributes ({ data: { module: 'govuk-details' } }) any additional attributes that will added as part of the HTML
+
+        def initialize(summary_text:, **options)
+          super(**options)
+
+          @summary_text = summary_text
+        end
+
+        # Generates the HTML for the GOV.UK Details component
+        #
+        # @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 render(&block)
+          tag.details(**options[:attributes]) 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))
+          end
+        end
+
+        # The default attributes for the details
+
+        DEFAULT_ATTRIBUTES = { class: 'govuk-details', data: { module: 'govuk-details' } }.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+require_relative '../base'
+
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK Error Message
+      #
+      # This is used to generate the error message component from the
+      # {https://design-system.service.gov.uk/components/error-message GDS - Components - Error message}
+      #
+      # @!attribute [r] message
+      #   @return [String] Text for the error message
+      # @!attribute [r] attribute
+      #   @return [String,Symbol] The attribute that has an error
+      # @!attribute [r] visually_hidden_text
+      #   @return [String] The visually hidden text before the error message
+
+      class ErrorMessage < Base
+        private
+
+        attr_reader :message, :attribute, :visually_hidden_text
+
+        public
+
+        # @param message [String] the message to be displayed
+        # @param attribute [String, Symbol] the attribute that has an error
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option options [String] :classes additional CSS classes for the error message HTML
+        # @option options [String] :visually_hidden_text ('Error') visualy hidden text before the error message
+        # @option options [Hash] :attributes ({}) any additional attributes that will be added as part of the HTML
+
+        def initialize(message:, attribute:, **options)
+          super(**options)
+
+          @options[:attributes][:id] ||= "#{attribute}-error"
+
+          @message = message
+          @attribute = attribute
+          @visually_hidden_text = @options[:visually_hidden_text] || 'Error'
+        end
+
+        # Generates the HTML for the GOV.UK Error message component
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.p(**options[:attributes]) do
+            concat(tag.span("#{visually_hidden_text}: ", class: 'govuk-visually-hidden')) if visually_hidden_text.present?
+            concat(message)
+          end
+        end
+
+        # The default attributes for the error message
+
+        DEFAULT_ATTRIBUTES = { class: 'govuk-error-message' }.freeze
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/error_summary/item.rb

@@ -0,0 +1,54 @@
+require_relative '../../base'
+
+module CCS
+  module Components
+    module GovUK
+      class ErrorSummary < Base
+        # = GOV.UK Error Summary Item
+        #
+        # The individual list item for the error summary
+        #
+        # @!attribute [r] text
+        #   @return [String] Text for the error message item
+        # @!attribute [r] href
+        #   @return [String] The href for the error message
+
+        class Item < Base
+          private
+
+          attr_reader :text, :href
+
+          public
+
+          # @param text [String] the text for the error link item
+          # @param href [String] the href for the error link item.
+          #                      If provided item will be a link
+          # @param options [Hash] options that will be used in customising the HTML
+          #
+          # @option options [Hash] :attributes any additional attributes that will added as part of the HTML.
+
+          def initialize(text:, href: nil, **options)
+            super(**options)
+
+            @text = text
+            @href = href
+          end
+
+          # Generates the HTML for the GOV.UK Error Summary Item
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            tag.li do
+              if href
+                link_to(text, href, **options[:attributes])
+              else
+                text
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+require_relative '../base'
+require_relative 'error_summary/item'
+
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK Error Summary
+      #
+      # This is used to generate the error summary component from the
+      # {https://design-system.service.gov.uk/components/error-summary GDS - Components - Error summary}
+      #
+      # @!attribute [r] title
+      #   @return [String] Heading for the error summary
+      # @!attribute [r] error_summary_items
+      #   @return [Array<Item>] An array of the initialised error summary items
+      # @!attribute [r] description
+      #   @return [String] Text to use for the description of the errors
+
+      class ErrorSummary < Base
+        private
+
+        attr_reader :title, :error_summary_items, :description
+
+        public
+
+        # @param title [String] text to use for the heading of the error summary block
+        # @param error_summary_items [Array<Hash>] the list of errors to include in the summary. See {Components::GovUK::ErrorSummary::Item#initialize Item#initialize}
+        # @param description [String] optional text to use for the description of the errors
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option options [String] :classes additional CSS classes for the error summary HTML
+        # @option options [Hash] :attributes ({}) any additional attributes that will be added as part of the HTML
+
+        def initialize(title:, error_summary_items:, description: nil, **options)
+          super(**options)
+
+          @title = title
+          @error_summary_items = error_summary_items.map { |error_summary_item| Item.new(context: @context, **error_summary_item) }
+          @description = description
+        end
+
+        # rubocop:disable Metrics/AbcSize
+
+        # Generates the HTML for the GOV.UK Error summary component
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.div(**options[:attributes]) do
+            tag.div(role: 'alert') do
+              concat(tag.h2(title, class: 'govuk-error-summary__title'))
+              concat(tag.div(class: 'govuk-error-summary__body') do
+                concat(tag.p(description)) if description
+                concat(tag.ul(class: 'govuk-list govuk-error-summary__list') do
+                  error_summary_items.each { |error_summary_item| concat(error_summary_item.render) }
+                end)
+              end)
+            end
+          end
+        end
+
+        # rubocop:enable Metrics/AbcSize
+
+        # The default attributes for the error summary
+
+        DEFAULT_ATTRIBUTES = { class: 'govuk-error-summary', data: { module: 'govuk-error-summary' } }.freeze
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/field/input/character_count.rb

@@ -0,0 +1,129 @@
+require_relative 'textarea'
+require_relative '../../hint'
+
+module CCS
+  module Components
+    module GovUK
+      class Field < Base
+        class Input < Field
+          # = GOV.UK Character count
+          #
+          # This 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}
+          #
+          # @!attribute [r] textarea
+          #   @return [Textarea] The initialised textarea
+          # @!attribute [r] fallback_hint
+          #   @return [Hint] The initialised character count fallback hint
+          # @!attribute [r] character_count_html_options
+          #   @return [Hash] HTML options for the character count
+
+          class CharacterCount
+            include ActionView::Context
+            include ActionView::Helpers
+
+            private
+
+            attr_reader :textarea, :fallback_hint, :character_count_html_options
+
+            public
+
+            # @param (see CCS::Components::GovUK::Field::Input::Textarea#initialize)
+            # @param character_count_options [Hash] options for the character count
+            # @param context [ActionView::Base] the view context
+            #
+            # @option (see CCS::Components::GovUK::Field::Input::Textarea#initialize)
+            #
+            # @option (see initialise_character_count_html_options)
+
+            def initialize(attribute:, character_count_options:, context:, **options)
+              character_count_attribute = options[:form] ? "#{options[:form].object_name}_#{attribute}" : attribute
+
+              initialise_textarea(attribute, character_count_attribute, context, options)
+              initialise_character_count_html_options(character_count_options)
+              initialise_fallback_hint(character_count_attribute, context, character_count_options)
+            end
+
+            # Generates the HTML for the GOV.UK Character count component
+            #
+            # @return [ActiveSupport::SafeBuffer]
+
+            def render
+              tag.div(**character_count_html_options) do
+                concat(textarea.render)
+                concat(fallback_hint.render)
+              end
+            end
+
+            private
+
+            # Initialises the Textarea for the character count
+            #
+            # @param attribute [Symbol] the attribute of the field
+            # @param character_count_attribute [String] the name of the field as it will appear in the textarea
+            # @param context [ActionView::Base] the view context
+            # @param options [Hash] options that will be used for the textarea
+            #
+            # @option (see CCS::Components::GovUK::Field::Input::Textarea#initialize)
+
+            def initialise_textarea(attribute, character_count_attribute, context, options)
+              ((options[:attributes] ||= {})[:aria] ||= {})[:describedby] = [options.dig(:attributes, :aria, :describedby), "#{character_count_attribute}-info"].compact.join(' ')
+              options[:classes] = "#{options[:classes]} govuk-js-character-count".lstrip
+
+              @textarea = Textarea.new(attribute: attribute, context: context, **options)
+            end
+
+            # Initialises the charcter count options
+            #
+            # @param character_count_options [Hash] options for the charcter count
+            #
+            # @option character_count_options [String] :maxlength the maximum number of characters.
+            #                                                     If +maxwords+ is set, this is not required.
+            #                                                     If +maxwords+ is provided, the +maxlength+ option will be ignored.
+            # @option character_count_options [String] :maxwords the maximum number of words.
+            #                                                    If maxlength is set, this is not required.
+            #                                                    If +maxwords+ is provided, the +maxlength+ option will be ignored.
+            # @option 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 character_count_options [Hash] :fallback_hint ({}) additional parameters that will be used to create the hint containing the character count text:
+            #                                                            - +:count_message+ replaced 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
+            #                                                            - +classes+ additional CSS classes for the fallback hint HTML
+
+            def initialise_character_count_html_options(character_count_options)
+              character_count_html_options = { class: 'govuk-character-count', data: { module: 'govuk-character-count' } }
+
+              %i[maxlength threshold maxwords].each do |data_attribute|
+                character_count_html_options[:data][data_attribute] = character_count_options[data_attribute].to_s if character_count_options[data_attribute]
+              end
+
+              @character_count_html_options = character_count_html_options
+            end
+
+            # Initialises the charcter count fall back hint
+            #
+            # @param character_count_attribute [String] the name of the field as it will appear in the textarea
+            # @param context [ActionView::Base] the view context
+            # @param (see initialise_character_count_html_options)
+            #
+            # @option (see initialise_character_count_html_options)
+
+            def initialise_fallback_hint(character_count_attribute, context, character_count_options)
+              fallback_hint = character_count_options[:fallback_hint] || {}
+
+              fallback_hint_length = character_count_options[:maxwords] || character_count_options[:maxlength]
+              fallback_hint_default = "You can enter up to %<count>s #{character_count_options[:maxwords] ? 'words' : 'characters'}"
+
+              text = format(fallback_hint[:count_message] || fallback_hint_default, count: fallback_hint_length)
+              classes = "#{fallback_hint[:classes]} govuk-character-count__message".lstrip
+
+              @fallback_hint = Hint.new(text: text, classes: classes, attributes: { id: "#{character_count_attribute}-info" }, context: context)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/field/input/file_upload.rb

@@ -0,0 +1,44 @@
+require_relative '../input'
+
+module CCS
+  module Components
+    module GovUK
+      class Field < Base
+        class Input < Field
+          # = GOV.UK File Upload
+          #
+          # This is used for generating the file upload component from the
+          # {https://design-system.service.gov.uk/components/file-upload GDS - Components - File Upload}
+
+          class FileUpload < Input
+            # @param (see CCS::Components::GovUK::Field::Input#initialize)
+            #
+            # @option (see CCS::Components::GovUK::Field::Input#initialize)
+
+            def initialize(attribute:, **options)
+              super(attribute: attribute, **options)
+            end
+
+            # Generates the HTML for the GOV.UK File Upload component
+            #
+            # @return [ActiveSupport::SafeBuffer]
+
+            def render
+              super() do
+                if options[:form]
+                  options[:form].file_field(attribute, **options[:attributes])
+                else
+                  context.file_field_tag(attribute, **options[:attributes])
+                end
+              end
+            end
+
+            # The default attributes for the file upload
+
+            DEFAULT_ATTRIBUTES = { class: 'govuk-file-upload' }.freeze
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/field/input/select.rb

@@ -0,0 +1,82 @@
+require_relative '../input'
+
+module CCS
+  module Components
+    module GovUK
+      class Field < Base
+        class Input < Field
+          # = GOV.UK Select
+          #
+          # This is used for generating the select component from the
+          # {https://design-system.service.gov.uk/components/select GDS - Components - Select}
+          #
+          # @!attribute [r] items
+          #   @return [Array<Hash>] The select items
+          # @!attribute [r] selected
+          #   @return [String] The selected option
+
+          class Select < Input
+            private
+
+            attr_reader :items, :selected
+
+            public
+
+            # @param (see CCS::Components::GovUK::Field::Input#initialize)
+            # @param items [Array<Hash>] array of options for select.
+            #                            The options are:
+            #                            - +:text+ the text of the option item. If this is blank the value is used
+            #                            - +:value+ the value of the option item
+            #                            - +:attributes+ any additional attributes that will added as part of the option HTML
+            # @param selected [String] the selected option
+            #
+            # @option (see CCS::Components::GovUK::Field::Input#initialize)
+
+            def initialize(attribute:, items:, selected: nil, **options)
+              super(attribute: attribute, **options)
+
+              @items = items.map do |item|
+                [
+                  item[:text] || item[:value],
+                  item[:value],
+                  (item[:attributes] || {})
+                ]
+              end
+              @selected = @options[:model] ? @options[:model].send(attribute) : selected
+            end
+
+            # Generates the HTML for the GOV.UK Select component
+            #
+            # @return [ActiveSupport::SafeBuffer]
+
+            def render
+              super() do
+                if options[:form]
+                  options[:form].select(
+                    attribute,
+                    items,
+                    {},
+                    **options[:attributes]
+                  )
+                else
+                  context.select_tag(
+                    attribute,
+                    context.options_for_select(
+                      items,
+                      selected
+                    ),
+                    **options[:attributes]
+                  )
+                end
+              end
+            end
+
+            # The default attributes for the select
+
+            DEFAULT_ATTRIBUTES = { class: 'govuk-select' }.freeze
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/field/input/text_input/fix.rb

@@ -0,0 +1,55 @@
+require_relative '../text_input'
+
+module CCS
+  module Components
+    module GovUK
+      class Field < Base
+        class Input < Field
+          class TextInput < Input
+            # = GOV.UK Text Input prefix/suffix
+            #
+            # This is used to generate the prefix/suffix HTML for a text input
+            #
+            # @!attribute [r] text
+            #   @return [String] Text for the prefix/suffix
+
+            class Fix < Base
+              private
+
+              attr_reader :text
+
+              public
+
+              # @param text [String] the text for the prefix/suffix
+              # @param fix [String] either +"pre"+ or +"suf"+
+              #
+              # @param options [Hash] options that will be used in customising the HTML
+              #
+              # @option options [String] :classes additional CSS classes for the prefix/suffix HTML
+              # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+
+              def initialize(text:, fix:, **options)
+                super(**options)
+
+                @options[:attributes][:class] = "govuk-input__#{fix}fix #{@options[:attributes][:class]}".rstrip
+                (@options[:attributes][:aria] ||= {})[:hidden] = true
+
+                @text = text
+              end
+
+              # Generates the HTML for the GOV.UK Text Input prefix/suffix
+              #
+              # @yield (see CCS::Components::GovUK::Field#render)
+              #
+              # @return [ActiveSupport::SafeBuffer]
+
+              def render
+                tag.div(text, **options[:attributes])
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end