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

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

@@ -0,0 +1,47 @@
+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
+          #
+          # @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

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

@@ -0,0 +1,45 @@
+require_relative '../item'
+
+module CCS::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

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

@@ -0,0 +1,62 @@
+require_relative '../../base'
+
+module CCS::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

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

@@ -0,0 +1,94 @@
+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::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

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

@@ -0,0 +1,60 @@
+require_relative '../base'
+
+module CCS::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

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

@@ -0,0 +1,67 @@
+require_relative '../base'
+require_relative 'tag'
+
+module CCS::Components
+  module GovUK
+    # = GOV.UK Phase banner
+    #
+    # This is used to generate the phase banner component from the
+    # {https://design-system.service.gov.uk/components/phase-banner GDS - Components - Phase banner}
+    #
+    # @!attribute [r] text
+    #   @return [String] Text for the phase banner
+    # @!attribute [r] tag_options
+    #   @return [Hash] Options for the phase banner tag
+
+    class PhaseBanner < Base
+      private
+
+      attr_reader :text, :tag_options
+
+      public
+
+      # @param tag_options [Hash] paramters for the govuk tag (see {Components::GovUK::Tag Tag}).
+      #                           options are:
+      #                           - +text+
+      #                           - +colour+
+      #                           - +options+
+      # @param text [String] the text for the phase banner.
+      #                      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 phase banner HTML
+      # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+
+      def initialize(tag_options:, text: nil, **options)
+        super(**options)
+
+        tag_options[:classes] = "govuk-phase-banner__content__tag #{tag_options[:classes]}".rstrip
+        tag_options[:context] = @context
+
+        @text = text
+        @tag_options = tag_options
+      end
+
+      # Generates the HTML for the GOV.UK Phase banner component
+      #
+      # @yield HTML that will be used in the phase banner. Ignored if text is passed.
+      #
+      # @return [ActiveSupport::SafeBuffer]
+
+      def render
+        tag.div(**options[:attributes]) do
+          tag.p(class: 'govuk-phase-banner__content') do
+            concat(Tag.new(**tag_options).render)
+            concat(tag.span(class: 'govuk-phase-banner__text') do
+              text || yield
+            end)
+          end
+        end
+      end
+
+      # The default attributes for the phase banner
+
+      DEFAULT_ATTRIBUTES = { class: 'govuk-phase-banner' }.freeze
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+require_relative '../base'
+
+module CCS::Components
+  module GovUK
+    # = GOV.UK Skip Link
+    #
+    # This is used to generate the skip link component from the
+    # {https://design-system.service.gov.uk/components/skip-link GDS - Components - Skip link}
+    #
+    # @!attribute [r] text
+    #   @return [String] Text for the skip link
+    # @!attribute [r] href
+    #   @return [String] The href for the skip link
+
+    class SkipLink < Base
+      private
+
+      attr_reader :text, :href
+
+      public
+
+      # @param text [String] the text for the skip link
+      # @param href [String] the href for the skip link
+      # @param options [Hash] options that will be used in customising the HTML
+      #
+      # @option options [String] :classes additional CSS classes for the skip link HTML
+      # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+
+      def initialize(text:, href: nil, **options)
+        super(**options)
+
+        @text = text
+        @href = href || '#content'
+      end
+
+      # Generates the HTML for the GOV.UK Skip link component
+      #
+      # @return [ActiveSupport::SafeBuffer]
+
+      def render
+        link_to(text, href, **options[:attributes])
+      end
+
+      # The default attributes for the skip link
+
+      DEFAULT_ATTRIBUTES = { class: 'govuk-skip-link', data: { module: 'govuk-skip-link' } }.freeze
+    end
+  end
+end

data/lib/ccs/components/govuk/step_by_step_navigation/section/content/list/item.rb

@@ -0,0 +1,51 @@
+require 'action_view'
+
+module CCS::Components
+  module GovUK
+    class StepByStepNavigation < Base
+      class Section < Base
+        class Content
+          class List
+            # = GOV.UK Step by step navigation section content list item
+            #
+            # Generates the list item HTML for the step by step navigation section content
+            #
+            # @!attribute [r] text
+            #   @return [String] Text for the list item
+            # @!attribute [r] classes
+            #   @return [String] HTML classes for the list item
+
+            class Item
+              include ActionView::Context
+              include ActionView::Helpers
+
+              private
+
+              attr_reader :text, :classes
+
+              public
+
+              # @param text [String] the text for the list item
+              # @param no_marker [Boolean] flag to hide the bullet marker
+
+              def initialize(text:, no_marker: nil)
+                @text = text
+                @classes = "gem-c-step-nav__list-item js-list-item #{'gem-c-step-nav__list--no-marker' if no_marker}".rstrip
+              end
+
+              # Generates the HTML for an individual the GOV.UK Step by step navigation list item
+              #
+              # @return [ActiveSupport::SafeBuffer]
+
+              def render
+                tag.li(class: classes) do
+                  tag.span(text)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/step_by_step_navigation/section/content/list.rb

