govuk_design_system_formbuilder 1.2.4 → 2.0.0b2

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

@@ -6,27 +6,29 @@ module GOVUKDesignSystemFormBuilder
       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)
+      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)
 
+        @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 = 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       = radio
-          @checkbox    = checkbox
-          @tag         = tag
-          @link_errors = link_errors
-          @caption     = caption
+          @text       = retrieve_text(text, hidden)
+          @size_class = size_class(size)
+          @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,25 +37,29 @@ 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, **@html_attributes) 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),
@@ -77,13 +83,13 @@ module GOVUKDesignSystemFormBuilder
         %(#{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,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

@@ -6,24 +6,25 @@ 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::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

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,19 +29,27 @@ 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

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,28 +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, **label_content, **label_options)
         end
 
         def label_options
-          { radio: true, value: @value, link_errors: @link_errors }
+          { 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

@@ -6,21 +6,22 @@ module GOVUKDesignSystemFormBuilder
       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
@@ -28,26 +29,26 @@ 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
-        [%(#{brand}-select), select_error_class, select_custom_classes].flatten.compact
+      def classes
+        [%(#{brand}-select), error_class, custom_classes].flatten.compact
       end
 
-      def select_error_class
+      def error_class
         %(#{brand}-select--error) if has_errors?
       end
 
-      def select_custom_classes
+      def custom_classes
         @html_options.dig(:class)
       end
     end

data/lib/govuk_design_system_formbuilder/elements/submit.rb

@@ -24,17 +24,18 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def submit
-        @builder.submit(@text, class: submit_classes, **submit_options)
+        @builder.submit(@text, class: classes, **options)
       end
 
-      def submit_classes
+      def classes
         %w(button)
           .prefix(brand)
-          .push(warning_class, secondary_class, disabled_class, padding_class, @classes)
+          .push(warning_class, secondary_class, disabled_class, padding_class, custom_classes)
+          .flatten
           .compact
       end
 
-      def submit_options
+      def options
         {
           formnovalidate: !@validate,
           disabled: @disabled,
@@ -60,6 +61,10 @@ module GOVUKDesignSystemFormBuilder
       def disabled_class
         %(#{brand}-button--disabled) if @disabled
       end
+
+      def custom_classes
+        Array.wrap(@classes)
+      end
     end
   end
 end