govuk_design_system_formbuilder 1.0.0 → 1.1.0

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
@@ -23,14 +29,11 @@ module GOVUKDesignSystemFormBuilder
                   id: field_id(link_errors: true),
                   class: govuk_textarea_classes,
                   aria: {
-                    describedby: described_by(
-                      hint_id,
-                      error_id,
-                      supplemental_id
-                    )
+                    describedby: described_by(hint_id, error_id, supplemental_id, limit_description_id)
                   },
                   **@extra_args.merge(rows: @rows)
-                )
+                ),
+                limit_description
               ].flatten.compact
             )
           end
@@ -46,9 +49,39 @@ 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
+
+      def limit_description
+        return nil unless limit?
+
+        content_tag('span', id: limit_id, class: %w(govuk-hint govuk-character-count__message), aria: { live: 'polite' }) do
+          "You can enter up to #{limit_quantity} #{limit_type}"
+        end
+      end
+
+      def limit_quantity
+        @max_words || @max_chars
+      end
+
+      def limit_type
+        @max_words.present? ? 'words' : 'characters'
+      end
+
+      def limit_description_id
+        return nil unless limit?
+
+        limit_id
+      end
     end
   end
 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/input.rb

@@ -0,0 +1,77 @@
+module GOVUKDesignSystemFormBuilder
+  module Traits
+    module Input
+      def initialize(builder, object_name, attribute_name, hint_text:, label:, width:, **extra_args, &block)
+        super(builder, object_name, attribute_name, &block)
+
+        @width          = width
+        @extra_args     = extra_args
+        @label          = label
+        @hint_text      = hint_text
+      end
+
+      def html
+        Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
+          safe_join(
+            [
+              label_element.html,
+              hint_element.html,
+              supplemental_content.html,
+              error_element.html,
+              @builder.send(
+                builder_method,
+                @attribute_name,
+                id: field_id(link_errors: true),
+                class: input_classes,
+                aria: {
+                  describedby: described_by(
+                    hint_id,
+                    error_id,
+                    supplemental_id
+                  )
+                },
+                **@extra_args
+              )
+            ]
+          )
+        end
+      end
+
+    private
+
+      def input_classes
+        %w(govuk-input).push(width_classes, error_classes).compact
+      end
+
+      def error_classes
+        'govuk-input--error' if has_errors?
+      end
+
+      def width_classes
+        return if @width.blank?
+
+        case @width
+        when nil then nil
+
+          # fixed (character) widths
+        when 20 then 'govuk-input--width-20'
+        when 10 then 'govuk-input--width-10'
+        when 5  then 'govuk-input--width-5'
+        when 4  then 'govuk-input--width-4'
+        when 3  then 'govuk-input--width-3'
+        when 2  then 'govuk-input--width-2'
+
+          # fluid widths
+        when 'full'           then 'govuk-!-width-full'
+        when 'three-quarters' then 'govuk-!-width-three-quarters'
+        when 'two-thirds'     then 'govuk-!-width-two-thirds'
+        when 'one-half'       then 'govuk-!-width-one-half'
+        when 'one-third'      then 'govuk-!-width-one-third'
+        when 'one-quarter'    then 'govuk-!-width-one-quarter'
+
+        else fail(ArgumentError, "invalid width '#{@width}'")
+        end
+      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,41 @@
+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?
+
+        schema(context)
+      end
+
+      def schema(context)
+        schema_root(context)
+          .push(@object_name, @attribute_name)
+          .map { |e| e == :__context__ ? context : e }
+          .join('.')
+      end
+
+      def schema_root(context)
+        contextual_schema = case context
+                            when :legend
+                              config.localisation_schema_legend
+                            when :hint
+                              config.localisation_schema_hint
+                            when :label
+                              config.localisation_schema_label
+                            end
+
+        (contextual_schema || config.localisation_schema_fallback).dup
+      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.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/lib/govuk_design_system_formbuilder.rb

@@ -1,45 +1,82 @@
-require 'govuk_design_system_formbuilder/version'
-require 'govuk_design_system_formbuilder/builder'
-require 'govuk_design_system_formbuilder/base'
-
-require 'govuk_design_system_formbuilder/elements/hint'
-require 'govuk_design_system_formbuilder/elements/label'
-require 'govuk_design_system_formbuilder/elements/date'
-require 'govuk_design_system_formbuilder/elements/select'
-require 'govuk_design_system_formbuilder/elements/submit'
-require 'govuk_design_system_formbuilder/elements/text_area'
-require 'govuk_design_system_formbuilder/elements/file'
-
-require 'govuk_design_system_formbuilder/elements/inputs/base'
-require 'govuk_design_system_formbuilder/elements/inputs/email'
-require 'govuk_design_system_formbuilder/elements/inputs/number'
-require 'govuk_design_system_formbuilder/elements/inputs/phone'
-require 'govuk_design_system_formbuilder/elements/inputs/text'
-require 'govuk_design_system_formbuilder/elements/inputs/url'
-
-require 'govuk_design_system_formbuilder/elements/radios/collection'
-require 'govuk_design_system_formbuilder/elements/radios/collection_radio_button'
-require 'govuk_design_system_formbuilder/elements/radios/fieldset_radio_button'
-
-require 'govuk_design_system_formbuilder/elements/check_boxes/collection'
-require 'govuk_design_system_formbuilder/elements/check_boxes/collection_check_box'
-require 'govuk_design_system_formbuilder/elements/check_boxes/fieldset_check_box'
-require 'govuk_design_system_formbuilder/elements/check_boxes/label'
-require 'govuk_design_system_formbuilder/elements/check_boxes/hint'
-
-require 'govuk_design_system_formbuilder/elements/error_message'
-require 'govuk_design_system_formbuilder/elements/error_summary'
-
-require 'govuk_design_system_formbuilder/containers/check_boxes_fieldset'
-require 'govuk_design_system_formbuilder/containers/form_group'
-require 'govuk_design_system_formbuilder/containers/fieldset'
-require 'govuk_design_system_formbuilder/containers/radios'
-require 'govuk_design_system_formbuilder/containers/radio_buttons_fieldset'
-require 'govuk_design_system_formbuilder/containers/check_boxes'
-require 'govuk_design_system_formbuilder/containers/character_count'
-require 'govuk_design_system_formbuilder/containers/supplemental'
+require 'active_support/configurable'
+
+[%w(traits *.rb), %w(*.rb), %w(elements ** *.rb), %w(containers ** *.rb)]
+  .flat_map { |matcher| Dir.glob(File.join(__dir__, 'govuk_design_system_formbuilder', *matcher)) }
+  .each { |file| require file }
 
 module GOVUKDesignSystemFormBuilder
