katalyst-govuk-formbuilder 1.9.4 → 1.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1653be0dcf19647a3372e5fe35ea0d6dbf6241c13fc057f68f09ab129568c43f
-  data.tar.gz: da4fbf9bce745fcb6f2c51fe5346b7f1e03526525a907d3951ea7c845ce3ce7e
+  metadata.gz: 2e03dce9b294fea3750ea7ec82957580fcb3cf6d28df45e0780dfda313ca7a69
+  data.tar.gz: 48faf010853d3cd17b1d49260e78f125d42cbd48eb43eb8206305df786fa6f34
 SHA512:
-  metadata.gz: 15555c7d0a9bcb55a5f35a5768be15e365e7fbf0f8e2bffb9ab1217f0bd8b3335aed9a1731544b29f750b5c8db7d6324fb26e3522f129edfb3d57fe116fe1c47
-  data.tar.gz: 4dee34d0bb82357ebe588593e42af4aab472afe2319aea41d6681d4380048317dc0ba04a86238852e86e5e2f0f7b17ec0f772cfb59302c5580f0778c8bf08fcc
+  metadata.gz: 3cd035acfd8a3ff0c55fe5f4754a7615f9f1db578dc0214dfc7f15df2547efc862e0898e4c5e4637f094250ea62a662192483031f6f9879cf4fe2b890cd7c257
+  data.tar.gz: 5cd513d0144aab0691f905245f612b0c93d8b053fde24448d74a72806a986fd2ec8a4ba73a9f37b1a40e766bcf487c67579d237a8c2442dd18f7d74daf80e095

data/README.md

@@ -23,7 +23,7 @@ Or install it yourself as:
 
 Add the stylesheet to your default layout:
 
-```erbruby
+```erb
 <%= stylesheet_link_tag "katalyst/govuk/formbuilder" %>
 ```
 
@@ -32,7 +32,7 @@ Some GOVUK components require javascript enhancements
 
 You can use the provided helper to load the formbuilder esm from importmaps and enhance your form:
 
-```erbruby
+```erb
 <%= form_with ... %>
 <%= govuk_formbuilder_init %>
 ```
@@ -49,11 +49,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/kataly
 
 ## Release
 
-Update the version number in `lib/katalyst/govuk/formbuilder/version.rb` and run:
-
-```bash
-bundle exec rake release
-```
+Tag the release version and push to CI.
 
 ## License
 

