crown_marketplace_utils 0.1.0.beta.6 → 0.1.0.beta.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e73452d7763d7859ed777fcf3fcb1b1c94f29d1b7847296a103cac6b75cb5be4
-  data.tar.gz: 9e68caffdbdaa5c2bd3c9b35cf867f59e2928945e74b0c537864bfe0441cd74b
+  metadata.gz: ab401ec177fe7672eec50c0bd05a41663ac0bd1b163f27ffd1112ac077d70af1
+  data.tar.gz: ddfdfaa105ff9c5680255d15bf9e2ce7924585c990cbcbd5fba6402c9539a9a9
 SHA512:
-  metadata.gz: 972d9d7bf8c15f1408500948595155932dc99d24ed43565762ce3e0d0f3b695328834f1685aff46c90d21afa8fe6a298551d1e00162d05cc21a91971600065ff
-  data.tar.gz: 16c588d4814694d494093134ff77098b0f1bf1a37ce019efeabef0780848cc17ea00bc6f356fa3206b668da507bf18038677152e21aad3d3c95dfd7eef775077
+  metadata.gz: 168c70a445d81be6119155c65715c522de6af4a6ef4e04cd8965f43db7bcb03fa4960ca8144c2d3d6edafe73273c680c99c205a07b1760b67e24d9d367091ed9
+  data.tar.gz: 8d070853427625e6e191d449cf4165d69573785b66580d29fa7dada93f1c85a49b1431853c3ab7d8a36b72d1f2fd919b208a5ecc9004978114ea694034d745f1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    crown_marketplace_utils (0.1.0.beta.6)
+    crown_marketplace_utils (0.1.0.beta.7)
       actionview (>= 6.0)
 
 GEM

data/lib/crown_marketplace_utils/helpers/gov_uk_helper/accordion.rb

@@ -2,112 +2,114 @@
 
 require 'action_view'
 
-module CrownMarketplaceUtils::Helpers
-  module GovUkHelper
-    # = GOV.UK Accordion
-    #
-    # This helper is used for generating the accordion component from the
-    # {https://design-system.service.gov.uk/accordion/back-link GDS - Components - Accordion}
+module CrownMarketplaceUtils
+  module Helpers
+    module GovUkHelper
+      # = GOV.UK Accordion
+      #
+      # This helper is used for generating the accordion component from the
+      # {https://design-system.service.gov.uk/accordion/back-link GDS - Components - Accordion}
 
-    module Accordion
-      include ActionView::Context
-      include ActionView::Helpers::TagHelper
-      include ActionView::Helpers::TextHelper
+      module Accordion
+        include ActionView::Context
+        include ActionView::Helpers::TagHelper
+        include ActionView::Helpers::TextHelper
 
-      # Generates the HTML for the GOV.UK accordion component
-      #
-      # @param accordion_id [String] used as an id in the HTML for the accordion as a whole,
-      #                              and also as a prefix for the ids of the section contents
-      #                              and the buttons that open them
-      # @param accordion_items [Array<Hash>] an array of accordion items.
-      #                                      See {#govuk_accordion_section} for details of the items in the array.
-      # @param govuk_accordion_options [Hash] options that will be used in customising the HTML
-      #
-      # @option govuk_accordion_options [String] :classes additional CSS classes for the accordion HTML
-      # @option govuk_accordion_options [Integer] :heading_level (2) heading level, from 1 to 6
-      # @option govuk_accordion_options [Hash] :attributes ({ data: { module: 'govuk-accordion' } }) any additional
-      #                                                    attributes that will added as part of the HTML
-      #
-      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Accordion
-      #                                     which can then be rendered on the page
+        # Generates the HTML for the GOV.UK accordion component
+        #
+        # @param accordion_id [String] used as an id in the HTML for the accordion as a whole,
+        #                              and also as a prefix for the ids of the section contents
+        #                              and the buttons that open them
+        # @param accordion_items [Array<Hash>] an array of accordion items.
+        #                                      See {#govuk_accordion_section} for details of the items in the array.
+        # @param govuk_accordion_options [Hash] options that will be used in customising the HTML
+        #
+        # @option govuk_accordion_options [String] :classes additional CSS classes for the accordion HTML
+        # @option govuk_accordion_options [Integer] :heading_level (2) heading level, from 1 to 6
+        # @option govuk_accordion_options [Hash] :attributes ({ data: { module: 'govuk-accordion' } }) any additional
+        #                                                    attributes that will added as part of the HTML
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Accordion
+        #                                     which can then be rendered on the page
 
