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

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

@@ -1,57 +1,59 @@
 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
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK Step by step navigation
       #
-      # @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
+      # 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
 
-      def initialize(step_by_step_navigation_sections:, **options)
-        super(**options)
+      class StepByStepNavigation < Base
+        private
 
-        DEFAULT_SHOW_HIDE_TEXT.each { |key, value| @options[:attributes][:data][key] ||= value }
+        attr_reader :step_by_step_navigation_sections
 
-        @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
+        public
 
-      # Generates the HTML for the GOV.UK Step by step navigation component (experimental)
-      #
-      # @return [ActiveSupport::SafeBuffer]
+        # @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 }
 
-      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) }
+          @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
-      end
 
-      # The default attributes for the step byt step navigation
+        # 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_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 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
+        DEFAULT_SHOW_HIDE_TEXT = { 'show-text': 'Show', 'hide-text': 'Hide', 'show-all-text': 'Show all', 'hide-all-text': 'Hide all' }.freeze
+      end
     end
   end
 end

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

@@ -1,55 +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
+module CCS
+  module Components
+    module GovUK
+      class SummaryList < Base
+        class Action
+          # = GOV.UK Summary list action link
           #
-          # @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)
+          # @!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
 
-            @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]
 
-          # 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
+            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
-          end
 
-          # The default attributes for the summary list action link
+            # The default attributes for the summary list action link
 
-          DEFAULT_ATTRIBUTES = { class: 'govuk-link' }.freeze
+            DEFAULT_ATTRIBUTES = { class: 'govuk-link' }.freeze
+          end
         end
       end
     end

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

@@ -1,55 +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
+module CCS
+  module 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
+          class Actions < Base
+            private
 
-          attr_reader :action_links
+            attr_reader :action_links
 
-          public
+            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
+            # @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)
+            def initialize(items:, **options)
+              super(**options)
 
-            @action_links = items.map { |item| Action::Link.new(context: @context, **item) }
-          end
+              @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]
+            # 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'))
+            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
-          end
 
-          # The default attributes for the summary list card actions
+            # The default attributes for the summary list card actions
 
-          DEFAULT_ATTRIBUTES = { class: 'govuk-summary-card__actions' }.freeze
+            DEFAULT_ATTRIBUTES = { class: 'govuk-summary-card__actions' }.freeze
+          end
         end
       end
     end

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

@@ -1,47 +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
+module CCS
+  module Components
+    module GovUK
+      class SummaryList < Base
+        class Card < Base
+          # = GOV.UK Summary list card title
           #
-          # @option options [String] :classes additional CSS classes for the summary list card title HTML
+          # @!attribute [r] text
+          #   @return [String] Text for the title
+          # @!attribute [r] heading_level
+          #   @return [String] Heading level for the title
 
-          def initialize(text:, heading_level: '2', **options)
-            super(**options)
+          class Title < Base
+            private
 
-            @text = text
-            @heading_level = heading_level
-          end
+            attr_reader :text, :heading_level
 
-          # Generates the HTML for the GOV.UK Summary list card title
-          #
-          # @return [ActiveSupport::SafeBuffer]
+            public
 
-          def render
-            tag.send("h#{heading_level}", text, class: @options[:attributes][:class])
-          end
+            # @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)
 
-          # The default attributes for the summary list card title
+              @text = text
+              @heading_level = heading_level
+            end
 
-          DEFAULT_ATTRIBUTES = { class: 'govuk-summary-card__title' }.freeze
+            # 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

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

@@ -2,59 +2,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
+module CCS
+  module Components
+    module GovUK
+      class SummaryList < Base
+        # = GOV.UK Summary card
         #
-        # @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
+        # 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
 
-        def initialize(title: nil, actions: nil, **options)
-          super(**options)
+        class Card < Base
+          private
 
-          @title = Title.new(context: @context, **title) if title
-          @actions = Actions.new(context: @context, **actions) if actions
-        end
+          attr_reader :title, :actions
 
-        # 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))
+          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
-        end
 
-        # The default attributes for the summary card
+          # 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
 
-        DEFAULT_ATTRIBUTES = { class: 'govuk-summary-card' }.freeze
+          # 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

@@ -1,55 +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
+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
+          class Actions < Base
+            private
 
-          attr_reader :action_links
+            attr_reader :action_links
 
-          public
+            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
+            # @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)
+            def initialize(items:, **options)
+              super(**options)
 
-            @action_links = items.map { |item| Action::Link.new(context: @context, **item) }
-          end
+              @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'))
+            # 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
-          end
 
-          # The default attributes for the summary list row actions
+            # The default attributes for the summary list row actions
 
-          DEFAULT_ATTRIBUTES = { class: 'govuk-summary-list__actions' }.freeze
+            DEFAULT_ATTRIBUTES = { class: 'govuk-summary-list__actions' }.freeze
+          end
         end
       end
     end