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

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

@@ -0,0 +1,56 @@
+require_relative '../base'
+require_relative 'accordion/section'
+
+module CCS::Components
+  module GovUK
+    # = GOV.UK Accordion
+    #
+    # This is used for generating the accordion component from the
+    # {https://design-system.service.gov.uk/accordion/back-link GDS - Components - Accordion}
+    #
+    # @!attribute [r] accordion_sections
+    #   @return [Array<Section>] An array of the initialised accordion sections
+
+    class Accordion < Base
+      private
+
+      attr_reader :accordion_sections
+
+      public
+
+      # @param accordion_id [String] used as an id in the HTML for the accordion as a whole,
+      #                              and also as a prefix for the ids of the section contents
+      #                              and the buttons that open them
+      # @param accordion_sections [Array<Hash>] an array of accordion section attributes.
+      #                                         See {Components::GovUK::Accordion::Section#initialize Section#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 accordion HTML
+      # @option options [Integer] :heading_level (2) heading level, from 1 to 6
+      # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+
+      def initialize(accordion_id:, accordion_sections:, **options)
+        super(**options)
+
+        @options[:attributes][:id] = accordion_id
+        @options[:heading_level] ||= 2
+
+        @accordion_sections = accordion_sections.map.with_index(1) { |accordion_section, index| Section.new(section: accordion_section, accordion_id: accordion_id, index: index, heading_level: @options[:heading_level]) }
+      end
+
+      # Generates the HTML for the GOV.UK Accordion component
+      #
+      # @return [ActiveSupport::SafeBuffer]
+
+      def render
+        tag.div(**options[:attributes]) do
+          accordion_sections.each { |accordion_section| concat(accordion_section.render) }
+        end
+      end
+
+      # The default attributes for the accordion
+
+      DEFAULT_ATTRIBUTES = { class: 'govuk-accordion', data: { module: 'govuk-accordion' } }.freeze
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+require_relative '../base'
+
+module CCS::Components
+  module GovUK
+    # = GOV.UK Back Link
+    #
+    # This is used to generate the back link component from the
+    # {https://design-system.service.gov.uk/components/back-link GDS - Components - Back link}
+    #
+    # @!attribute [r] text
+    #   @return [String] Text for the back link
+    # @!attribute [r] href
+    #   @return [String] The href for the back link
+
+    class BackLink < Base
+      private
+
+      attr_reader :text, :href
+
+      public
+
+      # @param text [String] the text for the back link
+      # @param href [String] the href for the back link
+      # @param options [Hash] options that will be used in customising the HTML
+      #
+      # @option options [String] :classes additional CSS classes for the back link HTML
+      # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+
+      def initialize(text:, href:, **options)
+        super(**options)
+
+        @text = text
+        @href = href
+      end
+
+      # Generates the HTML for the GOV.UK Back link component
+      #
+      # @return [ActiveSupport::SafeBuffer]
+
+      def render
+        link_to(text, href, **options[:attributes])
+      end
+
+      # The default attributes for the back link
+
+      DEFAULT_ATTRIBUTES = { class: 'govuk-back-link' }.freeze
+    end
+  end
+end

data/lib/ccs/components/govuk/breadcrumbs/link.rb

