govuk_design_system_formbuilder 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb762e8a359cd08175a12d4589052ea02fe5d30cdd74b0d970ba8b52c8ac09c2
+  data.tar.gz: a190f9073ebcd4d59abb9c62485be024f729343544fbc278c2dbbb3d5949b14a
+SHA512:
+  metadata.gz: 20a8147da81aa6add15ec3500ffd849e18ef5f29add89a4d10511d90be78eca08a278315ae17036c5c5ae1e7861408d27133c8f2dcb84faf30e032b7219b142c
+  data.tar.gz: 5f1e669b7248b062727a7b960aa4448c216a9ad4d30d5ead7314d8989430925b31fd700ed7cd34d4613e0c81465a358d61d59ca4ff47abc8a161b145338e8879

data/README.md

@@ -0,0 +1 @@
+# GOV.UK Form Builder

data/lib/govuk_design_system_formbuilder/base.rb

@@ -0,0 +1,45 @@
+module GOVUKDesignSystemFormBuilder
+  class Base
+    def initialize(builder, object_name, attribute_name)
+      @builder = builder
+      @object_name = object_name
+      @attribute_name = attribute_name
+    end
+
+    def html
+      fail 'should be overridden'
+    end
+
+    def hint_id
+      return nil unless @text.present?
+
+      @hint_id || [@object_name, @attribute_name, 'hint'].join('-').parameterize
+    end
+
+    def error_id
+      return nil unless has_errors?
+
+      [@object_name, @attribute_name, 'error'].join('-').parameterize
+    end
+
+    def conditional_id
+      [@object_name, @attribute_name, @value, 'conditional'].join('-').parameterize
+    end
+
+    def has_errors?
+      @builder.object.invalid? &&
+        @builder.object.errors.messages.keys.include?(@attribute_name)
+    end
+
+    def attribute_descriptor
+      [@object_name, @attribute_name, @value].compact.join('_').parameterize
+    end
+
+    def attribute_identifier
+      "%<object_name>s[%<attribute_name>s]" % {
+        object_name: @object_name,
+        attribute_name: @attribute_name
+      }
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/builder.rb

