govuk_design_system_formbuilder 1.2.0 → 1.2.5

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 = 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?
+          content_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,56 +6,66 @@ 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_text:, legend:, caption:, inline:, small:, bold_labels:, classes:, form_group_classes:, &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_text          = hint_text
+          @classes            = classes
+          @form_group_classes = form_group_classes
+          @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
-              safe_join(
-                [
-                  supplemental_content.html,
-                  hint_element.html,
-                  error_element.html,
-                  Containers::Radios.new(@builder, inline: @inline, small: @small, classes: @classes).html do
-                    safe_join(build_collection)
-                  end
-                ]
-              )
+          Containers::FormGroup.new(@builder, @object_name, @attribute_name, classes: @form_group_classes).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

@@ -24,30 +24,40 @@ module GOVUKDesignSystemFormBuilder
 
         def html
           content_tag('div', class: %(#{brand}-radios__item)) do
-            safe_join(
-              [
-                @builder.radio_button(
-                  @attribute_name,
-                  @value,
-                  id: field_id(link_errors: @link_errors),
-                  aria: { describedby: hint_id },
-                  class: %w(radios__input).prefix(brand)
-                ),
-                label_element.html,
-                hint_element.html
-              ]
-            )
+            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: %w(radios__input).prefix(brand)
+          }
+        end
+
         def hint_element
           @hint_element ||= Elements::Hint.new(@builder, @object_name, @attribute_name, @hint_text, @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

@@ -23,26 +23,23 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def html
-          safe_join(
-            [
-              content_tag('div', class: %(#{brand}-radios__item)) do
-                safe_join(
-                  [
-                    input,
-                    label_element.html,
-                    hint_element.html,
-                  ]
-                )
-              end,
-              @conditional_content
-            ]
-          )
+          safe_join([radio, @conditional_content])
         end
 
       private
 
+        def radio
+          content_tag('div', class: %(#{brand}-radios__item)) do
+            safe_join([input, label_element, hint_element])
+          end
+        end
+
         def label_element
-          @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, radio: true, value: @value, link_errors: @link_errors, **label_args)
+          @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 }
         end
 
         def hint_element
@@ -50,14 +47,16 @@ module GOVUKDesignSystemFormBuilder
         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(radios__input).prefix(brand)
-          )
+          }
         end
 
         def conditional_classes

data/lib/govuk_design_system_formbuilder/elements/select.rb

@@ -1,61 +1,55 @@
 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_text:, label:, caption:, form_group_classes:, &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_text          = hint_text
+        @form_group_classes = form_group_classes
       end
 
       def html
-        Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
-          safe_join(
-            [
-              label_element.html,
-              supplemental_content.html,
-              hint_element.html,
-              error_element.html,
-              @builder.collection_select(
-                @attribute_name,
-                @collection,
-                @value_method,
-                @text_method,
-                @options,
-                build_html_options
-              )
-            ]
-          )
+        Containers::FormGroup.new(@builder, @object_name, @attribute_name, classes: @form_group_classes).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(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

data/lib/govuk_design_system_formbuilder/elements/submit.rb

@@ -3,7 +3,7 @@ module GOVUKDesignSystemFormBuilder
     class Submit < Base
       using PrefixableArray
 
-      def initialize(builder, text, warning:, secondary:, classes:, prevent_double_click:, validate:, &block)
+      def initialize(builder, text, warning:, secondary:, classes:, prevent_double_click:, validate:, disabled:, &block)
         fail ArgumentError, 'buttons can be warning or secondary' if warning && secondary
 
         @builder              = builder
@@ -13,29 +13,39 @@ module GOVUKDesignSystemFormBuilder
         @secondary            = secondary
         @classes              = classes
         @validate             = validate
+        @disabled             = disabled
         @block_content        = capture { block.call } if block_given?
       end
 
       def html
-        safe_join(
-          [
-            @builder.submit(
-              @text,
-              class: %w(button).prefix(brand).push(
-                warning_class,
-                secondary_class,
-                @classes,
-                padding_class(@block_content.present?)
-              ).compact,
-              **extra_args
-            ),
-            @block_content
-          ]
-        )
+        safe_join([submit, @block_content])
       end
 
     private
 
+      def submit
+        @builder.submit(@text, class: classes, **options)
+      end
+
+      def classes
+        %w(button)
+          .prefix(brand)
+          .push(warning_class, secondary_class, disabled_class, padding_class, custom_classes)
+          .flatten
+          .compact
+      end
+
+      def options
+        {
+          formnovalidate: !@validate,
+          disabled: @disabled,
+          data: {
+            module: %(#{brand}-button),
+            'prevent-double-click': @prevent_double_click
+          }.select { |_k, v| v.present? }
+        }
+      end
+
       def warning_class
         %(#{brand}-button--warning) if @warning
       end
@@ -44,17 +54,16 @@ module GOVUKDesignSystemFormBuilder
         %(#{brand}-button--secondary) if @secondary
       end
 
-      def padding_class(content_present)
-        %(#{brand}-!-margin-right-1) if content_present
+      def padding_class
+        %(#{brand}-!-margin-right-1) if @block_content
       end
 
-      def extra_args
-        {
-          formnovalidate: !@validate,
-          data: {
-            module: %(#{brand}-button), 'prevent-double-click' => @prevent_double_click
-          }.select { |_k, v| v.present? }
-        }
+      def disabled_class
+        %(#{brand}-button--disabled) if @disabled
+      end
+
+      def custom_classes
+        Array.wrap(@classes)
       end
     end
   end