gov_uk_date_fields 3.2.0.rc3 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 932e2c3de2e43eee9399b2dbfa3189d00140257cd1576888718dbcc9ce7da109
-  data.tar.gz: bbca275b06393134b97f72e9963a85c14fdcb5fa002451fc62045822daa5c6cd
+  metadata.gz: 79f6690a87a5fe34ef7473660d47aad6f58019daca5cec9efec97b5038817c54
+  data.tar.gz: 81e1ee5473edf78be16e334a88ffb68cdda223b45b20693cb5b44f9381cc55cf
 SHA512:
-  metadata.gz: 428e25ae745cd6ad27fdb47a31a8b1aec72b9673c6a7d9d18dab1db28c26121bcfc0f2db4341d9e1ca6a93c77cee7f8e6508b115361108da0cb9d493c1ec3335
-  data.tar.gz: d44392510662c4c2e23269b1ef582e6018e0825d72aab29ac24588fb066b287a1f35dd6482acd3ba210b1c029d6512a2fdcb577f0746c2693d06a016e9f35882
+  metadata.gz: 4d2f1925d6a6e630bdbd4ce005dfb6cea0511e6ba63f6e1efee83047f417a52ee1c9aaef42cef6a447a1025370d0fbdc14a65b9c8ac602ef7d08a64ad8065fa4
+  data.tar.gz: c6e04f555e451fa43a7e9c65e323879e6f0f2f88e1152023a4e5d69c250ac8838032c6bf4353314378baba510885ab623accb17b589c2106aac82da9f3efd87a

data/lib/gov_uk_date_fields/form_fields.rb

@@ -1,19 +1,15 @@
 module GovUkDateFields
-
   class FormFields
-    VALID_OPTIONS = [:legend_text, :legend_class, :form_hint_text, :id, :placeholders, :error_messages, :today_button]
+    include ActionView::Context
+    include ActionView::Helpers::TagHelper
+
+    delegate :concat, to: :@output_buffer
 
     DATE_SEGMENTS = {
       day:    '_dd',
       month:  '_mm',
       year:   '_yyyy',
-    }
-
-    DEFAULT_PLACEHOLDERS = {
-      day: 'DD',
-      month: 'MM',
-      year: 'YYYY'
-    }
+    }.freeze
 
     def initialize(form, object_name, attribute, options={})
       @form               = form
@@ -24,28 +20,42 @@ module GovUkDateFields
       @day_value          = @object.send("#{@attribute}_dd")&.gsub(/\D/, '')
       @month_value        = @object.send("#{@attribute}_mm")&.gsub(/\D/, '')
       @year_value         = @object.send("#{@attribute}_yyyy")&.gsub(/\D/, '')
-      @form_hint_text     = @options[:form_hint_text] || "For example, 31 3 1980"
-      @fieldset_required  = false
-      @fieldset_id        = @options[:id]
-      @error_messages     = @options[:error_messages]
-      @hint_id            = form_group_hint_id
-      @today_button       = @options[:today_button] || false
-      parse_options
     end
 
     def raw_output
-      if fieldset_required?
-        generate_input_fields
-      else
-        generate_old_style_input_fields
-      end
+      generate_input_fields
     end
 
     def output
       raw_output.html_safe
     end
 
-  private
+    private
+
+    def generate_input_fields
+      content_tag(:div, class: form_group_classes) do
+        content_tag(:fieldset, fieldset_options(@attribute, @options)) do
+          concat fieldset_legend(@attribute, @options)
+          concat hint(@attribute)
+          concat error(@attribute)
+          concat input_fields_div
+        end
+      end
+    end
+
+    def generate_input_for(name, value, width: 2)
+      css_class = "govuk-input govuk-date-input__input govuk-input--width-#{width}"
+      css_class += " govuk-input--error" if error_for_attr?
+
+      content_tag(:div, class: 'govuk-date-input__item') do
+        content_tag(:div, class: 'govuk-form-group') do
+          %Q|
+            <label class="govuk-label govuk-date-input__label" for="#{html_id(name)}">#{localized_label(name)}</label>
+            <input class="#{css_class}" id="#{html_id(name)}" name="#{html_name(name)}" value="#{value}" type="text" inputmode="numeric" pattern="[0-9]*">
+          |.html_safe
+        end
+      end
+    end
 
     def error_for_attr?
       error_attribute_names.include?(@attribute) && @object.errors[@attribute].any?