data/lib/katalyst/govuk/formbuilder/builder.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module GOVUK
+    module Formbuilder
+      module Builder
+        extend ActiveSupport::Concern
+
+        included do
+          # Overwrite GOVUK default to set small to true
+          # @see GOVUKDesignSystemFormBuilder::Builder#govuk_radio_buttons_fieldset
+          def govuk_radio_buttons_fieldset(attribute_name, hint: {}, legend: {}, caption: {}, inline: false,
+                                           small: true, form_group: {}, **kwargs, &block)
+            GOVUKDesignSystemFormBuilder::Containers::RadioButtonsFieldset.new(
+              self, object_name, attribute_name,
+              hint:, legend:, caption:, inline:, small:, form_group:,
+              **kwargs, &block
+            ).html
+          end
+
+          # Overwrite GOVUK default to set small to true
+          # @see GOVUKDesignSystemFormBuilder::Builder#govuk_collection_check_boxes
+          def govuk_collection_check_boxes(attribute_name, collection, value_method, text_method, hint_method = nil,
+                                           hint: {}, legend: {}, caption: {}, small: true, form_group: {},
+                                           include_hidden: config.default_collection_check_boxes_include_hidden,
+                                           **kwargs, &block)
+            GOVUKDesignSystemFormBuilder::Elements::CheckBoxes::Collection.new(
+              self,
+              object_name,
+              attribute_name,
+              collection,
+              value_method:,
+              text_method:,
+              hint_method:,
+              hint:,
+              legend:,
+              caption:,
+              small:,
+              form_group:,
+              include_hidden:,
+              **kwargs,
+              &block
+            ).html
+          end
+
+          # Overwrite GOVUK default to set small to true
+          # @see GOVUKDesignSystemFormBuilder::Builder#govuk_check_boxes_fieldset
+          def govuk_check_boxes_fieldset(attribute_name, legend: {}, caption: {}, hint: {}, small: true, form_group: {},
+                                         multiple: true, **kwargs, &block)
+            GOVUKDesignSystemFormBuilder::Containers::CheckBoxesFieldset.new(
+              self,
+              object_name,
+              attribute_name,
+              hint:,
+              legend:,
+              caption:,
+              small:,
+              form_group:,
+              multiple:,
+              **kwargs,
+              &block
+            ).html
+          end
+        end
+
+        # Generates a check box within a fieldset to be used as a boolean toggle for a single attribute.
+        # The values are 1 (toggled on), and 0 (toggled off).
+        #
+        # @param attribute_name [Symbol] The name of the attribute
+        # @param small [Boolean] controls whether small check boxes are used instead of regular-sized ones
+        # @param hint [Hash,Proc] The content of the hint. No hint will be added if 'text' is left +nil+. When a +Proc+
+        #                         is supplied the hint will be wrapped in a +div+ instead of a +span+
+        # @option hint text [String] the hint text
+        # @option hint kwargs [Hash] additional arguments are applied as attributes to the hint
+        # @param link_errors [Boolean] controls whether this checkbox should be linked to from {#govuk_error_summary}
+        # @option label text [String] the label text
+        # @option label size [String] the size of the label font, can be +xl+, +l+, +m+, +s+ or nil
+        # @option label tag [Symbol,String] the label's wrapper tag, intended to allow labels to act as page headings
+        # @option label hidden [Boolean] control the visibility of the label. Hidden labels will be read by
+        #                                screenreaders
+        # @option label kwargs [Hash] additional arguments are applied as attributes on the +label+ element
+        # @option kwargs [Hash] kwargs additional arguments are applied as attributes to the +input+ element
+        # @param block [Block] any HTML passed in will form the contents of the fieldset
+        # @return [ActiveSupport::SafeBuffer] HTML output
+        #
+        # @example A single check box for terms and conditions
+        #   = f.govuk_check_box_field :terms_agreed,
+        #     link_errors: true,
+        #     label: { text: 'Do you agree with our terms and conditions?' },
+        #     hint: { text: 'You will not be able to proceed unless you do' }
+        #
+        def govuk_check_box_field(attribute_name, value = 1, unchecked_value = 0,
+                                  small: true, hint: {}, label: {}, link_errors: false, **kwargs, &block)
+          govuk_check_boxes_fieldset(attribute_name, legend: nil, multiple: false, small:) do
+            fieldset_context.pop # undo push from fieldset extension, labels should be bold unless already nested
+            checkbox = govuk_check_box(attribute_name, value, unchecked_value,
+                                       hint:,
+                                       label:,
+                                       link_errors:,
+                                       multiple:    false,
+                                       exclusive:   false,
+                                       **kwargs, &block)
+            fieldset_context.push attribute_name # restore push from fieldset
+            checkbox
+          end
+        end
+
+        # Overwrite GOVUK default to set small to true
+        # @see GOVUKDesignSystemFormBuilder::Builder#govuk_collection_radio_buttons
+        def govuk_collection_radio_buttons(attribute_name, collection, value_method, text_method = nil,
+                                           hint_method = nil, hint: {}, legend: {}, caption: {}, inline: false,
+                                           small: true, bold_labels: nil,
+                                           include_hidden: config.default_collection_radio_buttons_include_hidden,
+                                           form_group: {}, **, &)
+          GOVUKDesignSystemFormBuilder::Elements::Radios::Collection.new(
+            self,
+            object_name,
+            attribute_name,
+            collection,
+            value_method:,
+            text_method:,
+            hint_method:,
+            hint:,
+            legend:,
+            caption:,
+            inline:,
+            small:,
+            bold_labels:,
+            form_group:,
+            include_hidden:,
+            **,
+            &
+          ).html
+        end
+
+        # Generates a pair of +trix-toolbar+ and +trix-editor+ elements with a label, optional hint.
+        # Requires action-text to be correctly setup in the application
+        #
+        # @param attribute_name [Symbol] The name of the attribute
+        # @param hint [Hash,Proc] The content of the hint. No hint will be added if 'text' is left +nil+. When a +Proc+
+        #                         is supplied the hint will be wrapped in a +div+ instead of a +span+
+        # @option hint text [String] the hint text
+        # @option hint kwargs [Hash] additional arguments are applied as attributes to the hint
+        # @param label [Hash,Proc] configures or sets the associated label content
+        # @option label text [String] the label text
+        # @option label size [String] the size of the label font, can be +xl+, +l+, +m+, +s+ or nil
+        # @option label tag [Symbol,String] the label's wrapper tag, intended to allow labels to act as page headings
+        # @option label hidden [Boolean] control the visibility of the label. Hidden labels will still be read by screen
+        #   readers
+        # @option label kwargs [Hash] additional arguments are applied as attributes on the +label+ element
+        # @param caption [Hash] configures or sets the caption content which is inserted above the label
+        # @option caption text [String] the caption text
+        # @option caption size [String] the size of the caption, can be +xl+, +l+ or +m+. Defaults to +m+
+        # @option caption kwargs [Hash] additional arguments are applied as attributes on the caption +span+ element
+        # @option kwargs [Hash] kwargs additional arguments are applied as attributes to the +trix-editor+ element.
+        #                       This is picked up and handled by the action-text gem
+        # @param form_group [Hash] configures the form group
+        # @option form_group classes [Array,String] sets the form group's classes
+        # @option form_group kwargs [Hash] additional attributes added to the form group
+        # @param block [Block] arbitrary HTML that will be rendered between the hint and the input
+        # @return [ActiveSupport::SafeBuffer] HTML output
+        #
+        # @example A rich text area with injected content
+        #   = f.govuk_rich_text_area :description,
+        #     label: { text: 'Where did the incident take place?' } do
+        #
+        #     p.govuk-inset-text
+        #       | If you don't know exactly leave this section blank
+        #
+        # @example A rich text area with the label supplied as a proc
+        #   = f.govuk_rich_text_area :instructions,
+        #     label: -> { tag.h3("How do you set it up?") }
+        #
+        # @example A rich text area with a custom direct upload url and a custom stimulus controller
+        #   = f.govuk_rich_text_area :description,
+        #     data: {
+        #             direct_upload_url: direct_uploads_url,
+        #             controller:        "content--editor--trix",
+        #             action:            "trix-initialize->content--editor--trix#trixInitialize",
+        #           }
+        #
+        def govuk_rich_text_area(attribute_name, hint: {}, label: {}, caption: {}, form_group: {}, **, &)
+          Elements::RichTextArea.new(
+            self, object_name, attribute_name,
+            hint:, label:, caption:, form_group:, **, &
+          ).html
+        end
+
+        # Keep track of whether we are inside a fieldset
+        # This allows labels to default to bold ("s") normally but use the default otherwise
+        def fieldset_context
+          @fieldset_context ||= []
+        end
+      end
+    end
+  end
+end

