ccs-frontend_helpers 0.1.0 → 0.1.1.rc.1

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

@@ -0,0 +1,63 @@
+require_relative '../../base'
+require_relative 'card/title'
+require_relative 'card/actions'
+
+module CCS
+  module 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
+end

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

@@ -0,0 +1,59 @@
+require_relative '../../../base'
+require_relative '../action/link'
+
+module CCS
+  module 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
+end

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

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

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

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

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

@@ -0,0 +1,67 @@
+require_relative '../../base'
+require_relative 'row/key'
+require_relative 'row/value'
+require_relative 'row/actions'
+
+module CCS
+  module 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)
+
+            actions_present = actions && actions[:items].present?
+
+            @options[:attributes][:class] << ' govuk-summary-list__row--no-actions' if any_row_has_actions && !actions_present
+
+            @key = Key.new(context: @context, **key)
+            @value = Value.new(context: @context, **value)
+            @actions = Actions.new(context: @context, **actions) if actions_present
+          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
+end

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

@@ -0,0 +1,74 @@
+require_relative '../base'
+require_relative 'summary_list/row'
+require_relative 'summary_list/card'
+
+module CCS
+  module 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.dig(:actions, :items).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
+end

data/lib/ccs/components/govuk/table/body/data_cell.rb

@@ -0,0 +1,53 @@
+require_relative '../../../base'
+
+module CCS
+  module Components
+    module GovUK
+      class Table < Base
+        class Body
+          # = GOV.UK Table Body data cell
+          #
+          # The individual table body data cell
+          #
+          # @!attribute [r] text
+          #   @return [String] Text for the cell
+
+          class DataCell < Base
+            private
+
+            attr_reader :text
+
+            public
+
+            # @param text [String]  the text of the cell
+            # @param options [Hash] options that will be used in customising the HTML
+            #
+            # @option options [String] :classes additional CSS classes for the cell
+            # @option options [String] :format specify format of a cell
+            # @option options [Hash] :attributes ({}) any additional attributes that will be added as part of the cell
+
+            def initialize(text:, **options)
+              super(**options)
+
+              @options[:attributes][:class] += " govuk-table__cell--#{@options[:format]}" if @options[:format]
+
+              @text = text
+            end
+
+            # Generates the HTML for the GOV.UK Table Body data cell
+            #
+            # @return [ActiveSupport::SafeBuffer]
+
+            def render
+              tag.td(text, **options[:attributes])
+            end
+
+            # The default attributes for the table body data cell
+
+            DEFAULT_ATTRIBUTES = { class: 'govuk-table__cell' }.freeze
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/table/body/head_cell.rb

@@ -0,0 +1,52 @@
+require_relative '../../../base'
+
+module CCS
+  module Components
+    module GovUK
+      class Table < Base
+        class Body
+          # = GOV.UK Table Body head cell
+          #
+          # The individual table body head cell
+          #
+          # @!attribute [r] text
+          #   @return [String] Text for the cell
+
+          class HeadCell < Base
+            private
+
+            attr_reader :text
+
+            public
+
+            # @param text [String] the text of the cell
+            # @param options [Hash] options that will be used in customising the HTML
+            #
+            # @option options [String] :classes additional CSS classes for the cell
+            # @option options [Hash] :attributes ({}) any additional attributes that will be added as part of the cell
+
+            def initialize(text:, **options)
+              super(**options)
+
+              @options[:attributes][:scope] = 'row'
+
+              @text = text
+            end
+
+            # Generates the HTML for the GOV.UK Table Body head cell
+            #
+            # @return [ActiveSupport::SafeBuffer]
+
+            def render
+              tag.th(text, **options[:attributes])
+            end
+
+            # The default attributes for the table body head cell
+
+            DEFAULT_ATTRIBUTES = { class: 'govuk-table__header' }.freeze
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/table/header/head_cell.rb

