govuk_design_system_formbuilder 1.0.1 → 1.1.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a461a934a644c5132053494bb2f7226da713744089d2d2685c2288abb203fbc6
-  data.tar.gz: 6015d09960437e4f7c3672738da64bc67ff7651135e0f8ce52f4e5c261ec1e27
+  metadata.gz: b9c9499b630e3696a4d327de2e886f683126009aaf04a40d415c52d03fd48fdf
+  data.tar.gz: ae9a0f7b5c079b689da3e719031632a4007ad51b7e7bf4800575d8ba8b529b61
 SHA512:
-  metadata.gz: 50b788c0351f43d4919473f08cc4ba58da35a5e899fcdb1556a5ecf4edfbeb8ef327930a6a605fffee68b83d6db7cd90019ad525c86f88ce11a02eb0fd4284af
-  data.tar.gz: 36a30c7e31d409ef926726c0b2c56fda14c2c2606310c948810f288db2ef2a64637b9c9104d43f368e32bb5ebff4a38719a8e38a9fd76367f97e762d96b92fb7
+  metadata.gz: 32d92bf557aec39313728bb51ac4e43ac4a0ba983749a9bce6b9f2b8a107062ecdbd413bb1fb1583844781230f6c8e33f5f3c4eac84d7cbf432bdf0137e6e89d
+  data.tar.gz: ef4303cf4ea3ee8082f2597f8cf7f5d84e2b3182dd566fc9c77ad9bc3e21867be362356eb3b94519d132bbed8471c473e9ad023ce38fb4aa97208ecf195001df

data/lib/govuk_design_system_formbuilder.rb

@@ -1,3 +1,13 @@
+require 'active_support/configurable'
+
+require 'govuk_design_system_formbuilder/traits/collection_item'
+require 'govuk_design_system_formbuilder/traits/conditional'
+require 'govuk_design_system_formbuilder/traits/error'
+require 'govuk_design_system_formbuilder/traits/hint'
+require 'govuk_design_system_formbuilder/traits/label'
+require 'govuk_design_system_formbuilder/traits/localisation'
+require 'govuk_design_system_formbuilder/traits/supplemental'
+
 require 'govuk_design_system_formbuilder/version'
 require 'govuk_design_system_formbuilder/builder'
 require 'govuk_design_system_formbuilder/base'
@@ -40,6 +50,42 @@ require 'govuk_design_system_formbuilder/containers/character_count'
 require 'govuk_design_system_formbuilder/containers/supplemental'
 
 module GOVUKDesignSystemFormBuilder
+  include ActiveSupport::Configurable
+
+  DEFAULTS = {
+    default_legend_size: 'm',
+    default_legend_tag: 'h1',
+    default_submit_button_text: 'Continue',
+    default_radio_divider_text: 'or',
+    default_error_summary_title: 'There is a problem'
+  }.freeze
+
+  DEFAULTS.keys.each { |k| config_accessor(k) { DEFAULTS[k] } }
+
+  class << self
+    # Configure the form builder in the usual manner. All of the
+    # keys in {DEFAULTS} can be configured as per the example below
+    #
+    # @example
+    #   GOVUKDesignSystemFormBuilder.configure do |conf|
+    #     conf.default_legend_size = 'xl'
+    #     conf.default_error_summary_title = 'OMG'
+    #   end
+    def configure
+      yield(config)
+    end
+
+    # Resets each of the configurable values to its default
+    #
+    # @note This method is only really intended for use to clean up
+    #   during testing
+    def reset!
+      configure do |c|
+        DEFAULTS.each { |k, v| c.send("#{k}=", v) }
+      end
+    end
+  end
+
   class FormBuilder < ActionView::Helpers::FormBuilder
     delegate :content_tag, :tag, :safe_join, :safe_concat, :capture, :link_to, :raw, to: :@template
 
@@ -47,7 +93,5 @@ module GOVUKDesignSystemFormBuilder
   end
 
   # Disable Rails' div.field_with_error wrapper
