govuk_design_system_formbuilder 1.2.0b1 → 1.2.2

data/lib/govuk_design_system_formbuilder/elements/submit.rb

@@ -3,7 +3,7 @@ module GOVUKDesignSystemFormBuilder
     class Submit < Base
       using PrefixableArray
 
-      def initialize(builder, text, warning:, secondary:, classes:, prevent_double_click:, validate:, &block)
+      def initialize(builder, text, warning:, secondary:, classes:, prevent_double_click:, validate:, disabled:, &block)
         fail ArgumentError, 'buttons can be warning or secondary' if warning && secondary
 
         @builder              = builder
@@ -13,29 +13,38 @@ module GOVUKDesignSystemFormBuilder
         @secondary            = secondary
         @classes              = classes
         @validate             = validate
+        @disabled             = disabled
         @block_content        = capture { block.call } if block_given?
       end
 
       def html
-        safe_join(
-          [
-            @builder.submit(
-              @text,
-              class: %w(button).prefix(brand).push(
-                warning_class,
-                secondary_class,
-                @classes,
-                padding_class(@block_content.present?)
-              ).compact,
-              **extra_args
-            ),
-            @block_content
-          ]
-        )
+        safe_join([submit, @block_content])
       end
 
     private
 
+      def submit
+        @builder.submit(@text, class: submit_classes, **submit_options)
+      end
+
+      def submit_classes
+        %w(button)
+          .prefix(brand)
+          .push(warning_class, secondary_class, disabled_class, @classes, padding_class(@block_content.present?))
+          .compact
+      end
+
+      def submit_options
+        {
+          formnovalidate: !@validate,
+          disabled: @disabled,
+          data: {
+            module: %(#{brand}-button),
+            'prevent-double-click': @prevent_double_click
+          }.select { |_k, v| v.present? }
+        }
+      end
+
       def warning_class
         %(#{brand}-button--warning) if @warning
       end
@@ -48,13 +57,8 @@ module GOVUKDesignSystemFormBuilder
         %(#{brand}-!-margin-right-1) if content_present
       end
 
-      def extra_args
-        {
-          formnovalidate: !@validate,
-          data: {
-            module: %(#{brand}-button), 'prevent-double-click' => @prevent_double_click
-          }.select { |_k, v| v.present? }
-        }
+      def disabled_class
+        %(#{brand}-button--disabled) if @disabled
       end
     end
   end

data/lib/govuk_design_system_formbuilder/elements/text_area.rb

@@ -8,12 +8,13 @@ module GOVUKDesignSystemFormBuilder
       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)
+      def initialize(builder, object_name, attribute_name, hint_text:, label:, caption:, rows:, max_words:, max_chars:, threshold:, **kwargs, &block)
         super(builder, object_name, attribute_name, &block)
 
         @label      = label
+        @caption    = caption
         @hint_text  = hint_text
-        @extra_args = extra_args
+        @attributes = kwargs
         @max_words  = max_words
         @max_chars  = max_chars
         @threshold  = threshold
@@ -23,39 +24,32 @@ module GOVUKDesignSystemFormBuilder
       def html
         Containers::CharacterCount.new(@builder, max_words: @max_words, max_chars: @max_chars, threshold: @threshold).html do
           Containers::FormGroup.new(@builder, @object_name, @attribute_name).html do
-            safe_join(
-              [
-                [
-                  label_element,
-                  supplemental_content,
-                  hint_element,
-                  error_element
-                ].map(&:html),
-                @builder.text_area(
-                  @attribute_name,
-                  id: field_id(link_errors: true),
-                  class: govuk_textarea_classes,
-                  aria: {
-                    describedby: described_by(hint_id, error_id, supplemental_id, limit_description_id)
-                  },
-                  **@extra_args.merge(rows: @rows)
-                ),
-                limit_description
-              ].flatten.compact
-            )
+            safe_join([label_element, supplemental_content, hint_element, error_element, text_area, limit_description])
           end
         end
       end
 
     private
 
-      def govuk_textarea_classes
+      def text_area
+        @builder.text_area(@attribute_name, **text_area_options, **@attributes.merge(rows: @rows))
+      end
+
+      def text_area_classes
         %w(textarea).prefix(brand).tap do |classes|
           classes.push(%(#{brand}-textarea--error)) if has_errors?
           classes.push(%(#{brand}-js-character-count)) if limit?
         end
       end
 
+      def text_area_options
+        {
+          id: field_id(link_errors: true),
+          class: text_area_classes,
+          aria: { describedby: described_by(hint_id, error_id, supplemental_id, limit_description_id) },
+        }
+      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

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,44 +1,36 @@
 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
         [%(#{brand}-input)].push(width_classes, error_classes).compact
       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.2.0b1'.freeze
+  VERSION = '1.2.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_design_system_formbuilder
 version: !ruby/object:Gem::Version
-  version: 1.2.0b1
+  version: 1.2.2
 platform: ruby
 authors:
 - Peter Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-15 00:00:00.000000000 Z
+date: 2020-06-25 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,42 +134,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.17.1
-- !ruby/object:Gem::Dependency
-  name: adsf
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: 0.18.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.2
-- !ruby/object:Gem::Dependency
-  name: adsf-live
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: 0.18.5
 - !ruby/object:Gem::Dependency
   name: htmlbeautifier
   requirement: !ruby/object:Gem::Requirement
@@ -204,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
@@ -260,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:
@@ -288,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
@@ -310,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
@@ -339,11 +313,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      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