@@ -0,0 +1,54 @@
+require_relative '../../../base'
+
+module CCS
+  module Components
+    module GovUK
+      class Table < Base
+        class Header
+          # = GOV.UK Table Header head cell
+          #
+          # The individual table header head cell
+          #
+          # @!attribute [r] text
+          #   @return [String] Text for the cell
+
+          class HeadCell < Base
+            private
+
+            attr_reader :text
+
+            public
+
+            # @param text [String] the text of the cell
+            # @param options [Hash] options that will be used in customising the HTML
+            #
+            # @option options [String] :classes additional CSS classes for the cell
+            # @option options [String] :format specify format of a cell
+            # @option options [Hash] :attributes ({}) any additional attributes that will be added as part of the cell
+
+            def initialize(text:, **options)
+              super(**options)
+
+              @options[:attributes][:class] += " govuk-table__header--#{@options[:format]}" if @options[:format]
+              @options[:attributes][:scope] = 'col'
+
+              @text = text
+            end
+
+            # Generates the HTML for the GOV.UK Table Header head cell
+            #
+            # @return [ActiveSupport::SafeBuffer]
+
+            def render
+              tag.th(text, **options[:attributes])
+            end
+
+            # The default attributes for the table header head cell
+
+            DEFAULT_ATTRIBUTES = { class: 'govuk-table__header' }.freeze
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,111 @@
+require_relative '../base'
+require_relative 'table/body/data_cell'
+require_relative 'table/body/head_cell'
+require_relative 'table/header/head_cell'
+
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK Table
+      #
+      # This is used to generate the table component from the
+      # {https://design-system.service.gov.uk/components/table GDS - Components - Table}
+      #
+      # @!attribute [r] rows
+      #   @return [Array<Array<Body::HeadCell|Body::DataCell>>] Arrays of the initialised row cells
+      # @!attribute [r] head_cells
+      #   @return [Array<Header::HeadCell>] an array of the initialised header cells
+      # @!attribute [r] caption
+      #   @return [Hash] options for the caption
+
+      class Table < Base
+        private
+
+        attr_reader :rows, :head_cells, :caption
+
+        public
+
+        # @param rows [Array<Array<Hash>>] array of table rows and cells.
+        #                                  See {Components::GovUK::Table::Body::HeadCell#initialize Body::HeadCell#initialize}
+        #                                  or {Components::GovUK::Table::Body::DataCell#initialize Body::DataCell#initialize} for details of the items in the array.
+        # @param head_cells [NilClass,Array] array of table head cells.
+        #                                    See {Components::GovUK::Table::Header::HeadCell#initialize Header::HeadCell#initialize} for details of the items in the array.
+        # @param caption [NilClass,Hash] options for a table caption
+        # @param first_cell_is_header [Boolean] if set to true, first cell in table row will be a TH instead of a TD
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option caption [String] :text the caption text
+        # @option caption [String] :classes additional CSS classes for the table caption
+        #
+        # @option options [String] :classes additional CSS classes for the table HTML
+        # @option options [Hash] :attributes ({}) any additional attributes that will be added as part of the HTML
+
+        def initialize(rows:, head_cells: nil, caption: nil, first_cell_is_header: nil, **options)
+          super(**options)
+
+          @rows = rows.map do |row_cells|
+            row_cells.map.with_index do |row_cell, index|
+              if first_cell_is_header && index.zero?
+                Body::HeadCell.new(context: @context, **row_cell)
+              else
+                Body::DataCell.new(context: @context, **row_cell)
+              end
+            end
+          end
+          @head_cells = head_cells&.map { |head_cell| Header::HeadCell.new(context: @context, **head_cell) }
+          @caption = caption
+        end
+
+        # Generates the HTML for the GOV.UK table component
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.table(**options[:attributes]) do
+            concat(table_caption) if caption
+            concat(table_head) if head_cells
+            concat(tag.tbody(class: 'govuk-table__body') do
+              rows.each { |row_cells| concat(table_row(row_cells)) }
+            end)
+          end
+        end
+
+        # The default attributes for the table
+
+        DEFAULT_ATTRIBUTES = { class: 'govuk-table' }.freeze
+
+        private
+
+        # Generates the HTML for the the table caption
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def table_caption
+          tag.caption(caption[:text], class: "govuk-table__caption #{caption[:classes]}".rstrip)
+        end
+
+        # Generates the HTML for the table head
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def table_head
+          tag.thead(class: 'govuk-table__head') do
+            tag.tr(class: 'govuk-table__row') do
+              head_cells.each { |head_cell| concat(head_cell.render) }
+            end
+          end
+        end
+
+        # Generates the HTML for a table row
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def table_row(row_cells)
+          tag.tr(class: 'govuk-table__row') do
+            row_cells.each { |row_cell| concat(row_cell.render) }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+require_relative '../../base'
+
+module CCS
+  module Components
+    module GovUK
+      class Tabs < Base
+        # = GOV.UK Tabs panel
+        #
+        # The individual tab panels
+        #
+        # @!attribute [r] index
+        #   @return [Integer] The index of the panel
+        # @!attribute [r] id_prefix
+        #   @return [String] Prefix id for the panel
+        # @!attribute [r] content
+        #   @return [ActiveSupport::SafeBuffer] HTML for the tab panel
+        # @!attribute [r] text
+        #   @return [String] Text for the tabs panel
+
+        class Panel < Base
+          private
+
+          attr_reader :index, :id_prefix, :content, :text
+
+          public
+
+          # @param index [Integer] the index of the tab panel
+          # @param id_prefix [Integer] prefix used for the id of a panel if no id is specified
+          # @param content [ActiveSupport::SafeBuffer] HTML to use as content for the tab panel
+          # @param text [String] if +:content+ is blank then this is the text used for the tab panel
+          # @param options [Hash] options that will be used in customising the HTML
+          #
+          # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+
+          def initialize(index:, id_prefix:, content: nil, text: nil, **options)
+            super(**options)
+            @options[:attributes][:class] = "govuk-tabs__panel #{'govuk-tabs__panel--hidden' if index > 1}".rstrip
+            @options[:attributes][:id] ||= "#{id_prefix}-#{index}"
+
+            @index = index
+            @content = content
+            @text = text
+          end
+
+          # Generates the HTML for the GOV.UK Tabs panel
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            tag.div(**options[:attributes]) do
+              content || tag.p(text, class: 'govuk-body')
+            end
+          end
+        end
+      end
+    end
+  end
+end