govuk_design_system_formbuilder 0.9.8 → 2.0.0

data/lib/govuk_design_system_formbuilder/elements/inputs/phone.rb

@@ -2,6 +2,12 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module Inputs
       class Phone < Base
+        include Traits::Input
+        include Traits::Error
+        include Traits::Hint
+        include Traits::Label
+        include Traits::Supplemental
+
         def builder_method
           :phone_field
         end

data/lib/govuk_design_system_formbuilder/elements/inputs/text.rb

@@ -2,6 +2,12 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module Inputs
       class Text < Base
+        include Traits::Input
+        include Traits::Error
+        include Traits::Hint
+        include Traits::Label
+        include Traits::Supplemental
+
         def builder_method
           :text_field
         end

data/lib/govuk_design_system_formbuilder/elements/inputs/url.rb

@@ -2,6 +2,12 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module Inputs
       class URL < Base
+        include Traits::Input
+        include Traits::Error
+        include Traits::Hint
+        include Traits::Label
+        include Traits::Supplemental
+
         def builder_method
           :url_field
         end

data/lib/govuk_design_system_formbuilder/elements/label.rb

@@ -1,66 +1,95 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
-    class Label < GOVUKDesignSystemFormBuilder::Base
-      def initialize(builder, object_name, attribute_name, text: nil, value: nil, size: nil, hidden: false, radio: false, checkbox: false, tag: nil, link_errors: true)
+    class Label < Base
+      using PrefixableArray
+
+      include Traits::Caption
+      include Traits::Localisation
+
+      def initialize(builder, object_name, attribute_name, text: nil, value: nil, size: nil, hidden: false, radio: false, checkbox: false, tag: nil, link_errors: true, content: nil, caption: nil, **kwargs)
         super(builder, object_name, attribute_name)
 
-        @text           = label_text(text, hidden)
-        @value          = value # used by field_id
-        @size_class     = label_size_class(size)
-        @radio_class    = radio_class(radio)
-        @checkbox_class = checkbox_class(checkbox)
-        @tag            = tag
-        @link_errors    = link_errors
+        @value           = value # used by field_id
+        @tag             = tag
+        @radio           = radio
+        @checkbox        = checkbox
+        @link_errors     = link_errors
+        @html_attributes = kwargs
+
+        # content is passed in directly via a proc and overrides
+        # the other display options
+        if content
+          @content = capture { content.call }
+        else
+          @text       = retrieve_text(text, hidden)
+          @size_class = size_class(size)
+          @caption    = caption
+        end
       end
 
       def html
-        return nil if @text.blank?
+        return nil unless active?
 
         if @tag.present?
