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

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

@@ -1,105 +1,107 @@
 require_relative '../base'
 
-module CCS::Components
-  module GovUK
-    # = 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}
-    #
-    # @!attribute [r] text
-    #   @return [String] Text for the notification banner
-    # @!attribute [r] success_banner
-    #   @return [Boolean] Indicates if this is a success banner
-
-    class NotificationBanner < Base
-      private
-
-      attr_reader :text, :success_banner
-
-      public
-
-      # @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 options [Hash] options that will be used in customising the HTML
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK Notification Banner
       #
-      # @option options [String] :classes additional CSS classes for the notification banner HTML
-      # @option options [String] :title_text ('Important') the title text shown at the top of the banner
-      # @option options [String] :title_id ('govuk-notification-banner-title') the ID for the title text
-      # @option options [String] :role ('region') the role for the banner
-      # @option options [String] :heading_level (2) the heading level for the title text
-      # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+      # 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}
+      #
+      # @!attribute [r] text
+      #   @return [String] Text for the notification banner
+      # @!attribute [r] success_banner
+      #   @return [Boolean] Indicates if this is a success banner
 
-      def initialize(text: nil, success_banner: nil, **options)
-        super(**options)
+      class NotificationBanner < Base
+        private
 
-        @text = text
-        @success_banner = success_banner || false
+        attr_reader :text, :success_banner
 
-        set_additional_options_for_banner
-      end
+        public
 