@@ -0,0 +1,163 @@
+module GOVUKDesignSystemFormBuilder
+  module Builder
+    def govuk_text_field(attribute_name, hint: {}, label: {}, **args)
+      Elements::Input.new(self, object_name, attribute_name, attribute_type: :text, hint: hint, label: label, **args).html
+    end
+
+    def govuk_phone_field(attribute_name, hint: {}, label: {}, **args)
+      Elements::Input.new(self, object_name, attribute_name, attribute_type: :phone, hint: hint, label: label, **args).html
+    end
+
+    def govuk_email_field(attribute_name, hint: {}, label: {}, **args)
+      Elements::Input.new(self, object_name, attribute_name, attribute_type: :email, hint: hint, label: label, **args).html
+    end
+
+    def govuk_url_field(attribute_name, hint: {}, label: {}, **args)
+      Elements::Input.new(self, object_name, attribute_name, attribute_type: :url, hint: hint, label: label, **args).html
+    end
+
+    def govuk_number_field(attribute_name, hint: {}, label: {}, **args)
+      Elements::Input.new(self, object_name, attribute_name, attribute_type: :number, hint: hint, label: label, **args).html
+    end
+
+    def govuk_text_area(attribute_name, hint: {}, label: {}, max_words: nil, max_chars: nil, rows: 5, **args)
+      Elements::TextArea.new(self, object_name, attribute_name, hint: hint, label: label, max_words: max_words, max_chars: max_chars, rows: rows, **args).html
+    end
+
+    # FIXME #govuk_collection_select args differ from Rails' #collection_select args in that
+    # options: and :html_options are keyword arguments. Leaving them as regular args with
+    # defaults and following them with keyword args (hint and label) doesn't seem to work
+    def govuk_collection_select(attribute_name, collection, value_method, text_method, options: {}, html_options: {}, hint: {}, label: {})
+      label_element = Elements::Label.new(self, object_name, attribute_name, label)
+      hint_element  = Elements::Hint.new(self, object_name, attribute_name, hint)
+      error_element = Elements::ErrorMessage.new(self, object_name, attribute_name)
+
+      Containers::FormGroup.new(self, object_name, attribute_name).html do
+        safe_join([
+          label_element.html,
+          hint_element.html,
+          error_element.html,
+
+          (yield if block_given?),
+
+          collection_select(
+            attribute_name,
+            collection,
+            value_method,
+            text_method,
+            options,
+            html_options.merge(
+              aria: {
+                describedby: [
+                  hint_element.hint_id,
+                  error_element.error_id
+                ].compact.join(' ').presence
+              }
+            )
+          )
+        ])
+      end
+    end
+
+    def govuk_collection_radio_buttons(attribute_name, collection, value_method, text_method, hint_method = nil, options: { inline: false }, html_options: {}, hint: {}, legend: {})
+      hint_element  = Elements::Hint.new(self, object_name, attribute_name, hint)
+      Containers::FormGroup.new(self, object_name, attribute_name).html do
+        safe_join(
+          [
+            hint_element.html,
+            Containers::Fieldset.new(self, object_name, attribute_name, legend: legend, described_by: hint_element.hint_id).html do
+              safe_join(
+                [
+                  (yield if block_given?),
+                  Containers::Radios.new(self, inline: options.dig(:inline)).html do
+                    safe_join(
+                      collection.map do |item|
+                        Elements::Radios::CollectionRadio.new(self, object_name, attribute_name, item, value_method, text_method, hint_method).html
+                      end
+                    )
+                  end
+                ].compact
+              )
+            end
+          ]
+        )
+      end
+    end
+
+    def govuk_radio_buttons_fieldset(attribute_name, options: { inline: false }, hint: {}, legend: {})
+      hint_element  = Elements::Hint.new(self, object_name, attribute_name, hint)
+
+      Containers::FormGroup.new(self, object_name, attribute_name).html do
+        safe_join([
+          hint_element.html,
+          Containers::Fieldset.new(self, object_name, attribute_name, legend: legend, described_by: hint_element.hint_id).html do
+            Containers::Radios.new(self, inline: options.dig(:inline)).html do
+              yield
+            end
+          end
+        ])
+      end
+    end
+
+    # only intended for use inside a #govuk_radio_buttons_fieldset
+    def govuk_radio_button(attribute_name, value, hint: {}, label: {})
+      Elements::Radios::FieldsetRadio.new(self, object_name, attribute_name, value, hint: hint, label: label).html do
+        (yield if block_given?)
+      end
+    end
+
+    def govuk_radio_divider(text = 'or')
+      tag.div(text, class: %w(govuk-radios__divider))
+    end
+
+    def govuk_collection_check_boxes(attribute_name, collection, value_method, text_method, hint_method = nil, html_options: {}, hint: {}, legend: {})
+      hint_element  = Elements::Hint.new(self, object_name, attribute_name, hint)
+      Containers::FormGroup.new(self, object_name, attribute_name).html do
+        safe_join(
+          [
+            hint_element.html,
+            (yield if block_given?),
+            Containers::Fieldset.new(self, object_name, attribute_name, legend: legend, described_by: hint_element.hint_id).html do
+              collection_check_boxes(attribute_name, collection, value_method, text_method) do |check_box|
+                Elements::CheckBoxes::CollectionCheckBox.new(self, attribute_name, check_box, hint_method).html
+              end
+            end
+          ]
+        )
+      end
+    end
+
+    def govuk_check_boxes_fieldset(attribute_name, html_options: {}, hint: {}, legend: {})
+      hint_element  = Elements::Hint.new(self, object_name, attribute_name, hint)
+
+      Containers::FormGroup.new(self, object_name, attribute_name).html do
+        safe_join([
+          hint_element.html,
+          Containers::Fieldset.new(self, object_name, attribute_name, legend: legend, described_by: hint_element.hint_id).html do
+            Containers::CheckBoxes.new(self).html do
+              yield
+            end
+          end
+        ])
+      end
+    end
+
+    def govuk_check_box(attribute_name, value, hint: {}, label: {})
+      Elements::CheckBox.new(self, object_name, attribute_name, value, hint: hint, label: label).html do
+        (yield if block_given?)
+      end
+    end
+
+    def govuk_submit(text = 'Continue', warning: false, secondary: false, prevent_double_click: true)
+      Elements::Submit.new(self, text, warning: warning, secondary: secondary, prevent_double_click: prevent_double_click).html do
+        (yield if block_given?)
+      end
+    end
+
+    def govuk_date_field(attribute_name, hint: {}, legend: {})
+      Elements::Date.new(self, object_name, attribute_name, hint: hint, legend: legend).html do
+        (yield if block_given?)
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/containers/character_count.rb

