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

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

@@ -1,41 +1,43 @@
 require_relative '../item'
 
-module CCS::Components
-  module GovUK
-    class Pagination < Base
-      class Item < Base
-        # = GOV.UK Pagination Item tag
-        #
-        # This generates the HTML for the pagination item using a link tag
-        #
-        # @!attribute [r] href
-        #   @return [String] URL for the pagination item
-
-        class Tag < Item
-          private
-
-          attr_reader :href
-
-          public
-
-          # @param (see CCS::Components::GovUK::Pagination::Item)
-          # @param href [String] the URL for the pagination item
+module CCS
+  module Components
+    module GovUK
+      class Pagination < Base
+        class Item < Base
+          # = GOV.UK Pagination Item tag
           #
-          # @option (see CCS::Components::GovUK::Pagination::Item)
+          # This generates the HTML for the pagination item using a link tag
+          #
+          # @!attribute [r] href
+          #   @return [String] URL for the pagination item
 
-          def initialize(href:, **options)
-            super(**options)
+          class Tag < Item
+            private
 
-            @href = href
-          end
+            attr_reader :href
 
-          # Generates the HTML for the GOV.UK Pagination item link
-          #
-          # @return [ActiveSupport::SafeBuffer]
+            public
+
+            # @param (see CCS::Components::GovUK::Pagination::Item)
+            # @param href [String] the URL for the pagination item
+            #
+            # @option (see CCS::Components::GovUK::Pagination::Item)
+
+            def initialize(href:, **options)
+              super(**options)
+
+              @href = href
+            end
+
+            # Generates the HTML for the GOV.UK Pagination item link
+            #
+            # @return [ActiveSupport::SafeBuffer]
 
-          def render
-            super() do
-              link_to(number, href, **@options[:attributes])
+            def render
+              super() do
+                link_to(number, href, **@options[:attributes])
+              end
             end
           end
         end

data/lib/ccs/components/govuk/pagination/item.rb

@@ -1,61 +1,63 @@
 require_relative '../../base'
 
-module CCS::Components
-  module GovUK
-    class Pagination < Base
-      # = GOV.UK Pagination Item
-      #
-      # This generates the HTML for the pagination item
-      #
-      # @!attribute [r] number
-      #   @return [String] The number for the item
-      # @!attribute [r] li_classes
-      #   @return [String] HTML classes for pagination item +li+ element
-
-      class Item < Base
-        private
-
-        attr_reader :number, :li_classes
-
-        public
-
-        # @param number [String] the number for the item
-        # @param current [Boolean] flag to indicate if this item is the current page
+module CCS
+  module Components
+    module GovUK
+      class Pagination < Base
+        # = GOV.UK Pagination Item
         #
-        # @option options [String] :classes additional CSS classes for the item HTML
-        # @option options [Symbol] :type the type of item. If the value is +:ellipsis+ then an ellipsis will be rendered
-        # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+        # This generates the HTML for the pagination item
+        #
+        # @!attribute [r] number
+        #   @return [String] The number for the item
+        # @!attribute [r] li_classes
+        #   @return [String] HTML classes for pagination item +li+ element
 
-        def initialize(number:, current: false, **options)
-          super(**options)
+        class Item < Base
+          private
 
-          @number = number
+          attr_reader :number, :li_classes
 
-          (@options[:attributes][:aria] ||= {})[:label] ||= "Page #{@number}"
+          public
 
-          li_classes = 'govuk-pagination__item'
+          # @param number [String] the number for the item
+          # @param current [Boolean] flag to indicate if this item is the current page
+          #
+          # @option options [String] :classes additional CSS classes for the item HTML
+          # @option options [Symbol] :type the type of item. If the value is +:ellipsis+ then an ellipsis will be rendered
+          # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
 
-          if current
-            li_classes << ' govuk-pagination__item--current'
-            @options[:attributes][:aria][:current] = 'page'
-          end
+          def initialize(number:, current: false, **options)
+            super(**options)
 
-          @li_classes = li_classes
-        end
+            @number = number
 
