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

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

@@ -0,0 +1,67 @@
+require 'action_view'
+
+module CCS::Components
+  module GovUK
+    class StepByStepNavigation < Base
+      class Section < Base
+        # = GOV.UK Step by step navigation section heading
+        #
+        # The heading for a navigation section
+        #
+        # @!attribute [r] text
+        #   @return [String] Text for the section heading
+        # @!attribute [r] index
+        #   @return [String] Index of the section
+        # @!attribute [r] logic
+        #   @return [String] Optional text to show in the sidebar
+
+        class Heading
+          include ActionView::Context
+          include ActionView::Helpers
+
+          private
+
+          attr_reader :text, :index, :logic
+
+          public
+
+          # @param text [String] text for the section heading
+          # @param index [String] the index of the section
+          # @param logic [String] text to show instead of a number in the sidebar
+
+          def initialize(text:, index:, logic: nil)
+            @text = text
+            @index = index
+            @logic = logic
+          end
+
+          # rubocop:disable Metrics/AbcSize
+
+          # Generates the HTML for the GOV.UK Step by step navigation section heading
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            tag.div(class: 'gem-c-step-nav__header js-toggle-panel', data: { position: index }) do
+              tag.h2(class: 'gem-c-step-nav__title') do
+                concat(tag.span(class: "gem-c-step-nav__circle gem-c-step-nav__circle--#{logic ? 'logic' : 'number'}") do
+                  tag.span(class: 'gem-c-step-nav__circle-inner') do
+                    tag.span(class: 'gem-c-step-nav__circle-background') do
+                      concat(tag.span('Step', class: 'govuk-visually-hidden'))
+                      concat(logic || index)
+                    end
+                  end
+                end)
+                concat(tag.span(class: 'js-step-title') do
+                  tag.span(text, class: 'js-step-title-text')
+                end)
+              end
+            end
+          end
+
+          # rubocop:enable Metrics/AbcSize
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+require_relative '../../base'
+require_relative 'section/heading'
+require_relative 'section/content'
+
+module CCS::Components
+  module GovUK
+    class StepByStepNavigation < Base
+      # = GOV.UK Step by step navigation section
+      #
+      # The individual section for the step by step navigation
+      #
+      # @!attribute [r] heading
+      #   @return [Heading] Initialised heading for the section
+      # @!attribute [r] content
+      #   @return [Content] Initialised content for the section
+
+      class Section < Base
+        private
+
+        attr_reader :heading, :content
+
+        public
+
+        # @param heading [Hash] options for the section heading.
+        #                      See {Components::GovUK::StepByStepNavigation::Section::Heading#initialize Heading#initialize} for details of the options.
+        # @param content [Hash] options for the section content.
+        #                       See {Components::GovUK::StepByStepNavigation::Section::Content#initialize Content#initialize} for details of the options.
+        # @param index [String] the index of the section
+        # @param context [ActionView::Base] the view context
+
+        def initialize(heading:, content:, index:, context:)
+          super(context: context)
+
+          @options[:attributes][:class] = 'gem-c-step-nav__step js-step'
+          @options[:attributes][:id] = heading[:text].downcase.gsub(' ', '-').gsub('(', '').gsub(')', '')
+
+          @heading = Heading.new(index: index, **heading)
+          @content = Content.new(content_items: content, index: index, id: @options[:attributes][:id])
+        end
+
+        # Generates the HTML for the GOV.UK Step by step navigation section
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.li(class: @options[:attributes][:class], id: @options[:attributes][:id]) do
+            concat(heading.render)
+            concat(content.render)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+require_relative '../base'
+require_relative 'step_by_step_navigation/section'
+
+module CCS::Components
+  module GovUK
+    # = GOV.UK Step by step navigation
+    #
+    # This is used for generating the Step by step navigation component from the
+    # {https://design-system.service.gov.uk/patterns/step-by-step-navigation/ GDS - Pages - Step by step navigation}
+    #
+    # @!attribute [r] step_by_step_navigation_sections
+    #   @return [Array<Section>] An array of the initialised step by step navigation sections
+
+    class StepByStepNavigation < Base
+      private
+
+      attr_reader :step_by_step_navigation_sections
+
+      public
+
+      # @param step_by_step_navigation_sections [Array<Hash>] An array of options for the step by step navigation section.
+      #                                                       See {Components::GovUK::StepByStepNavigation::Section#initialize Section#initialize} for details of the items in the array.
+      # @param options [Hash] options that will be used in customising the HTML
+      #
+      # @option options [String] :classes additional CSS classes for the step by step navigation HTML
+      # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+
+      def initialize(step_by_step_navigation_sections:, **options)
+        super(**options)
+
+        DEFAULT_SHOW_HIDE_TEXT.each { |key, value| @options[:attributes][:data][key] ||= value }
+
+        @step_by_step_navigation_sections = step_by_step_navigation_sections.map.with_index(1) { |step_by_step_section, index| Section.new(index: index.to_s, context: @context, **step_by_step_section) }
+      end
+
+      # Generates the HTML for the GOV.UK Step by step navigation component (experimental)
+      #
+      # @return [ActiveSupport::SafeBuffer]
+
+      def render
+        tag.div(**options[:attributes]) do
+          tag.ol(class: 'gem-c-step-nav__steps') do
+            step_by_step_navigation_sections.each { |step_by_step_navigation_section| concat(step_by_step_navigation_section.render) }
+          end
+        end
+      end
+
+      # The default attributes for the step byt step navigation
+
+      DEFAULT_ATTRIBUTES = { class: 'gem-c-step-nav gem-c-step-nav--large gem-c-step-nav--active', data: { module: 'govuk-step-by-step-navigation' } }.freeze
+
+      # Default text for the show and hide buttons which are part of each section
+
+      DEFAULT_SHOW_HIDE_TEXT = { 'show-text': 'Show', 'hide-text': 'Hide', 'show-all-text': 'Show all', 'hide-all-text': 'Hide all' }.freeze
+    end
+  end
+end

