ccs-frontend_helpers 0.1.0 → 0.1.1.rc.1

data/lib/ccs/components/ccs/dashboard_section.rb

@@ -0,0 +1,71 @@
+require_relative '../base'
+require_relative 'dashboard_section/panel'
+
+module CCS
+  module Components
+    module CCS
+      # = CCS Dashboard Section
+      #
+      # This is used for generating the dashboard section component
+      #
+      # @!attribute [r] dashboard_section_panels
+      #   @return [Array<Link>] An array of the initialised dashboard section panels
+      # @!attribute [r] title_text
+      #   @return [String] Text for the title of a dashboard section
+
+      class DashboardSection < Base
+        private
+
+        attr_reader :dashboard_section_panels, :title_text
+
+        public
+
+        # @param dashboard_section_panels [Array<Hash>] An array of options for the dashboard section panels,
+        #                                               See {Components::CCS::DashboardSection::Panel#initialize Panel#initialize} for details of the items in the array.
+        # @param title_text [String] text for the title of a dashboard section
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option options [String] :classes additional CSS classes for the dashboard section HTML
+        # @option options [String] :width (default: 'full') the width of the dashboard section
+        # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+
+        def initialize(dashboard_section_panels:, title_text: nil, **options)
+          super(**options)
+
+          @options[:width] ||= 'full'
+
+          @dashboard_section_panels = dashboard_section_panels.map { |dashboard_section_panel| Panel.new(context: @context, **dashboard_section_panel) }
+          @title_text = title_text
+        end
+
+        # rubocop:disable Metrics/AbcSize
+
+        # Generates the HTML for the CCS dashboard section component
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.div(**options[:attributes]) do
+            tag.div(class: 'govuk-grid-row') do
+              tag.div(class: "govuk-grid-column-#{options[:width]}") do
+                if title_text
+                  concat(tag.h2(title_text, class: 'ccs-dashboard-section__heading govuk-heading-m'))
+                  concat(tag.hr(class: 'ccs-dashboard-section__heading-section-break govuk-section-break govuk-section-break--visible'))
+                end
+                concat(tag.div(class: 'govuk-grid-row ccs-dashboard-section__container') do
+                  dashboard_section_panels.each { |dashboard_section_panel| concat(dashboard_section_panel.render) }
+                end)
+              end
+            end
+          end
+        end
+
+        # rubocop:enable Metrics/AbcSize
+
+        # The default attributes for the dashboard section
+
+        DEFAULT_ATTRIBUTES = { class: 'ccs-dashboard-section' }.freeze
+      end
+    end
+  end
+end

data/lib/ccs/components/ccs/footer/link.rb

@@ -0,0 +1,55 @@
+require_relative '../../base'
+
+module CCS
+  module Components
+    module CCS
+      class Footer < Base
+        # = CCS Footer link
+        #
+        # The individual footer footer link item
+        #
+        # @!attribute [r] text
+        #   @return [String] Text for the footer link
+        # @!attribute [r] href
+        #   @return [String] The href for the footer link
+        # @!attribute [r] li_class
+        #   @return [String] The class for the li elements
+
+        class Link < Base
+          private
+
+          attr_reader :text, :href, :li_class
+
+          public
+
+          # @param text [String] the text for the footer link
+          # @param href [String] the href for the footer link
+          # @param li_class [String] class for the li elements
+          # @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:, li_class:, **options)
+            super(**options)
+
+            @text = text
+            @href = href
+            @li_class = li_class
+          end
+
+          # Generates the HTML for the CCS Footer link
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            tag.li(class: li_class) do
+              options[:attributes][:class] = 'ccs-footer__link'
+
+              link_to(text, href, **options[:attributes])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/ccs/footer/meta.rb