data/lib/katalyst/govuk/formbuilder/containers/fieldset_context.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module GOVUK
+    module Formbuilder
+      module Containers
+        module FieldsetContext
+          def initialize(builder, object_name = nil, attribute_name = nil, &)
+            builder.fieldset_context << attribute_name
+
+            super
+
+            builder.fieldset_context.pop
+          end
+        end
+      end
+    end
+  end
+end

data/lib/katalyst/govuk/formbuilder/elements/label.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "govuk_design_system_formbuilder"
+
+module Katalyst
+  module GOVUK
+    module Formbuilder
+      module Elements
+        # Extend Elements::Label to add support for human_attribute_name as a fallback
+        module Label
+          extend ActiveSupport::Concern
+
+          included do
+            def retrieve_text(option_text, hidden)
+              text = option_text.presence ||
+                localised_text(:label).presence ||
+                human_attribute_name.presence ||
+                @attribute_name.to_s.humanize.capitalize.presence
+
+              if hidden
+                tag.span(text, class: %(#{brand}-visually-hidden))
+              else
+                text
+              end
+            end
+          end
+
+          def human_attribute_name
+            return unless @object_name.present? && @attribute_name.present?
+            return unless @builder.object&.class.respond_to?(:human_attribute_name)
+
+            @builder.object.class.human_attribute_name(@attribute_name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/katalyst/govuk/formbuilder/elements/legend.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "govuk_design_system_formbuilder"
+
+module Katalyst
+  module GOVUK
+    module Formbuilder
+      module Elements
+        # Extend Elements::Legend to add support for human_attribute_name as a fallback
+        module Legend
+          extend ActiveSupport::Concern
+
+          included do
+            def retrieve_text(supplied_text)
+              supplied_text.presence ||
+                localised_text(:legend).presence ||
+                human_attribute_name.presence ||
+                @attribute_name.to_s.humanize.capitalize.presence
+            end
+          end
+
+          def human_attribute_name
+            return unless @object_name.present? && @attribute_name.present?
+            return unless @builder.object&.class.respond_to?(:human_attribute_name)
+
+            @builder.object.class.human_attribute_name(@attribute_name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/katalyst/govuk/formbuilder/elements/rich_text_area.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "govuk_design_system_formbuilder"
+
+module Katalyst
+  module GOVUK
+    module Formbuilder
+      module Elements
+        class RichTextArea < GOVUKDesignSystemFormBuilder::Base
+          using GOVUKDesignSystemFormBuilder::PrefixableArray
+
+          include GOVUKDesignSystemFormBuilder::Traits::Error
+          include GOVUKDesignSystemFormBuilder::Traits::Hint
+          include GOVUKDesignSystemFormBuilder::Traits::Label
+          include GOVUKDesignSystemFormBuilder::Traits::Supplemental
+          include GOVUKDesignSystemFormBuilder::Traits::HTMLAttributes
+          include GOVUKDesignSystemFormBuilder::Traits::HTMLClasses
+
+          def initialize(builder, object_name, attribute_name, hint:, label:, caption:, form_group:, **kwargs, &)
+            super(builder, object_name, attribute_name, &)
+
+            @label           = label
+            @caption         = caption
+            @hint            = hint
+            @form_group      = form_group
+            @html_attributes = kwargs
+          end
+
+          def html
+            GOVUKDesignSystemFormBuilder::Containers::FormGroup.new(*bound, **@form_group).html do
+              safe_join([label_element, supplemental_content, hint_element, error_element, rich_text_area])
+            end
+          end
+
+          private
+
+          def rich_text_area
+            @builder.rich_text_area(@attribute_name, **attributes(@html_attributes))
+          end
+
+          def classes
+            build_classes(%(richtextarea), %(richtextarea--error) => has_errors?).prefix(brand)
+          end
+
+          def options
+            {
+              id:    field_id(link_errors: true),
+              class: classes,
+              aria:  { describedby: combine_references(hint_id, error_id, supplemental_id) },
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/katalyst/govuk/formbuilder/engine.rb

@@ -1,10 +1,19 @@
 # frozen_string_literal: true
 
+require "active_support/inflector"
+require "govuk_design_system_formbuilder"
+
 module Katalyst
   module GOVUK
     module Formbuilder
-      # Engine is responsible for adding assets to load path
       class Engine < ::Rails::Engine
+        ActiveSupport::Inflector.inflections(:en) do |inflect|
+          inflect.acronym "GOVUK"
+        end
+
+        config.eager_load_namespaces << Katalyst::GOVUK::Formbuilder
+        config.paths.add("lib", autoload_once: true)
+
         initializer "katalyst-govuk-formbuilder.assets" do
           config.after_initialize do |app|
             if app.config.respond_to?(:assets)
@@ -14,6 +23,10 @@ module Katalyst
           end
         end
 
+        initializer "katalyst-govuk-formbuilder.extensions" do
+          GOVUKDesignSystemFormBuilder::Builder.include(Formbuilder::Extensions)
+        end
+
         initializer "katalyst-govuk-formbuilder.importmap", before: "importmap" do |app|
           if app.config.respond_to?(:importmap)
             app.config.importmap.paths << root.join("config/importmap.rb")

data/lib/katalyst/govuk/formbuilder/extensions.rb

@@ -6,181 +6,18 @@ module Katalyst
   module GOVUK
     module Formbuilder
       module Extensions
-        module Fieldset
-          def initialize(builder, object_name = nil, attribute_name = nil, &)
-            builder.fieldset_context << attribute_name
-
-            super
-
-            builder.fieldset_context.pop
-          end
-        end
-      end
-    end
-  end
-end
-
-module GOVUKDesignSystemFormBuilder
-  module Builder
-    # Keep track of whether we are inside a fieldset
-    # This allows labels to default to bold ("s") normally but use the default otherwise
-    def fieldset_context
-      @fieldset_context ||= []
-    end
-
-    # Overwrite GOVUK default to set small to true
-    # @see GOVUKDesignSystemFormBuilder::Builder#govuk_collection_radio_buttons
-    def govuk_collection_radio_buttons(attribute_name, collection, value_method, text_method = nil, hint_method = nil,
-                                       hint: {}, legend: {}, caption: {}, inline: false, small: true, bold_labels: nil,
-                                       include_hidden: config.default_collection_radio_buttons_include_hidden,
-                                       form_group: {}, **kwargs, &block)
-      Elements::Radios::Collection.new(
-        self,
-        object_name,
-        attribute_name,
-        collection,
-        value_method:,
-        text_method:,
-        hint_method:,
-        hint:,
-        legend:,
-        caption:,
-        inline:,
-        small:,
-        bold_labels:,
-        form_group:,
-        include_hidden:,
-        **kwargs,
-        &block
-      ).html
-    end
-
-    # Overwrite GOVUK default to set small to true
-    # @see GOVUKDesignSystemFormBuilder::Builder#govuk_radio_buttons_fieldset
-    def govuk_radio_buttons_fieldset(attribute_name, hint: {}, legend: {}, caption: {}, inline: false, small: true,
-                                     form_group: {}, **kwargs, &block)
-      Containers::RadioButtonsFieldset.new(self, object_name, attribute_name,
-                                           hint:, legend:, caption:, inline:, small:, form_group:,
-                                           **kwargs, &block).html
-    end
-
-    # Overwrite GOVUK default to set small to true
-    # @see GOVUKDesignSystemFormBuilder::Builder#govuk_collection_check_boxes
-    def govuk_collection_check_boxes(attribute_name, collection, value_method, text_method, hint_method = nil,
-                                     hint: {}, legend: {}, caption: {}, small: true, form_group: {},
-                                     include_hidden: config.default_collection_check_boxes_include_hidden,
-                                     **kwargs, &block)
-      Elements::CheckBoxes::Collection.new(
-        self,
-        object_name,
-        attribute_name,
-        collection,
-        value_method:,
-        text_method:,
-        hint_method:,
-        hint:,
-        legend:,
-        caption:,
-        small:,
-        form_group:,
-        include_hidden:,
-        **kwargs,
-        &block
-      ).html
-    end
-
-    # Overwrite GOVUK default to set small to true
-    # @see GOVUKDesignSystemFormBuilder::Builder#govuk_check_boxes_fieldset
-    def govuk_check_boxes_fieldset(attribute_name, legend: {}, caption: {}, hint: {}, small: true, form_group: {},
-                                   multiple: true, **kwargs, &block)
-      Containers::CheckBoxesFieldset.new(
-        self,
-        object_name,
-        attribute_name,
-        hint:,
-        legend:,
-        caption:,
-        small:,
-        form_group:,
-        multiple:,
-        **kwargs,
-        &block
-      ).html
-    end
-  end
-
-  # Extend Traits::Label set the default size to small for non-nested labels.
-  module Traits
-    module Label
-      private
-
-      def label_content
-        default = @builder.fieldset_context.count.positive? ? {} : { size: "s" }
-
-        case @label
-        when Hash
-          default.merge(@label)
-        when Proc
-          default.merge(content: @label)
-        else
-          fail(ArgumentError, %(label must be a Proc or Hash))
+        extend ActiveSupport::Concern
+
+        included do
+          GOVUKDesignSystemFormBuilder::Builder.include(Builder)
+          GOVUKDesignSystemFormBuilder::Elements::Label.include(Elements::Label)
+          GOVUKDesignSystemFormBuilder::Elements::Legend.include(Elements::Legend)
+          GOVUKDesignSystemFormBuilder::Traits::Label.include(Traits::Label)
+          GOVUKDesignSystemFormBuilder::Containers::Fieldset.include(Containers::FieldsetContext)
+          GOVUKDesignSystemFormBuilder::Containers::CheckBoxesFieldset.include(Containers::FieldsetContext)
+          GOVUKDesignSystemFormBuilder::Containers::RadioButtonsFieldset.include(Containers::FieldsetContext)
         end
       end
     end
   end
-
-  # Extend Elements::Label to add support for human_attribute_name as a fallback
-  module Elements
-    class Label
-      def retrieve_text(option_text, hidden)
-        text = option_text.presence ||
-          localised_text(:label).presence ||
-          human_attribute_name.presence ||
-          @attribute_name.to_s.humanize.capitalize.presence
-
-        if hidden
-          tag.span(text, class: %(#{brand}-visually-hidden))
-        else
-          text
-        end
-      end
-
-      def human_attribute_name
-        return unless @object_name.present? && @attribute_name.present?
-        return unless @builder.object&.class.respond_to?(:human_attribute_name)
-
-        @builder.object.class.human_attribute_name(@attribute_name)
-      end
-    end
-
-    class Legend
-      def retrieve_text(supplied_text)
-        supplied_text.presence ||
-          localised_text(:legend).presence ||
-          human_attribute_name.presence ||
-          @attribute_name.to_s.humanize.capitalize.presence
-      end
-
-      def human_attribute_name
-        return unless @object_name.present? && @attribute_name.present?
-        return unless @builder.object&.class.respond_to?(:human_attribute_name)
-
-        @builder.object.class.human_attribute_name(@attribute_name)
-      end
-    end
-  end
-
-  module Containers
-    class Fieldset
-      include Katalyst::GOVUK::Formbuilder::Extensions::Fieldset
-    end
-
-    class CheckBoxesFieldset
-      include Katalyst::GOVUK::Formbuilder::Extensions::Fieldset
-    end
-
-    class RadioButtonsFieldset
-      include Katalyst::GOVUK::Formbuilder::Extensions::Fieldset
-    end
-  end
 end

data/lib/katalyst/govuk/formbuilder/traits/label.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "govuk_design_system_formbuilder"
+
+module Katalyst
+  module GOVUK
+    module Formbuilder
+      module Traits
+        # Extend GovukDesignSystemFormBuilder::Traits::Label set the default size to small for non-nested labels.
+        module Label
+          extend ActiveSupport::Concern
+
+          included do
+            private
+
+            def label_content
+              default = @builder.fieldset_context.count.positive? ? {} : { size: "s" }
+
+              case @label
+              when Hash
+                default.merge(@label)
+              when Proc
+                default.merge(content: @label)
+              else
+                fail(ArgumentError, %(label must be a Proc or Hash))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/katalyst/govuk/formbuilder.rb

@@ -1,16 +1,10 @@
 # frozen_string_literal: true
 
-require "govuk_design_system_formbuilder"
-require "govuk_design_system_formbuilder/elements/rich_text_area"
-require "govuk_design_system_formbuilder/elements/check_box_field"
-
-require "katalyst/govuk/formbuilder/engine"
-require "katalyst/govuk/formbuilder/extensions"
-require "katalyst/govuk/formbuilder/frontend"
-
 module Katalyst
   module GOVUK
     module Formbuilder
     end
   end
 end
+
+require "katalyst/govuk/formbuilder/engine"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-govuk-formbuilder
 version: !ruby/object:Gem::Version
-  version: 1.9.4
+  version: 1.10.1
 platform: ruby
 authors:
 - Katalyst Interactive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-26 00:00:00.000000000 Z
+date: 2024-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_design_system_formbuilder
@@ -41,12 +41,16 @@ files:
 - app/assets/stylesheets/katalyst/govuk/components/richtextarea/_richtextarea.scss
 - app/assets/stylesheets/katalyst/govuk/formbuilder.scss
 - config/importmap.rb
-- lib/govuk_design_system_formbuilder/elements/check_box_field.rb
-- lib/govuk_design_system_formbuilder/elements/rich_text_area.rb
 - lib/katalyst/govuk/formbuilder.rb
+- lib/katalyst/govuk/formbuilder/builder.rb
+- lib/katalyst/govuk/formbuilder/containers/fieldset_context.rb
+- lib/katalyst/govuk/formbuilder/elements/label.rb
+- lib/katalyst/govuk/formbuilder/elements/legend.rb
+- lib/katalyst/govuk/formbuilder/elements/rich_text_area.rb
 - lib/katalyst/govuk/formbuilder/engine.rb
 - lib/katalyst/govuk/formbuilder/extensions.rb
 - lib/katalyst/govuk/formbuilder/frontend.rb
+- lib/katalyst/govuk/formbuilder/traits/label.rb
 - node_modules/govuk-frontend/dist/govuk/_base.scss
 - node_modules/govuk-frontend/dist/govuk/all.scss
 - node_modules/govuk-frontend/dist/govuk/components/_all.scss
@@ -198,7 +202,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/govuk_design_system_formbuilder/elements/check_box_field.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-require "govuk_design_system_formbuilder"
-
-module GOVUKDesignSystemFormBuilder
-  module Builder
-    # Generates a check box within a fieldset to be used as a boolean toggle for a single attribute.
-    # The values are 1 (toggled on), and 0 (toggled off).
-    #
-    # @param attribute_name [Symbol] The name of the attribute
-    # @param small [Boolean] controls whether small check boxes are used instead of regular-sized ones
-    # @param hint [Hash,Proc] The content of the hint. No hint will be added if 'text' is left +nil+. When a +Proc+ is
-    #   supplied the hint will be wrapped in a +div+ instead of a +span+
-    # @option hint text [String] the hint text
-    # @option hint kwargs [Hash] additional arguments are applied as attributes to the hint
-    # @param link_errors [Boolean] controls whether this checkbox should be linked to from {#govuk_error_summary}
-    # @option label text [String] the label text
-    # @option label size [String] the size of the label font, can be +xl+, +l+, +m+, +s+ or nil
-    # @option label tag [Symbol,String] the label's wrapper tag, intended to allow labels to act as page headings
-    # @option label hidden [Boolean] control the visibility of the label. Hidden labels will be read by screenreaders
-    # @option label kwargs [Hash] additional arguments are applied as attributes on the +label+ element
-    # @option kwargs [Hash] kwargs additional arguments are applied as attributes to the +input+ element
-    # @param block [Block] any HTML passed in will form the contents of the fieldset
-    # @return [ActiveSupport::SafeBuffer] HTML output
-    #
-    # @example A single check box for terms and conditions
-    #   = f.govuk_check_box_field :terms_agreed,
-    #     link_errors: true,
-    #     label: { text: 'Do you agree with our terms and conditions?' },
-    #     hint: { text: 'You will not be able to proceed unless you do' }
-    #
-    def govuk_check_box_field(attribute_name, value = 1, unchecked_value = 0,
-                              small: true, hint: {}, label: {}, link_errors: false, **kwargs, &block)
-      govuk_check_boxes_fieldset(attribute_name, legend: nil, multiple: false, small:) do
-        fieldset_context.pop # undo push from fieldset extension, labels should be bold unless already nested
-        checkbox = govuk_check_box(attribute_name, value, unchecked_value,
-                                   hint:,
-                                   label:,
-                                   link_errors:,
-                                   multiple:    false,
-                                   exclusive:   false,
-                                   **kwargs, &block)
-        fieldset_context.push attribute_name # restore push from fieldset
-        checkbox
-      end
-    end
-  end
-end

data/lib/govuk_design_system_formbuilder/elements/rich_text_area.rb

@@ -1,107 +0,0 @@
-# frozen_string_literal: true
-
-require "govuk_design_system_formbuilder"
-
-module GOVUKDesignSystemFormBuilder
-  module Elements
-    class RichTextArea < Base
-      using PrefixableArray
-
-      include Traits::Error
-      include Traits::Hint
-      include Traits::Label
-      include Traits::Supplemental
-      include Traits::HTMLAttributes
-      include Traits::HTMLClasses
-
-      def initialize(builder, object_name, attribute_name, hint:, label:, caption:, form_group:, **kwargs, &block)
-        super(builder, object_name, attribute_name, &block)
-
-        @label           = label
-        @caption         = caption
-        @hint            = hint
-        @form_group      = form_group
-        @html_attributes = kwargs
-      end
-
-      def html
-        Containers::FormGroup.new(*bound, **@form_group).html do
-          safe_join([label_element, supplemental_content, hint_element, error_element, rich_text_area])
-        end
-      end
-
-      private
-
-      def rich_text_area
-        @builder.rich_text_area(@attribute_name, **attributes(@html_attributes))
-      end
-
-      def classes
-        build_classes(%(richtextarea), %(richtextarea--error) => has_errors?).prefix(brand)
-      end
-
-      def options
-        {
-          id:    field_id(link_errors: true),
-          class: classes,
-          aria:  { describedby: combine_references(hint_id, error_id, supplemental_id) },
-        }
-      end
-    end
-  end
-end
-
-module GOVUKDesignSystemFormBuilder
-  module Builder
-    # Generates a pair of +trix-toolbar+ and +trix-editor+ elements with a label, optional hint. Requires action-text to
-    # be correctly setup in the application
-    #
-    # @param attribute_name [Symbol] The name of the attribute
-    # @param hint [Hash,Proc] The content of the hint. No hint will be added if 'text' is left +nil+. When a +Proc+ is
-    #   supplied the hint will be wrapped in a +div+ instead of a +span+
-    # @option hint text [String] the hint text
-    # @option hint kwargs [Hash] additional arguments are applied as attributes to the hint
-    # @param label [Hash,Proc] configures or sets the associated label content
-    # @option label text [String] the label text
-    # @option label size [String] the size of the label font, can be +xl+, +l+, +m+, +s+ or nil
-    # @option label tag [Symbol,String] the label's wrapper tag, intended to allow labels to act as page headings
-    # @option label hidden [Boolean] control the visibility of the label. Hidden labels will still be read by screen
-    #   readers
-    # @option label kwargs [Hash] additional arguments are applied as attributes on the +label+ element
-    # @param caption [Hash] configures or sets the caption content which is inserted above the label
-    # @option caption text [String] the caption text
-    # @option caption size [String] the size of the caption, can be +xl+, +l+ or +m+. Defaults to +m+
-    # @option caption kwargs [Hash] additional arguments are applied as attributes on the caption +span+ element
-    # @option kwargs [Hash] kwargs additional arguments are applied as attributes to the +trix-editor+ element. This is
-    #   picked up and handled by the action-text gem
-    # @param form_group [Hash] configures the form group
-    # @option form_group classes [Array,String] sets the form group's classes
-    # @option form_group kwargs [Hash] additional attributes added to the form group
-    # @param block [Block] arbitrary HTML that will be rendered between the hint and the input
-    # @return [ActiveSupport::SafeBuffer] HTML output
-    #
-    # @example A rich text area with injected content
-    #   = f.govuk_rich_text_area :description,
-    #     label: { text: 'Where did the incident take place?' } do
-    #
-    #     p.govuk-inset-text
-    #       | If you don't know exactly leave this section blank
-    #
-    # @example A rich text area with the label supplied as a proc
-    #   = f.govuk_rich_text_area :instructions,
-    #     label: -> { tag.h3("How do you set it up?") }
-    #
-    # @example A rich text area with a custom direct upload url and a custom stimulus controller
-    #   = f.govuk_rich_text_area :description,
-    #     data: {
-    #             direct_upload_url: direct_uploads_url,
-    #             controller:        "content--editor--trix",
-    #             action:            "trix-initialize->content--editor--trix#trixInitialize",
-    #           }
-    #
-    def govuk_rich_text_area(attribute_name, hint: {}, label: {}, caption: {}, form_group: {}, **kwargs, &block)
-      Elements::RichTextArea.new(self, object_name, attribute_name,
-                                 hint:, label:, caption:, form_group:, **kwargs, &block).html
-    end
-  end
-end