+  include ActiveSupport::Configurable
+
+  # @!group Defaults
+
+  # Default form builder configuration
+  #
+  # * +:default_legend_size+ controls the default size of legend text.
+  #   Can be either +xl+, +l+, +m+ or +s+.
+  #
+  # * +:default_legend_tag+ controls the default tag that legends are
+  #   wrapped in. Defaults to +h1+.
+  #
+  # * +:default_submit_button_text+ sets the value assigned to +govuk_submit+,
+  #   defaults to 'Continue'.
+  #
+  # * +:default_submit_button_text+ sets the text used to divide the last radio
+  #   button in radio button fieldsets. As per the GOV.UK Design System spec,
+  #   it defaults to 'or'.
+  #
+  # * +:default_error_summary_title+ sets the text used in error summary
+  #   blocks. As per the GOV.UK Design System spec, it defaults to
+  #   'There is a problem'.
+  #
+  # * +:localisation_schema_fallback+ sets the prefix elements for the array
+  #   used to build the localisation string. The final two elements are always
+  #   are the object name and attribute name. The _special_ value +__context__+,
+  #   is used as a placeholder for the context (label, fieldset or hint).
+  #
+  # * +:localisation_schema_legend+, +:localisation_schema_hint+ and
+  #   +:localisation_schema_label+ each override the schema root for their
+  #   particular context, allowing them to be independently customised.
+  # ===
+  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',
+
+    localisation_schema_fallback: %i(helpers __context__),
+    localisation_schema_label: nil,
+    localisation_schema_hint: nil,
+    localisation_schema_legend: nil
+  }.freeze
+
+  DEFAULTS.keys.each { |k| config_accessor(k) { DEFAULTS[k] } }
+  # @!endgroup
+
+  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 +84,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_design_system_formbuilder
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Peter Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-19 00:00:00.000000000 Z
+date: 2019-12-29 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,28 @@ 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: rubypants
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: sassc
   requirement: !ruby/object:Gem::Requirement
@@ -226,6 +240,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
@@ -270,7 +298,6 @@ files:
 - lib/govuk_design_system_formbuilder/elements/error_summary.rb
 - lib/govuk_design_system_formbuilder/elements/file.rb
 - lib/govuk_design_system_formbuilder/elements/hint.rb
-- lib/govuk_design_system_formbuilder/elements/inputs/base.rb
 - lib/govuk_design_system_formbuilder/elements/inputs/email.rb
 - lib/govuk_design_system_formbuilder/elements/inputs/number.rb
 - lib/govuk_design_system_formbuilder/elements/inputs/phone.rb
@@ -283,6 +310,14 @@ 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/input.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:

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

@@ -1,79 +0,0 @@
-module GOVUKDesignSystemFormBuilder
-  module Elements
-    module Inputs
-      class Base < GOVUKDesignSystemFormBuilder::Base
-        def initialize(builder, object_name, attribute_name, hint_text:, label:, width:, **extra_args, &block)
-          super(builder, object_name, attribute_name, &block)
-
-          @width          = width
-          @extra_args     = extra_args
-          @label          = label
-          @hint_text      = hint_text
-        end
-
-        def html
-          Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
-            safe_join(
-              [
-                label_element.html,
-                hint_element.html,
-                supplemental_content.html,
-                error_element.html,
-                @builder.send(
-                  builder_method,
-                  @attribute_name,
-                  id: field_id(link_errors: true),
-                  class: input_classes,
-                  aria: {
-                    describedby: described_by(
-                      hint_id,
-                      error_id,
-                      supplemental_id
-                    )
-                  },
-                  **@extra_args
-                )
-              ]
-            )
-          end
-        end
-
-      private
-
-        def input_classes
-          %w(govuk-input).push(width_classes, error_classes).compact
-        end
-
-        def error_classes
-          'govuk-input--error' if has_errors?
-        end
-
-        def width_classes
-          return if @width.blank?
-
-          case @width
-          when nil then nil
-
-            # fixed (character) widths
-          when 20 then 'govuk-input--width-20'
-          when 10 then 'govuk-input--width-10'
-          when 5  then 'govuk-input--width-5'
-          when 4  then 'govuk-input--width-4'
-          when 3  then 'govuk-input--width-3'
-          when 2  then 'govuk-input--width-2'
-
-            # fluid widths
-          when 'full'           then 'govuk-!-width-full'
-          when 'three-quarters' then 'govuk-!-width-three-quarters'
-          when 'two-thirds'     then 'govuk-!-width-two-thirds'
-          when 'one-half'       then 'govuk-!-width-one-half'
-          when 'one-third'      then 'govuk-!-width-one-third'
-          when 'one-quarter'    then 'govuk-!-width-one-quarter'
-
-          else fail(ArgumentError, "invalid width '#{@width}'")
-          end
-        end
-      end
-    end
-  end
-end