crown_marketplace_utils 0.1.0.beta.6 → 0.1.0.beta.8

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

@@ -2,85 +2,87 @@
 
 require 'action_view'
 
-module CrownMarketplaceUtils::Helpers
-  module GovUkHelper
-    # = GOV.UK label
-    #
-    # This helper is used for generating the label component from the Government Design Systems
+module CrownMarketplaceUtils
+  module Helpers
+    module GovUkHelper
+      # = GOV.UK label
+      #
+      # This helper is used for generating the label component from the Government Design Systems
 
-    module Label
-      include ActionView::Context
-      include ActionView::Helpers::TagHelper
-      include ActionView::Helpers::TextHelper
-      include ActionView::Helpers::FormTagHelper
+      module Label
+        include ActionView::Context
+        include ActionView::Helpers::TagHelper
+        include ActionView::Helpers::TextHelper
+        include ActionView::Helpers::FormTagHelper
 
-      # Generates the HTML for the GOV.UK label component
-      #
-      # @param attribute [String, Symbol] the attribute of the input that requires a label
-      # @param label_text [String] the label text, it is ignored if a block is given
-      # @param govuk_label_options [Hash] options that will be used in customising the HTML
-      #
-      # @option govuk_label_options [String] :classes additional CSS classes for the label HTML
-      # @option govuk_label_options [Boolean] :is_page_heading (false) if the legend is also the heading it will rendered in a h1
-      # @option govuk_label_options [ActionView::Helpers::FormBuilder] :form (nil) optional form builder used to create the label
-      # @option govuk_label_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
-      #
-      # @yield HTML that will be contained within the 'govuk-label' label. Ignored if label text is given
-      #
-      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Label
-      #                                     which can then be rendered on the page
+        # Generates the HTML for the GOV.UK label component
+        #
+        # @param attribute [String, Symbol] the attribute of the input that requires a label
+        # @param label_text [String] the label text, it is ignored if a block is given
+        # @param govuk_label_options [Hash] options that will be used in customising the HTML
+        #
+        # @option govuk_label_options [String] :classes additional CSS classes for the label HTML
+        # @option govuk_label_options [Boolean] :is_page_heading (false) if the legend is also the heading it will rendered in a h1
+        # @option govuk_label_options [ActionView::Helpers::FormBuilder] :form (nil) optional form builder used to create the label
+        # @option govuk_label_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+        #
+        # @yield HTML that will be contained within the 'govuk-label' label. Ignored if label text is given
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Label
+        #                                     which can then be rendered on the page
 
-      def govuk_label(attribute, label_text = nil, **govuk_label_options, &block)
-        govuk_label_options[:attributes] ||= {}
-        govuk_label_options[:attributes][:class] = "govuk-label #{govuk_label_options[:classes]}".rstrip
+        def govuk_label(attribute, label_text = nil, **govuk_label_options, &block)
+          govuk_label_options[:attributes] ||= {}
+          govuk_label_options[:attributes][:class] = "govuk-label #{govuk_label_options[:classes]}".rstrip
 
-        label_html = if govuk_label_options[:form]
-                       govuk_label_form(attribute, label_text, **govuk_label_options, &block)
-                     else
-                       govuk_label_tag(attribute, label_text, **govuk_label_options, &block)
-                     end
+          label_html = if govuk_label_options[:form]
+                         govuk_label_form(attribute, label_text, **govuk_label_options, &block)
+                       else
+                         govuk_label_tag(attribute, label_text, **govuk_label_options, &block)
+                       end
 
-        if govuk_label_options[:is_page_heading]
-          tag.h1(label_html, class: 'govuk-label-wrapper')
-        else
-          label_html
+          if govuk_label_options[:is_page_heading]
+            tag.h1(label_html, class: 'govuk-label-wrapper')
+          else
+            label_html
+          end
         end
-      end
 
-      private
+        private
 
-      # Generates the HTML for the GOV.UK label component
-      # using the inbuilt rails method +label+
-      #
-      # @param (see govuk_label)
-      #
-      # @option (see govuk_label)
-      #
-      # @yield (see govuk_label)
-      #
-      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Label
-      #                                     which can then be rendered on the page
+        # Generates the HTML for the GOV.UK label component
+        # using the inbuilt rails method +label+
+        #
+        # @param (see govuk_label)
+        #
+        # @option (see govuk_label)
+        #
+        # @yield (see govuk_label)
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Label
+        #                                     which can then be rendered on the page
 