@@ -0,0 +1,55 @@
+require_relative '../../base'
+
+module CCS::Components
+  module GovUK
+    class Breadcrumbs < Base
+      # = GOV.UK Breadcrumbs Link
+      #
+      # The individual list item for the breadcrumbs
+      #
+      # @!attribute [r] text
+      #   @return [String] Text for the breadcrumb link
+      # @!attribute [r] href
+      #   @return [String] The href for the breadcrumb link
+
+      class Link < Base
+        private
+
+        attr_reader :text, :href
+
+        public
+
+        # @param text [String] the text for the breadcrumb link
+        # @param href [String] the href for the breadcrumb link.
+        #                      If blank it is assumed that this item relates to current page
+        # @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.
+        #                                    If the link is blank then it defaults to +{ aria: { current: 'page' } }+
+
+        def initialize(text:, href: nil, **options)
+          super(**options)
+
+          @text = text
+          @href = href
+        end
+
+        # Generates the HTML for the GOV.UK Breadcrumbs link
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          if href.present?
+            options[:attributes][:class] = 'govuk-breadcrumbs__link'
+
+            tag.li(class: 'govuk-breadcrumbs__list-item') do
+              link_to(text, href, **options[:attributes])
+            end
+          else
+            tag.li(text, class: 'govuk-breadcrumbs__list-item', aria: { current: 'page' })
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+require_relative '../base'
+require_relative 'breadcrumbs/link'
+
+module CCS::Components
+  module GovUK
+    # = GOV.UK Breadcrumbs
+    #
+    # This is used to generate the breadcrumbs component from the
+    # {https://design-system.service.gov.uk/components/breadcrumbs GDS - Components - Breadcrumbs}
+    #
+    # @!attribute [r] breadcrumb_links
+    #   @return [Array<Link>] An array of the initialised breadcrumb links
+
+    class Breadcrumbs < Base
+      private
+
+      attr_reader :breadcrumb_links
+
+      public
+
+      # @param breadcrumb_links [Array<Hash>] An array of links for the breadcrumbs list.
+      #                                       See {Components::GovUK::Breadcrumbs::Link#initialize Link#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 breadcrumbs HTML
+      # @option options [Boolean] :collapse_on_mobile indicates if it is to colapse breadcrumbs on mobile
+      # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+
+      def initialize(breadcrumb_links:, **options)
+        super(**options)
+        @options[:attributes][:class] << ' govuk-breadcrumbs--collapse-on-mobile' if @options[:collapse_on_mobile]
+
+        @breadcrumb_links = breadcrumb_links.map { |breadcrumb_link| Link.new(context: @context, **breadcrumb_link) }
+      end
+
+      # Generates the HTML for the GOV.UK breadcrumbs component
+      #
+      # @return [ActiveSupport::SafeBuffer]
+
+      def render
+        tag.div(**options[:attributes]) do
+          tag.ol(class: 'govuk-breadcrumbs__list') do
+            breadcrumb_links.each { |breadcrumb_link| concat(breadcrumb_link.render) }
+          end
+        end
+      end
+
+      # The default attributes for the breadcrumbs
+
+      DEFAULT_ATTRIBUTES = { class: 'govuk-breadcrumbs' }.freeze
+    end
+  end
+end

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

