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

data/lib/ccs/components/govuk/warning_text.rb

@@ -1,59 +1,61 @@
 require_relative '../base'
 
-module CCS::Components
-  module GovUK
-    # = GOV.UK Warning text
-    #
-    # This helper is used for generating the warning text component from the
-    # {https://design-system.service.gov.uk/components/warning-text GDS - Components - Warning text}
-    #
-    # @!attribute [r] text
-    #   @return [String] Text for the warning text
-
-    class WarningText < Base
-      private
-
-      attr_reader :text
-
-      public
-
-      # @param text [String] (nil) the text for the warning
-      #                            If nil, then a block will be rendered
-      # @param options [Hash] options that will be used in customising the HTML
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK Warning text
       #
-      # @option options [String] :classes additional CSS classes for the tag HTML
-      # @option options [String] :icon_fallback_text the fallback text for the icon (default: +'Warning'+)
-      # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+      # This helper is used for generating the warning text component from the
+      # {https://design-system.service.gov.uk/components/warning-text GDS - Components - Warning text}
+      #
+      # @!attribute [r] text
+      #   @return [String] Text for the warning text
 
-      def initialize(text: nil, **options)
-        super(**options)
+      class WarningText < Base
+        private
 
-        @text = text
-      end
+        attr_reader :text
 
-      # Generates the HTML for the GOV.UK Warning text component
-      #
-      # @yield HTML that will be used in the warning text. Ignored if text is passed.
-      #
-      # @return [ActiveSupport::SafeBuffer]
-
-      def render
-        tag.div(**options[:attributes]) do
-          concat(tag.span('!', class: 'govuk-warning-text__icon'))
-          concat(tag.strong(class: 'govuk-warning-text__text') do
-            concat(tag.span(options[:icon_fallback_text] || 'Warning', class: 'govuk-warning-text__assistive'))
-            if text
-              concat(text)
-            else
-              yield
-            end
-          end)
+        public
+
+        # @param text [String] (nil) the text for the warning
+        #                            If nil, then a block will be rendered
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option options [String] :classes additional CSS classes for the tag HTML
+        # @option options [String] :icon_fallback_text the fallback text for the icon (default: +'Warning'+)
+        # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+
+        def initialize(text: nil, **options)
+          super(**options)
+
+          @text = text
         end
-      end
 
-      # The default attributes for the warning text
+        # Generates the HTML for the GOV.UK Warning text component
+        #
+        # @yield HTML that will be used in the warning text. Ignored if text is passed.
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.div(**options[:attributes]) do
+            concat(tag.span('!', class: 'govuk-warning-text__icon'))
+            concat(tag.strong(class: 'govuk-warning-text__text') do
+              concat(tag.span(options[:icon_fallback_text] || 'Warning', class: 'govuk-warning-text__assistive'))
+              if text
+                concat(text)
+              else
+                yield
+              end
+            end)
+          end
+        end
 
-      DEFAULT_ATTRIBUTES = { class: 'govuk-warning-text' }.freeze
+        # The default attributes for the warning text
+
+        DEFAULT_ATTRIBUTES = { class: 'govuk-warning-text' }.freeze
+      end
     end
   end
 end

data/lib/ccs/frontend_helpers/ccs_frontend/dashboard_section.rb

@@ -3,22 +3,24 @@
 require_relative '../../components/ccs/dashboard_section'
 
 module CCS
-  module FrontendHelpers::CCSFrontend
-    # = CCS Dashboard Section
-    #
-    # This helper is used for generating the dashboard section component
-
-    module DashboardSection
-      # Generates the HTML for the CCS Dashboard Section component
-      #
-      # @param (see CCS::Components::CCS::DashboardSection#initialize)
+  module FrontendHelpers
+    module CCSFrontend
+      # = CCS Dashboard Section
       #
-      # @option (see CCS::Components::CCS::DashboardSection#initialize)
-      #
-      # @return (see CCS::Components::CCS::DashboardSection#render)
+      # This helper is used for generating the dashboard section component
+
+      module DashboardSection
+        # Generates the HTML for the CCS Dashboard Section component
+        #
+        # @param (see CCS::Components::CCS::DashboardSection#initialize)
+        #
+        # @option (see CCS::Components::CCS::DashboardSection#initialize)
+        #
+        # @return (see CCS::Components::CCS::DashboardSection#render)
 
-      def ccs_dashboard_section(dashboard_section_panels, title_text = nil, **options)
-        Components::CCS::DashboardSection.new(context: self, dashboard_section_panels: dashboard_section_panels, title_text: title_text, **options).render
+        def ccs_dashboard_section(dashboard_section_panels, title_text = nil, **options)
+          Components::CCS::DashboardSection.new(context: self, dashboard_section_panels: dashboard_section_panels, title_text: title_text, **options).render
+        end
       end
     end
   end

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