-      def govuk_label_tag(attribute, label_text, **govuk_label_options)
-        label_tag(attribute, **govuk_label_options[:attributes]) do
-          label_text || yield
+        def govuk_label_tag(attribute, label_text, **govuk_label_options)
+          label_tag(attribute, **govuk_label_options[:attributes]) do
+            label_text || yield
+          end
         end
-      end
 
-      # Generates the HTML for the GOV.UK label component
-      # using the inbuilt rails ActionView::Helpers::FormBuilder
-      #
-      # @param (see govuk_label)
-      #
-      # @option (see govuk_label)
-      #
-      # @yield (see govuk_label)
-      #
-      # @return (see govuk_label_tag)
+        # Generates the HTML for the GOV.UK label component
+        # using the inbuilt rails ActionView::Helpers::FormBuilder
+        #
+        # @param (see govuk_label)
+        #
+        # @option (see govuk_label)
+        #
+        # @yield (see govuk_label)
+        #
+        # @return (see govuk_label_tag)
 
-      def govuk_label_form(attribute, label_text, **govuk_label_options)
-        govuk_label_options[:form].label(attribute, **govuk_label_options[:attributes]) do
-          label_text || yield
+        def govuk_label_form(attribute, label_text, **govuk_label_options)
+          govuk_label_options[:form].label(attribute, **govuk_label_options[:attributes]) do
+            label_text || yield
+          end
         end
       end
     end

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

@@ -2,138 +2,140 @@
 
 require 'action_view'
 
-module CrownMarketplaceUtils::Helpers
-  module GovUkHelper
-    # = GOV.UK Notification Banner
-    #
-    # This helper is used for generating the notification banner component from the
-    # {https://design-system.service.gov.uk/components/notification-banner GDS - Components - Notification banner}
-
-    module NotificationBanner
-      include ActionView::Context
-      include ActionView::Helpers::TagHelper
-      include ActionView::Helpers::TextHelper
-
-      # Generates the HTML for the GOV.UK Notification banner component
+module CrownMarketplaceUtils
+  module Helpers
+    module GovUkHelper
+      # = GOV.UK Notification Banner
       #
-      # @param text [String] the text that will be used for the heading in the content section of the banner.
-      #                      It is ignored if a block is given
-      # @param success_banner [Boolean] will use the success banner options if this is set to true
-      # @param govuk_notification_banner_options [Hash] options that will be used in customising the HTML
-      #
-      # @option govuk_notification_banner_options [String] :classes additional CSS classes for the notification banner HTML
-      # @option govuk_notification_banner_options [String] :title_text ('Important') the title text shown at the top of the banner
-      # @option govuk_notification_banner_options [String] :title_id ('govuk-notification-banner-title') the ID for the title text
-      # @option govuk_notification_banner_options [String] :role ('region') the role for the banner
-      # @option govuk_notification_banner_options [String] :heading_level (2) the heading level for the title text
-      # @option govuk_notification_banner_options [Hash] :attributes ({data: { module: 'govuk-notification-banner' }, aria: { labelledby: 'govuk-notification-banner-title' }})
-      #                                                  any additional attributes that will added as part of the HTML
-      #
-      # @yield HTML that will be contained within the 'govuk-notification-banner__content' div
-      #
-      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Notification banner
-      #                                     which can then be rendered on the page
-
-      def govuk_notification_banner(text = nil, success_banner = false, **govuk_notification_banner_options)
-        banner_options = fetch_banner_options(success_banner, govuk_notification_banner_options)
-        govuk_notification_banner_classes = fetch_banner_classes(banner_options, govuk_notification_banner_options)
-        govuk_notification_banner_attributes = fetch_banner_attributes(banner_options, govuk_notification_banner_options)
-
-        tag.div(class: govuk_notification_banner_classes, role: banner_options[:role], **govuk_notification_banner_attributes) do
-          capture do
-            concat(tag.div(class: 'govuk-notification-banner__header') do
-              tag.send(:"h#{govuk_notification_banner_options[:heading_level] || 2}", banner_options[:title_text], class: 'govuk-notification-banner__title', id: banner_options[:title_id])
-            end)
-            concat(tag.div(class: 'govuk-notification-banner__content') do
-              if block_given?
-                yield
-              else
-                tag.p(text, class: 'govuk-notification-banner__heading')
-              end
-            end)
+      # This helper is used for generating the notification banner component from the
+      # {https://design-system.service.gov.uk/components/notification-banner GDS - Components - Notification banner}
+
+      module NotificationBanner
+        include ActionView::Context
+        include ActionView::Helpers::TagHelper
+        include ActionView::Helpers::TextHelper
+
+        # Generates the HTML for the GOV.UK Notification banner component
+        #
+        # @param text [String] the text that will be used for the heading in the content section of the banner.
+        #                      It is ignored if a block is given
+        # @param success_banner [Boolean] will use the success banner options if this is set to true
+        # @param govuk_notification_banner_options [Hash] options that will be used in customising the HTML
+        #
+        # @option govuk_notification_banner_options [String] :classes additional CSS classes for the notification banner HTML
+        # @option govuk_notification_banner_options [String] :title_text ('Important') the title text shown at the top of the banner
+        # @option govuk_notification_banner_options [String] :title_id ('govuk-notification-banner-title') the ID for the title text
+        # @option govuk_notification_banner_options [String] :role ('region') the role for the banner
+        # @option govuk_notification_banner_options [String] :heading_level (2) the heading level for the title text
+        # @option govuk_notification_banner_options [Hash] :attributes ({data: { module: 'govuk-notification-banner' }, aria: { labelledby: 'govuk-notification-banner-title' }})
+        #                                                  any additional attributes that will added as part of the HTML
+        #
+        # @yield HTML that will be contained within the 'govuk-notification-banner__content' div
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Notification banner
+        #                                     which can then be rendered on the page
+
+        def govuk_notification_banner(text = nil, success_banner = false, **govuk_notification_banner_options)
+          banner_options = fetch_banner_options(success_banner, govuk_notification_banner_options)
+          govuk_notification_banner_classes = fetch_banner_classes(banner_options, govuk_notification_banner_options)
+          govuk_notification_banner_attributes = fetch_banner_attributes(banner_options, govuk_notification_banner_options)
+
+          tag.div(class: govuk_notification_banner_classes, role: banner_options[:role], **govuk_notification_banner_attributes) do
+            capture do
+              concat(tag.div(class: 'govuk-notification-banner__header') do
+                tag.send(:"h#{govuk_notification_banner_options[:heading_level] || 2}", banner_options[:title_text], class: 'govuk-notification-banner__title', id: banner_options[:title_id])
+              end)
+              concat(tag.div(class: 'govuk-notification-banner__content') do
+                if block_given?
+                  yield
+                else
+                  tag.p(text, class: 'govuk-notification-banner__heading')
+                end
+              end)
+            end
           end
         end
