govuk_design_system_formbuilder 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb762e8a359cd08175a12d4589052ea02fe5d30cdd74b0d970ba8b52c8ac09c2
-  data.tar.gz: a190f9073ebcd4d59abb9c62485be024f729343544fbc278c2dbbb3d5949b14a
+  metadata.gz: 843bd26d3611fad40854e1bdfc5864617e64f90ffc51ededfcf1af0a74f4d2ae
+  data.tar.gz: 530a95ed1fb38467f56ef2904110d153c8b1fe5832d5226914f38ae482c8aca7
 SHA512:
-  metadata.gz: 20a8147da81aa6add15ec3500ffd849e18ef5f29add89a4d10511d90be78eca08a278315ae17036c5c5ae1e7861408d27133c8f2dcb84faf30e032b7219b142c
-  data.tar.gz: 5f1e669b7248b062727a7b960aa4448c216a9ad4d30d5ead7314d8989430925b31fd700ed7cd34d4613e0c81465a358d61d59ca4ff47abc8a161b145338e8879
+  metadata.gz: 129ddeaf0fba3811dfd02b6730af2e30adfe1c7a312744aea73ee8bafddade947d92912f86f6e94b94307385b9a6f7dfbf2f58487e4b5d4345c5dc2d53cc1ebd
+  data.tar.gz: 8ff31c945db767cb82dff353e7355e52f1901d6dc7e517f08f6b6a40ed5816bde09a1832f428b9c1c4d9f71304d64f539acbc9dfdd26e4ccccecd5cd2661ab73

data/README.md

@@ -1 +1,78 @@
-# GOV.UK Form Builder
+# GOV.UK Design System Form Builder for Rails
+
+## What's included
+
+* 100% compatibility with the GOV.UK Design System
+* Full control of labels, hints, fieldsets and legends
+* No overwriting of Rails' default form helpers
+* Automatic ARIA associations between hints, errors and inputs
+* Most helpers take a block for arbitrary content
+* Additional params for programmatically adding hints to check box and radio
+  button collections
+
+## Installation
+
+You can install the form builder gem by running the `gem install
+govuk_design_system_formbuilder` or by adding the following line
+to your `Gemfile`
+
+```sh
+gem 'govuk_design_system_formbuilder'
+```
+
+## Setup
+
+To use the form builder in an ad hoc basis you can specify it
+as an argument to `form_for`
+
+
+```slim
+= form_for @some_object, builder: GOVUKDesignSystemFormBuilder::FormBuilder do |f|
+```
+
+To set it globally, just add this to your `ApplicationController`
+
+```ruby
+class ApplicationController < ActionController::Base
+  default_form_builder GOVUKDesignSystemFormBuilder::FormBuilder
+end
+```
+
+Now we can get started! 🎉
+
+```slim
+= form_for @person do |f|
+
+  = f.govuk_text_field :full_name, label: { text: 'Your full name' }
+
+  = f.govuk_number_field :age, label: { text: 'Age' }
+
+  = f.submit 'Away we go!'
+```
+
+## Developing and running the tests
+
+The form builder is covered by RSpec, to run all the tests first ensure that
+all of the development and testing prerequisite gems are installed. At the root
+of a freshly-cloned repo run
+
+```sh
+bundle
+```
+
+Now, if everything was successful, run RSpec
+
+```sh
+rspec -fd
+```
+
+## Thanks
+
+This project was inspired by [MoJ's GovukElementsFormBuilder](https://github.com/ministryofjustice/govuk_elements_form_builder),
+but tackles some problems in a different manner. It provides the following
+advantages by providing:
+
+* no reliance on a custom proxy/block buffer
+* idiomatic Ruby
+* a modular codebase
+* a more-robust test suite

data/lib/govuk_design_system_formbuilder.rb

@@ -6,10 +6,8 @@ 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'

data/lib/govuk_design_system_formbuilder/base.rb

@@ -11,19 +11,19 @@ module GOVUKDesignSystemFormBuilder
     end
 
     def hint_id
-      return nil unless @text.present?
+      return nil unless @hint_text.present?
 
-      @hint_id || [@object_name, @attribute_name, 'hint'].join('-').parameterize
+      [@object_name, @attribute_name, @value, 'hint'].compact.join('-').parameterize
     end
 
     def error_id
       return nil unless has_errors?
 
-      [@object_name, @attribute_name, 'error'].join('-').parameterize
+      [@object_name, @attribute_name, 'error'].compact.join('-').parameterize
     end
 
     def conditional_id
-      [@object_name, @attribute_name, @value, 'conditional'].join('-').parameterize
+      [@object_name, @attribute_name, @value, 'conditional'].compact.join('-').parameterize
     end
 
     def has_errors?
@@ -41,5 +41,12 @@ module GOVUKDesignSystemFormBuilder
         attribute_name: @attribute_name
       }
     end
