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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8953dff436dfc45a5f342ee8914f5e784ab794670e6bf3ddb8490b5a4405044
-  data.tar.gz: 95a5eb7c860225423cab0f0a7876357195e078e8b4a101efdf9540a7fec8d96a
+  metadata.gz: 675c60c51c25d5cd22e26b1e92a579053d1340200bc4a33e9a4e36e65b6790ca
+  data.tar.gz: b90658aa1deadfa04ee5dd2d12be7f8a62b83656017a0fc557812fced67a789f
 SHA512:
-  metadata.gz: c18444fc0a1442a00be351944e9d23cd32800da85e73b2b57c6c150a3b75b87f01ae8c6e520092439f35ac45bccd63c1d390a1935b1d8d4e41427cff229161e1
-  data.tar.gz: e44027d75f86627f1360be7bc60e3e3c149de32a4847dbf8fc7c6f188a9951882e46347849f24f8cb28fc720f0de54a45e3e005fa36b7bc4877181f495bba54c
+  metadata.gz: d5ec2d542ec51558264bfd069546b59969ff401fc1c49c0b332ea547ce7504e477d8dd01ae50f16a7b322d1e80b3d5e584d540259c398090b5aba10af240cd33
+  data.tar.gz: 93ed922f0db520239e8d27bf422ebf9badaad94cd014f7af431e6009d5d1ba4b9ffb96cfca565e7e7ff1ed2d4912a2f7189d03c9ec4f4a8f1dfe2650a4cc7b1b

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-## [0.1.0] - 2023-02-22
+## [0.1.0.rc.3] - 2023-04-05
 
 Initial release of CCS Frontend Helpers.
 This release contains view helpers that are used to create GOV.UK and CCS components.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ccs-frontend_helpers (0.1.0.rc.2)
+    ccs-frontend_helpers (0.1.0.rc.3)
       rails (>= 6.0)
 
 GEM

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

@@ -1,52 +1,54 @@
 require_relative '../../base'
 
-module CCS::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
+module CCS
+  module Components
+    module CCS
+      class DashboardSection < Base
+        # = CCS Dashboard Section Panel
         #
-        # @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.
+        # 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
 
-        def initialize(title:, href:, description:, **options)
-          super(**options)
+        class Panel < Base
+          private
 
-          @options[:attributes][:class] = "ccs-dashboard-section__panel govuk-grid-column-#{@options[:width] || 'one-third'}"
+          attr_reader :title, :href, :description
 
-          @title = title
-          @href = href
-          @description = description
-        end
+          public
 
-        # Generates the HTML for the CCS Dashboard Section Panel
-        #
-        # @return [ActiveSupport::SafeBuffer]
+          # @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'))
+          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

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

@@ -1,71 +1,73 @@
 require_relative '../base'
 require_relative 'dashboard_section/panel'
 
-module CCS::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
+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
+      class DashboardSection < Base
+        private
 
-      attr_reader :dashboard_section_panels, :title_text
+        attr_reader :dashboard_section_panels, :title_text
 
-      public
+        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
+        # @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)
+        def initialize(dashboard_section_panels:, title_text: nil, **options)
+          super(**options)
 
-        @options[:width] ||= 'full'
+          @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
+          @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
+        # rubocop:disable Metrics/AbcSize
 
-      # Generates the HTML for the CCS dashboard section component
-      #
-      # @return [ActiveSupport::SafeBuffer]
+        # 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: 'ccs-dashboard-section__container') do
-                tag.div(class: 'govuk-grid-row') do
-                  dashboard_section_panels.each { |dashboard_section_panel| concat(dashboard_section_panel.render) }
+        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
-              end)
+                concat(tag.div(class: 'ccs-dashboard-section__container') do
+                  tag.div(class: 'govuk-grid-row') do
+                    dashboard_section_panels.each { |dashboard_section_panel| concat(dashboard_section_panel.render) }
+                  end
+                end)
+              end
             end
           end
         end
-      end
 
-      # rubocop:enable Metrics/AbcSize
+        # rubocop:enable Metrics/AbcSize
 
-      # The default attributes for the dashboard section
+        # The default attributes for the dashboard section
 
-      DEFAULT_ATTRIBUTES = { class: 'ccs-dashboard-section' }.freeze
+        DEFAULT_ATTRIBUTES = { class: 'ccs-dashboard-section' }.freeze
+      end
     end
   end
 end

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

@@ -1,50 +1,52 @@
 require_relative '../../base'
 
-module CCS::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
+module CCS
+  module Components
+    module CCS
+      class Footer < Base
+        # = CCS Footer link
         #
-        # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+        # 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
 
-        def initialize(text:, href:, li_class:, **options)
-          super(**options)
+        class Link < Base
+          private
 
-          @text = text
-          @href = href
-          @li_class = li_class
-        end
+          attr_reader :text, :href, :li_class
 
-        # Generates the HTML for the CCS Footer link
-        #
-        # @return [ActiveSupport::SafeBuffer]
+          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'
+          def render
+            tag.li(class: li_class) do
+              options[:attributes][:class] = 'ccs-footer__link'
 
-            link_to(text, href, **options[:attributes])
+              link_to(text, href, **options[:attributes])
+            end
           end
         end
       end

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

@@ -1,55 +1,56 @@
-require_relative '../../base'
 require_relative 'link'
 
-module CCS::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
+module CCS
+  module Components
+    module CCS
+      class Footer < Base
+        # = CCS Footer Meta
+        #
+        # The footer meta section
         #
-        # @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)
+        # @!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
-            concat(tag.div(text, class: 'ccs-footer__meta-custom')) if text
           end
         end
       end

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

@@ -1,56 +1,57 @@
-require_relative '../../base'
 require_relative 'link'
 
-module CCS::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
+module CCS
+  module Components
+    module CCS
+      class Footer < Base
+        # = CCS Footer Navigation
+        #
+        # The individual footer navigation item
         #
-        # @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)
+        # @!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