-      def govuk_accordion(accordion_id, accordion_items, **govuk_accordion_options)
-        (govuk_accordion_options[:attributes] ||= {})[:data] ||= {}
-        govuk_accordion_options[:attributes][:class] = "govuk-accordion #{govuk_accordion_options[:classes]}".rstrip
-        govuk_accordion_options[:attributes][:id] = accordion_id
-        govuk_accordion_options[:attributes][:data][:module] = 'govuk-accordion'
-        govuk_accordion_options[:heading_level] ||= 2
+        def govuk_accordion(accordion_id, accordion_items, **govuk_accordion_options)
+          (govuk_accordion_options[:attributes] ||= {})[:data] ||= {}
+          govuk_accordion_options[:attributes][:class] = "govuk-accordion #{govuk_accordion_options[:classes]}".rstrip
+          govuk_accordion_options[:attributes][:id] = accordion_id
+          govuk_accordion_options[:attributes][:data][:module] = 'govuk-accordion'
+          govuk_accordion_options[:heading_level] ||= 2
 
-        tag.div(**govuk_accordion_options[:attributes]) do
-          capture do
-            accordion_items.each.with_index(1) { |accordion_item, index| concat(govuk_accordion_section(accordion_id, accordion_item, index, govuk_accordion_options[:heading_level])) }
+          tag.div(**govuk_accordion_options[:attributes]) do
+            capture do
+              accordion_items.each.with_index(1) { |accordion_item, index| concat(govuk_accordion_section(accordion_id, accordion_item, index, govuk_accordion_options[:heading_level])) }
+            end
           end
         end
-      end
 
-      private
+        private
 
-      # Generates the HTML for an accordion section, used by {govuk_accordion}
-      #
-      # @param accordion_id [String] used as an id in the HTML for the accordion
-      # @param index [Integer] the index of the accordion item
-      # @param heading_level [Integer] heading level, from 1 to 6
-      #
-      # @option accordion_item [Boolean] :expanded sets whether the section should be expanded
-      #                                            when the page loads for the first time.
-      # @option accordion_item [String] :heading_level (2) Heading level, from 1 to 6
-      # @option accordion_item [String] :heading the heading text for the accordion
-      # @option accordion_item [String] :summary (nil) optional summary text for the accordion header
-      # @option accordion_item [String, ActiveSupport::SafeBuffer] the content within the accordion section
-      #
-      # @return [ActiveSupport::SafeBuffer] the HTML for an accordion section
-      #                                     which is used in {govuk_accordion}
+        # Generates the HTML for an accordion section, used by {govuk_accordion}
+        #
+        # @param accordion_id [String] used as an id in the HTML for the accordion
+        # @param index [Integer] the index of the accordion item
+        # @param heading_level [Integer] heading level, from 1 to 6
+        #
+        # @option accordion_item [Boolean] :expanded sets whether the section should be expanded
+        #                                            when the page loads for the first time.
+        # @option accordion_item [String] :heading_level (2) Heading level, from 1 to 6
+        # @option accordion_item [String] :heading the heading text for the accordion
+        # @option accordion_item [String] :summary (nil) optional summary text for the accordion header
+        # @option accordion_item [String, ActiveSupport::SafeBuffer] the content within the accordion section
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for an accordion section
+        #                                     which is used in {govuk_accordion}
 
-      def govuk_accordion_section(accordion_id, accordion_item, index, heading_level)
-        tag.div(class: "govuk-accordion__section #{'govuk-accordion__section--expanded' if accordion_item[:expanded]}".rstrip) do
-          capture do
-            concat(govuk_accordion_section_header(accordion_id, accordion_item, index, heading_level))
-            concat(govuk_accordion_section_content(accordion_id, accordion_item, index))
+        def govuk_accordion_section(accordion_id, accordion_item, index, heading_level)
+          tag.div(class: "govuk-accordion__section #{'govuk-accordion__section--expanded' if accordion_item[:expanded]}".rstrip) do
+            capture do
+              concat(govuk_accordion_section_header(accordion_id, accordion_item, index, heading_level))
+              concat(govuk_accordion_section_content(accordion_id, accordion_item, index))
+            end
           end
         end
-      end
 
