katalyst-koi 4.9.4 → 4.10.0

data/lib/koi/form/elements/image.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Koi
+  module Form
+    module Elements
+      class Image < GOVUKDesignSystemFormBuilder::Base
+        include FileElement
+
+        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 preview
+          options = {}
+          add_option(options, :data, "#{stimulus_controller}_target", "preview")
+          add_option(options, :class, "preview-image")
+          add_option(options, :class, "hidden") unless preview?
+
+          tag.div(**options) do
+            tag.img(src: preview_url, class: "image-thumbnail") + destroy_element_trigger
+          end
+        end
+
+        private
+
+        def stimulus_controller
+          "image-field"
+        end
+
+        def form_group_class
+          "govuk-image-field"
+        end
+      end
+    end
+  end
+end

data/lib/koi/form/govuk_extensions.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Koi
+  module Form
+    module GOVUKExtensions
+      # Generates a +div+ element with an +input+ with +type=file+ with a label, optional hint.
+      #
+      # @example A upload field with label as a proc
+      #   = f.govuk_document_field :data, label: -> { tag.h3('Upload your document') }
+      #
+      def govuk_document_field(attribute_name,
+                               label: {},
+                               caption: {},
+                               hint: {},
+                               form_group: {},
+                               mime_types: Koi.config.document_mime_types,
+                               **,
+                               &)
+        Elements::Document.new(
+          self, object_name, attribute_name, label:, caption:, hint:, form_group:, mime_types:, **, &
+        ).html
+      end
+
+      # Generates a +div+ element to preview uploaded images and an +input+ with +type=file+ with a label, optional hint
+      #
+      # @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 +input+ element.
+      # @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] arbitrary HTML that will be rendered between the hint and the input
+      # @return [ActiveSupport::SafeBuffer] HTML output
+      #
+      # @example An image field with injected content
+      #   = f.govuk_image_field :incident_image,
+      #     label: { text: 'Attach a picture of the incident' } do
+      #
+      #     p.govuk-inset-text
+      #       | If you don't know exactly leave this section blank
+      #
+      # @example A image upload field with label as a proc
+      #   = f.govuk_image_field :image, label: -> { tag.h3('Upload your image') }
+      #
+      def govuk_image_field(attribute_name,
+                            label: {},
+                            caption: {},
+                            hint: {},
+                            form_group: {},
+                            mime_types: Koi.config.image_mime_types,
+                            **,
+                            &)
+        Elements::Image.new(
+          self, object_name, attribute_name, label:, caption:, hint:, form_group:, mime_types:, **, &
+        ).html
+      end
+    end
+  end
+end

data/lib/koi/form_builder.rb

@@ -2,71 +2,7 @@
 
 module Koi
   class FormBuilder < ActionView::Helpers::FormBuilder
-    delegate_missing_to :@template
-
     include GOVUKDesignSystemFormBuilder::Builder
