katalyst-govuk-formbuilder 1.19.0 → 1.20.0

data/lib/katalyst/govuk/form_builder/elements/image.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module GOVUK
+    module FormBuilder
+      module Elements
+        class Image < GOVUKDesignSystemFormBuilder::Base
+          include ActionDispatch::Routing::RouteSet::MountedHelpers
+
+          include GOVUKDesignSystemFormBuilder::Traits::Error
+          include GOVUKDesignSystemFormBuilder::Traits::Hint
+          include GOVUKDesignSystemFormBuilder::Traits::Label
+          include GOVUKDesignSystemFormBuilder::Traits::Supplemental
+          include GOVUKDesignSystemFormBuilder::Traits::HTMLAttributes
+          include GOVUKDesignSystemFormBuilder::Traits::HTMLClasses
+
+          include FormBuilder::Traits::File
+
+          def initialize(builder, object_name, attribute_name, hint:, label:, caption:, form_group:, mime_types:,
+                         **kwargs, &)
+            super(builder, object_name, attribute_name, &)
+
+            @mime_types      = mime_types
+            @label           = label
+            @caption         = caption
+            @hint            = hint
+            @html_attributes = kwargs.merge(file_input_options)
+            @form_group      = form_group
+          end
+
+          def html
+            GOVUKDesignSystemFormBuilder::Containers::FormGroup.new(
+              *bound,
+              **default_form_group_options(**@form_group),
+            ).html do
+              safe_join([label_element, preview, hint_element, error_element, file, destroy_element,
+                         supplemental_content])
+            end
+          end
+
+          def preview
+            options = {}
+            add_option(options, :data, "#{stimulus_controller}_target", "preview")
+            add_option(options, :class, "preview-image")
+            options[:hidden] = "" unless preview?
+
+            tag.div(**options) do
+              tag.img(src: preview_url, class: "image-thumbnail") + destroy_element_trigger
+            end
+          end
+
+          private
+
+          def stimulus_controller
+            "govuk-image-field"
+          end
+
+          def form_group_class
+            "govuk-image-field"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/katalyst/govuk/{formbuilder → form_builder}/elements/label.rb

@@ -4,7 +4,7 @@ require "govuk_design_system_formbuilder"
 
 module Katalyst
   module GOVUK
-    module Formbuilder
+    module FormBuilder
       module Elements
         # Extend Elements::Label to add support for human_attribute_name as a fallback
         module Label

data/lib/katalyst/govuk/{formbuilder → form_builder}/elements/legend.rb

@@ -4,7 +4,7 @@ require "govuk_design_system_formbuilder"
 
 module Katalyst
   module GOVUK
-    module Formbuilder
+    module FormBuilder
       module Elements
         # Extend Elements::Legend to add support for human_attribute_name as a fallback
         module Legend

data/lib/katalyst/govuk/{formbuilder → form_builder}/elements/rich_text_area.rb

@@ -4,7 +4,7 @@ require "govuk_design_system_formbuilder"
 
 module Katalyst
   module GOVUK
-    module Formbuilder
+    module FormBuilder
       module Elements
         class RichTextArea < GOVUKDesignSystemFormBuilder::Base
           using GOVUKDesignSystemFormBuilder::PrefixableArray

data/lib/katalyst/govuk/{formbuilder → form_builder}/engine.rb

@@ -6,15 +6,18 @@ require "rails/engine"
 
 module Katalyst
   module GOVUK
-    module Formbuilder
+    module FormBuilder
       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.autoload", before: :setup_once_autoloader do
+          Rails.autoloaders.once.ignore File.expand_path(root.join("lib/katalyst-govuk-formbuilder.rb"))
+        end
+
         initializer "katalyst-govuk-formbuilder.assets" do
           config.after_initialize do |app|
             if app.config.respond_to?(:assets)
@@ -25,7 +28,7 @@ module Katalyst
         end
 
         initializer "katalyst-govuk-formbuilder.extensions" do
-          GOVUKDesignSystemFormBuilder::Builder.include(Formbuilder::Extensions)
+          GOVUKDesignSystemFormBuilder::Builder.include(FormBuilder::Extensions)
         end
 
         initializer "katalyst-govuk-formbuilder.importmap", before: "importmap" do |app|

data/lib/katalyst/govuk/{formbuilder → form_builder}/extensions.rb