-      end
 
-      private
-
-      # Determines the banner options to be used for {#govuk_notification_banner}
-      #
-      # @param success_banner [Boolean] will use the success banner options if this is set to true
-      # @param govuk_notification_banner_options [Hash] options that will be used in customising the HTML
-      #
-      # @option govuk_notification_banner_options [String] :title_text ('Important') the title text shown at the top of the banner
-      # @option govuk_notification_banner_options [String] :title_id ('govuk-notification-banner-title') the ID for the title text
-      # @option govuk_notification_banner_options [String] :role ('region') the role for the banner
-      #
-      # @return [Hash] contains the following options used in {#govuk_notification_banner}:
-      #                - +classes+
-      #                - +title_text+
-      #                - +title_id+
-      #                - +role+
-
-      def fetch_banner_options(success_banner, govuk_notification_banner_options)
-        banner_options = DEFAULT_OPTIONS.dup
-
-        banner_options.merge!(SUCCESS_BANNER_OPTIONS) if success_banner
+        private
+
+        # Determines the banner options to be used for {#govuk_notification_banner}
+        #
+        # @param success_banner [Boolean] will use the success banner options if this is set to true
+        # @param govuk_notification_banner_options [Hash] options that will be used in customising the HTML
+        #
+        # @option govuk_notification_banner_options [String] :title_text ('Important') the title text shown at the top of the banner
+        # @option govuk_notification_banner_options [String] :title_id ('govuk-notification-banner-title') the ID for the title text
+        # @option govuk_notification_banner_options [String] :role ('region') the role for the banner
+        #
+        # @return [Hash] contains the following options used in {#govuk_notification_banner}:
+        #                - +classes+
+        #                - +title_text+
+        #                - +title_id+
+        #                - +role+
+
+        def fetch_banner_options(success_banner, govuk_notification_banner_options)
+          banner_options = DEFAULT_OPTIONS.dup
+
+          banner_options.merge!(SUCCESS_BANNER_OPTIONS) if success_banner
+
+          govuk_notification_banner_options.each do |key, value|
+            banner_options[key] = value if banner_options.key?(key)
+          end
 
-        govuk_notification_banner_options.each do |key, value|
-          banner_options[key] = value if banner_options.key?(key)
+          banner_options
         end
 