data/lib/ccs/components/govuk/summary_list/action/link.rb

@@ -0,0 +1,57 @@
+require_relative '../../../base'
+
+module CCS::Components
+  module GovUK
+    class SummaryList < Base
+      class Action
+        # = GOV.UK Summary list action link
+        #
+        # @!attribute [r] text
+        #   @return [String] Text for the action link
+        # @!attribute [r] href
+        #   @return [String] The href for the action link
+        # @!attribute [r] visually_hidden_text
+        #   @return [String] Visually hidden text for the action link
+
+        class Link < Base
+          private
+
+          attr_reader :text, :href, :visually_hidden_text
+
+          public
+
+          # @param text [String] the text for the action link
+          # @param href [String] the href for the action link
+          # @param visually_hidden_text [String] optional visually hidden text for the action link
+          # @param options [Hash] options that will be used in customising the HTML
+          #
+          # @option options [String] :classes additional CSS classes for the summary list action link HTML
+          # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+
+          def initialize(text:, href:, visually_hidden_text: nil, **options)
+            super(**options)
+
+            @text = text
+            @href = href
+            @visually_hidden_text = visually_hidden_text
+          end
+
+          # Generates the HTML for the GOV.UK Summary list action link
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            link_to(href, **@options[:attributes]) do
+              concat(text)
+              concat(tag.span(visually_hidden_text, class: 'govuk-visually-hidden')) if visually_hidden_text
+            end
+          end
+
+          # The default attributes for the summary list action link
+
+          DEFAULT_ATTRIBUTES = { class: 'govuk-link' }.freeze
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/summary_list/card/actions.rb

