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

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

@@ -1,103 +1,105 @@
 require_relative '../base'
 
-module CCS::Components
-  module GovUK
-    # = GOV.UK Button
-    #
-    # This is used to generate the button component from the
-    # {https://design-system.service.gov.uk/components/button GDS - Components - Button}
-    #
-    # @!attribute [r] text
-    #   @return [String] Text for the button
-    # @!attribute [r] render_method
-    #   @return [String] The method that will be used to render the button
-
-    class Button < Base
-      private
-
-      attr_reader :text, :render_method
-
-      public
-
-      # @param text [String] the text that will be shown in the button
-      # @param options [Hash] options that will be used in customising the HTML
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK Button
       #
-      # @option options [String] :classes additional CSS classes for the button HTML
-      # @option options [Boolean] :is_start_button indicates if it is a start button
-      # @option options [String] :href the URI that will be used in anchor tag
-      # @option options [ActionView::Helpers::FormBuilder] :form the form builder used to create the submit button
-      # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
-
-      def initialize(text:, **options)
-        super(**options)
-
-        @options[:attributes][:class] << ' govuk-button--disabled' if @options[:attributes][:disabled]
-        @options[:attributes][:class] << ' govuk-button--start' if @options[:is_start_button]
-
-        @text = text
-        @render_method = :"render_#{if @options[:href]
-                                      :link
-                                    elsif @options[:form]
-                                      :submit
-                                    else
-                                      :button
-                                    end}"
-      end
-
-      # Generates the HTML for the GOV.UK Back link component
+      # This is used to generate the button component from the
+      # {https://design-system.service.gov.uk/components/button GDS - Components - Button}
       #
-      # @return [ActiveSupport::SafeBuffer]
+      # @!attribute [r] text
+      #   @return [String] Text for the button
+      # @!attribute [r] render_method
+      #   @return [String] The method that will be used to render the button
+
+      class Button < Base
+        private
+
+        attr_reader :text, :render_method
+
+        public
+
+        # @param text [String] the text that will be shown in the button
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option options [String] :classes additional CSS classes for the button HTML
+        # @option options [Boolean] :is_start_button indicates if it is a start button
+        # @option options [String] :href the URI that will be used in anchor tag
+        # @option options [ActionView::Helpers::FormBuilder] :form the form builder used to create the submit button
+        # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+
+        def initialize(text:, **options)
+          super(**options)
+
+          @options[:attributes][:class] << ' govuk-button--disabled' if @options[:attributes][:disabled]
+          @options[:attributes][:class] << ' govuk-button--start' if @options[:is_start_button]
+
+          @text = text
+          @render_method = :"render_#{if @options[:href]
+                                        :link
+                                      elsif @options[:form]
+                                        :submit
+                                      else
+                                        :button
+                                      end}"
+        end
 
-      def render
-        send(@render_method)
-      end
+        # Generates the HTML for the GOV.UK Back link component
+        #
+        # @return [ActiveSupport::SafeBuffer]
 
-      # The default attributes for the button
+        def render
+          send(@render_method)
+        end
 
-      DEFAULT_ATTRIBUTES = { class: 'govuk-button', data: { module: 'govuk-button' } }.freeze
+        # The default attributes for the button
 
-      private
+        DEFAULT_ATTRIBUTES = { class: 'govuk-button', data: { module: 'govuk-button' } }.freeze
 
-      # Generates the HTML for the GOV.UK button component as an anchor tag.
-      #
-      # @return [ActiveSupport::SafeBuffer]
+        private
+
+        # Generates the HTML for the GOV.UK button component as an anchor tag.
+        #
+        # @return [ActiveSupport::SafeBuffer]
 
-      def render_link
-        @options[:attributes][:role] = :button
-        @options[:attributes][:draggable] = false
+        def render_link
+          @options[:attributes][:role] = :button
+          @options[:attributes][:draggable] = false
 
