govuk_design_system_formbuilder 0.9.8 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34191822b2322a27884781b5fdc5d494385f0386b349c8253c213f76cef55600
-  data.tar.gz: dc0d69655c5d8bcbeaa967b852566abec1b821ad9ef43a6f0a4bc65afafc841a
+  metadata.gz: f87c2ecd9fbd0615a3061159d7e87b42254115db22f59c260a6e4209f7ff742d
+  data.tar.gz: a167bde412b2158d9ed303af32e730d5ae27876b1ac4ee80d675b9bc81d15126
 SHA512:
-  metadata.gz: 21f8a1d3f15d4de5f01bb54804fbb700ca902f6cb7dee40ab686b500d3d9133f2c3983b48fb4ee040ffcb24c19d03c5511736dc9ca732d3204caeb45ad185e20
-  data.tar.gz: 154333ebb09be62fd38a1d4c0b3449d0a140d2c732e1010f2a164b095f93cd1d67c6870fbf6908729cc8a78cc02ea131f67677f685cef680a276611706b1b2b6
+  metadata.gz: 4d184b3fa9ed93c35ea9ef15a72bf79f3520632fd3f501d93cc089a2e4b4e73fb73c2078083a9e0785f812802f2b406c972b568033148c9875bf1c4906ee9122
+  data.tar.gz: 3462d38207e9220b41bc3bc899d5218bc9ef982e609e2c96f58abbe0d8d20d9e9bd515b1be4566f77b37a4b543e0929a02fd9fa18bb0001815067aa0e6b07ea9

data/README.md

