ccs-frontend_helpers 0.1.0 → 0.1.1.rc.1

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

@@ -0,0 +1,107 @@
+require_relative '../base'
+
+module CCS
+  module 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
+        #
+        # @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
+
+        # 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
+
+        # The default attributes for the notifaction banner
+
+        DEFAULT_ATTRIBUTES = { class: 'govuk-notification-banner', data: { module: 'govuk-notification-banner' } }.freeze
+
+        # Default options used in normal versions of the notification banner
+
+        DEFAULT_OPTIONS = {
+          title_text: 'Important',
+          title_id: 'govuk-notification-banner-title',
+          role: 'region'
+        }.freeze
+
+        # Specific options for the success version of the notification banner
+
+        SUCCESS_BANNER_OPTIONS = {
+          classes: ' govuk-notification-banner--success',
+          title_text: 'Success',
+          role: 'alert'
+        }.freeze
+
+        private
+
+        # rubocop:disable Metrics/AbcSize
+
+        # Determines the banner options to be used for the notification banner
+
+        def set_additional_options_for_banner
+          banner_options = DEFAULT_OPTIONS.dup
+
+          banner_options.merge!(SUCCESS_BANNER_OPTIONS) if success_banner
+
+          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

@@ -0,0 +1,44 @@
+require_relative '../increment'
+
+module CCS
+  module 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)
+            #
+            # @option (see Increment#initialize)
+
+            def initialize(text: 'Next', **options)
+              super(type: :next, text: text, **options)
+            end
+
+            # 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
+
+            # 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
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+require_relative '../increment'
+
+module CCS
+  module 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)
+            #
+            # @option (see Increment#initialize)
+
+            def initialize(text: 'Previous', **options)
+              super(type: :prev, text: text, **options)
+            end
+
+            # 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
+
+            # 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
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,98 @@
+require_relative '../../base'
+
+module CCS
+  module 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
+          #
+          # @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
+          #
+          # @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
+
+          private
+
+          # 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
+
+          # 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)
+            end
+          end
+
+          # 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
+
+            concat(tag.span(':', class: 'govuk-visually-hidden'))
+            concat(tag.span(label_text, class: 'govuk-pagination__link-label'))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+require 'action_view'
+
+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
+
+            # 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')
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+require_relative '../item'
+
+module CCS
+  module 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
+            #
+            # @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])
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+require_relative '../item'
+
+module CCS
+  module Components
+    module GovUK
+      class Pagination < Base
+        class Item < Base
+          # = GOV.UK Pagination Item tag
+          #
+          # This generates the HTML for the pagination item using a link tag
+          #
+          # @!attribute [r] href
+          #   @return [String] URL for the pagination item
+
+          class Tag < Item
+            private
+
+            attr_reader :href
+
+            public
+
+            # @param (see CCS::Components::GovUK::Pagination::Item)
+            # @param href [String] the URL for the pagination item
+            #
+            # @option (see CCS::Components::GovUK::Pagination::Item)
+
+            def initialize(href:, **options)
+              super(**options)
+
+              @href = href
+            end
+
+            # Generates the HTML for the GOV.UK Pagination item link
+            #
+            # @return [ActiveSupport::SafeBuffer]
+
+            def render
+              super() do
+                link_to(number, href, **@options[:attributes])
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+require_relative '../../base'
+
+module CCS
+  module Components
+    module GovUK
+      class Pagination < Base
+        # = GOV.UK Pagination Item
+        #
+        # This generates the HTML for the pagination item
+        #
+        # @!attribute [r] number
+        #   @return [String] The number for the item
+        # @!attribute [r] li_classes
+        #   @return [String] HTML classes for pagination item +li+ element
+
+        class Item < Base
+          private
+
+          attr_reader :number, :li_classes
+
+          public
+
+          # @param number [String] the number for the item
+          # @param current [Boolean] flag to indicate if this item is the current page
+          #
+          # @option options [String] :classes additional CSS classes for the item HTML
+          # @option options [Symbol] :type the type of item. If the value is +:ellipsis+ then an ellipsis will be rendered
+          # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+
+          def initialize(number:, current: false, **options)
+            super(**options)
+
+            @number = number
+
+            (@options[:attributes][:aria] ||= {})[:label] ||= "Page #{@number}"
+
+            li_classes = 'govuk-pagination__item'
+
+            if current
+              li_classes << ' govuk-pagination__item--current'
+              @options[:attributes][:aria][:current] = 'page'
+            end
+
+            @li_classes = li_classes
+          end
+
+          # Generates the HTML for the GOV.UK Pagination item
+          #
+          # @yield the HTML for the pagination item link/button
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render(&block)
+            tag.li(class: li_classes, &block)
+          end
+
+          # The default attributes for the pagination link
+
+          DEFAULT_ATTRIBUTES = { class: 'govuk-link govuk-pagination__link' }.freeze
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,96 @@
+require_relative '../base'
+require_relative 'pagination/increment/previous'
+require_relative 'pagination/increment/next'
+require_relative 'pagination/item/ellipsis'
+require_relative 'pagination/item/tag'
+require_relative 'pagination/item/form'
+
+module CCS
+  module Components
+    module GovUK
+      # = 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}
+      #
+      # @!attribute [r] pagination_previous
+      #   @return [Increment::Previous] Initialised pagination previous
+      # @!attribute [r] pagination_items
+      #   @return [Array<Item::Ellipsis|Item::Tag|Item::Form>] An array of the initialised pagination items
+      # @!attribute [r] pagination_next
+      #   @return [Increment::Next] Initialised pagination next
+
+      class Pagination < Base
+        private
+
+        attr_reader :pagination_previous, :pagination_items, :pagination_next
+
+        public
+
+        # rubocop:disable Metrics/CyclomaticComplexity
+
+        # @param pagination_previous [Hash] attributes for the pagination previous, see {CCS::Components::GovUK::Pagination::Increment::Previous#initialize Previous#initialize} for more details.
+        # @param pagination_items [Array<Hash>] An array of options for the pagination items.
+        #                                       See {CCS::Components::GovUK::Pagination::Item::Tag#initialize Item::Tag#initialize} and
+        #                                       {CCS::Components::GovUK::Pagination::Item::Form#initialize Item::Form#initialize} for details of the items in the array.
+        # @param pagination_next [Hash] attributes for the pagination next, see {CCS::Components::GovUK::Pagination::Increment::Next#initialize Next#initialize} for more details.
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option options [String] :classes additional CSS classes for the pagination HTML
+        # @option options [ActionView::Helpers::FormBuilder] :form form builder used to create pagination buttons
+        # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+
+        def initialize(pagination_previous: nil, pagination_items: nil, pagination_next: nil, **options)
+          super(**options)
+
+          block_is_level = pagination_items.blank? && (pagination_previous.present? || pagination_next.present?)
+
+          @options[:attributes][:class] << ' govuk-pagination--block' if block_is_level
+          @options[:attributes][:role] = 'navigation'
+          (@options[:attributes][:aria] ||= {})[:label] ||= 'results'
+
+          @pagination_previous = Increment::Previous.new(block_is_level: block_is_level, form: @options[:form], context: @context, **pagination_previous) if pagination_previous
+          @pagination_next = Increment::Next.new(block_is_level: block_is_level, form: @options[:form], context: @context, **pagination_next) if pagination_next
+          initialize_pagination_items(pagination_items, @options[:form])
+        end
+
+        # rubocop:enable Metrics/CyclomaticComplexity
+
+        # Generates the HTML for the GOV.UK pagination component
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.nav(**options[:attributes]) do
+            concat(pagination_previous.render) if pagination_previous
+            if pagination_items
+              concat(tag.ul(class: 'govuk-pagination__list') do
+                pagination_items.each { |pagination_item| concat(pagination_item.render) }
+              end)
+            end
+            concat(pagination_next.render) if pagination_next
+          end
+        end
+
+        # The default attributes for the pagination
+
+        DEFAULT_ATTRIBUTES = { class: 'govuk-pagination' }.freeze
+
+        private
+
+        # Initialises the pagination items
+        #
+        # @param pagination_items [Array<Hash>] An array of options for the pagination items
+        # @param form [ActionView::Helpers::FormBuilder] form builder used to create pagination buttons
+
+        def initialize_pagination_items(pagination_items, form)
+          return unless pagination_items
+
+          pagination_item_class = form ? Item::Form : Item::Tag
+
+          @pagination_items = pagination_items.map { |pagination_item| pagination_item[:type] == :ellipsis ? Item::Ellipsis : pagination_item_class.new(form: form, context: context, **pagination_item) }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+require_relative '../base'
+
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK Panel
+      #
+      # This is used to generate the panel component from the
+      # {https://design-system.service.gov.uk/components/panel GDS - Components - Panel}
+      #
+      # @!attribute [r] title_text
+      #   @return [String] Text for the panel title
+      # @!attribute [r] panel_text
+      #   @return [String] Text that will be used for the panel content
+
+      class Panel < Base
+        private
+
+        attr_reader :title_text, :panel_text
+
+        public
+
+        # @param title_text [String] title text for the panel which will be contained in haeding tags
+        # @param panel_text [String] text to use within the panel component.
+        #                            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 panel HTML
+        # @option options [Integer,String] :heading_level (default: 1) heading level for the panel title text
+        # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+
+        def initialize(title_text:, panel_text: nil, **options)
+          super(**options)
+
+          @title_text = title_text
+          @panel_text = panel_text
+        end
+
+        # Generates the HTML for the GOV.UK Panel component
+        #
+        # @yield HTML that will be contained within the panel body. Ignored if panel text is given
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.div(**options[:attributes]) do
+            concat(tag.send(:"h#{options[:heading_level] || 1}", title_text, class: 'govuk-panel__title'))
+            if panel_text || block_given?
+              concat(tag.div(class: 'govuk-panel__body') do
+                panel_text || yield
+              end)
+            end
+          end
+        end
+
+        # The default attributes for the panel
+
+        DEFAULT_ATTRIBUTES = { class: 'govuk-panel govuk-panel--confirmation' }.freeze
+      end
+    end
+  end
+end