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

data/lib/ccs/components/govuk/field/inputs.rb

@@ -1,51 +1,53 @@
 require_relative '../field'
 require_relative '../fieldset'
 
-module CCS::Components
-  module GovUK
-    class Field < Base
-      # = GOV.UK Field Inputs
-      #
-      # This class is used to create a form for a list of fields, e.g. radios or checkboxes.
-      # It will wrap the inputs in the form group and then the fieldset and:
-      # - display the hint (if there is one)
-      # - find and display the error message (if there is one)
-      #
-      # @!attribute [r] fieldset
-      #   @return [Fieldset] The initialised fieldset
-
-      class Inputs < Field
-        private
-
-        attr_reader :fieldset
-
-        public
-
-        # @param (see CCS::Components::GovUK::Field#initialize)
-        # @param fieldset [Hash] attributes for the fieldset, see {CCS::Components::GovUK::Fieldset#initialize Fieldset#initialize} for more details.
+module CCS
+  module Components
+    module GovUK
+      class Field < Base
+        # = GOV.UK Field Inputs
         #
-        # @option (see CCS::Components::GovUK::Field#initialize)
+        # This class is used to create a form for a list of fields, e.g. radios or checkboxes.
+        # It will wrap the inputs in the form group and then the fieldset and:
+        # - display the hint (if there is one)
+        # - find and display the error message (if there is one)
+        #
+        # @!attribute [r] fieldset
+        #   @return [Fieldset] The initialised fieldset
 
-        def initialize(attribute:, fieldset:, **options)
-          super(attribute: attribute, **options)
+        class Inputs < Field
+          private
 
-          set_described_by(fieldset, @attribute, @error_message, options[:hint])
+          attr_reader :fieldset
 
-          @fieldset = Fieldset.new(context: @context, **fieldset)
-        end
+          public
 
-        # Generates the HTML to wrap arround a GDS form component
-        #
-        # @yield (see CCS::Components::GovUK::Field#render)
-        #
-        # @return [ActiveSupport::SafeBuffer]
-
-        def render
-          super() do |display_error_message|
-            fieldset.render do
-              concat(hint.render) if hint
-              concat(display_error_message)
-              concat(yield)
+          # @param (see CCS::Components::GovUK::Field#initialize)
+          # @param fieldset [Hash] attributes for the fieldset, see {CCS::Components::GovUK::Fieldset#initialize Fieldset#initialize} for more details.
+          #
+          # @option (see CCS::Components::GovUK::Field#initialize)
+
+          def initialize(attribute:, fieldset:, **options)
+            super(attribute: attribute, **options)
+
+            set_described_by(fieldset, @attribute, @error_message, options[:hint])
+
+            @fieldset = Fieldset.new(context: @context, **fieldset)
+          end
+
+          # Generates the HTML to wrap arround a GDS form component
+          #
+          # @yield (see CCS::Components::GovUK::Field#render)
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            super() do |display_error_message|
+              fieldset.render do
+                concat(hint.render) if hint
+                concat(display_error_message)
+                concat(yield)
+              end
             end
           end
         end

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

@@ -2,105 +2,107 @@ require_relative '../base'
 require_relative 'form_group'
 require_relative 'hint'
 
-module CCS::Components
-  module GovUK
-    # = GOV.UK Field
-    #
-    # This class is used to create a form using the structure of a GDS input field components, e.g. text input.
-    # It will wrap the input within the form group as well as find if there are any error messages to display.
-    #
-    # @!attribute [r] attribute
-    #   @return [String,Symbol] The attribute of the field
-    # @!attribute [r] error_message
-    #   @return [String] The error message for the field
-    # @!attribute [r] form_group
-    #   @return [FormGroup] The initialised form group
-    # @!attribute [r] hint
-    #   @return [Hint] The initialised hint
-
-    class Field < Base
-      private
-
-      attr_reader :attribute, :error_message, :form_group, :hint
-
-      public
-
-      # @param attribute [String, Symbol] the attribute of the field
-      # @param hint [Hash] attributes for the hint, see {CCS::Components::GovUK::Hint#initialize Hint#initialize} for more details.
-      #                    If no hint is given then no hint will be rendered
-      # @param form_group [Hash] attributes for the form group, see {CCS::Components::GovUK::FormGroup#initialize FormGroup#initialize} for more details.
-      # @param options [Hash] options that will be used for the parts of the field
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK Field
       #