-      # Generates the HTML for an accordion section heading, used by {govuk_accordion_section}
-      #
-      # @param (see govuk_accordion_section)
-      #
-      # @option (see govuk_accordion_section)
-      #
-      # @return [ActiveSupport::SafeBuffer] the HTML for an accordion section heading
-      #                                     which is used in {govuk_accordion_section}
+        # Generates the HTML for an accordion section heading, used by {govuk_accordion_section}
+        #
+        # @param (see govuk_accordion_section)
+        #
+        # @option (see govuk_accordion_section)
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for an accordion section heading
+        #                                     which is used in {govuk_accordion_section}
 
-      def govuk_accordion_section_header(accordion_id, accordion_item, index, heading_level)
-        tag.div(class: 'govuk-accordion__section-header') do
-          capture do
-            concat(tag.send("h#{heading_level}", class: 'govuk-accordion__section-heading') do
-              tag.span(accordion_item[:heading], class: 'govuk-accordion__section-button', id: "#{accordion_id}-heading-#{index}")
-            end)
-            concat(tag.div(accordion_item[:summary], class: 'govuk-accordion__section-summary govuk-body', id: "#{accordion_id}-summary-#{index}")) if accordion_item[:summary]
+        def govuk_accordion_section_header(accordion_id, accordion_item, index, heading_level)
+          tag.div(class: 'govuk-accordion__section-header') do
+            capture do
+              concat(tag.send("h#{heading_level}", class: 'govuk-accordion__section-heading') do
+                tag.span(accordion_item[:heading], class: 'govuk-accordion__section-button', id: "#{accordion_id}-heading-#{index}")
+              end)
+              concat(tag.div(accordion_item[:summary], class: 'govuk-accordion__section-summary govuk-body', id: "#{accordion_id}-summary-#{index}")) if accordion_item[:summary]
+            end
           end
         end
-      end
 
-      # Generates the HTML for an accordion sections content, used by {govuk_accordion_section}
-      #
-      # @param accordion_id [String] used as an id in the HTML for the accordion
-      # @param index [Integer] the index of the accordion item
-      #
-      # @option (see govuk_accordion_section)
-      #
-      # @return [ActiveSupport::SafeBuffer] the HTML for an accordion sections content
-      #                                     which is used in {govuk_accordion_section}
+        # Generates the HTML for an accordion sections content, used by {govuk_accordion_section}
+        #
+        # @param accordion_id [String] used as an id in the HTML for the accordion
+        # @param index [Integer] the index of the accordion item
+        #
+        # @option (see govuk_accordion_section)
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for an accordion sections content
+        #                                     which is used in {govuk_accordion_section}
 
-      def govuk_accordion_section_content(accordion_id, accordion_item, index)
-        tag.div(class: 'govuk-accordion__section-content', id: "#{accordion_id}-content-#{index}", aria: { labelledby: "#{accordion_id}-heading-#{index}" }) do
-          if accordion_item[:content].is_a? ActiveSupport::SafeBuffer
-            accordion_item[:content]
-          else
-            tag.p(accordion_item[:content], class: 'govuk-body')
+        def govuk_accordion_section_content(accordion_id, accordion_item, index)
+          tag.div(class: 'govuk-accordion__section-content', id: "#{accordion_id}-content-#{index}", aria: { labelledby: "#{accordion_id}-heading-#{index}" }) do
+            if accordion_item[:content].is_a? ActiveSupport::SafeBuffer
+              accordion_item[:content]
+            else
+              tag.p(accordion_item[:content], class: 'govuk-body')
+            end
           end
         end
       end

data/lib/crown_marketplace_utils/helpers/gov_uk_helper/back_link.rb

@@ -2,32 +2,34 @@
 
 require 'action_view'
 
-module CrownMarketplaceUtils::Helpers
-  module GovUkHelper
-    # = GOV.UK Back Link
-    #
-    # This helper is used for generating the back link component from the
-    # {https://design-system.service.gov.uk/components/back-link GDS - Components - Back link}
+module CrownMarketplaceUtils
+  module Helpers
+    module GovUkHelper
+      # = GOV.UK Back Link
+      #
+      # This helper is used for generating the back link component from the
+      # {https://design-system.service.gov.uk/components/back-link GDS - Components - Back link}
 
-    module BackLink
-      include ActionView::Helpers::UrlHelper
+      module BackLink
+        include ActionView::Helpers::UrlHelper
 