@@ -4,11 +4,12 @@ require "govuk_design_system_formbuilder"
 
 module Katalyst
   module GOVUK
-    module Formbuilder
+    module FormBuilder
       module Extensions
         extend ActiveSupport::Concern
 
         included do
+          GOVUKDesignSystemFormBuilder.include(Config)
           GOVUKDesignSystemFormBuilder::Builder.include(Builder)
           GOVUKDesignSystemFormBuilder::Elements::Label.include(Elements::Label)
           GOVUKDesignSystemFormBuilder::Elements::Legend.include(Elements::Legend)

data/lib/katalyst/govuk/{formbuilder → form_builder}/frontend.rb

@@ -2,7 +2,7 @@
 
 module Katalyst
   module GOVUK
-    module Formbuilder
+    module FormBuilder
       module Frontend
         # rubocop:disable Rails/OutputSafety
         def govuk_formbuilder_init

data/lib/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, supplemental_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/lib/katalyst/govuk/{formbuilder → form_builder}/traits/label.rb

@@ -4,7 +4,7 @@ require "govuk_design_system_formbuilder"
 
 module Katalyst
   module GOVUK
-    module Formbuilder
+    module FormBuilder
       module Traits
         # Extend GovukDesignSystemFormBuilder::Traits::Label set the default size to small for non-nested labels.
         module Label

data/lib/katalyst/govuk/form_builder.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/rails"
+
+module Katalyst
+  module GOVUK
+    module FormBuilder
+    end
+  end
+end
+
+require "katalyst/govuk/form_builder/engine"

data/lib/katalyst/govuk/formbuilder.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
 
-require "active_support"
+require "katalyst-govuk-formbuilder"
 
+# Backwards compatibility for Koi 4
 module Katalyst
   module GOVUK
-    module Formbuilder
-      extend ActiveSupport::Autoload
-    end
+    Formbuilder = FormBuilder
   end
 end
-
-require "katalyst/govuk/formbuilder/engine"

data/lib/katalyst-govuk-formbuilder.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "katalyst/govuk/form_builder"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-govuk-formbuilder
 version: !ruby/object:Gem::Version
-  version: 1.19.0
+  version: 1.20.0
 platform: ruby
 authors:
 - Katalyst Interactive
@@ -35,22 +35,29 @@ files:
 - app/assets/builds/katalyst/govuk/formbuilder.css
 - app/assets/builds/katalyst/govuk/formbuilder.js
 - app/assets/builds/katalyst/govuk/formbuilder.min.js
+- app/assets/builds/katalyst/govuk/formbuilder.min.js.map
 - app/assets/config/katalyst-govuk-formbuilder.js
 - app/assets/stylesheets/katalyst/govuk/components/combobox/_index.scss
 - app/assets/stylesheets/katalyst/govuk/components/richtextarea/_index.scss
 - app/assets/stylesheets/katalyst/govuk/formbuilder.scss
 - config/importmap.rb
+- lib/katalyst-govuk-formbuilder.rb
+- lib/katalyst/govuk/form_builder.rb
+- lib/katalyst/govuk/form_builder/builder.rb
+- lib/katalyst/govuk/form_builder/config.rb
+- lib/katalyst/govuk/form_builder/containers/fieldset_context.rb
+- lib/katalyst/govuk/form_builder/elements/combobox.rb
+- lib/katalyst/govuk/form_builder/elements/document.rb
+- lib/katalyst/govuk/form_builder/elements/image.rb
+- lib/katalyst/govuk/form_builder/elements/label.rb
+- lib/katalyst/govuk/form_builder/elements/legend.rb
+- lib/katalyst/govuk/form_builder/elements/rich_text_area.rb
+- lib/katalyst/govuk/form_builder/engine.rb
+- lib/katalyst/govuk/form_builder/extensions.rb
+- lib/katalyst/govuk/form_builder/frontend.rb
+- lib/katalyst/govuk/form_builder/traits/file.rb
+- lib/katalyst/govuk/form_builder/traits/label.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/combobox.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
@@ -196,6 +203,7 @@ homepage: https://github.com/katalyst/govuk-formbuilder
 licenses:
 - MIT
 metadata:
+  changelog_uri: https://github.com/katalyst/govuk-formbuilder/releases
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: