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

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

@@ -1,49 +1,51 @@
 require_relative '../base'
 
-module CCS::Components
-  module GovUK
-    # = GOV.UK Skip Link
-    #
-    # This is used to generate the skip link component from the
-    # {https://design-system.service.gov.uk/components/skip-link GDS - Components - Skip link}
-    #
-    # @!attribute [r] text
-    #   @return [String] Text for the skip link
-    # @!attribute [r] href
-    #   @return [String] The href for the skip link
-
-    class SkipLink < Base
-      private
-
-      attr_reader :text, :href
-
-      public
-
-      # @param text [String] the text for the skip link
-      # @param href [String] the href for the skip link
-      # @param options [Hash] options that will be used in customising the HTML
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK Skip Link
       #
-      # @option options [String] :classes additional CSS classes for the skip link HTML
-      # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+      # This is used to generate the skip link component from the
+      # {https://design-system.service.gov.uk/components/skip-link GDS - Components - Skip link}
+      #
+      # @!attribute [r] text
+      #   @return [String] Text for the skip link
+      # @!attribute [r] href
+      #   @return [String] The href for the skip link
 
-      def initialize(text:, href: nil, **options)
-        super(**options)
+      class SkipLink < Base
+        private
 
-        @text = text
-        @href = href || '#content'
-      end
+        attr_reader :text, :href
 
-      # Generates the HTML for the GOV.UK Skip link component
-      #
-      # @return [ActiveSupport::SafeBuffer]
+        public
 
-      def render
-        link_to(text, href, **options[:attributes])
-      end
+        # @param text [String] the text for the skip link
+        # @param href [String] the href for the skip link
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option options [String] :classes additional CSS classes for the skip link HTML
+        # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+
+        def initialize(text:, href: nil, **options)
+          super(**options)
 
-      # The default attributes for the skip link
+          @text = text
+          @href = href || '#content'
+        end
 
-      DEFAULT_ATTRIBUTES = { class: 'govuk-skip-link', data: { module: 'govuk-skip-link' } }.freeze
+        # Generates the HTML for the GOV.UK Skip link component
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          link_to(text, href, **options[:attributes])
+        end
+
+        # The default attributes for the skip link
+
+        DEFAULT_ATTRIBUTES = { class: 'govuk-skip-link', data: { module: 'govuk-skip-link' } }.freeze
+      end
     end
   end
 end

data/lib/ccs/components/govuk/step_by_step_navigation/section/content/list/item.rb

@@ -1,45 +1,47 @@
 require 'action_view'
 
-module CCS::Components
-  module GovUK
-    class StepByStepNavigation < Base
-      class Section < Base
-        class Content
-          class List
-            # = GOV.UK Step by step navigation section content list item
-            #
-            # Generates the list item HTML for the step by step navigation section content
-            #
-            # @!attribute [r] text
-            #   @return [String] Text for the list item
-            # @!attribute [r] classes
-            #   @return [String] HTML classes for the list item
-
-            class Item
-              include ActionView::Context
-              include ActionView::Helpers
-
-              private
-
-              attr_reader :text, :classes
-
-              public
-
-              # @param text [String] the text for the list item
-              # @param no_marker [Boolean] flag to hide the bullet marker
-
-              def initialize(text:, no_marker: nil)
-                @text = text
-                @classes = "gem-c-step-nav__list-item js-list-item #{'gem-c-step-nav__list--no-marker' if no_marker}".rstrip
-              end
-
-              # Generates the HTML for an individual the GOV.UK Step by step navigation list item
+module CCS
+  module Components
+    module GovUK
+      class StepByStepNavigation < Base
+        class Section < Base
+          class Content
+            class List
+              # = GOV.UK Step by step navigation section content list item
+              #
+              # Generates the list item HTML for the step by step navigation section content
               #
-              # @return [ActiveSupport::SafeBuffer]
+              # @!attribute [r] text
+              #   @return [String] Text for the list item
+              # @!attribute [r] classes
+              #   @return [String] HTML classes for the list item
+
+              class Item
+                include ActionView::Context
+                include ActionView::Helpers
+
+                private
+
+                attr_reader :text, :classes
+
+                public
+
+                # @param text [String] the text for the list item
+                # @param no_marker [Boolean] flag to hide the bullet marker
+
+                def initialize(text:, no_marker: nil)
+                  @text = text
+                  @classes = "gem-c-step-nav__list-item js-list-item #{'gem-c-step-nav__list--no-marker' if no_marker}".rstrip
+                end
+
+                # Generates the HTML for an individual the GOV.UK Step by step navigation list item
+                #
+                # @return [ActiveSupport::SafeBuffer]
 
-              def render
-                tag.li(class: classes) do
-                  tag.span(text)
+                def render
+                  tag.li(class: classes) do
+                    tag.span(text)
+                  end
                 end
               end
             end

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

@@ -2,42 +2,44 @@ require 'action_view'
 
 require_relative 'list/item'
 
-module CCS::Components
-  module GovUK
-    class StepByStepNavigation < Base
-      class Section < Base
-        class Content
-          # = GOV.UK Step by step navigation section content list
-          #
-          # Generates the list HTML for the step by step navigation section content
-          #
-          # @!attribute [r] items
-          #   @return [Item] Array of initialised list items
+module CCS
+  module Components
+    module GovUK
+      class StepByStepNavigation < Base
+        class Section < Base
+          class Content
+            # = GOV.UK Step by step navigation section content list
+            #
+            # Generates the list HTML for the step by step navigation section content
+            #
+            # @!attribute [r] items
+            #   @return [Item] Array of initialised list items
 
-          class List
-            include ActionView::Context
-            include ActionView::Helpers
+            class List
+              include ActionView::Context
+              include ActionView::Helpers
 
-            private
+              private
 
-            attr_reader :items
+              attr_reader :items
 
-            public
+              public
 
-            # @param items [Array<Hash>] An array of options for the list items
-            #                            See {Components::GovUK::StepByStepNavigation::Section::Content::List::Item#initialize Item#initialize} for details of the items in the array.
+              # @param items [Array<Hash>] An array of options for the list items
+              #                            See {Components::GovUK::StepByStepNavigation::Section::Content::List::Item#initialize Item#initialize} for details of the items in the array.
 
-            def initialize(items:)
-              @items = items.map { |item| Item.new(**item) }
-            end
+              def initialize(items:)
+                @items = items.map { |item| Item.new(**item) }
+              end
 
-            # Generates the HTML for the GOV.UK Step by step navigation section content list
-            #
-            # @return [ActiveSupport::SafeBuffer]
+              # Generates the HTML for the GOV.UK Step by step navigation section content list
+              #
+              # @return [ActiveSupport::SafeBuffer]
 
-            def render
-              tag.ul(class: 'gem-c-step-nav__list gem-c-step-nav__list--choice', data: { length: items.length.to_s }) do
-                items.each { |item| concat(item.render) }
+              def render
+                tag.ul(class: 'gem-c-step-nav__list gem-c-step-nav__list--choice', data: { length: items.length.to_s }) do
+                  items.each { |item| concat(item.render) }
+                end
               end
             end
           end

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

@@ -1,39 +1,41 @@
 require 'action_view'
 
-module CCS::Components
-  module GovUK
-    class StepByStepNavigation < Base
-      class Section < Base
-        class Content
-          # = GOV.UK Step by step navigation section content paragraph
-          #
-          # Generates the paragraph HTML for the step by step navigation section content
-          #
-          # @!attribute [r] text
-          #   @return [String] Text for the paragraph
+module CCS
+  module Components
+    module GovUK
+      class StepByStepNavigation < Base
+        class Section < Base
+          class Content
+            # = GOV.UK Step by step navigation section content paragraph
+            #
+            # Generates the paragraph HTML for the step by step navigation section content
+            #
+            # @!attribute [r] text
+            #   @return [String] Text for the paragraph
 
-          class Paragraph
-            include ActionView::Context
-            include ActionView::Helpers
+            class Paragraph
+              include ActionView::Context
+              include ActionView::Helpers
 
-            private
+              private
 
-            attr_reader :text
+              attr_reader :text
 
-            public
+              public
 
-            # @param text [String] the text for the paragraph
+              # @param text [String] the text for the paragraph
 
-            def initialize(text:)
-              @text = text
-            end
+              def initialize(text:)
+                @text = text
+              end
 
-            # Generates the HTML for the GOV.UK Step by step navigation section content paragraph
-            #
-            # @return [ActiveSupport::SafeBuffer]
+              # Generates the HTML for the GOV.UK Step by step navigation section content paragraph
+              #
+              # @return [ActiveSupport::SafeBuffer]
 
-            def render
-              tag.p(text, class: 'gem-c-step-nav__paragraph')
+              def render
+                tag.p(text, class: 'gem-c-step-nav__paragraph')
+              end
             end
           end
         end

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

@@ -3,55 +3,57 @@ require 'action_view'
 require_relative 'content/list'
 require_relative 'content/paragraph'
 
-module CCS::Components
-  module GovUK
-    class StepByStepNavigation < Base
-      class Section < Base
-        # = GOV.UK Step by step navigation section content
-        #
-        # The content for a navigation section
-        #
-        # @!attribute [r] section_id
-        #   @return [String] ID for the section content
-        # @!attribute [r] content_items
-        #   @return [Array<Paragraph|List>] An array of the initialised content items
-
-        class Content
-          include ActionView::Context
-          include ActionView::Helpers
-
-          private
-
-          attr_reader :section_id, :content_items
-
-          public
-
-          # @param content_items [Array<Hash>] array of content items.
-          #                                  If the type is +:paragraph+, see {Components::GovUK::StepByStepNavigation::Section::Content::Paragraph#initialize Paragraph#initialize}.
-          #                                  If the type is +:list+, see {Components::GovUK::StepByStepNavigation::Section::Content::List#initialize List#initialize}.
-          # @param index [String] the index of the section
-          # @param id [String] the id of the section
-
-          def initialize(content_items:, index:, id:)
-            @section_id = "step-panel-#{id}-#{index}"
-
-            @content_items = content_items.map do |content_item|
-              case content_item[:type]
-              when :paragraph
-                Paragraph.new(text: content_item[:text])
-              when :list
-                List.new(items: content_item[:items])
+module CCS
+  module Components
+    module GovUK
+      class StepByStepNavigation < Base
+        class Section < Base
+          # = GOV.UK Step by step navigation section content
+          #
+          # The content for a navigation section
+          #
+          # @!attribute [r] section_id
+          #   @return [String] ID for the section content
+          # @!attribute [r] content_items
+          #   @return [Array<Paragraph|List>] An array of the initialised content items
+
+          class Content
+            include ActionView::Context
+            include ActionView::Helpers
+
+            private
+
+            attr_reader :section_id, :content_items
+
+            public
+
+            # @param content_items [Array<Hash>] array of content items.
+            #                                  If the type is +:paragraph+, see {Components::GovUK::StepByStepNavigation::Section::Content::Paragraph#initialize Paragraph#initialize}.
+            #                                  If the type is +:list+, see {Components::GovUK::StepByStepNavigation::Section::Content::List#initialize List#initialize}.
+            # @param index [String] the index of the section
+            # @param id [String] the id of the section
+
+            def initialize(content_items:, index:, id:)
+              @section_id = "step-panel-#{id}-#{index}"
+
+              @content_items = content_items.map do |content_item|
+                case content_item[:type]
+                when :paragraph
+                  Paragraph.new(text: content_item[:text])
+                when :list
+                  List.new(items: content_item[:items])
+                end
               end
             end
-          end
 
-          # Generates the HTML for the GOV.UK Step by step navigation section content
-          #
-          # @return [ActiveSupport::SafeBuffer]
+            # Generates the HTML for the GOV.UK Step by step navigation section content
+            #
+            # @return [ActiveSupport::SafeBuffer]
 
-          def render
-            tag.div(class: 'gem-c-step-nav__panel js-panel', id: section_id) do
-              content_items.each { |content_item| concat(content_item.render) }
+            def render
+              tag.div(class: 'gem-c-step-nav__panel js-panel', id: section_id) do
+                content_items.each { |content_item| concat(content_item.render) }
+              end
             end
           end
         end

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

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

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

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