-      # @option options [String] :error_message (nil) the error message to be displayed
-      # @option options [ActiveModel] :model (nil) optional model that can be used to find an error message
-      # @option options [ActionView::Helpers::FormBuilder] :form (nil) optional form builder used to create
-      #                                                                the field and find the error message
-      # @option options [String] :classes additional CSS classes for the field HTML
-      # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
-
-      def initialize(attribute:, form_group: nil, hint: nil, **options)
-        super(**options)
-
-        (hint[:attributes] ||= {})[:id] = "#{attribute}-hint" if hint && !hint.dig(:attributes, :id)
-
-        @attribute = attribute
-        @error_message = find_error_message(attribute)
-
-        @form_group = FormGroup.new(attribute: attribute, error_message: @error_message, context: @context, **(form_group || {}))
-        @hint = Hint.new(context: @context, **hint) if hint
-      end
-
-      # Generates the HTML to wrap arround a GDS form input component
-      #
-      # @yield the field HTML
+      # This class is used to create a form using the structure of a GDS input field components, e.g. text input.
+      # It will wrap the input within the form group as well as find if there are any error messages to display.
       #
-      # @yieldparam displayed_error_message [ActiveSupport::SafeBuffer] the error message HTML to display
-      #
-      # @return [ActiveSupport::SafeBuffer]
+      # @!attribute [r] attribute
+      #   @return [String,Symbol] The attribute of the field
+      # @!attribute [r] error_message
+      #   @return [String] The error message for the field
+      # @!attribute [r] form_group
+      #   @return [FormGroup] The initialised form group
+      # @!attribute [r] hint
+      #   @return [Hint] The initialised hint
+
+      class Field < Base
+        private
+
+        attr_reader :attribute, :error_message, :form_group, :hint
+
+        public
+
+        # @param attribute [String, Symbol] the attribute of the field
+        # @param hint [Hash] attributes for the hint, see {CCS::Components::GovUK::Hint#initialize Hint#initialize} for more details.
+        #                    If no hint is given then no hint will be rendered
+        # @param form_group [Hash] attributes for the form group, see {CCS::Components::GovUK::FormGroup#initialize FormGroup#initialize} for more details.
+        # @param options [Hash] options that will be used for the parts of the field
+        #
+        # @option options [String] :error_message (nil) the error message to be displayed
+        # @option options [ActiveModel] :model (nil) optional model that can be used to find an error message
+        # @option options [ActionView::Helpers::FormBuilder] :form (nil) optional form builder used to create
+        #                                                                the field and find the error message
+        # @option options [String] :classes additional CSS classes for the field HTML
+        # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+
+        def initialize(attribute:, form_group: nil, hint: nil, **options)
+          super(**options)
+
+          (hint[:attributes] ||= {})[:id] = "#{attribute}-hint" if hint && !hint.dig(:attributes, :id)
+
+          @attribute = attribute
+          @error_message = find_error_message(attribute)
+
+          @form_group = FormGroup.new(attribute: attribute, error_message: @error_message, context: @context, **(form_group || {}))
+          @hint = Hint.new(context: @context, **hint) if hint
+        end
 
-      def render(&block)
-        form_group.render(&block)
-      end
+        # Generates the HTML to wrap arround a GDS form input component
+        #
+        # @yield the field HTML
+        #
+        # @yieldparam displayed_error_message [ActiveSupport::SafeBuffer] the error message HTML to display
+        #
+        # @return [ActiveSupport::SafeBuffer]
 
-      private
+        def render(&block)
+          form_group.render(&block)
+        end
 
-      # If one is present it will find the error message text for the field
-      #
-      # @param attribute [String, Symbol] the attribute of the field
-      #
-      # @return [String]
-
-      def find_error_message(attribute)
-        if @options[:model]
-          @options[:model].errors[attribute].first
-        elsif options[:form]
-          @options[:form].object.errors[attribute].first
-        else
-          @options[:error_message]
+        private
+
+        # If one is present it will find the error message text for the field
+        #
+        # @param attribute [String, Symbol] the attribute of the field
+        #
+        # @return [String]
+
+        def find_error_message(attribute)
+          if @options[:model]
+            @options[:model].errors[attribute].first
+          elsif options[:form]
+            @options[:form].object.errors[attribute].first
+          else
+            @options[:error_message]
+          end
         end
-      end
 
-      # Adds the aira-describedby attribute for the field
-      # if there is a hint or an error message
-      #
-      # @param field_options [Hash] the hash with the options to add the aria described by to
-      # @param attribute [String, Symbol] the attribute of the field
-      # @param error_message [String] used to indicate if there is an error
-      # @param hint [Hash] the hint attributes
+        # Adds the aira-describedby attribute for the field
+        # if there is a hint or an error message
+        #
+        # @param field_options [Hash] the hash with the options to add the aria described by to
+        # @param attribute [String, Symbol] the attribute of the field
+        # @param error_message [String] used to indicate if there is an error
+        # @param hint [Hash] the hint attributes
 