-        link_to(@options[:href], **@options[:attributes]) do
-          concat(text)
-          concat(start_button_icon) if @options[:is_start_button]
+          link_to(@options[:href], **@options[:attributes]) do
+            concat(text)
+            concat(start_button_icon) if @options[:is_start_button]
+          end
         end
-      end
 
-      # Generates the HTML for the GOV.UK button component as a button.
-      #
-      # @return [ActiveSupport::SafeBuffer]
+        # Generates the HTML for the GOV.UK button component as a button.
+        #
+        # @return [ActiveSupport::SafeBuffer]
 
-      def render_button
-        button_tag(**@options[:attributes]) do
-          concat(text)
-          concat(start_button_icon) if @options[:is_start_button]
+        def render_button
+          button_tag(**@options[:attributes]) do
+            concat(text)
+            concat(start_button_icon) if @options[:is_start_button]
+          end
         end
-      end
 
-      # Generates the HTML for the GOV.UK button component as an input.
-      #
-      # @return [ActiveSupport::SafeBuffer]
+        # Generates the HTML for the GOV.UK button component as an input.
+        #
+        # @return [ActiveSupport::SafeBuffer]
 
-      def render_submit
-        @options[:form].submit(text, **@options[:attributes])
-      end
+        def render_submit
+          @options[:form].submit(text, **@options[:attributes])
+        end
 
-      # Generates the arrow if the button is a start button
-      #
-      # @return [ActiveSupport::SafeBuffer]
+        # Generates the arrow if the button is a start button
+        #
+        # @return [ActiveSupport::SafeBuffer]
 
-      def start_button_icon
-        tag.svg(class: 'govuk-button__start-icon', xmlns: 'http://www.w3.org/2000/svg', width: 17.5, height: 19, viewBox: '0 0 33 40', aria: { hidden: true }, focusable: false) do
-          tag.path(fill: 'currentColor', d: 'M0 0h13l20 20-20 20H0l20-20z')
+        def start_button_icon
+          tag.svg(class: 'govuk-button__start-icon', xmlns: 'http://www.w3.org/2000/svg', width: 17.5, height: 19, viewBox: '0 0 33 40', aria: { hidden: true }, focusable: false) do
+            tag.path(fill: 'currentColor', d: 'M0 0h13l20 20-20 20H0l20-20z')
+          end
         end
       end
     end

data/lib/ccs/components/govuk/cookie_banner/action.rb

@@ -1,57 +1,59 @@
 require_relative '../../base'
 require_relative '../button'
 
-module CCS::Components
-  module GovUK
-    class CookieBanner < Base
-      # = GOV.UK Cookie Banner Action
-      #
-      # The individual cookie banner action.
-      # It defaults to creating button unless a +href+ is set which will create a link
-      #
-      # @!attribute [r] text
-      #   @return [String] Text for the action
-      # @!attribute [r] href
-      #   @return [String] The href for the action
-
-      class Action < Base
-        private
-
-        attr_reader :text, :href
-
-        public
-
-        # @param text [String] the button or link text
-        # @param href [String] the href for a link
-        # @param options [Hash] options that will be used in customising the HTML
+module CCS
+  module Components
+    module GovUK
+      class CookieBanner < Base
+        # = GOV.UK Cookie Banner Action
         #
-        # @option options [String] : classes additional CSS classes for the cookie action button or link
-        # @option options [Hash] :attributes any additional attributes that will added as part of the HTML.
-        #                                    If the +:type+ key is present with a value of +:button+,
-        #                                   the action will be rendered as a button
+        # The individual cookie banner action.
+        # It defaults to creating button unless a +href+ is set which will create a link
+        #
+        # @!attribute [r] text
+        #   @return [String] Text for the action
+        # @!attribute [r] href
+        #   @return [String] The href for the action
 
-        def initialize(text:, href: nil, **options)
-          super(**options)
+        class Action < Base
+          private
 
-          @text = text
-          @href = href
-        end
+          attr_reader :text, :href
 