@@ -0,0 +1,57 @@
+require_relative '../../../base'
+require_relative '../action/link'
+
+module CCS::Components
+  module GovUK
+    class SummaryList < Base
+      class Card < Base
+        # = GOV.UK Summary list card actions
+        #
+        # @!attribute [r] action_links
+        #   @return [Array<Action::Link>] An array of the initialised aummary list card action links
+
+        class Actions < Base
+          private
+
+          attr_reader :action_links
+
+          public
+
+          # @param items [Array<Hash>] An array of attributes for the action links.
+          #                            See {Components::GovUK::SummaryList::Action::Link#initialize Action::Link#initialize} for details of the items in the array.
+          # @param options [Hash] options that will be used in customising the HTML
+          #
+          # @option options [String] :classes additional CSS classes for the summary list card actions HTML
+
+          def initialize(items:, **options)
+            super(**options)
+
+            @action_links = items.map { |item| Action::Link.new(context: @context, **item) }
+          end
+
+          # Generates the HTML for the GOV.UK Summary list card actions
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            if action_links.length == 1
+              tag.div(class: @options[:attributes][:class]) do
+                action_links.first.render
+              end
+            else
+              tag.ul(class: @options[:attributes][:class]) do
+                action_links.each do |action_link|
+                  concat(tag.li(action_link.render, class: 'govuk-summary-card__action'))
+                end
+              end
+            end
+          end
+
+          # The default attributes for the summary list card actions
+
+          DEFAULT_ATTRIBUTES = { class: 'govuk-summary-card__actions' }.freeze
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/summary_list/card/title.rb

@@ -0,0 +1,49 @@
+require_relative '../../../base'
+
+module CCS::Components
+  module GovUK
+    class SummaryList < Base
+      class Card < Base
+        # = GOV.UK Summary list card title
+        #
+        # @!attribute [r] text
+        #   @return [String] Text for the title
+        # @!attribute [r] heading_level
+        #   @return [String] Heading level for the title
+
+        class Title < Base
+          private
+
+          attr_reader :text, :heading_level
+
+          public
+
+          # @param text [String] the text for the title
+          # @param heading_level [String] heading level, from 1 to 6
+          # @param options [Hash] options that will be used in customising the HTML
+          #
+          # @option options [String] :classes additional CSS classes for the summary list card title HTML
+
+          def initialize(text:, heading_level: '2', **options)
+            super(**options)
+
+            @text = text
+            @heading_level = heading_level
+          end
+
+          # Generates the HTML for the GOV.UK Summary list card title
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            tag.send("h#{heading_level}", text, class: @options[:attributes][:class])
+          end
+
+          # The default attributes for the summary list card title
+
+          DEFAULT_ATTRIBUTES = { class: 'govuk-summary-card__title' }.freeze
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/summary_list/card.rb

@@ -0,0 +1,61 @@
+require_relative '../../base'
+require_relative 'card/title'
+require_relative 'card/actions'
+
+module CCS::Components
+  module GovUK
+    class SummaryList < Base
+      # = GOV.UK Summary card
+      #
+      # This is used for generating the summary cards component from the
+      # {https://design-system.service.gov.uk/components/summary-list/#summary-cards GDS - Components - Summary cards}
+      #
+      # @!attribute [r] title
+      #   @return [Title] Initialised summary card title
+      # @!attribute [r] actions
+      #   @return [Actions] Initialised summary card actions
+
+      class Card < Base
+        private
+
+        attr_reader :title, :actions
+
+        public
+
+        # @param title [Hash] attributes for the title, see {CCS::Components::GovUK::SummaryList::Card::Title#initialize Title#initialize} for more details.
+        # @param actions [Hash] attributes for the actions, see {CCS::Components::GovUK::SummaryList::Card::Actions#initialize Actions#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 summary card HTML
+        # @option options [Hash] :attributes any additional attributes that will be added as part of the HTML
+
+        def initialize(title: nil, actions: nil, **options)
+          super(**options)
+
+          @title = Title.new(context: @context, **title) if title
+          @actions = Actions.new(context: @context, **actions) if actions
+        end
+
+        # Generates the HTML for the GOV.UK Summary card
+        #
+        # @yield the HTML for the summary list
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render(&block)
+          tag.div(**@options[:attributes]) do
+            concat(tag.div(class: 'govuk-summary-card__title-wrapper') do
+              concat(title.render) if title
+              concat(actions.render) if actions
+            end)
+            concat(tag.div(class: 'govuk-summary-card__content', &block))
+          end
+        end
+
+        # The default attributes for the summary card
+
+        DEFAULT_ATTRIBUTES = { class: 'govuk-summary-card' }.freeze
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/summary_list/row/actions.rb