-      def set_described_by(field_options, attribute, error_message, hint)
-        aria_described_by = [
-          field_options.dig(:attributes, :aria, :describedby),
-          (hint[:attributes][:id] if hint),
-          ("#{attribute}-error" if error_message)
-        ].compact
+        def set_described_by(field_options, attribute, error_message, hint)
+          aria_described_by = [
+            field_options.dig(:attributes, :aria, :describedby),
+            (hint[:attributes][:id] if hint),
+            ("#{attribute}-error" if error_message)
+          ].compact
 
-        return unless aria_described_by.any?
+          return unless aria_described_by.any?
 
-        ((field_options[:attributes] ||= {})[:aria] ||= {})[:describedby] = aria_described_by.join(' ')
+          ((field_options[:attributes] ||= {})[:aria] ||= {})[:describedby] = aria_described_by.join(' ')
+        end
       end
     end
-  end
 
-  ActionView::Base.field_error_proc = proc { |html_tag, _instance| html_tag }
+    ActionView::Base.field_error_proc = proc { |html_tag, _instance| html_tag }
+  end
 end

data/lib/ccs/components/govuk/fieldset/legend.rb

@@ -1,62 +1,64 @@
 require_relative '../../base'
 
-module CCS::Components
-  module GovUK
-    class Fieldset < Base
-      # = GOV.UK Fieldset Legend
-      #
-      # The legend for the fieldset
-      #
-      # @!attribute [r] text
-      #   @return [String] Text for the fieldset legend
-      # @!attribute [r] is_page_heading
-      #   @return [Boolean] Flag to indicate of the legend is a the page heading
-      # @!attribute [r] caption
-      #   @return [Hash] The class for the li elements
-
-      class Legend < Base
-        private
-
-        attr_reader :text, :is_page_heading, :caption
-
-        public
-
-        # @param text [String] the text for the fieldset legend
-        # @param is_page_heading [Boolean]  if the legend is also the heading it will rendered in a h1
-        # @param caption [String] options for the caption to be rendered above the heading if +:is_page_heading+ is true
-        # @param options [Hash] options that will be used in customising the HTML
+module CCS
+  module Components
+    module GovUK
+      class Fieldset < Base
+        # = GOV.UK Fieldset Legend
         #
-        # @option options [String] :classes additional CSS classes for the legend HTML
+        # The legend for the fieldset
         #
-        # @option caption [String] :text text for the caption
-        # @option caption [String] :classes additional CSS classes for the caption HTML
+        # @!attribute [r] text
+        #   @return [String] Text for the fieldset legend
+        # @!attribute [r] is_page_heading
+        #   @return [Boolean] Flag to indicate of the legend is a the page heading
+        # @!attribute [r] caption
+        #   @return [Hash] The class for the li elements
 
-        def initialize(text:, is_page_heading: nil, caption: nil, **options)
-          super(**options)
+        class Legend < Base
+          private
 
-          @text = text
-          @is_page_heading = is_page_heading
-          @caption = caption
-        end
+          attr_reader :text, :is_page_heading, :caption
 
-        # Generates the HTML for the GOV.UK Fieldset legend
-        #
-        # @return [ActiveSupport::SafeBuffer]
-
-        def render
-          tag.legend(class: options[:attributes][:class]) do
-            if is_page_heading
-              concat(tag.span(caption[:text], class: caption[:classes])) if caption
-              concat(tag.h1(text, class: 'govuk-fieldset__heading'))
-            else
-              text
+          public
+
+          # @param text [String] the text for the fieldset legend
+          # @param is_page_heading [Boolean]  if the legend is also the heading it will rendered in a h1
+          # @param caption [String] options for the caption to be rendered above the heading if +:is_page_heading+ is true
+          # @param options [Hash] options that will be used in customising the HTML
+          #
+          # @option options [String] :classes additional CSS classes for the legend HTML
+          #
+          # @option caption [String] :text text for the caption
+          # @option caption [String] :classes additional CSS classes for the caption HTML
+
+          def initialize(text:, is_page_heading: nil, caption: nil, **options)
+            super(**options)
+
+            @text = text
+            @is_page_heading = is_page_heading
+            @caption = caption
+          end
+
+          # Generates the HTML for the GOV.UK Fieldset legend
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            tag.legend(class: options[:attributes][:class]) do
+              if is_page_heading
+                concat(tag.span(caption[:text], class: caption[:classes])) if caption
+                concat(tag.h1(text, class: 'govuk-fieldset__heading'))
+              else
+                text
+              end
             end
           end
-        end
 
-        # The default attributes for the fieldset legend
+          # The default attributes for the fieldset legend
 
-        DEFAULT_ATTRIBUTES = { class: 'govuk-fieldset__legend' }.freeze
+          DEFAULT_ATTRIBUTES = { class: 'govuk-fieldset__legend' }.freeze
+        end
       end
     end
   end

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

@@ -1,52 +1,54 @@
 require_relative '../base'
 require_relative 'fieldset/legend'
 
