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

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

@@ -2,121 +2,123 @@
 
 require 'action_view'
 
-module CrownMarketplaceUtils::Helpers
-  module GovUkHelper
-    # = GOV.UK Button
-    #
-    # This helper is used for generating the button component from the
-    # {https://design-system.service.gov.uk/components/button GDS - Components - Button}
-
-    module Button
-      include ActionView::Context
-      include ActionView::Helpers::TagHelper
-      include ActionView::Helpers::TextHelper
-      include ActionView::Helpers::UrlHelper
-      include ActionView::Helpers::FormTagHelper
-
-      # Generates the HTML for the GOV.UK button component
+module CrownMarketplaceUtils
+  module Helpers
+    module GovUkHelper
+      # = GOV.UK Button
       #
-      # @param text [String] the text that will be shown in the button
-      # @param govuk_button_options [Hash] options that will be used in customising the HTML
-      #
-      # @option govuk_button_options [String] :classes additional CSS classes for the button HTML
-      # @option govuk_button_options [Boolean] :is_start_button indicates if it is a start button
-      # @option govuk_button_options [String] :href the URI that will be used in anchor tag
-      # @option govuk_button_options [ActionView::Helpers::FormBuilder] :form the form builder used to create the submit button
-      # @option govuk_button_options [Hash] :attributes ({ data: { module: 'govuk-button' } }) any additional attributes that will added as part of the HTML
-      #
-      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Button
-      #                                     which can then be rendered on the page
-
-      def govuk_button(text, **govuk_button_options)
-        govuk_button_classes = ['govuk-button']
-        govuk_button_classes << govuk_button_options[:classes]
-        govuk_button_options[:attributes] ||= {}
-        govuk_button_classes << 'govuk-button--disabled' if govuk_button_options[:attributes][:disabled]
-        govuk_button_classes << 'govuk-button--start' if govuk_button_options[:is_start_button]
-
-        (govuk_button_options[:attributes][:data] ||= {}).merge!({ module: 'govuk-button' })
-
-        button_method = if govuk_button_options[:href]
-                          :govuk_button_link
-                        elsif govuk_button_options[:form]
-                          :govuk_button_submit
-                        else
-                          :govuk_button_button
-                        end
-
-        send(button_method, text, govuk_button_classes, **govuk_button_options)
-      end
-
-      private
-
-      # Generates the HTML for the GOV.UK button component as an anchor tag.
-      # It is called by {#govuk_button} which will pass in the parameters, including any defaults.
-      #
-      # @param text [String] the text that will be shown in the button
-      # @param classes [String] additional CSS classes for the button HTML
-      # @param govuk_button_options [Hash] options that will be used in customising the HTML
-      #
-      # @option govuk_button_options [Boolean] :is_start_button indicates if it is a start button
-      # @option govuk_button_options [String] :href the URI that will be used in anchor tag
-      # @option govuk_button_options [Hash] :attributes any additional attributes that will added as part of the HTML
-      #
-      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Button as an anchor element
-      #                                     which can then be rendered on the page
-
-      def govuk_button_link(text, classes, **govuk_button_options)
-        link_to(govuk_button_options[:href], class: classes, role: :button, draggable: false, **govuk_button_options[:attributes]) do
-          concat(text)
-          concat(govuk_start_button_icon) if govuk_button_options[:is_start_button]
+      # This helper is used for generating the button component from the
+      # {https://design-system.service.gov.uk/components/button GDS - Components - Button}
+
+      module Button
+        include ActionView::Context
+        include ActionView::Helpers::TagHelper
+        include ActionView::Helpers::TextHelper
+        include ActionView::Helpers::UrlHelper
+        include ActionView::Helpers::FormTagHelper
+
+        # Generates the HTML for the GOV.UK button component
+        #
+        # @param text [String] the text that will be shown in the button
+        # @param govuk_button_options [Hash] options that will be used in customising the HTML
+        #
+        # @option govuk_button_options [String] :classes additional CSS classes for the button HTML
+        # @option govuk_button_options [Boolean] :is_start_button indicates if it is a start button
+        # @option govuk_button_options [String] :href the URI that will be used in anchor tag
+        # @option govuk_button_options [ActionView::Helpers::FormBuilder] :form the form builder used to create the submit button
+        # @option govuk_button_options [Hash] :attributes ({ data: { module: 'govuk-button' } }) any additional attributes that will added as part of the HTML
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Button
+        #                                     which can then be rendered on the page
+
+        def govuk_button(text, **govuk_button_options)
+          govuk_button_classes = ['govuk-button']
+          govuk_button_classes << govuk_button_options[:classes]
+          govuk_button_options[:attributes] ||= {}
+          govuk_button_classes << 'govuk-button--disabled' if govuk_button_options[:attributes][:disabled]
+          govuk_button_classes << 'govuk-button--start' if govuk_button_options[:is_start_button]
+
+          (govuk_button_options[:attributes][:data] ||= {}).merge!({ module: 'govuk-button' })
+
+          button_method = if govuk_button_options[:href]
+                            :govuk_button_link
+                          elsif govuk_button_options[:form]
+                            :govuk_button_submit
+                          else
+                            :govuk_button_button
+                          end
+
+          send(button_method, text, govuk_button_classes, **govuk_button_options)
         end
