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

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

@@ -3,105 +3,107 @@ require_relative 'table/body/data_cell'
 require_relative 'table/body/head_cell'
 require_relative 'table/header/head_cell'
 
-module CCS::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
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK Table
       #
-      # @option caption [String] :text the caption text
-      # @option caption [String] :classes additional CSS classes for the table caption
+      # This is used to generate the table component from the
+      # {https://design-system.service.gov.uk/components/table GDS - Components - Table}
       #
-      # @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)
+      # @!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
-        @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)
+        # 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
-      end
 
-      # The default attributes for the table
+        # The default attributes for the table
 
-      DEFAULT_ATTRIBUTES = { class: 'govuk-table' }.freeze
+        DEFAULT_ATTRIBUTES = { class: 'govuk-table' }.freeze
 
-      private
+        private
 
-      # Generates the HTML for the the table caption
-      #
-      # @return [ActiveSupport::SafeBuffer]
+        # 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
+        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]
+        # 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) }
+        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
-      end
 
-      # Generates the HTML for a table row
-      #
-      # @return [ActiveSupport::SafeBuffer]
+        # 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) }
+        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

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

@@ -1,53 +1,55 @@
 require_relative '../../base'
 
-module CCS::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
+module CCS
+  module Components
+    module GovUK
+      class Tabs < Base
+        # = GOV.UK Tabs panel
         #
-        # @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
+        # The individual tab panels
         #
-        # @return [ActiveSupport::SafeBuffer]
+        # @!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')
+          def render
+            tag.div(**options[:attributes]) do
+              content || tag.p(text, class: 'govuk-body')
+            end
           end
         end
       end

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

@@ -1,51 +1,53 @@
 require_relative '../../base'
 
-module CCS::Components
-  module GovUK
-    class Tabs < Base
-      # = GOV.UK Tabs tab
-      #
-      # The individual tab
-      #
-      # @!attribute [r] index
-      #   @return [Integer] The index of the tab
-      # @!attribute [r] label
-      #   @return [String] Text for the tab
-      # @!attribute [r] href
-      #   @return [String] The href for the tab panel
-
-      class Tab < Base
-        private
-
-        attr_reader :index, :label, :href
-
-        public
-
-        # @param index [Integer] the index of the tab
-        # @param id_prefix [Integer] prefix used for the id of a panel if no id is specified
-        # @param label [String] the text for the tab
-        # @param panel [Hash] used to find the id of the panel. See {Components::GovUK::Tabs::Panel#initialize Panel#initialize} for more details
-        # @param options [Hash] options that will be used in customising the HTML
+module CCS
+  module Components
+    module GovUK
+      class Tabs < Base
+        # = GOV.UK Tabs tab
         #
-        # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+        # The individual tab
+        #
+        # @!attribute [r] index
+        #   @return [Integer] The index of the tab
+        # @!attribute [r] label
+        #   @return [String] Text for the tab
+        # @!attribute [r] href
+        #   @return [String] The href for the tab panel
 
-        def initialize(index:, id_prefix:, label:, panel:, **options)
-          super(**options)
+        class Tab < Base
+          private
 
-          @options[:attributes][:class] = 'govuk-tabs__tab'
+          attr_reader :index, :label, :href
 
-          @index = index
-          @label = label
-          @href = "##{panel.dig(:attributes, :id) || "#{id_prefix}-#{index}"}"
-        end
+          public
 
-        # Generates the HTML for the GOV.UK Tabs tab
-        #
-        # @return [ActiveSupport::SafeBuffer]
+          # @param index [Integer] the index of the tab
+          # @param id_prefix [Integer] prefix used for the id of a panel if no id is specified
+          # @param label [String] the text for the tab
+          # @param panel [Hash] used to find the id of the panel. See {Components::GovUK::Tabs::Panel#initialize Panel#initialize} for more details
+          # @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:, label:, panel:, **options)
+            super(**options)
+
+            @options[:attributes][:class] = 'govuk-tabs__tab'
+
+            @index = index
+            @label = label
+            @href = "##{panel.dig(:attributes, :id) || "#{id_prefix}-#{index}"}"
+          end
+
+          # Generates the HTML for the GOV.UK Tabs tab
+          #
+          # @return [ActiveSupport::SafeBuffer]
 
