ccs-frontend_helpers 0.1.0.rc.1 → 0.1.0.rc.2

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

@@ -0,0 +1,68 @@
+require_relative '../base'
+require_relative 'error_summary/item'
+
+module CCS::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

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

@@ -0,0 +1,127 @@
+require_relative 'textarea'
+require_relative '../../hint'
+
+module CCS::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

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

@@ -0,0 +1,42 @@
+require_relative '../input'
+
+module CCS::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

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

@@ -0,0 +1,80 @@
+require_relative '../input'
+
+module CCS::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

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

@@ -0,0 +1,53 @@
+require_relative '../text_input'
+
+module CCS::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

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

@@ -0,0 +1,95 @@
+require_relative '../input'
+require_relative 'text_input/fix'
+
+module CCS::Components
+  module GovUK
+    class Field < Base
+      class Input < Field
+        # = GOV.UK Input
+        #
+        # This is used for generating the input component from the
+        # {https://design-system.service.gov.uk/components/text-input GDS - Components - Text Input}
+        #
+        # @!attribute [r] field_type
+        #   @return [Symbol,String] The input field type
+        # @!attribute [r] value
+        #   @return [String] The value of the text input
+        # @!attribute [r] prefix
+        #   @return [Fix] The initialised prefix
+        # @!attribute [r] suffix
+        #   @return [Fix] The initialised suffix
+
+        class TextInput < Input
+          private
+
+          attr_reader :field_type, :value, :prefix, :suffix
+
+          public
+
+          # rubocop:disable Metrics/ParameterLists
+
+          # @param (see CCS::Components::GovUK::Field::Input#initialize)
+          # @param field_type [Symbol,String] (:text) the input field type
+          # @param value [String] the value if the input
+          # @param prefix [Hash] optional prefix for the input field,
+          #                      see {CCS::Components::GovUK::Field::Input::TextInput::Fix#initialize Fix#initialize} for more details.
+          # @param suffix [Hash] optional suffix for the input field,
+          #                      see {CCS::Components::GovUK::Field::Input::TextInput::Fix#initialize Fix#initialize} for more details.
+          #
+          # @option (see CCS::Components::GovUK::Field::Input#initialize)
+
+          def initialize(attribute:, field_type: :text, value: nil, prefix: nil, suffix: nil, **options)
+            super(attribute: attribute, **options)
+
+            @field_type = :"#{field_type}_field"
+            @value = @options[:model] ? @options[:model].send(attribute) : value
+            @prefix = Fix.new(fix: 'pre', context: @context, **prefix) if prefix
+            @suffix = Fix.new(fix: 'suf', context: @context, **suffix) if suffix
+          end
+
+          # rubocop:enable Metrics/ParameterLists
+
+          # Generates the HTML for the GOV.UK Text Input component
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            super() do
+              text_input_wrapper do
+                if options[:form]
+                  options[:form].send(field_type, attribute, **options[:attributes])
+                else
+                  context.send("#{field_type}_tag", attribute, value, **options[:attributes])
+                end
+              end
+            end
+          end
+
+          # The default attributes for the text input
+
+          DEFAULT_ATTRIBUTES = { class: 'govuk-input' }.freeze
+
+          private
+
+          # Wrapper method used by {render} to wrap the text input with a prefix or suffix if they exist
+          #
+          # @yield the text input HTML
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def text_input_wrapper
+            if prefix || suffix
+              tag.div(class: 'govuk-input__wrapper') do
+                concat(prefix.render) if prefix
+                concat(yield)
+                concat(suffix.render) if suffix
+              end
+            else
+              yield
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+require_relative '../input'
+
+module CCS::Components
+  module GovUK
+    class Field < Base
+      class Input < Field
+        # = GOV.UK Textarea
+        #
+        # This helper is used for generating the textarea component from the
+        # {https://design-system.service.gov.uk/components/textarea GDS - Components - Textarea}
+        #
+        # @!attribute [r] content
+        #   @return [String] The content of the textarea
+
+        class Textarea < Input
+          private
+
+          attr_reader :content
+
+          public
+
+          # @param (see CCS::Components::GovUK::Field::Input#initialize)
+          # @param content [String] the content of the textarea
+          # @param rows [Integer] the number of rows for the text area
+          #
+          # @option (see CCS::Components::GovUK::Field::Input#initialize)
+
+          def initialize(attribute:, content: nil, rows: 5, **options)
+            super(attribute: attribute, **options)
+
+            @options[:attributes][:rows] ||= rows
+
+            @content = @options[:model] ? @options[:model].send(attribute) : content
+          end
+
+          # Generates the HTML for the GOV.UK Textarea component
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            super() do
+              if options[:form]
+                options[:form].text_area(attribute, **options[:attributes])
+              else
+                context.text_area_tag(attribute, content, **options[:attributes])
+              end
+            end
+          end
+
+          # The default attributes for the textarea
+
+          DEFAULT_ATTRIBUTES = { class: 'govuk-textarea' }.freeze
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+require_relative '../field'
+require_relative '../label'
+
+module CCS::Components
+  module GovUK
+    class Field < Base
+      # = GOV.UK Field Input
+      #
+      # This class is used to create a form for an individual field, e.g. text input or select.
+      # It will wrap the input in the form group and:
+      # - display the label
+      # - display the hint (if there is one)
+      # - find and display the error message (if there is one)
+      #
+      # @!attribute [r] label
+      #   @return [Label] The initialised label
+
+      class Input < Field
+        private
+
+        attr_reader :label
+
+        public
+
+        # @param (see CCS::Components::GovUK::Field#initialize)
+        # @param label [Hash] attributes for the label, see {CCS::Components::GovUK::Label#initialize Label#initialize} for more details.
+        #
+        # @option (see CCS::Components::GovUK::Field#initialize)
+
+        def initialize(attribute:, label:, **options)
+          super(attribute: attribute, **options)
+
+          set_described_by(@options, @attribute, @error_message, options[:hint])
+
+          @options[:attributes][:class] << " #{self.class::DEFAULT_ATTRIBUTES[:class]}--error" if @error_message
+
+          field_id = @options.dig(:attributes, :id)
+          (label[:attributes] ||= {})[:for] = field_id if field_id
+
+          @label = Label.new(attribute: attribute, form: @options[:form], context: @context, **label)
+        end
+
+        # Generates the HTML to wrap arround a GDS form component
+        #
+        # @yield (see CCS::Components::GovUK::Field#render)
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          super() do |display_error_message|
+            concat(label.render)
+            concat(hint.render) if hint
+            concat(display_error_message)
+            concat(yield)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/field/inputs/checkboxes.rb