@@ -0,0 +1,57 @@
+require_relative '../../../base'
+require_relative '../action/link'
+
+module CCS::Components
+  module GovUK
+    class SummaryList < Base
+      class Row < Base
+        # = GOV.UK Summary list row actions
+        #
+        # @!attribute [r] action_links
+        #   @return [Array<Action::Link>] An array of the initialised aummary list row action links
+
+        class Actions < Base
+          private
+
+          attr_reader :action_links
+
+          public
+
+          # @param items [Array<Hash>] An array of attributes for the action links.
+          #                            See {Components::GovUK::SummaryList::Action::Link#initialize Action::Link#initialize} for details of the items in the array.
+          # @param options [Hash] options that will be used in customising the HTML
+          #
+          # @option options [String] :classes additional CSS classes for the summary list row actions HTML
+
+          def initialize(items:, **options)
+            super(**options)
+
+            @action_links = items.map { |item| Action::Link.new(context: @context, **item) }
+          end
+
+          # Generates the HTML for the GOV.UK Summary list row actions
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            tag.dd(class: @options[:attributes][:class]) do
+              if action_links.length == 1
+                action_links.first.render
+              else
+                tag.ul(class: 'govuk-summary-list__actions-list') do
+                  action_links.each do |action_link|
+                    concat(tag.li(action_link.render, class: 'govuk-summary-list__actions-list-item'))
+                  end
+                end
+              end
+            end
+          end
+
+          # The default attributes for the summary list row actions
+
+          DEFAULT_ATTRIBUTES = { class: 'govuk-summary-list__actions' }.freeze
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/summary_list/row/key.rb

@@ -0,0 +1,45 @@
+require_relative '../../../base'
+
+module CCS::Components
+  module GovUK
+    class SummaryList < Base
+      class Row < Base
+        # = GOV.UK Summary list row key
+        #
+        # @!attribute [r] text
+        #   @return [String] Text for the summary list row key
+
+        class Key < Base
+          private
+
+          attr_reader :text
+
+          public
+
+          # @param text [String] Text for the summary list row key
+          # @param options [Hash] options that will be used in customising the HTML
+          #
+          # @option options [String] :classes additional CSS classes for the summary list row key HTML
+
+          def initialize(text:, **options)
+            super(**options)
+
+            @text = text
+          end
+
+          # Generates the HTML for the GOV.UK Summary list row key
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            tag.dt(text, class: @options[:attributes][:class])
+          end
+
+          # The default attributes for the summary list row key
+
+          DEFAULT_ATTRIBUTES = { class: 'govuk-summary-list__key' }.freeze
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/summary_list/row/value.rb

@@ -0,0 +1,45 @@
+require_relative '../../../base'
+
+module CCS::Components
+  module GovUK
+    class SummaryList < Base
+      class Row < Base
+        # = GOV.UK Summary list row value
+        #
+        # @!attribute [r] text
+        #   @return [String] Text for the summary list row value
+
+        class Value < Base
+          private
+
+          attr_reader :text
+
+          public
+
+          # @param text [String] Text for the summary list row value
+          # @param options [Hash] options that will be used in customising the HTML
+          #
+          # @option options [String] :classes additional CSS classes for the summary list row value HTML
+
+          def initialize(text:, **options)
+            super(**options)
+
+            @text = text
+          end
+
+          # Generates the HTML for the GOV.UK Summary list row value
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            tag.dd(text, class: @options[:attributes][:class])
+          end
+
+          # The default attributes for the summary list row value
+
+          DEFAULT_ATTRIBUTES = { class: 'govuk-summary-list__value' }.freeze
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/summary_list/row.rb