-        # Generates the HTML for a cookie banner message action
-        #
-        # @return [ActiveSupport::SafeBuffer]
+          public
+
+          # @param text [String] the button or link text
+          # @param href [String] the href for a link
+          # @param options [Hash] options that will be used in customising the HTML
+          #
+          # @option options [String] : classes additional CSS classes for the cookie action button or link
+          # @option options [Hash] :attributes any additional attributes that will added as part of the HTML.
+          #                                    If the +:type+ key is present with a value of +:button+,
+          #                                   the action will be rendered as a button
+
+          def initialize(text:, href: nil, **options)
+            super(**options)
 
-        def render
-          if href && options[:attributes][:type] != :button
-            link_to(text, href, **options[:attributes])
-          else
-            Button.new(text: text, href: href, context: context, **options).render
+            @text = text
+            @href = href
           end
-        end
 
-        # The default attributes for the cookie banner action
+          # Generates the HTML for a cookie banner message action
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            if href && options[:attributes][:type] != :button
+              link_to(text, href, **options[:attributes])
+            else
+              Button.new(text: text, href: href, context: context, **options).render
+            end
+          end
 
-        DEFAULT_ATTRIBUTES = { class: 'govuk-link' }.freeze
+          # The default attributes for the cookie banner action
+
+          DEFAULT_ATTRIBUTES = { class: 'govuk-link' }.freeze
+        end
       end
     end
   end

data/lib/ccs/components/govuk/cookie_banner/message.rb

@@ -1,77 +1,79 @@
 require_relative '../../base'
 require_relative 'action'
 
-module CCS::Components
-  module GovUK
-    class CookieBanner < Base
-      # = GOV.UK Cookie Banner Message
-      #
-      # The individual cookie banner message
-      #
-      # @!attribute [r] heading_text
-      #   @return [String] Heading text for the message
-      # @!attribute [r] content
-      #   @return [ActiveSupport::SafeBuffer] HTML for the message
-      # @!attribute [r] text
-      #   @return [String] Text for the message
-      # @!attribute [r] actions
-      #   @return [Array<Action>] Array of initialised cookie banner actions
+module CCS
+  module Components
+    module GovUK
+      class CookieBanner < Base
+        # = GOV.UK Cookie Banner Message
+        #
+        # The individual cookie banner message
+        #
+        # @!attribute [r] heading_text
+        #   @return [String] Heading text for the message
+        # @!attribute [r] content
+        #   @return [ActiveSupport::SafeBuffer] HTML for the message
+        # @!attribute [r] text
+        #   @return [String] Text for the message
+        # @!attribute [r] actions
+        #   @return [Array<Action>] Array of initialised cookie banner actions
 
-      class Message < Base
-        private
+        class Message < Base
+          private
 
-        attr_reader :heading_text, :content, :text, :actions
+          attr_reader :heading_text, :content, :text, :actions
 
-        public
+          public
 
-        # @param heading_text [String] the heading text that displays in the message
-        # @param content [ActiveSupport::SafeBuffer] HTML to use as content for the message
-        # @param text [String] if +:content+ is blank then this is the text used for the message
-        # @param actions [Array<Hash>] the buttons and/or links that you want to display in the message.
-        #                              See {Components::GovUK::CookieBanner::Action#initialize Action#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 cookie message HTML
-        # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+          # @param heading_text [String] the heading text that displays in the message
+          # @param content [ActiveSupport::SafeBuffer] HTML to use as content for the message
+          # @param text [String] if +:content+ is blank then this is the text used for the message
+          # @param actions [Array<Hash>] the buttons and/or links that you want to display in the message.
+          #                              See {Components::GovUK::CookieBanner::Action#initialize Action#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 cookie message HTML
+          # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
 
-        def initialize(heading_text: nil, content: nil, text: nil, actions: nil, **options)
-          super(**options)
+          def initialize(heading_text: nil, content: nil, text: nil, actions: nil, **options)
+            super(**options)
 
-          @heading_text = heading_text
-          @content = content
-          @text = text
-          @actions = actions.map { |action| Action.new(context: @context, **action) } if actions
-        end
+            @heading_text = heading_text
+            @content = content
+            @text = text
+            @actions = actions.map { |action| Action.new(context: @context, **action) } if actions
+          end
 