-
-    # Generates a submit button for saving admin resources.
-    def admin_save(text = "Save", name: :commit, value: :save, class: "button button--primary", **)
-      button(text, name:, value:, class:, **)
-    end
-
-    # Generates a delete link formatted as a button that will perform a turbo
-    # delete with a confirmation.
-    def admin_delete(text = "Delete", url: nil, confirm: "Are you sure?", data: {}, **)
-      return unless object.persisted?
-
-      link_to(text, url || url_for(action: :destroy),
-              class: "button button--secondary",
-              data:  data.reverse_merge(turbo_method: :delete, turbo_confirm: confirm),
-              **)
-    end
-
-    # Generates an archive link formatted as a button that will perform a turbo
-    # delete with a confirmation.
-    def admin_archive(text = "Archive", **)
-      admin_delete(text, **)
-    end
-
-    # Generates a discard changes link formatted as a text button that navigates
-    # the user back to the previous page.
-    def admin_discard(text = "Discard", url: :back, **)
-      link_to(text, url, class: "button button--text", **)
-    end
-
-    # @api internal
-    # @see GOVUKDesignSystemFormBuilder::Builder#govuk_document_field
-    def govuk_document_field(attribute_name, hint: {}, **, &)
-      if hint.is_a?(Hash)
-        max_size = hint.fetch(:max_size, Koi.config.document_size_limit)
-        hint[:text] ||= t("helpers.hint.default.document", max_size: @template.number_to_human_size(max_size))
-      end
-
-      super
-    end
-
-    # @api internal
-    # @see GOVUKDesignSystemFormBuilder::Builder#govuk_image_field
-    def govuk_image_field(attribute_name, hint: {}, **, &)
-      if hint.is_a?(Hash)
-        max_size = hint.fetch(:max_size, Koi.config.image_size_limit)
-        hint[:text] ||= t("helpers.hint.default.document", max_size: @template.number_to_human_size(max_size))
-      end
-
-      super
-    end
-
-    # Use content editor trix setup by default.
-    #
-    # @api internal
-    # @see GOVUKDesignSystemFormBuilder::Builder#govuk_rich_text_area
-    def govuk_rich_text_area(attribute_name, data: {}, **, &)
-      data = data.reverse_merge(
-        direct_upload_url: @template.katalyst_content.direct_uploads_url,
-        controller:        "content--editor--trix",
-        action:            "trix-initialize->content--editor--trix#trixInitialize",
-      )
-      super
-    end
+    include Koi::Form::Builder
   end
 end

data/lib/koi/menu.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "koi/menu/builder"
-
 module Koi
   module Menu
     mattr_accessor :priority

data/lib/koi/middleware/url_redirect.rb

@@ -1,38 +1,40 @@
 # frozen_string_literal: true
 
 module Koi
-  class UrlRedirect
-    def initialize(app)
-      @app = app
-    end
+  module Middleware
+    class UrlRedirect
+      def initialize(app)
+        @app = app
+      end
 
-    def call(env)
-      status, headers, body = @app.call(env)
+      def call(env)
+        status, headers, body = @app.call(env)
 
-      current_path = env["REQUEST_URI"]
+        current_path = env["REQUEST_URI"]
 
-      if status.to_i == 404 && (redirect = UrlRewrite.active.find_by(from: current_path))
-        request = ActionDispatch::Request.new(env)
+        if status.to_i == 404 && (redirect = UrlRewrite.active.find_by(from: current_path))
+          request = ActionDispatch::Request.new(env)
 
-        # Close the body as we will not use it for a 301 redirect
-        body.close
+          # Close the body as we will not use it for a 301 redirect
+          body.close
 
-        # Return a redirect response
-        [redirect.status_code, { "Location" => new_location(current_path, redirect.to, request) },
-         ["#{redirect.from} moved. The document has moved to #{redirect.to}"]]
-      else
-        # Not a 404 or no redirect found, just send the response as is
-        [status, headers, body]
+          # Return a redirect response
+          [redirect.status_code, { "Location" => new_location(current_path, redirect.to, request) },
+           ["#{redirect.from} moved. The document has moved to #{redirect.to}"]]
+        else
+          # Not a 404 or no redirect found, just send the response as is
+          [status, headers, body]
+        end
       end
-    end
 
-    private
+      private
 