-  ActionView::Base.field_error_proc = Proc.new do |html_tag, _instance|
-    html_tag.html_safe
-  end
+  ActionView::Base.field_error_proc = ->(html_tag, _instance) { html_tag }
 end

data/lib/govuk_design_system_formbuilder/base.rb

@@ -1,29 +1,18 @@
 module GOVUKDesignSystemFormBuilder
   class Base
+    include Traits::Localisation
+
     delegate :capture, :content_tag, :safe_join, :tag, :raw, :link_to, to: :@builder
+    delegate :config, to: GOVUKDesignSystemFormBuilder
 
     def initialize(builder, object_name, attribute_name, &block)
-      @builder = builder
-      @object_name = object_name
+      @builder        = builder
+      @object_name    = object_name
       @attribute_name = attribute_name
-      @block_content = capture { block.call } if block_given?
-    end
-
-    def hint_element
-      @hint_element ||= Elements::Hint.new(@builder, @object_name, @attribute_name, @hint_text)
-    end
-
-    def error_element
-      @error_element ||= Elements::ErrorMessage.new(@builder, @object_name, @attribute_name)
-    end
-
-    def label_element
-      @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, **@label)
+      @block_content  = capture { block.call } if block_given?
     end
 
-    def supplemental_content
-      @supplemental_content ||= Containers::Supplemental.new(@builder, @object_name, @attribute_name, @block_content)
-    end
+  private
 
     # returns the id value used for the input
     #
@@ -46,53 +35,15 @@ module GOVUKDesignSystemFormBuilder
       end
     end
 
-    def hint_id
-      return nil unless @hint_text.present?
-
-      build_id('hint')
-    end
-
-    def error_id
-      return nil unless has_errors?
-
-      build_id('error')
-    end
-
-    def conditional_id
-      build_id('conditional')
-    end
-
-    def supplemental_id
-      return nil unless @block_content.present?
-
-      build_id('supplemental')
-    end
-
-    # Provides an id for use by the textual description of character and word limits.
-    #
-    # @note In order for the GOV.UK Frontend JavaScript to pick up this associated field
-    #   it has to have the same id as the text area with the additional suffix of '-info'
-    def limit_id
-      [field_id(link_errors: true), 'info'].join('-')
-    end
-
     def has_errors?
       @builder.object.errors.any? &&
         @builder.object.errors.messages.dig(@attribute_name).present?
     end
 
-    def wrap_conditional(block)
-      content_tag('div', class: conditional_classes, id: conditional_id) do
-        capture { block.call }
-      end
-    end
-
     def described_by(*ids)
       ids.flatten.compact.join(' ').presence
     end
 
-  private
-
     # Builds the values used for HTML id attributes throughout the builder
     #
     # @param id_type [String] a description of the id's type, eg +hint+, +error+

data/lib/govuk_design_system_formbuilder/builder.rb

@@ -1,5 +1,6 @@
 module GOVUKDesignSystemFormBuilder
   module Builder
+    delegate :config, to: GOVUKDesignSystemFormBuilder
     # Generates a input of type +text+
     #
     # @param attribute_name [Symbol] The name of the attribute
@@ -201,9 +202,12 @@ module GOVUKDesignSystemFormBuilder
     #
     # @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_method [Symbol] The method called against each member of the collection to provide the hint text
+    # @param value_method [Symbol, Proc] The method called against each member of the collection to provide the value.
+    #   When a +Proc+ is provided it must take a single argument that is a single member of the collection
+    # @param text_method [Symbol, Proc] The method called against each member of the collection to provide the label text.
+    #   When a +Proc+ is provided it must take a single argument that is a single member of the collection
+    # @param hint_method [Symbol, Proc] The method called against each member of the collection to provide the hint text.
+    #   When a +Proc+ is provided it must take a single argument that is a single member of the collection
     # @param hint_text [String] The content of the fieldset hint. No hint will be injected if left +nil+
     # @param legend [Hash] options for configuring the legend
     # @param inline [Boolean] controls whether the radio buttons are displayed inline or not