-      # Generates the HTML for the GOV.UK Back link component
-      #
-      # @param text [String] the text for the back link
-      # @param href [String] the href for the back link
-      # @param govuk_back_link_options [Hash] options that will be used in customising the HTML
-      #
-      # @option govuk_back_link_options [String] :classes additional CSS classes for the tag HTML
-      # @option govuk_back_link_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
-      #
-      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Back link
-      #                                     which can then be rendered on the page
+        # Generates the HTML for the GOV.UK Back link component
+        #
+        # @param text [String] the text for the back link
+        # @param href [String] the href for the back link
+        # @param govuk_back_link_options [Hash] options that will be used in customising the HTML
+        #
+        # @option govuk_back_link_options [String] :classes additional CSS classes for the tag HTML
+        # @option govuk_back_link_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Back link
+        #                                     which can then be rendered on the page
 
-      def govuk_back_link(text, href, **govuk_back_link_options)
-        govuk_back_link_options[:class] = "govuk-back-link #{govuk_back_link_options[:classes]}".rstrip
+        def govuk_back_link(text, href, **govuk_back_link_options)
+          govuk_back_link_options[:class] = "govuk-back-link #{govuk_back_link_options[:classes]}".rstrip
 
-        link_to(text, href, class: govuk_back_link_options[:class], **(govuk_back_link_options[:attributes] || {}))
+          link_to(text, href, class: govuk_back_link_options[:class], **(govuk_back_link_options[:attributes] || {}))
+        end
       end
     end
   end

data/lib/crown_marketplace_utils/helpers/gov_uk_helper/breadcrumbs.rb

@@ -2,72 +2,74 @@
 
 require 'action_view'
 
-module CrownMarketplaceUtils::Helpers
-  module GovUkHelper
-    # = GOV.UK Breadcrumbs
-    #
-    # This helper is used for generating the breadcrumbs component from the
-    # {https://design-system.service.gov.uk/components/breadcrumbs GDS - Components - Breadcrumbs}
+module CrownMarketplaceUtils
+  module Helpers
+    module GovUkHelper
+      # = GOV.UK Breadcrumbs
+      #
+      # This helper is used for generating the breadcrumbs component from the
+      # {https://design-system.service.gov.uk/components/breadcrumbs GDS - Components - Breadcrumbs}
 
-    module Breadcrumbs
-      include ActionView::Context
-      include ActionView::Helpers::TagHelper
-      include ActionView::Helpers::TextHelper
-      include ActionView::Helpers::UrlHelper
+      module Breadcrumbs
+        include ActionView::Context
+        include ActionView::Helpers::TagHelper
+        include ActionView::Helpers::TextHelper
+        include ActionView::Helpers::UrlHelper
 
-      # Generates the HTML for the GOV.UK breadcrumbs component
-      #
-      # @param govuk_breadcrumb_items [Array<Hash>] An array of links for the breadcrumbs list. See {#govuk_breadcrumb_link} for details of the items in the array.
-      # @param govuk_breadcrumbs_options [Hash] options that will be used in customising the HTML
-      #
-      # @option govuk_breadcrumbs_options [String] :classes additional CSS classes for the breadcrumbs HTML
-      # @option govuk_breadcrumbs_options [Boolean] :collapse_on_mobile indicates if it is to colapse breadcrumbs on mobile
-      # @option govuk_breadcrumbs_options [Hash] :attributes any additional attributes that will added as part of the HTML
-      #
-      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Breadcrumbs
-      #                                     which can then be rendered on the page
+        # Generates the HTML for the GOV.UK breadcrumbs component
+        #
+        # @param govuk_breadcrumb_items [Array<Hash>] An array of links for the breadcrumbs list. See {#govuk_breadcrumb_link} for details of the items in the array.
+        # @param govuk_breadcrumbs_options [Hash] options that will be used in customising the HTML
+        #
+        # @option govuk_breadcrumbs_options [String] :classes additional CSS classes for the breadcrumbs HTML
+        # @option govuk_breadcrumbs_options [Boolean] :collapse_on_mobile indicates if it is to colapse breadcrumbs on mobile
+        # @option govuk_breadcrumbs_options [Hash] :attributes any additional attributes that will added as part of the HTML
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Breadcrumbs
+        #                                     which can then be rendered on the page
 