-        # Generates the HTML for the GOV.UK Pagination item
-        #
-        # @yield the HTML for the pagination item link/button
-        #
-        # @return [ActiveSupport::SafeBuffer]
+            (@options[:attributes][:aria] ||= {})[:label] ||= "Page #{@number}"
 
-        def render(&block)
-          tag.li(class: li_classes, &block)
-        end
+            li_classes = 'govuk-pagination__item'
 
-        # The default attributes for the pagination link
+            if current
+              li_classes << ' govuk-pagination__item--current'
+              @options[:attributes][:aria][:current] = 'page'
+            end
 
-        DEFAULT_ATTRIBUTES = { class: 'govuk-link govuk-pagination__link' }.freeze
+            @li_classes = li_classes
+          end
+
+          # Generates the HTML for the GOV.UK Pagination item
+          #
+          # @yield the HTML for the pagination item link/button
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render(&block)
+            tag.li(class: li_classes, &block)
+          end
+
+          # The default attributes for the pagination link
+
+          DEFAULT_ATTRIBUTES = { class: 'govuk-link govuk-pagination__link' }.freeze
+        end
       end
     end
   end

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

@@ -5,89 +5,91 @@ require_relative 'pagination/item/ellipsis'
 require_relative 'pagination/item/tag'
 require_relative 'pagination/item/form'
 
-module CCS::Components
-  module GovUK
-    # = GOV.UK Pagination
-    #
-    # This helper is used for generating the pagination component from the
-    # {https://design-system.service.gov.uk/components/pagination GDS - Components - Pagination}
-    #
-    # @!attribute [r] pagination_previous
-    #   @return [Increment::Previous] Initialised pagination previous
-    # @!attribute [r] pagination_items
-    #   @return [Array<Item::Ellipsis|Item::Tag|Item::Form>] An array of the initialised pagination items
-    # @!attribute [r] pagination_next
-    #   @return [Increment::Next] Initialised pagination next
-
-    class Pagination < Base
-      private
-
-      attr_reader :pagination_previous, :pagination_items, :pagination_next
-
-      public
-
-      # rubocop:disable Metrics/CyclomaticComplexity
-
-      # @param pagination_previous [Hash] attributes for the pagination previous, see {CCS::Components::GovUK::Pagination::Increment::Previous#initialize Previous#initialize} for more details.
-      # @param pagination_items [Array<Hash>] An array of options for the pagination items.
-      #                                       See {CCS::Components::GovUK::Pagination::Item::Tag#initialize Item::Tag#initialize} and
-      #                                       {CCS::Components::GovUK::Pagination::Item::Form#initialize Item::Form#initialize} for details of the items in the array.
-      # @param pagination_next [Hash] attributes for the pagination next, see {CCS::Components::GovUK::Pagination::Increment::Next#initialize Next#initialize} for more details.
-      # @param options [Hash] options that will be used in customising the HTML
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK Pagination
       #
-      # @option options [String] :classes additional CSS classes for the pagination HTML
-      # @option options [ActionView::Helpers::FormBuilder] :form form builder used to create pagination buttons
-      # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+      # This helper is used for generating the pagination component from the
+      # {https://design-system.service.gov.uk/components/pagination GDS - Components - Pagination}
+      #
+      # @!attribute [r] pagination_previous
+      #   @return [Increment::Previous] Initialised pagination previous
+      # @!attribute [r] pagination_items
+      #   @return [Array<Item::Ellipsis|Item::Tag|Item::Form>] An array of the initialised pagination items
+      # @!attribute [r] pagination_next
+      #   @return [Increment::Next] Initialised pagination next
 
-      def initialize(pagination_previous: nil, pagination_items: nil, pagination_next: nil, **options)
-        super(**options)
+      class Pagination < Base
+        private
 
-        block_is_level = pagination_items.blank? && (pagination_previous.present? || pagination_next.present?)
+        attr_reader :pagination_previous, :pagination_items, :pagination_next
 