-        def render
-          tag.li(class: "govuk-tabs__list-item #{'govuk-tabs__list-item--selected' if index == 1}".rstrip) do
-            link_to(label, href, **options[:attributes])
+          def render
+            tag.li(class: "govuk-tabs__list-item #{'govuk-tabs__list-item--selected' if index == 1}".rstrip) do
+              link_to(label, href, **options[:attributes])
+            end
           end
         end
       end

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

@@ -2,63 +2,65 @@ require_relative '../base'
 require_relative 'tabs/tab'
 require_relative 'tabs/panel'
 
-module CCS::Components
-  module GovUK
-    # = GOV.UK Tabs
-    #
-    # This is used to generate the tabs component from the
-    # {https://design-system.service.gov.uk/components/tabs GDS - Components - Tabs}
-    #
-    # @!attribute [r] title
-    #   @return [String] Title for the tabs table of contents
-    # @!attribute [r] tabs
-    #   @return [Array<Tabs::Tab>] an array of initialised tabs
-    # @!attribute [r] panels
-    #   @return [Array<Tabs::Panel>] an array of initialised panel
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK Tabs
+      #
+      # This is used to generate the tabs component from the
+      # {https://design-system.service.gov.uk/components/tabs GDS - Components - Tabs}
+      #
+      # @!attribute [r] title
+      #   @return [String] Title for the tabs table of contents
+      # @!attribute [r] tabs
+      #   @return [Array<Tabs::Tab>] an array of initialised tabs
+      # @!attribute [r] panels
+      #   @return [Array<Tabs::Panel>] an array of initialised panel
 
-    class Tabs < Base
-      private
+      class Tabs < Base
+        private
 
-      attr_reader :title, :tabs, :panels
+        attr_reader :title, :tabs, :panels
 
-      public
+        public
 
-      # @param items [Array<Hash>] array of the tab items.
-      #                            See {Components::GovUK::Tabs::Tab#initialize Tab#initialize}
-      #                            and {Components::GovUK::Tabs::Panel#initialize Panel#initialize} for details of the items in the array.
-      # @param title [NilClass,String] title for the tabs table of contents
-      # @param id_prefix [String] prefix id for each tab item if no id is specified on each item
-      # @param options [Hash] options that will be used in customising the HTML
-      #
-      # @option options [String] :classes additional CSS classes for the tabs HTML
-      # @option options [Hash] :attributes ({}) any additional attributes that will be added as part of the HTML
+        # @param items [Array<Hash>] array of the tab items.
+        #                            See {Components::GovUK::Tabs::Tab#initialize Tab#initialize}
+        #                            and {Components::GovUK::Tabs::Panel#initialize Panel#initialize} for details of the items in the array.
+        # @param title [NilClass,String] title for the tabs table of contents
+        # @param id_prefix [String] prefix id for each tab item if no id is specified on each item
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option options [String] :classes additional CSS classes for the tabs HTML
+        # @option options [Hash] :attributes ({}) any additional attributes that will be added as part of the HTML
 
-      def initialize(items:, title: nil, id_prefix: nil, **options)
-        super(**options)
+        def initialize(items:, title: nil, id_prefix: nil, **options)
+          super(**options)
 
-        @title = title || 'Contents'
-        id_prefix ||= sanitize_to_id(@title.downcase)
-        @tabs = items.map.with_index(1) { |item, index| Tab.new(index: index, id_prefix: id_prefix, context: @context, **item) }
-        @panels = items.map.with_index(1) { |item, index| Panel.new(index: index, id_prefix: id_prefix, context: @context, **item[:panel]) }
-      end
+          @title = title || 'Contents'
+          id_prefix ||= sanitize_to_id(@title.downcase)
+          @tabs = items.map.with_index(1) { |item, index| Tab.new(index: index, id_prefix: id_prefix, context: @context, **item) }
+          @panels = items.map.with_index(1) { |item, index| Panel.new(index: index, id_prefix: id_prefix, context: @context, **item[:panel]) }
+        end
 