-      end
-
-      # Generates the HTML for the GOV.UK button component as a button.
-      # It is called by {#govuk_button} which will pass in the parameters, including any defaults.
-      #
-      # @param text [String] the text that will be shown in the button
-      # @param classes [String] additional CSS classes for the button HTML
-      # @param govuk_button_options [Hash] options that will be used in customising the HTML
-      #
-      # @option govuk_button_options [Boolean] :is_start_button indicates if it is a start button
-      # @option govuk_button_options [Hash] :attributes any additional attributes that will added as part of the HTML
-      #
-      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Button as a button element
-      #                                     which can then be rendered on the page
 
-      def govuk_button_button(text, classes, **govuk_button_options)
-        button_tag(class: classes, **govuk_button_options[:attributes]) do
-          concat(text)
-          concat(govuk_start_button_icon) if govuk_button_options[:is_start_button]
+        private
+
+        # Generates the HTML for the GOV.UK button component as an anchor tag.
+        # It is called by {#govuk_button} which will pass in the parameters, including any defaults.
+        #
+        # @param text [String] the text that will be shown in the button
+        # @param classes [String] additional CSS classes for the button HTML
+        # @param govuk_button_options [Hash] options that will be used in customising the HTML
+        #
+        # @option govuk_button_options [Boolean] :is_start_button indicates if it is a start button
+        # @option govuk_button_options [String] :href the URI that will be used in anchor tag
+        # @option govuk_button_options [Hash] :attributes any additional attributes that will added as part of the HTML
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Button as an anchor element
+        #                                     which can then be rendered on the page
+
+        def govuk_button_link(text, classes, **govuk_button_options)
+          link_to(govuk_button_options[:href], class: classes, role: :button, draggable: false, **govuk_button_options[:attributes]) do
+            concat(text)
+            concat(govuk_start_button_icon) if govuk_button_options[:is_start_button]
+          end
         end
-      end
 
-      # Generates the HTML for the GOV.UK button component as an input.
-      # It is called by {#govuk_button} which will pass in the parameters, including any defaults.
-      #
-      # @param text [String] the text that will be shown in the input
-      # @param classes [String] additional CSS classes for the button HTML
-      # @param govuk_button_options [Hash] options that will be used in customising the HTML
-      #
-      # @option govuk_button_options [ActionView::Helpers::FormBuilder] :form the form builder used to create the submit button
-      # @option govuk_button_options [Hash] :attributes any additional attributes that will added as part of the HTML
-      #
-      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Button as an input element
-      #                                     which can then be rendered on the page
+        # Generates the HTML for the GOV.UK button component as a button.
+        # It is called by {#govuk_button} which will pass in the parameters, including any defaults.
+        #
+        # @param text [String] the text that will be shown in the button
+        # @param classes [String] additional CSS classes for the button HTML
+        # @param govuk_button_options [Hash] options that will be used in customising the HTML
+        #
+        # @option govuk_button_options [Boolean] :is_start_button indicates if it is a start button
+        # @option govuk_button_options [Hash] :attributes any additional attributes that will added as part of the HTML
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Button as a button element
+        #                                     which can then be rendered on the page
+
+        def govuk_button_button(text, classes, **govuk_button_options)
+          button_tag(class: classes, **govuk_button_options[:attributes]) do
+            concat(text)
+            concat(govuk_start_button_icon) if govuk_button_options[:is_start_button]
+          end
+        end
 
-      def govuk_button_submit(text, classes, **govuk_button_options)
-        govuk_button_options[:form].submit(text, class: classes, **govuk_button_options[:attributes])
-      end
+        # Generates the HTML for the GOV.UK button component as an input.
+        # It is called by {#govuk_button} which will pass in the parameters, including any defaults.
+        #
+        # @param text [String] the text that will be shown in the input
+        # @param classes [String] additional CSS classes for the button HTML
+        # @param govuk_button_options [Hash] options that will be used in customising the HTML
+        #
+        # @option govuk_button_options [ActionView::Helpers::FormBuilder] :form the form builder used to create the submit button
+        # @option govuk_button_options [Hash] :attributes any additional attributes that will added as part of the HTML
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Button as an input element
+        #                                     which can then be rendered on the page
+
+        def govuk_button_submit(text, classes, **govuk_button_options)
+          govuk_button_options[:form].submit(text, class: classes, **govuk_button_options[:attributes])
+        end
 
