katalyst-koi 4.20.1 → 5.0.0.alpha.1

data/app/views/katalyst/navigation/menus/show.html.erb

@@ -1,13 +1,14 @@
 <% content_for :header do %>
-  <%= render Koi::Header::ShowComponent.new(resource: menu, title: menu.title) do |component| %>
-    <% component.with_breadcrumb "Navigations", katalyst_navigation.menus_path %>
-    <% component.with_action "Edit", katalyst_navigation.edit_menu_path(menu) %>
+  <%= breadcrumb_list do %>
+    <li><%= link_to "Navigations", katalyst_navigation.menus_path %></li>
+  <% end %>
+
+  <h1><%= menu.title %></h1>
+
+  <%= actions_list do %>
+    <li><%= link_to("Edit", katalyst_navigation.edit_menu_path(menu)) %></li>
   <% end %>
 <% end %>
 
 <%= render editor.status_bar %>
 <%= render editor %>
-
-<%= content_for :sidebar do %>
-  <%= render editor.new_items %>
-<% end %>

data/app/views/layouts/koi/_application_header.html.erb

@@ -0,0 +1,20 @@
+<header data-environment="<%= Rails.env %>" class="application-header">
+  <div class="repel wrapper">
+    <%= link_to(main_app.admin_dashboard_path, class: "brand") do %>
+      <icon aria-hidden="true" class="icon" data-icon="koi">&nbsp;</icon>
+      Koi
+    <% end %>
+    <div>
+      <span class="environment"><%= Rails.env.capitalize %></span>
+      <span class="release">(<%= Koi::Release.version %>)</span>
+    </div>
+    <%= tag.button(class: "button",
+                   data:  {
+                     controller:  "navigation-toggle",
+                     action:      "navigation-toggle#trigger",
+                     text_button: "",
+                   }) do %>
+      Menu <kbd>G</kbd>
+    <% end %>
+  </div>
+</header>

data/app/views/layouts/koi/_application_navigation.html.erb

@@ -0,0 +1,34 @@
+<dialog class="application-navigation"
+        data-controller="navigation"
+        data-action="shortcut:go@document->navigation#toggle
+          navigation:toggle@document->navigation#toggle
+          shortcut:nav-toggle@document->navigation#toggle
+          turbo:before-morph-attribute->navigation#onMorphAttribute
+          click->navigation#click">
+  <nav aria-label="Main menu" role="navigation" class="flow">
+    <div class="filter">
+      <input type="search" placeholder="Filter menu" autocomplete="off" autofocus
+             data-navigation-target="filter"
+             data-action="input->navigation#filter change->navigation#filter
+                        keydown.enter->navigation#go keydown.esc->navigation#clear">
+    </div>
+    <ul class="navigation-group | flow" role="list">
+      <li>
+        <span><%= current_admin_user.name %></span>
+        <ul class="navigation-list | flow" role="list">
+          <li><%= link_to("Profile", main_app.admin_admin_user_path(current_admin_user)) %></li>
+          <li><%= link_to("Log out", main_app.admin_session_path, data: { turbo_method: :delete }) %></li>
+        </ul>
+      </li>
+    </ul>
+    <%= navigation_menu_with(
+          menu:  Koi::Menu.admin_menu(self),
+          list:  {
+            class: "navigation-list | flow",
+            role:  "list",
+          },
+          class: "navigation-group | flow",
+          role:  "list",
+        ) %>
+  </nav>
+</dialog>

data/app/views/layouts/koi/_flash.html.erb

@@ -1,8 +1,11 @@
-<ul id="flash" aria-label="Notifications" data-controller="flash" class="stack">
+<ul aria-label="Notifications" data-controller="flash" class="flash | flow" role="list">
   <% flash.each do |type, message| %>
-    <%= tag.li role: "alertdialog", class: type do %>
+    <%= tag.li(role: "alertdialog", class: "flash | wrapper", data: { flash_type: type }) do %>
       <%= message %>
-      <%= tag.button "Close", aria: { label: "Dismiss" }, data: { action: "flash#close" } %>
+      <%= tag.button("Dismiss",
+                     aria:  { label: "Dismiss" },
+                     class: "button",
+                     data:  { action: "flash#close", ghost_button: "" }) %>
     <% end %>
   <% end %>
 </ul>

data/app/views/layouts/koi/_navigation_header.html.erb

@@ -6,6 +6,4 @@
   <% else %>
     <h3 class="admin-name">Koi Admin</h3>
   <% end %>
-  <%# default, prefer using an icon in a Koi override %>
-  <span class="site-icon"><%= URI.parse(root_url).host[0] %></span>
 </header>

data/app/views/layouts/koi/application.html.erb

@@ -1,7 +1,6 @@
 <!DOCTYPE html>
 <html lang="en">
 <head>
-  <!-- meta -->
   <meta charset="UTF-8">
 
   <!-- title -->
@@ -18,12 +17,7 @@
   <meta name="turbo-refresh-scroll" content="preserve">
   <%= yield :head %>
 
-  <%# Deprecated: meta, use :head instead %>
-  <%= yield :meta %>
-
   <!-- STYLES -->
-  <link rel="stylesheet" href="https://unpkg.com/modern-css-reset/dist/reset.min.css">
-  <link rel="stylesheet" href="https://rsms.me/inter/inter.css">
   <%= stylesheet_link_tag Koi.config.admin_stylesheet, "data-turbo-track": "reload" %>
 
   <!-- SCRIPTS -->
@@ -35,33 +29,34 @@
           Slash->shortcut:search
           KeyN->shortcut:create
           KeyG->shortcut:go
-          BracketLeft->shortcut:nav-toggle
           Escape->shortcut:cancel
           ArrowLeft->shortcut:page-prev
           ArrowRight->shortcut:page-next
         ">
-<%= render "layouts/koi/navigation" %>
-<main>
-  <% if content_for? :header %>
-    <%= yield :header %>
-  <% else %>
-    <%= render "layouts/koi/header" %>
-  <% end %>
+<!-- application header -->
+<%= render "layouts/koi/application_header" %>
 
-  <div class="page <%= "has-sidebar" if content_for?(:sidebar) %>">
-    <div class="page--content stack" role="main">
-      <%= render "layouts/koi/flash" unless flash.empty? %>
-      <%= yield %>
+<!-- header -->
+<% if content_for?(:header) %>
+  <header class="page-header">
+    <div class="flow wrapper">
+      <%= yield(:header) %>
     </div>
-    <%= tag.div class: "page--sidebar" do %>
-      <%= yield :sidebar %>
-    <% end if content_for?(:sidebar) %>
-  </div>
-</main>
-<%= render "layouts/koi/environment" %>
-<%= render ScrimComponent.new %>
-<%= render Kpop::FrameComponent.new do %>
-  <%= content_for :kpop %>
+  </header>
 <% end %>
+
+<main class="flow wrapper">
+  <% unless flash.empty? %>
+    <!-- flash -->
+    <%= render "layouts/koi/flash" %>
+  <% end %>
+
+  <!-- content -->
+  <%= yield %>
+</main>
+
+<!-- application navigation -->
+<%= render "layouts/koi/application_navigation" %>
+
 </body>
 </html>

data/app/views/layouts/koi/frame.html.erb

@@ -10,8 +10,6 @@
   <%= yield :head %>
 </head>
 <body>
-<%= render Kpop::FrameComponent.new do %>
-  <%= yield %>
-<% end %>
+<%= yield %>
 </body>
 </html>

data/app/views/layouts/koi/login.html.erb

@@ -14,16 +14,23 @@
   <%= yield :meta %>
 
   <!-- STYLES -->
-  <link rel="stylesheet" href="https://unpkg.com/modern-css-reset/dist/reset.min.css">
-  <link rel="stylesheet" href="https://rsms.me/inter/inter.css">
+  <%= stylesheet_link_tag path_to_stylesheet("koi/login.css"), "data-turbo-track": "reload" %>
   <%= stylesheet_link_tag Koi.config.admin_stylesheet, "data-turbo-track": "reload" %>
 
   <!-- SCRIPTS -->
   <%= javascript_importmap_tags "koi/admin" %>
 </head>
-<body class="admin-login">
-<main class="stack">
-  <%= yield %>
+<body>
+<main class="cover" data-centered>
+  <div class="login | modal">
+    <header>
+      <img src="<%= path_to_image("koi/koi.png") %>" alt="Koi" aria-hidden>
+      <h1>Koi</h1>
+      <h2 class="site-name"><%= URI.parse(root_url).host %></h2>
+    </header>
+
+    <%= yield %>
+  </div>
 </main>
 </body>
 </html>

data/config/importmap.rb

@@ -3,6 +3,7 @@
 pin "@hotwired/stimulus", to: "stimulus.min.js", preload: true
 pin "@hotwired/stimulus-loading", to: "stimulus-loading.js", preload: true
 pin "@hotwired/turbo-rails", to: "turbo.min.js", preload: true
+pin "@github/webauthn-json/browser-ponyfill", to: "https://ga.jspm.io/npm:@github/webauthn-json@2.1.1/dist/esm/webauthn-json.browser-ponyfill.js"
 pin "@rails/actiontext", to: "actiontext.js", preload: true
 pin "trix"
 

data/config/locales/koi.en.yml

@@ -16,9 +16,17 @@ en:
       new: New
       search: Search
   activerecord:
+    attributes:
+      url_rewrite/status_code:
+        303: "See other (303)"
+        307: "Temporary redirect (307)"
+        308: "Permanent redirect (308)"
+      well_known/content_type:
+        text: "Plain text"
+        json: "JSON"
     errors:
       models:
-        admin:
+        admin_user:
           invalid: "Invalid login credentials"
   helpers:
     hint:

data/config/locales/pagy.en.yml

@@ -0,0 +1,11 @@
+en:
+  pagy:
+    aria_label:
+      nav:
+        one: "Pagination"
+        other: "Pagination"
+      prev: "Previous page"
+      next: "Next page"
+    prev: "←  Previous"
+    next: "Next  →"
+    gap: "…"

data/config/routes.rb

@@ -30,5 +30,5 @@ Rails.application.routes.draw do
     mount Flipper::UI.app(Flipper) => "flipper" if Object.const_defined?("Flipper::UI")
   end
 
-  resources :well_knowns, path: ".well-known", param: :name, only: %i[show], name: /[^\/]+/
+  resources :well_knowns, path: ".well-known", param: :name, only: %i[show], name: /.+/
 end

data/lib/generators/koi/admin/admin_generator.rb

@@ -1,27 +1,18 @@
 # frozen_string_literal: true
 
-require "rails/generators/rails/scaffold/scaffold_generator"
+require "rails/generators/named_base"
 
 module Koi
-  class AdminGenerator < Rails::Generators::ScaffoldGenerator
-    # Replace the default model generator with our own
-    remove_hook_for(:orm)
-    hook_for(:orm, in: :koi, as: :admin, default: true)
+  class AdminGenerator < Rails::Generators::NamedBase
 
-    # Disable default controller generation as we do not want to generate public
-    # controllers by default
-    remove_hook_for(:scaffold_controller)
-    remove_hook_for(:resource_route)
+    class_option :force, type: :boolean, default: true
 
     hook_for :admin_controller, in: :koi, as: :admin, type: :boolean, default: true do |instance, controller|
       args, opts, config = @_initializer
-      opts             ||= {}
+      opts               ||= {}
 
       # setting model_name so that generators will use the controller_class_path
       instance.invoke controller, args, { model_name: instance.name, **opts }, config
     end
-
-    Rails::Generators::ModelGenerator.hook_for :admin_search, type: :boolean, default: true
-    Rails::Generators::ModelGenerator.hook_for :ordinal_scope, type: :boolean, default: true
   end
 end

data/lib/generators/koi/admin_controller/admin_controller_generator.rb

@@ -3,12 +3,13 @@
 require "rails/generators/named_base"
 require "rails/generators/resource_helpers"
 
-require_relative "../helpers/admin_generator_attributes"
+require_relative "../helpers/attribute_helpers"
+require_relative "../helpers/resource_helpers"
 
 module Koi
   class AdminControllerGenerator < Rails::Generators::NamedBase
-    include Rails::Generators::ResourceHelpers
-    include Helpers::AdminGeneratorAttributes
+    include Helpers::AttributeHelpers
+    include Helpers::ResourceHelpers
 
     source_root File.expand_path("templates", __dir__)
 
@@ -16,6 +17,8 @@ module Koi
 
     argument :attributes, type: :array, default: [], banner: "field:type field:type"
 