+
+    def wrap_conditional(block)
+      conditional = @builder.content_tag('div', class: conditional_classes, id: conditional_id) do
+        @builder.capture { block.call }
+      end
+      return conditional, conditional_id
+    end
   end
 end

data/lib/govuk_design_system_formbuilder/builder.rb

@@ -1,35 +1,150 @@
 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
+
+    # Generates a input of type `text`
+    #
+    # @param attribute_name [Symbol] The name of the attribute
+    # @param hint_text [String] The content of the hint. No hint will be injected if left +nil+
+    # @param [Hash] label configures the associated label
+    # @option label text [String] the label text
+    # @option label size [String] the size of the label font, can be +large+, +medium+, +regular+ or +small+
+    # @option label weight [String] the weight of the label font, can be +bold+ or +regular+
+    # @option args [Hash] args additional arguments are applied as attributes to +input+ element
+    # @return [ActiveSupport::SafeBuffer] HTML output
+    #
+    # @example A required full name field with a placeholder
+    #   = govuk_text_field :name,
+    #     label: { text: 'Full name' },
+    #     hint_text: 'It says it on your birth certificate',
+    #     required: true,
+    #     placeholder: 'Ralph Wiggum'
+    def govuk_text_field(attribute_name, hint_text: nil, label: {}, **args)
+      Elements::Input.new(self, object_name, attribute_name, attribute_type: :text, hint_text: hint_text, 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
+    # Generates a input of type `tel`
+    #
+    # @param attribute_name [Symbol] The name of the attribute
+    # @param hint_text [String] The content of the hint. No hint will be injected if left +nil+
+    # @param [Hash] label configures the associated label
+    # @option label text [String] the label text
+    # @option label size [String] the size of the label font, can be +large+, +medium+, +regular+ or +small+
+    # @option label weight [String] the weight of the label font, can be +bold+ or +regular+
+    # @option args [Hash] args additional arguments are applied as attributes to +input+ element
+    # @return [ActiveSupport::SafeBuffer] HTML output
+    #
+    # @example A required phone number field with a placeholder
+    #   = govuk_phone_field :phone_number,
+    #     label: { text: 'UK telephone number' },
+    #     hint_text: 'Include the dialling code',
+    #     required: true,
+    #     placeholder: '0123 456 789'
+    def govuk_phone_field(attribute_name, hint_text: nil, label: {}, **args)
+      Elements::Input.new(self, object_name, attribute_name, attribute_type: :phone, hint_text: hint_text, 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
+    # Generates a input of type `email`
+    #
+    # @param attribute_name [Symbol] The name of the attribute
+    # @param hint_text [String] The content of the hint. No hint will be injected if left +nil+
+    # @param [Hash] label configures the associated label
+    # @option label text [String] the label text
+    # @option label size [String] the size of the label font, can be +large+, +medium+, +regular+ or +small+
+    # @option label weight [String] the weight of the label font, can be +bold+ or +regular+
+    # @option args [Hash] args additional arguments are applied as attributes to +input+ element
+    # @return [ActiveSupport::SafeBuffer] HTML output
+    #
+    # @example An email address field with a placeholder
+    #   = govuk_email_field :email_address,
+    #     label: { text: 'Enter your email address' },
+    #     placeholder: 'ralph.wiggum@springfield.edu'
+    def govuk_email_field(attribute_name, hint_text: nil, label: {}, **args)
+      Elements::Input.new(self, object_name, attribute_name, attribute_type: :email, hint_text: hint_text, 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
+    # Generates a input of type `url`
+    #
+    # @param attribute_name [Symbol] The name of the attribute
+    # @param hint_text [String] The content of the hint. No hint will be injected if left +nil+
+    # @param [Hash] label configures the associated label
+    # @option label text [String] the label text
+    # @option label size [String] the size of the label font, can be +large+, +medium+, +regular+ or +small+
+    # @option label weight [String] the weight of the label font, can be +bold+ or +regular+
+    # @option args [Hash] args additional arguments are applied as attributes to +input+ element
+    # @return [ActiveSupport::SafeBuffer] HTML output
+    #
+    # @example A url field with autocomplete
+    #   = govuk_url_field :favourite_website,
+    #     label: { text: 'Enter your favourite website' },
+    #     placeholder: 'https://www.gov.uk',
+    #     autocomplete: 'url'
+    def govuk_url_field(attribute_name, hint_text: nil, label: {}, **args)
+      Elements::Input.new(self, object_name, attribute_name, attribute_type: :url, hint_text: hint_text, 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
+    # Generates a input of type `number`
+    #
+    # @param attribute_name [Symbol] The name of the attribute
+    # @param hint_text [String] The content of the hint. No hint will be injected if left +nil+
+    # @param [Hash] label configures the associated label
+    # @option label text [String] the label text
+    # @option label size [String] the size of the label font, can be +large+, +medium+, +regular+ or +small+
+    # @option label weight [String] the weight of the label font, can be +bold+ or +regular+
+    # @option args [Hash] args additional arguments are applied as attributes to the +input+ element
+    # @return [ActiveSupport::SafeBuffer] HTML output
+    #
+    # @example A number field with placeholder, min, max and step
+    #   = govuk_number_field :iq,
+    #     label: { text: 'What is your IQ?' },
+    #     placeholder: 100,
+    #     min: 80,
+    #     max: 150,
+    #     step: 5
+    def govuk_number_field(attribute_name, hint_text: nil, label: {}, **args)
+      Elements::Input.new(self, object_name, attribute_name, attribute_type: :number, hint_text: hint_text, 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
+
+    # Generates a +textarea+ element with a label, optional hint. Also offers
+    # the ability to add the GOV.UK character and word counting components
+    # automatically
+    #
+    # @param attribute_name [Symbol] The name of the attribute
+    # @param hint_text [String] The content of the hint. No hint will be injected if left +nil+
+    # @param [Hash] label configures the associated label
+    # @option label text [String] the label text
+    # @option label size [String] the size of the label font, can be +large+, +medium+, +regular+ or +small+
+    # @option label weight [String] the weight of the label font, can be +bold+ or +regular+
+    # @param max_words [Integer] adds the GOV.UK max word count
+    # @param max_chars [Integer] adds the GOV.UK max characters count
+    # @option args [Hash] args additional arguments are applied as attributes to the +textarea+ element
+    # @return [ActiveSupport::SafeBuffer] HTML output
+    # @see https://design-system.service.gov.uk/components/character-count GOV.UK character count component
+    # @note Setting +max_chars+ or +max_words+ will add a caption beneath the +textarea+ with a live count of words
+    #   or characters
+    #
+    # @example A number field with placeholder, min, max and step
+    #   = govuk_number_field :cv,
+    #     label: { text: 'Tell us about your work history' },
+    #     rows: 8,
+    #     max_words: 300
+    def govuk_text_area(attribute_name, hint_text: nil, label: {}, max_words: nil, max_chars: nil, rows: 5, **args)
+      Elements::TextArea.new(self, object_name, attribute_name, hint_text: hint_text, 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: {})
+    # Generates a +select+ element containing +option+ for each member in the provided collection
+    #
+    # @param attribute_name [Symbol] The name of the attribute
+    # @param collection [Enumerable<Object>] Options to be added to the +select+ element
+    # @param value_method [Symbol] The method called against each member of the collection to provide the value
+    # @param text_method [Symbol] The method called against each member of the collection to provide the text
+    # @param hint_text [String] The content of the hint. No hint will be injected if left +nil+
+    # @option label text [String] the label text
+    # @option label size [String] the size of the label font, can be +large+, +medium+, +regular+ or +small+
+    # @option label weight [String] the weight of the label font, can be +bold+ or +regular+
+    def govuk_collection_select(attribute_name, collection, value_method, text_method, options: {}, html_options: {}, hint_text: nil, label: {})
       label_element = Elements::Label.new(self, object_name, attribute_name, label)
-      hint_element  = Elements::Hint.new(self, object_name, attribute_name, hint)
+      hint_element  = Elements::Hint.new(self, object_name, attribute_name, hint_text)
       error_element = Elements::ErrorMessage.new(self, object_name, attribute_name)
 
       Containers::FormGroup.new(self, object_name, attribute_name).html do
@@ -59,105 +174,83 @@ module GOVUKDesignSystemFormBuilder
       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)
+    def govuk_collection_radio_buttons(attribute_name, collection, value_method, text_method, hint_method = nil, options: { inline: false }, html_options: {}, hint_text: nil, legend: {})
+      hint_element  = Elements::Hint.new(self, object_name, attribute_name, hint_text)
+      error_element = Elements::ErrorMessage.new(self, object_name, attribute_name)
+
       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
-                    )
+        Containers::Fieldset.new(self, object_name, attribute_name, legend: legend, described_by: [error_element.error_id, hint_element.hint_id]).html do
+          safe_join(
+            [
+              hint_element.html,
+              error_element.html,
+
+              (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
-                ].compact
-              )
-            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)
+    def govuk_radio_buttons_fieldset(attribute_name, options: { inline: false }, hint_text: nil, legend: {})
+      hint_element  = Elements::Hint.new(self, object_name, attribute_name, hint_text)
+      error_element = Elements::ErrorMessage.new(self, object_name, attribute_name)
 
       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::Fieldset.new(self, object_name, attribute_name, legend: legend, described_by: [error_element.error_id, hint_element.hint_id]).html do
+          safe_join([
+            hint_element.html,
+            error_element.html,
             Containers::Radios.new(self, inline: options.dig(:inline)).html do
               yield
             end
-          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
+    def govuk_radio_button(attribute_name, value, hint_text: nil, label: {}, &block)
+      Elements::Radios::FieldsetRadio.new(self, object_name, attribute_name, value, hint_text: hint_text, label: label, &block).html
     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)
+    def govuk_collection_check_boxes(attribute_name, collection, value_method, text_method, hint_method = nil, html_options: {}, hint_text: nil, legend: {})
+      hint_element  = Elements::Hint.new(self, object_name, attribute_name, hint_text)
+      error_element = Elements::ErrorMessage.new(self, object_name, attribute_name)
+
       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
+        Containers::Fieldset.new(self, object_name, attribute_name, legend: legend, described_by: [error_element.error_id, hint_element.hint_id]).html do
+          safe_join(
+            [
+              hint_element.html,
+              error_element.html,
+              (yield if block_given?),
               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
     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
+    def govuk_submit(text = 'Continue', warning: false, secondary: false, prevent_double_click: true, &block)
+      Elements::Submit.new(self, text, warning: warning, secondary: secondary, prevent_double_click: prevent_double_click, &block).html
     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
+    def govuk_date_field(attribute_name, hint_text: nil, legend: {}, date_of_birth: false, &block)
+      Elements::Date.new(self, object_name, attribute_name, hint_text: hint_text, legend: legend, date_of_birth: date_of_birth, &block).html
     end
   end
 end

data/lib/govuk_design_system_formbuilder/containers/fieldset.rb

@@ -2,12 +2,14 @@ module GOVUKDesignSystemFormBuilder
   module Containers
     class Fieldset < GOVUKDesignSystemFormBuilder::Base
       LEGEND_DEFAULTS = { text: nil, tag: 'h1', size: 'xl' }.freeze
+
+      # FIXME standardise sizes with labels
       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
+        @described_by = descriptors(described_by)
       end
 
       def html
@@ -42,6 +44,12 @@ module GOVUKDesignSystemFormBuilder
       def legend_heading_classes
         %(govuk-fieldset__heading)
       end
+
+      def descriptors(described_by)
+        return nil unless described_by.present?
+
+        Array.wrap(described_by).join(' ')
+      end
     end
   end
 end

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

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

data/lib/govuk_design_system_formbuilder/elements/date.rb

@@ -3,21 +3,23 @@ module GOVUKDesignSystemFormBuilder
     class Date < GOVUKDesignSystemFormBuilder::Base
       SEGMENTS = { day: '3i', month: '2i', year: '1i' }
 
-      def initialize(builder, object_name, attribute_name, legend:, hint:)
+      def initialize(builder, object_name, attribute_name, legend:, hint_text:, date_of_birth: false, &block)
         super(builder, object_name, attribute_name)
         @legend = legend
-        @hint = hint
+        @hint_text = hint_text
+        @date_of_birth = date_of_birth
+        @block_content = @builder.capture { block.call }.html_safe if block_given?
       end
 
       def html
-        hint_element  = Elements::Hint.new(@builder, @object_name, @attribute_name, @hint)
+        hint_element  = Elements::Hint.new(@builder, @object_name, @attribute_name, @hint_text)
 
         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?),
+                @block_content,
                 @builder.content_tag('div', class: 'govuk-date-input') do
                   @builder.safe_join(
                     [
@@ -57,7 +59,8 @@ module GOVUKDesignSystemFormBuilder
                   min: min,
                   max: max,
                   step: 1,
-                  value: value
+                  value: value,
+                  autocomplete: date_of_birth_autocomplete_value(segment)
                 )
               ]
             )
@@ -84,6 +87,12 @@ module GOVUKDesignSystemFormBuilder
           segment: SEGMENTS.fetch(segment)
         }
       end
+
+      def date_of_birth_autocomplete_value(segment)
+        return nil unless @date_of_birth
+
+        { day: 'bday-day', month: 'bday-month', year: 'bday-year' }.fetch(segment)
+      end
     end
   end
 end

data/lib/govuk_design_system_formbuilder/elements/hint.rb

@@ -1,23 +1,32 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     class Hint < GOVUKDesignSystemFormBuilder::Base
-      def initialize(builder, object_name, attribute_name, options = {})
+      def initialize(builder, object_name, attribute_name, text, value = nil, radio: false, checkbox: false)
         super(builder, object_name, attribute_name)
-        @text = options&.dig(:text)
-        @extra_classes = options&.dig(:class)
-        @hint_id = options&.dig(:id)
+        @value = value
+        @hint_text  = text
+        @radio_class = radio_class(radio)
+        @checkbox_class = checkbox_class(checkbox)
       end
 
       def html
-        return nil unless @text.present?
+        return nil unless @hint_text.present?
 
-        @builder.tag.span(@text, class: hint_classes, id: hint_id)
+        @builder.tag.span(@hint_text, class: hint_classes, id: hint_id)
       end
 
     private
 
       def hint_classes
-        %w(govuk-hint).push(@extra_classes).compact
+        %w(govuk-hint).push(@radio_class, @checkbox_class).compact
+      end
+
+      def radio_class(radio)
+        radio ? 'govuk-radios__hint' : nil
+      end
+
+      def checkbox_class(checkbox)
+        checkbox ? 'govuk-checkboxes__hint' : nil
       end
     end
   end

data/lib/govuk_design_system_formbuilder/elements/input.rb

@@ -1,18 +1,18 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     class Input < GOVUKDesignSystemFormBuilder::Base
-      def initialize(builder, object_name, attribute_name, attribute_type:, hint:, label:, **extra_args)
+      def initialize(builder, object_name, attribute_name, attribute_type:, hint_text:, label:, **extra_args)
         super(builder, object_name, attribute_name)
 
-        @extra_args = extra_args.dup
-        @width = @extra_args.delete(:width)
+        @extra_args     = extra_args.dup
+        @width          = @extra_args.delete(:width)
         @builder_method = [attribute_type, 'field'].join('_')
-        @label = label
-        @hint = hint
+        @label          = label
+        @hint_text      = hint_text
       end
 
       def html
-        hint_element  = Elements::Hint.new(@builder, @object_name, @attribute_name, @hint)
+        hint_element  = Elements::Hint.new(@builder, @object_name, @attribute_name, @hint_text)
         label_element = Elements::Label.new(@builder, @object_name, @attribute_name, @label)
         error_element = Elements::ErrorMessage.new(@builder, @object_name, @attribute_name)
 
@@ -26,7 +26,6 @@ module GOVUKDesignSystemFormBuilder
                 @builder_method,
                 @attribute_name,
                 class: input_classes,
-                name: attribute_descriptor,
                 aria: {
                   describedby: [
                     hint_element.hint_id,

data/lib/govuk_design_system_formbuilder/elements/label.rb

@@ -1,13 +1,15 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     class Label < GOVUKDesignSystemFormBuilder::Base
-      def initialize(builder, object_name, attribute_name, text: nil, value: nil, size: 'regular', weight: 'regular')
+      def initialize(builder, object_name, attribute_name, text: nil, value: nil, size: 'regular', weight: 'regular', radio: false, checkbox: false)
         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)
+        @text           = label_text(text)
+        @value          = value # used by attribute_descriptor
+        @size_class     = label_size_class(size)
+        @weight_class   = label_weight_class(weight)
+        @radio_class    = radio_class(radio)
+        @checkbox_class = checkbox_class(checkbox)
       end
 
       def html
@@ -17,7 +19,7 @@ module GOVUKDesignSystemFormBuilder
           @attribute_name,
           @text,
           value: @value,
-          class: %w(govuk-label).push(@size_class, @weight_class).compact
+          class: %w(govuk-label).push(@size_class, @weight_class, @radio_class, @checkbox_class).compact
         )
       end
 
@@ -27,6 +29,14 @@ module GOVUKDesignSystemFormBuilder
         [option_text, @value, @attribute_name.capitalize].compact.first
       end
 
+      def radio_class(radio)
+        radio ? 'govuk-radios__label' : nil
+      end
+
+      def checkbox_class(checkbox)
+        checkbox ? 'govuk-checkboxes__label' : nil
+      end
+
       def label_size_class(size)
         case size
         when 'large'   then "govuk-!-font-size-48"

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

@@ -1,13 +1,13 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     module Radios
-      class CollectionRadio < Radio
+      class CollectionRadio < Base
         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?
+          @hint_text = item.send(hint_method) if hint_method.present?
         end
 
         def html
@@ -18,10 +18,11 @@ module GOVUKDesignSystemFormBuilder
                   @attribute_name,
                   @value,
                   id: attribute_descriptor,
-                  aria: { describedby: hint_id }
+                  aria: { describedby: hint_id },
+                  class: %w(govuk-radios__input)
                 ),
                 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,
+                Elements::Hint.new(@builder, @object_name, @attribute_name, @hint_text, @value, radio: true).html,
               ].compact
             )
           end

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

