govuk_design_system_formbuilder 3.1.2 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a538f7ffa0545474cbf27c732593366f6db00bb2941301ea8b747fd82dcb1f53
-  data.tar.gz: 478a366c7d960553dd74095ac6ac63209883b75701dc2732e10c47106a52e169
+  metadata.gz: 23f730aaf4ab5716aabec97d5becffbfae9e7e4f5fcab7ccc0889f3e1989b733
+  data.tar.gz: 381ebbd696bf0de076b1218c40f255bd3d30badbfbb15ea7388a3b1eb384be46
 SHA512:
-  metadata.gz: 1eb3291b77100cdd0f55db025e20d623ced134e966498c66cc949ecc4ee70ca132de885959ffaefb67fcce0a19aac0d587c620ffaccdca6a886c73b28d585f7f
-  data.tar.gz: 98879a898f28df855ace670efe976749db0a3ab911f9090e096ffd73e803d9b6342e3a5d8a813c7927628e56af833d1ce3d430fe84ef4a53da79bbaf58010b67
+  metadata.gz: 03be873f3bdc9826d02282d9e19bbd4314225a70e5913a1fd7b830f8eed1b037fb9cd192d37d5ae73f440cb66e2ee964aac085798f4eb9e8c7dc5521f208c612
+  data.tar.gz: c33b0b4c947807befcf25cd6def07b1121fb45703d6a7a36ceeaf56686d4a0919b8a71cd848ceb0430f178a65e3e93bb970ec4c5a23db27afad087fff9678a3e

data/README.md

@@ -6,15 +6,15 @@
 [![Gem](https://img.shields.io/gem/dt/govuk_design_system_formbuilder?logo=rubygems)](https://rubygems.org/gems/govuk_design_system_formbuilder)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/110136fb22341d3ba646/test_coverage)](https://codeclimate.com/github/DFE-Digital/govuk-formbuilder/test_coverage)
 [![GitHub license](https://img.shields.io/github/license/DFE-Digital/govuk_design_system_formbuilder)](https://github.com/DFE-Digital/govuk-formbuilder/blob/main/LICENSE)
-[![GOV.UK Design System Version](https://img.shields.io/badge/GOV.UK%20Design%20System-4.3.0-brightgreen)](https://design-system.service.gov.uk)
-[![Rails](https://img.shields.io/badge/Rails-6.1.5%20%E2%95%B1%207.0.3-E16D6D)](https://weblog.rubyonrails.org/releases/)
+[![GOV.UK Design System Version](https://img.shields.io/badge/GOV.UK%20Design%20System-4.3.1-brightgreen)](https://design-system.service.gov.uk)
+[![Rails](https://img.shields.io/badge/Rails-6.1.7%20%E2%95%B1%207.0.4-E16D6D)](https://weblog.rubyonrails.org/releases/)
 [![Ruby](https://img.shields.io/badge/Ruby-2.7.6%20%20%E2%95%B1%203.0.4%20%20%E2%95%B1%203.1.2-E16D6D)](https://www.ruby-lang.org/en/downloads/)
 
 This library provides an easy-to-use form builder for the [GOV.UK Design System](https://design-system.service.gov.uk/).
 
 It is intended to make creating forms **quick**, **easy** and **familiar** for Ruby on Rails developers.
 
-## Documentation 📚
+## Documentation
 
 The gem comes with [a full guide](https://govuk-form-builder.netlify.app/) that
 covers most aspects of day-to-day use, along with code and output examples. The
@@ -23,7 +23,7 @@ be up to date.
 
 [![Netlify Status](https://api.netlify.com/api/v1/badges/d4c50b8d-6ca3-4797-9ab3-6e0731c72b44/deploy-status)](https://app.netlify.com/sites/govuk-form-builder/deploys)
 
-## What's included 🧳
+## What's included
 
 * 100% compatibility with the GOV.UK Design System
 * Full control of labels, legends, hints, captions and fieldsets
@@ -38,7 +38,7 @@ be up to date.
 * An exhaustive test suite
 * [Extensive technical documentation](https://www.rubydoc.info/gems/govuk_design_system_formbuilder/GOVUKDesignSystemFormBuilder/Builder)
 
-## Installation 🏗
+## Installation
 
 You can install the form builder gem by running the `gem install
 govuk_design_system_formbuilder` or by adding the following line
@@ -58,10 +58,10 @@ pre-configured template:
 * [DfE Rails Template](https://github.com/DFE-Digital/rails-template)
 * [DEFRA Ruby Template](https://github.com/DEFRA/defra-ruby-template)
 
-## Setup 🔧
+## Setup
 
 To use the form builder in an ad hoc basis you can specify it as an argument to
-`form_for` or `form_with`. These examples are written in [Slim](https://slim-lang.com) but
+`form_for` or `form_with`. These examples are written in [Slim](https://github.com/slim-template/slim) but
 other templating languages like ERB and [Haml](https://haml.info/) work just as well.
 
 ```slim
@@ -97,7 +97,7 @@ Now we can get started!
   = f.govuk_submit 'Away we go!'
 ```
 
-## Developing and running the tests 👨🏻‍🏭
+## Developing and running the tests
 
 The form builder is tested with RSpec. To run all the tests first ensure that
 the development and testing prerequisite gems are installed. At the root of a
@@ -113,7 +113,7 @@ Now, if everything was successful, run RSpec:
 bundle exec rspec
 ```
 
-## Contributing 📦
+## Contributing
 
 Bug reports and feature requests are most welcome, please raise an issue or
 submit a pull request.
@@ -143,7 +143,12 @@ here are a few from the <abbr title="Department for Education">DfE</abbr>, <abbr
  * [Trade Tariff duty calculator](https://www.github.com/trade-tariff/trade-tariff-duty-calculator)
  * [Report your official development assistance](https://www.github.com/UKGovernmentBEIS/beis-report-official-development-assistance)
 
-## Thanks 👩🏽‍⚖️
+## Form building services using this library
+
+* [MoJ Forms](https://moj-forms.service.justice.gov.uk/)
+* [GOV.UK Forms](https://www.forms.service.gov.uk/)
+
+## Thanks
 
 This project was inspired by [Ministry of Justice's GovukElementsFormBuilder](https://github.com/ministryofjustice/govuk_elements_form_builder),
 but is leaner, more modular and written in a more idiomatic style.

data/lib/govuk_design_system_formbuilder/elements/caption.rb

@@ -2,6 +2,8 @@ module GOVUKDesignSystemFormBuilder
   module Elements
     class Caption < Base
       include Traits::Localisation
+      include Traits::HTMLAttributes
+      include Traits::HTMLClasses
 
       def initialize(builder, object_name, attribute_name, text: nil, size: config.default_caption_size, **kwargs)
         super(builder, object_name, attribute_name)
@@ -14,11 +16,15 @@ module GOVUKDesignSystemFormBuilder
       def html
         return unless active?
 
-        tag.span(@text, class: @size_class, **@html_attributes)
+        tag.span(@text, **attributes(@html_attributes))
       end
 
     private
 
+      def options
+        { class: @size_class }
+      end
+
       def active?
         @text.present?
       end
@@ -28,13 +34,9 @@ module GOVUKDesignSystemFormBuilder
       end
 
       def size_class(size)
-        case size
-        when 'xl' then %(#{brand}-caption-xl)
-        when 'l'  then %(#{brand}-caption-l)
-        when 'm'  then %(#{brand}-caption-m)
-        else
-          fail ArgumentError, "invalid size '#{size}', must be xl, l or m"
-        end
+        fail ArgumentError, "invalid size '#{size}', must be xl, l or m" unless size.in?(%w(xl l m))
+
+        %(#{brand}-caption-#{size})
       end
     end
   end

data/lib/govuk_design_system_formbuilder/elements/hint.rb

@@ -4,6 +4,8 @@ module GOVUKDesignSystemFormBuilder
       using PrefixableArray
 
       include Traits::Localisation
+      include Traits::HTMLAttributes
+      include Traits::HTMLClasses
 
       def initialize(builder, object_name, attribute_name, value: nil, text: nil, content: nil, radio: false, checkbox: false, **kwargs)
         super(builder, object_name, attribute_name)
@@ -27,7 +29,7 @@ module GOVUKDesignSystemFormBuilder
       def html
         return unless active?
 
-        tag.div(**hint_options, **@html_attributes) { hint_body }
+        tag.div(**attributes(@html_attributes)) { hint_body }
       end
 
       def hint_id
@@ -38,7 +40,7 @@ module GOVUKDesignSystemFormBuilder
 
     private
 
-      def hint_options
+      def options
         { class: classes, id: hint_id }
       end
 

data/lib/govuk_design_system_formbuilder/elements/label.rb

@@ -5,6 +5,8 @@ module GOVUKDesignSystemFormBuilder
 
       include Traits::Caption
       include Traits::Localisation
+      include Traits::HTMLAttributes
+      include Traits::HTMLClasses
 
       def initialize(builder, object_name, attribute_name, text: nil, value: nil, size: nil, hidden: false, radio: false, checkbox: false, tag: nil, link_errors: true, content: nil, caption: nil, **kwargs)
         super(builder, object_name, attribute_name)
@@ -44,7 +46,7 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def label
-        @builder.label(@attribute_name, **options, **@html_attributes) do
+        @builder.label(@attribute_name, **attributes(@html_attributes)) do
           @content || safe_join([caption, @text])
         end
       end
@@ -63,7 +65,7 @@ module GOVUKDesignSystemFormBuilder
         {
           value: @value,
           for: field_id(link_errors: @link_errors),
-          class: %w(label).prefix(brand).push(@size_class, @weight_class, radio_class, checkbox_class).compact
+          class: classes
         }
       end
 
@@ -71,28 +73,22 @@ module GOVUKDesignSystemFormBuilder
         caption_element.html unless [@radio, @checkbox].any?
       end
 
-      def radio_class
-        return unless @radio
-
-        %(#{brand}-radios__label)
+      def classes
+        build_classes(
+          %(label),
+          @size_class,
+          @weight_class,
+          %(radios__label) => @radio,
+          %(checkboxes__label) => @checkbox,
+        ).prefix(brand)
       end
 
-      def checkbox_class
-        return unless @checkbox
+      def size_class(size)
+        return if size.blank?
 
-        %(#{brand}-checkboxes__label)
-      end
+        fail "invalid size '#{size}', must be xl, l, m, s or nil" unless size.in?(%w(xl l m s))
 
-      def size_class(size)
-        case size
-        when 'xl' then %(#{brand}-label--xl)
-        when 'l'  then %(#{brand}-label--l)
-        when 'm'  then %(#{brand}-label--m)
-        when 's'  then %(#{brand}-label--s)
-        when nil  then nil
-        else
-          fail "invalid size '#{size}', must be xl, l, m, s or nil"
-        end
+        %(label--#{size})
       end
     end
   end

data/lib/govuk_design_system_formbuilder/elements/legend.rb

@@ -1,8 +1,12 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     class Legend < Base
+      using PrefixableArray
+
       include Traits::Caption
       include Traits::Localisation
+      include Traits::HTMLAttributes
+      include Traits::HTMLClasses
 
       def initialize(builder, object_name, attribute_name, text: nil, size: config.default_legend_size, hidden: false, tag: config.default_legend_tag, caption: nil, content: nil, **kwargs)
         super(builder, object_name, attribute_name)
@@ -33,7 +37,19 @@ module GOVUKDesignSystemFormBuilder
       def legend
         return unless active?
 
-        tag.legend(legend_content, class: classes, **@html_attributes)
+        tag.legend(legend_content, **attributes(@html_attributes))
+      end
+
+      def options
+        { class: classes }
+      end
+
+      def classes
+        build_classes(
+          %(fieldset__legend),
+          @size_class,
+          %(visually-hidden) => @hidden
+        ).prefix(brand)
       end
 
       def legend_content
@@ -48,20 +64,10 @@ module GOVUKDesignSystemFormBuilder
         [supplied_text, localised_text(:legend), @attribute_name&.capitalize].find(&:presence)
       end
 
-      def classes
-        [%(#{brand}-fieldset__legend), @size_class, visually_hidden_class].compact
-      end
-
       def size_class(size)
-        if size.in?(%w(xl l m s))
-          %(#{brand}-fieldset__legend--#{size})
-        else
-          fail "invalid size '#{size}', must be xl, l, m or s"
-        end
-      end
+        fail "invalid size '#{size}', must be xl, l, m or s" unless size.in?(%w(xl l m s))
 
-      def visually_hidden_class
-        %(#{brand}-visually-hidden) if @hidden
+        %(fieldset__legend--#{size})
       end
 
       def heading_classes

data/lib/govuk_design_system_formbuilder/version.rb

@@ -1,3 +1,3 @@
 module GOVUKDesignSystemFormBuilder
-  VERSION = '3.1.2'.freeze
+  VERSION = '3.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_design_system_formbuilder
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.2.0
 platform: ruby
 authors:
 - Peter Yates
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-15 00:00:00.000000000 Z
+date: 2022-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: html-attributes-utils
@@ -78,14 +78,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -126,28 +126,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rubocop-govuk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.6.0
+        version: 4.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.6.0
+        version: 4.8.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -196,14 +196,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.30.0
+        version: 4.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.30.0
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: rubypants
   requirement: !ruby/object:Gem::Requirement