-        @options[:attributes][:class] << ' govuk-pagination--block' if block_is_level
-        @options[:attributes][:role] = 'navigation'
-        (@options[:attributes][:aria] ||= {})[:label] ||= 'results'
+        public
 
-        @pagination_previous = Increment::Previous.new(block_is_level: block_is_level, form: @options[:form], context: @context, **pagination_previous) if pagination_previous
-        @pagination_next = Increment::Next.new(block_is_level: block_is_level, form: @options[:form], context: @context, **pagination_next) if pagination_next
-        initialize_pagination_items(pagination_items, @options[:form])
-      end
+        # rubocop:disable Metrics/CyclomaticComplexity
 
-      # rubocop:enable Metrics/CyclomaticComplexity
+        # @param pagination_previous [Hash] attributes for the pagination previous, see {CCS::Components::GovUK::Pagination::Increment::Previous#initialize Previous#initialize} for more details.
+        # @param pagination_items [Array<Hash>] An array of options for the pagination items.
+        #                                       See {CCS::Components::GovUK::Pagination::Item::Tag#initialize Item::Tag#initialize} and
+        #                                       {CCS::Components::GovUK::Pagination::Item::Form#initialize Item::Form#initialize} for details of the items in the array.
+        # @param pagination_next [Hash] attributes for the pagination next, see {CCS::Components::GovUK::Pagination::Increment::Next#initialize Next#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 pagination HTML
+        # @option options [ActionView::Helpers::FormBuilder] :form form builder used to create pagination buttons
+        # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
 
-      # Generates the HTML for the GOV.UK pagination component
-      #
-      # @return [ActiveSupport::SafeBuffer]
-
-      def render
-        tag.nav(**options[:attributes]) do
-          concat(pagination_previous.render) if pagination_previous
-          if pagination_items
-            concat(tag.ul(class: 'govuk-pagination__list') do
-              pagination_items.each { |pagination_item| concat(pagination_item.render) }
-            end)
+        def initialize(pagination_previous: nil, pagination_items: nil, pagination_next: nil, **options)
+          super(**options)
+
+          block_is_level = pagination_items.blank? && (pagination_previous.present? || pagination_next.present?)
+
+          @options[:attributes][:class] << ' govuk-pagination--block' if block_is_level
+          @options[:attributes][:role] = 'navigation'
+          (@options[:attributes][:aria] ||= {})[:label] ||= 'results'
+
+          @pagination_previous = Increment::Previous.new(block_is_level: block_is_level, form: @options[:form], context: @context, **pagination_previous) if pagination_previous
+          @pagination_next = Increment::Next.new(block_is_level: block_is_level, form: @options[:form], context: @context, **pagination_next) if pagination_next
+          initialize_pagination_items(pagination_items, @options[:form])
+        end
+
+        # rubocop:enable Metrics/CyclomaticComplexity
+
+        # Generates the HTML for the GOV.UK pagination component
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.nav(**options[:attributes]) do
+            concat(pagination_previous.render) if pagination_previous
+            if pagination_items
+              concat(tag.ul(class: 'govuk-pagination__list') do
+                pagination_items.each { |pagination_item| concat(pagination_item.render) }
+              end)
+            end
+            concat(pagination_next.render) if pagination_next
           end
-          concat(pagination_next.render) if pagination_next
         end
-      end
 
-      # The default attributes for the pagination
+        # The default attributes for the pagination
 
-      DEFAULT_ATTRIBUTES = { class: 'govuk-pagination' }.freeze
+        DEFAULT_ATTRIBUTES = { class: 'govuk-pagination' }.freeze
 
-      private
+        private
 
-      # Initialises the pagination items
-      #
-      # @param pagination_items [Array<Hash>] An array of options for the pagination items
-      # @param form [ActionView::Helpers::FormBuilder] form builder used to create pagination buttons
+        # Initialises the pagination items
+        #
+        # @param pagination_items [Array<Hash>] An array of options for the pagination items
+        # @param form [ActionView::Helpers::FormBuilder] form builder used to create pagination buttons
 