@@ -1,24 +1,23 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     module Radios
-      class FieldsetRadio < Radio
-        def initialize(builder, object_name, attribute_name, value, label:, hint:)
+      class FieldsetRadio < Base
+        def initialize(builder, object_name, attribute_name, value, label:, hint_text:, &block)
           super(builder, object_name, attribute_name)
           @value = value
           @label = label
-          @hint  = hint
+          @hint_text  = hint_text
+          @conditional_content, @conditional_id = wrap_conditional(block) if block_given?
         end
 
-        def html(&block)
-          @conditional_content, @conditional_id = process(block)
-
+        def html
           @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
+                Elements::Label.new(@builder, @object_name, @attribute_name, radio: true, value: @value, **@label).html,
+                Elements::Hint.new(@builder, @object_name, @attribute_name, @hint_text, radio: true).html,
+                @conditional_content
               ]
             )
           end
@@ -32,22 +31,11 @@ module GOVUKDesignSystemFormBuilder
             @value,
             id: attribute_descriptor,
             aria: { describedby: hint_id },
-            data: { 'aria-controls' => @conditional_id }
+            data: { 'aria-controls' => @conditional_id },
+            class: %w(govuk-radios__input)
           )
         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

data/lib/govuk_design_system_formbuilder/elements/submit.rb