-      # Generates the HTML for the GOV.UK Notification banner component
-      #
-      # @yield HTML that will be contained within the 'govuk-notification-banner__content' div
-      #
-      # @return [ActiveSupport::SafeBuffer]
-
-      def render
-        tag.div(**options[:attributes]) do
-          concat(tag.div(class: 'govuk-notification-banner__header') do
-            tag.send(:"h#{options[:heading_level] || 2}", options[:title_text], class: 'govuk-notification-banner__title', id: 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)
+        # @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 options [Hash] options that will be used in customising the HTML
+        #
+        # @option options [String] :classes additional CSS classes for the notification banner HTML
+        # @option options [String] :title_text ('Important') the title text shown at the top of the banner
+        # @option options [String] :title_id ('govuk-notification-banner-title') the ID for the title text
+        # @option options [String] :role ('region') the role for the banner
+        # @option options [String] :heading_level (2) the heading level for the title text
+        # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+
+        def initialize(text: nil, success_banner: nil, **options)
+          super(**options)
+
+          @text = text
+          @success_banner = success_banner || false
+
+          set_additional_options_for_banner
         end
-      end
 
-      # The default attributes for the notifaction banner
+        # Generates the HTML for the GOV.UK Notification banner component
+        #
+        # @yield HTML that will be contained within the 'govuk-notification-banner__content' div
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.div(**options[:attributes]) do
+            concat(tag.div(class: 'govuk-notification-banner__header') do
+              tag.send(:"h#{options[:heading_level] || 2}", options[:title_text], class: 'govuk-notification-banner__title', id: 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
 
-      DEFAULT_ATTRIBUTES = { class: 'govuk-notification-banner', data: { module: 'govuk-notification-banner' } }.freeze
+        # The default attributes for the notifaction banner
 
-      # Default options used in normal versions of the notification banner
+        DEFAULT_ATTRIBUTES = { class: 'govuk-notification-banner', data: { module: 'govuk-notification-banner' } }.freeze
 
-      DEFAULT_OPTIONS = {
-        title_text: 'Important',
-        title_id: 'govuk-notification-banner-title',
-        role: 'region'
-      }.freeze
+        # Default options used in normal versions of the notification banner
 
-      # Specific options for the success version of the notification banner
+        DEFAULT_OPTIONS = {
+          title_text: 'Important',
+          title_id: 'govuk-notification-banner-title',
+          role: 'region'
+        }.freeze
 
-      SUCCESS_BANNER_OPTIONS = {
-        classes: ' govuk-notification-banner--success',
-        title_text: 'Success',
-        role: 'alert'
-      }.freeze
+        # Specific options for the success version of the notification banner
 
-      private
+        SUCCESS_BANNER_OPTIONS = {
+          classes: ' govuk-notification-banner--success',
+          title_text: 'Success',
+          role: 'alert'
+        }.freeze
 
-      # rubocop:disable Metrics/AbcSize
+        private
 
-      # Determines the banner options to be used for the notification banner
+        # rubocop:disable Metrics/AbcSize
 
-      def set_additional_options_for_banner
-        banner_options = DEFAULT_OPTIONS.dup
+        # Determines the banner options to be used for the notification banner
 
-        banner_options.merge!(SUCCESS_BANNER_OPTIONS) if success_banner
+        def set_additional_options_for_banner
+          banner_options = DEFAULT_OPTIONS.dup
 
-        options[:title_text] ||= banner_options[:title_text]
-        options[:title_id] ||= banner_options[:title_id]
-        options[:attributes][:role] ||= banner_options[:role]
-        options[:attributes][:class] << banner_options[:classes].to_s
-        (options[:attributes][:aria] ||= {})[:labelledby] = options[:title_id]
-      end
+          banner_options.merge!(SUCCESS_BANNER_OPTIONS) if success_banner
 
-      # rubocop:enable Metrics/AbcSize
+          options[:title_text] ||= banner_options[:title_text]
+          options[:title_id] ||= banner_options[:title_id]
+          options[:attributes][:role] ||= banner_options[:role]
+          options[:attributes][:class] << banner_options[:classes].to_s
+          (options[:attributes][:aria] ||= {})[:labelledby] = options[:title_id]
+        end
+
+        # rubocop:enable Metrics/AbcSize
+      end
     end
   end
 end

data/lib/ccs/components/govuk/pagination/increment/next.rb

@@ -1,40 +1,42 @@
 require_relative '../increment'
 
-module CCS::Components
-  module GovUK
-    class Pagination < Base
-      class Increment < Base
-        # = GOV.UK Pagination Next
-        #
-        # This generates the HTML for the pagination next link
-
-        class Next < Increment
-          # @param (see Increment#initialize)
+module CCS
+  module Components
+    module GovUK
+      class Pagination < Base
+        class Increment < Base
+          # = GOV.UK Pagination Next
           #
-          # @option (see Increment#initialize)
+          # This generates the HTML for the pagination next link
 
-          def initialize(text: 'Next', **options)
-            super(type: :next, text: text, **options)
-          end
+          class Next < Increment
+            # @param (see Increment#initialize)
+            #
+            # @option (see Increment#initialize)
 
-          # Generates the HTML for the next link in the pagination
-          #
-          # @return [ActiveSupport::SafeBuffer]
+            def initialize(text: 'Next', **options)
+              super(type: :next, text: text, **options)
+            end
 
-          def render
-            tag.div(class: 'govuk-pagination__next') do
-              super() do
-                concat(pagination_icon) if block_is_level
-                concat(tag.span(text, class: pagination_text_classes))
-                pagination_icon_label_text
-                concat(pagination_icon) unless block_is_level
+            # Generates the HTML for the next link in the pagination
+            #
+            # @return [ActiveSupport::SafeBuffer]
+
+            def render
+              tag.div(class: 'govuk-pagination__next') do
+                super() do
+                  concat(pagination_icon) if block_is_level
+                  concat(tag.span(text, class: pagination_text_classes))
+                  pagination_icon_label_text
+                  concat(pagination_icon) unless block_is_level
+                end
               end
             end
-          end
 
-          # The path for the pagination next icon
+            # The path for the pagination next icon
 
-          PAGINATION_ICON_PATH = 'm8.107-0.0078125-1.4136 1.414 4.2926 4.293h-12.986v2h12.896l-4.1855 3.9766 1.377 1.4492 6.7441-6.4062-6.7246-6.7266z'.freeze
+            PAGINATION_ICON_PATH = 'm8.107-0.0078125-1.4136 1.414 4.2926 4.293h-12.986v2h12.896l-4.1855 3.9766 1.377 1.4492 6.7441-6.4062-6.7246-6.7266z'.freeze
+          end
         end
       end
     end

data/lib/ccs/components/govuk/pagination/increment/previous.rb

@@ -1,39 +1,41 @@
 require_relative '../increment'
 
-module CCS::Components
-  module GovUK
-    class Pagination < Base
-      class Increment < Base
-        # = GOV.UK Pagination Previous
-        #
-        # This generates the HTML for the pagination previous link
-
-        class Previous < Increment
-          # @param (see Increment#initialize)
+module CCS
+  module Components
+    module GovUK
+      class Pagination < Base
+        class Increment < Base
+          # = GOV.UK Pagination Previous
           #
-          # @option (see Increment#initialize)
+          # This generates the HTML for the pagination previous link
 
-          def initialize(text: 'Previous', **options)
-            super(type: :prev, text: text, **options)
-          end
+          class Previous < Increment
+            # @param (see Increment#initialize)
+            #
+            # @option (see Increment#initialize)
 
-          # Generates the HTML for the previous link in the pagination
-          #
-          # @return [ActiveSupport::SafeBuffer]
+            def initialize(text: 'Previous', **options)
+              super(type: :prev, text: text, **options)
+            end
 
-          def render
-            tag.div(class: 'govuk-pagination__prev') do
-              super() do
-                concat(pagination_icon)
-                concat(tag.span(text, class: pagination_text_classes))
-                pagination_icon_label_text
+            # Generates the HTML for the previous link in the pagination
+            #
+            # @return [ActiveSupport::SafeBuffer]
+
+            def render
+              tag.div(class: 'govuk-pagination__prev') do
+                super() do
+                  concat(pagination_icon)
+                  concat(tag.span(text, class: pagination_text_classes))
+                  pagination_icon_label_text
+                end
               end
             end
-          end
 
-          # The path for the pagination previous icon
+            # The path for the pagination previous icon
 
-          PAGINATION_ICON_PATH = 'm6.5938-0.0078125-6.7266 6.7266 6.7441 6.4062 1.377-1.449-4.1856-3.9768h12.896v-2h-12.984l4.2931-4.293-1.414-1.414z'.freeze
+            PAGINATION_ICON_PATH = 'm6.5938-0.0078125-6.7266 6.7266 6.7441 6.4062 1.377-1.449-4.1856-3.9768h12.896v-2h-12.984l4.2931-4.293-1.414-1.414z'.freeze
+          end
         end
       end
     end

data/lib/ccs/components/govuk/pagination/increment.rb

@@ -1,94 +1,96 @@
 require_relative '../../base'
 
-module CCS::Components
-  module GovUK
-    class Pagination < Base
-      # = GOV.UK Pagination Increment
-      #
-      # This generates the HTML for a  pagination increment, that is {Previous} and {Next}
-      #
-      # @!attribute [r] type
-      #   @return [Symbol] The type of pagination increment
-      # @!attribute [r] text
-      #   @return [String] Text for the pagination increment
-      # @!attribute [r] block_is_level
-      #   @return [Boolean] Flag to indicate if previous and next blocks are level
-      # @!attribute [r] label_text
-      #   @return [Boolean] Additional label text for when +block_is_level == true+
-
-      class Increment < Base
-        private
-
-        attr_reader :type, :text, :block_is_level, :label_text
-
-        public
-
-        # @param type [Symbol] the type of increment, either +:prev+ or +:next+
-        # @param text [String] the text for the pagination increment
-        # @param block_is_level [Boolean] when there are no items, this will be true and will add extra classes
-        #                                 to the link to make the next and previous pagination links level
-        # @param label_text [String] additional text for the link when the pagination block is level
-        # @param options [Hash] options that will be used in customising the HTML
+module CCS
+  module Components
+    module GovUK
+      class Pagination < Base
+        # = GOV.UK Pagination Increment
         #
-        # @option options [String] :href the URL for the link
-        # @option options  [ActionView::Helpers::FormBuilder] :form optional form builder used to create the button
-        # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
-
-        def initialize(type:, text:, block_is_level:, label_text: nil, **options)
-          super(**options)
-
-          @options[:attributes][:class] = "govuk-link govuk-pagination__link #{'pagination--button_as_link' if @options[:form]}".rstrip
-          @options[:attributes][:rel] = type.to_s
-
-          @type = type
-          @text = text
-          @block_is_level = block_is_level
-          @label_text = label_text
-        end
-
-        # Generates the HTML for the pagination increment link/button
-        #
-        # @yield the HTML for the increment button/link
+        # This generates the HTML for a  pagination increment, that is {Previous} and {Next}
         #
-        # @return [ActiveSupport::SafeBuffer]
+        # @!attribute [r] type
+        #   @return [Symbol] The type of pagination increment
+        # @!attribute [r] text
+        #   @return [String] Text for the pagination increment
+        # @!attribute [r] block_is_level
+        #   @return [Boolean] Flag to indicate if previous and next blocks are level
+        # @!attribute [r] label_text
+        #   @return [Boolean] Additional label text for when +block_is_level == true+
+
+        class Increment < Base
+          private
+
+          attr_reader :type, :text, :block_is_level, :label_text
+
+          public
+
+          # @param type [Symbol] the type of increment, either +:prev+ or +:next+
+          # @param text [String] the text for the pagination increment
+          # @param block_is_level [Boolean] when there are no items, this will be true and will add extra classes
+          #                                 to the link to make the next and previous pagination links level
+          # @param label_text [String] additional text for the link when the pagination block is level
+          # @param options [Hash] options that will be used in customising the HTML
+          #
+          # @option options [String] :href the URL for the link
+          # @option options  [ActionView::Helpers::FormBuilder] :form optional form builder used to create the button
+          # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+
+          def initialize(type:, text:, block_is_level:, label_text: nil, **options)
+            super(**options)
+
+            @options[:attributes][:class] = "govuk-link govuk-pagination__link #{'pagination--button_as_link' if @options[:form]}".rstrip
+            @options[:attributes][:rel] = type.to_s
+
+            @type = type
+            @text = text
+            @block_is_level = block_is_level
+            @label_text = label_text
+          end
 
-        def render(&block)
-          if options[:form]
-            options[:form].button(**options[:attributes], &block)
-          else
-            link_to(options[:href], **options[:attributes], &block)
+          # Generates the HTML for the pagination increment link/button
+          #
+          # @yield the HTML for the increment button/link
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render(&block)
+            if options[:form]
+              options[:form].button(**options[:attributes], &block)
+            else
+              link_to(options[:href], **options[:attributes], &block)
+            end
           end
-        end
 
-        private
+          private
 
-        # Returns the classes for the link/button label
-        #
-        # @return [String]
+          # Returns the classes for the link/button label
+          #
+          # @return [String]
 
-        def pagination_text_classes
-          "govuk-pagination__link-title #{'govuk-pagination__link-title--decorated' if block_is_level && !label_text}".rstrip
-        end
+          def pagination_text_classes
+            "govuk-pagination__link-title #{'govuk-pagination__link-title--decorated' if block_is_level && !label_text}".rstrip
+          end
 
-        # Generates the icon for the pagination increment
-        #
-        # @return [ActiveSupport::SafeBuffer]
+          # Generates the icon for the pagination increment
+          #
+          # @return [ActiveSupport::SafeBuffer]
 
-        def pagination_icon
-          tag.svg(class: "govuk-pagination__icon govuk-pagination__icon--#{type}", xmlns: 'http://www.w3.org/2000/svg', height: '13', width: '15', aria: { hidden: 'true' }, focusable: 'false', viewBox: '0 0 15 13') do
-            tag.path(d: self.class::PAGINATION_ICON_PATH)
+          def pagination_icon
+            tag.svg(class: "govuk-pagination__icon govuk-pagination__icon--#{type}", xmlns: 'http://www.w3.org/2000/svg', height: '13', width: '15', aria: { hidden: 'true' }, focusable: 'false', viewBox: '0 0 15 13') do
+              tag.path(d: self.class::PAGINATION_ICON_PATH)
+            end
           end
-        end
 
-        # Generates the label text for when the block is level
-        #
-        # @return [ActiveSupport::SafeBuffer]
+          # Generates the label text for when the block is level
+          #
+          # @return [ActiveSupport::SafeBuffer]
 
-        def pagination_icon_label_text
-          return unless block_is_level && label_text
+          def pagination_icon_label_text
+            return unless block_is_level && label_text
 
-          concat(tag.span(':', class: 'govuk-visually-hidden'))
-          concat(tag.span(label_text, class: 'govuk-pagination__link-label'))
+            concat(tag.span(':', class: 'govuk-visually-hidden'))
+            concat(tag.span(label_text, class: 'govuk-pagination__link-label'))
+          end
         end
       end
     end

data/lib/ccs/components/govuk/pagination/item/ellipsis.rb

@@ -1,23 +1,25 @@
 require 'action_view'
 
-module CCS::Components
-  module GovUK
-    class Pagination < Base
-      class Item < Base
-        # = GOV.UK Pagination Item ellipsis
-        #
-        # This generates the HTML for a  pagination ellipsis
+module CCS
+  module Components
+    module GovUK
+      class Pagination < Base
+        class Item < Base
+          # = GOV.UK Pagination Item ellipsis
+          #
+          # This generates the HTML for a  pagination ellipsis
 
-        class Ellipsis
-          extend ActionView::Context
-          extend ActionView::Helpers
+          class Ellipsis
+            extend ActionView::Context
+            extend ActionView::Helpers
 
-          # Generates the HTML for the GOV.UK Pagination Item ellipsis
-          #
-          # @return [ActiveSupport::SafeBuffer]
+            # Generates the HTML for the GOV.UK Pagination Item ellipsis
+            #
+            # @return [ActiveSupport::SafeBuffer]
 
-          def self.render
-            tag.li('⋯', class: 'govuk-pagination__item govuk-pagination__item--ellipses')
+            def self.render
+              tag.li('⋯', class: 'govuk-pagination__item govuk-pagination__item--ellipses')
+            end
           end
         end
       end

data/lib/ccs/components/govuk/pagination/item/form.rb

@@ -1,43 +1,45 @@
 require_relative '../item'
 
-module CCS::Components
-  module GovUK
-    class Pagination < Base
-      class Item < Base
-        # = GOV.UK Pagination Item form
-        #
-        # This generates the HTML for the pagination item using a button tag
-        #
-        # @!attribute [r] form
-        #   @return [ActionView::Helpers::FormBuilder] Form builder used to create the button
-
-        class Form < Item
-          private
-
-          attr_reader :form
-
-          public
-
-          # @param (see CCS::Components::GovUK::Pagination::Item)
-          # @param form [ActionView::Helpers::FormBuilder] form builder used to create the button
+module CCS
+  module Components
+    module GovUK
+      class Pagination < Base
+        class Item < Base
+          # = GOV.UK Pagination Item form
           #
-          # @option (see CCS::Components::GovUK::Pagination::Item)
+          # This generates the HTML for the pagination item using a button tag
+          #
+          # @!attribute [r] form
+          #   @return [ActionView::Helpers::FormBuilder] Form builder used to create the button
 
-          def initialize(form:, **options)
-            super(**options)
+          class Form < Item
+            private
 
-            @options[:attributes][:class] << ' pagination-number--button_as_link'
+            attr_reader :form
 
-            @form = form
-          end
+            public
 
-          # Generates the HTML for the GOV.UK Pagination item button
-          #
-          # @return [ActiveSupport::SafeBuffer]
+            # @param (see CCS::Components::GovUK::Pagination::Item)
+            # @param form [ActionView::Helpers::FormBuilder] form builder used to create the button
+            #
+            # @option (see CCS::Components::GovUK::Pagination::Item)
+
+            def initialize(form:, **options)
+              super(**options)
+
+              @options[:attributes][:class] << ' pagination-number--button_as_link'
+
+              @form = form
+            end
+
+            # Generates the HTML for the GOV.UK Pagination item button
+            #
+            # @return [ActiveSupport::SafeBuffer]
 
-          def render
-            super() do
-              form.button(number, **@options[:attributes])
+            def render
+              super() do
+                form.button(number, **@options[:attributes])
+              end
             end
           end
         end