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

data/lib/ccs/frontend_helpers/govuk_frontend/error_message.rb

@@ -3,41 +3,43 @@
 require_relative '../../components/govuk/back_link'
 
 module CCS
-  module FrontendHelpers::GovUKFrontend
-    # = 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
-      # Generates the HTML for the GOV.UK Error message component
-      #
-      # @param (see CCS::Components::GovUK::ErrorMessage#initialize)
+  module FrontendHelpers
+    module GovUKFrontend
+      # = GOV.UK Error Message
       #
-      # @option (see CCS::Components::GovUK::ErrorMessage#initialize)
-      #
-      # @return (see CCS::Components::GovUK::ErrorMessage#render)
+      # 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}
 
-      def govuk_error_message(error_message, attribute, **options)
-        Components::GovUK::ErrorMessage.new(context: self, message: error_message, attribute: attribute, **options).render
-      end
+      module ErrorMessage
+        # Generates the HTML for the GOV.UK Error message component
+        #
+        # @param (see CCS::Components::GovUK::ErrorMessage#initialize)
+        #
+        # @option (see CCS::Components::GovUK::ErrorMessage#initialize)
+        #
+        # @return (see CCS::Components::GovUK::ErrorMessage#render)
 
-      # 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 options [Hash] options that will be used in customising the HTML
-      #
-      # @option (see CCS::Components::GovUK::ErrorMessage#initialize)
-      #
-      # @return [NilClass, ActiveSupport::SafeBuffer] if the error message is not on the model it will return nil,
-      #                                               otherwise it returns the error message HTML
+        def govuk_error_message(error_message, attribute, **options)
+          Components::GovUK::ErrorMessage.new(context: self, message: error_message, attribute: attribute, **options).render
+        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 options [Hash] options that will be used in customising the HTML
+        #
+        # @option (see CCS::Components::GovUK::ErrorMessage#initialize)
+        #
+        # @return [NilClass, ActiveSupport::SafeBuffer] if the error message is not on the model it will return nil,
+        #                                               otherwise it returns the error message HTML
 
-      def govuk_error_message_with_model(model, attribute, **options)
-        error_message = model.errors[attribute].first
-        return unless error_message
+        def govuk_error_message_with_model(model, attribute, **options)
+          error_message = model.errors[attribute].first
+          return unless error_message
 
-        Components::GovUK::ErrorMessage.new(context: self, message: error_message, attribute: attribute, **options).render
+          Components::GovUK::ErrorMessage.new(context: self, message: error_message, attribute: attribute, **options).render
+        end
       end
     end
   end

data/lib/ccs/frontend_helpers/govuk_frontend/error_summary.rb

@@ -3,43 +3,45 @@
 require_relative '../../components/govuk/error_summary'
 
 module CCS
-  module FrontendHelpers::GovUKFrontend
-    # = GOV.UK Error Summary
-    #
-    # This helper is used for generating the error summary component from the
-    # {https://design-system.service.gov.uk/components/error-summary GDS - Components - Error summary}
-
-    module ErrorSummary
-      # Generates the HTML for the GOV.UK Error summary component
+  module FrontendHelpers
+    module GovUKFrontend
+      # = GOV.UK Error Summary
       #