-      # Generates the arrow for the start button option as part of {#govuk_button}
-      #
-      # @return [ActiveSupport::SafeBuffer] the HTML for the arrow for the start button
+        # Generates the arrow for the start button option as part of {#govuk_button}
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the arrow for the start button
 
-      def govuk_start_button_icon
-        tag.svg(class: 'govuk-button__start-icon', xmlns: 'http://www.w3.org/2000/svg', width: 17.5, height: 19, viewBox: '0 0 33 40', aria: { hidden: true }, focusable: false) do
-          tag.path(fill: 'currentColor', d: 'M0 0h13l20 20-20 20H0l20-20z')
+        def govuk_start_button_icon
+          tag.svg(class: 'govuk-button__start-icon', xmlns: 'http://www.w3.org/2000/svg', width: 17.5, height: 19, viewBox: '0 0 33 40', aria: { hidden: true }, focusable: false) do
+            tag.path(fill: 'currentColor', d: 'M0 0h13l20 20-20 20H0l20-20z')
+          end
         end
       end
     end

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

@@ -2,41 +2,43 @@
 
 require 'action_view'
 
-module CrownMarketplaceUtils::Helpers
-  module GovUkHelper
-    # = GOV.UK Details
-    #
-    # This helper is used for generating the details component from the
-    # {https://design-system.service.gov.uk/components/details GDS - Components - Details}
+module CrownMarketplaceUtils
+  module Helpers
+    module GovUkHelper
+      # = GOV.UK Details
+      #
+      # This helper is used for generating the details component from the
+      # {https://design-system.service.gov.uk/components/details GDS - Components - Details}
 
-    module Details
-      include ActionView::Context
-      include ActionView::Helpers::TagHelper
-      include ActionView::Helpers::TextHelper
+      module Details
+        include ActionView::Context
+        include ActionView::Helpers::TagHelper
+        include ActionView::Helpers::TextHelper
 
-      # Generates the HTML for the GOV.UK Details component
-      #
-      # @param summary_text [String] the summary text for the details element
-      # @param govuk_details_options [Hash] options that will be used in customising the HTML
-      #
-      # @option govuk_details_options [String] :classes additional CSS classes for the details HTML
-      # @option govuk_details_options [Hash] :attributes ({ data: { module: 'govuk-details' } }) any additional attributes that will added as part of the HTML
-      #
-      # @yield HTML that will be contained within the 'govuk-details__text' div
-      #
-      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Details
-      #                                     which can then be rendered on the page
+        # Generates the HTML for the GOV.UK Details component
+        #
+        # @param summary_text [String] the summary text for the details element
+        # @param govuk_details_options [Hash] options that will be used in customising the HTML
+        #
+        # @option govuk_details_options [String] :classes additional CSS classes for the details HTML
+        # @option govuk_details_options [Hash] :attributes ({ data: { module: 'govuk-details' } }) any additional attributes that will added as part of the HTML
+        #
+        # @yield HTML that will be contained within the 'govuk-details__text' div
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Details
+        #                                     which can then be rendered on the page
 
-      def govuk_details(summary_text, **govuk_details_options, &block)
-        govuk_details_classes = ['govuk-details']
-        govuk_details_classes << govuk_details_options[:classes]
-        govuk_details_options[:attributes] ||= {}
-        (govuk_details_options[:attributes][:data] ||= {}).merge!({ module: 'govuk-details' })
+        def govuk_details(summary_text, **govuk_details_options, &block)
+          govuk_details_classes = ['govuk-details']
+          govuk_details_classes << govuk_details_options[:classes]
+          govuk_details_options[:attributes] ||= {}
+          (govuk_details_options[:attributes][:data] ||= {}).merge!({ module: 'govuk-details' })
 
-        tag.details(class: govuk_details_classes, **govuk_details_options[:attributes]) do
-          capture do
-            concat(tag.summary(tag.span(summary_text, class: 'govuk-details__summary-text'), class: 'govuk-details__summary'))
-            concat(tag.div(class: 'govuk-details__text', &block))
+          tag.details(class: govuk_details_classes, **govuk_details_options[:attributes]) do
+            capture do
+              concat(tag.summary(tag.span(summary_text, class: 'govuk-details__summary-text'), class: 'govuk-details__summary'))
+              concat(tag.div(class: 'govuk-details__text', &block))
+            end
           end
         end
       end

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