@@ -214,7 +218,7 @@ module GOVUKDesignSystemFormBuilder
     # @option legend tag [Symbol,String] the tag used for the fieldset's header, defaults to +h1+, defaults to +h1+
     # @return [ActiveSupport::SafeBuffer] HTML output
     #
-    # @example A collection of radio buttons for favourite colours
+    # @example A collection of radio buttons for favourite colours, labels capitalised via a proc
     #
     #  @colours = [
     #    OpenStruct.new(id: 'red', name: 'Red', description: 'Roses are red'),
@@ -224,7 +228,7 @@ module GOVUKDesignSystemFormBuilder
     #  = f.govuk_collection_radio_buttons :favourite_colour,
     #    @colours,
     #    :id,
-    #    :name,
+    #    ->(option) { option.name.upcase },
     #    :description,
     #    legend: { text: 'Pick your favourite colour', size: 'm' },
     #    hint_text: 'If you cannot find the exact match choose something close',
@@ -307,7 +311,7 @@ module GOVUKDesignSystemFormBuilder
     # @return [ActiveSupport::SafeBuffer] HTML output
     # @example A custom divider
     #   = govuk_radio_divider 'Alternatively'
-    def govuk_radio_divider(text = 'or')
+    def govuk_radio_divider(text = config.default_radio_divider_text)
       tag.div(text, class: %w(govuk-radios__divider))
     end
 
@@ -316,8 +320,9 @@ module GOVUKDesignSystemFormBuilder
     # @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_method [Symbol] The method called against each member of the collection to provide the hint text
+    # @param text_method [Symbol] The method called against each member of the collection to provide the label text
+    # @param hint_method [Symbol, Proc] The method called against each member of the collection to provide the hint text.
+    #   When a +Proc+ is provided it must take a single argument that is a single member of the collection
     # @param hint_text [String] The content of the fieldset hint. No hint will be injected if left +nil+
     # @param small [Boolean] controls whether small check boxes are used instead of regular-sized ones
     # @param legend [Hash] options for configuring the legend
@@ -450,7 +455,7 @@ module GOVUKDesignSystemFormBuilder
     #   = f.govuk_submit "Proceed", prevent_double_click: true do
     #     = link_to 'Cancel', some_other_path, class: 'govuk-button__secondary'
     #
-    def govuk_submit(text = 'Continue', warning: false, secondary: false, prevent_double_click: true, validate: false, &block)
+    def govuk_submit(text = config.default_submit_button_text, warning: false, secondary: false, prevent_double_click: true, validate: false, &block)
       Elements::Submit.new(self, text, warning: warning, secondary: secondary, prevent_double_click: prevent_double_click, validate: validate, &block).html
     end
 
@@ -496,7 +501,7 @@ module GOVUKDesignSystemFormBuilder
     #   = f.govuk_error_summary 'Uh-oh, spaghettios'
     #
     # @see https://design-system.service.gov.uk/components/error-summary/ GOV.UK error summary
-    def govuk_error_summary(title = 'There is a problem')
+    def govuk_error_summary(title = config.default_error_summary_title)
       Elements::ErrorSummary.new(self, object_name, title).html
     end
 

data/lib/govuk_design_system_formbuilder/containers/check_boxes_fieldset.rb

@@ -1,6 +1,9 @@
 module GOVUKDesignSystemFormBuilder
   module Containers
-    class CheckBoxesFieldset < GOVUKDesignSystemFormBuilder::Base
+    class CheckBoxesFieldset < Base
+      include Traits::Error
+      include Traits::Hint
+
       def initialize(builder, object_name, attribute_name, hint_text:, legend:, small:, &block)
         super(builder, object_name, attribute_name, &block)
 
@@ -12,7 +15,7 @@ module GOVUKDesignSystemFormBuilder
 
       def html
         Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