@@ -0,0 +1,105 @@
+require_relative '../base'
+
+module CCS::Components
+  module GovUK
+    # = GOV.UK Button
+    #
+    # This is used to generate the button component from the
+    # {https://design-system.service.gov.uk/components/button GDS - Components - Button}
+    #
+    # @!attribute [r] text
+    #   @return [String] Text for the button
+    # @!attribute [r] render_method
+    #   @return [String] The method that will be used to render the button
+
+    class Button < Base
+      private
+
+      attr_reader :text, :render_method
+
+      public
+
+      # @param text [String] the text that will be shown in the button
+      # @param options [Hash] options that will be used in customising the HTML
+      #
+      # @option options [String] :classes additional CSS classes for the button HTML
+      # @option options [Boolean] :is_start_button indicates if it is a start button
+      # @option options [String] :href the URI that will be used in anchor tag
+      # @option options [ActionView::Helpers::FormBuilder] :form the form builder used to create the submit button
+      # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+
+      def initialize(text:, **options)
+        super(**options)
+
+        @options[:attributes][:class] << ' govuk-button--disabled' if @options[:attributes][:disabled]
+        @options[:attributes][:class] << ' govuk-button--start' if @options[:is_start_button]
+
+        @text = text
+        @render_method = :"render_#{if @options[:href]
+                                      :link
+                                    elsif @options[:form]
+                                      :submit
+                                    else
+                                      :button
+                                    end}"
+      end
+
+      # Generates the HTML for the GOV.UK Back link component
+      #
+      # @return [ActiveSupport::SafeBuffer]
+
+      def render
+        send(@render_method)
+      end
+
+      # The default attributes for the button
+
+      DEFAULT_ATTRIBUTES = { class: 'govuk-button', data: { module: 'govuk-button' } }.freeze
+
+      private
+
+      # Generates the HTML for the GOV.UK button component as an anchor tag.
+      #
+      # @return [ActiveSupport::SafeBuffer]
+
+      def render_link
+        @options[:attributes][:role] = :button
+        @options[:attributes][:draggable] = false
+
+        link_to(@options[:href], **@options[:attributes]) do
+          concat(text)
+          concat(start_button_icon) if @options[:is_start_button]
+        end
+      end
+
+      # Generates the HTML for the GOV.UK button component as a button.
+      #
+      # @return [ActiveSupport::SafeBuffer]
+
+      def render_button
+        button_tag(**@options[:attributes]) do
+          concat(text)
+          concat(start_button_icon) if @options[:is_start_button]
+        end
+      end
+
+      # Generates the HTML for the GOV.UK button component as an input.
+      #
+      # @return [ActiveSupport::SafeBuffer]
+
+      def render_submit
+        @options[:form].submit(text, **@options[:attributes])
+      end
+
+      # Generates the arrow if the button is a start button
+      #
+      # @return [ActiveSupport::SafeBuffer]
+
+      def start_button_icon
+        tag.svg(class: 'govuk-button__start-icon', xmlns: 'http://www.w3.org/2000/svg', width: 17.5, height: 19, viewBox: '0 0 33 40', aria: { hidden: true }, focusable: false) do
+          tag.path(fill: 'currentColor', d: 'M0 0h13l20 20-20 20H0l20-20z')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+require_relative '../../base'
+require_relative '../button'
+
+module CCS::Components
+  module GovUK
+    class CookieBanner < Base
+      # = GOV.UK Cookie Banner Action
+      #
+      # The individual cookie banner action.
+      # It defaults to creating button unless a +href+ is set which will create a link
+      #
+      # @!attribute [r] text
+      #   @return [String] Text for the action
+      # @!attribute [r] href
+      #   @return [String] The href for the action
+
+      class Action < Base
+        private
+
+        attr_reader :text, :href
+
+        public
+
+        # @param text [String] the button or link text
+        # @param href [String] the href for a link
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option options [String] : classes additional CSS classes for the cookie action button or link
+        # @option options [Hash] :attributes any additional attributes that will added as part of the HTML.
+        #                                    If the +:type+ key is present with a value of +:button+,
+        #                                   the action will be rendered as a button
+
+        def initialize(text:, href: nil, **options)
+          super(**options)
+
+          @text = text
+          @href = href
+        end
+
+        # Generates the HTML for a cookie banner message action
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          if href && options[:attributes][:type] != :button
+            link_to(text, href, **options[:attributes])
+          else
+            Button.new(text: text, href: href, context: context, **options).render
+          end
+        end
+
+        # The default attributes for the cookie banner action
+
+        DEFAULT_ATTRIBUTES = { class: 'govuk-link' }.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+require_relative '../../base'
+require_relative 'action'
+
+module CCS::Components
+  module GovUK
+    class CookieBanner < Base
+      # = GOV.UK Cookie Banner Message
+      #
+      # The individual cookie banner message
+      #
+      # @!attribute [r] heading_text
+      #   @return [String] Heading text for the message
+      # @!attribute [r] content
+      #   @return [ActiveSupport::SafeBuffer] HTML for the message
+      # @!attribute [r] text
+      #   @return [String] Text for the message
+      # @!attribute [r] actions
+      #   @return [Array<Action>] Array of initialised cookie banner actions
+
+      class Message < Base
+        private
+
+        attr_reader :heading_text, :content, :text, :actions
+
+        public
+
+        # @param heading_text [String] the heading text that displays in the message
+        # @param content [ActiveSupport::SafeBuffer] HTML to use as content for the message
+        # @param text [String] if +:content+ is blank then this is the text used for the message
+        # @param actions [Array<Hash>] the buttons and/or links that you want to display in the message.
+        #                              See {Components::GovUK::CookieBanner::Action#initialize Action#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 message HTML
+        # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+
+        def initialize(heading_text: nil, content: nil, text: nil, actions: nil, **options)
+          super(**options)
+
+          @heading_text = heading_text
+          @content = content
+          @text = text
+          @actions = actions.map { |action| Action.new(context: @context, **action) } if actions
+        end
+
+        # rubocop:disable Metrics/AbcSize
+
+        # Generates the HTML for the GOV.UK Cookie Banner Message
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.div(**options[:attributes]) do
+            concat(tag.div(class: 'govuk-grid-row') do
+              tag.div(class: 'govuk-grid-column-two-thirds') do
+                concat(tag.h2(heading_text, class: 'govuk-cookie-banner__heading govuk-heading-m')) if heading_text
+                concat(tag.div(class: 'govuk-cookie-banner__content') do
+                  content || tag.p(text, class: 'govuk-body')
+                end)
+              end
+            end)
+            if actions
+              concat(tag.div(class: 'govuk-button-group') do
+                actions.each { |action| concat(action.render) }
+              end)
+            end
+          end
+        end
+
+        # rubocop:enable Metrics/AbcSize
+
+        # The default attributes for the cookie banner message
+
+        DEFAULT_ATTRIBUTES = { class: 'govuk-cookie-banner__message govuk-width-container' }.freeze
+      end
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +1,58 @@
+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
+      #
+      # @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

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

@@ -0,0 +1,52 @@
+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
+        #
+        # @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