@@ -0,0 +1,38 @@
+module GOVUKDesignSystemFormBuilder
+  module Containers
+    class CharacterCount < Base
+      def initialize(builder, max_words:, max_chars:)
+        @builder = builder
+        fail ArgumentError, 'limit can be words or chars' if max_words && max_chars
+        @max_words = max_words
+        @max_chars = max_chars
+      end
+
+      def html
+        return yield unless limit?
+
+        @builder.content_tag(
+          'div',
+          class: 'govuk-character-count',
+          data: { module: 'character-count' }.merge(limit)
+        ) do
+          yield
+        end
+      end
+
+    private
+
+      def limit
+        if @max_words
+          { maxwords: @max_words }
+        elsif @max_chars
+          { maxlength: @max_chars }
+        end
+      end
+
+      def limit?
+        @max_words || @max_chars
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/containers/check_boxes.rb

@@ -0,0 +1,15 @@
+module GOVUKDesignSystemFormBuilder
+  module Containers
+    class CheckBoxes < Base
+      def initialize(builder)
+        @builder = builder
+      end
+
+      def html
+        @builder.content_tag('div', class: 'govuk-checkboxes', data: { module: 'checkboxes' }) do
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/containers/fieldset.rb

@@ -0,0 +1,47 @@
+module GOVUKDesignSystemFormBuilder
+  module Containers
+    class Fieldset < GOVUKDesignSystemFormBuilder::Base
+      LEGEND_DEFAULTS = { text: nil, tag: 'h1', size: 'xl' }.freeze
+      LEGEND_SIZES = %w(xl l m s)
+
+      def initialize(builder, object_name, attribute_name, legend: {}, described_by: nil)
+        super(builder, object_name, attribute_name)
+        @legend = LEGEND_DEFAULTS.merge(legend)
+        @described_by = described_by
+      end
+
+      def html
+        @builder.content_tag('div', class: fieldset_classes, aria: { describedby: @described_by }) do
+          @builder.safe_join([
+            build_legend,
+            yield
+          ])
+        end
+      end
+
+    private
+
+      def build_legend
+        if @legend.dig(:text).present?
+          @builder.content_tag('legend', class: legend_classes) do
+            @builder.tag.send(@legend.dig(:tag), @legend.dig(:text), class: legend_heading_classes)
+          end
+        end
+      end
+
+      def fieldset_classes
+        %w(govuk-fieldset)
+      end
+
+      def legend_classes
+        size = @legend.dig(:size)
+        fail "invalid size #{size}, must be #{LEGEND_SIZES.join(', ')}" unless size.in?(LEGEND_SIZES)
+        "govuk-fieldset__legend govuk-fieldset__legend--#{size}"
+      end
+
+      def legend_heading_classes
+        %(govuk-fieldset__heading)
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/containers/form_group.rb

@@ -0,0 +1,27 @@
+module GOVUKDesignSystemFormBuilder
+  module Containers
+    class FormGroup < GOVUKDesignSystemFormBuilder::Base
+      def initialize(builder, object_name, attribute_name)
+        super(builder, object_name, attribute_name)
+      end
+
+      def html
+        @builder.content_tag('div', class: form_group_classes) do
+          yield
+        end
+      end
+
+    private
+
+      def form_group_classes
+        %w(govuk-form-group).push(form_group_error_classes).compact
+      end
+
+      def form_group_error_classes
+        return nil unless has_errors?
+
+        'govuk-form-group--error'
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/containers/radios.rb

@@ -0,0 +1,23 @@
+module GOVUKDesignSystemFormBuilder
+  module Containers
+    class Radios < GOVUKDesignSystemFormBuilder::Base
+      def initialize(builder, inline:)
+        @builder = builder
+        @inline = inline
+      end
+
+      def html
+        @builder.content_tag('div', class: radios_classes, data: { module: 'radios' }) do
+          yield
+        end
+      end
+    private
+
+      def radios_classes
+        %w(govuk-radios).tap do |c|
+          c.push('govuk-radios--inline') if @inline
+        end
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/elements/check_box.rb