-      # @param (see CCS::Components::GovUK::ErrorSummary#initialize)
-      #
-      # @option (see CCS::Components::GovUK::ErrorSummary#initialize)
-      #
-      # @return (see CCS::Components::GovUK::ErrorSummary#render)
-
-      def govuk_error_summary(title, error_summary_items, description = nil, **options)
-        Components::GovUK::ErrorSummary.new(context: self, title: title, error_summary_items: error_summary_items, description: description, **options).render
-      end
-
-      # Generates the HTML for the GOV.UK Error summary component using the error messages in an ActiveModel
-      #
-      # @param model [ActiveModel] model that will be used to find the error messages to list
-      # @param title [String] text to use for the heading of the error summary block
-      # @param description [String] (nil) optional text to use for the description of the errors
-      # @param options [Hash] options that will be used in customising the HTML
-      #
-      # @option (see CCS::Components::GovUK::ErrorSummary#initialize)
-      #
-      # @return [NilClass, ActiveSupport::SafeBuffer] if error messages are not on the model it will return nil,
-      #                                               otherwise it returns the error summary HTML.
-
-      def govuk_error_summary_with_model(model, title, description = nil, **options)
-        return if model.errors.blank?
-
-        error_summary_items = model.errors.map { |error| { text: error.message, href: "##{error.attribute}-error" } }
-
-        Components::GovUK::ErrorSummary.new(context: self, title: title, error_summary_items: error_summary_items, description: description, **options).render
+      # This helper is used for generating the error summary component from the
+      # {https://design-system.service.gov.uk/components/error-summary GDS - Components - Error summary}
+
+      module ErrorSummary
+        # Generates the HTML for the GOV.UK Error summary component
+        #
+        # @param (see CCS::Components::GovUK::ErrorSummary#initialize)
+        #
+        # @option (see CCS::Components::GovUK::ErrorSummary#initialize)
+        #
+        # @return (see CCS::Components::GovUK::ErrorSummary#render)
+
+        def govuk_error_summary(title, error_summary_items, description = nil, **options)
+          Components::GovUK::ErrorSummary.new(context: self, title: title, error_summary_items: error_summary_items, description: description, **options).render
+        end
+
+        # Generates the HTML for the GOV.UK Error summary component using the error messages in an ActiveModel
+        #
+        # @param model [ActiveModel] model that will be used to find the error messages to list
+        # @param title [String] text to use for the heading of the error summary block
+        # @param description [String] (nil) optional text to use for the description of the errors
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option (see CCS::Components::GovUK::ErrorSummary#initialize)
+        #
+        # @return [NilClass, ActiveSupport::SafeBuffer] if error messages are not on the model it will return nil,
+        #                                               otherwise it returns the error summary HTML.
+
+        def govuk_error_summary_with_model(model, title, description = nil, **options)
+          return if model.errors.blank?
+
+          error_summary_items = model.errors.map { |error| { text: error.message, href: "##{error.attribute}-error" } }
+
+          Components::GovUK::ErrorSummary.new(context: self, title: title, error_summary_items: error_summary_items, description: description, **options).render
+        end
       end
     end
   end

data/lib/ccs/frontend_helpers/govuk_frontend/fieldset.rb

@@ -3,25 +3,27 @@
 require_relative '../../components/govuk/fieldset'
 
 module CCS
-  module FrontendHelpers::GovUKFrontend
-    # = GOV.UK Fieldset
-    #
-    # This helper is used for generating the fieldset component from the
-    # {https://design-system.service.gov.uk/components/fieldset GDS - Components - Fieldset}
-
-    module Fieldset
-      # Generates the HTML for the GOV.UK Fieldset component
-      #
-      # @param (see CCS::Components::GovUK::Fieldset#initialize)
-      #
-      # @option (see CCS::Components::GovUK::Fieldset#initialize)
+  module FrontendHelpers
+    module GovUKFrontend
+      # = GOV.UK Fieldset
       #
-      # @yield (see CCS::Components::GovUK::Fieldset#render)
-      #
-      # @return (see CCS::Components::GovUK::Fieldset#render)
+      # This helper is used for generating the fieldset component from the
+      # {https://design-system.service.gov.uk/components/fieldset GDS - Components - Fieldset}
+
+      module Fieldset
+        # Generates the HTML for the GOV.UK Fieldset component
+        #
+        # @param (see CCS::Components::GovUK::Fieldset#initialize)
+        #
+        # @option (see CCS::Components::GovUK::Fieldset#initialize)
+        #
+        # @yield (see CCS::Components::GovUK::Fieldset#render)
+        #
+        # @return (see CCS::Components::GovUK::Fieldset#render)
 
-      def govuk_fieldset(**options, &block)
-        Components::GovUK::Fieldset.new(context: self, **options).render(&block)
+        def govuk_fieldset(**options, &block)
+          Components::GovUK::Fieldset.new(context: self, **options).render(&block)
+        end
       end
     end
   end

data/lib/ccs/frontend_helpers/govuk_frontend/file_upload.rb

@@ -3,23 +3,25 @@
 require_relative '../../components/govuk/field/input/file_upload'
 
 module CCS
-  module FrontendHelpers::GovUKFrontend
-    # = GOV.UK File Upload
-    #
-    # This helper is used for generating the file upload component from the
-    # {https://design-system.service.gov.uk/components/file-upload GDS - Components - File Upload}
-
-    module FileUpload
-      # Generates the HTML for the GOV.UK File Upload component
-      #
-      # @param (see CCS::Components::GovUK::Input::FileUpload#initialize)
+  module FrontendHelpers
+    module GovUKFrontend
+      # = GOV.UK File Upload
       #
-      # @option (see CCS::Components::GovUK::Input::FileUpload#initialize)
-      #
-      # @return (see CCS::Components::GovUK::Input::FileUpload#render)
+      # This helper is used for generating the file upload component from the
+      # {https://design-system.service.gov.uk/components/file-upload GDS - Components - File Upload}
+
+      module FileUpload
+        # Generates the HTML for the GOV.UK File Upload component
+        #
+        # @param (see CCS::Components::GovUK::Input::FileUpload#initialize)
+        #
+        # @option (see CCS::Components::GovUK::Input::FileUpload#initialize)
+        #
+        # @return (see CCS::Components::GovUK::Input::FileUpload#render)
 
-      def govuk_file_upload(attribute, **options)
-        Components::GovUK::Field::Input::FileUpload.new(context: self, attribute: attribute, **options).render
+        def govuk_file_upload(attribute, **options)
+          Components::GovUK::Field::Input::FileUpload.new(context: self, attribute: attribute, **options).render
+        end
       end
     end
   end

data/lib/ccs/frontend_helpers/govuk_frontend/footer.rb

@@ -3,23 +3,25 @@
 require_relative '../../components/govuk/footer'
 
 module CCS
-  module FrontendHelpers::GovUKFrontend
-    # = GOV.UK Footer
-    #
-    # This helper is used for generating the footer component from the
-    # {https://design-system.service.gov.uk/components/footer GDS - Components - Footer}
-
-    module Footer
-      # Generates the HTML for the GOV.UK Footer component
-      #
-      # @param (see CCS::Components::GovUK::Footer#initialize)
+  module FrontendHelpers
+    module GovUKFrontend
+      # = GOV.UK Footer
       #
-      # @option (see CCS::Components::GovUK::Footer#initialize)
-      #
-      # @return (see CCS::Components::GovUK::Footer#render)
+      # This helper is used for generating the footer component from the
+      # {https://design-system.service.gov.uk/components/footer GDS - Components - Footer}
+
+      module Footer
+        # Generates the HTML for the GOV.UK Footer component
+        #
+        # @param (see CCS::Components::GovUK::Footer#initialize)
+        #
+        # @option (see CCS::Components::GovUK::Footer#initialize)
+        #
+        # @return (see CCS::Components::GovUK::Footer#render)
 
-      def govuk_footer(**options)
-        Components::GovUK::Footer.new(context: self, **options).render
+        def govuk_footer(**options)
+          Components::GovUK::Footer.new(context: self, **options).render
+        end
       end
     end
   end

data/lib/ccs/frontend_helpers/govuk_frontend/form_group.rb

@@ -3,34 +3,36 @@
 require_relative '../../components/govuk/form_group'
 
 module CCS
-  module FrontendHelpers::GovUKFrontend
-    # = GOV.UK FormGroup
-    #
-    # This helper is used for generating the form group component from the Government Design Systems
-
-    module FormGroup
-      # Generates the HTML for the GOV.UK Warning text component
-      #
-      # @param (see CCS::Components::GovUK::FormGroup#initialize)
-      #
-      # @option options [String] :classes additional CSS classes for the form group HTML
-      # @option options  [ActiveModel] :model (nil) model that will be used to find an error message
-      # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+  module FrontendHelpers
+    module GovUKFrontend
+      # = GOV.UK FormGroup
       #
-      # @yield (see CCS::Components::GovUK::FormGroup#render)
-      #
-      # @yieldparam (see CCS::Components::GovUK::FormGroup#render)
-      #
-      # @return (see CCS::Components::GovUK::FormGroup#render)
+      # This helper is used for generating the form group component from the Government Design Systems
+
+      module FormGroup
+        # Generates the HTML for the GOV.UK Warning text component
+        #
+        # @param (see CCS::Components::GovUK::FormGroup#initialize)
+        #
+        # @option options [String] :classes additional CSS classes for the form group HTML
+        # @option options  [ActiveModel] :model (nil) model that will be used to find an error message
+        # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+        #
+        # @yield (see CCS::Components::GovUK::FormGroup#render)
+        #
+        # @yieldparam (see CCS::Components::GovUK::FormGroup#render)
+        #
+        # @return (see CCS::Components::GovUK::FormGroup#render)
 
-      def govuk_form_group(attribute, **options, &block)
-        error_message = if options[:model]
-                          model.errors[attribute].first
-                        else
-                          options[:error_message]
-                        end
+        def govuk_form_group(attribute, **options, &block)
+          error_message = if options[:model]
+                            model.errors[attribute].first
+                          else
+                            options[:error_message]
+                          end
 
-        Components::GovUK::FormGroup.new(context: self, attribute: attribute, error_message: error_message, **options).render(&block)
+          Components::GovUK::FormGroup.new(context: self, attribute: attribute, error_message: error_message, **options).render(&block)
+        end
       end
     end
   end

data/lib/ccs/frontend_helpers/govuk_frontend/header.rb

@@ -3,23 +3,25 @@
 require_relative '../../components/govuk/header'
 
 module CCS
-  module FrontendHelpers::GovUKFrontend
-    # = GOV.UK Header
-    #
-    # This helper is used for generating the header component from the
-    # {https://design-system.service.gov.uk/components/header GDS - Components - Header}
-
-    module Header
-      # Generates the HTML for the GOV.UK Header component
-      #
-      # @param (see CCS::Components::GovUK::Header#initialize)
+  module FrontendHelpers
+    module GovUKFrontend
+      # = GOV.UK Header
       #
-      # @option (see CCS::Components::GovUK::Header#initialize)
-      #
-      # @return (see CCS::Components::GovUK::Header#render)
+      # This helper is used for generating the header component from the
+      # {https://design-system.service.gov.uk/components/header GDS - Components - Header}
+
+      module Header
+        # Generates the HTML for the GOV.UK Header component
+        #
+        # @param (see CCS::Components::GovUK::Header#initialize)
+        #
+        # @option (see CCS::Components::GovUK::Header#initialize)
+        #
+        # @return (see CCS::Components::GovUK::Header#render)
 
-      def govuk_header(**options)
-        Components::GovUK::Header.new(context: self, **options).render
+        def govuk_header(**options)
+          Components::GovUK::Header.new(context: self, **options).render
+        end
       end
     end
   end

data/lib/ccs/frontend_helpers/govuk_frontend/hint.rb

@@ -3,24 +3,26 @@
 require_relative '../../components/govuk/hint'
 
 module CCS
-  module FrontendHelpers::GovUKFrontend
-    # = GOV.UK Hint
-    #
-    # This helper is used for generating the hint text component from the Government Design Systems
-
-    module Hint
-      # Generates the HTML for the GOV.UK Hint component
-      #
-      # @param (see CCS::Components::GovUK::Hint#initialize)
-      #
-      # @option (see CCS::Components::GovUK::Hint#initialize)
+  module FrontendHelpers
+    module GovUKFrontend
+      # = GOV.UK Hint
       #
-      # @yield (see CCS::Components::GovUK::Hint#render)
-      #
-      # @return (see CCS::Components::GovUK::Hint#render)
+      # This helper is used for generating the hint text component from the Government Design Systems
+
+      module Hint
+        # Generates the HTML for the GOV.UK Hint component
+        #
+        # @param (see CCS::Components::GovUK::Hint#initialize)
+        #
+        # @option (see CCS::Components::GovUK::Hint#initialize)
+        #
+        # @yield (see CCS::Components::GovUK::Hint#render)
+        #
+        # @return (see CCS::Components::GovUK::Hint#render)
 
-      def govuk_hint(text = nil, **options, &block)
-        Components::GovUK::Hint.new(context: self, text: text, **options).render(&block)
+        def govuk_hint(text = nil, **options, &block)
+          Components::GovUK::Hint.new(context: self, text: text, **options).render(&block)
+        end
       end
     end
   end

data/lib/ccs/frontend_helpers/govuk_frontend/input.rb

@@ -3,23 +3,25 @@
 require_relative '../../components/govuk/field/input/text_input'
 
 module CCS
-  module FrontendHelpers::GovUKFrontend
-    # = GOV.UK Input
-    #
-    # This helper is used for generating the input component from the
-    # {https://design-system.service.gov.uk/components/text-input GDS - Components - Text Input}
-
-    module Input
-      # Generates the HTML for the GOV.UK Text Input component
-      #
-      # @param (see CCS::Components::GovUK::Input::TextInput#initialize)
+  module FrontendHelpers
+    module GovUKFrontend
+      # = GOV.UK Input
       #
-      # @option (see CCS::Components::GovUK::Input::TextInput#initialize)
-      #
-      # @return (see CCS::Components::GovUK::Input::TextInput#render)
+      # This helper is used for generating the input component from the
+      # {https://design-system.service.gov.uk/components/text-input GDS - Components - Text Input}
+
+      module Input
+        # Generates the HTML for the GOV.UK Text Input component
+        #
+        # @param (see CCS::Components::GovUK::Input::TextInput#initialize)
+        #
+        # @option (see CCS::Components::GovUK::Input::TextInput#initialize)
+        #
+        # @return (see CCS::Components::GovUK::Input::TextInput#render)
 
-      def govuk_input(attribute, **options)
-        Components::GovUK::Field::Input::TextInput.new(context: self, attribute: attribute, **options).render
+        def govuk_input(attribute, **options)
+          Components::GovUK::Field::Input::TextInput.new(context: self, attribute: attribute, **options).render
+        end
       end
     end
   end

data/lib/ccs/frontend_helpers/govuk_frontend/inset_text.rb

@@ -3,25 +3,27 @@
 require_relative '../../components/govuk/inset_text'
 
 module CCS
-  module FrontendHelpers::GovUKFrontend
-    # = GOV.UK Inset Text
-    #
-    # This helper is used for generating the inset text component from the
-    # {https://design-system.service.gov.uk/components/inset-text GDS - Components - Inset text}
-
-    module InsetText
-      # Generates the HTML for the GOV.UK Inset text component
-      #
-      # @param (see CCS::Components::GovUK::InsetText#initialize)
-      #
-      # @option (see CCS::Components::GovUK::InsetText#initialize)
+  module FrontendHelpers
+    module GovUKFrontend
+      # = GOV.UK Inset Text
       #
-      # @yield (see CCS::Components::GovUK::InsetText#render)
-      #
-      # @return (see CCS::Components::GovUK::InsetText#render)
+      # This helper is used for generating the inset text component from the
+      # {https://design-system.service.gov.uk/components/inset-text GDS - Components - Inset text}
+
+      module InsetText
+        # Generates the HTML for the GOV.UK Inset text component
+        #
+        # @param (see CCS::Components::GovUK::InsetText#initialize)
+        #
+        # @option (see CCS::Components::GovUK::InsetText#initialize)
+        #
+        # @yield (see CCS::Components::GovUK::InsetText#render)
+        #
+        # @return (see CCS::Components::GovUK::InsetText#render)
 
-      def govuk_inset_text(text = nil, **options, &block)
-        Components::GovUK::InsetText.new(context: self, text: text, **options).render(&block)
+        def govuk_inset_text(text = nil, **options, &block)
+          Components::GovUK::InsetText.new(context: self, text: text, **options).render(&block)
+        end
       end
     end
   end

data/lib/ccs/frontend_helpers/govuk_frontend/label.rb

@@ -3,24 +3,26 @@
 require_relative '../../components/govuk/label'
 
 module CCS
-  module FrontendHelpers::GovUKFrontend
-    # = GOV.UK label
-    #
-    # This helper is used for generating the label component from the Government Design Systems
-
-    module Label
-      # Generates the HTML for the GOV.UK label component
-      #
-      # @param (see CCS::Components::GovUK::Label#initialize)
-      #
-      # @option (see CCS::Components::GovUK::Label#initialize)
+  module FrontendHelpers
+    module GovUKFrontend
+      # = GOV.UK label
       #
-      # @yield (see CCS::Components::GovUK::Label#render)
-      #
-      # @return (see CCS::Components::GovUK::Label#render)
+      # This helper is used for generating the label component from the Government Design Systems
+
+      module Label
+        # Generates the HTML for the GOV.UK label component
+        #
+        # @param (see CCS::Components::GovUK::Label#initialize)
+        #
+        # @option (see CCS::Components::GovUK::Label#initialize)
+        #
+        # @yield (see CCS::Components::GovUK::Label#render)
+        #
+        # @return (see CCS::Components::GovUK::Label#render)
 
-      def govuk_label(attribute, text = nil, **options, &block)
-        Components::GovUK::Label.new(context: self, attribute: attribute, text: text, **options).render(&block)
+        def govuk_label(attribute, text = nil, **options, &block)
+          Components::GovUK::Label.new(context: self, attribute: attribute, text: text, **options).render(&block)
+        end
       end
     end
   end

data/lib/ccs/frontend_helpers/govuk_frontend/notification_banner.rb

@@ -3,25 +3,27 @@
 require_relative '../../components/govuk/notification_banner'
 
 module CCS
-  module FrontendHelpers::GovUKFrontend
-    # = 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
-      # Generates the HTML for the GOV.UK Notification banner component
-      #
-      # @param (see CCS::Components::GovUK::NotificationBanner#initialize)
-      #
-      # @option (see CCS::Components::GovUK::NotificationBanner#initialize)
+  module FrontendHelpers
+    module GovUKFrontend
+      # = GOV.UK Notification Banner
       #
-      # @yield (see CCS::Components::GovUK::NotificationBanner#render)
-      #
-      # @return (see CCS::Components::GovUK::NotificationBanner#render)
+      # 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
+        # Generates the HTML for the GOV.UK Notification banner component
+        #
+        # @param (see CCS::Components::GovUK::NotificationBanner#initialize)
+        #
+        # @option (see CCS::Components::GovUK::NotificationBanner#initialize)
+        #
+        # @yield (see CCS::Components::GovUK::NotificationBanner#render)
+        #
+        # @return (see CCS::Components::GovUK::NotificationBanner#render)
 
-      def govuk_notification_banner(text = nil, success_banner = nil, **options, &block)
-        Components::GovUK::NotificationBanner.new(context: self, text: text, success_banner: success_banner, **options).render(&block)
+        def govuk_notification_banner(text = nil, success_banner = nil, **options, &block)
+          Components::GovUK::NotificationBanner.new(context: self, text: text, success_banner: success_banner, **options).render(&block)
+        end
       end
     end
   end

data/lib/ccs/frontend_helpers/govuk_frontend/pagination.rb

@@ -3,23 +3,25 @@
 require_relative '../../components/govuk/pagination'
 
 module CCS
-  module FrontendHelpers::GovUKFrontend
-    # = GOV.UK Pagination
-    #
-    # This helper is used for generating the pagination component from the
-    # {https://design-system.service.gov.uk/components/pagination GDS - Components - Pagination}
-
-    module Pagination
-      # Generates the HTML for the GOV.UK Pagination component
-      #
-      # @param (see CCS::Components::GovUK::Pagination#initialize)
+  module FrontendHelpers
+    module GovUKFrontend
+      # = GOV.UK Pagination
       #
-      # @option (see CCS::Components::GovUK::Pagination#initialize)
-      #
-      # @return (see CCS::Components::GovUK::Pagination#render)
+      # This helper is used for generating the pagination component from the
+      # {https://design-system.service.gov.uk/components/pagination GDS - Components - Pagination}
+
+      module Pagination
+        # Generates the HTML for the GOV.UK Pagination component
+        #
+        # @param (see CCS::Components::GovUK::Pagination#initialize)
+        #
+        # @option (see CCS::Components::GovUK::Pagination#initialize)
+        #
+        # @return (see CCS::Components::GovUK::Pagination#render)
 
-      def govuk_pagination(**options)
-        Components::GovUK::Pagination.new(context: self, **options).render
+        def govuk_pagination(**options)
+          Components::GovUK::Pagination.new(context: self, **options).render
+        end
       end
     end
   end