-        # rubocop:disable Metrics/AbcSize
+          # rubocop:disable Metrics/AbcSize
 
-        # Generates the HTML for the GOV.UK Cookie Banner Message
-        #
-        # @return [ActiveSupport::SafeBuffer]
+          # Generates the HTML for the GOV.UK Cookie Banner Message
+          #
+          # @return [ActiveSupport::SafeBuffer]
 
-        def render
-          tag.div(**options[:attributes]) do
-            concat(tag.div(class: 'govuk-grid-row') do
-              tag.div(class: 'govuk-grid-column-two-thirds') do
-                concat(tag.h2(heading_text, class: 'govuk-cookie-banner__heading govuk-heading-m')) if heading_text
-                concat(tag.div(class: 'govuk-cookie-banner__content') do
-                  content || tag.p(text, class: 'govuk-body')
+          def render
+            tag.div(**options[:attributes]) do
+              concat(tag.div(class: 'govuk-grid-row') do
+                tag.div(class: 'govuk-grid-column-two-thirds') do
+                  concat(tag.h2(heading_text, class: 'govuk-cookie-banner__heading govuk-heading-m')) if heading_text
+                  concat(tag.div(class: 'govuk-cookie-banner__content') do
+                    content || tag.p(text, class: 'govuk-body')
+                  end)
+                end
+              end)
+              if actions
+                concat(tag.div(class: 'govuk-button-group') do
+                  actions.each { |action| concat(action.render) }
                 end)
               end
-            end)
-            if actions
-              concat(tag.div(class: 'govuk-button-group') do
-                actions.each { |action| concat(action.render) }
-              end)
             end
           end
-        end
 
-        # rubocop:enable Metrics/AbcSize
+          # rubocop:enable Metrics/AbcSize
 
-        # The default attributes for the cookie banner message
+          # The default attributes for the cookie banner message
 
-        DEFAULT_ATTRIBUTES = { class: 'govuk-cookie-banner__message govuk-width-container' }.freeze
+          DEFAULT_ATTRIBUTES = { class: 'govuk-cookie-banner__message govuk-width-container' }.freeze
+        end
       end
     end
   end

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

@@ -1,53 +1,55 @@
 require_relative '../base'
 require_relative 'cookie_banner/message'
 
-module CCS::Components
-  module GovUK
-    # = GOV.UK Cookie Banner
-    #
-    # This is used to generate the cookie banner component from the
-    # {https://design-system.service.gov.uk/components/cookie-banner GDS - Components - Cookie banner}
-    #
-    # @!attribute [r] messages
-    #   @return [Array<Message>] An array of the initialised cookie banner messages
-
-    class CookieBanner < Base
-      private
-
-      attr_reader :messages
-
-      public
-
-      # @param messages [Array<Hash>] An array of messages for the cookie banner.
-      #                               See {Components::GovUK::CookieBanner::Message#initialize Message#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 Cookie Banner
       #
-      # @option options [String] :classes additional CSS classes for the cookie banner HTML
-      # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+      # This is used to generate the cookie banner component from the
+      # {https://design-system.service.gov.uk/components/cookie-banner GDS - Components - Cookie banner}
+      #
+      # @!attribute [r] messages
+      #   @return [Array<Message>] An array of the initialised cookie banner messages
 
-      def initialize(messages:, **options)
-        super(**options)
+      class CookieBanner < Base
+        private
 
-        (@options[:attributes][:data] ||= {})[:nosnippet] = 'true'
-        @options[:attributes][:role] = 'region'
-        (@options[:attributes][:aria] ||= {})[:label] ||= 'Cookie banner'
+        attr_reader :messages
 
-        @messages = messages.map { |message| Message.new(context: @context, **message) }
-      end
+        public
 
-      # Generates the HTML for the GOV.UK Cookie banner component
-      #
-      # @return [ActiveSupport::SafeBuffer]
+        # @param messages [Array<Hash>] An array of messages for the cookie banner.
+        #                               See {Components::GovUK::CookieBanner::Message#initialize Message#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 cookie banner HTML
+        # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+
+        def initialize(messages:, **options)
+          super(**options)
+
+          (@options[:attributes][:data] ||= {})[:nosnippet] = 'true'
+          @options[:attributes][:role] = 'region'
+          (@options[:attributes][:aria] ||= {})[:label] ||= 'Cookie banner'
 
-      def render
-        tag.div(**options[:attributes]) do
-          messages.each { |message| concat(message.render) }
+          @messages = messages.map { |message| Message.new(context: @context, **message) }
         end
-      end
 
-      # The default attributes for the cookie banner
+        # Generates the HTML for the GOV.UK Cookie banner component
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.div(**options[:attributes]) do
+            messages.each { |message| concat(message.render) }
+          end
+        end
 
-      DEFAULT_ATTRIBUTES = { class: 'govuk-cookie-banner' }.freeze
+        # The default attributes for the cookie banner
+
+        DEFAULT_ATTRIBUTES = { class: 'govuk-cookie-banner' }.freeze
+      end
     end
   end
 end

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

@@ -1,51 +1,53 @@
 require_relative '../base'
 
-module CCS::Components
-  module GovUK
-    # = GOV.UK Details
-    #
-    # This is used to generate the details component from the
-    # {https://design-system.service.gov.uk/components/details GDS - Components - Details}
-    #
-    # @!attribute [r] summary_text
-    #   @return [String] Summary text for the details element
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK Details
+      #
+      # This is used to generate the details component from the
+      # {https://design-system.service.gov.uk/components/details GDS - Components - Details}
+      #
+      # @!attribute [r] summary_text
+      #   @return [String] Summary text for the details element
 
-    class Details < Base
-      private
+      class Details < Base
+        private
 
-      attr_reader :summary_text
+        attr_reader :summary_text
 
-      public
+        public
 
-      # @param summary_text [String] the summary text for the details element
-      # @param options [Hash] options that will be used in customising the HTML
-      #
-      # @option options [String] :classes additional CSS classes for the details HTML
-      # @option options [Hash] :attributes ({ data: { module: 'govuk-details' } }) any additional attributes that will added as part of the HTML
+        # @param summary_text [String] the summary text for the details element
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option options [String] :classes additional CSS classes for the details HTML
+        # @option options [Hash] :attributes ({ data: { module: 'govuk-details' } }) any additional attributes that will added as part of the HTML
 
-      def initialize(summary_text:, **options)
-        super(**options)
-
-        @summary_text = summary_text
-      end
+        def initialize(summary_text:, **options)
+          super(**options)
 
-      # Generates the HTML for the GOV.UK Details component
-      #
-      # @yield HTML that will be contained within the 'govuk-details__text' div
-      #
-      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Details
-      #                                     which can then be rendered on the page
+          @summary_text = summary_text
+        end
 
-      def render(&block)
-        tag.details(**options[:attributes]) do
-          concat(tag.summary(tag.span(summary_text, class: 'govuk-details__summary-text'), class: 'govuk-details__summary'))
-          concat(tag.div(class: 'govuk-details__text', &block))
+        # Generates the HTML for the GOV.UK Details component
+        #
+        # @yield HTML that will be contained within the 'govuk-details__text' div
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Details
+        #                                     which can then be rendered on the page
+
+        def render(&block)
+          tag.details(**options[:attributes]) do
+            concat(tag.summary(tag.span(summary_text, class: 'govuk-details__summary-text'), class: 'govuk-details__summary'))
+            concat(tag.div(class: 'govuk-details__text', &block))
+          end
         end
-      end
 
-      # The default attributes for the details
+        # The default attributes for the details
 
-      DEFAULT_ATTRIBUTES = { class: 'govuk-details', data: { module: 'govuk-details' } }.freeze
+        DEFAULT_ATTRIBUTES = { class: 'govuk-details', data: { module: 'govuk-details' } }.freeze
+      end
     end
   end
 end