@@ -0,0 +1,84 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    class CheckBox < GOVUKDesignSystemFormBuilder::Base
+      def initialize(builder, object_name, attribute_name, value, label:, hint:)
+        super(builder, object_name, attribute_name)
+        @value = value
+        @label = label
+        @hint  = hint
+      end
+
+      def html(&block)
+        @conditional_content, @conditional_id = process(block)
+
+        @builder.content_tag('div', class: 'govuk-checkboxes__item') do
+          @builder.safe_join(
+            [
+              input,
+
+              Elements::Label.new(
+                @builder,
+                @object_name,
+                @attribute_name,
+                { value: @value.parameterize, text: @value }.merge(@label)
+              ).html,
+
+              Elements::Hint.new(
+                @builder,
+                @object_name,
+                @attribute_name,
+                id: hint_id,
+                class: check_box_hint_classes,
+                **@hint
+              ).html,
+
+              conditional_content
+            ]
+          )
+        end
+      end
+
+    private
+
+      def input
+        @builder.check_box(
+          @attribute_name,
+          id: attribute_descriptor,
+          class: check_box_classes,
+          aria: { describedby: hint_id },
+          data: { 'aria-controls' => @conditional_id }
+        )
+      end
+
+      def conditional_content
+        return nil unless @conditional_content.present?
+
+        @builder.content_tag('div', class: conditional_classes, id: @conditional_id) do
+          @conditional_content
+        end
+      end
+
+      def process(block)
+        return content = block.call, (content && conditional_id)
+      end
+
+      def conditional_classes
+        %w(govuk-checkboxes__conditional govuk-checkboxes__conditional--hidden)
+      end
+
+      def hint_id
+        return nil unless @hint['text'].present?
+
+        [@object_name, @attribute_name, @value, 'hint'].join('-').parameterize
+      end
+
+      def check_box_classes
+        %w(govuk-checkbox)
+      end
+
+      def check_box_hint_classes
+        %w(govuk-hint govuk-checkboxes__hint)
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/elements/check_boxes/collection_check_box.rb

