govuk_design_system_formbuilder 1.2.3 → 2.0.0b1

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

@@ -2,14 +2,14 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module Inputs
       class Email < Base
-        using PrefixableArray
-
         include Traits::Input
         include Traits::Error
         include Traits::Hint
         include Traits::Label
         include Traits::Supplemental
 
+      private
+
         def builder_method
           :email_field
         end

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

@@ -2,8 +2,6 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module Inputs
       class Number < Base
-        using PrefixableArray
-
         include Traits::Input
         include Traits::Error
         include Traits::Hint

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

@@ -2,8 +2,6 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module Inputs
       class Password < Base
-        using PrefixableArray
-
         include Traits::Input
         include Traits::Error
         include Traits::Hint

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

@@ -2,8 +2,6 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module Inputs
       class Phone < Base
-        using PrefixableArray
-
         include Traits::Input
         include Traits::Error
         include Traits::Hint

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

@@ -2,8 +2,6 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module Inputs
       class Text < Base
-        using PrefixableArray
-
         include Traits::Input
         include Traits::Error
         include Traits::Hint

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

@@ -2,8 +2,6 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module Inputs
       class URL < Base
-        using PrefixableArray
-
         include Traits::Input
         include Traits::Error
         include Traits::Hint

data/lib/govuk_design_system_formbuilder/elements/label.rb

@@ -12,21 +12,21 @@ module GOVUKDesignSystemFormBuilder
         # content is passed in directly via a proc and overrides
         # the other display options
         if content
-          @content = content.call
+          @content = capture { content.call }
         else
-          @value          = value # used by field_id
-          @text           = label_text(text, hidden)
-          @size_class     = label_size_class(size)
-          @radio_class    = radio_class(radio)
-          @checkbox_class = checkbox_class(checkbox)
-          @tag            = tag
-          @link_errors    = link_errors
-          @caption        = caption
+          @value       = value # used by field_id
+          @text        = retrieve_text(text, hidden)
+          @size_class  = size_class(size)
+          @radio       = radio
+          @checkbox    = checkbox
+          @tag         = tag
+          @link_errors = link_errors
+          @caption     = caption
         end
       end
 
       def html
-        return nil if [@content, @text].all?(&:blank?)
+        return nil unless active?
 
         if @tag.present?
           content_tag(@tag, class: %(#{brand}-label-wrapper)) { label }
@@ -35,51 +35,59 @@ module GOVUKDesignSystemFormBuilder
         end
       end
 
+      def active?
+        [@content, @text].any?(&:present?)
+      end
+
     private
 
       def label
-        @builder.label(@attribute_name, label_options) do
+        @builder.label(@attribute_name, **options) do
           @content || safe_join([caption, @text])
         end
       end
 
-      def label_text(option_text, hidden)
-        text = [option_text, localised_text(:label), @attribute_name.capitalize].compact.first.to_s
+      def retrieve_text(option_text, hidden)
+        text = [option_text, localised_text(:label), @attribute_name.capitalize].compact.first
 
         if hidden
-          tag.span(text, class: %w(visually-hidden).prefix(brand))
+          tag.span(text, class: %(#{brand}-visually-hidden))
         else
           text
         end
       end
 
-      def label_options
+      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
+          class: %w(label).prefix(brand).push(@size_class, @weight_class, radio_class, checkbox_class).compact
         }
       end
 
       def caption
-        caption_element.html unless [@radio_class, @checkbox_class].any?
+        caption_element.html unless [@radio, @checkbox].any?
       end
 
-      def radio_class(radio)
-        radio ? %(#{brand}-radios__label) : nil
+      def radio_class
+        return nil unless @radio
+
+        %(#{brand}-radios__label)
       end
 
-      def checkbox_class(checkbox)
-        checkbox ? %(#{brand}-checkboxes__label) : nil
+      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 %(#{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
+        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,79 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    class Legend < Base
+      include Traits::Caption
+      include Traits::Localisation
+
+      def initialize(builder, object_name, attribute_name, legend:, caption:)
+        super(builder, object_name, attribute_name)
+
+        case legend
+        when Proc
+          @raw = capture { legend.call }
+        when Hash
+          defaults.merge(legend).tap do |l|
+            @text    = 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 content
+        if @text.present?
+          tag.legend(class: classes) do
+            content_tag(@tag, class: heading_classes) do
+              safe_join([caption_element, @text])
+            end
+          end
+        end
+      end
+
+      def text(supplied_text)
+        supplied_text || localised_text(:legend)
+      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

@@ -6,25 +6,26 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Hint
         include Traits::Supplemental
 
-        def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint_method:, hint_text:, legend:, caption:, inline:, small:, bold_labels:, classes:, &block)
+        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
-          @caption       = caption
-          @hint_text     = hint_text
-          @classes       = classes
-          @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, @object_name, @attribute_name, legend: @legend, caption: @caption, described_by: [error_id, hint_id, supplemental_id]).html do
+          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
@@ -32,6 +33,14 @@ module GOVUKDesignSystemFormBuilder
 
       private
 
+        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)

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

@@ -2,8 +2,6 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module Radios
       class CollectionRadioButton < Base
-        using PrefixableArray
-
         include Traits::Hint
         include Traits::CollectionItem
 
@@ -23,7 +21,7 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def html
-          content_tag('div', class: %(#{brand}-radios__item)) do
+          tag.div(class: %(#{brand}-radios__item)) do
             safe_join([radio, label_element, hint_element])
           end
         end
@@ -31,23 +29,41 @@ module GOVUKDesignSystemFormBuilder
       private
 
         def radio
-          @builder.radio_button(@attribute_name, @value, **radio_options)
+          @builder.radio_button(@attribute_name, @value, **options)
         end
 
-        def radio_options
+        def options
           {
             id: field_id(link_errors: @link_errors),
             aria: { describedby: hint_id },
-            class: %w(radios__input).prefix(brand)
+            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: @label_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

@@ -8,12 +8,12 @@ module GOVUKDesignSystemFormBuilder
         include Traits::Hint
         include Traits::Conditional
 
-        def initialize(builder, object_name, attribute_name, value, label:, hint_text:, link_errors:, &block)
+        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?
@@ -29,24 +29,36 @@ module GOVUKDesignSystemFormBuilder
       private
 
         def radio
-          content_tag('div', class: %(#{brand}-radios__item)) do
+          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, link_errors: @link_errors, **label_options)
+          @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, **label_content, **label_options, **@label)
+        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, @value, 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, input_options)
+          @builder.radio_button(@attribute_name, @value, **options)
         end
 
-        def input_options
+        def options
           {
             id: field_id(link_errors: @link_errors),
             aria: { describedby: hint_id },

data/lib/govuk_design_system_formbuilder/elements/select.rb

@@ -1,28 +1,27 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     class Select < Base
-      using PrefixableArray
-
       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_text:, label:, caption:, &block)
+      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
-        @caption       = caption
-        @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
+        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
@@ -30,21 +29,27 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def select
-        @builder.collection_select(@attribute_name, @collection, @value_method, @text_method, @options, select_options)
+        @builder.collection_select(@attribute_name, @collection, @value_method, @text_method, @options, **options)
       end
 
-      def select_options
+      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(select).prefix(brand).tap do |classes|
-          classes.push(%(#{brand}-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