katalyst-koi 4.0.0

data/lib/generators/koi/admin_views/admin_views_generator.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "rails/generators/named_base"
+require "rails/generators/resource_helpers"
+
+module Koi
+  class AdminViewsGenerator < Rails::Generators::NamedBase
+    include Rails::Generators::ResourceHelpers
+
+    source_root File.expand_path("templates", __dir__)
+
+    argument :attributes, type: :array, default: [], banner: "field:type field:type"
+
+    def create_root_folder
+      empty_directory File.join("app/views/admin", controller_file_path)
+    end
+
+    def copy_view_files
+      available_views.each do |filename|
+        target = filename.gsub("record", singular_name)
+        template filename, File.join("app/views/admin", controller_file_path, target)
+      end
+    end
+
+    private
+
+    def available_views
+      %w(index.html.erb edit.html.erb show.html.erb new.html.erb _fields.html.erb _record.html+row.erb)
+    end
+
+    def govuk_input_for(attribute)
+      case attribute.type
+      when :string
+        %(<%= form.govuk_text_field :#{attribute.name}, label: { size: "s" } %>)
+      when :integer
+        %(<%= form.govuk_number_field :#{attribute.name}, label: { size: "s" } %>)
+      when :boolean
+        %(<%= form.govuk_check_box_field :#{attribute.name}, small: true, label: { size: "s" } %>)
+      when :date
+        %(<%= form.govuk_date_field :#{attribute.name}, legend: { size: "s" } %>)
+      when :text
+        %(<%= form.govuk_rich_text_area :#{attribute.name}, label: { size: "s" } %>)
+      when :rich_text
+        %(<%= form.govuk_rich_text_area :#{attribute.name}, label: { size: "s" } %>)
+      else
+        ""
+      end
+    end
+
+    def index_attributes
+      attributes.select { |attribute| attribute.type == :string }.take(3)
+    end
+  end
+end

data/lib/generators/koi/admin_views/templates/_fields.html.erb.tt

@@ -0,0 +1,3 @@
+<%- attributes.each do |attribute| -%>
+<%= govuk_input_for attribute %>
+<%- end -%>

data/lib/generators/koi/admin_views/templates/_record.html+row.erb.tt

@@ -0,0 +1,10 @@
+<%- index_attributes.each_with_index do |attribute, index| -%>
+<%- if index.zero? -%>
+<%% row.cell :<%= attribute.name %>, header: true do |cell| %>
+  <%%= link_to cell.value, url_for([:admin, <%= singular_name %>]) %>
+<%% end %>
+
+<%- else -%>
+<%% row.cell :<%= attribute.name %> %>
+<%- end -%>
+<%- end -%>

data/lib/generators/koi/admin_views/templates/edit.html.erb.tt

@@ -0,0 +1,12 @@
+<%% content_for :header do %>
+  <%%= render(Koi::Header::EditComponent.new(resource: <%= singular_name %>)) %>
+<%% end %>
+
+<%%= form_with(model: <%= singular_name %>, url: [:admin, <%= singular_name %>], builder: Koi::FormBuilder) do |form| %>
+  <%%= render "fields", form: %>
+
+  <div class="actions">
+    <%%= form.admin_save %>
+    <%%= form.admin_delete %>
+  </div>
+<%% end %>

data/lib/generators/koi/admin_views/templates/index.html.erb.tt

@@ -0,0 +1,7 @@
+<%% content_for :header do %>
+  <%%= render(Koi::Header::IndexComponent.new(model: <%= class_name %>)) %>
+<%% end %>
+
+<%%= koi_index_actions create: true, search: true %>
+
+<%%= render table %>

data/lib/generators/koi/admin_views/templates/new.html.erb.tt

@@ -0,0 +1,11 @@
+<%% content_for :header do %>
+  <%%= render(Koi::Header::NewComponent.new(model: <%= class_name %>)) %>
+<%% end %>
+
+<%%= form_with(model: <%= singular_name %>, url: [:admin, <%= class_name %>], builder: Koi::FormBuilder) do |form| %>
+  <%%= render "fields", form: %>
+
+  <div class="actions">
+    <%%= form.admin_save %>
+  </div>
+<%% end %>

data/lib/generators/koi/admin_views/templates/show.html.erb.tt

@@ -0,0 +1,18 @@
+<%% content_for :header do %>
+  <%%= render(Koi::Header::ShowComponent.new(resource: <%= singular_name %>)) %>
+<%% end %>
+
+<h2>Summary</h2>
+
+<%%= definition_list(class: "item-table") do |builder| %>
+<%- attributes.each do |attribute| -%>
+  <%%= builder.item <%= singular_name %>, :<%= attribute.name %> %>
+<%- end -%>
+<%% end %>
+
+<div class="actions">
+  <%%= button_to "Delete", [:admin, <%= singular_name %>],
+                class:  "button button--secondary",
+                method: :delete,
+                form:   { data: { turbo_confirm: "Are you sure?" } } %>
+</div>

data/lib/govuk_design_system_formbuilder/concerns/file_element.rb

@@ -0,0 +1,115 @@
+# 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
+        @builder.file_field(@attribute_name, attributes(@html_attributes))
+      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?
+        value&.attached? && value&.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 govuk-image-field")
+        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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "govuk_design_system_formbuilder"
+
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    class Document < Base
+      include FileElement
+
+      MIME_TYPES            = %w[
+        image/png image/gif image/jpeg image/webp
+        application/pdf
+      ].freeze
+
+      def initialize(builder, object_name, attribute_name, hint:, label:, caption:, form_group:, **kwargs, &block)
+        super(builder, object_name, attribute_name, &block)
+
+        @mime_types      = MIME_TYPES || kwargs[: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
+
+      def stimulus_controller
+        "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_file_field :data, label: -> { tag.h3('Upload your document') }
+    #
+    def govuk_document_field(attribute_name, label: {}, caption: {}, hint: {}, form_group: {}, **kwargs, &block)
+      Elements::Document.new(self, object_name, attribute_name, label:, caption:, hint:, form_group:, **kwargs,
+                             &block).html
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/elements/image.rb

@@ -0,0 +1,86 @@
+# 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
+
+      MIME_TYPES = %w[image/png image/gif image/jpeg image/webp].freeze
+
+      def initialize(builder, object_name, attribute_name, hint:, label:, caption:, form_group:, **kwargs, &block)
+        super(builder, object_name, attribute_name, &block)
+
+        @mime_types      = kwargs[: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
+
+      def stimulus_controller
+        "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: {}, **kwargs, &block)
+      Elements::Image.new(self, object_name, attribute_name,
+                          label:, caption:, hint:, form_group:, **kwargs, &block).html
+    end
+  end
+end

data/lib/katalyst/koi.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "koi"

data/lib/koi/caching.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/integer/time"
+
+module Koi
+  module Caching
+    # Caching Enabled
+    mattr_accessor :enabled
+    @@enabled = true
+
+    # Cache Expires in
+    mattr_accessor :expires_in
+    @@expires_in = 60.minutes
+  end
+end

data/lib/koi/config.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "active_support/configurable"
+
+module Koi
+  class Config
+    include ActiveSupport::Configurable
+
+    config_accessor(:resource_name_candidates) { %i[title name] }
+  end
+end

data/lib/koi/engine.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "middleware/url_redirect"
+
+module Koi
+  class Engine < ::Rails::Engine
+    engine_name "koi"
+
+    initializer "koi.assets" do |app|
+      app.middleware.use ::ActionDispatch::Static, "#{root}/public"
+      app.middleware.insert_before Rack::Sendfile, Koi::UrlRedirect
+
+      config.after_initialize do |a|
+        if a.config.respond_to?(:assets)
+          a.config.assets.precompile += %w(koi.js)
+        end
+      end
+    end
+
+    initializer "koi.importmap", before: "importmap" do |app|
+      app.config.importmap.paths << root.join("config/importmap.rb")
+      app.config.importmap.cache_sweepers << root.join("app/assets/javascripts")
+    end
+
+    initializer "koi.factories", after: "factory_bot.set_factory_paths" do
+      FactoryBot.definition_file_paths << Engine.root.join("spec/factories") if defined?(FactoryBot)
+    end
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_bot
+      g.factory_bot dir: "spec/factories"
+    end
+
+    config.to_prepare do
+      Katalyst::Navigation::BaseController.include Koi::Controller::IsAdminController
+      Katalyst::Navigation::BaseController.helper Koi::Engine.helpers
+    end
+  end
+end

data/lib/koi/form_builder.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+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", **kwargs)
+      button(text, name:, value:, class:, **kwargs)
+    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: {}, **kwargs)
+      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),
+              **kwargs)
+    end
+
+    # Generates an archive link formatted as a button that will perform a turbo
+    # delete with a confirmation.
+    def admin_archive(text = "Archive", **kwargs)
+      admin_delete(text, **kwargs)
+    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, **kwargs)
+      link_to(text, url, class: "button button--text", **kwargs)
+    end
+
+    # @api internal
+    # @see GOVUKDesignSystemFormBuilder::Builder#govuk_document_field
+    def govuk_document_field(attribute_name, hint: {}, **kwargs, &block)
+      max_size = hint[:max_size] || App::PERMITTED_IMAGE_SIZE
+      super(attribute_name, hint:, **kwargs) do
+        if block
+          concat(yield)
+        else
+          concat(t("helpers.hint.default.document", max_size: @template.number_to_human_size(max_size)))
+        end
+      end
+    end
+
+    # @api internal
+    # @see GOVUKDesignSystemFormBuilder::Builder#govuk_image_field
+    def govuk_image_field(attribute_name, hint: {}, **kwargs, &block)
+      max_size = hint[:max_size] || App::PERMITTED_IMAGE_SIZE
+      super(attribute_name, hint:, **kwargs) do
+        if block
+          concat(yield)
+        else
+          concat(t("helpers.hint.default.image", max_size: @template.number_to_human_size(max_size)))
+        end
+      end
+    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: {}, **kwargs, &block)
+      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(attribute_name, data:, **kwargs, &block)
+    end
+  end
+end

data/lib/koi/menu/builder.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Koi
+  module Menu
+    class Builder
+      def initialize
+        @menu  = Katalyst::Navigation::Menu.new
+        @index = 0
+        @depth = 0
+      end
+
+      def add_items(items)
+        items.each do |k, v|
+          add_item(k, v)
+        end
+      end
+
+      def add_item(title, value)
+        if value.is_a?(Hash)
+          add_menu(title:) do |b|
+            value.each do |k, v|
+              b.add_item(k, v)
+            end
+          end
+        else
+          add_link(title:, url: value)
+        end
+      end
+
+      def add_menu(title:, **options, &)
+        @menu.items.build(type:  Katalyst::Navigation::Heading.name,
+                          title:,
+                          **options,
+                          index: @index,
+                          depth: @depth)
+        @index += 1
+        @depth += 1
+        yield(self)
+        @depth -= 1
+      end
+
+      def add_link(title:, url:, **options)
+        @menu.items.build(type:  Katalyst::Navigation::Link.name,
+                          title:,
+                          url:,
+                          **options,
+                          index: @index,
+                          depth: @depth)
+        @index += 1
+      end
+
+      def add_button(title:, url:, **options)
+        @menu.items.build(type:  Katalyst::Navigation::Button.name,
+                          title:,
+                          url:,
+                          **options,
+                          index: @index,
+                          depth: @depth)
+        @index += 1
+      end
+
+      def render
+        @menu.published_version = @menu.build_draft_version
+        @menu
+      end
+    end
+  end
+end

data/lib/koi/menu.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "koi/menu/builder"
+
+module Koi
+  module Menu
+    mattr_accessor :priority
+    @@priority = {}
+
+    mattr_accessor :modules
+    @@modules = {}
+
+    mattr_accessor :advanced
+    @@advanced = {}
+
+    def admin_menu(context)
+      builder = Builder.new
+      builder.add_menu(title: "Priority") do |b|
+        b.add_link(title: "View site", url: "/", target: :blank)
+        b.add_link(title: "Dashboard", url: context.main_app.admin_dashboard_path)
+        b.add_items(priority)
+        b.add_button(title: "Logout", url: context.main_app.admin_session_path, http_method: :delete)
+      end
+      builder.add_menu(title: "Modules") do |b|
+        b.add_items(modules)
+      end
+      builder.add_menu(title: "Advanced") do |b|
+        b.add_items(advanced)
+
+        if Object.const_defined?("Flipper::UI")
+          b.add_link(title:  "Flipper", url: context.main_app.admin_root_path.concat("/flipper"),
+                     target: :blank)
+        end
+        if Object.const_defined?("Sidekiq::Web")
+          b.add_link(title:  "Sidekiq", url: context.main_app.admin_root_path.concat("sidekiq"),
+                     target: :blank)
+        end
+        b.add_button(title:       "Clear cache", url: context.main_app.admin_cache_path,
+                     http_method: :delete)
+      end
+      builder.render
+    end
+
+    module_function(:admin_menu)
+  end
+end