katalyst-govuk-formbuilder 1.9.3 → 1.10.0

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.3
+  version: 1.10.0
 platform: ruby
 authors:
 - Katalyst Interactive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-13 00:00:00.000000000 Z
+date: 2024-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_design_system_formbuilder
@@ -33,17 +33,24 @@ extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
+- app/assets/builds/katalyst/govuk/formbuilder.css
+- app/assets/builds/katalyst/govuk/formbuilder.js
+- app/assets/builds/katalyst/govuk/formbuilder.min.js
 - app/assets/config/katalyst-govuk-formbuilder.js
 - app/assets/stylesheets/katalyst/govuk/components/richtextarea/_index.scss
 - 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
@@ -195,14 +202,14 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: Repackaging of UK.GOV forms for Rails 7 asset pipeline

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