@@ -0,0 +1,59 @@
+require_relative 'link'
+
+module CCS
+  module Components
+    module CCS
+      class Footer < Base
+        # = CCS Footer Meta
+        #
+        # The footer meta section
+        #
+        # @!attribute [r] meta_links
+        #   @return [Array<Link>] An array of the initialised meta links
+        # @!attribute [r] visually_hidden_title
+        #   @return [String] Title for the meta section
+        # @!attribute [r] text
+        #   @return [String] Text to add to the meta section of the footer
+
+        class Meta
+          include ActionView::Context
+          include ActionView::Helpers
+
+          private
+
+          attr_reader :meta_links, :visually_hidden_title, :text
+
+          public
+
+          # @param items [Array<Hash>] an array of links for the meta section.
+          #                            See {Components::CCS::Footer::Link#initialize Link#initialize} for details of the items in the array.
+          # @param visually_hidden_title [String] ('Support links') title for the meta section
+          # @param text [String] text to add to the meta section of the footer
+          # @param context [ActionView::Base] the view context
+
+          def initialize(context:, items: nil, visually_hidden_title: nil, text: nil)
+            @meta_links = items&.map { |meta_link| Link.new(li_class: 'ccs-footer__inline-list-item', context: context, **meta_link) }
+            @visually_hidden_title = visually_hidden_title || 'Support links'
+            @text = text
+          end
+
+          # Generates the HTML for the CCS Footer Meta sections
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            capture do
+              concat(tag.h2(visually_hidden_title, class: 'govuk-visually-hidden'))
+              if meta_links
+                concat(tag.ul(class: 'ccs-footer__inline-list') do
+                  meta_links.each { |meta_link| concat(meta_link.render) }
+                end)
+              end
+              concat(tag.div(text, class: 'ccs-footer__meta-custom')) if text
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/ccs/footer/navigation.rb