@@ -0,0 +1,63 @@
+require_relative '../../base'
+require_relative 'row/key'
+require_relative 'row/value'
+require_relative 'row/actions'
+
+module CCS::Components
+  module GovUK
+    class SummaryList < Base
+      # = GOV.UK Summary list row
+      #
+      # Generates the HTML for a summary list row
+      #
+      # @!attribute [r] key
+      #   @return [Key] Initialised summary list cell for the key
+      # @!attribute [r] value
+      #   @return [Value] Initialised summary list cell for the value
+      # @!attribute [r] actions
+      #   @return [Actions] Initialised summary list cell for the actions
+
+      class Row < Base
+        private
+
+        attr_reader :key, :value, :actions
+
+        public
+
+        # @param any_row_has_actions [Boolean] flag to indicate if any rows have actions
+        # @param key [Hash] attributes for the key, see {CCS::Components::GovUK::SummaryList::Row::Key#initialize Key#initialize} for more details.
+        # @param value [Hash] attributes for the value, see {CCS::Components::GovUK::SummaryList::Row::Value#initialize Value#initialize} for more details.
+        # @param actions [Hash] attributes for the actions, see {CCS::Components::GovUK::SummaryList::Row::Actions#initialize Actions#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 summary list row HTML
+
+        def initialize(any_row_has_actions:, key:, value:, actions: nil, **options)
+          super(**options)
+
+          @options[:attributes][:class] << ' govuk-summary-list__row--no-actions' if any_row_has_actions && !actions
+
+          @key = Key.new(context: @context, **key)
+          @value = Value.new(context: @context, **value)
+          @actions = Actions.new(context: @context, **actions) if actions
+        end
+
+        # Generates the HTML for the GOV.UK Summary list row
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.div(class: options[:attributes][:class]) do
+            concat(key.render)
+            concat(value.render)
+            concat(actions.render) if actions
+          end
+        end
+
+        # The default attributes for the summary list row
+
+        DEFAULT_ATTRIBUTES = { class: 'govuk-summary-list__row' }.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+require_relative '../base'
+require_relative 'summary_list/row'
+require_relative 'summary_list/card'
+
+module CCS::Components
+  module GovUK
+    # = GOV.UK Summary list
+    #
+    # This is used for generating the summary list component from the
+    # {https://design-system.service.gov.uk/components/summary-list GDS - Components - Summary list}
+    #
+    # @!attribute [r] summary_list_rows
+    #   @return [Array<Row>] An array of the initialised summary list rows
+    # @!attribute [r] card
+    #   @return [Card] Initialised summary list card
+
+    class SummaryList < Base
+      private
+
+      attr_reader :summary_list_rows, :card
+
+      public
+
+      # @param summary_list_items [Array<Hash>] An array of options for the summary list rows.
+      #                                         See {Components::GovUK::SummaryList::Row#initialize Row#initialize} for details of the items in the array.
+      # @param card [Hash] attributes for the card, see {CCS::Components::GovUK::SummaryList::Card#initialize Card#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 summary list HTML
+      # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+
+      def initialize(summary_list_items:, card: nil, **options)
+        super(**options)
+
+        any_row_has_actions = summary_list_items.any? { |summary_list_item| summary_list_item[:actions].present? }
+
+        @summary_list_rows = summary_list_items.map { |summary_list_item| Row.new(any_row_has_actions: any_row_has_actions, context: @context, **summary_list_item) }
+        @card = Card.new(context: @context, **card) if card
+      end
+
+      # Generates the HTML for the GOV.UK Summary list component
+      #
+      # @return [ActiveSupport::SafeBuffer]
+
+      def render
+        if card
+          card.render do
+            render_summary_list
+          end
+        else
+          render_summary_list
+        end
+      end
+
+      # The default attributes for the summary list
+
+      DEFAULT_ATTRIBUTES = { class: 'govuk-summary-list' }.freeze
+
+      private
+
+      # Generates the HTML for the actual summary list
+      #
+      # @return [ActiveSupport::SafeBuffer]
+
+      def render_summary_list
+        tag.dl(**options[:attributes]) do
+          summary_list_rows.each { |summary_list_row| concat(summary_list_row.render) }
+        end
+      end
+    end
+  end
+end