-      def initialize_pagination_items(pagination_items, form)
-        return unless pagination_items
+        def initialize_pagination_items(pagination_items, form)
+          return unless pagination_items
 
-        pagination_item_class = form ? Item::Form : Item::Tag
+          pagination_item_class = form ? Item::Form : Item::Tag
 
-        @pagination_items = pagination_items.map { |pagination_item| pagination_item[:type] == :ellipsis ? Item::Ellipsis : pagination_item_class.new(form: form, context: context, **pagination_item) }
+          @pagination_items = pagination_items.map { |pagination_item| pagination_item[:type] == :ellipsis ? Item::Ellipsis : pagination_item_class.new(form: form, context: context, **pagination_item) }
+        end
       end
     end
   end

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

@@ -1,60 +1,62 @@
 require_relative '../base'
 
-module CCS::Components
-  module GovUK
-    # = GOV.UK Panel
-    #
-    # This is used to generate the panel component from the
-    # {https://design-system.service.gov.uk/components/panel GDS - Components - Panel}
-    #
-    # @!attribute [r] title_text
-    #   @return [String] Text for the panel title
-    # @!attribute [r] panel_text
-    #   @return [String] Text that will be used for the panel content
-
-    class Panel < Base
-      private
-
-      attr_reader :title_text, :panel_text
-
-      public
-
-      # @param title_text [String] title text for the panel which will be contained in haeding tags
-      # @param panel_text [String] text to use within the panel component.
-      #                            If nil, then a block will be rendered
-      # @param options [Hash] options that will be used in customising the HTML
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK Panel
       #
-      # @option options [String] :classes additional CSS classes for the panel HTML
-      # @option options [Integer,String] :heading_level (default: 1) heading level for the panel title text
-      # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+      # This is used to generate the panel component from the
+      # {https://design-system.service.gov.uk/components/panel GDS - Components - Panel}
+      #
+      # @!attribute [r] title_text
+      #   @return [String] Text for the panel title
+      # @!attribute [r] panel_text
+      #   @return [String] Text that will be used for the panel content
 
-      def initialize(title_text:, panel_text: nil, **options)
-        super(**options)
+      class Panel < Base
+        private
 
-        @title_text = title_text
-        @panel_text = panel_text
-      end
+        attr_reader :title_text, :panel_text
 
-      # Generates the HTML for the GOV.UK Panel component
-      #
-      # @yield HTML that will be contained within the panel body. Ignored if panel text is given
-      #
-      # @return [ActiveSupport::SafeBuffer]
-
-      def render
-        tag.div(**options[:attributes]) do
-          concat(tag.send(:"h#{options[:heading_level] || 1}", title_text, class: 'govuk-panel__title'))
-          if panel_text || block_given?
-            concat(tag.div(class: 'govuk-panel__body') do
-              panel_text || yield
-            end)
+        public
+
+        # @param title_text [String] title text for the panel which will be contained in haeding tags
+        # @param panel_text [String] text to use within the panel component.
+        #                            If nil, then a block will be rendered
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option options [String] :classes additional CSS classes for the panel HTML
+        # @option options [Integer,String] :heading_level (default: 1) heading level for the panel title text
+        # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+
+        def initialize(title_text:, panel_text: nil, **options)
+          super(**options)
+
+          @title_text = title_text
+          @panel_text = panel_text
+        end
+
+        # Generates the HTML for the GOV.UK Panel component
+        #
+        # @yield HTML that will be contained within the panel body. Ignored if panel text is given
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.div(**options[:attributes]) do
+            concat(tag.send(:"h#{options[:heading_level] || 1}", title_text, class: 'govuk-panel__title'))
+            if panel_text || block_given?
+              concat(tag.div(class: 'govuk-panel__body') do
+                panel_text || yield
+              end)
+            end
           end
         end
-      end
 
-      # The default attributes for the panel
+        # The default attributes for the panel
 