-        banner_options
-      end
-
-      # Determines the banner classes to be used for {#govuk_notification_banner}
-      #
-      # @param banner_options [Hash] this is the return value from {#fetch_banner_options}
-      # @param govuk_notification_banner_options [Hash] options that will be used in customising the HTML
-      #
-      # @option govuk_notification_banner_options [String] :classes additional CSS classes for the notification banner HTML
-      #
-      # @return [Array<String>] an array of classes to be used in {#govuk_notification_banner}
+        # Determines the banner classes to be used for {#govuk_notification_banner}
+        #
+        # @param banner_options [Hash] this is the return value from {#fetch_banner_options}
+        # @param govuk_notification_banner_options [Hash] options that will be used in customising the HTML
+        #
+        # @option govuk_notification_banner_options [String] :classes additional CSS classes for the notification banner HTML
+        #
+        # @return [Array<String>] an array of classes to be used in {#govuk_notification_banner}
+
+        def fetch_banner_classes(banner_options, govuk_notification_banner_options)
+          govuk_notification_banner_classes = ['govuk-notification-banner']
+          govuk_notification_banner_classes << govuk_notification_banner_options[:classes]
+          govuk_notification_banner_classes << banner_options[:classes]
+
+          govuk_notification_banner_classes
+        end
 
-      def fetch_banner_classes(banner_options, govuk_notification_banner_options)
-        govuk_notification_banner_classes = ['govuk-notification-banner']
-        govuk_notification_banner_classes << govuk_notification_banner_options[:classes]
-        govuk_notification_banner_classes << banner_options[:classes]
+        # Default HTML attributes for {#govuk_notification_banner}
+        #
+        # @param banner_options [Hash] this is the return value from {#fetch_banner_options}
+        # @param govuk_notification_banner_options [Hash] options that will be used in customising the HTML
+        #
+        # @option govuk_notification_banner_options [Hash] :attributes ({data: { module: 'govuk-notification-banner' }, aria: { labelledby: 'govuk-notification-banner-title' }})
+        #                                                  any additional attributes that will added as part of the HTML
+        #
+        # @return [Hash] contains the default attributes for {#govuk_notification_banner} and any additional attributes that were passed
+
+        def fetch_banner_attributes(banner_options, govuk_notification_banner_options)
+          govuk_notification_banner_attributes = govuk_notification_banner_options[:attributes] || {}
+          (govuk_notification_banner_attributes[:data] ||= {}).merge!({ module: 'govuk-notification-banner' })
+          (govuk_notification_banner_attributes[:aria] ||= {}).merge!({ labelledby: banner_options[:title_id] })
+
+          govuk_notification_banner_attributes
+        end
 
-        govuk_notification_banner_classes
-      end
+        # Default options used in normal versions of {#govuk_notification_banner}
 
-      # Default HTML attributes for {#govuk_notification_banner}
-      #
-      # @param banner_options [Hash] this is the return value from {#fetch_banner_options}
-      # @param govuk_notification_banner_options [Hash] options that will be used in customising the HTML
-      #
-      # @option govuk_notification_banner_options [Hash] :attributes ({data: { module: 'govuk-notification-banner' }, aria: { labelledby: 'govuk-notification-banner-title' }})
-      #                                                  any additional attributes that will added as part of the HTML
-      #
-      # @return [Hash] contains the default attributes for {#govuk_notification_banner} and any additional attributes that were passed
+        DEFAULT_OPTIONS = {
+          title_text: 'Important',
+          title_id: 'govuk-notification-banner-title',
+          role: 'region'
+        }.freeze
 
-      def fetch_banner_attributes(banner_options, govuk_notification_banner_options)
-        govuk_notification_banner_attributes = govuk_notification_banner_options[:attributes] || {}
-        (govuk_notification_banner_attributes[:data] ||= {}).merge!({ module: 'govuk-notification-banner' })
-        (govuk_notification_banner_attributes[:aria] ||= {}).merge!({ labelledby: banner_options[:title_id] })
+        # Options specific for the success version of {#govuk_notification_banner}
 
-        govuk_notification_banner_attributes
+        SUCCESS_BANNER_OPTIONS = {
+          classes: 'govuk-notification-banner--success',
+          title_text: 'Success',
+          role: 'alert'
+        }.freeze
       end
-
-      # Default options used in normal versions of {#govuk_notification_banner}
-
-      DEFAULT_OPTIONS = {
-        title_text: 'Important',
-        title_id: 'govuk-notification-banner-title',
-        role: 'region'
-      }.freeze
-
-      # Options specific for the success version of {#govuk_notification_banner}
-
-      SUCCESS_BANNER_OPTIONS = {
-        classes: 'govuk-notification-banner--success',
-        title_text: 'Success',
-        role: 'alert'
-      }.freeze
     end
   end
 end