@@ -0,0 +1,60 @@
+require_relative 'link'
+
+module CCS
+  module Components
+    module CCS
+      class Footer < Base
+        # = CCS Footer Navigation
+        #
+        # The individual footer navigation item
+        #
+        # @!attribute [r] title
+        #   @return [String] Title for the navigation section
+        # @!attribute [r] navigation_links
+        #   @return [Array<Link>] An array of the initialised navigation links
+        # @!attribute [r] width
+        #   @return [String] Width of the navigation section
+        # @!attribute [r] columns
+        #   @return [Integer] Number of columns to display the links in
+
+        class Navigation
+          include ActionView::Context
+          include ActionView::Helpers
+
+          private
+
+          attr_reader :title, :navigation_links, :width, :columns
+
+          public
+
+          # @param title [String] the title for the navigation section
+          # @param items [Array<Hash>] an array of links for the navigation section.
+          #                            See {Components::CCS::Footer::Link#initialize Link#initialize} for details of the items in the array.
+          # @param width [String] ('full') width of each navigation section in the footer
+          # @param columns [Integer] (nil) number of columns to display the links
+          # @param context [ActionView::Base] the view context
+
+          def initialize(title:, items:, context:, width: nil, columns: nil)
+            @title = title
+            @navigation_links = items.map { |navigation_link| Link.new(li_class: 'ccs-footer__list-item', context: context, **navigation_link) }
+            @width = width || 'full'
+            @columns = columns
+          end
+
+          # Generates the HTML for the CCS Footer Navigation sections
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            tag.div(class: "ccs-footer__section govuk-grid-column-#{width}") do
+              concat(tag.h2(title, class: 'ccs-footer__heading govuk-heading-m'))
+              concat(tag.ul(class: "ccs-footer__list #{"ccs-footer__list--columns-#{columns}" if columns}".rstrip) do
+                navigation_links.each { |navigation_link| concat(navigation_link.render) }
+              end)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/ccs/footer.rb

@@ -0,0 +1,95 @@
+require_relative '../base'
+require_relative 'logo'
+require_relative 'footer/navigation'
+require_relative 'footer/meta'
+
+module CCS
+  module Components
+    module CCS
+      # = CCS Footer
+      #
+      # This is used for generating the footer component from the
+      # {https://github.com/tim-s-ccs/ts-ccs-frontend/tree/main/src/ccs/components/footer CCS - Components - Footer}
+      #
+      # @!attribute [r] navigation
+      #   @return [Array<Navigation>] An array of the initialised navigation sections
+      # @!attribute [r] meta
+      #   @return [Meta] The initialised meta section
+
+      class Footer < Base
+        private
+
+        attr_reader :navigation, :meta
+
+        public
+
+        # @param navigation [Array<Hash>] an array of sections for the footer navigation.
+        #                                 See {Components::CCS::Footer::Navigation#initialize Navigation#initialize} for details of the items in the array.
+        # @param meta [Hash] ptions for the meta section of the footer.
+        #                    See {Components::CCS::Footer::Meta#initialize Meta#initialize} for details of the options.
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option options [String] :classes additional CSS classes for the footer HTML
+        # @option options [String] :container_class classes that can be added to the inner container
+        # @option options [ActiveSupport::SafeBuffer,String] :copyright The copyright information, (default: '© Crown copyright')
+        # @option options [Hash] :attributes additional attributes that will added as part of the HTML
+
+        def initialize(navigation: nil, meta: nil, **options)
+          super(**options)
+
+          @options[:attributes][:role] = 'contentinfo'
+          @options[:copyright] ||= '© Crown copyright'
+
+          @navigation = navigation&.map { |navigation_item| Navigation.new(context: @context, **navigation_item) }
+          @meta = Meta.new(context: @context, **meta) if meta
+        end
+
+        # rubocop:disable Metrics/AbcSize
+
+        # Generates the HTML for the CCS Footer component
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.footer(**options[:attributes]) do
+            tag.div(class: "govuk-width-container #{options[:container_classes]}".rstrip) do
+              if navigation
+                concat(tag.div(class: 'ccs-footer__navigation') do
+                  navigation.each { |navigation_item| concat(navigation_item.render) }
+                end)
+                concat(tag.hr(class: 'ccs-footer__section-break'))
+              end
+              concat(tag.div(class: 'ccs-footer__meta') do
+                concat(tag.div(class: 'ccs-footer__meta-item') do
+                  concat(tag.div(Logo.render, class: 'ccs-footer__logo'))
+                  concat(footer_copyright)
+                end)
+                concat(tag.div(class: 'ccs-footer__meta-item ccs-footer__meta-item--grow') do
+                  concat(meta.render) if meta
+                end)
+              end)
+            end
+          end
+        end
+
+        # rubocop:enable Metrics/AbcSize
+
+        # The default attributes for the breadcrumbs
+
+        DEFAULT_ATTRIBUTES = { class: 'ccs-footer' }.freeze
+
+        private
+
+        # Generates the copyright used in the footer
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def footer_copyright
+          tag.div(class: 'ccs-footer__copyright') do
+            link_to(options[:copyright], 'https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/', class: 'ccs-footer__link')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/ccs/header/link.rb

@@ -0,0 +1,60 @@
+require_relative '../../base'
+
+module CCS
+  module Components
+    module CCS
+      class Header < Base
+        # = CCS Header link
+        #
+        # The individual header link item
+        #
+        # @!attribute [r] text
+        #   @return [String] Text for the header link
+        # @!attribute [r] li_class
+        #   @return [String] The class for the li elements
+        # @!attribute [r] href
+        #   @return [String] The href for the header link
+
+        class Link < Base
+          private
+
+          attr_reader :text, :li_class, :href
+
+          public
+
+          # @param text [String] the text for the header link
+          # @param li_class [String] class for the li elements
+          # @param href [String] the href for the header link
+          # @param options [Hash] options that will be used in customising the HTML
+          #
+          # @option options [Boolean] :active flag to mark the navigation item as active or not
+          # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+
+          def initialize(text:, li_class:, href: nil, **options)
+            super(**options)
+
+            @text = text
+            @href = href
+            @li_class = li_class
+          end
+
+          # Generates the HTML for the CCS Header link
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            tag.li(class: "#{li_class} #{'ccs-header__navigation-item--active' if options[:active]}".rstrip) do
+              if href
+                options[:attributes][:class] = 'ccs-header__link'
+
+                link_to(text, href, **options[:attributes])
+              else
+                text
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/ccs/header/navigation.rb

@@ -0,0 +1,98 @@
+require_relative 'link'
+
+module CCS
+  module Components
+    module CCS
+      class Header < Base
+        # = CCS Header navigation
+        #
+        # The header navigation section
+        #
+        # @!attribute [r] primary_links
+        #   @return [Array<Link>] An array of the initialised primary navigation links
+        # @!attribute [r] secondary_links
+        #   @return [Array<Link>] An array of the initialised secondary navigation links
+        # @!attribute [r] navigation_label
+        #   @return [String] The aria label for the navigation
+        # @!attribute [r] navigation_classes
+        #   @return [String] The classes for the navigation
+        # @!attribute [r] menu_button
+        #   @return [Hash] The options for the menu button
+
+        class Navigation
+          include ActionView::Context
+          include ActionView::Helpers
+
+          private
+
+          attr_reader :primary_links, :secondary_links, :navigation_label, :navigation_classes, :menu_button
+
+          public
+
+          # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+          # @param navigation [Hash] options for the navigation
+          # @param menu_button [Hash] options for the menu button
+          # @param context [ActionView::Base] the view context
+          #
+          # @option navigation [Array] :primary_items an array of primary links for the navigation section.
+          #                            See {Components::CCS::Header::Link#initialize Link#initialize} for details of the items in the array.
+          # @option navigation [Array] :secondary_items an array of secondary links for the navigation section.
+          #                            See {Components::CCS::Header::Link#initialize Link#initialize} for details of the items in the array.
+          # @option navigation [String] :classes additional CSS classes for the navigation HTML
+          # @option navigation [String] :label text for the aria-label attribute of the navigation. Defaults to the menu button text
+          #
+          # @option menu_button [String] :text text for the button that opens the mobile navigation menu.
+          #                                    By default, this is set to +Menu+.
+          # @option menu_button [String] :label text for the aria-label attribute of the button that opens the mobile navigation.
+          #                                     Defaults to +Show or hide menu+.
+
+          def initialize(navigation:, serivce_name_present:, context:, menu_button: nil)
+            menu_button ||= {}
+            menu_button[:text] ||= 'Menu'
+            menu_button[:label] ||= 'Show or hide menu'
+
+            @menu_button = menu_button
+            @primary_links = navigation[:primary_items]&.map { |navigation_link| Link.new(li_class: LI_CLASS, context: context, **navigation_link) }
+            @secondary_links = navigation[:secondary_items]&.map { |navigation_link| Link.new(li_class: LI_CLASS, context: context, **navigation_link) }
+            @navigation_label = navigation[:label] || menu_button[:text]
+            @navigation_classes = "ccs-header__navigation #{navigation[:classes]}".rstrip
+            @navigation_classes << ' ccs-header__navigation--no-service-name' unless serivce_name_present
+          end
+
+          # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+          # rubocop:disable Metrics/AbcSize
+
+          # Generates the HTML for the GOV.UK Navigation
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            tag.nav(aria: { label: navigation_label }, class: navigation_classes) do
+              concat(button_tag(menu_button[:text], type: :button, class: 'ccs-header__menu-button ccs-js-header-toggle', aria: { controls: 'navigation', label: menu_button[:label] }, hidden: true))
+              concat(tag.div(id: 'navigation', class: 'ccs-header__navigation-lists') do
+                if secondary_links
+                  concat(tag.ul(id: 'navigation-secondary', class: "ccs-header__navigation-secondary-list #{'ccs-header__navigation--no-second-list' unless primary_links}".rstrip) do
+                    secondary_links.each { |secondary_link| concat(secondary_link.render) }
+                  end)
+                end
+                if primary_links
+                  concat(tag.ul(id: 'navigation-primary', class: "ccs-header__navigation-primary-list #{'ccs-header__navigation--no-second-list' unless secondary_links}".rstrip) do
+                    primary_links.each { |primary_link| concat(primary_link.render) }
+                  end)
+                end
+              end)
+            end
+          end
+
+          # rubocop:enable Metrics/AbcSize
+
+          # The li class for the navigation links
+
+          LI_CLASS = 'ccs-header__navigation-item'.freeze
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/ccs/header/service_authentication.rb

@@ -0,0 +1,53 @@
+require_relative 'link'
+
+module CCS
+  module Components
+    module CCS
+      class Header < Base
+        # = CCS Header Service Authentication
+        #
+        # The individual footer navigation item
+        #
+        # @!attribute [r] service_authentication_links
+        #   @return [Array<Link>] An array of the initialised service authentication links
+        # @!attribute [r] container_classes
+        #   @return [String] classes for the container
+
+        class ServiceAuthentication
+          include ActionView::Context
+          include ActionView::Helpers
+
+          private
+
+          attr_reader :service_authentication_links, :container_classes
+
+          public
+
+          # @param service_authentication_items [Array<Hash>] an array of links for the service authentication section.
+          #                                                   See {Components::CCS::Header::Link#initialize Link#initialize} for details of the items in the array.
+          # @param container_classes [String] classes for the container
+          # @param context [ActionView::Base] the view context
+
+          def initialize(service_authentication_items:, context:, container_classes: nil)
+            @service_authentication_links = service_authentication_items&.map { |service_authentication_link| Link.new(li_class: 'ccs-header__service-authentication-item', active: false, context: context, **service_authentication_link) }
+            @container_classes = container_classes
+          end
+
+          # Generates the HTML for the CCS Footer Meta sections
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            tag.div(class: 'ccs-header__service-authentication') do
+              tag.div(class: "ccs-header__service-authentication-container #{container_classes}".rstrip) do
+                tag.ul(class: 'ccs-header__service-authentication-list') do
+                  service_authentication_links.each { |service_authentication_link| concat(service_authentication_link.render) }
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/ccs/header.rb

@@ -0,0 +1,110 @@
+require_relative '../base'
+require_relative 'logo'
+require_relative 'header/service_authentication'
+require_relative 'header/navigation'
+
+module CCS
+  module Components
+    module CCS
+      # = CCS Header
+      #
+      # This is used for generating the header component from the
+      # {https://github.com/tim-s-ccs/ts-ccs-frontend/tree/main/src/ccs/components/header CCS - Components - Header}
+      #
+      # @!attribute [r] service_authentication
+      #   @return [ServiceAuthentication] The initialised service authentication section
+      # @!attribute [r] navigation
+      #   @return [Navigation] The initialised navigation section
+      # @!attribute [r] service
+      #   @return [Hash] The options for the service section
+
+      class Header < Base
+        private
+
+        attr_reader :service_authentication, :navigation, :service
+
+        public
+
+        # @param service_authentication_items [Array<Hash>] An array of links for the service authentication section of the header.
+        #                                                   See {Components::CCS::Header::ServiceAuthentication#initialize ServiceAuthentication#initialize} for details of the items in the array.
+        # @param navigation [Hash] options for the navigation section of the header.
+        #                          See {Components::CCS::Header::Navigation#initialize Navigation#initialize} for details of the options.
+        # @param menu_button [Hash] options for the menu button in the header.
+        #                           See {Components::CCS::Header::Navigation#initialize Navigation#initialize} for details of the options.
+        # @param service [Hash] options for the service name
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option service [String] :name the name of the service, included in the header
+        # @option service [String] :href URL for the service name anchor
+        #
+        # @option options [String] :classes additional CSS classes for the header HTML
+        # @option options [String] :container_classes classes for the container
+        # @option options [String] :homepage_url URL of the homepage. Defaults to +/https://www.crowncommercial.gov.uk+
+        # @option options [Hash] :attributes additional attributes that will added as part of the header HTML
+
+        def initialize(service_authentication_items: nil, navigation: nil, menu_button: nil, service: nil, **options)
+          super(**options)
+
+          @options[:attributes][:role] = 'banner'
+          @options[:container_classes] ||= 'govuk-width-container'
+          @options[:homepage_url] ||= 'https://www.crowncommercial.gov.uk'
+
+          @service_authentication = ServiceAuthentication.new(service_authentication_items: service_authentication_items, container_classes: @options[:container_classes], context: @context) if service_authentication_items
+          @navigation = Navigation.new(navigation: navigation, serivce_name_present: service, menu_button: menu_button, context: @context) if navigation
+          @service = service
+        end
+
+        # rubocop:disable Metrics/AbcSize
+
+        # Generates the HTML for the CCS Header component
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.header(**options[:attributes]) do
+            concat(service_authentication.render) if service_authentication
+            concat(tag.div(class: "ccs-header__container #{options[:container_classes]}".rstrip) do
+              concat(header_logo)
+              if service || navigation
+                concat(tag.div(class: 'ccs-header__content') do
+                  concat(header_service_name) if service
+                  concat(navigation.render) if navigation
+                end)
+              end
+            end)
+          end
+        end
+
+        # rubocop:enable Metrics/AbcSize
+
+        # The default attributes for the breadcrumbs
+
+        DEFAULT_ATTRIBUTES = { class: 'ccs-header', data: { module: 'ccs-header' } }.freeze
+
+        private
+
+        # Generates the logo for header
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def header_logo
+          tag.div(class: 'ccs-header__logo') do
+            link_to(Logo.render, options[:homepage_url], class: 'ccs-header__link ccs-header__link--homepage', aria: { label: 'Crown Commercial Service' })
+          end
+        end
+
+        # Generates the service name section
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def header_service_name
+          if service[:href]
+            link_to(service[:name], service[:href], class: 'ccs-header__link ccs-header__link--service-name')
+          else
+            tag.span(service[:name], class: 'ccs-header__link--service-name')
+          end
+        end
+      end
+    end
+  end
+end