katalyst-govuk-formbuilder 1.30.0 → 2.0.0

data/app/helpers/katalyst/govuk/form_builder/traits/file.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require "govuk_design_system_formbuilder"
+
+module Katalyst
+  module GOVUK
+    module FormBuilder
+      module Traits
+        module File
+          extend ActiveSupport::Concern
+
+          protected
+
+          def stimulus_controller_actions
+            <<~ACTIONS.gsub(/\s+/, " ").freeze
+              dragover->#{stimulus_controller}#dragover
+              dragenter->#{stimulus_controller}#dragenter
+              dragleave->#{stimulus_controller}#dragleave
+              drop->#{stimulus_controller}#drop
+            ACTIONS
+          end
+
+          def file
+            previous_input = @builder.hidden_field(@attribute_name, id: nil, value: value.signed_id) if attached?
+            file_input     = @builder.file_field(@attribute_name, attributes(@html_attributes))
+
+            safe_join([previous_input, file_input])
+          end
+
+          def destroy_element
+            return if @html_attributes[:optional].blank?
+
+            @builder.fields_for(:"#{@attribute_name}_attachment") do |form|
+              form.hidden_field :_destroy, value: false, data: { "#{stimulus_controller}_target" => "destroy" }
+            end
+          end
+
+          def destroy_element_trigger
+            return if @html_attributes[:optional].blank?
+
+            content_tag(:button, "", class: "file-destroy", data: { action: "#{stimulus_controller}#setDestroy" })
+          end
+
+          def preview_url
+            preview? ? main_app.polymorphic_path(value, only_path: true) : ""
+          end
+
+          def preview?
+            attached?
+          end
+
+          def attached?
+            value&.attached? && value.blob.persisted?
+          end
+
+          def value
+            @builder.object.send(@attribute_name)
+          end
+
+          def file_input_options
+            default_file_input_options = options
+
+            add_option(default_file_input_options, :accept, @mime_types.join(","))
+            add_option(default_file_input_options, :data, :action, "change->#{stimulus_controller}#onUpload")
+
+            default_file_input_options
+          end
+
+          def options
+            {
+              id:    field_id(link_errors: true),
+              class: classes,
+              aria:  { describedby: combine_references(hint_id, error_id) },
+            }
+          end
+
+          using GOVUKDesignSystemFormBuilder::PrefixableArray
+
+          def classes
+            build_classes(%(file-upload), %(file-upload--error) => has_errors?).prefix(brand)
+          end
+
+          def default_form_group_options(**form_group_options)
+            add_option(form_group_options, :class, "govuk-form-group #{form_group_class}")
+            add_option(form_group_options, :data, :controller, stimulus_controller)
+            add_option(form_group_options, :data, :action, stimulus_controller_actions)
+            add_option(form_group_options, :data, :"#{stimulus_controller}_mime_types_value",
+                       @mime_types.to_json)
+
+            form_group_options
+          end
+
+          def add_option(options, key, *path)
+            if path.length > 1
+              add_option(options[key] ||= {}, *path)
+            else
+              options[key] = [options[key], *path].compact.join(" ")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/helpers/katalyst/govuk/form_builder/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.any? ? {} : { 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/config/importmap.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 pin "@katalyst/govuk-formbuilder", to: "katalyst/govuk/formbuilder.js"
+pin "@rails/activestorage", to: "activestorage.esm.js"
 
 pin_all_from Katalyst::GOVUK::FormBuilder::Engine.root.join("app/assets/javascripts"),
              # preload in tests so that we don't start clicking before controllers load

data/config/locales/en.yml

@@ -0,0 +1,16 @@
+# The attachment field's string defaults — the canonical vocabulary.
+# The JS bundle carries a mirror of this table as its offline defaults
+# (app/javascript/katalyst/govuk/config.js); keep the two in step.
+# Strings that differ from these defaults — a translation, or a host
+# app's override in any locale, en included — render onto the field's
+# data-i18n.* attributes, where the JS enhancement reads them.
+en:
+  katalyst:
+    govuk:
+      attachment:
+        upload_succeeded: "Uploaded successfully"
+        upload_failed: "Upload failed — try again"
+        retry_button: "Try again"
+        file_removed: "%{filename} removed"
+        remove_button: "Remove %{filename}"
+        remove_button_content: "Remove"

data/lib/katalyst/govuk/form_builder/config.rb

@@ -26,6 +26,26 @@ module Katalyst
           end
 
           config.image_mime_types = %w[image/png image/gif image/jpeg image/webp].freeze
+
+          def attachment_preview_representation
+            config.attachment_preview_representation
+          end
+
+          def attachment_preview_representation=(value)
+            config.attachment_preview_representation = value
+          end
+
+          config.attachment_preview_representation = { resize_to_fill: [256, 256] }.freeze
+
+          def use_legacy_file_fields?
+            config.use_legacy_file_fields
+          end
+
+          def use_legacy_file_fields=(value)
+            config.use_legacy_file_fields = value
+          end
+
+          config.use_legacy_file_fields = false
         end
       end
     end

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

@@ -43,7 +43,7 @@ module Katalyst
         initializer "katalyst-govuk-formbuilder.importmap", before: "importmap" do |app|
           if app.config.respond_to?(:importmap)
             app.config.importmap.paths << root.join("config/importmap.rb")
-            app.config.importmap.cache_sweepers << root.join("app/assets/javascripts")
+            app.config.importmap.cache_sweepers << root.join("app/assets/builds")
           end
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-govuk-formbuilder
 version: !ruby/object:Gem::Version
-  version: 1.30.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Katalyst Interactive
@@ -9,6 +9,20 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activestorage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.0
 - !ruby/object:Gem::Dependency
   name: govuk_design_system_formbuilder
   requirement: !ruby/object:Gem::Requirement
@@ -38,13 +52,29 @@ files:
 - app/assets/builds/katalyst/govuk/formbuilder.min.js.map
 - app/assets/config/katalyst-govuk-formbuilder.js
 - app/assets/stylesheets/katalyst/govuk/components/_index.scss
+- app/assets/stylesheets/katalyst/govuk/components/attachment/_index.scss
+- app/assets/stylesheets/katalyst/govuk/components/attachment/_mixin.scss
 - app/assets/stylesheets/katalyst/govuk/components/combobox/_index.scss
 - app/assets/stylesheets/katalyst/govuk/components/combobox/_mixin.scss
 - app/assets/stylesheets/katalyst/govuk/components/richtextarea/_index.scss
 - app/assets/stylesheets/katalyst/govuk/components/richtextarea/_mixin.scss
 - app/assets/stylesheets/katalyst/govuk/formbuilder.scss
+- app/helpers/katalyst/govuk/form_builder/builder.rb
+- app/helpers/katalyst/govuk/form_builder/containers/fieldset_context.rb
+- app/helpers/katalyst/govuk/form_builder/elements/attachment.rb
+- app/helpers/katalyst/govuk/form_builder/elements/combobox.rb
+- app/helpers/katalyst/govuk/form_builder/elements/document.rb
+- app/helpers/katalyst/govuk/form_builder/elements/image.rb
+- app/helpers/katalyst/govuk/form_builder/elements/label.rb
+- app/helpers/katalyst/govuk/form_builder/elements/legend.rb
+- app/helpers/katalyst/govuk/form_builder/elements/rich_textarea.rb
+- app/helpers/katalyst/govuk/form_builder/frontend.rb
+- app/helpers/katalyst/govuk/form_builder/traits/attachment.rb
+- app/helpers/katalyst/govuk/form_builder/traits/file.rb
+- app/helpers/katalyst/govuk/form_builder/traits/label.rb
 - config/ci.rb
 - config/importmap.rb
+- config/locales/en.yml
 - lib/katalyst-govuk-formbuilder.rb
 - lib/katalyst/govuk/form_builder.rb
 - lib/katalyst/govuk/form_builder/config.rb