@@ -59,202 +69,157 @@ module GovUkDateFields
       end
     end
 
-    def fieldset_required?
-      @fieldset_required
-    end
-
-    def generate_old_style_input_fields
-      %Q[
-        #{@form.text_field(@attribute, field_options(@day_value, html_id(:day), html_name(:day), placeholder(:day), 2))}
-        #{@form.text_field(@attribute, field_options(@month_value, html_id(:month), html_name(:month), placeholder(:month), 3))}
-        #{@form.text_field(@attribute, field_options(@year_value, html_id(:year), html_name(:year), placeholder(:year), 4))}
-      ]
-    end
-
-    def generate_start_fieldset
-      %Q|
-        #{generate_fieldset_tag}
-          #{generate_legend_tag}
-            <span class="form-label-bold">#{@options[:legend_text]}</span>
-            <span class="form-hint" id="#{@hint_id}">#{@form_hint_text}</span>
-            #{generate_error_message}
-          </legend>
-          <div class="form-date">
-      |
-    end
-
-    def generate_fieldset_tag
-      css_class = "form-group gov_uk_date"
-      css_class += " form-group-error" if error_for_attr?
-
-      result = %Q|
-                <div class="#{css_class}"|
-      result += %Q| id="#{form_group_id}"|
-      result += ">"
-      result += %Q| <fieldset|
-      result += ">"
-      result
+    def html_id(date_segment)
+      brackets2underscore(html_name(date_segment))
     end
 
-    def generate_end_fieldset
-      "</div></fieldset></div>"
+    def html_name(date_segment)
+      "#{@object_name}[#{@attribute}#{DATE_SEGMENTS[date_segment]}]"
     end
 
-    def generate_legend_tag
-      if @options.key?(:legend_class)
-        %Q|<legend class="#{@options[:legend_class]}">|
-      else
-        "<legend>"
-      end
+    def brackets2underscore(string)
+      string.tr('[','_').tr(']', '_').gsub('__', '_').gsub(/_$/, '')
     end
 
-    def generate_error_message
-      result = ''
-      if error_for_attr?
-        result = "<ul>"
-        if @error_messages.nil?
-          @error_messages = @object.errors[@attribute]
-        end
-        @error_messages.each do |message|
-          result += %Q|<li><span class="error-message">#{message}</span></li>|
-        end
-        result += "</ul>"
-      end
-      result
+    def attribute_prefix
+      brackets2underscore(@object_name.to_s)
     end
 
-    def generate_input_fields
-      result = generate_start_fieldset
-      result += generate_today_button if @today_button
-      result += generate_day_input_field(@day_value) + generate_month_input_field(@month_value) + generate_year_input_field(@year_value)
-      result += generate_end_fieldset
-      result
+    def form_group_id
+      [attribute_prefix, @attribute].join('_')
     end
 
-    def today_button_class
-      if @today_button.is_a?(Hash) && @today_button.key?(:class)
-        @today_button[:class]
-      else
-        'button'
-      end
+    def form_group_hint_id
+      [form_group_id, 'hint'].join('_')
     end
 
-    def generate_today_button
-      %Q|<a class="#{today_button_class}" role="button" href="#">Today</a>|
+    def form_group_classes
+      classes = ['govuk-form-group']
+      classes << 'govuk-form-group--error' if error_for_attr?
+      classes
     end
 
-    def generate_start_div
-      %Q|<div class="form-group form-group-day">|
-    end
+    def fieldset_options(attribute, options)
+      defaults = { class: 'govuk-fieldset', role: 'group' }
 
-    def generate_end_div
-      %Q|</div>|
-    end
+      aria_ids = []
+      aria_ids << id_for(attribute, 'hint')  if hint(attribute)
+      aria_ids << id_for(attribute, 'error') if error_for_attr?
 
-    def generate_day_input_field(day_value)
-      css_class = "form-control"
-      css_class += " form-control-error" if error_for_attr?
+      # If the array is empty, `#presence` will return nil
+      defaults['aria-describedby'] = aria_ids.presence
 
-      result = %Q|
-          <div class="form-group form-group-day">
-            <label for="#{html_id(:day)}">Day</label>
-            <input class="#{css_class}" id="#{html_id(:day)}" name="#{html_name(:day)}" type="number" min="0" max="31" aria-describedby="#{@hint_id}" value="#{day_value}">
-          </div>
-      |
+      merge_attributes(
+        options[:fieldset_options],
+        default: defaults
+      )
     end
 
-    def generate_month_input_field(month_value)
-      css_class = "form-control"
-      css_class += " form-control-error" if error_for_attr?
+    def fieldset_legend(attribute, options)
+      default_attrs = { class: 'govuk-fieldset__legend' }.freeze
+      default_opts  = { visually_hidden: false, page_heading: true, size: 'xl' }.freeze
 
-      result = %Q|
-        <div class="form-group form-group-month">
-          <label for="#{html_id(:month)}">Month</label>
-          <input class="#{css_class}" id="#{html_id(:month)}" name="#{html_name(:month)}" type="number" min="0" max="12" value="#{month_value}">
-        </div>
-      |
-    end
+      legend_options = merge_attributes(
+        options[:legend_options],
+        default: default_attrs
+      ).reverse_merge(
+        default_opts
+      )
 
-    def generate_year_input_field(year_value)
-      css_class = "form-control"
-      css_class += " form-control-error" if error_for_attr?
+      opts = legend_options.extract!(*default_opts.keys)
 
-      result = %Q|
-        <div class="form-group form-group-year">
-          <label for="#{html_id(:year)}">Year</label>
-          <input class="#{css_class}" id="#{html_id(:year)}" name="#{html_name(:year)}" type="number" min="0" max="2100" value="#{year_value}">
-        </div>
-      |
-    end
+      legend_options[:class] << " govuk-fieldset__legend--#{opts[:size]}"
+      legend_options[:class] << " govuk-visually-hidden" if opts[:visually_hidden]
 
-    def parse_options
-      validate_option_keys
-      if @options.key?(:legend_text) || @options.key?(:id)
-        @fieldset_required = true
-      else
-        if @options.key?(:legend_class) || @options.key?(:form_hint_text)
-          raise ArgumentError.new("Invalid combination of options: You must specifigy :legend_text if :legend_class or :form_hint_text are specified")
+      # The `page_heading` option can be false to disable "Legends as page headings"
+      # https://design-system.service.gov.uk/get-started/labels-legends-headings/
+      #
+      if opts[:page_heading]
+        content_tag(:legend, legend_options) do
+          content_tag(:h1, fieldset_text(attribute), class: 'govuk-fieldset__heading')
         end
+      else
+        content_tag(:legend, fieldset_text(attribute), legend_options)
       end
     end
 
-    def validate_option_keys
-      @options.keys.each do |option_key|
-        unless VALID_OPTIONS.include?(option_key)
-          raise ArgumentError.new("Invalid option key: #{option_key.inspect}")
-        end
+    def input_fields_div
+      content_tag(:div, class: 'govuk-date-input', id: form_group_id) do
+        concat generate_input_for(:day, @day_value)
+        concat generate_input_for(:month, @month_value)
+        concat generate_input_for(:year, @year_value, width: 4)
       end
     end
 
+    def hint(attribute)
+      return unless hint_text(attribute)
+      content_tag(:span, hint_text(attribute), class: 'govuk-hint', id: id_for(attribute, 'hint'))
+    end
 
-    def placeholder(part)
-      if @options[:placeholders] == true
-        DEFAULT_PLACEHOLDERS[part]
-      else
-        @options[:placeholders][part] || DEFAULT_PLACEHOLDERS[part] if @options[:placeholders]
-      end
+    def error(attribute)
+      return unless error_for_attr?
+
+      text = error_full_message_for(attribute)
+      content_tag(:span, text, class: 'govuk-error-message', id: id_for(attribute, 'error'))
     end
 
-    def html_id(date_segment)
-      brackets2underscore(html_name(date_segment))
+    def id_for(attribute, suffix)
+      [attribute_prefix, attribute, suffix].join('_')
     end
 
-    def html_name(date_segment)
-      "#{@object_name}[#{@attribute}#{DATE_SEGMENTS[date_segment]}]"
+    def default_label attribute
+      attribute.to_s.split('.').last.humanize.capitalize
     end
 
-    def brackets2underscore(string)
-      string.tr('[','_').tr(']', '_').gsub('__', '_').gsub(/_$/, '')
+    def fieldset_text attribute
+      localized 'helpers.fieldset', attribute, default_label(attribute)
     end
 
-    def attribute_prefix
-      brackets2underscore(@object_name.to_s)
+    def hint_text attribute
+      localized 'helpers.hint', attribute, ''
     end
 
