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

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

@@ -1,58 +1,60 @@
 require_relative '../base'
 
-module CCS::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
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK Error Message
       #
-      # @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
+      # 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
 
-      def initialize(message:, attribute:, **options)
-        super(**options)
+      class ErrorMessage < Base
+        private
 
-        @options[:attributes][:id] ||= "#{attribute}-error"
+        attr_reader :message, :attribute, :visually_hidden_text
 
-        @message = message
-        @attribute = attribute
-        @visually_hidden_text = @options[:visually_hidden_text] || 'Error'
-      end
+        public
 
-      # Generates the HTML for the GOV.UK Error message component
-      #
-      # @return [ActiveSupport::SafeBuffer]
+        # @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"
 
-      def render
-        tag.p(**options[:attributes]) do
-          concat(tag.span("#{visually_hidden_text}: ", class: 'govuk-visually-hidden')) if visually_hidden_text.present?
-          concat(message)
+          @message = message
+          @attribute = attribute
+          @visually_hidden_text = @options[:visually_hidden_text] || 'Error'
         end
-      end
 
-      # The default attributes for the error message
+        # 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
 
-      DEFAULT_ATTRIBUTES = { class: 'govuk-error-message' }.freeze
+        # 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

@@ -1,48 +1,50 @@
 require_relative '../../base'
 
-module CCS::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
+module CCS
+  module Components
+    module GovUK
+      class ErrorSummary < Base
+        # = GOV.UK Error Summary Item
         #
-        # @option options [Hash] :attributes any additional attributes that will added as part of the HTML.
+        # 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
 
-        def initialize(text:, href: nil, **options)
-          super(**options)
+        class Item < Base
+          private
 
-          @text = text
-          @href = href
-        end
+          attr_reader :text, :href
 
-        # 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
+          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

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

@@ -1,68 +1,70 @@
 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
+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
+      class ErrorSummary < Base
+        private
 
-      attr_reader :title, :error_summary_items, :description
+        attr_reader :title, :error_summary_items, :description
 
-      public
+        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
+        # @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)
+        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
+          @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
+        # rubocop:disable Metrics/AbcSize
 
-      # Generates the HTML for the GOV.UK Error summary component
-      #
-      # @return [ActiveSupport::SafeBuffer]
+        # 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) }
+        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
         end
-      end
 
-      # rubocop:enable Metrics/AbcSize
+        # rubocop:enable Metrics/AbcSize
 
-      # The default attributes for the error summary
+        # The default attributes for the error summary
 
-      DEFAULT_ATTRIBUTES = { class: 'govuk-error-summary', data: { module: 'govuk-error-summary' } }.freeze
+        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

@@ -1,124 +1,126 @@
 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
+module CCS
+  module Components
+    module GovUK
+      class Field < Base
+        class Input < Field
+          # = GOV.UK Character count
           #
-          # @option (see CCS::Components::GovUK::Field::Input::Textarea#initialize)
+          # This is used for generating the character count component from the
+          # {https://design-system.service.gov.uk/components/character-count GDS - Components - Character count}
           #
-          # @option (see initialise_character_count_html_options)
+          # 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
 
-          def initialize(attribute:, character_count_options:, context:, **options)
-            character_count_attribute = options[:form] ? "#{options[:form].object_name}_#{attribute}" : attribute
+          class CharacterCount
+            include ActionView::Context
+            include ActionView::Helpers
 
-            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
+            private
 
-          # Generates the HTML for the GOV.UK Character count component
-          #
-          # @return [ActiveSupport::SafeBuffer]
+            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 render
-            tag.div(**character_count_html_options) do
-              concat(textarea.render)
-              concat(fallback_hint.render)
+            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
-          end
 
-          private
+            # Generates the HTML for the GOV.UK Character count component
+            #
+            # @return [ActiveSupport::SafeBuffer]
 
-          # 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 render
+              tag.div(**character_count_html_options) do
+                concat(textarea.render)
+                concat(fallback_hint.render)
+              end
+            end
 
-          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
+            private
 
-            @textarea = Textarea.new(attribute: attribute, context: context, **options)
-          end
+            # 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)
 
-          # 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]
+            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
 
-            @character_count_html_options = character_count_html_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)
+            # 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] || {}
+            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'}"
+              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
+              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)
+              @fallback_hint = Hint.new(text: text, classes: classes, attributes: { id: "#{character_count_attribute}-info" }, context: context)
+            end
           end
         end
       end

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

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