katalyst-govuk-formbuilder 1.6.0 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fe8b8fab00b8f7b6f76dfda5f890c3e75d272273f3246bf3bbcae40ea33255b
-  data.tar.gz: df00a746df46fba7758343b92b44f8ff9807780371a0c75b2e0e4fd0ca7ad480
+  metadata.gz: d500045cb23ba6da9d6df55b1584249c2b95fadb8e44b0e8ea1fe63f58bbb5a1
+  data.tar.gz: 58dce6296ea70daee510c44a9c8bb403a3aed623cefff5496af5ff08cbe5b25c
 SHA512:
-  metadata.gz: b7a6bde01a0587ffdfbbfcbd88993fc942ab9a00825d0ddb1f85694bc13ddfcc710527410800faec22b739010b69bfee30a31f84e226ea035fccf4b41dcb6a6f
-  data.tar.gz: 253baadde1f08d806eba2ebb734e8e9e620f6d6994852e24d4114398672d8745046adb2aff8bc23a850694c5b863351240c40843bb0f906162992430cda9bb52
+  metadata.gz: 37feec9e8a284f7ef6da32ea78543d6c525538485586a13cf7037f8ce8db0f7853111b1becbf8d26f9aeaacf7a164c243803d6adcbac9a4c6773eb5f717ee057
+  data.tar.gz: 956f29c704ddb6f99fe490142560945dc6f5738ec5af99601a7e83d1d1c963345c9720623007c0ca9c6c39215bb653af63e05b38f21d262b1535ddc2bfcf62de

data/lib/govuk_design_system_formbuilder/elements/check_box_field.rb

@@ -30,15 +30,18 @@ module GOVUKDesignSystemFormBuilder
     #     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: false, hint: {}, label: {}, link_errors: false, **kwargs, &block)
+                              small: true, hint: {}, label: {}, link_errors: false, **kwargs, &block)
       govuk_check_boxes_fieldset(attribute_name, legend: nil, multiple: false, small:) do
-        govuk_check_box(attribute_name, value, unchecked_value,
-                        hint:,
-                        label:,
-                        link_errors:,
-                        multiple:    false,
-                        exclusive:   false,
-                        **kwargs, &block)
+        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

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

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+require "govuk_design_system_formbuilder"
+
+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))
+        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.rb

@@ -5,6 +5,7 @@ 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-govuk-formbuilder
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.1
 platform: ruby
 authors:
 - Katalyst Interactive
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-10 00:00:00.000000000 Z
+date: 2023-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_design_system_formbuilder
@@ -45,6 +45,7 @@ files:
 - lib/govuk_design_system_formbuilder/elements/rich_text_area.rb
 - lib/katalyst/govuk/formbuilder.rb
 - lib/katalyst/govuk/formbuilder/engine.rb
+- lib/katalyst/govuk/formbuilder/extensions.rb
 - lib/katalyst/govuk/formbuilder/frontend.rb
 - vendor/assets/stylesheets/govuk-frontend/dist/govuk/_base.scss
 - vendor/assets/stylesheets/govuk-frontend/dist/govuk/all.scss