-    def new_location(current_path, new_path, request)
-      if %r{\Ahttps{0,1}://}.match?(new_path)
-        new_path
-      else
-        request.original_url.gsub(current_path, new_path)
+      def new_location(current_path, new_path, request)
+        if %r{\Ahttps{0,1}://}.match?(new_path)
+          new_path
+        else
+          request.original_url.gsub(current_path, new_path)
+        end
       end
     end
   end

data/lib/koi.rb

@@ -1,32 +1,13 @@
 # frozen_string_literal: true
 
-require "importmap-rails"
-require "katalyst/govuk/formbuilder"
-require "govuk_design_system_formbuilder/concerns/file_element"
-require "govuk_design_system_formbuilder/elements/document"
-require "govuk_design_system_formbuilder/elements/image"
-require "katalyst/tables"
-require "pagy"
-require "stimulus-rails"
-require "turbo-rails"
-require "webauthn"
+require "active_support"
+require "active_support/rails"
 
-require "koi/form_builder"
-require "koi/menu"
-require "koi/caching"
-require "koi/collection"
-require "koi/config"
-require "koi/engine"
-require "koi/extensions"
-require "koi/release"
-
-require "katalyst/content"
-require "katalyst/kpop"
-require "katalyst/navigation"
+module Koi
+  extend ActiveSupport::Autoload
 
-require "view_component"
+  autoload :Config
 
-module Koi
   extend self
 
   def config
@@ -37,3 +18,5 @@ module Koi
     yield config
   end
 end
+
+require "koi/engine"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-koi
 version: !ruby/object:Gem::Version
-  version: 4.9.4
+  version: 4.10.0
 platform: ruby
 authors:
 - Katalyst Interactive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-05 00:00:00.000000000 Z
+date: 2024-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -411,11 +411,8 @@ files:
 - app/views/layouts/koi/frame.html.erb
 - app/views/layouts/koi/login.html.erb
 - config/importmap.rb
-- config/initializers/content.rb
 - config/initializers/extensions.rb
 - config/initializers/flipper.rb
-- config/initializers/navigation.rb
-- config/initializers/pagy.rb
 - config/locales/koi.en.yml
 - config/locales/pagy.en.yml
 - config/routes.rb
@@ -445,18 +442,18 @@ files:
 - lib/generators/koi/admin_views/templates/new.html.erb.tt
 - lib/generators/koi/admin_views/templates/show.html.erb.tt
 - lib/generators/koi/helpers/admin_generator_attributes.rb
-- lib/govuk_design_system_formbuilder/concerns/file_element.rb
-- lib/govuk_design_system_formbuilder/elements/document.rb
-- lib/govuk_design_system_formbuilder/elements/image.rb
 - lib/katalyst/koi.rb
 - lib/koi.rb
 - lib/koi/caching.rb
-- lib/koi/collection.rb
 - lib/koi/collection/type/archivable.rb
 - lib/koi/config.rb
 - lib/koi/engine.rb
-- lib/koi/extensions.rb
 - lib/koi/extensions/object_rendering.rb
+- lib/koi/form/builder.rb
+- lib/koi/form/elements/document.rb
+- lib/koi/form/elements/file_element.rb
+- lib/koi/form/elements/image.rb
+- lib/koi/form/govuk_extensions.rb
 - lib/koi/form_builder.rb
 - lib/koi/menu.rb
 - lib/koi/menu/builder.rb

data/config/initializers/content.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-Katalyst::Content.config.base_controller = "Admin::ApplicationController"
-Katalyst::Content.config.errors_component = "Koi::Content::Editor::ErrorsComponent"

data/config/initializers/navigation.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-Katalyst::Navigation.config.base_controller  = "Admin::ApplicationController"
-Katalyst::Navigation.config.errors_component = "Koi::Navigation::Editor::ErrorsComponent"

data/config/initializers/pagy.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-Pagy::I18n.load({ locale: "en", filepath: Koi::Engine.root.join("config/locales/pagy.en.yml") })

data/lib/govuk_design_system_formbuilder/concerns/file_element.rb

@@ -1,122 +0,0 @@
-# frozen_string_literal: true
-
-require "govuk_design_system_formbuilder"
-
-module GOVUKDesignSystemFormBuilder
-  module Elements
-    module FileElement
-      extend ActiveSupport::Concern
-
-      using PrefixableArray
-
-      include Traits::Error
-      include Traits::Hint
-      include Traits::Label
-      include Traits::Supplemental
-      include Traits::HTMLAttributes
-      include Traits::HTMLClasses
-      include ActionDispatch::Routing::RouteSet::MountedHelpers
-
-      def html
-        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
-
-      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 stimulus_controller
-        nil
-      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
-        ""
-      end
-
-      def preview_url
-        preview? ? main_app.url_for(value) : ""
-      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
-
-      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

data/lib/govuk_design_system_formbuilder/elements/document.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-require "govuk_design_system_formbuilder"
-
-module GOVUKDesignSystemFormBuilder
-  module Elements
-    class Document < Base
-      include FileElement
-
-      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 preview
-        options = {}
-        add_option(options, :data, "#{stimulus_controller}_target", "preview")
-        add_option(options, :class, "preview-file")
-        add_option(options, :class, "hidden") unless preview?
-
-        tag.div(**options) do
-          filename = @builder.object.send(@attribute_name).filename.to_s
-          tag.p(filename, class: "preview-filename") + destroy_element_trigger
-        end
-      end
-
-      private
-
-      def stimulus_controller
-        "document-field"
-      end
-
-      def form_group_class
-        "govuk-document-field"
-      end
-    end
-  end
-end
-
-module GOVUKDesignSystemFormBuilder
-  module Builder
-    delegate :config, to: GOVUKDesignSystemFormBuilder
-
-    # Generates a +div+ element with an +input+ with +type=file+ with a label, optional hint.
-    #
-    # @example A upload field with label as a proc
-    #   = f.govuk_document_field :data, label: -> { tag.h3('Upload your document') }
-    #
-    def govuk_document_field(attribute_name,
-                             label: {},
-                             caption: {},
-                             hint: {},
-                             form_group: {},
-                             mime_types: Koi.config.document_mime_types,
-                             **,
-                             &)
-      Elements::Document.new(
-        self, object_name, attribute_name, label:, caption:, hint:, form_group:, mime_types:, **, &
-      ).html
-    end
-  end
-end

data/lib/govuk_design_system_formbuilder/elements/image.rb

@@ -1,99 +0,0 @@
-# frozen_string_literal: true
-
-require "govuk_design_system_formbuilder"
-require "govuk_design_system_formbuilder/elements/document"
-
-module GOVUKDesignSystemFormBuilder
-  module Elements
-    class Image < Base
-      include FileElement
-
-      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 preview
-        options = {}
-        add_option(options, :data, "#{stimulus_controller}_target", "preview")
-        add_option(options, :class, "preview-image")
-        add_option(options, :class, "hidden") unless preview?
-
-        tag.div **options do
-          tag.img(src: preview_url, class: "image-thumbnail") + destroy_element_trigger
-        end
-      end
-
-      private
-
-      def stimulus_controller
-        "image-field"
-      end
-
-      def form_group_class
-        "govuk-image-field"
-      end
-    end
-  end
-end
-
-module GOVUKDesignSystemFormBuilder
-  module Builder
-    delegate :config, to: GOVUKDesignSystemFormBuilder
-
-    # Generates a +div+ element to preview uploaded images and an +input+ with +type=file+ with a label, optional hint.
-    #
-    # @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 +input+ element.
-    # @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 An image field with injected content
-    #   = f.govuk_image_field :incident_image,
-    #     label: { text: 'Attach a picture of the incident' } do
-    #
-    #     p.govuk-inset-text
-    #       | If you don't know exactly leave this section blank
-    #
-    # @example A image upload field with label as a proc
-    #   = f.govuk_image_field :image, label: -> { tag.h3('Upload your image') }
-    #
-    def govuk_image_field(attribute_name,
-                          label: {},
-                          caption: {},
-                          hint: {},
-                          form_group: {},
-                          mime_types: Koi.config.image_mime_types,
-                          **,
-                          &)
-      Elements::Image.new(
-        self, object_name, attribute_name, label:, caption:, hint:, form_group:, mime_types:, **, &
-      ).html
-    end
-  end
-end

data/lib/koi/collection.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require "koi/collection/type/archivable"
-
-module Koi
-  module Collection
-    class << self
-      Katalyst::Tables::Collection::Type.register(:archivable, Koi::Collection::Type::Archivable)
-    end
-  end
-end