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

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

@@ -1,43 +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
+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
+          class Key < Base
+            private
 
-          attr_reader :text
+            attr_reader :text
 
-          public
+            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
+            # @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)
+            def initialize(text:, **options)
+              super(**options)
 
-            @text = text
-          end
+              @text = text
+            end
 
-          # Generates the HTML for the GOV.UK Summary list row key
-          #
-          # @return [ActiveSupport::SafeBuffer]
+            # Generates the HTML for the GOV.UK Summary list row key
+            #
+            # @return [ActiveSupport::SafeBuffer]
 
-          def render
-            tag.dt(text, class: @options[:attributes][:class])
-          end
+            def render
+              tag.dt(text, class: @options[:attributes][:class])
+            end
 
-          # The default attributes for the summary list row key
+            # The default attributes for the summary list row key
 
-          DEFAULT_ATTRIBUTES = { class: 'govuk-summary-list__key' }.freeze
+            DEFAULT_ATTRIBUTES = { class: 'govuk-summary-list__key' }.freeze
+          end
         end
       end
     end

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

@@ -1,43 +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
+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
+          class Value < Base
+            private
 
-          attr_reader :text
+            attr_reader :text
 
-          public
+            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
+            # @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)
+            def initialize(text:, **options)
+              super(**options)
 
-            @text = text
-          end
+              @text = text
+            end
 
-          # Generates the HTML for the GOV.UK Summary list row value
-          #
-          # @return [ActiveSupport::SafeBuffer]
+            # Generates the HTML for the GOV.UK Summary list row value
+            #
+            # @return [ActiveSupport::SafeBuffer]
 
-          def render
-            tag.dd(text, class: @options[:attributes][:class])
-          end
+            def render
+              tag.dd(text, class: @options[:attributes][:class])
+            end
 
-          # The default attributes for the summary list row value
+            # The default attributes for the summary list row value
 
-          DEFAULT_ATTRIBUTES = { class: 'govuk-summary-list__value' }.freeze
+            DEFAULT_ATTRIBUTES = { class: 'govuk-summary-list__value' }.freeze
+          end
         end
       end
     end

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

@@ -3,60 +3,62 @@ 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
+module CCS
+  module Components
+    module GovUK
+      class SummaryList < Base
+        # = GOV.UK Summary list row
         #
-        # @option options [String] :classes additional CSS classes for the summary list row HTML
+        # 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
 
-        def initialize(any_row_has_actions:, key:, value:, actions: nil, **options)
-          super(**options)
+        class Row < Base
+          private
 
-          @options[:attributes][:class] << ' govuk-summary-list__row--no-actions' if any_row_has_actions && !actions
+          attr_reader :key, :value, :actions
 
-          @key = Key.new(context: @context, **key)
-          @value = Value.new(context: @context, **value)
-          @actions = Actions.new(context: @context, **actions) if actions
-        end
+          public
 
-        # Generates the HTML for the GOV.UK Summary list row
-        #
-        # @return [ActiveSupport::SafeBuffer]
+          # @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
 
-        def render
-          tag.div(class: options[:attributes][:class]) do
-            concat(key.render)
-            concat(value.render)
-            concat(actions.render) if actions
+            @key = Key.new(context: @context, **key)
+            @value = Value.new(context: @context, **value)
+            @actions = Actions.new(context: @context, **actions) if actions
           end
-        end
 
-        # The default attributes for the summary list row
+          # 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
 
-        DEFAULT_ATTRIBUTES = { class: 'govuk-summary-list__row' }.freeze
+          # 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

@@ -2,69 +2,71 @@ 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
+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
+      class SummaryList < Base
+        private
 
-      attr_reader :summary_list_rows, :card
+        attr_reader :summary_list_rows, :card
 
-      public
+        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
+        # @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)
+        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? }
+          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
+          @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]
+        # Generates the HTML for the GOV.UK Summary list component
+        #
+        # @return [ActiveSupport::SafeBuffer]
 
-      def render
-        if card
-          card.render do
+        def render
+          if card
+            card.render do
+              render_summary_list
+            end
+          else
             render_summary_list
           end