-          content_tag(@tag, class: 'govuk-label-wrapper') { build_label }
+          content_tag(@tag, class: %(#{brand}-label-wrapper)) { label }
         else
-          build_label
+          label
         end
       end
 
+      def active?
+        [@content, @text].any?(&:present?)
+      end
+
     private
 
-      def build_label
-        @builder.label(
-          @attribute_name,
-          value: @value,
-          for: field_id(link_errors: @link_errors),
-          class: %w(govuk-label).push(@size_class, @weight_class, @radio_class, @checkbox_class).compact
-        ) do
-          @text
+      def label
+        @builder.label(@attribute_name, **options, **@html_attributes) do
+          @content || safe_join([caption, @text])
         end
       end
 
-      def label_text(option_text, hidden)
-        text = [option_text, @value, @attribute_name.capitalize].compact.first
+      def retrieve_text(option_text, hidden)
+        text = [option_text, localised_text(:label), @attribute_name.capitalize].compact.first
 
         if hidden
-          tag.span(text, class: %w(govuk-visually-hidden))
+          tag.span(text, class: %(#{brand}-visually-hidden))
         else
-          raw(text)
+          text
         end
       end
 
-      def radio_class(radio)
-        radio ? 'govuk-radios__label' : nil
+      def options
+        {
+          value: @value,
+          for: field_id(link_errors: @link_errors),
+          class: %w(label).prefix(brand).push(@size_class, @weight_class, radio_class, checkbox_class).compact
+        }
+      end
+
+      def caption
+        caption_element.html unless [@radio, @checkbox].any?
       end
 
-      def checkbox_class(checkbox)
-        checkbox ? 'govuk-checkboxes__label' : nil
+      def radio_class
+        return nil unless @radio
+
+        %(#{brand}-radios__label)
+      end
+
+      def checkbox_class
+        return nil unless @checkbox
+
+        %(#{brand}-checkboxes__label)
       end
 
-      def label_size_class(size)
+      def size_class(size)
         case size
-        when 'xl'      then "govuk-label--xl"
-        when 'l'       then "govuk-label--l"
-        when 'm'       then "govuk-label--m"
-        when 's'       then "govuk-label--s"
-        when nil       then nil
+        when 'xl' then %(#{brand}-label--xl)
+        when 'l'  then %(#{brand}-label--l)
+        when 'm'  then %(#{brand}-label--m)
+        when 's'  then %(#{brand}-label--s)
+        when nil  then nil
         else
           fail "invalid size '#{size}', must be xl, l, m, s or nil"
         end

data/lib/govuk_design_system_formbuilder/elements/legend.rb

@@ -0,0 +1,87 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    class Legend < Base
+      include Traits::Caption
+      include Traits::Localisation
+
+      def initialize(builder, object_name, attribute_name, legend:, caption:, **kwargs)
+        super(builder, object_name, attribute_name)
+
+        @html_attributes = kwargs
+
+        case legend
+        when NilClass
+          @active = false
+        when Proc
+          @raw = capture { legend.call }
+        when Hash
+          defaults.merge(legend).tap do |l|
+            @text    = retrieve_text(l.dig(:text))
+            @hidden  = l.dig(:hidden)
+            @tag     = l.dig(:tag)
+            @size    = l.dig(:size)
+            @caption = caption
+          end
+        else
+          fail(ArgumentError, %(legend must be a Proc or Hash))
+        end
+      end
+
+      def html
+        @raw || content
+      end
+
+    private
+
+      def active?
+        [@text, @raw].any?(&:present?)
+      end
+
+      def content
+        return nil unless active?
+
+        tag.legend(class: classes, **@html_attributes) do
+          content_tag(@tag, class: heading_classes) do
+            safe_join([caption_element, @text])
+          end
+        end
+      end
+
+      def retrieve_text(supplied_text)
+        [supplied_text, localised_text(:legend), @attribute_name&.capitalize].compact.first
+      end
+
+      def classes
+        [%(#{brand}-fieldset__legend), size_class, visually_hidden_class].compact
+      end
+
+      def size_class
+        case @size
+        when 'xl' then %(#{brand}-fieldset__legend--xl)
+        when 'l'  then %(#{brand}-fieldset__legend--l)
+        when 'm'  then %(#{brand}-fieldset__legend--m)
+        when 's'  then %(#{brand}-fieldset__legend--s)
+        else
+          fail "invalid size '#{@size}', must be xl, l, m or s"
+        end
+      end
+
+      def visually_hidden_class
+        %(#{brand}-visually-hidden) if @hidden
+      end
+
+      def heading_classes
+        %(#{brand}-fieldset__heading)
+      end
+
+      def defaults
+        {
+          hidden: false,
+          text: nil,
+          tag:  config.default_legend_tag,
+          size: config.default_legend_size
+        }
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/elements/radios/collection.rb

@@ -1,55 +1,71 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     module Radios
-      class Collection < GOVUKDesignSystemFormBuilder::Base
-        def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint_method:, hint_text:, legend:, inline:, small:, bold_labels:, &block)
+      class Collection < Base
+        include Traits::Error
+        include Traits::Hint
+        include Traits::Supplemental
+
+        def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint_method:, hint:, legend:, caption:, inline:, small:, bold_labels:, classes:, form_group:, &block)
           super(builder, object_name, attribute_name, &block)
 
-          @collection    = collection
-          @value_method  = value_method
-          @text_method   = text_method
-          @hint_method   = hint_method
-          @inline        = inline
-          @small         = small
-          @legend        = legend
-          @hint_text     = hint_text
-          @bold_labels   = hint_method.present? || bold_labels
+          @collection   = collection
+          @value_method = value_method
+          @text_method  = text_method
+          @hint_method  = hint_method
+          @inline       = inline
+          @small        = small
+          @legend       = legend
+          @caption      = caption
+          @hint         = hint
+          @classes      = classes
+          @form_group   = form_group
+          @bold_labels  = hint_method.present? || bold_labels
         end
 
         def html
-          Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
-            Containers::Fieldset.new(@builder, legend: @legend, described_by: [error_id, hint_id, supplemental_id]).html do
-              safe_join(
-                [
-                  hint_element.html,
-                  error_element.html,
-                  supplemental_content.html,
-                  Containers::Radios.new(@builder, inline: @inline, small: @small).html do
-                    safe_join(build_collection)
-                  end
-                ]
-              )
+          Containers::FormGroup.new(@builder, @object_name, @attribute_name, **@form_group).html do
+            Containers::Fieldset.new(@builder, @object_name, @attribute_name, **fieldset_options).html do
+              safe_join([supplemental_content, hint_element, error_element, radios])
             end
           end
         end
 
       private
 
-        def build_collection
+        def fieldset_options
+          {
+            legend: @legend,
+            caption: @caption,
+            described_by: [error_id, hint_id, supplemental_id]
+          }
+        end
+
+        def radios
+          Containers::Radios.new(@builder, inline: @inline, small: @small, classes: @classes).html do
+            safe_join(collection)
+          end
+        end
+
+        def collection
           @collection.map.with_index do |item, i|
-            Elements::Radios::CollectionRadioButton.new(
-              @builder,
-              @object_name,
-              @attribute_name,
-              item,
-              value_method: @value_method,
-              text_method: @text_method,
-              hint_method: @hint_method,
-              link_errors: has_errors? && i.zero?,
-              bold_labels: @bold_labels
-            ).html
+            Elements::Radios::CollectionRadioButton.new(@builder, @object_name, @attribute_name, item, **collection_options(i)).html
           end
         end
+
+        def collection_options(index)
+          {
+            value_method: @value_method,
+            text_method: @text_method,
+            hint_method: @hint_method,
+            link_errors: link_errors?(index),
+            bold_labels: @bold_labels
+          }
+        end
+
+        def link_errors?(index)
+          has_errors? && index.zero?
+        end
       end
     end
   end

data/lib/govuk_design_system_formbuilder/elements/radios/collection_radio_button.rb

@@ -2,46 +2,68 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module Radios
       class CollectionRadioButton < Base
+        include Traits::Hint
+        include Traits::CollectionItem
+
         # @param link_errors [Boolean] used to control the id generated for radio buttons. The
         #   error summary requires that the id of the first radio is linked-to from the corresponding
         #   error message. As when the summary is built what happens later in the form is unknown, we
         #   need to control this to ensure the link is generated correctly
         def initialize(builder, object_name, attribute_name, item, value_method:, text_method:, hint_method:, link_errors: false, bold_labels:)
           super(builder, object_name, attribute_name)
+
           @item        = item
-          @value       = item.send(value_method)
-          @text        = item.send(text_method)
-          @hint_text   = item.send(hint_method) if hint_method.present?
+          @value       = retrieve(item, value_method)
+          @label_text  = retrieve(item, text_method)
+          @hint_text   = retrieve(item, hint_method)
           @link_errors = link_errors
           @bold_labels = bold_labels
         end
 
         def html
-          content_tag('div', class: 'govuk-radios__item') do
-            safe_join(
-              [
-                @builder.radio_button(
-                  @attribute_name,
-                  @value,
-                  id: field_id(link_errors: @link_errors),
-                  aria: { describedby: hint_id },
-                  class: %w(govuk-radios__input)
-                ),
-                label_element.html,
-                hint_element.html
-              ]
-            )
+          tag.div(class: %(#{brand}-radios__item)) do
+            safe_join([radio, label_element, hint_element])
           end
         end
 
       private
 
+        def radio
+          @builder.radio_button(@attribute_name, @value, **options)
+        end
+
+        def options
+          {
+            id: field_id(link_errors: @link_errors),
+            aria: { describedby: hint_id },
+            class: %(#{brand}-radios__input)
+          }
+        end
+
         def hint_element
-          @hint_element ||= Elements::Hint.new(@builder, @object_name, @attribute_name, @hint_text, @value, radio: true)
+          @hint_element ||= Elements::Hint.new(@builder, @object_name, @attribute_name, **hint_options, **hint_content)
+        end
+
+        def hint_content
+          { text: @hint_text }
+        end
+
+        def hint_options
+          { value: @value, radio: true }
         end
 
         def label_element
-          @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, text: @text, value: @value, radio: true, size: label_size, link_errors: @link_errors)
+          @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, **label_options)
+        end
+
+        def label_options
+          {
+            text: @label_text,
+            value: @value,
+            radio: true,
+            size: label_size,
+            link_errors: @link_errors
+          }
         end
 
         def label_size

data/lib/govuk_design_system_formbuilder/elements/radios/fieldset_radio_button.rb

@@ -2,12 +2,18 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module Radios
       class FieldsetRadioButton < Base
-        def initialize(builder, object_name, attribute_name, value, label:, hint_text:, link_errors:, &block)
+        using PrefixableArray
+
+        include Traits::Label
+        include Traits::Hint
+        include Traits::Conditional
+
+        def initialize(builder, object_name, attribute_name, value, label:, hint:, link_errors:, &block)
           super(builder, object_name, attribute_name)
 
           @value       = value
           @label       = label
-          @hint_text   = hint_text
+          @hint        = hint
           @link_errors = has_errors? && link_errors
 
           if block_given?
@@ -17,45 +23,52 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def html
-          safe_join(
-            [
-              content_tag('div', class: 'govuk-radios__item') do
-                safe_join(
-                  [
-                    input,
-                    label_element.html,
-                    hint_element.html,
-                  ]
-                )
-              end,
-              @conditional_content
-            ]
-          )
+          safe_join([radio, @conditional_content])
         end
 
       private
 
+        def radio
+          tag.div(class: %(#{brand}-radios__item)) do
+            safe_join([input, label_element, hint_element])
+          end
+        end
+
+        def radio_options
+          { radio: true }
+        end
+
         def label_element
-          @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, radio: true, value: @value, **@label, link_errors: @link_errors)
+          @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, **label_content, **label_options)
+        end
+
+        def label_options
+          { value: @value, link_errors: @link_errors }.merge(radio_options)
         end
 
         def hint_element
-          @hint_element ||= Elements::Hint.new(@builder, @object_name, @attribute_name, @hint_text, radio: true)
+          @hint_element ||= Elements::Hint.new(@builder, @object_name, @attribute_name, **hint_options, **hint_content)
+        end
+
+        def hint_options
+          { value: @value }.merge(radio_options)
         end
 
         def input
-          @builder.radio_button(
-            @attribute_name,
-            @value,
+          @builder.radio_button(@attribute_name, @value, **options)
+        end
+
+        def options
+          {
             id: field_id(link_errors: @link_errors),
             aria: { describedby: hint_id },
             data: { 'aria-controls' => @conditional_id },
-            class: %w(govuk-radios__input)
-          )
+            class: %w(radios__input).prefix(brand)
+          }
         end
 
         def conditional_classes
-          %w(govuk-radios__conditional govuk-radios__conditional--hidden)
+          %w(radios__conditional radios__conditional--hidden).prefix(brand)
         end
       end
     end

data/lib/govuk_design_system_formbuilder/elements/select.rb

@@ -1,53 +1,55 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
-    class Select < GOVUKDesignSystemFormBuilder::Base
-      def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, options: {}, html_options: {}, hint_text:, label:, &block)
+    class Select < Base
+      include Traits::Error
+      include Traits::Label
+      include Traits::Hint
+      include Traits::Supplemental
+
+      def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, options: {}, html_options: {}, hint:, label:, caption:, form_group:, &block)
         super(builder, object_name, attribute_name, &block)
 
-        @collection    = collection
-        @value_method  = value_method
-        @text_method   = text_method
-        @options       = options
-        @html_options  = html_options
-        @label         = label
-        @hint_text     = hint_text
+        @collection   = collection
+        @value_method = value_method
+        @text_method  = text_method
+        @options      = options
+        @html_options = html_options
+        @label        = label
+        @caption      = caption
+        @hint         = hint
+        @form_group   = form_group
       end
 
       def html
-        Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
-          safe_join(
-            [
-              label_element.html,
-              hint_element.html,
-              error_element.html,
-              supplemental_content.html,
-              @builder.collection_select(
-                @attribute_name,
-                @collection,
-                @value_method,
-                @text_method,
-                @options,
-                build_html_options
-              )
-            ]
-          )
+        Containers::FormGroup.new(@builder, @object_name, @attribute_name, **@form_group).html do
+          safe_join([label_element, supplemental_content, hint_element, error_element, select])
         end
       end
 
     private
 
-      def build_html_options
+      def select
+        @builder.collection_select(@attribute_name, @collection, @value_method, @text_method, @options, **options)
+      end
+
+      def options
         @html_options.deep_merge(
           id: field_id(link_errors: true),
-          class: select_classes,
+          class: classes,
           aria: { describedby: described_by(hint_id, error_id, supplemental_id) }
         )
       end
 
-      def select_classes
-        %w(govuk-select).tap do |classes|
-          classes.push('govuk-select--error') if has_errors?
-        end
+      def classes
+        [%(#{brand}-select), error_class, custom_classes].flatten.compact
+      end
+
+      def error_class
+        %(#{brand}-select--error) if has_errors?
+      end
+
+      def custom_classes
+        @html_options.dig(:class)
       end
     end
   end