@@ -2,44 +2,42 @@
 
 [![Build Status](https://travis-ci.com/DFE-Digital/govuk_design_system_formbuilder.svg?branch=master)](https://travis-ci.com/DFE-Digital/govuk_design_system_formbuilder)
 [![Maintainability](https://api.codeclimate.com/v1/badges/fde73b5dc9476197281b/maintainability)](https://codeclimate.com/github/DFE-Digital/govuk_design_system_formbuilder/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/fde73b5dc9476197281b/test_coverage)](https://codeclimate.com/github/DFE-Digital/govuk_design_system_formbuilder/test_coverage)
 [![Gem Version](https://badge.fury.io/rb/govuk_design_system_formbuilder.svg)](https://badge.fury.io/rb/govuk_design_system_formbuilder)
-[![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)
+[![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/fde73b5dc9476197281b/test_coverage)](https://codeclimate.com/github/DFE-Digital/govuk_design_system_formbuilder/test_coverage)
+[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=DFE-Digital/govuk_design_system_formbuilder)](https://dependabot.com)
+[![GitHub license](https://img.shields.io/github/license/DFE-Digital/govuk_design_system_formbuilder)](https://github.com/DFE-Digital/govuk_design_system_formbuilder/blob/master/LICENSE)
+[![GOV.UK Design System Version](https://img.shields.io/badge/GOV.UK%20Design%20System-3.9.1-brightgreen)](https://design-system.service.gov.uk)
 
-This gem provides a easy-to-use form builder that generates forms that are
-fully-compliant with version 3.3.0 of the [GOV.UK Design System](https://design-system.service.gov.uk/),
-minimising the amount of markup you need to write.
+This library provides an easy-to-use form builder for the [GOV.UK Design System](https://design-system.service.gov.uk/).
 
-The latest version of this gem that supports GOV.UK Design System version 2 is
-[0.7.10](https://github.com/DFE-Digital/govuk_design_system_formbuilder/releases/tag/v0.7.10).
+It is intended to make creating forms **quick**, **easy** and **familiar** for Ruby on Rails developers.
 
-In addition to the basic markup, the more-advanced functionality of the Design
-System is exposed via the API. Adding [JavaScript-enhanced word count
-checking](https://govuk-form-builder.netlify.com/form-elements/text-area/)
-to text areas or [setting the size and weight of
-labels](https://govuk-form-builder.netlify.com/introduction/labels-hints-and-legends/)
-on text fields requires only a single argument.
+## Documentation 📚
 
-If you're still not sure what a form builder is or how it works, don't worry!
-[This screencast](https://www.youtube.com/watch?v=PhoFZ0qXAlA) should give you
-an idea of what's on offer and [the official guide](https://govuk-form-builder.netlify.com) goes
-into a bit more depth on how everything works 😅
+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
+examples in the guide are generated from the builder itself so it will always
+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, hints, fieldsets and legends
+* Full control of labels, legends, hints, captions and fieldsets
 * No overwriting of Rails' default form helpers
 * Automatic ARIA associations between hints, errors and inputs
 * Most helpers take blocks for arbitrary content
 * Additional params for programmatically adding hints to check box and radio
   button collections
+* Full I18n support
+* Automatic handling of ActiveRecord validation error messages
 * No external dependencies
 * An exhaustive test suite
-* [Extensive documentation](https://www.rubydoc.info/gems/govuk_design_system_formbuilder/GOVUKDesignSystemFormBuilder/Builder)
-* [A full guide](https://govuk-form-builder.netlify.com/)
+* [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
@@ -59,10 +57,11 @@ pre-configured template:
 * [DfE Boilerplate](https://github.com/DFE-Digital/govuk-rails-boilerplate)
 * [MoJ Rails Template](https://github.com/ministryofjustice/moj_rails_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`:
+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
+other templating languages like ERB and [Haml](https://haml.info/) work just as well.
 
 ```slim
 = form_for @some_object, builder: GOVUKDesignSystemFormBuilder::FormBuilder do |f|
@@ -77,7 +76,7 @@ class ApplicationController < ActionController::Base
 end
 ```
 
-Now we can get started! 🎉
+Now we can get started!
 
 ```slim
 = form_for @person do |f|
@@ -92,16 +91,16 @@ Now we can get started! 🎉
     :name,
     :description,
     label: { text: "Which department do you work for?" },
-    hint_text: "If you don't know ask your manager" }
+    hint: { text: "If you don't know ask your manager" }
 
   = f.govuk_submit 'Away we go!'
 ```
 
-## Developing and running the tests
+## Developing and running the tests 👨🏻‍🏭
 
-The form builder is covered by RSpec, to run all the tests first ensure that
-all of the development and testing prerequisite gems are installed. At the root
-of a freshly-cloned repo run:
+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
+freshly-cloned repo run:
 
 ```sh
 bundle
@@ -110,10 +109,10 @@ bundle
 Now, if everything was successful, run RSpec:
 
 ```sh
-bundle exec rspec -fd
+bundle exec rspec
 ```
 
-## Contributing
+## Contributing 📦
 
 Bug reports and feature requests are most welcome, please raise an issue or
 submit a pull request.
@@ -122,7 +121,13 @@ Currently we're using [GOVUK Lint](https://github.com/alphagov/govuk-lint) to
 ensure code meets the GOV.UK guidelines. Please ensure that any PRs also adhere
 to this standard.
 
-## Thanks
+To help keep the logs clean and tidy, please configure git to use your full name:
+
+```sh
+git config --global user.name "Julius Hibbert"
+```
+
+## Thanks 👩🏽‍⚖️
 
-This project was inspired by [MoJ's GovukElementsFormBuilder](https://github.com/ministryofjustice/govuk_elements_form_builder),
+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/base.rb

@@ -1,28 +1,32 @@
 module GOVUKDesignSystemFormBuilder
+  module PrefixableArray
+    refine Array do
+      def prefix(text, delimiter: '-')
+        map { |item| text + delimiter + item }
+      end
+    end
+  end
+
   class Base
-    delegate :capture, :content_tag, :safe_join, :tag, :raw, :link_to, to: :@builder
+    delegate :content_tag, :safe_join, :tag, :link_to, :capture, to: :@builder
+    delegate :config, to: GOVUKDesignSystemFormBuilder
 
     def initialize(builder, object_name, attribute_name, &block)
-      @builder = builder
-      @object_name = object_name
+      @builder        = builder
+      @object_name    = object_name
       @attribute_name = attribute_name
-      @block_content = capture { block.call } if block_given?
-    end
-
-    def hint_element
-      @hint_element ||= Elements::Hint.new(@builder, @object_name, @attribute_name, @hint_text)
+      @block_content  = capture { block.call } if block_given?
     end
 
-    def error_element
-      @error_element ||= Elements::ErrorMessage.new(@builder, @object_name, @attribute_name)
+    # objects that implement #to_s can be passed directly into #safe_join
+    def to_s
+      html || ''
     end
 
-    def label_element
-      @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, **@label)
-    end
+  private
 
-    def supplemental_content
-      @supplemental_content ||= Containers::Supplemental.new(@builder, @object_name, @attribute_name, @block_content)
+    def brand(override = nil)
+      override || config.brand
     end
 
     # returns the id value used for the input
@@ -46,45 +50,16 @@ module GOVUKDesignSystemFormBuilder
       end
     end
 
-    def hint_id
-      return nil unless @hint_text.present?
-
-      build_id('hint')
-    end
-
-    def error_id
-      return nil unless has_errors?
-
-      build_id('error')
-    end
-
-    def conditional_id
-      build_id('conditional')
-    end
-
-    def supplemental_id
-      return nil unless @block_content.present?
-
-      build_id('supplemental')
-    end
-
     def has_errors?
-      @builder.object.errors.any? &&
+      @builder.object.respond_to?(:errors) &&
+        @builder.object.errors.any? &&
         @builder.object.errors.messages.dig(@attribute_name).present?
     end
 
-    def wrap_conditional(block)
-      content_tag('div', class: conditional_classes, id: conditional_id) do
-        capture { block.call }
-      end
-    end
-
     def described_by(*ids)
       ids.flatten.compact.join(' ').presence
     end
 
-  private
-
     # Builds the values used for HTML id attributes throughout the builder
     #
     # @param id_type [String] a description of the id's type, eg +hint+, +error+