-module CCS::Components
-  module GovUK
-    # = GOV.UK Fieldset
-    #
-    # This is used to generate the fieldset component from the
-    # {https://design-system.service.gov.uk/components/fieldset GDS - Components - Fieldset}
-    #
-    # @!attribute [r] legend
-    #   @return [Legend] Initialised fieldset legend
-
-    class Fieldset < Base
-      private
-
-      attr_reader :legend
-
-      public
-
-      # @param legend [Hash] options for the fieldset legend.
-      #                      See {Components::GovUK::Fieldset::Legend#initialize Legend#initialize} for details of the options.
-      # @param options [Hash] options that will be used in customising the HTML
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK Fieldset
       #
-      # @option options [String] :classes additional CSS classes for the fieldset HTML
-      # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+      # This is used to generate the fieldset component from the
+      # {https://design-system.service.gov.uk/components/fieldset GDS - Components - Fieldset}
+      #
+      # @!attribute [r] legend
+      #   @return [Legend] Initialised fieldset legend
 
-      def initialize(legend: nil, **options)
-        super(**options)
+      class Fieldset < Base
+        private
 
-        @legend = Legend.new(context: @context, **legend) if legend
-      end
+        attr_reader :legend
 
-      # Generates the HTML for the GOV.UK Fieldset component
-      #
-      # @yield HTML that will be contained within the 'govuk-fieldset' div and under the legend
-      #
-      # @return [ActiveSupport::SafeBuffer]
+        public
+
+        # @param legend [Hash] options for the fieldset legend.
+        #                      See {Components::GovUK::Fieldset::Legend#initialize Legend#initialize} for details of the options.
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option options [String] :classes additional CSS classes for the fieldset HTML
+        # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
 
-      def render
-        tag.fieldset(**options[:attributes]) do
-          concat(legend.render) if legend
-          yield
+        def initialize(legend: nil, **options)
+          super(**options)
+
+          @legend = Legend.new(context: @context, **legend) if legend
         end
-      end
 
-      # The default attributes for the fieldset
+        # Generates the HTML for the GOV.UK Fieldset component
+        #
+        # @yield HTML that will be contained within the 'govuk-fieldset' div and under the legend
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.fieldset(**options[:attributes]) do
+            concat(legend.render) if legend
+            yield
+          end
+        end
 
-      DEFAULT_ATTRIBUTES = { class: 'govuk-fieldset' }.freeze
+        # The default attributes for the fieldset
+
+        DEFAULT_ATTRIBUTES = { class: 'govuk-fieldset' }.freeze
+      end
     end
   end
 end

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

@@ -1,50 +1,52 @@
 require_relative '../../base'
 
-module CCS::Components
-  module GovUK
-    class Footer < Base
-      # = GOV.UK Footer link
-      #
-      # The individual footer footer link item
-      #
-      # @!attribute [r] text
-      #   @return [String] Text for the footer link
-      # @!attribute [r] href
-      #   @return [String] The href for the footer link
-      # @!attribute [r] li_class
-      #   @return [String] The class for the li elements
-
-      class Link < Base
-        private
-
-        attr_reader :text, :href, :li_class
-
-        public
-
-        # @param text [String] the text for the footer link
-        # @param href [String] the href for the footer link
-        # @param li_class [String] class for the li elements
-        # @param options [Hash] options that will be used in customising the HTML
+module CCS
+  module Components
+    module GovUK
+      class Footer < Base
+        # = GOV.UK Footer link
         #
-        # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+        # The individual footer footer link item
+        #
+        # @!attribute [r] text
+        #   @return [String] Text for the footer link
+        # @!attribute [r] href
+        #   @return [String] The href for the footer link
+        # @!attribute [r] li_class
+        #   @return [String] The class for the li elements
 
-        def initialize(text:, href:, li_class:, **options)
-          super(**options)
+        class Link < Base
+          private
 
-          @text = text
-          @href = href
-          @li_class = li_class
-        end
+          attr_reader :text, :href, :li_class
 
-        # Generates the HTML for the GOV.UK Footer link
-        #
-        # @return [ActiveSupport::SafeBuffer]
+          public
+
+          # @param text [String] the text for the footer link
+          # @param href [String] the href for the footer link
+          # @param li_class [String] class for the li elements
+          # @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
+
+          def initialize(text:, href:, li_class:, **options)
+            super(**options)
+
+            @text = text
+            @href = href
+            @li_class = li_class
+          end
+
+          # Generates the HTML for the GOV.UK Footer link
+          #
+          # @return [ActiveSupport::SafeBuffer]
 
-        def render
-          tag.li(class: li_class) do
-            options[:attributes][:class] = 'govuk-footer__link'
+          def render
+            tag.li(class: li_class) do
+              options[:attributes][:class] = 'govuk-footer__link'
 
-            link_to(text, href, **options[:attributes])
+              link_to(text, href, **options[:attributes])
+            end
           end
         end
       end