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

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

@@ -3,89 +3,91 @@ require_relative 'logo'
 require_relative 'footer/navigation'
 require_relative 'footer/meta'
 
-module CCS::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
+module CCS
+  module Components
+    module CCS
+      # = CCS Footer
       #
-      # @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
+      # 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
 
-      def initialize(navigation: nil, meta: nil, **options)
-        super(**options)
+      class Footer < Base
+        private
 
-        @options[:attributes][:role] = 'contentinfo'
-        @options[:copyright] ||= '© Crown copyright'
+        attr_reader :navigation, :meta
 
-        @navigation = navigation&.map { |navigation_item| Navigation.new(context: @context, **navigation_item) }
-        @meta = Meta.new(context: @context, **meta) if meta
-      end
+        public
 
-      # rubocop:disable Metrics/AbcSize
+        # @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
 
-      # 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) }
+        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)
-              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
+        # rubocop:enable Metrics/AbcSize
 
-      # The default attributes for the breadcrumbs
+        # The default attributes for the breadcrumbs
 
-      DEFAULT_ATTRIBUTES = { class: 'ccs-footer' }.freeze
+        DEFAULT_ATTRIBUTES = { class: 'ccs-footer' }.freeze
 
-      private
+        private
 
-      # Generates the copyright used in the footer
-      #
-      # @return [ActiveSupport::SafeBuffer]
+        # 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')
+        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

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

@@ -1,54 +1,56 @@
 require_relative '../../base'
 
-module CCS::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
+module CCS
+  module Components
+    module CCS
+      class Header < Base
+        # = CCS Header link
         #
-        # @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
+        # The individual header link item
         #
-        # @return [ActiveSupport::SafeBuffer]
+        # @!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'
+          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
+                link_to(text, href, **options[:attributes])
+              else
+                text
+              end
             end
           end
         end

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

@@ -1,96 +1,97 @@
-require_relative '../../base'
 require_relative 'link'
 
-module CCS::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
+module CCS
+  module Components
+    module CCS
+      class Header < Base
+        # = CCS Header navigation
         #
-        # @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
+        # The header navigation section
         #
-        # @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
+        # @!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
 
-        # 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)
+          # 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
-        end
 
-        # rubocop:enable Metrics/AbcSize
+          # rubocop:enable Metrics/AbcSize
 
-        # The li class for the navigation links
+          # The li class for the navigation links
 
-        LI_CLASS = 'ccs-header__navigation-item'.freeze
+          LI_CLASS = 'ccs-header__navigation-item'.freeze
+        end
       end
     end
   end

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

@@ -1,47 +1,48 @@
-require_relative '../../base'
 require_relative 'link'
 
-module CCS::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
+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
+        class ServiceAuthentication
+          include ActionView::Context
+          include ActionView::Helpers
 
-        private
+          private
 
-        attr_reader :service_authentication_links, :container_classes
+          attr_reader :service_authentication_links, :container_classes
 
-        public
+          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
+          # @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
+          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]
+          # 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) }
+          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