@@ -0,0 +1,48 @@
+require 'action_view'
+
+require_relative 'list/item'
+
+module CCS::Components
+  module GovUK
+    class StepByStepNavigation < Base
+      class Section < Base
+        class Content
+          # = GOV.UK Step by step navigation section content list
+          #
+          # Generates the list HTML for the step by step navigation section content
+          #
+          # @!attribute [r] items
+          #   @return [Item] Array of initialised list items
+
+          class List
+            include ActionView::Context
+            include ActionView::Helpers
+
+            private
+
+            attr_reader :items
+
+            public
+
+            # @param items [Array<Hash>] An array of options for the list items
+            #                            See {Components::GovUK::StepByStepNavigation::Section::Content::List::Item#initialize Item#initialize} for details of the items in the array.
+
+            def initialize(items:)
+              @items = items.map { |item| Item.new(**item) }
+            end
+
+            # Generates the HTML for the GOV.UK Step by step navigation section content list
+            #
+            # @return [ActiveSupport::SafeBuffer]
+
+            def render
+              tag.ul(class: 'gem-c-step-nav__list gem-c-step-nav__list--choice', data: { length: items.length.to_s }) do
+                items.each { |item| concat(item.render) }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/step_by_step_navigation/section/content/paragraph.rb

@@ -0,0 +1,43 @@
+require 'action_view'
+
+module CCS::Components
+  module GovUK
+    class StepByStepNavigation < Base
+      class Section < Base
+        class Content
+          # = GOV.UK Step by step navigation section content paragraph
+          #
+          # Generates the paragraph HTML for the step by step navigation section content
+          #
+          # @!attribute [r] text
+          #   @return [String] Text for the paragraph
+
+          class Paragraph
+            include ActionView::Context
+            include ActionView::Helpers
+
+            private
+
+            attr_reader :text
+
+            public
+
+            # @param text [String] the text for the paragraph
+
+            def initialize(text:)
+              @text = text
+            end
+
+            # Generates the HTML for the GOV.UK Step by step navigation section content paragraph
+            #
+            # @return [ActiveSupport::SafeBuffer]
+
+            def render
+              tag.p(text, class: 'gem-c-step-nav__paragraph')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/step_by_step_navigation/section/content.rb

@@ -0,0 +1,61 @@
+require 'action_view'
+
+require_relative 'content/list'
+require_relative 'content/paragraph'
+
+module CCS::Components
+  module GovUK
+    class StepByStepNavigation < Base
+      class Section < Base
+        # = GOV.UK Step by step navigation section content
+        #
+        # The content for a navigation section
+        #
+        # @!attribute [r] section_id
+        #   @return [String] ID for the section content
+        # @!attribute [r] content_items
+        #   @return [Array<Paragraph|List>] An array of the initialised content items
+
+        class Content
+          include ActionView::Context
+          include ActionView::Helpers
+
+          private
+
+          attr_reader :section_id, :content_items
+
+          public
+
+          # @param content_items [Array<Hash>] array of content items.
+          #                                  If the type is +:paragraph+, see {Components::GovUK::StepByStepNavigation::Section::Content::Paragraph#initialize Paragraph#initialize}.
+          #                                  If the type is +:list+, see {Components::GovUK::StepByStepNavigation::Section::Content::List#initialize List#initialize}.
+          # @param index [String] the index of the section
+          # @param id [String] the id of the section
+
+          def initialize(content_items:, index:, id:)
+            @section_id = "step-panel-#{id}-#{index}"
+
+            @content_items = content_items.map do |content_item|
+              case content_item[:type]
+              when :paragraph
+                Paragraph.new(text: content_item[:text])
+              when :list
+                List.new(items: content_item[:items])
+              end
+            end
+          end
+
+          # Generates the HTML for the GOV.UK Step by step navigation section content
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            tag.div(class: 'gem-c-step-nav__panel js-panel', id: section_id) do
+              content_items.each { |content_item| concat(content_item.render) }
+            end
+          end
+        end
+      end
+    end
+  end
+end