katalyst-koi 4.7.2 → 4.8.0

data/app/assets/javascripts/koi/controllers/pagy_nav_controller.js

@@ -0,0 +1,21 @@
+import { Controller } from "@hotwired/stimulus";
+
+export default class PagyNavController extends Controller {
+  connect() {
+    document.addEventListener("shortcut:page-prev", this.prevPage);
+    document.addEventListener("shortcut:page-next", this.nextPage);
+  }
+
+  disconnect() {
+    document.removeEventListener("shortcut:page-prev", this.prevPage);
+    document.removeEventListener("shortcut:page-next", this.nextPage);
+  }
+
+  nextPage = () => {
+    this.element.querySelector("a:last-child").click();
+  };
+
+  prevPage = () => {
+    this.element.querySelector("a:first-child").click();
+  };
+}

data/app/assets/stylesheets/koi/base/_index.scss

@@ -3,6 +3,7 @@
 @use "input";
 @use "link";
 @use "list";
+@use "tables";
 @use "typography";
 
 .button--primary {

data/app/assets/stylesheets/koi/base/_tables.scss

@@ -0,0 +1,15 @@
+@use "katalyst/tables";
+
+:where(th.type-enum, td.type-enum) {
+  width: var(--width-small);
+}
+
+:where(td.type-enum span) {
+  --background-color: var(--site-primary-light);
+  --color: var(--site-on-primary);
+  background: var(--background-color);
+  color: var(--color);
+  border-radius: 0.25rem;
+  font-size: var(--paragraph--small);
+  padding: 0.25rem 0.5rem;
+}

data/app/assets/stylesheets/koi/components/_index.scss

@@ -3,6 +3,5 @@
 @use "document-field";
 @use "image-field";
 @use "index-actions";
-@use "index-table";
 @use "pagy";
 @use "summary-list";

data/app/components/concerns/koi/tables/cells.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Koi
+  module Tables
+    module Cells
+      # Generates a column that links to the record's show page (by default).
+      #
+      # @param column [Symbol] the column's name, called as a method on the record
+      # @param label [String|nil] the label to use for the column header
+      # @param heading [boolean] if true, data cells will use `th` tags
+      # @param url [Symbol|String|Proc] arguments for url_For, defaults to the record
+      # @param link [Hash] options to be passed to the link_to helper
+      # @param ** [Hash] HTML attributes to be added to column cells
+      # @param & [Proc] optional block to alter the cell content
+      #
+      # If a block is provided, it will be called with the link cell component as an argument.
+      # @yieldparam cell [Katalyst::Tables::Cells::LinkComponent] the cell component
+      #
+      # @return [void]
+      #
+      # @example Render a column containing the record's title, linked to its show page
+      #   <% row.link :title %> # => <td><a href="/admin/post/15">About us</a></td>
+      # @example Render a column containing the record's title, linked to its edit page
+      #   <% row.link :title, url: :edit_admin_post_path do |cell| %>
+      #      Edit <%= cell %>
+      #   <% end %>
+      #   # => <td><a href="/admin/post/15/edit">Edit About us</a></td>
+      def link(column, label: nil, heading: false, url: [:admin, record], link: {}, **, &)
+        with_cell(Tables::Cells::LinkComponent.new(
+                    collection:, row:, column:, record:, label:, heading:, url:, link:, **,
+                  ), &)
+      end
+
+      # Generates a column from an enum value rendered as a tag.
+      # The target attribute must be defined as an `enum` in the model.
+      #
+      # @param column [Symbol] the column's name, called as a method on the record.
+      # @param label [String|nil] the label to use for the column header
+      # @param heading [boolean] if true, data cells will use `th` tags
+      # @param ** [Hash] HTML attributes to be added to column cells
+      # @param & [Proc] optional block to wrap the cell content
+      #
+      # When rendering an enum value, the component will check for translations
+      # using the key `active_record.attributes.[model]/[column].[value]`,
+      # e.g. `active_record.attributes.banner/status.published`.
+      #
+      # If a block is provided, it will be called with the cell component as an argument.
+      # @yieldparam cell [Katalyst::Tables::CellComponent] the cell component
+      #
+      # @return [void]
+      #
+      # @example Render a generic text column for any value that supports `to_s`
+      #   <% row.enum :status %>
+      #   <%# label => <th>Status</th> %>
+      #   <%# data => <td class="type-enum"><span data-enum="status" data-value="published">Published</span></td> %>
+      def enum(column, label: nil, heading: false, **, &)
+        with_cell(Tables::Cells::EnumComponent.new(
+                    collection:, row:, column:, record:, label:, heading:, **,
+                  ), &)
+      end
+
+      # Generates a column that renders an ActiveStorage attachment as a downloadable link.
+      #
+      # @param column [Symbol] the column's name, called as a method on the record
+      # @param label [String|nil] the label to use for the column header
+      # @param heading [boolean] if true, data cells will use `th` tags
+      # @param variant [Symbol] the variant to use when rendering the image (default :thumb)
+      # @param ** [Hash] HTML attributes to be added to column cells
+      # @param & [Proc] optional block to alter the cell content
+      #
+      # If a block is provided, it will be called with the attachment cell component as an argument.
+      # @yieldparam cell [Katalyst::Tables::Cells::AttachmentComponent] the cell component
+      #
+      # @return [void]
+      #
+      # @example Render a column containing a download link to the record's background image
+      #   <% row.attachment :background %> # => <td><a href="...">background.png</a></td>
+      def attachment(column, label: nil, heading: false, variant: :thumb, **, &)
+        with_cell(Tables::Cells::AttachmentComponent.new(
+                    collection:, row:, column:, record:, label:, heading:, variant:, **,
+                  ), &)
+      end
+    end
+  end
+end

data/app/components/koi/header/edit_component.rb

@@ -36,7 +36,7 @@ module Koi
 
       def resource_title
         title = Koi.config.resource_name_candidates.reduce(nil) do |name, key|
-          name || resource.respond_to?(key) && resource.public_send(key)
+          name || (resource.public_send(key) if resource.respond_to?(key))
         end
 
         title.presence || resource.model_name.human

data/app/components/koi/header/show_component.rb

@@ -29,7 +29,7 @@ module Koi
 
       def title
         title = Koi.config.resource_name_candidates.reduce(@title) do |name, key|
-          name || resource.respond_to?(key) && resource.public_send(key)
+          name || (resource.public_send(key) if resource.respond_to?(key))
         end
 
         title.presence || resource.model_name.human

data/app/components/koi/summary_list/date_component.rb

@@ -3,8 +3,8 @@
 module Koi
   module SummaryList
     class DateComponent < Base
-      def initialize(model, attribute, format: :admin, **options)
-        super(model, attribute, **options)
+      def initialize(model, attribute, format: :admin, **)
+        super(model, attribute, **)
 
         @format = format
       end

data/app/components/koi/summary_list/datetime_component.rb

@@ -3,8 +3,8 @@
 module Koi
   module SummaryList
     class DatetimeComponent < Base
-      def initialize(model, attribute, format: :admin, **options)
-        super(model, attribute, **options)
+      def initialize(model, attribute, format: :admin, **)
+        super(model, attribute, **)
 
         @format = format
       end

data/app/components/koi/summary_list/number_component.rb

@@ -3,8 +3,8 @@
 module Koi
   module SummaryList
     class NumberComponent < Base
-      def initialize(model, attribute, format: :admin, **options)
-        super(model, attribute, **options)
+      def initialize(model, attribute, format: :admin, **)
+        super(model, attribute, **)
 
         @format = format
       end

data/app/components/koi/summary_table_component.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Koi
+  class SummaryTableComponent < Katalyst::SummaryTableComponent
+    include Tables::Cells
+  end
+end

data/app/components/koi/table_component.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Koi
+  class TableComponent < Katalyst::TableComponent
+    include Tables::Cells
+  end
+end

data/app/components/koi/tables/cells/enum_component.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Koi
+  module Tables
+    module Cells
+      # Displays an enum value using data inferred from the model.
+      class EnumComponent < Katalyst::Tables::CellComponent
+        def rendered_value
+          if (value = self.value).present?
+            label = t(i18n_enum_label_key(value), default: value)
+            tag.span(label, data: { enum: column, value: })
+          end
+        end
+
+        private
+
+        def default_html_attributes
+          { class: "type-enum" }
+        end
+
+        def i18n_enum_label_key(value)
+          "active_record.attributes.#{collection.model_name.i18n_key}/#{column}.#{value}"
+        end
+      end
+    end
+  end
+end

data/app/components/koi/tables/table_component.rb

@@ -1,61 +1,9 @@
 # frozen_string_literal: true
 
+# @deprecated prefer Koi::TableComponent
 module Koi
   module Tables
-    class TableComponent < Katalyst::TableComponent
-      # Generates a column that links to the record's show page (by default).
-      #
-      # @param column [Symbol] the column's name, called as a method on the record
-      # @param label [String|nil] the label to use for the column header
-      # @param heading [boolean] if true, data cells will use `th` tags
-      # @param url [Symbol|String|Proc] arguments for url_For, defaults to the record
-      # @param link [Hash] options to be passed to the link_to helper
-      # @param ** [Hash] HTML attributes to be added to column cells
-      # @param & [Proc] optional block to alter the cell content
-      #
-      # If a block is provided, it will be called with the link cell component as an argument.
-      # @yieldparam cell [Katalyst::Tables::Cells::LinkComponent] the cell component
-      #
-      # @return [void]
-      #
-      # @example Render a column containing the record's title, linked to its show page
-      #   <% row.link :title %> # => <td><a href="/admin/post/15">About us</a></td>
-      # @example Render a column containing the record's title, linked to its edit page
-      #   <% row.link :title, url: :edit_admin_post_path do |cell| %>
-      #      Edit <%= cell %>
-      #   <% end %>
-      #   # => <td><a href="/admin/post/15/edit">Edit About us</a></td>
-      def link(column, label: nil, heading: false, url: [:admin, record], link: {}, **, &)
-        with_cell(Tables::Cells::LinkComponent.new(
-                    collection:, row:, column:, record:, label:, heading:, url:, link:, **,
-                  ), &)
-      end
-
-      # Generates a column that renders an ActiveStorage attachment as a downloadable link.
-      #
-      # @param column [Symbol] the column's name, called as a method on the record
-      # @param label [String|nil] the label to use for the column header
-      # @param heading [boolean] if true, data cells will use `th` tags
-      # @param variant [Symbol] the variant to use when rendering the image (default :thumb)
-      # @param ** [Hash] HTML attributes to be added to column cells
-      # @param & [Proc] optional block to alter the cell content
-      #
-      # If a block is provided, it will be called with the attachment cell component as an argument.
-      # @yieldparam cell [Katalyst::Tables::Cells::AttachmentComponent] the cell component
-      #
-      # @return [void]
-      #
-      # @example Render a column containing a download link to the record's background image
-      #   <% row.attachment :background %> # => <td><a href="...">background.png</a></td>
-      def attachment(column, label: nil, heading: false, variant: :thumb, **, &)
-        with_cell(Tables::Cells::AttachmentComponent.new(
-                    collection:, row:, column:, record:, label:, heading:, variant:, **,
-                  ), &)
-      end
-
-      def default_html_attributes
-        { class: "index-table" }
-      end
+    class TableComponent < ::Koi::TableComponent
     end
   end
 end

data/app/controllers/admin/admin_users_controller.rb

@@ -32,7 +32,7 @@ module Admin
       if admin.save
         redirect_to admin_admin_user_path(admin)
       else
-        render :new, locals: { admin: }, status: :unprocessable_entity
+        render :new, locals: { admin: }, status: :unprocessable_content
       end
     end
 
@@ -40,7 +40,7 @@ module Admin
       if admin.update(admin_user_params)
         redirect_to action: :show
       else
-        render :edit, locals: { admin: }, status: :unprocessable_entity
+        render :edit, locals: { admin: }, status: :unprocessable_content
       end
     end
 

data/app/controllers/admin/sessions_controller.rb

@@ -15,23 +15,17 @@ module Admin
     end
 
     def create
-      if (admin_user = webauthn_authenticate!)
+      if (admin_user = webauthn_authenticate! || params_authenticate!)
         record_sign_in!(admin_user)
 
         session[:admin_user_id] = admin_user.id
 
-        redirect_to admin_dashboard_path, notice: "You have been logged in"
-      elsif (admin_user = Admin::User.authenticate_by(session_params.slice(:email, :password)))
-        record_sign_in!(admin_user)
-
-        session[:admin_user_id] = admin_user.id
-
-        redirect_to admin_dashboard_path, notice: "You have been logged in"
+        redirect_to admin_dashboard_path, notice: I18n.t("koi.auth.login")
       else
         admin_user = Admin::User.new(session_params.slice(:email, :password))
         admin_user.errors.add(:email, "Invalid email or password")
 
-        render :new, status: :unprocessable_entity, locals: { admin_user: }
+        render :new, status: :unprocessable_content, locals: { admin_user: }
       end
     end
 
@@ -40,7 +34,7 @@ module Admin
 
       session[:admin_user_id] = nil
 
-      redirect_to admin_dashboard_path, notice: "You have been logged out"
+      redirect_to admin_dashboard_path, notice: I18n.t("koi.auth.logout")
     end
 
     private
@@ -49,6 +43,10 @@ module Admin
       params.require(:admin).permit(:email, :password, :response)
     end
 
+    def params_authenticate!
+      Admin::User.authenticate_by(session_params.slice(:email, :password))
+    end
+
     def update_last_sign_in(admin_user)
       return if admin_user.current_sign_in_at.blank?
 

data/app/controllers/admin/tokens_controller.rb

@@ -7,6 +7,18 @@ module Admin
     skip_before_action :authenticate_admin, only: %i[show update]
     before_action :set_token, only: %i[show update]
 
+    def show
+      return redirect_to new_admin_session_path, notice: I18n.t("koi.auth.token_invalid") if @token.blank?
+
+      admin = Admin::User.find(@token[:admin_id])
+
+      if token_utilised?(admin, @token)
+        return redirect_to new_admin_session_path, notice: I18n.t("koi.auth.token_invalid")
+      end
+
+      render locals: { admin:, token: params[:token] }, layout: "koi/login"
+    end
+
     def create
       admin = Admin::User.find(params[:id])
       token = encode_token(admin_id: admin.id, exp: 5.minutes.from_now.to_i, iat: Time.current.to_i)
@@ -17,7 +29,9 @@ module Admin
     def update
       return redirect_to admin_dashboard_path, status: :see_other if admin_signed_in?
 
-      return redirect_to new_admin_session_path, status: :see_other, notice: "invalid token" if @token.blank?
+      if @token.blank?
+        return redirect_to new_admin_session_path, status: :see_other, notice: I18n.t("koi.auth.token_invalid")
+      end
 
       admin = Admin::User.find(@token[:admin_id])
       sign_in_admin(admin)
@@ -25,18 +39,6 @@ module Admin
       redirect_to admin_admin_user_path(admin)
     end
 
-    def show
-      return redirect_to new_admin_session_path, notice: "Token invalid or consumed already" if @token.blank?
-
-      admin = Admin::User.find(@token[:admin_id])
-
-      if token_utilised?(admin, @token)
-        return redirect_to new_admin_session_path, notice: "Token invalid or consumed already"
-      end
-
-      render locals: { admin:, token: params[:token] }, layout: "koi/login"
-    end
-
     private
 
     def set_token

data/app/controllers/admin/url_rewrites_controller.rb

@@ -29,7 +29,7 @@ module Admin
       if @url_rewrite.save
         redirect_to admin_url_rewrite_path(@url_rewrite)
       else
-        render :new, status: :unprocessable_entity, locals: { url_rewrite: @url_rewrite }
+        render :new, status: :unprocessable_content, locals: { url_rewrite: @url_rewrite }
       end
     end
 
@@ -39,7 +39,7 @@ module Admin
       if @url_rewrite.save
         redirect_to admin_url_rewrite_path(@url_rewrite)
       else
-        render :edit, status: :unprocessable_entity, locals: { url_rewrite: @url_rewrite }
+        render :edit, status: :unprocessable_content, locals: { url_rewrite: @url_rewrite }
       end
     end
 

data/app/controllers/concerns/koi/controller/has_attachments.rb

@@ -15,7 +15,7 @@ module Koi
       #         redirect_to [:admin, @document], status: :see_other
       #       else
       #         store_attachments(@document)
-      #         render :new, status: :unprocessable_entity
+      #         render :new, status: :unprocessable_content
       #       end
       #     end
       #

data/app/controllers/concerns/koi/controller/is_admin_controller.rb

@@ -15,15 +15,17 @@ module Koi
         include HasAdminUsers
         include HasAttachments
         include Katalyst::Tables::Backend
-        include Pagy::Backend
+        include ::Pagy::Backend
 
         default_form_builder "Koi::FormBuilder"
-        default_table_component Koi::Tables::TableComponent
+        default_table_component Koi::TableComponent
+        default_summary_table_component Koi::SummaryTableComponent
 
         helper Katalyst::GOVUK::Formbuilder::Frontend
         helper Katalyst::Navigation::FrontendHelper
         helper Katalyst::Tables::Frontend
-        helper Pagy::Frontend
+        helper ::Pagy::Frontend
+        helper Koi::Pagy::Frontend
         helper IndexActionsHelper
         helper :all
 
@@ -43,7 +45,7 @@ module Koi
         return if admin_signed_in? || !Rails.env.development?
 
         session[:admin_user_id] =
-          Admin::User.where(email: %W[#{ENV['USER']}@katalyst.com.au admin@katalyst.com.au]).first&.id
+          Admin::User.where(email: %W[#{ENV.fetch('USER', nil)}@katalyst.com.au admin@katalyst.com.au]).first&.id
       end
 
       def authenticate_admin

data/app/controllers/concerns/koi/controller/json_web_token.rb

@@ -13,7 +13,7 @@ module Koi
 
       def decode_token(token)
         payload = JWT.decode(token, SECRET_KEY)[0]
-        HashWithIndifferentAccess.new(payload)
+        ActiveSupport::HashWithIndifferentAccess.new(payload)
       rescue JWT::DecodeError
         nil
       end

data/app/helpers/koi/definition_list_helper.rb

@@ -3,8 +3,8 @@
 module Koi
   module DefinitionListHelper
     # @deprecated This method is deprecated and will be removed in Koi 5.
-    def definition_list(**options, &block)
-      render Koi::SummaryListComponent.new(**options), &block
+    def definition_list(**, &)
+      render(Koi::SummaryListComponent.new(**), &)
     end
   end
 end

data/app/helpers/koi/index_actions_helper.rb

@@ -2,8 +2,8 @@
 
 module Koi
   module IndexActionsHelper
-    def koi_index_actions(search: false, create: false, &block)
-      IndexActionsBuilder.new(self, search:, create:).render(&block)
+    def koi_index_actions(search: false, create: false, &)
+      IndexActionsBuilder.new(self, search:, create:).render(&)
     end
   end
 
@@ -85,8 +85,6 @@ module Koi
         ("shortcut:cancel@document->index-actions#clear" if search?),
         ("shortcut:create@document->index-actions#create" if create?),
         ("shortcut:search@document->index-actions#search" if search?),
-        "shortcut:page-prev@document->index-actions#prevPage",
-        "shortcut:page-next@document->index-actions#nextPage",
       ].compact.join(" ")
     end
 

data/app/helpers/koi/pagy.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Koi
+  # Koi Pagy extensions
+  module Pagy
+    module Frontend
+      private
+
+      # @overload nav_aria_label() to add stimulus controller to pagy_nav
+      def nav_aria_label(pagy, aria_label: nil)
+        "#{super} data-controller='pagy-nav'"
+      end
+    end
+  end
+end

data/app/models/url_rewrite.rb

@@ -14,7 +14,7 @@ class UrlRewrite < ApplicationRecord
   attribute :status_code, :integer, default: 303
 
   validates :from, :to, presence: true
-  validates :from, format: { with: %r{\A/.*\z}, message: "should start with /" }
+  validates :from, format: { with: %r{\A/.*\z}, message: "should start with /" } # rubocop:disable Rails/I18nLocaleTexts
 
   scope :active, -> { where(active: true) }
   scope :alphabetical, -> { order(from: :asc) }

data/app/views/admin/credentials/_credentials.html.erb

@@ -1,4 +1,4 @@
-<%= table_with(id: dom_id(admin, :credentials), collection: admin.credentials, class: "index-table") do |t, c| %>
+<%= table_with(id: dom_id(admin, :credentials), collection: admin.credentials) do |t, c| %>
   <% t.text :nickname %>
   <% t.number :sign_count %>
   <% t.cell :actions, label: "" do %>

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

@@ -12,6 +12,9 @@
   <meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=0.6667">
   <meta name="robots" content="noindex,nofollow">
   <%= Koi::Release.meta_tags(self) %>
+
+  <meta name="turbo-refresh-method" content="morph">
+  <meta name="turbo-refresh-scroll" content="preserve">
   <%= yield :head %>
 
   <%# Deprecated: meta, use :head instead %>

data/config/initializers/extensions.rb

@@ -5,6 +5,6 @@ ActiveSupport.on_load(:action_view) do
   # https://github.com/rails/rails/issues/50916
   ActionView::AbstractRenderer::ObjectRendering.define_method(
     :merge_prefix_into_object_path,
-    Koi::Extensions::ObjectRendering.instance_method(:merge_prefix_into_object_path)
+    Koi::Extensions::ObjectRendering.instance_method(:merge_prefix_into_object_path),
   )
 end

data/config/initializers/flipper.rb

@@ -2,7 +2,7 @@
 
 # Register koi admin roles with flipper for easy toggling
 
-return unless Object.const_defined?("Flipper")
+return unless Object.const_defined?(:Flipper)
 
 Flipper.register(:admins) do |flipper, _context|
   flipper.actor.is_a?(Admin::User) && !flipper.actor.archived?

data/config/initializers/pagy.rb

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

data/config/locales/koi.en.yml

@@ -8,6 +8,10 @@ en:
       default: "%Y-%m-%d"
       admin: "%e %B %Y"
   koi:
+    auth:
+      login: "You have been logged in"
+      logout: "You have been logged out"
+      token_invalid: "Token invalid or consumed already"
     labels:
       new: New
       search: Search

data/db/migrate/20130509235316_add_url_rewriter.rb

@@ -5,7 +5,7 @@ class AddUrlRewriter < ActiveRecord::Migration[4.2]
     create_table :url_rewrites do |t|
       t.text    :from
       t.text    :to
-      t.boolean :active, default: true
+      t.boolean :active, default: true, null: false
 
       t.timestamps
     end

data/db/migrate/20230531063707_update_admin_users.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 class UpdateAdminUsers < ActiveRecord::Migration[7.0]
-  class Admin < ActiveRecord::Base; end
+  class Admin < ApplicationRecord; end
 
   def up
     add_column :admins, :name, :string
@@ -21,14 +23,15 @@ class UpdateAdminUsers < ActiveRecord::Migration[7.0]
   def down
     add_column :admins, :first_name, :string
     add_column :admins, :last_name, :string
-    add_column :admins, :reset_password_token, :string, index: { unique: true }
+    add_column :admins, :reset_password_token, :string
+    add_index :admins, :reset_password_token, unique: true
     add_column :admins, :reset_password_sent_at, :datetime
     add_column :admins, :remember_created_at, :datetime
     add_column :admins, :locked_at, :datetime
     add_column :admins, :role, :string
 
     Admin.all.each do |admin|
-      admin.first_name, admin.last_name = admin.name.split(' ', 2)
+      admin.first_name, admin.last_name = admin.name.split(" ", 2)
       admin.save!
     end
 

data/db/seeds.rb

@@ -5,5 +5,5 @@ if Rails.env.development? && !ENV["CI"]
   Admin::User.create_with(
     name:     `id -F`.strip,
     password: "password",
-  ).find_or_create_by(email: "#{ENV['USER']}@katalyst.com.au")
+  ).find_or_create_by(email: "#{ENV.fetch('USER', nil)}@katalyst.com.au")
 end