@@ -0,0 +1,28 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    module CheckBoxes
+      class CollectionCheckBox < GOVUKDesignSystemFormBuilder::Base
+        def initialize(builder, attribute, checkbox, hint_method = nil)
+          @builder  = builder
+          @attribute = attribute
+          @checkbox = checkbox
+          @item     = checkbox.object
+          @hint     = @item.send(hint_method) if hint_method.present?
+        end
+
+        def html
+          hint = Hint.new(@builder, @attribute, @checkbox, @hint)
+          @builder.content_tag('div', class: 'govuk-checkboxes__item') do
+            @builder.safe_join(
+              [
+                @checkbox.check_box(class: "govuk-checkboxes_input", aria: { describedby: hint.id }),
+                Label.new(@checkbox).html,
+                hint.html
+              ]
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/elements/check_boxes/hint.rb

@@ -0,0 +1,38 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    module CheckBoxes
+      class Hint
+        def initialize(builder, attribute, checkbox, text)
+          @builder = builder
+          @attribute = attribute
+          @checkbox = checkbox
+          @text    = text
+        end
+
+        def html
+          return nil if @text.blank?
+
+          @builder.tag.span(@text, class: hint_classes, id: id)
+        end
+
+        def id
+          return nil if @text.blank?
+
+          [
+            @attribute,
+            @checkbox.object.id,
+            'hint'
+          ]
+            .join('-')
+            .parameterize
+        end
+
+      private
+
+        def hint_classes
+          %w(govuk-hint govuk-checkboxes__hint)
+        end
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/elements/check_boxes/label.rb

@@ -0,0 +1,21 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    module CheckBoxes
+      class Label
+        def initialize(builder)
+          @builder = builder
+        end
+
+        def html
+          @builder.label(class: label_classes)
+        end
+
+        private
+
+        def label_classes
+          %w(govuk-label govuk-checkboxes__label)
+        end
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/elements/date.rb

@@ -0,0 +1,89 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    class Date < GOVUKDesignSystemFormBuilder::Base
+      SEGMENTS = { day: '3i', month: '2i', year: '1i' }
+
+      def initialize(builder, object_name, attribute_name, legend:, hint:)
+        super(builder, object_name, attribute_name)
+        @legend = legend
+        @hint = hint
+      end
+
+      def html
+        hint_element  = Elements::Hint.new(@builder, @object_name, @attribute_name, @hint)
+
+        Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
+          Containers::Fieldset.new(@builder, @object_name, @attribute_name, legend: @legend, described_by: hint_element.hint_id).html do
+            @builder.safe_join(
+              [
+                hint_element.html,
+                (yield if block_given?),
+                @builder.content_tag('div', class: 'govuk-date-input') do
+                  @builder.safe_join(
+                    [
+                      date_input_group(:day, min: 1, max: 31),
+                      date_input_group(:month, min: 1, max: 12),
+                      # FIXME there must be more sensible defaults than this!
+                      date_input_group(:year, min: 1900, max: 2100, width: 4)
+                    ]
+                  )
+                end
+              ]
+            )
+          end
+        end
+      end
+
+    private
+
+      def date_input_group(segment, min:, max:, width: 2)
+        value = @builder.object.try(@attribute_name).try(segment)
+
+        @builder.content_tag('div', class: %w(govuk-date-input__item)) do
+          @builder.content_tag('div', class: %w(govuk-form-group)) do
+            @builder.safe_join(
+              [
+                @builder.tag.label(
+                  segment.capitalize,
+                  class: date_input_label_classes,
+                  for: date_attribute_descriptor(segment)
+                ),
+
+                @builder.tag.input(
+                  id: date_attribute_descriptor(segment),
+                  class: date_input_classes(width),
+                  for: date_attribute_identifier(segment),
+                  type: 'number',
+                  min: min,
+                  max: max,
+                  step: 1,
+                  value: value
+                )
+              ]
+            )
+          end
+        end
+      end
+
+      def date_input_classes(width)
+        %w(govuk-input govuk-date-input__input).push("govuk-input--width-#{width}")
+      end
+
+      def date_input_label_classes
+        %w(govuk-label govuk-date-input__label)
+      end
+
+      def date_attribute_descriptor(segment)
+        [@object_name, @attribute_name, SEGMENTS.fetch(segment)].join("_")
+      end
+
+      def date_attribute_identifier(segment)
+        "%<object_name>s[%<attribute_name>s(%<segment>s)]" % {
+          object_name: @object_name,
+          attribute_name: @attribute_name,
+          segment: SEGMENTS.fetch(segment)
+        }
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/elements/error_message.rb

@@ -0,0 +1,31 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    class ErrorMessage < GOVUKDesignSystemFormBuilder::Base
+      def initialize(builder, object_name, attribute_name, options = {})
+        super(builder, object_name, attribute_name)
+        @options = default_options.merge(options)
+      end
+
+      def html
+        return nil unless has_errors?
+
+        @builder.content_tag('span', class: 'govuk-error-message', id: error_id) do
+          @builder.safe_join([
+            @builder.tag.span('Error: ', class: 'govuk-visually-hidden'),
+            message
+          ])
+        end
+      end
+
+      def message
+        @builder.object.errors.messages[@attribute_name]
+      end
+
+    private
+
+      def default_options
+        {}
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/elements/hint.rb

@@ -0,0 +1,24 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    class Hint < GOVUKDesignSystemFormBuilder::Base
+      def initialize(builder, object_name, attribute_name, options = {})
+        super(builder, object_name, attribute_name)
+        @text = options&.dig(:text)
+        @extra_classes = options&.dig(:class)
+        @hint_id = options&.dig(:id)
+      end
+
+      def html
+        return nil unless @text.present?
+
+        @builder.tag.span(@text, class: hint_classes, id: hint_id)
+      end
+
+    private
+
+      def hint_classes
+        %w(govuk-hint).push(@extra_classes).compact
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/elements/input.rb

@@ -0,0 +1,77 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    class Input < GOVUKDesignSystemFormBuilder::Base
+      def initialize(builder, object_name, attribute_name, attribute_type:, hint:, label:, **extra_args)
+        super(builder, object_name, attribute_name)
+
+        @extra_args = extra_args.dup
+        @width = @extra_args.delete(:width)
+        @builder_method = [attribute_type, 'field'].join('_')
+        @label = label
+        @hint = hint
+      end
+
+      def html
+        hint_element  = Elements::Hint.new(@builder, @object_name, @attribute_name, @hint)
+        label_element = Elements::Label.new(@builder, @object_name, @attribute_name, @label)
+        error_element = Elements::ErrorMessage.new(@builder, @object_name, @attribute_name)
+
+        Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
+          @builder.safe_join(
+            [
+              label_element.html,
+              hint_element.html,
+              error_element.html,
+              @builder.send(
+                @builder_method,
+                @attribute_name,
+                class: input_classes,
+                name: attribute_descriptor,
+                aria: {
+                  describedby: [
+                    hint_element.hint_id,
+                    error_element.error_id
+                  ].compact.join(' ').presence
+                },
+                **@extra_args
+              )
+            ]
+          )
+        end
+      end
+
+    private
+
+      def input_classes
+        %w(govuk-input).tap do |classes|
+          classes.push(width_classes)
+          classes.push('govuk-input--error') if has_errors?
+        end
+      end
+
+      def width_classes
+        return unless @width.present?
+
+        case @width
+          # fixed (character) widths
+        when 20 then 'govuk-input--width-20'
+        when 10 then 'govuk-input--width-10'
+        when 5  then 'govuk-input--width-5'
+        when 4  then 'govuk-input--width-4'
+        when 3  then 'govuk-input--width-3'
+        when 2  then 'govuk-input--width-2'
+
+          # fluid widths
+        when 'full'           then 'govuk-!-width-full'
+        when 'three-quarters' then 'govuk-!-width-three-quarters'
+        when 'two-thirds'     then 'govuk-!-width-two-thirds'
+        when 'one-half'       then 'govuk-!-width-one-half'
+        when 'one-third'      then 'govuk-!-width-one-third'
+        when 'one-quarter'    then 'govuk-!-width-one-quarter'
+
+        else fail "invalid width #{@width}"
+        end
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/elements/label.rb

@@ -0,0 +1,51 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    class Label < GOVUKDesignSystemFormBuilder::Base
+      def initialize(builder, object_name, attribute_name, text: nil, value: nil, size: 'regular', weight: 'regular')
+        super(builder, object_name, attribute_name)
+
+        @text         = label_text(text)
+        @value        = value # used by attribute_descriptor
+        @size_class   = label_size_class(size)
+        @weight_class = label_weight_class(weight)
+      end
+
+      def html
+        return nil unless @text.present?
+
+        @builder.label(
+          @attribute_name,
+          @text,
+          value: @value,
+          class: %w(govuk-label).push(@size_class, @weight_class).compact
+        )
+      end
+
+    private
+
+      def label_text(option_text)
+        [option_text, @value, @attribute_name.capitalize].compact.first
+      end
+
+      def label_size_class(size)
+        case size
+        when 'large'   then "govuk-!-font-size-48"
+        when 'medium'  then "govuk-!-font-size-36"
+        when 'small'   then "govuk-!-font-size-27"
+        when 'regular' then nil
+        else
+          fail 'size must be either large, medium, small or regular'
+        end
+      end
+
+      def label_weight_class(weight)
+        case weight
+        when 'bold'    then "govuk-!-font-weight-bold"
+        when 'regular' then nil
+        else
+          fail 'weight must be bold or regular'
+        end
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/elements/radio.rb

@@ -0,0 +1,15 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    class Radio < GOVUKDesignSystemFormBuilder::Base
+      def hint_id
+        return nil unless @hint.present?
+
+        [@object_name, @attribute_name, @value, 'hint'].join('-').parameterize
+      end
+
+      def radio_hint_classes
+        %w(govuk-hint govuk-radios__hint)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    module Radios
+      class CollectionRadio < Radio
+        def initialize(builder, object_name, attribute_name, item, value_method, text_method, hint_method)
+          super(builder, object_name, attribute_name)
+          @item = item
+          @value = item.send(value_method)
+          @text = item.send(text_method)
+          @hint = item.send(hint_method) if hint_method.present?
+        end
+
+        def html
+          @builder.content_tag('div', class: 'govuk-radios__item') do
+            @builder.safe_join(
+              [
+                @builder.radio_button(
+                  @attribute_name,
+                  @value,
+                  id: attribute_descriptor,
+                  aria: { describedby: hint_id }
+                ),
+                Elements::Label.new(@builder, @object_name, @attribute_name, text: @text, value: @value).html,
+                Elements::Hint.new(@builder, @object_name, @attribute_name, id: hint_id, class: radio_hint_classes, text: @hint).html,
+              ].compact
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    module Radios
+      class FieldsetRadio < Radio
+        def initialize(builder, object_name, attribute_name, value, label:, hint:)
+          super(builder, object_name, attribute_name)
+          @value = value
+          @label = label
+          @hint  = hint
+        end
+
+        def html(&block)
+          @conditional_content, @conditional_id = process(block)
+
+          @builder.content_tag('div', class: 'govuk-radios__item') do
+            @builder.safe_join(
+              [
+                input,
+                Elements::Label.new(@builder, @object_name, @attribute_name, @label).html,
+                Elements::Hint.new(@builder, @object_name, @attribute_name, id: hint_id, class: radio_hint_classes, text: @hint).html,
+                conditional_content
+              ]
+            )
+          end
+        end
+
+      private
+
+        def input
+          @builder.radio_button(
+            @attribute_name,
+            @value,
+            id: attribute_descriptor,
+            aria: { describedby: hint_id },
+            data: { 'aria-controls' => @conditional_id }
+          )
+        end
+
+        def conditional_content
+          return nil unless @conditional_content.present?
+
+          @builder.content_tag('div', class: conditional_classes, id: @conditional_id) do
+            @conditional_content
+          end
+        end
+
+        def process(block)
+          return content = block.call, (content && conditional_id)
+        end
+
+        def conditional_classes
+          %w(govuk-radios__conditional govuk-radios__conditional--hidden)
+        end
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/elements/submit.rb

@@ -0,0 +1,46 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    class Submit < GOVUKDesignSystemFormBuilder::Base
+      def initialize(builder, text, warning:, secondary:, prevent_double_click:)
+        @builder              = builder
+        @text                 = text
+        @prevent_double_click = prevent_double_click
+
+        fail ArgumentError, 'buttons can be warning or secondary' if (warning && secondary)
+        @warning = warning
+        @secondary = secondary
+      end
+
+      def html(&block)
+        content = process(block)
+
+        @builder.content_tag('div', class: %w(govuk-form-group)) do
+          @builder.safe_join([
+            @builder.submit(@text, class: submit_button_classes(content.present?), **extra_args),
+            content
+          ])
+        end
+      end
+    private
+
+      def submit_button_classes(content_present)
+        %w(govuk-button).tap do |classes|
+          classes.push('govuk-button--warning') if @warning
+          classes.push('govuk-button--secondary') if @secondary
+
+          # NOTE only this input will receive a right margin, block
+          # contents must be addressed individually
+          classes.push('govuk-!-margin-right-1') if content_present
+        end
+      end
+
+      def extra_args
+        { data: { 'prevent-double-click' => (@prevent_double_click || nil) }.compact }
+      end
+
+      def process(block)
+        block.call
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/elements/text_area.rb

@@ -0,0 +1,70 @@
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    class TextArea < Base
+      def initialize(builder, object_name, attribute_name, hint:, label:, rows:, max_words:, max_chars:, **extra_args)
+        super(builder, object_name, attribute_name)
+        @label      = label
+        @hint       = hint
+        @extra_args = extra_args
+        @max_words  = max_words
+        @max_chars  = max_chars
+        @rows       = rows
+      end
+
+      def html
+        hint_element  = Elements::Hint.new(@builder, @object_name, @attribute_name, @hint)
+        label_element = Elements::Label.new(@builder, @object_name, @attribute_name, @label)
+        error_element = Elements::ErrorMessage.new(@builder, @object_name, @attribute_name)
+
+        Containers::CharacterCount.new(@builder, max_words: @max_words, max_chars: @max_chars).html do
+          Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
+            @builder.safe_join(
+              [
+                label_element.html,
+                hint_element.html,
+                error_element.html,
+                @builder.text_area(
+                  @attribute_name,
+                  class: govuk_textarea_classes,
+                  **@extra_args.merge(rows: @rows)
+                ),
+                character_count_info
+              ]
+            )
+          end
+        end
+      end
+
+    private
+
+      def govuk_textarea_classes
+        %w(govuk-textarea).tap do |classes|
+          classes.push('govuk-textarea--error') if has_errors?
+          classes.push('js-character-count') if limit?
+        end
+      end
+
+      def character_count_info
+        return nil unless limit?
+
+        @builder.tag.span(
+          "You can enter up to #{character_count_description}",
+          class: %w(govuk-hint govuk-character-count__message),
+          aria: { live: 'polite' }
+        )
+      end
+
+      def character_count_description
+        if @max_words
+          "#{@max_words} words"
+        elsif @max_chars
+          "#{@max_chars} characters"
+        end
+      end
+
+      def limit?
+        @max_words || @max_chars
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/version.rb

@@ -0,0 +1,3 @@
+module GOVUKDesignSystemFormBuilder
+  VERSION = '0.7.0'.freeze
+end

data/lib/govuk_design_system_formbuilder.rb

@@ -0,0 +1,32 @@
+require 'govuk_design_system_formbuilder/version'
+require 'govuk_design_system_formbuilder/builder'
+require 'govuk_design_system_formbuilder/base'
+
+require 'govuk_design_system_formbuilder/elements/hint'
+require 'govuk_design_system_formbuilder/elements/label'
+require 'govuk_design_system_formbuilder/elements/input'
+require 'govuk_design_system_formbuilder/elements/date'
+require 'govuk_design_system_formbuilder/elements/radio'
+require 'govuk_design_system_formbuilder/elements/radios/collection_radio'
+require 'govuk_design_system_formbuilder/elements/radios/fieldset_radio'
+require 'govuk_design_system_formbuilder/elements/check_box'
+require 'govuk_design_system_formbuilder/elements/check_boxes/collection_check_box'
+require 'govuk_design_system_formbuilder/elements/check_boxes/label'
+require 'govuk_design_system_formbuilder/elements/check_boxes/hint'
+require 'govuk_design_system_formbuilder/elements/error_message'
+require 'govuk_design_system_formbuilder/elements/submit'
+require 'govuk_design_system_formbuilder/elements/text_area'
+
+require 'govuk_design_system_formbuilder/containers/form_group'
+require 'govuk_design_system_formbuilder/containers/fieldset'
+require 'govuk_design_system_formbuilder/containers/radios'
+require 'govuk_design_system_formbuilder/containers/check_boxes'
+require 'govuk_design_system_formbuilder/containers/character_count'
+
+module GOVUKDesignSystemFormBuilder
+  class FormBuilder < ActionView::Helpers::FormBuilder
+    delegate :content_tag, :tag, :safe_join, :safe_concat, :capture, :link_to, to: :@template
+
+    include GOVUKDesignSystemFormBuilder::Builder
+  end
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: govuk_design_system_formbuilder
+version: !ruby/object:Gem::Version
+  version: 0.7.0
+platform: ruby
+authors:
+- Peter Yates
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-html-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: govuk-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Rails form builder that generates form inputs adhering to the GOV.UK
+  Design System
+email:
+- peter.yates@graphia.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/govuk_design_system_formbuilder.rb
+- lib/govuk_design_system_formbuilder/base.rb
+- lib/govuk_design_system_formbuilder/builder.rb
+- lib/govuk_design_system_formbuilder/containers/character_count.rb
+- lib/govuk_design_system_formbuilder/containers/check_boxes.rb
+- lib/govuk_design_system_formbuilder/containers/fieldset.rb
+- lib/govuk_design_system_formbuilder/containers/form_group.rb
+- lib/govuk_design_system_formbuilder/containers/radios.rb
+- lib/govuk_design_system_formbuilder/elements/check_box.rb
+- lib/govuk_design_system_formbuilder/elements/check_boxes/collection_check_box.rb
+- lib/govuk_design_system_formbuilder/elements/check_boxes/hint.rb
+- lib/govuk_design_system_formbuilder/elements/check_boxes/label.rb
+- lib/govuk_design_system_formbuilder/elements/date.rb
+- lib/govuk_design_system_formbuilder/elements/error_message.rb
+- lib/govuk_design_system_formbuilder/elements/hint.rb
+- lib/govuk_design_system_formbuilder/elements/input.rb
+- lib/govuk_design_system_formbuilder/elements/label.rb
+- lib/govuk_design_system_formbuilder/elements/radio.rb
+- lib/govuk_design_system_formbuilder/elements/radios/collection_radio.rb
+- lib/govuk_design_system_formbuilder/elements/radios/fieldset_radio.rb
+- lib/govuk_design_system_formbuilder/elements/submit.rb
+- lib/govuk_design_system_formbuilder/elements/text_area.rb
+- lib/govuk_design_system_formbuilder/version.rb
+homepage: https://github.com/DFE-Digital
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: GOV.UK-compliant Rails form builder
+test_files: []