-        else
-          render_summary_list
         end
-      end
 
-      # The default attributes for the summary list
+        # The default attributes for the summary list
 
-      DEFAULT_ATTRIBUTES = { class: 'govuk-summary-list' }.freeze
+        DEFAULT_ATTRIBUTES = { class: 'govuk-summary-list' }.freeze
 
-      private
+        private
 
-      # Generates the HTML for the actual summary list
-      #
-      # @return [ActiveSupport::SafeBuffer]
+        # 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) }
+        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

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

@@ -1,49 +1,51 @@
 require_relative '../../../base'
 
-module CCS::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
+module CCS
+  module Components
+    module GovUK
+      class Table < Base
+        class Body
+          # = GOV.UK Table Body data cell
           #
-          # @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
+          # The individual table body data cell
+          #
+          # @!attribute [r] text
+          #   @return [String] Text for the cell
 
-          def initialize(text:, **options)
-            super(**options)
+          class DataCell < Base
+            private
 
-            @options[:attributes][:class] += " govuk-table__cell--#{@options[:format]}" if @options[:format]
+            attr_reader :text
 
-            @text = text
-          end
+            public
 
-          # Generates the HTML for the GOV.UK Table Body data cell
-          #
-          # @return [ActiveSupport::SafeBuffer]
+            # @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 render
-            tag.td(text, **options[:attributes])
-          end
+            def initialize(text:, **options)
+              super(**options)
+
+              @options[:attributes][:class] += " govuk-table__cell--#{@options[:format]}" if @options[:format]
 
-          # The default attributes for the table body data cell
+              @text = text
+            end
 
-          DEFAULT_ATTRIBUTES = { class: 'govuk-table__cell' }.freeze
+            # 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

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

@@ -1,48 +1,50 @@
 require_relative '../../../base'
 
-module CCS::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
+module CCS
+  module Components
+    module GovUK
+      class Table < Base
+        class Body
+          # = GOV.UK Table Body head cell
           #
-          # @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
+          # The individual table body head cell
+          #
+          # @!attribute [r] text
+          #   @return [String] Text for the cell
 
-          def initialize(text:, **options)
-            super(**options)
+          class HeadCell < Base
+            private
 
-            @options[:attributes][:scope] = 'row'
+            attr_reader :text
 
-            @text = text
-          end
+            public
 
-          # Generates the HTML for the GOV.UK Table Body head cell
-          #
-          # @return [ActiveSupport::SafeBuffer]
+            # @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 render
-            tag.th(text, **options[:attributes])
-          end
+            def initialize(text:, **options)
+              super(**options)
+
+              @options[:attributes][:scope] = 'row'
 
-          # The default attributes for the table body head cell
+              @text = text
+            end
 
-          DEFAULT_ATTRIBUTES = { class: 'govuk-table__header' }.freeze
+            # 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

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

@@ -1,50 +1,52 @@
 require_relative '../../../base'
 
-module CCS::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
+module CCS
+  module Components
+    module GovUK
+      class Table < Base
+        class Header
+          # = GOV.UK Table Header head cell
           #
-          # @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
+          # The individual table header head cell
+          #
+          # @!attribute [r] text
+          #   @return [String] Text for the cell
 
-          def initialize(text:, **options)
-            super(**options)
+          class HeadCell < Base
+            private
 
-            @options[:attributes][:class] += " govuk-table__header--#{@options[:format]}" if @options[:format]
-            @options[:attributes][:scope] = 'col'
+            attr_reader :text
 
-            @text = text
-          end
+            public
 
-          # Generates the HTML for the GOV.UK Table Header head cell
-          #
-          # @return [ActiveSupport::SafeBuffer]
+            # @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 render
-            tag.th(text, **options[:attributes])
-          end
+            def initialize(text:, **options)
+              super(**options)
+
+              @options[:attributes][:class] += " govuk-table__header--#{@options[:format]}" if @options[:format]
+              @options[:attributes][:scope] = 'col'
 
-          # The default attributes for the table header head cell
+              @text = text
+            end
 
-          DEFAULT_ATTRIBUTES = { class: 'govuk-table__header' }.freeze
+            # 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