@@ -2,57 +2,59 @@
 
 require 'action_view'
 
-module CrownMarketplaceUtils::Helpers
-  module GovUkHelper
-    # = GOV.UK Error Message
-    #
-    # This helper is used for generating the error message component from the
-    # {https://design-system.service.gov.uk/components/error-message GDS - Components - Error message}
-
-    module ErrorMessage
-      include ActionView::Context
-      include ActionView::Helpers::TagHelper
-      include ActionView::Helpers::TextHelper
-
-      # Generates the HTML for the GOV.UK Error message component
+module CrownMarketplaceUtils
+  module Helpers
+    module GovUkHelper
+      # = GOV.UK Error Message
       #
-      # @param message [String] the message to be displayed
-      # @param attribute [String, Symbol] the attribute that has an error
-      # @param govuk_error_message_options [Hash] options that will be used in customising the HTML
-      #
-      # @option govuk_error_message_options [String] :classes additional CSS classes for the error message HTML
-      # @option govuk_error_message_options [String] :visually_hidden_text ('Error') visualy hidden text before the error message
-      # @option govuk_error_message_options [Hash] :attributes ({}) any additional attributes that will be added as part of the HTML
-      #
-      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Error message
-      #                                     which can then be rendered on the page
-
-      def govuk_error_message(message, attribute, **govuk_error_message_options)
-        class_list = ['govuk-error-message']
-        class_list << govuk_error_message_options[:classes]
-        visually_hidden_text = govuk_error_message_options[:visually_hidden_text] || 'Error'
-        govuk_error_message_options[:attributes] ||= {}
-
-        tag.p(id: "#{attribute}-error", class: class_list, **govuk_error_message_options[:attributes]) do
-          capture do
-            concat(tag.span("#{visually_hidden_text}: ", class: 'govuk-visually-hidden')) if visually_hidden_text.present?
-            concat(message)
+      # This helper is used for generating the error message component from the
+      # {https://design-system.service.gov.uk/components/error-message GDS - Components - Error message}
+
+      module ErrorMessage
+        include ActionView::Context
+        include ActionView::Helpers::TagHelper
+        include ActionView::Helpers::TextHelper
+
+        # Generates the HTML for the GOV.UK Error message component
+        #
+        # @param message [String] the message to be displayed
+        # @param attribute [String, Symbol] the attribute that has an error
+        # @param govuk_error_message_options [Hash] options that will be used in customising the HTML
+        #
+        # @option govuk_error_message_options [String] :classes additional CSS classes for the error message HTML
+        # @option govuk_error_message_options [String] :visually_hidden_text ('Error') visualy hidden text before the error message
+        # @option govuk_error_message_options [Hash] :attributes ({}) any additional attributes that will be added as part of the HTML
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Error message
+        #                                     which can then be rendered on the page
+
+        def govuk_error_message(message, attribute, **govuk_error_message_options)
+          class_list = ['govuk-error-message']
+          class_list << govuk_error_message_options[:classes]
+          visually_hidden_text = govuk_error_message_options[:visually_hidden_text] || 'Error'
+          govuk_error_message_options[:attributes] ||= {}
+
+          tag.p(id: "#{attribute}-error", class: class_list, **govuk_error_message_options[:attributes]) do
+            capture do
+              concat(tag.span("#{visually_hidden_text}: ", class: 'govuk-visually-hidden')) if visually_hidden_text.present?
+              concat(message)
+            end
           end
         end
-      end
-
-      # Generates the HTML for the GOV.UK Error message component using the error messages in an ActiveModel
-      #
-      # @param model [ActiveModel] model that will be used to find the error message
-      # @param attribute [String, Symbol] the attribute that has an error
-      # @param govuk_error_message_options [Hash] options that will be used in customising the HTML
-      #
-      # @option (see #govuk_error_message)
-      #
-      # @return (see #govuk_error_message)
 
-      def govuk_error_message_with_model(model, attribute, **govuk_error_message_options)
-        govuk_error_message(model.errors[attribute].first, attribute, **govuk_error_message_options)
+        # Generates the HTML for the GOV.UK Error message component using the error messages in an ActiveModel
+        #
+        # @param model [ActiveModel] model that will be used to find the error message
+        # @param attribute [String, Symbol] the attribute that has an error
+        # @param govuk_error_message_options [Hash] options that will be used in customising the HTML
+        #
+        # @option (see #govuk_error_message)
+        #
+        # @return (see #govuk_error_message)
+
+        def govuk_error_message_with_model(model, attribute, **govuk_error_message_options)
+          govuk_error_message(model.errors[attribute].first, attribute, **govuk_error_message_options)
+        end
       end
     end
   end