-      def govuk_breadcrumbs(govuk_breadcrumb_items, **govuk_breadcrumbs_options)
-        govuk_breadcrumbs_classes = ['govuk-breadcrumbs']
-        govuk_breadcrumbs_classes << govuk_breadcrumbs_options[:classes]
-        govuk_breadcrumbs_classes << 'govuk-breadcrumbs--collapse-on-mobile' if govuk_breadcrumbs_options[:collapse_on_mobile]
-        govuk_breadcrumbs_options[:attributes] ||= {}
+        def govuk_breadcrumbs(govuk_breadcrumb_items, **govuk_breadcrumbs_options)
+          govuk_breadcrumbs_classes = ['govuk-breadcrumbs']
+          govuk_breadcrumbs_classes << govuk_breadcrumbs_options[:classes]
+          govuk_breadcrumbs_classes << 'govuk-breadcrumbs--collapse-on-mobile' if govuk_breadcrumbs_options[:collapse_on_mobile]
+          govuk_breadcrumbs_options[:attributes] ||= {}
 
-        tag.div(class: govuk_breadcrumbs_classes, **govuk_breadcrumbs_options[:attributes]) do
-          tag.ol(class: 'govuk-breadcrumbs__list') do
-            capture do
-              govuk_breadcrumb_items.each { |govuk_breadcrumb_item| concat(govuk_breadcrumb_link(govuk_breadcrumb_item)) }
+          tag.div(class: govuk_breadcrumbs_classes, **govuk_breadcrumbs_options[:attributes]) do
+            tag.ol(class: 'govuk-breadcrumbs__list') do
+              capture do
+                govuk_breadcrumb_items.each { |govuk_breadcrumb_item| concat(govuk_breadcrumb_link(govuk_breadcrumb_item)) }
+              end
             end
           end
         end
-      end
 
-      private
+        private
 
-      # Generates the HTML for each link in the breadcrumbs.
-      # It is called by {#govuk_breadcrumbs} which will pass in the breadcrum item.
-      #
-      # @param govuk_breadcrumb_item [Hash] a hash containg options for the breadcrumb item
-      #
-      # @option govuk_breadcrumb_item [String] :text the text for the link
-      # @option govuk_breadcrumb_item [String] :href the URI for the link. If blank it is assumed that this item relates to current page
-      # @option govuk_breadcrumb_item [Hash] :attributes any additional attributes that will added as part of the HTML.
-      #                                                  If the link is blank then it defaults to +{ aria: { current: 'page' } }+
-      #
-      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Breadcrumb list item
+        # Generates the HTML for each link in the breadcrumbs.
+        # It is called by {#govuk_breadcrumbs} which will pass in the breadcrum item.
+        #
+        # @param govuk_breadcrumb_item [Hash] a hash containg options for the breadcrumb item
+        #
+        # @option govuk_breadcrumb_item [String] :text the text for the link
+        # @option govuk_breadcrumb_item [String] :href the URI for the link. If blank it is assumed that this item relates to current page
+        # @option govuk_breadcrumb_item [Hash] :attributes any additional attributes that will added as part of the HTML.
+        #                                                  If the link is blank then it defaults to +{ aria: { current: 'page' } }+
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Breadcrumb list item
 
-      def govuk_breadcrumb_link(govuk_breadcrumb_item)
-        govuk_breadcrumb_item[:attributes] ||= {}
+        def govuk_breadcrumb_link(govuk_breadcrumb_item)
+          govuk_breadcrumb_item[:attributes] ||= {}
 
-        if govuk_breadcrumb_item[:href].present?
-          tag.li(class: 'govuk-breadcrumbs__list-item', **govuk_breadcrumb_item[:attributes]) do
-            link_to govuk_breadcrumb_item[:text], govuk_breadcrumb_item[:href], class: 'govuk-breadcrumbs__link'
-          end
-        else
-          (govuk_breadcrumb_item[:attributes][:aria] ||= {}).merge!({ current: 'page' })
+          if govuk_breadcrumb_item[:href].present?
+            tag.li(class: 'govuk-breadcrumbs__list-item', **govuk_breadcrumb_item[:attributes]) do
+              link_to govuk_breadcrumb_item[:text], govuk_breadcrumb_item[:href], class: 'govuk-breadcrumbs__link'
+            end
+          else
+            (govuk_breadcrumb_item[:attributes][:aria] ||= {}).merge!({ current: 'page' })
 
-          tag.li(class: 'govuk-breadcrumbs__list-item', **govuk_breadcrumb_item[:attributes]) do
-            govuk_breadcrumb_item[:text]
+            tag.li(class: 'govuk-breadcrumbs__list-item', **govuk_breadcrumb_item[:attributes]) do
+              govuk_breadcrumb_item[:text]
+            end
           end
         end
       end