-      DEFAULT_ATTRIBUTES = { class: 'govuk-panel govuk-panel--confirmation' }.freeze
+        DEFAULT_ATTRIBUTES = { class: 'govuk-panel govuk-panel--confirmation' }.freeze
+      end
     end
   end
 end

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

@@ -1,67 +1,69 @@
 require_relative '../base'
 require_relative 'tag'
 
-module CCS::Components
-  module GovUK
-    # = GOV.UK Phase banner
-    #
-    # This is used to generate the phase banner component from the
-    # {https://design-system.service.gov.uk/components/phase-banner GDS - Components - Phase banner}
-    #
-    # @!attribute [r] text
-    #   @return [String] Text for the phase banner
-    # @!attribute [r] tag_options
-    #   @return [Hash] Options for the phase banner tag
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK Phase banner
+      #
+      # This is used to generate the phase banner component from the
+      # {https://design-system.service.gov.uk/components/phase-banner GDS - Components - Phase banner}
+      #
+      # @!attribute [r] text
+      #   @return [String] Text for the phase banner
+      # @!attribute [r] tag_options
+      #   @return [Hash] Options for the phase banner tag
 
-    class PhaseBanner < Base
-      private
+      class PhaseBanner < Base
+        private
 
-      attr_reader :text, :tag_options
+        attr_reader :text, :tag_options
 
-      public
+        public
 
-      # @param tag_options [Hash] paramters for the govuk tag (see {Components::GovUK::Tag Tag}).
-      #                           options are:
-      #                           - +text+
-      #                           - +colour+
-      #                           - +options+
-      # @param text [String] the text for the phase banner.
-      #                      If nil, then a block will be rendered
-      # @param options [Hash] options that will be used in customising the HTML
-      #
-      # @option options [String] :classes additional CSS classes for the phase banner HTML
-      # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+        # @param tag_options [Hash] paramters for the govuk tag (see {Components::GovUK::Tag Tag}).
+        #                           options are:
+        #                           - +text+
+        #                           - +colour+
+        #                           - +options+
+        # @param text [String] the text for the phase banner.
+        #                      If nil, then a block will be rendered
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option options [String] :classes additional CSS classes for the phase banner HTML
+        # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
 
-      def initialize(tag_options:, text: nil, **options)
-        super(**options)
+        def initialize(tag_options:, text: nil, **options)
+          super(**options)
 
-        tag_options[:classes] = "govuk-phase-banner__content__tag #{tag_options[:classes]}".rstrip
-        tag_options[:context] = @context
+          tag_options[:classes] = "govuk-phase-banner__content__tag #{tag_options[:classes]}".rstrip
+          tag_options[:context] = @context
 
-        @text = text
-        @tag_options = tag_options
-      end
+          @text = text
+          @tag_options = tag_options
+        end
 
-      # Generates the HTML for the GOV.UK Phase banner component
-      #
-      # @yield HTML that will be used in the phase banner. Ignored if text is passed.
-      #
-      # @return [ActiveSupport::SafeBuffer]
+        # Generates the HTML for the GOV.UK Phase banner component
+        #
+        # @yield HTML that will be used in the phase banner. Ignored if text is passed.
+        #
+        # @return [ActiveSupport::SafeBuffer]
 
-      def render
-        tag.div(**options[:attributes]) do
-          tag.p(class: 'govuk-phase-banner__content') do
-            concat(Tag.new(**tag_options).render)
-            concat(tag.span(class: 'govuk-phase-banner__text') do
-              text || yield
-            end)
+        def render
+          tag.div(**options[:attributes]) do
+            tag.p(class: 'govuk-phase-banner__content') do
+              concat(Tag.new(**tag_options).render)
+              concat(tag.span(class: 'govuk-phase-banner__text') do
+                text || yield
+              end)
+            end
           end
         end
-      end
 
-      # The default attributes for the phase banner
+        # The default attributes for the phase banner
 
-      DEFAULT_ATTRIBUTES = { class: 'govuk-phase-banner' }.freeze
+        DEFAULT_ATTRIBUTES = { class: 'govuk-phase-banner' }.freeze
+      end
     end
   end
 end