@@ -1,7 +1,7 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     class Submit < GOVUKDesignSystemFormBuilder::Base
-      def initialize(builder, text, warning:, secondary:, prevent_double_click:)
+      def initialize(builder, text, warning:, secondary:, prevent_double_click:, &block)
         @builder              = builder
         @text                 = text
         @prevent_double_click = prevent_double_click
@@ -9,15 +9,14 @@ module GOVUKDesignSystemFormBuilder
         fail ArgumentError, 'buttons can be warning or secondary' if (warning && secondary)
         @warning = warning
         @secondary = secondary
+        @block_content = @builder.capture { block.call } if block_given?
       end
 
-      def html(&block)
-        content = process(block)
-
+      def html
         @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
+            @builder.submit(@text, class: submit_button_classes(@block_content.present?), **extra_args),
+            @block_content
           ])
         end
       end
@@ -37,10 +36,6 @@ module GOVUKDesignSystemFormBuilder
       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

@@ -1,10 +1,10 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     class TextArea < Base
-      def initialize(builder, object_name, attribute_name, hint:, label:, rows:, max_words:, max_chars:, **extra_args)
+      def initialize(builder, object_name, attribute_name, hint_text:, label:, rows:, max_words:, max_chars:, **extra_args)
         super(builder, object_name, attribute_name)
         @label      = label
-        @hint       = hint
+        @hint_text  = hint_text
         @extra_args = extra_args
         @max_words  = max_words
         @max_chars  = max_chars
@@ -12,7 +12,7 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def html
-        hint_element  = Elements::Hint.new(@builder, @object_name, @attribute_name, @hint)
+        hint_element  = Elements::Hint.new(@builder, @object_name, @attribute_name, @hint_text)
         label_element = Elements::Label.new(@builder, @object_name, @attribute_name, @label)
         error_element = Elements::ErrorMessage.new(@builder, @object_name, @attribute_name)
 

data/lib/govuk_design_system_formbuilder/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_design_system_formbuilder
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Peter Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-25 00:00:00.000000000 Z
+date: 2019-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: rspec-html-matchers
   requirement: !ruby/object:Gem::Requirement
@@ -92,28 +92,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.12.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.12.2
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.7.0
 description: A Rails form builder that generates form inputs adhering to the GOV.UK
   Design System
 email:
@@ -132,7 +132,6 @@ files:
 - 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
@@ -141,7 +140,6 @@ files:
 - 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

data/lib/govuk_design_system_formbuilder/elements/check_box.rb

@@ -1,84 +0,0 @@
-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/radio.rb

@@ -1,15 +0,0 @@
-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