@@ -0,0 +1,67 @@
+require_relative '../input'
+require_relative 'item/divider'
+require_relative 'item/checkbox/form'
+require_relative 'item/checkbox/tag'
+
+module CCS::Components
+  module GovUK
+    class Field < Base
+      class Inputs < Field
+        # = GOV.UK Checkboxes
+        #
+        # This is used for generating the checkboxes component from the
+        # {https://design-system.service.gov.uk/components/checkboxes GDS - Components - Checkboxes}
+        #
+        # @!attribute [r] checkbox_items
+        #   @return [Array<Item::Divider|Item::Checkbox|Item::Checkbox>] An array of the initialised checkbox items
+
+        class Checkboxes < Inputs
+          private
+
+          attr_reader :checkbox_items
+
+          public
+
+          # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+          # @param (see CCS::Components::GovUK::Field::Inputs#initialize)
+          # @param checkbox_items [Array<Hash>] an array of options for the checkboxes.
+          #                                     See {Components::GovUK::Field::Inputs::Item::Checkbox#initialize Checkbox#initialize} for details of the items in the array.
+          #
+          # @option (see CCS::Components::GovUK::Field::Inputs#initialize)
+
+          def initialize(attribute:, checkbox_items:, **options)
+            super(attribute: attribute, **options)
+
+            if @options[:model] || @options[:form]
+              values = (@options[:model] || @options[:form].object).send(attribute) || []
+              checkbox_items.each { |checkbox_item| checkbox_item[:checked] = values.include?(checkbox_item[:value]) }
+            end
+
+            checkbox_item_class = @options[:form] ? Item::Checkbox::Form : Inputs::Item::Checkbox::Tag
+
+            @checkbox_items = checkbox_items.map { |checkbox_item| checkbox_item[:divider] ? Item::Divider.new(divider: checkbox_item[:divider], type: 'checkboxes') : checkbox_item_class.new(attribute: attribute, form: @options[:form], context: @context, **checkbox_item) }
+          end
+
+          # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+          # Generates the HTML for the GOV.UK Checkboxes component
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            super() do
+              tag.div(**options[:attributes]) do
+                checkbox_items.each { |checkbox_item| concat(checkbox_item.render) }
+              end
+            end
+          end
+
+          # The default attributes for the checkboxes
+
+          DEFAULT_ATTRIBUTES = { class: 'govuk-checkboxes', data: { module: 'govuk-checkboxes' } }.freeze
+        end
+      end
+    end
+  end
+end