-          Containers::Fieldset.new(@builder, legend: @legend, described_by: [error_element.error_id, hint_element.hint_id]).html do
+          Containers::Fieldset.new(@builder, @object_name, @attribute_name, legend: @legend, described_by: [error_element.error_id, hint_element.hint_id]).html do
             safe_join(
               [
                 hint_element.html,

data/lib/govuk_design_system_formbuilder/containers/fieldset.rb

@@ -1,13 +1,14 @@
 module GOVUKDesignSystemFormBuilder
   module Containers
-    class Fieldset < GOVUKDesignSystemFormBuilder::Base
-      LEGEND_DEFAULTS = { text: nil, tag: 'h1', size: 'm' }.freeze
+    class Fieldset < Base
       LEGEND_SIZES = %w(xl l m s).freeze
 
-      def initialize(builder, legend: {}, described_by: nil)
-        @builder = builder
-        @legend = LEGEND_DEFAULTS.merge(legend)
-        @described_by = described_by(described_by)
+      def initialize(builder, object_name = nil, attribute_name = nil, legend: {}, described_by: nil)
+        super(builder, object_name, attribute_name)
+
+        @legend         = legend_defaults.merge(legend)
+        @described_by   = described_by(described_by)
+        @attribute_name = attribute_name
       end
 
       def html
@@ -18,14 +19,26 @@ module GOVUKDesignSystemFormBuilder
 
     private
 
+      def legend_defaults
+        {
+          text: nil,
+          tag:  config.default_legend_tag,
+          size: config.default_legend_size
+        }
+      end
+
       def build_legend
-        if @legend.dig(:text).present?
+        if legend_text.present?
           content_tag('legend', class: legend_classes) do
-            tag.send(@legend.dig(:tag), @legend.dig(:text), class: legend_heading_classes)
+            tag.send(@legend.dig(:tag), legend_text, class: legend_heading_classes)
           end
         end
       end
 
+      def legend_text
+        [@legend.dig(:text), localised_text('fieldset')].compact.first
+      end
+
       def fieldset_classes
         %w(govuk-fieldset)
       end

data/lib/govuk_design_system_formbuilder/containers/form_group.rb

@@ -1,6 +1,6 @@
 module GOVUKDesignSystemFormBuilder
   module Containers
-    class FormGroup < GOVUKDesignSystemFormBuilder::Base
+    class FormGroup < Base
       def initialize(builder, object_name, attribute_name)
         super(builder, object_name, attribute_name)
       end

data/lib/govuk_design_system_formbuilder/containers/radio_buttons_fieldset.rb

@@ -1,6 +1,9 @@
 module GOVUKDesignSystemFormBuilder
   module Containers
-    class RadioButtonsFieldset < GOVUKDesignSystemFormBuilder::Base
+    class RadioButtonsFieldset < Base
+      include Traits::Hint
+      include Traits::Error
+
       def initialize(builder, object_name, attribute_name, hint_text:, legend:, inline:, small:, &block)
         super(builder, object_name, attribute_name)
 
@@ -13,7 +16,7 @@ module GOVUKDesignSystemFormBuilder
 
       def html
         Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
-          Containers::Fieldset.new(@builder, legend: @legend, described_by: [error_element.error_id, hint_element.hint_id]).html do
+          Containers::Fieldset.new(@builder, @object_name, @attribute_name, legend: @legend, described_by: [error_element.error_id, hint_element.hint_id]).html do
             safe_join(
               [
                 hint_element.html,

data/lib/govuk_design_system_formbuilder/containers/radios.rb

@@ -1,6 +1,8 @@
 module GOVUKDesignSystemFormBuilder
   module Containers
-    class Radios < GOVUKDesignSystemFormBuilder::Base
+    class Radios < Base
+      include Traits::Hint
+
       def initialize(builder, inline:, small:)
         @builder = builder
         @inline  = inline

data/lib/govuk_design_system_formbuilder/containers/supplemental.rb

@@ -1,15 +1,14 @@
 module GOVUKDesignSystemFormBuilder
   module Containers
-    class Supplemental < GOVUKDesignSystemFormBuilder::Base
+    class Supplemental < Base
       def initialize(builder, object_name, attribute_name, content)
-        @builder        = builder
-        @object_name    = object_name
-        @attribute_name = attribute_name
-        @content        = content
+        super(builder, object_name, attribute_name)
+
+        @content = content
       end
 
       def html
-        return nil unless @content.present?
+        return nil if @content.blank?
 
         content_tag('div', id: supplemental_id) do
           @content

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

@@ -1,7 +1,11 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     module CheckBoxes
-      class Collection < GOVUKDesignSystemFormBuilder::Base
+      class Collection < Base
+        include Traits::Error
+        include Traits::Hint
+        include Traits::Supplemental
+
         def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint_method: nil, hint_text:, legend:, small:, &block)
           super(builder, object_name, attribute_name, &block)
 
@@ -16,7 +20,7 @@ module GOVUKDesignSystemFormBuilder
 
         def html
           Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
-            Containers::Fieldset.new(@builder, legend: @legend, described_by: [error_id, hint_id, supplemental_id]).html do
+            Containers::Fieldset.new(@builder, @object_name, @attribute_name, legend: @legend, described_by: [error_id, hint_id, supplemental_id]).html do
               safe_join(
                 [
                   hint_element.html,

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

@@ -1,13 +1,17 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     module CheckBoxes
-      class CollectionCheckBox < GOVUKDesignSystemFormBuilder::Base
+      class CollectionCheckBox < Base
+        include Traits::CollectionItem
+        include Traits::Hint
+
         def initialize(builder, object_name, attribute_name, checkbox, hint_method = nil, link_errors: false)
           super(builder, object_name, attribute_name)
+
           @checkbox  = checkbox
           @item      = checkbox.object
           @value     = checkbox.value
-          @hint_text = @item.send(hint_method) if hint_method.present?
+          @hint_text = retrieve(@item, hint_method)
           @link_errors = link_errors
         end
 

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

@@ -1,7 +1,10 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     module CheckBoxes
-      class FieldsetCheckBox < GOVUKDesignSystemFormBuilder::Base
+      class FieldsetCheckBox < Base
+        include Traits::Hint
+        include Traits::Conditional
+
         def initialize(builder, object_name, attribute_name, value, label:, hint_text:, link_errors:, multiple:, &block)
           super(builder, object_name, attribute_name)
 

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

@@ -1,7 +1,9 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     module CheckBoxes
-      class Hint < GOVUKDesignSystemFormBuilder::Base
+      class Hint < Base
+        include Traits::Hint
+
         def initialize(builder, object_name, attribute_name, hint_text, value:)
           super(builder, object_name, attribute_name)
 

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

@@ -1,7 +1,7 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     module CheckBoxes
-      class Label < GOVUKDesignSystemFormBuilder::Base
+      class Label < Base
         def initialize(builder, object_name, attribute_name, checkbox, value:, link_errors: true)
           super(builder, object_name, attribute_name)
 

data/lib/govuk_design_system_formbuilder/elements/date.rb

@@ -1,6 +1,10 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
-    class Date < GOVUKDesignSystemFormBuilder::Base
+    class Date < Base
+      include Traits::Error
+      include Traits::Hint
+      include Traits::Supplemental
+
       SEGMENTS = { day: '3i', month: '2i', year: '1i' }.freeze
 
       def initialize(builder, object_name, attribute_name, legend:, hint_text:, date_of_birth: false, omit_day:, &block)
@@ -14,7 +18,7 @@ module GOVUKDesignSystemFormBuilder
 
       def html
         Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
-          Containers::Fieldset.new(@builder, legend: @legend, described_by: [error_id, hint_id, supplemental_id]).html do
+          Containers::Fieldset.new(@builder, @object_name, @attribute_name, legend: @legend, described_by: [error_id, hint_id, supplemental_id]).html do
             safe_join(
               [
                 hint_element.html,

data/lib/govuk_design_system_formbuilder/elements/error_message.rb

@@ -1,6 +1,8 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
-    class ErrorMessage < GOVUKDesignSystemFormBuilder::Base
+    class ErrorMessage < Base
+      include Traits::Error
+
       def initialize(builder, object_name, attribute_name)
         super(builder, object_name, attribute_name)
       end

data/lib/govuk_design_system_formbuilder/elements/error_summary.rb

@@ -1,6 +1,8 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
-    class ErrorSummary < GOVUKDesignSystemFormBuilder::Base
+    class ErrorSummary < Base
+      include Traits::Error
+
       def initialize(builder, object_name, title)
         @builder = builder
         @object_name = object_name

data/lib/govuk_design_system_formbuilder/elements/file.rb

@@ -1,6 +1,11 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
-    class File < GOVUKDesignSystemFormBuilder::Base
+    class File < Base
+      include Traits::Error
+      include Traits::Hint
+      include Traits::Label
+      include Traits::Supplemental
+
       def initialize(builder, object_name, attribute_name, hint_text:, label:, **extra_args, &block)
         super(builder, object_name, attribute_name, &block)
 

data/lib/govuk_design_system_formbuilder/elements/hint.rb

@@ -1,11 +1,13 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
-    class Hint < GOVUKDesignSystemFormBuilder::Base
+    class Hint < Base
+      include Traits::Hint
+
       def initialize(builder, object_name, attribute_name, text, value = nil, radio: false, checkbox: false)
         super(builder, object_name, attribute_name)
 
         @value          = value
-        @hint_text      = text
+        @hint_text      = hint_text(text)
         @radio_class    = radio_class(radio)
         @checkbox_class = checkbox_class(checkbox)
       end
@@ -18,6 +20,13 @@ module GOVUKDesignSystemFormBuilder
 
     private
 
+      def hint_text(supplied)
+        [
+          supplied.presence,
+          localised_text('hint')
+        ].compact.first
+      end
+
       def hint_classes
         %w(govuk-hint).push(@radio_class, @checkbox_class).compact
       end

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

@@ -2,6 +2,11 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module Inputs
       class Base < GOVUKDesignSystemFormBuilder::Base
+        include Traits::Error
+        include Traits::Hint
+        include Traits::Label
+        include Traits::Supplemental
+
         def initialize(builder, object_name, attribute_name, hint_text:, label:, width:, **extra_args, &block)
           super(builder, object_name, attribute_name, &block)
 

data/lib/govuk_design_system_formbuilder/elements/label.rb

@@ -1,6 +1,6 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
-    class Label < GOVUKDesignSystemFormBuilder::Base
+    class Label < Base
       def initialize(builder, object_name, attribute_name, text: nil, value: nil, size: nil, hidden: false, radio: false, checkbox: false, tag: nil, link_errors: true)
         super(builder, object_name, attribute_name)
 
@@ -37,12 +37,12 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def label_text(option_text, hidden)
-        text = [option_text, @value, @attribute_name.capitalize].compact.first
+        text = [option_text, @value, localised_text('label'), @attribute_name.capitalize].compact.first.to_s
 
         if hidden
           tag.span(text, class: %w(govuk-visually-hidden))
         else
-          raw(text)
+          text
         end
       end
 

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

@@ -1,7 +1,11 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     module Radios
-      class Collection < GOVUKDesignSystemFormBuilder::Base
+      class Collection < Base
+        include Traits::Error
+        include Traits::Hint
+        include Traits::Supplemental
+
         def initialize(builder, object_name, attribute_name, collection, value_method:, text_method:, hint_method:, hint_text:, legend:, inline:, small:, bold_labels:, &block)
           super(builder, object_name, attribute_name, &block)
 
@@ -18,7 +22,7 @@ module GOVUKDesignSystemFormBuilder
 
         def html
           Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
-            Containers::Fieldset.new(@builder, legend: @legend, described_by: [error_id, hint_id, supplemental_id]).html do
+            Containers::Fieldset.new(@builder, @object_name, @attribute_name, legend: @legend, described_by: [error_id, hint_id, supplemental_id]).html do
               safe_join(
                 [
                   hint_element.html,

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

@@ -2,16 +2,20 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module Radios
       class CollectionRadioButton < Base
+        include Traits::Hint
+        include Traits::CollectionItem
+
         # @param link_errors [Boolean] used to control the id generated for radio buttons. The
         #   error summary requires that the id of the first radio is linked-to from the corresponding
         #   error message. As when the summary is built what happens later in the form is unknown, we
         #   need to control this to ensure the link is generated correctly
         def initialize(builder, object_name, attribute_name, item, value_method:, text_method:, hint_method:, link_errors: false, bold_labels:)
           super(builder, object_name, attribute_name)
+
           @item        = item
-          @value       = item.send(value_method)
-          @text        = item.send(text_method)
-          @hint_text   = item.send(hint_method) if hint_method.present?
+          @value       = retrieve(item, value_method)
+          @label_text  = retrieve(item, text_method)
+          @hint_text   = retrieve(item, hint_method)
           @link_errors = link_errors
           @bold_labels = bold_labels
         end
@@ -41,7 +45,7 @@ module GOVUKDesignSystemFormBuilder
         end
 
         def label_element
-          @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, text: @text, value: @value, radio: true, size: label_size, link_errors: @link_errors)
+          @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, 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

@@ -2,6 +2,9 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     module Radios
       class FieldsetRadioButton < Base
+        include Traits::Hint
+        include Traits::Conditional
+
         def initialize(builder, object_name, attribute_name, value, label:, hint_text:, link_errors:, &block)
           super(builder, object_name, attribute_name)
 

data/lib/govuk_design_system_formbuilder/elements/select.rb

@@ -1,6 +1,11 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
-    class Select < GOVUKDesignSystemFormBuilder::Base
+    class Select < Base
+      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:, &block)
         super(builder, object_name, attribute_name, &block)
 

data/lib/govuk_design_system_formbuilder/elements/submit.rb

@@ -1,6 +1,6 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
-    class Submit < GOVUKDesignSystemFormBuilder::Base
+    class Submit < Base
       def initialize(builder, text, warning:, secondary:, prevent_double_click:, validate:, &block)
         fail ArgumentError, 'buttons can be warning or secondary' if warning && secondary
 

data/lib/govuk_design_system_formbuilder/elements/text_area.rb

@@ -1,8 +1,14 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     class TextArea < Base
+      include Traits::Error
+      include Traits::Hint
+      include Traits::Label
+      include Traits::Supplemental
+
       def initialize(builder, object_name, attribute_name, hint_text:, label:, rows:, max_words:, max_chars:, threshold:, **extra_args, &block)
         super(builder, object_name, attribute_name, &block)
+
         @label      = label
         @hint_text  = hint_text
         @extra_args = extra_args
@@ -43,6 +49,14 @@ module GOVUKDesignSystemFormBuilder
         end
       end
 
+      # Provides an id for use by the textual description of character and word limits.
+      #
+      # @note In order for the GOV.UK Frontend JavaScript to pick up this associated field
+      #   it has to have the same id as the text area with the additional suffix of '-info'
+      def limit_id
+        [field_id(link_errors: true), 'info'].join('-')
+      end
+
       def limit?
         @max_words || @max_chars
       end

data/lib/govuk_design_system_formbuilder/traits/collection_item.rb

@@ -0,0 +1,16 @@
+module GOVUKDesignSystemFormBuilder
+  module Traits
+    module CollectionItem
+    private
+
+      def retrieve(item, method)
+        case method
+        when Symbol, String
+          item.send(method)
+        when Proc
+          method.call(item)
+        end
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/traits/conditional.rb

@@ -0,0 +1,17 @@
+module GOVUKDesignSystemFormBuilder
+  module Traits
+    module Conditional
+    private
+
+      def conditional_id
+        build_id('conditional')
+      end
+
+      def wrap_conditional(block)
+        content_tag('div', class: conditional_classes, id: conditional_id) do
+          capture { block.call }
+        end
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/traits/error.rb

@@ -0,0 +1,17 @@
+module GOVUKDesignSystemFormBuilder
+  module Traits
+    module Error
+      def error_id
+        return nil unless has_errors?
+
+        build_id('error')
+      end
+
+    private
+
+      def error_element
+        @error_element ||= Elements::ErrorMessage.new(@builder, @object_name, @attribute_name)
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/traits/hint.rb

@@ -0,0 +1,17 @@
+module GOVUKDesignSystemFormBuilder
+  module Traits
+    module Hint
+      def hint_id
+        return nil if @hint_text.blank?
+
+        build_id('hint')
+      end
+
+    private
+
+      def hint_element
+        @hint_element ||= Elements::Hint.new(@builder, @object_name, @attribute_name, @hint_text)
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/traits/label.rb

@@ -0,0 +1,11 @@
+module GOVUKDesignSystemFormBuilder
+  module Traits
+    module Label
+    private
+
+      def label_element
+        @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, **@label)
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/traits/localisation.rb

@@ -0,0 +1,21 @@
+module GOVUKDesignSystemFormBuilder
+  module Traits
+    module Localisation
+    private
+
+      def localised_text(context)
+        key = localisation_key(context)
+
+        return nil unless I18n.exists?(key)
+
+        I18n.translate(key)
+      end
+
+      def localisation_key(context)
+        return nil unless @object_name.present? && @attribute_name.present?
+
+        ['helpers', context, @object_name, @attribute_name].join('.')
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/traits/supplemental.rb

@@ -0,0 +1,17 @@
+module GOVUKDesignSystemFormBuilder
+  module Traits
+    module Supplemental
+      def supplemental_id
+        return nil if @block_content.blank?
+
+        build_id('supplemental')
+      end
+
+    private
+
+      def supplemental_content
+        @supplemental_content ||= Containers::Supplemental.new(@builder, @object_name, @attribute_name, @block_content)
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/version.rb

@@ -1,3 +1,3 @@
 module GOVUKDesignSystemFormBuilder
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.1.0.beta.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_design_system_formbuilder
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0.beta.1
 platform: ruby
 authors:
 - Peter Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-23 00:00:00.000000000 Z
+date: 2019-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -53,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: govuk-lint
+  name: rubocop-govuk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -204,14 +204,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.12.0
+        version: 3.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.12.0
+        version: 3.13.0
 - !ruby/object:Gem::Dependency
   name: sassc
   requirement: !ruby/object:Gem::Requirement
@@ -226,6 +226,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.2.1
+- !ruby/object:Gem::Dependency
+  name: sass
+  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: slim
   requirement: !ruby/object:Gem::Requirement
@@ -283,6 +297,13 @@ files:
 - lib/govuk_design_system_formbuilder/elements/select.rb
 - lib/govuk_design_system_formbuilder/elements/submit.rb
 - lib/govuk_design_system_formbuilder/elements/text_area.rb
+- lib/govuk_design_system_formbuilder/traits/collection_item.rb
+- lib/govuk_design_system_formbuilder/traits/conditional.rb
+- lib/govuk_design_system_formbuilder/traits/error.rb
+- lib/govuk_design_system_formbuilder/traits/hint.rb
+- lib/govuk_design_system_formbuilder/traits/label.rb
+- lib/govuk_design_system_formbuilder/traits/localisation.rb
+- lib/govuk_design_system_formbuilder/traits/supplemental.rb
 - lib/govuk_design_system_formbuilder/version.rb
 homepage: https://govuk-form-builder.netlify.com
 licenses:
@@ -304,9 +325,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: