katalyst-koi 4.18.1 → 5.0.0.alpha.1

data/lib/generators/koi/helpers/attribute_types.rb

@@ -0,0 +1,218 @@
+# frozen_string_literal: true
+
+module Koi
+  module Helpers
+    module AttributeTypes
+      class Base
+        attr_reader :attribute
+
+        def initialize(attribute)
+          @attribute = attribute
+        end
+
+        def govuk_input
+          nil
+        end
+
+        def index_row
+          nil
+        end
+
+        def show_row
+          nil
+        end
+
+        def collection_attribute
+          nil
+        end
+      end
+
+      class StringType < Base
+        def govuk_input
+          %(<%= form.govuk_text_field :#{attribute.name} %>)
+        end
+
+        def index_row
+          %(<% row.text :#{attribute.name} %>)
+        end
+
+        def show_row
+          %(<% row.text :#{attribute.name} %>)
+        end
+
+        def collection_attribute
+          %(attribute :#{attribute.name}, :string)
+        end
+      end
+
+      class IntegerType < Base
+        def govuk_input
+          %(<%= form.govuk_number_field :#{attribute.name} %>)
+        end
+
+        def index_row
+          %(<% row.number :#{attribute.name} %>)
+        end
+
+        def show_row
+          %(<% row.number :#{attribute.name} %>)
+        end
+
+        def collection_attribute
+          %(attribute :#{attribute.name}, :integer)
+        end
+      end
+
+      class BooleanType < Base
+        def govuk_input
+          %(<%= form.govuk_check_box_field :#{attribute.name} %>)
+        end
+
+        def index_row
+          %(<% row.boolean :#{attribute.name} %>)
+        end
+
+        def show_row
+          %(<% row.boolean :#{attribute.name} %>)
+        end
+
+        def collection_attribute
+          %(attribute :#{attribute.name}, :boolean)
+        end
+      end
+
+      class DateType < Base
+        def govuk_input
+          %(<%= form.govuk_date_field :#{attribute.name} %>)
+        end
+
+        def index_row
+          %(<% row.date :#{attribute.name} %>)
+        end
+
+        def show_row
+          %(<% row.date :#{attribute.name} %>)
+        end
+
+        def collection_attribute
+          %(attribute :#{attribute.name}, :date)
+        end
+      end
+
+      class DatetimeType < Base
+        def index_row
+          %(<% row.datetime :#{attribute.name} %>)
+        end
+
+        def show_row
+          %(<% row.datetime :#{attribute.name} %>)
+        end
+
+        def collection_attribute
+          %(attribute :#{attribute.name}, :date)
+        end
+      end
+
+      class RichTextType < Base
+        def govuk_input
+          %(<%= form.govuk_rich_text_area :#{attribute.name} %>)
+        end
+
+        def show_row
+          %(<% row.rich_text :#{attribute.name} %>)
+        end
+      end
+
+      class AttachmentType < Base
+        def govuk_input
+          %(<%= form.govuk_image_field :#{attribute.name} %>)
+        end
+
+        def show_row
+          %(<% row.attachment :#{attribute.name} %>)
+        end
+      end
+
+      class AssociationType < Base
+        def show_row
+          %(<% row.link :#{attribute.name} %>)
+        end
+      end
+
+      class EnumType < Base
+        def govuk_input
+          %(<%= form.govuk_enum_select :#{attribute.name} %>)
+        end
+
+        def index_row
+          %(<% row.enum :#{attribute.name} %>)
+        end
+
+        def show_row
+          %(<% row.enum :#{attribute.name} %>)
+        end
+
+        def collection_attribute
+          %(attribute :#{attribute.name}, :enum)
+        end
+      end
+
+      class OrdinalType < Base
+      end
+
+      class ArchivedType < Base
+        def show_row
+          %(<% row.boolean :archived %>)
+        end
+      end
+
+      module GeneratedAttributeExtensions
+        refine Rails::Generators::GeneratedAttribute do
+          def attachment?
+            false
+          end
+
+          def association?
+            %i[belongs_to references].include?(type)
+          end
+
+          def enum?
+            false
+          end
+        end
+      end
+
+      TYPES = {
+        string:     StringType,
+        integer:    IntegerType,
+        boolean:    BooleanType,
+        date:       DateType,
+        datetime:   DatetimeType,
+        rich_text:  RichTextType,
+        text:       StringType,
+        attachment: AttachmentType,
+        enum:       EnumType,
+      }.freeze
+
+      using GeneratedAttributeExtensions
+
+      def for(attribute)
+        if attribute.association?
+          AssociationType.new(attribute)
+        elsif attribute.attachment?
+          AttachmentType.new(attribute)
+        elsif attribute.enum?
+          EnumType.new(attribute)
+        elsif attribute.name == "ordinal"
+          OrdinalType.new(attribute)
+        elsif attribute.name == "archived_at"
+          ArchivedType.new(attribute)
+        else
+          TYPES.fetch(attribute.type, StringType).new(attribute)
+        end
+      end
+
+      module_function :for
+    end
+  end
+end

data/lib/generators/koi/helpers/resource_helpers.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require_relative "attribute_types"
+
+module Koi
+  module Helpers
+    module ResourceHelpers
+      extend ActiveSupport::Concern
+
+      included do
+        include Rails::Generators::ResourceHelpers
+
+        private
+
+        def assign_controller_names!(name)
+          super
+          @controller_class_path = ["admin", *@controller_class_path]
+        end
+
+        def class_name
+          candidate = (class_path + [file_name]).map!(&:camelize).join("::")
+          if class_path_overlap.any?
+            "::#{candidate}"
+          else
+            candidate
+          end
+        end
+
+        def singular_route_name
+          parts = controller_class_path
+
+          # Gradually remove suffix parts from the prefix if they appear at the beginning of singular_table_name
+          (0..parts.count).detect do |n|
+            trial = parts.drop(n).join("_")
+            return "#{parts.take(n).join('_')}_#{singular_table_name}" if singular_table_name.start_with?(trial)
+          end
+        end
+
+        def plural_route_name
+          parts = controller_class_path
+
+          # Gradually remove suffix parts from the prefix if they appear at the beginning of plural_table_name
+          (0..parts.count).detect do |n|
+            trial = parts.drop(n).join("_")
+            return "#{parts.take(n).join('_')}_#{plural_table_name}" if plural_table_name.start_with?(trial)
+          end
+        end
+      end
+
+      private
+
+      def archivable?
+        model_class&.included_modules&.include?(Koi::Model::Archivable)
+      end
+
+      def orderable?
+        attributes_names.include?("ordinal")
+      end
+
+      def paginate?
+        !orderable?
+      end
+
+      def selectable?
+        archivable?
+      end
+
+      def sortable?
+        default_sort_attribute.present?
+      end
+
+      def query?
+        true
+      end
+
+      def admin_index_helper(type: :path)
+        "#{plural_route_name}_#{type}"
+      end
+
+      def archive_admin_helper(type: :path)
+        "archive_#{plural_route_name}_#{type}"
+      end
+
+      def archived_admin_helper(type: :path)
+        "archived_#{plural_route_name}_#{type}"
+      end
+
+      def admin_show_helper(identifier = singular_name, type: :path)
+        "#{singular_route_name}_#{type}(#{identifier})"
+      end
+
+      def edit_admin_helper(identifier = singular_name, type: :path)
+        "edit_#{admin_show_helper(identifier, type:)}"
+      end
+
+      def new_admin_helper(type: :path)
+        "new_#{singular_route_name}_#{type}"
+      end
+
+      def order_admin_helper(type: :path)
+        "order_#{plural_route_name}_#{type}"
+      end
+
+      def restore_admin_helper(type: :path)
+        "restore_#{plural_route_name}_#{type}"
+      end
+
+      def class_path_overlap(controller = controller_class_path, model = class_path)
+        return [] unless controller.present? && model.present?
+
+        limit = [controller.size, model.size].min
+
+        (1..limit).reverse_each do |size|
+          return model.slice(0...size) if controller.slice(size - 1..-1) == model.slice(0...size)
+        end
+
+        []
+      end
+    end
+  end
+end

data/lib/generators/koi/{active_record/active_record_generator.rb → model/model_generator.rb}

@@ -3,7 +3,7 @@
 require "rails/generators/active_record/model/model_generator"
 
 module Koi
-  class ActiveRecordGenerator < ActiveRecord::Generators::ModelGenerator
+  class ModelGenerator < ActiveRecord::Generators::ModelGenerator
     source_root ActiveRecord::Generators::ModelGenerator.source_root
 
     def admin_search

data/lib/koi/config.rb

@@ -9,9 +9,11 @@ module Koi
 
     config_accessor(:admin_name) { "Koi" }
 
+    config_accessor(:authenticate_local_admins) { Rails.env.development? }
+
     config_accessor(:resource_name_candidates) { %i[title name] }
 
-    config_accessor(:admin_stylesheet) { "koi/admin" }
+    config_accessor(:admin_stylesheet) { "admin" }
 
     config_accessor(:document_mime_types) do
       %w[image/png image/gif image/jpeg image/webp application/pdf audio/*].freeze

data/lib/koi/engine.rb

@@ -3,7 +3,6 @@
 require "importmap-rails"
 require "katalyst/content"
 require "katalyst/govuk/formbuilder"
-require "katalyst/kpop"
 require "katalyst/navigation"
 require "katalyst/tables"
 require "pagy"
@@ -38,14 +37,6 @@ module Koi
       Katalyst::Content.config.errors_component = "Koi::Content::Editor::ErrorsComponent"
     end
 
-    # Koi (& katalyst gems) generate css assets in build that are useful for non-sass consumers, but we don't
-    # want them getting picked up preferentially by dartsass over their similarly named scss counterparts.
-    initializer "koi.dartsass" do |app|
-      app.config.after_initialize do
-        ::Dartsass::Runner.include(Koi::Extensions::Dartsass) if defined?(::Dartsass::Runner)
-      end
-    end
-
     initializer "koi.factories", after: "factory_bot.set_factory_paths" do
       FactoryBot.definition_file_paths << root.join("spec/factories") if defined?(FactoryBot)
     end

data/lib/koi/form/builder.rb

@@ -10,7 +10,7 @@ module Koi
       end
 
       # Generates a submit button for saving admin resources.
-      def admin_save(text = "Save", name: :commit, value: :save, class: "button button--primary", **)
+      def admin_save(text = "Save", name: :commit, value: :save, class: "button", **)
         button(text, name:, value:, class:, **)
       end
 
@@ -20,8 +20,8 @@ module Koi
         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),
+                class: "button",
+                data:  data.reverse_merge(turbo_method: :delete, turbo_confirm: confirm, ghost_button: ""),
                 **)
       end
 
@@ -34,7 +34,7 @@ module Koi
       # 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", **)
+        link_to(text, url, class: "button", data: { text_button: "" }, **)
       end
 
       # @api internal

data/lib/koi/form/content.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Koi
+  module Form
+    module Content
+      extend ActiveSupport::Concern
+
+      def content_heading_fieldset
+        govuk_fieldset(legend: { text: "Heading", size: "m" }) do
+          concat(content_heading_field(label: nil))
+          concat(content_heading_style_field)
+        end
+      end
+
+      def content_heading_field(args = {})
+        govuk_text_field(:heading,
+                         **{ label: { text: "Heading", size: "s" } }.deep_merge(args))
+      end
+
+      def content_heading_style_field(args = {})
+        govuk_collection_radio_buttons(:heading_style,
+                                       Katalyst::Content.config.heading_styles,
+                                       :itself,
+                                       :itself,
+                                       **{ small: true, legend: { text: "Style", size: "s" } }.deep_merge(args))
+      end
+
+      def content_url_field(args = {})
+        govuk_text_field(:url,
+                         **{ label: { text: "URL", size: "s" } }.deep_merge(args))
+      end
+
+      def content_http_method_field(methods, args = {})
+        govuk_select(:http_method, methods,
+                     **{ label: { text: "HTTP method", size: "s" } }.deep_merge(args))
+      end
+
+      def content_target_field(targets, args = {})
+        govuk_select(:target, targets,
+                     **{ label: { text: "HTTP target", size: "s" } }.deep_merge(args))
+      end
+
+      def content_theme_field(args = {})
+        govuk_select(:theme, Katalyst::Content.config.themes,
+                     **{ label: { size: "s" }, options: { include_blank: true } }.deep_merge(args))
+      end
+      alias_method :content_background_field, :content_theme_field
+
+      def content_visible_field(args = {})
+        govuk_check_box_field(:visible,
+                              **{ label: { text: "Visible? ", size: "s" }, small: true }.deep_merge(args))
+      end
+    end
+  end
+end

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

@@ -24,7 +24,7 @@ module Koi
           options = {}
           add_option(options, :data, "#{stimulus_controller}_target", "preview")
           add_option(options, :class, "preview-file")
-          add_option(options, :class, "hidden") unless preview?
+          options[:hidden] = "" unless preview?
 
           tag.div(**options) do
             filename = @builder.object.send(@attribute_name).filename.to_s

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

@@ -22,7 +22,7 @@ module Koi
           options = {}
           add_option(options, :data, "#{stimulus_controller}_target", "preview")
           add_option(options, :class, "preview-image")
-          add_option(options, :class, "hidden") unless preview?
+          options[:hidden] = "" unless preview?
 
           tag.div(**options) do
             tag.img(src: preview_url, class: "image-thumbnail") + destroy_element_trigger

data/lib/koi/form_builder.rb

@@ -4,5 +4,6 @@ module Koi
   class FormBuilder < ActionView::Helpers::FormBuilder
     include GOVUKDesignSystemFormBuilder::Builder
     include Koi::Form::Builder
+    include Koi::Form::Content
   end
 end

data/lib/koi/menu.rb

@@ -2,6 +2,9 @@
 
 module Koi
   module Menu
+    mattr_accessor :quick_links
+    @@quick_links = {}
+
     mattr_accessor :priority
     @@priority = {}
 
@@ -14,7 +17,7 @@ module Koi
     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: "View website", url: "/", target: :blank)
         b.add_link(title: "Dashboard", url: context.main_app.admin_dashboard_path)
         b.add_items(priority)
       end
@@ -38,6 +41,16 @@ module Koi
       builder.render
     end
 
+    def dashboard_menu
+      builder = Builder.new
+      builder.add_menu(title: "Quick links") do |b|
+        b.add_link(title: "View website", url: "/", target: :blank)
+        b.add_items(quick_links)
+      end
+      builder.render
+    end
+
     module_function(:admin_menu)
+    module_function(:dashboard_menu)
   end
 end

data/spec/factories/admins.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 FactoryBot.define do
-  factory :admin, class: "Admin::User" do
+  factory :admin_user, aliases: %i[admin], class: "Admin::User" do
     email { Faker::Internet.email }
     name { Faker::Name.name }
     password { Faker::Internet.password }