govuk_design_system_formbuilder 1.1.11 → 1.2.1

data/lib/govuk_design_system_formbuilder/traits/caption.rb

@@ -0,0 +1,23 @@
+module GOVUKDesignSystemFormBuilder
+  module Traits
+    module Caption
+    private
+
+      def caption_element
+        @caption_element ||= Elements::Caption.new(@builder, @object_name, @attribute_name, **caption_options)
+      end
+
+      def caption_options
+        { text: nil }.merge({ text: caption_text, size: caption_size }.compact)
+      end
+
+      def caption_text
+        @caption&.dig(:text)
+      end
+
+      def caption_size
+        @caption&.dig(:size)
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/traits/input.rb

@@ -1,50 +1,42 @@
 module GOVUKDesignSystemFormBuilder
   module Traits
     module Input
-      def initialize(builder, object_name, attribute_name, hint_text:, label:, width:, **extra_args, &block)
+      def initialize(builder, object_name, attribute_name, hint_text:, label:, caption:, width:, **kwargs, &block)
         super(builder, object_name, attribute_name, &block)
 
-        @width          = width
-        @extra_args     = extra_args
-        @label          = label
-        @hint_text      = hint_text
+        @width      = width
+        @attributes = kwargs
+        @label      = label
+        @caption    = caption
+        @hint_text  = hint_text
       end
 
       def html
         Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
-          safe_join(
-            [
-              label_element.html,
-              supplemental_content.html,
-              hint_element.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
-              )
-            ]
-          )
+          safe_join([label_element, supplemental_content, hint_element, error_element, input])
         end
       end
 
     private
 
+      def input
+        @builder.send(builder_method, @attribute_name, **input_options.merge(@attributes))
+      end
+
+      def input_options
+        {
+          id: field_id(link_errors: true),
+          class: input_classes,
+          aria: { describedby: described_by(hint_id, error_id, supplemental_id) }
+        }
+      end
+
       def input_classes
-        %w(govuk-input).push(width_classes, error_classes).compact
+        [%(#{brand}-input)].push(width_classes, error_classes).compact
       end
 
       def error_classes
-        'govuk-input--error' if has_errors?
+        %(#{brand}-input--error) if has_errors?
       end
 
       def width_classes
@@ -53,20 +45,20 @@ module GOVUKDesignSystemFormBuilder
         case @width
 
           # fixed (character) widths
-        when 20 then 'govuk-input--width-20'
-        when 10 then 'govuk-input--width-10'
-        when 5  then 'govuk-input--width-5'
-        when 4  then 'govuk-input--width-4'
-        when 3  then 'govuk-input--width-3'
-        when 2  then 'govuk-input--width-2'
+        when 20 then %(#{brand}-input--width-20)
+        when 10 then %(#{brand}-input--width-10)
+        when 5  then %(#{brand}-input--width-5)
+        when 4  then %(#{brand}-input--width-4)
+        when 3  then %(#{brand}-input--width-3)
+        when 2  then %(#{brand}-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'
+        when 'full'           then %(#{brand}-!-width-full)
+        when 'three-quarters' then %(#{brand}-!-width-three-quarters)
+        when 'two-thirds'     then %(#{brand}-!-width-two-thirds)
+        when 'one-half'       then %(#{brand}-!-width-one-half)
+        when 'one-third'      then %(#{brand}-!-width-one-third)
+        when 'one-quarter'    then %(#{brand}-!-width-one-quarter)
 
         else fail(ArgumentError, "invalid width '#{@width}'")
         end

data/lib/govuk_design_system_formbuilder/traits/label.rb

@@ -4,7 +4,18 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def label_element
-        @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, **@label)
+        @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, caption: @caption, **label_options)
+      end
+
+      def label_options
+        case @label
+        when Hash
+          @label
+        when Proc
+          { content: @label }
+        else
+          fail(ArgumentError, %(label must be a Proc or Hash))
+        end
       end
     end
   end

data/lib/govuk_design_system_formbuilder/traits/localisation.rb

@@ -40,6 +40,8 @@ module GOVUKDesignSystemFormBuilder
                               config.localisation_schema_hint
                             when :label
                               config.localisation_schema_label
+                            when :caption
+                              config.localisation_schema_caption
                             end
 
         (contextual_schema || config.localisation_schema_fallback).dup

data/lib/govuk_design_system_formbuilder/version.rb

@@ -1,3 +1,3 @@
 module GOVUKDesignSystemFormBuilder
-  VERSION = '1.1.11'.freeze
+  VERSION = '1.2.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_design_system_formbuilder
 version: !ruby/object:Gem::Version
-  version: 1.1.11
+  version: 1.2.1
 platform: ruby
 authors:
 - Peter Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-20 00:00:00.000000000 Z
+date: 2020-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 3.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 3.14.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -84,22 +84,22 @@ dependencies:
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.9.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.9.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: rspec-html-matchers
   requirement: !ruby/object:Gem::Requirement
@@ -134,14 +134,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 0.18.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 0.18.5
 - !ruby/object:Gem::Dependency
   name: htmlbeautifier
   requirement: !ruby/object:Gem::Requirement
@@ -176,14 +176,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.18.0
+        version: 3.19.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.18.0
+        version: 3.19.0
 - !ruby/object:Gem::Dependency
   name: rubypants
   requirement: !ruby/object:Gem::Requirement
@@ -232,14 +232,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: 4.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: 4.1.0
 description: A Rails form builder that generates form inputs adhering to the GOV.UK
   Design System
 email:
@@ -260,6 +260,7 @@ files:
 - lib/govuk_design_system_formbuilder/containers/radio_buttons_fieldset.rb
 - lib/govuk_design_system_formbuilder/containers/radios.rb
 - lib/govuk_design_system_formbuilder/containers/supplemental.rb
+- lib/govuk_design_system_formbuilder/elements/caption.rb
 - lib/govuk_design_system_formbuilder/elements/check_boxes/collection.rb
 - lib/govuk_design_system_formbuilder/elements/check_boxes/collection_check_box.rb
 - lib/govuk_design_system_formbuilder/elements/check_boxes/fieldset_check_box.rb
@@ -282,6 +283,7 @@ 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/caption.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
@@ -315,7 +317,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: GOV.UK-compliant Rails form builder