@@ -3,23 +3,25 @@
 require_relative '../../components/ccs/footer'
 
 module CCS
-  module FrontendHelpers::CCSFrontend
-    # = CCS Footer
-    #
-    # This helper is used for generating the footer component from the
-    # {https://github.com/tim-s-ccs/ts-ccs-frontend/tree/main/src/ccs/components/footer CCS - Components - Footer}
-
-    module Footer
-      # Generates the HTML for the CCS Footer component
-      #
-      # @param (see CCS::Components::CCS::Footer#initialize)
+  module FrontendHelpers
+    module CCSFrontend
+      # = CCS Footer
       #
-      # @option (see CCS::Components::CCS::Footer#initialize)
-      #
-      # @return (see CCS::Components::CCS::Footer#render)
+      # This helper is used for generating the footer component from the
+      # {https://github.com/tim-s-ccs/ts-ccs-frontend/tree/main/src/ccs/components/footer CCS - Components - Footer}
+
+      module Footer
+        # Generates the HTML for the CCS Footer component
+        #
+        # @param (see CCS::Components::CCS::Footer#initialize)
+        #
+        # @option (see CCS::Components::CCS::Footer#initialize)
+        #
+        # @return (see CCS::Components::CCS::Footer#render)
 
-      def ccs_footer(**options)
-        Components::CCS::Footer.new(context: self, **options).render
+        def ccs_footer(**options)
+          Components::CCS::Footer.new(context: self, **options).render
+        end
       end
     end
   end

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

@@ -3,23 +3,25 @@
 require_relative '../../components/ccs/header'
 
 module CCS
-  module FrontendHelpers::CCSFrontend
-    # = CCS Header
-    #
-    # This helper is used for generating the header component from the
-    # {https://github.com/tim-s-ccs/ts-ccs-frontend/tree/main/src/ccs/components/header CCS - Components - Header}
-
-    module Header
-      # Generates the HTML for the CCS Header component
-      #
-      # @param (see CCS::Components::CCS::Header#initialize)
+  module FrontendHelpers
+    module CCSFrontend
+      # = CCS Header
       #
-      # @option (see CCS::Components::CCS::Header#initialize)
-      #
-      # @return (see CCS::Components::CCS::Header#render)
+      # This helper is used for generating the header component from the
+      # {https://github.com/tim-s-ccs/ts-ccs-frontend/tree/main/src/ccs/components/header CCS - Components - Header}
+
+      module Header
+        # Generates the HTML for the CCS Header component
+        #
+        # @param (see CCS::Components::CCS::Header#initialize)
+        #
+        # @option (see CCS::Components::CCS::Header#initialize)
+        #
+        # @return (see CCS::Components::CCS::Header#render)
 
-      def ccs_header(**options)
-        Components::CCS::Header.new(context: self, **options).render
+        def ccs_header(**options)
+          Components::CCS::Header.new(context: self, **options).render
+        end
       end
     end
   end

data/lib/ccs/frontend_helpers/ccs_frontend.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
+require_relative 'ccs_frontend/dashboard_section'
 require_relative 'ccs_frontend/footer'
 require_relative 'ccs_frontend/header'
-require_relative 'ccs_frontend/dashboard_section'
 
 module CCS
   module FrontendHelpers

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

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

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

@@ -3,23 +3,25 @@
 require_relative '../../components/govuk/back_link'
 
 module CCS
-  module FrontendHelpers::GovUKFrontend
-    # = 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
-      # Generates the HTML for the GOV.UK Back link component
-      #
-      # @param (see CCS::Components::GovUK::BackLink#initialize)
+  module FrontendHelpers
+    module GovUKFrontend
+      # = GOV.UK Back Link
       #
-      # @option (see CCS::Components::GovUK::BackLink#initialize)
-      #
-      # @return (see CCS::Components::GovUK::BackLink#render)
+      # 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
+        # Generates the HTML for the GOV.UK Back link component
+        #
+        # @param (see CCS::Components::GovUK::BackLink#initialize)
+        #
+        # @option (see CCS::Components::GovUK::BackLink#initialize)
+        #
+        # @return (see CCS::Components::GovUK::BackLink#render)
 
-      def govuk_back_link(text, href, **options)
-        Components::GovUK::BackLink.new(context: self, text: text, href: href, **options).render
+        def govuk_back_link(text, href, **options)
+          Components::GovUK::BackLink.new(context: self, text: text, href: href, **options).render
+        end
       end
     end
   end

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

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

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

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

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

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

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

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

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

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

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

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

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

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