+    class_option :force, type: :boolean, default: true
+
     def create_controller_files
       template("controller.rb",
                File.join("app/controllers",
@@ -35,24 +38,11 @@ module Koi
 
     private
 
-    def controller_class_path
-      ["admin"] + super
-    end
-
     def permitted_params
       attachments, others = attributes_names.partition { |name| attachments?(name) }
       params              = others.map { |name| ":#{name}" }
-      params             += attachments.map { |name| "#{name}: []" }
+      params += attachments.map { |name| "#{name}: []" }
       params.join(", ")
     end
-
-    def attachments?(name)
-      attribute = attributes.find { |attr| attr.name == name }
-      attribute&.attachments?
-    end
-
-    def sort_attribute
-      attributes.find { |attr| attr.type == :string }&.name
-    end
   end
 end

data/lib/generators/koi/admin_controller/templates/controller.rb.tt

@@ -3,51 +3,110 @@
 class <%= controller_class_name %>Controller < ApplicationController
   before_action :set_<%= singular_name %>, only: %i[show edit update destroy]
 
+  attr_reader :collection, :<%= singular_name %>
+
   def index
-    collection = Collection.new.with_params(params).apply(::<%= class_name %>.strict_loading.all)
+    <%- if archivable? -%>
+    @collection = Collection.with_params(params).apply(<%= class_name %>.not_archived.strict_loading)
+    <%- else -%>
+    @collection = Collection.with_params(params).apply(<%= class_name %>.strict_loading)
+    <%- end -%>
+
+    render locals: { collection: }
+  end
+
+  <%- if archivable? -%>
+  def archived
+    collection = Collection.with_params(params).apply(<%= class_name %>.archived.strict_loading)
 
     render locals: { collection: }
   end
+  <%- end -%>
 
   def show
-    render locals: { <%= singular_name %>: @<%= singular_name %> }
+    render locals: { <%= singular_name %>: }
   end
 
   def new
-    render locals: { <%= singular_name %>: ::<%= class_name %>.new }
+    @<%= singular_name %> = <%= class_name %>.new
+
+    render locals: { <%= singular_name %>: }
   end
 
   def edit
-    render locals: { <%= singular_name %>: @<%= singular_name %> }
+    render locals: { <%= singular_name %>: }
   end
 
   def create
-    @<%= singular_name %> = ::<%= class_name %>.new(<%= singular_table_name %>_params)
+    @<%= singular_name %> = <%= class_name %>.new(<%= singular_table_name %>_params)
 
-    if @<%= singular_name %>.save
-      redirect_to [:admin, @<%= singular_name %>], status: :see_other
+    if <%= singular_name %>.save
+      redirect_to <%= admin_show_helper %>, status: :see_other
     else
-      render :new, locals: { <%= singular_name %>: @<%= singular_name %> }, status: :unprocessable_content
+      render :new, locals: { <%= singular_name %>: }, status: :unprocessable_content
     end
   end
 
   def update
-    if @<%= singular_name %>.update(<%= singular_table_name %>_params)
-      redirect_to action: :show, status: :see_other
+    if <%= singular_name %>.update(<%= singular_table_name %>_params)
+      redirect_to <%= admin_show_helper %>, status: :see_other
     else
-      render :edit, locals: { <%= singular_name %>: @<%= singular_name %> }, status: :unprocessable_content
+      render :edit, locals: { <%= singular_name %>: }, status: :unprocessable_content
+    end
+  end
+
+  <%- if archivable? -%>
+  def archive
+    <%= class_name %>.where(id: params[:id]).each(&:archive!)
+
+    redirect_back(fallback_location: <%= admin_index_helper %>, status: :see_other)
+  end
+
+  def restore
+    <%= class_name %>.archived.where(id: params[:id]).each(&:restore!)
+
+    redirect_back(fallback_location: <%= admin_index_helper %>, status: :see_other)
+  end
+  <%- end -%>
+
+  <%- if orderable? -%>
+  def order
+    order_params[:<%= table_name %>].each do |id, attrs|
+      <%= class_name %>.find(id).update(attrs)
     end
+
+    redirect_back(fallback_location: <%= admin_index_helper %>, status: :see_other)
   end
+  <%- end -%>
 
   def destroy
-    @<%= singular_name %>.destroy!
+    <%- if archivable? -%>
+    if <%= singular_name %>.archived?
+      <%= singular_name %>.destroy!
+
+      redirect_to <%= admin_index_helper %>, status: :see_other
+    else
+      <%= singular_name %>.archive!
 
-    redirect_to action: :index, status: :see_other
+      redirect_back_or_to(<%= admin_show_helper %>, status: :see_other)
+    end
+    <%- else -%>
+    <%= singular_name %>.destroy!
+
+    redirect_to <%= admin_index_helper %>, status: :see_other
+    <%- end -%>
   end
 
   private
 
-  # Only allow a list of trusted parameters through.
+  def set_<%= singular_name %>
+    <%- if archivable? -%>
+    @<%= singular_name %> = <%= class_name %>.with_archived.find(params[:id])
+    <%- else -%>
+    @<%= singular_name %> = <%= class_name %>.find(params[:id])
+    <%- end -%>
+  end
+
   def <%= "#{singular_table_name}_params" %>
     <%- if attributes_names.empty? -%>
     params.expect(<%= singular_table_name %>: [])
@@ -56,14 +115,19 @@ class <%= controller_class_name %>Controller < ApplicationController
     <%- end -%>
   end
 
-  # Use callbacks to share common setup or constraints between actions.
-  def set_<%= singular_name %>
-    @<%= singular_name %> = ::<%= class_name %>.find(params[:id])
+  <%- if orderable? -%>
+  def order_params
+    params.expect(order: { <%= table_name %>: [[:ordinal]] })
   end
+  <%- end -%>
 
   class Collection < Admin::Collection
-    config.sorting  = :<%= sort_attribute %>
+    <%- if sortable? %>
+    config.sorting  = :<%= default_sort_attribute %>
+    <%- end -%>
+    <%- if paginate? -%>
     config.paginate = true
+    <%- end -%>
 
     <%- attributes.each do |attribute| -%>
     <% definition = collection_attribute_for(attribute) -%>