-    def form_group_id
-      # If an `id` option was passed, this takes precedence, to ensure backward compatibility
-      return @fieldset_id if @fieldset_id
+    def localized_label attribute
+      localized 'helpers.label', attribute, default_label(attribute)
+    end
 
-      group_id = [attribute_prefix, @attribute]
-      group_id.unshift('error') if error_for_attr?
-      group_id.join('_')
+    def error_full_message_for attribute
+      message = @object.errors.full_messages_for(attribute).first
+      message&.sub default_label(attribute), localized_label(attribute)
     end
 
-    def form_group_hint_id
-      # If an `id` option was passed, this takes precedence, to ensure backward compatibility
-      return "#{@fieldset_id}-hint" if @fieldset_id
+    # If a form view is reused but the attribute doesn't change (for example in
+    # partials) an `i18n_attribute` can be used to lookup the legend or hint locales
+    # based on this, instead of the original attribute.
+    #
+    # We prioritise the `i18n_attribute` if provided, and if no locale is found,
+    # we try the 'real' attribute as a fallback and finally the default value.
+    #
+    def localized scope, attribute, default
+      found = if @options[:i18n_attribute]
+        key = "#{@object_name}.#{@options[:i18n_attribute]}"
+
+        I18n.translate(key, default: '', scope: scope).presence ||
+          I18n.translate("#{key}_html", default: '', scope: scope).html_safe.presence
+      end
+
+      return found if found
+
+      key = "#{@object_name}.#{attribute}"
 
-      [attribute_prefix, @attribute].join('_') + '-hint'
+      # Passes blank String as default because nil is interpreted as no default
+      I18n.translate(key, default: '', scope: scope).presence ||
+        I18n.translate("#{key}_html", default: default, scope: scope).html_safe.presence
     end
 
-    def field_options(value, id, name, placeholder, size)
-      {
-        value: value,
-        id: id,
-        name: name,
-        placeholder: placeholder,
-        size: size
-      }
+    # Given an attributes hash that could include any number of arbitrary keys, this method
+    # ensure we merge one or more 'default' attributes into the hash, creating the keys if
+    # don't exist, or merging the defaults if the keys already exists.
+    # It supports strings or arrays as values.
+    #
+    def merge_attributes attributes, default:
+      hash = attributes || {}
+      hash.merge(default) { |_key, oldval, newval| Array(newval) + Array(oldval) }
     end
   end
 end

data/lib/gov_uk_date_fields/version.rb

@@ -1,4 +1,4 @@
 module GovUkDateFields
-  VERSION = "3.2.0.rc3"
-  VERSION_RELEASED = "2021-06-14"
+  VERSION = "4.2.0"
+  VERSION_RELEASED = "2021-06-16"
 end

data/test/dummy/app/assets/config/manifest.js

@@ -1,3 +1,3 @@
 //= link_tree ../images
 //= link_directory ../javascripts .js
-//= link_directory ../stylesheets .css
+//= link_directory ../stylesheets .css

data/test/dummy/app/views/employees/_form.html.erb

@@ -17,7 +17,7 @@
   </div>
   <div class="field">
     <%= f.label :dob %><br>
-    <%= f.gov_uk_date_field :dob, placeholders: true, today_button: true %>
+    <%= f.gov_uk_date_field :dob %>
   </div>
   <div class="field">
     <%= f.label :joined %><br>

data/test/dummy/config/database.yml

@@ -17,6 +17,9 @@
 default: &default
   adapter: postgresql
   encoding: unicode
+  host: localhost
+  username: <%= ENV["POSTGRES_USER"] %>
+  password: <%= ENV["POSTGRES_PASSWORD"] %>
   # For details on connection pooling, see rails configuration guide
   # http://guides.rubyonrails.org/configuring.html#database-pooling
   pool: 5

data/test/dummy/config/locales/en.yml

@@ -20,4 +20,23 @@
 # available at http://guides.rubyonrails.org/i18n.html.
 
 en:
-  hello: "Hello world"
+  errors:
+    format: "%{message}"
+    attributes:
+      dob:
+        blank: Enter the date of birth
+
+  helpers:
+    fieldset:
+      employee:
+        dob: Date of birth
+        custom_i18n_attribute: A custom legend
+    label:
+      dob:
+        day: Day
+        month: Month
+        year: Year
+    hint:
+      employee:
+        dob: For example, 12 11 2007
+        custom_i18n_attribute: A custom hint