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

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

@@ -1,57 +1,58 @@
-require_relative '../../base'
 require_relative 'section/header'
 require_relative 'section/content'
 
-module CCS::Components
-  module GovUK
-    class Accordion < Base
-      # = GOV.UK Accordion Section
-      #
-      # The individual accordion section
-      #
-      # @!attribute [r] header
-      #   @return [Header] Initialised accordion section header
-      # @!attribute [r] content
-      #   @return [Content] Initialised accordion section content
-      # @!attribute [r] section_is_expanded
-      #   @return [Boolean] flag to indicate of the section should be expanded
-
-      class Section
-        include ActionView::Context
-        include ActionView::Helpers
-
-        private
-
-        attr_reader :header, :content, :section_is_expanded
-
-        public
-
-        # @param section [Hash] attributes for the accordion section
-        # @param accordion_id [String] ID of the accordion
-        # @param index [Integer] the index of the accordion section
-        # @param heading_level [Integer] heading level, from 1 to 6
+module CCS
+  module Components
+    module GovUK
+      class Accordion < Base
+        # = GOV.UK Accordion Section
         #
-        # @option section [Boolean] :expanded sets whether the section should be expanded
-        #                                     when the page loads for the first time.
-        # @option section [String] :heading the heading text for the accordion
-        # @option section [String] :summary (nil) optional summary text for the accordion header
-        # @option section [ActiveSupport::SafeBuffer] :content the content within the accordion section
-        # @option section [String] : text if +:content+ is +nil+ then the text will be rendered
-
-        def initialize(section:, accordion_id:, index:, heading_level:)
-          @section_is_expanded = section[:expanded]
-          @header = Header.new(section: section, accordion_id: accordion_id, index: index, heading_level: heading_level)
-          @content = Content.new(section: section, accordion_id: accordion_id, index: index)
-        end
-
-        # Generates the HTML for the GOV.UK Accordion Section
+        # The individual accordion section
         #
-        # @return [ActiveSupport::SafeBuffer]
+        # @!attribute [r] header
+        #   @return [Header] Initialised accordion section header
+        # @!attribute [r] content
+        #   @return [Content] Initialised accordion section content
+        # @!attribute [r] section_is_expanded
+        #   @return [Boolean] flag to indicate of the section should be expanded
+
+        class Section
+          include ActionView::Context
+          include ActionView::Helpers
+
+          private
+
+          attr_reader :header, :content, :section_is_expanded
+
+          public
+
+          # @param section [Hash] attributes for the accordion section
+          # @param accordion_id [String] ID of the accordion
+          # @param index [Integer] the index of the accordion section
+          # @param heading_level [Integer] heading level, from 1 to 6
+          #
+          # @option section [Boolean] :expanded sets whether the section should be expanded
+          #                                     when the page loads for the first time.
+          # @option section [String] :heading the heading text for the accordion
+          # @option section [String] :summary (nil) optional summary text for the accordion header
+          # @option section [ActiveSupport::SafeBuffer] :content the content within the accordion section
+          # @option section [String] : text if +:content+ is +nil+ then the text will be rendered
+
+          def initialize(section:, accordion_id:, index:, heading_level:)
+            @section_is_expanded = section[:expanded]
+            @header = Header.new(section: section, accordion_id: accordion_id, index: index, heading_level: heading_level)
+            @content = Content.new(section: section, accordion_id: accordion_id, index: index)
+          end
+
+          # Generates the HTML for the GOV.UK Accordion Section
+          #
+          # @return [ActiveSupport::SafeBuffer]
 
-        def render
-          tag.div(class: "govuk-accordion__section #{'govuk-accordion__section--expanded' if section_is_expanded}".rstrip) do
-            concat(header.render)
-            concat(content.render)
+          def render
+            tag.div(class: "govuk-accordion__section #{'govuk-accordion__section--expanded' if section_is_expanded}".rstrip) do
+              concat(header.render)
+              concat(content.render)
+            end
           end
         end
       end

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

@@ -1,56 +1,58 @@
 require_relative '../base'
 require_relative 'accordion/section'
 
-module CCS::Components
-  module GovUK
-    # = GOV.UK Accordion
-    #
-    # This is used for generating the accordion component from the
-    # {https://design-system.service.gov.uk/accordion/back-link GDS - Components - Accordion}
-    #
-    # @!attribute [r] accordion_sections
-    #   @return [Array<Section>] An array of the initialised accordion sections
-
-    class Accordion < Base
-      private
-
-      attr_reader :accordion_sections
-
-      public
-
-      # @param accordion_id [String] used as an id in the HTML for the accordion as a whole,
-      #                              and also as a prefix for the ids of the section contents
-      #                              and the buttons that open them
-      # @param accordion_sections [Array<Hash>] an array of accordion section attributes.
-      #                                         See {Components::GovUK::Accordion::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 Accordion
       #
-      # @option options [String] :classes additional CSS classes for the accordion HTML
-      # @option options [Integer] :heading_level (2) heading level, from 1 to 6
-      # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+      # This is used for generating the accordion component from the
+      # {https://design-system.service.gov.uk/accordion/back-link GDS - Components - Accordion}
+      #
+      # @!attribute [r] accordion_sections
+      #   @return [Array<Section>] An array of the initialised accordion sections
 
-      def initialize(accordion_id:, accordion_sections:, **options)
-        super(**options)
+      class Accordion < Base
+        private
 
-        @options[:attributes][:id] = accordion_id
-        @options[:heading_level] ||= 2
+        attr_reader :accordion_sections
 
-        @accordion_sections = accordion_sections.map.with_index(1) { |accordion_section, index| Section.new(section: accordion_section, accordion_id: accordion_id, index: index, heading_level: @options[:heading_level]) }
-      end
+        public
 
-      # Generates the HTML for the GOV.UK Accordion component
-      #
-      # @return [ActiveSupport::SafeBuffer]
+        # @param accordion_id [String] used as an id in the HTML for the accordion as a whole,
+        #                              and also as a prefix for the ids of the section contents
+        #                              and the buttons that open them
+        # @param accordion_sections [Array<Hash>] an array of accordion section attributes.
+        #                                         See {Components::GovUK::Accordion::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 accordion HTML
+        # @option options [Integer] :heading_level (2) heading level, from 1 to 6
+        # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+
+        def initialize(accordion_id:, accordion_sections:, **options)
+          super(**options)
+
+          @options[:attributes][:id] = accordion_id
+          @options[:heading_level] ||= 2
 
-      def render
-        tag.div(**options[:attributes]) do
-          accordion_sections.each { |accordion_section| concat(accordion_section.render) }
+          @accordion_sections = accordion_sections.map.with_index(1) { |accordion_section, index| Section.new(section: accordion_section, accordion_id: accordion_id, index: index, heading_level: @options[:heading_level]) }
         end
-      end
 
-      # The default attributes for the accordion
+        # Generates the HTML for the GOV.UK Accordion component
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.div(**options[:attributes]) do
+            accordion_sections.each { |accordion_section| concat(accordion_section.render) }
+          end
+        end
 
-      DEFAULT_ATTRIBUTES = { class: 'govuk-accordion', data: { module: 'govuk-accordion' } }.freeze
+        # The default attributes for the accordion
+
+        DEFAULT_ATTRIBUTES = { class: 'govuk-accordion', data: { module: 'govuk-accordion' } }.freeze
+      end
     end
   end
 end

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

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

data/lib/ccs/components/govuk/breadcrumbs/link.rb

@@ -1,52 +1,54 @@
 require_relative '../../base'
 
-module CCS::Components
-  module GovUK
-    class Breadcrumbs < Base
-      # = GOV.UK Breadcrumbs Link
-      #
-      # The individual list item for the breadcrumbs
-      #
-      # @!attribute [r] text
-      #   @return [String] Text for the breadcrumb link
-      # @!attribute [r] href
-      #   @return [String] The href for the breadcrumb link
-
-      class Link < Base
-        private
-
-        attr_reader :text, :href
-
-        public
-
-        # @param text [String] the text for the breadcrumb link
-        # @param href [String] the href for the breadcrumb link.
-        #                      If blank it is assumed that this item relates to current page
-        # @param options [Hash] options that will be used in customising the HTML
+module CCS
+  module Components
+    module GovUK
+      class Breadcrumbs < Base
+        # = GOV.UK Breadcrumbs Link
         #
-        # @option options [Hash] :attributes any additional attributes that will added as part of the HTML.
-        #                                    If the link is blank then it defaults to +{ aria: { current: 'page' } }+
+        # The individual list item for the breadcrumbs
+        #
+        # @!attribute [r] text
+        #   @return [String] Text for the breadcrumb link
+        # @!attribute [r] href
+        #   @return [String] The href for the breadcrumb link
 
-        def initialize(text:, href: nil, **options)
-          super(**options)
+        class Link < Base
+          private
 
-          @text = text
-          @href = href
-        end
+          attr_reader :text, :href
 
-        # Generates the HTML for the GOV.UK Breadcrumbs link
-        #
-        # @return [ActiveSupport::SafeBuffer]
+          public
+
+          # @param text [String] the text for the breadcrumb link
+          # @param href [String] the href for the breadcrumb link.
+          #                      If blank it is assumed that this item relates to current page
+          # @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.
+          #                                    If the link is blank then it defaults to +{ aria: { current: 'page' } }+
+
+          def initialize(text:, href: nil, **options)
+            super(**options)
+
+            @text = text
+            @href = href
+          end
+
+          # Generates the HTML for the GOV.UK Breadcrumbs link
+          #
+          # @return [ActiveSupport::SafeBuffer]
 
-        def render
-          if href.present?
-            options[:attributes][:class] = 'govuk-breadcrumbs__link'
+          def render
+            if href.present?
+              options[:attributes][:class] = 'govuk-breadcrumbs__link'
 
-            tag.li(class: 'govuk-breadcrumbs__list-item') do
-              link_to(text, href, **options[:attributes])
+              tag.li(class: 'govuk-breadcrumbs__list-item') do
+                link_to(text, href, **options[:attributes])
+              end
+            else
+              tag.li(text, class: 'govuk-breadcrumbs__list-item', aria: { current: 'page' })
             end
-          else
-            tag.li(text, class: 'govuk-breadcrumbs__list-item', aria: { current: 'page' })
           end
         end
       end

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

@@ -1,53 +1,55 @@
 require_relative '../base'
 require_relative 'breadcrumbs/link'
 
-module CCS::Components
-  module GovUK
-    # = GOV.UK Breadcrumbs
-    #
-    # This is used to generate the breadcrumbs component from the
-    # {https://design-system.service.gov.uk/components/breadcrumbs GDS - Components - Breadcrumbs}
-    #
-    # @!attribute [r] breadcrumb_links
-    #   @return [Array<Link>] An array of the initialised breadcrumb links
-
-    class Breadcrumbs < Base
-      private
-
-      attr_reader :breadcrumb_links
-
-      public
-
-      # @param breadcrumb_links [Array<Hash>] An array of links for the breadcrumbs list.
-      #                                       See {Components::GovUK::Breadcrumbs::Link#initialize Link#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 Breadcrumbs
       #
-      # @option options [String] :classes additional CSS classes for the breadcrumbs HTML
-      # @option options [Boolean] :collapse_on_mobile indicates if it is to colapse breadcrumbs on mobile
-      # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+      # This is used to generate the breadcrumbs component from the
+      # {https://design-system.service.gov.uk/components/breadcrumbs GDS - Components - Breadcrumbs}
+      #
+      # @!attribute [r] breadcrumb_links
+      #   @return [Array<Link>] An array of the initialised breadcrumb links
 
-      def initialize(breadcrumb_links:, **options)
-        super(**options)
-        @options[:attributes][:class] << ' govuk-breadcrumbs--collapse-on-mobile' if @options[:collapse_on_mobile]
+      class Breadcrumbs < Base
+        private
 
-        @breadcrumb_links = breadcrumb_links.map { |breadcrumb_link| Link.new(context: @context, **breadcrumb_link) }
-      end
+        attr_reader :breadcrumb_links
 
-      # Generates the HTML for the GOV.UK breadcrumbs component
-      #
-      # @return [ActiveSupport::SafeBuffer]
+        public
+
+        # @param breadcrumb_links [Array<Hash>] An array of links for the breadcrumbs list.
+        #                                       See {Components::GovUK::Breadcrumbs::Link#initialize 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 breadcrumbs HTML
+        # @option options [Boolean] :collapse_on_mobile indicates if it is to colapse breadcrumbs on mobile
+        # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+
+        def initialize(breadcrumb_links:, **options)
+          super(**options)
+          @options[:attributes][:class] << ' govuk-breadcrumbs--collapse-on-mobile' if @options[:collapse_on_mobile]
 
-      def render
-        tag.div(**options[:attributes]) do
-          tag.ol(class: 'govuk-breadcrumbs__list') do
-            breadcrumb_links.each { |breadcrumb_link| concat(breadcrumb_link.render) }
+          @breadcrumb_links = breadcrumb_links.map { |breadcrumb_link| Link.new(context: @context, **breadcrumb_link) }
+        end
+
+        # Generates the HTML for the GOV.UK breadcrumbs component
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.div(**options[:attributes]) do
+            tag.ol(class: 'govuk-breadcrumbs__list') do
+              breadcrumb_links.each { |breadcrumb_link| concat(breadcrumb_link.render) }
+            end
           end
         end
-      end
 
-      # The default attributes for the breadcrumbs
+        # The default attributes for the breadcrumbs
 
-      DEFAULT_ATTRIBUTES = { class: 'govuk-breadcrumbs' }.freeze
+        DEFAULT_ATTRIBUTES = { class: 'govuk-breadcrumbs' }.freeze
+      end
     end
   end
 end