ccs-frontend_helpers 0.1.0.rc.7 → 0.1.0

data/lib/ccs/components/base.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-module CCS
-  # Components for the GOV.UK Frontend and CCS Frontend using an Object Oriented pattern
-  # These are then used in the {CCS::FrontendHelpers FrontendHelpers}
-  # to create view helpers that can be used in a Ruby on Rails project
-
-  module Components
-    # Component base class that all components will inherit from.
-    #
-    # It's main purpose is to handle the initialisation of the options
-    # which is very similar between components
-    #
-    # @!attribute [r] options
-    #   @return [Hash] Options for the component which defaults to +{ attributes: {} }+
-    #                  where +attributes+ are HTML attributes
-    # @!attribute [r] context
-    #   @return [ActionView::Base] View context where the components are being rendered
-
-    class Base
-      private
-
-      attr_accessor :options, :context
-
-      public
-
-      delegate :button_tag, :concat, :label_tag, :link_to, :tag, to: :context
-
-      # @param context [ActionView::Base] the view context where the components are being rendered
-      # @param options [Hash] options for the component
-
-      def initialize(context:, **options)
-        options[:attributes] ||= {}
-        options[:attributes][:class] = "#{default_attributes[:class]} #{options[:classes]}".strip if default_attributes[:class] || options[:classes]
-        (options[:attributes][:data] ||= {})[:module] = default_attributes[:data][:module] if default_attributes.dig(:data, :module)
-
-        @context = context
-        @options = options
-      end
-
-      # The default attributes for the component
-
-      DEFAULT_ATTRIBUTES = {}.freeze
-
-      private
-
-      # The default attributes for the component
-      #
-      # @return [Hash]
-
-      def default_attributes
-        self.class::DEFAULT_ATTRIBUTES
-      end
-
-      # Sanitizes string used as HTML tag id
-      #
-      # @return [String]
-
-      def sanitize_to_id(...)
-        @context.send(:sanitize_to_id, ...)
-      end
-    end
-  end
-end

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

@@ -1,57 +0,0 @@
-require_relative '../../base'
-
-module CCS
-  module Components
-    module CCS
-      class DashboardSection < Base
-        # = CCS Dashboard Section Panel
-        #
-        # The individual panel within a dashboard section
-        #
-        # @!attribute [r] title
-        #   @return [String] Text for the panel title
-        # @!attribute [r] href
-        #   @return [String] The href for the panel
-        # @!attribute [r] description
-        #   @return [String] Description text for the panel
-
-        class Panel < Base
-          private
-
-          attr_reader :title, :href, :description
-
-          public
-
-          # @param title [String] the text for the panel title
-          # @param href [String] the href for the panel
-          # @param description [String] the description text for the panel
-          # @param options [Hash] options that will be used in customising the HTML
-          #
-          # @option options [String] :width (default: 'one-third') the width of the panel
-          # @option options [Hash] :attributes any additional attributes that will added as part of the HTML.
-
-          def initialize(title:, href:, description:, **options)
-            super(**options)
-
-            @options[:attributes][:class] = "ccs-dashboard-section__panel govuk-grid-column-#{@options[:width] || 'one-third'}"
-
-            @title = title
-            @href = href
-            @description = description
-          end
-
-          # Generates the HTML for the CCS Dashboard Section Panel
-          #
-          # @return [ActiveSupport::SafeBuffer]
-
-          def render
-            tag.div(**options[:attributes]) do
-              concat(link_to(title, href, class: 'ccs-dashboard-section__panel-title'))
-              concat(tag.p(description, class: 'ccs-dashboard-section__panel-description'))
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

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

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

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

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

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

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

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

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