-      # Generates the HTML for the GOV.UK Tabs component
-      #
-      # @return [ActiveSupport::SafeBuffer]
+        # Generates the HTML for the GOV.UK Tabs component
+        #
+        # @return [ActiveSupport::SafeBuffer]
 
-      def render
-        tag.div(**options[:attributes]) do
-          concat(tag.h2(title, class: 'govuk-tabs__title'))
-          concat(tag.ul(class: 'govuk-tabs__list') do
-            @tabs.each { |tab| concat(tab.render) }
-          end)
-          @panels.each { |panel| concat(panel.render) }
+        def render
+          tag.div(**options[:attributes]) do
+            concat(tag.h2(title, class: 'govuk-tabs__title'))
+            concat(tag.ul(class: 'govuk-tabs__list') do
+              @tabs.each { |tab| concat(tab.render) }
+            end)
+            @panels.each { |panel| concat(panel.render) }
+          end
         end
-      end
 
-      # The default attributes for the tabs
+        # The default attributes for the tabs
 
-      DEFAULT_ATTRIBUTES = { class: 'govuk-tabs', data: { module: 'govuk-tabs' } }.freeze
+        DEFAULT_ATTRIBUTES = { class: 'govuk-tabs', data: { module: 'govuk-tabs' } }.freeze
+      end
     end
   end
 end

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

@@ -1,49 +1,51 @@
 require_relative '../base'
 
-module CCS::Components
-  module GovUK
-    # = GOV.UK Tag
-    #
-    # This is used to generate the tag component from the
-    # {https://design-system.service.gov.uk/components/tag GDS - Components - Tag}
-    #
-    # @!attribute [r] text
-    #   @return [String] Text for the tag
-
-    class Tag < Base
-      private
-
-      attr_reader :text
-
-      public
-
-      # @param text [String] the text for the tag
-      # @param colour [String] optional colour for the tag,
-      #                        see {https://design-system.service.gov.uk/components/tag/#additional-colours Tag - Additional colours}
-      #                        for available colours in GOV.UK Frontend
-      # @param options [Hash] options that will be used in customising the HTML
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK Tag
       #
-      # @option options [String] :classes additional CSS classes for the tag HTML
-      # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+      # This is used to generate the tag component from the
+      # {https://design-system.service.gov.uk/components/tag GDS - Components - Tag}
+      #
+      # @!attribute [r] text
+      #   @return [String] Text for the tag
 
-      def initialize(text:, colour: nil, **options)
-        super(**options)
-        @options[:attributes][:class][..8] = "govuk-tag govuk-tag--#{colour}" if colour
+      class Tag < Base
+        private
 
-        @text = text
-      end
+        attr_reader :text
 
-      # Generates the HTML for the GOV.UK Tag component
-      #
-      # @return [ActiveSupport::SafeBuffer]
+        public
 
-      def render
-        tag.strong(text, **options[:attributes])
-      end
+        # @param text [String] the text for the tag
+        # @param colour [String] optional colour for the tag,
+        #                        see {https://design-system.service.gov.uk/components/tag/#additional-colours Tag - Additional colours}
+        #                        for available colours in GOV.UK Frontend
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option options [String] :classes additional CSS classes for the tag HTML
+        # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+
+        def initialize(text:, colour: nil, **options)
+          super(**options)
+          @options[:attributes][:class][..8] = "govuk-tag govuk-tag--#{colour}" if colour
 
-      # The default attributes for the tag
+          @text = text
+        end
 
-      DEFAULT_ATTRIBUTES = { class: 'govuk-tag' }.freeze
+        # Generates the HTML for the GOV.UK Tag component
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.strong(text, **options[:attributes])
+        end
+
+        # The default attributes for the tag
+
+        DEFAULT_ATTRIBUTES = { class: 'govuk-tag' }.freeze
+      end
     end
   end
 end