katalyst-koi 4.20.1 → 5.0.0.alpha.1

data/app/controllers/admin/admin_users_controller.rb

@@ -2,9 +2,9 @@
 
 module Admin
   class AdminUsersController < ApplicationController
-    before_action :set_admin, only: %i[show edit update destroy]
+    before_action :set_admin_user, only: %i[show edit update destroy]
 
-    attr_reader :admin
+    attr_reader :admin_user
 
     def index
       collection = Collection.new.with_params(params).apply(Admin::User.strict_loading)
@@ -19,65 +19,71 @@ module Admin
     end
 
     def show
-      render :show, locals: { admin: }
+      render locals: { admin_user: }
     end
 
     def new
-      @admin = Admin::User.new
+      @admin_user = Admin::User.new
 
-      render :new, locals: { admin: }
+      render locals: { admin_user: }
     end
 
     def edit
-      render :edit, locals: { admin: }
+      render :edit, locals: { admin_user: }
     end
 
     def create
-      admin = Admin::User.new(admin_user_params)
+      admin_user = Admin::User.new(admin_user_params)
 
-      if admin.save
-        redirect_to admin_admin_user_path(admin)
+      if admin_user.save
+        redirect_to admin_admin_user_path(admin_user)
       else
-        render :new, locals: { admin: }, status: :unprocessable_content
+        render :new, locals: { admin_user: }, status: :unprocessable_content
       end
     end
 
     def update
-      if admin.update(admin_user_params)
+      if admin_user.update(admin_user_params)
         redirect_to action: :show
       else
-        render :edit, locals: { admin: }, status: :unprocessable_content
+        render :edit, locals: { admin_user: }, status: :unprocessable_content
       end
     end
 
     def archive
       Admin::User.where(id: params[:id]).where.not(id: current_admin.id).each(&:archive!)
 
-      redirect_back_or_to(admin_admin_users_path, status: :see_other)
+      redirect_back(fallback_location: admin_admin_users_path, status: :see_other)
     end
 
     def restore
       Admin::User.archived.where(id: params[:id]).each(&:restore!)
 
-      redirect_back_or_to(admin_admin_users_path, status: :see_other)
+      redirect_back(fallback_location: admin_admin_users_path, status: :see_other)
     end
 
     def destroy
-      admin.destroy
+      if admin_user.archived?
+        admin_user.destroy!
 
-      redirect_to admin_admin_users_path
+        redirect_to admin_admin_users_path
+      else
+        admin_user.archive!
+
+        redirect_back_or_to(admin_admin_user_path(admin_user), status: :see_other)
+      end
     end
 
     private
 
-    def set_admin
-      @admin = Admin::User.with_archived.find(params.expect(:id))
+    def set_admin_user
+      @admin_user = Admin::User.with_archived.find(params[:id])
 
-      request.variant << :self if @admin == current_admin_user
+      request.variant << :self if admin_user == current_admin_user
     end
 
     def admin_user_params
-      params.expect(admin: %i[name email password archived])
+      params.expect(admin_user: %i[name email password archived])
     end
 
     class Collection < Admin::Collection

data/app/controllers/admin/application_controller.rb

@@ -2,8 +2,6 @@
 
 module Admin
   class ApplicationController < ActionController::Base
-    include Koi::Controller::IsAdminController
-
-    protect_from_forgery with: :exception
+    include Koi::Controller
   end
 end

data/app/controllers/admin/caches_controller.rb

@@ -5,7 +5,7 @@ module Admin
     def destroy
       Rails.logger.warn("[CACHE CLEAR] - Cleaning entire cache manually by #{current_admin} request")
       Rails.cache.clear
-      redirect_back_or_to(admin_dashboard_path)
+      redirect_back(fallback_location: admin_dashboard_path)
     end
   end
 end

data/app/controllers/admin/credentials_controller.rb

@@ -6,25 +6,29 @@ module Admin
 
     before_action :set_admin_user
 
+    attr_reader :admin_user
+
     def new
-      unless @admin_user.webauthn_id
-        @admin_user.update!(webauthn_id: WebAuthn.generate_user_id)
+      unless admin_user.webauthn_id
+        admin_user.update!(webauthn_id: WebAuthn.generate_user_id)
       end
 
       options = webauthn_relying_party.options_for_registration(
         user:    {
-          id:           @admin_user.webauthn_id,
-          name:         @admin_user.email,
-          display_name: @admin_user.to_s,
+          id:           admin_user.webauthn_id,
+          name:         admin_user.email,
+          display_name: admin_user.name,
         },
-        exclude: @admin_user.credentials.map(&:external_id),
+        exclude: admin_user.credentials.map(&:external_id),
       )
 
       # Store the newly generated challenge somewhere so you can have it
       # for the verification phase.
       session[:creation_challenge] = options.challenge
 
-      render :new, locals: { admin: @admin_user, options: }
+      credential = admin_user.credentials.new
+
+      render locals: { admin_user:, credential:, options: }
     end
 
     def create
@@ -35,7 +39,7 @@ module Admin
         session.delete(:creation_challenge),
       )
 
-      credential = @admin_user.credentials.find_or_initialize_by(
+      credential = admin_user.credentials.find_or_initialize_by(
         external_id: webauthn_credential.id,
       )
 
@@ -46,18 +50,18 @@ module Admin
       )
 
       respond_to do |format|
-        format.html { redirect_to admin_admin_user_path(@admin_user), status: :see_other }
-        format.turbo_stream { render locals: { admin: @admin_user } }
+        format.html { redirect_to admin_admin_user_path(admin_user), status: :see_other }
+        format.turbo_stream { render locals: { admin_user: } }
       end
     end
 
     def destroy
-      credential = @admin_user.credentials.find(params.expect(:id))
+      credential = admin_user.credentials.find(params[:id])
       credential.destroy!
 
       respond_to do |format|
-        format.html { redirect_to admin_admin_user_path(@admin_user), status: :see_other }
-        format.turbo_stream { render locals: { admin: @admin_user } }
+        format.html { redirect_to admin_admin_user_path(admin_user), status: :see_other }
+        format.turbo_stream { render locals: { admin_user: } }
       end
     end
 
@@ -68,9 +72,9 @@ module Admin
     end
 
     def set_admin_user
-      @admin_user = Admin::User.find(params.expect(:admin_user_id))
+      @admin_user = Admin::User.find(params[:admin_user_id])
 
-      if current_admin == @admin_user
+      if current_admin == admin_user
         request.variant = :self
       else
         head(:forbidden)

data/app/controllers/admin/otps_controller.rb

@@ -4,45 +4,47 @@ module Admin
   class OtpsController < ApplicationController
     before_action :set_admin_user
 
+    attr_reader :admin_user
+
     def new
-      @admin_user.otp_secret = ROTP::Base32.random
+      admin_user.otp_secret = ROTP::Base32.random
 
-      render :new, locals: { admin: @admin_user }
+      render :new, locals: { admin_user: }
     end
 
     def create
-      @admin_user.otp_secret = otp_params[:otp_secret]
+      admin_user.otp_secret = otp_params[:otp_secret]
 
-      if @admin_user.otp.verify(otp_params[:token])
-        @admin_user.save
+      if admin_user.otp.verify(otp_params[:token])
+        admin_user.save
 
-        redirect_to admin_admin_user_path(@admin_user), status: :see_other
+        redirect_to admin_admin_user_path(admin_user), status: :see_other
       else
-        @admin_user.errors.add(:token, :invalid)
+        admin_user.errors.add(:token, :invalid)
 
         respond_to do |format|
-          format.html { redirect_to admin_admin_user_path(@admin_user), status: :see_other }
-          format.turbo_stream { render locals: { admin: @admin_user } }
+          format.html { redirect_to admin_admin_user_path(admin_user), status: :see_other }
+          format.turbo_stream { render locals: { admin_user: }, status: :unprocessable_entity }
         end
       end
     end
 
     def destroy
-      @admin_user.update!(otp_secret: nil)
+      admin_user.update!(otp_secret: nil)
 
-      redirect_to admin_admin_user_path(@admin_user), status: :see_other
+      redirect_to admin_admin_user_path(admin_user), status: :see_other
     end
 
     private
 
     def otp_params
-      params.expect(admin: %i[otp_secret token])
+      params.expect(admin_user: %i[otp_secret token])
     end
 
     def set_admin_user
-      @admin_user = Admin::User.find(params.expect(:admin_user_id))
+      @admin_user = Admin::User.find(params[:admin_user_id])
 
-      if current_admin == @admin_user
+      if current_admin == admin_user
         request.variant = :self
       else
         head(:forbidden)

data/app/controllers/admin/sessions_controller.rb

@@ -6,7 +6,7 @@ module Admin
     include Koi::Controller::RecordsAuthentication
 
     before_action :redirect_authenticated, only: %i[new], if: :admin_signed_in?
-    before_action :authenticate_local_admin, only: %i[new], if: :authenticate_local_admins?
+    before_action :authenticate_local_admin, only: %i[new], if: -> { Koi.config.authenticate_local_admins? }
 
     layout "koi/login"
 
@@ -35,7 +35,9 @@ module Admin
     end
 
     def destroy
-      destroy_admin_session!(current_admin_user)
+      record_sign_out!(current_admin_user)
+
+      session[:admin_user_id] = nil
 
       redirect_to new_admin_session_path
     end
@@ -92,8 +94,21 @@ module Admin
       redirect_to(admin_dashboard_path, status: :see_other)
     end
 
+    def authenticate_local_admin
+      return if admin_signed_in? || !Rails.env.development?
+
+      session[:admin_user_id] =
+        Admin::User.where(email: %W[#{ENV.fetch('USER', nil)}@katalyst.com.au admin@katalyst.com.au]).first&.id
+
+      flash.delete(:redirect) if (redirect = flash[:redirect])
+
+      redirect_to(redirect || admin_dashboard_path, status: :see_other)
+    end
+
     def admin_sign_in(admin_user)
-      create_admin_session!(admin_user)
+      record_sign_in!(admin_user)
+
+      session[:admin_user_id] = admin_user.id
 
       redirect_to(url_from(params[:redirect].presence) || admin_dashboard_path, status: :see_other)
     end

data/app/controllers/admin/tokens_controller.rb

@@ -22,7 +22,9 @@ module Admin
 
     def update
       if (@admin_user = Admin::User.find_by_token_for(:password_reset, params[:token]))
-        create_admin_session!(admin_user)
+        record_sign_in!(admin_user)
+
+        session[:admin_user_id] = admin_user.id
 
         redirect_to admin_admin_user_path(admin_user), status: :see_other, notice: t("koi.auth.token_consumed")
       else
@@ -33,7 +35,7 @@ module Admin
     private
 
     def set_admin_user
-      @admin_user = Admin::User.find(params.expect(:admin_user_id))
+      @admin_user = Admin::User.find(params[:admin_user_id])
     end
   end
 end

data/app/controllers/admin/url_rewrites_controller.rb

@@ -4,68 +4,70 @@ module Admin
   class UrlRewritesController < ApplicationController
     before_action :set_url_rewrite, only: %i[show edit update destroy]
 
+    attr_reader :collection, :url_rewrite
+
     def index
-      collection = Collection.new.with_params(params).apply(UrlRewrite.strict_loading)
+      @collection = Collection.new.with_params(params).apply(UrlRewrite.strict_loading.all)
 
       render locals: { collection: }
     end
 
     def show
-      render :show, locals: { url_rewrite: @url_rewrite }
+      render locals: { url_rewrite: }
     end
 
     def new
       @url_rewrite = UrlRewrite.new
-      render :new, locals: { url_rewrite: @url_rewrite }
+
+      render locals: { url_rewrite: }
     end
 
     def edit
-      render :edit, locals: { url_rewrite: @url_rewrite }
+      render locals: { url_rewrite: }
     end
 
     def create
       @url_rewrite = UrlRewrite.new(url_rewrite_params)
 
       if @url_rewrite.save
-        redirect_to admin_url_rewrite_path(@url_rewrite)
+        redirect_to admin_url_rewrite_path(url_rewrite), status: :see_other
       else
-        render :new, status: :unprocessable_content, locals: { url_rewrite: @url_rewrite }
+        render :new, locals: { url_rewrite: }, status: :unprocessable_content
       end
     end
 
     def update
-      @url_rewrite.attributes = url_rewrite_params
-
-      if @url_rewrite.save
-        redirect_to admin_url_rewrite_path(@url_rewrite)
+      if url_rewrite.update(url_rewrite_params)
+        redirect_to admin_url_rewrite_path(url_rewrite), status: :see_other
       else
-        render :edit, status: :unprocessable_content, locals: { url_rewrite: @url_rewrite }
+        render :edit, locals: { url_rewrite: }, status: :unprocessable_content
       end
     end
 
     def destroy
       @url_rewrite.destroy!
 
-      redirect_to admin_url_rewrites_path
+      redirect_to admin_url_rewrites_path, status: :see_other
     end
 
     private
 
-    def url_rewrite_params
-      params.expect(url_rewrite: %i[from to status_code active])
+    def set_url_rewrite
+      @url_rewrite = ::UrlRewrite.find(params[:id])
     end
 
-    def set_url_rewrite
-      @url_rewrite = UrlRewrite.find(params.expect(:id))
+    def url_rewrite_params
+      params.expect(url_rewrite: %i[from to active status_code])
     end
 
     class Collection < Admin::Collection
-      config.sorting  = "from"
+      config.sorting  = :from
       config.paginate = true
 
       attribute :from, :string
       attribute :to, :string
       attribute :active, :boolean
+      attribute :status_code, :enum
     end
   end
 end

data/app/controllers/admin/well_knowns_controller.rb

@@ -4,58 +4,60 @@ module Admin
   class WellKnownsController < ApplicationController
     before_action :set_well_known, only: %i[show edit update destroy]
 
+    attr_reader :collection, :well_known
+
     def index
-      collection = Collection.new.with_params(params).apply(::WellKnown.strict_loading.all)
+      @collection = Collection.new.with_params(params).apply(WellKnown.strict_loading.all)
 
       render locals: { collection: }
     end
 
     def show
-      render locals: { well_known: @well_known }
+      render locals: { well_known: }
     end
 
     def new
-      render locals: { well_known: ::WellKnown.new }
+      @well_known = WellKnown.new
+
+      render locals: { well_known: }
     end
 
     def edit
-      render locals: { well_known: @well_known }
+      render locals: { well_known: }
     end
 
     def create
-      @well_known = ::WellKnown.new(well_known_params)
+      @well_known = WellKnown.new(well_known_params)
 
       if @well_known.save
-        redirect_to [:admin, @well_known], status: :see_other
+        redirect_to admin_well_known_path(well_known), status: :see_other
       else
-        render :new, locals: { well_known: @well_known }, status: :unprocessable_content
+        render :new, locals: { well_known: }, status: :unprocessable_content
       end
     end
 
     def update
-      if @well_known.update(well_known_params)
-        redirect_to action: :show, status: :see_other
+      if well_known.update(well_known_params)
+        redirect_to admin_well_known_path(well_known), status: :see_other
       else
-        render :edit, locals: { well_known: @well_known }, status: :unprocessable_content
+        render :edit, locals: { well_known: }, status: :unprocessable_content
       end
     end
 
     def destroy
       @well_known.destroy!
 
-      redirect_to action: :index, status: :see_other
+      redirect_to admin_well_knowns_path, status: :see_other
     end
 
     private
 
-    # Only allow a list of trusted parameters through.
-    def well_known_params
-      params.expect(well_known: %i[name purpose content_type content])
+    def set_well_known
+      @well_known = ::WellKnown.find(params[:id])
     end
 
-    # Use callbacks to share common setup or constraints between actions.
-    def set_well_known
-      @well_known = ::WellKnown.find(params.expect(:id))
+    def well_known_params
+      params.expect(well_known: %i[name purpose content_type content])
     end
 
     class Collection < Admin::Collection
@@ -64,7 +66,7 @@ module Admin
 
       attribute :name, :string
       attribute :purpose, :string
-      attribute :content_type, :string
+      attribute :content_type, :enum
       attribute :content, :string
     end
   end

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

@@ -3,46 +3,33 @@
 module Koi
   module Controller
     module RecordsAuthentication
-      def create_admin_session!(admin_user)
-        sign_in_at = Time.current
+      def update_last_sign_in(admin_user)
+        return if admin_user.current_sign_in_at.blank?
 
+        admin_user.last_sign_in_at = admin_user.current_sign_in_at
+        admin_user.last_sign_in_ip = admin_user.current_sign_in_ip
+      end
+
+      def record_sign_in!(admin_user)
         update_last_sign_in(admin_user)
 
-        admin_user.current_sign_in_at = sign_in_at
+        admin_user.current_sign_in_at = Time.current
         admin_user.current_sign_in_ip = request.remote_ip
-        admin_user.sign_in_count     += 1
+        admin_user.sign_in_count += 1
 
         admin_user.save!
-
-        session[:admin_user_id]           = admin_user.id
-        session[:admin_user_signed_in_at] = sign_in_at.iso8601(6)
       end
 
-      def destroy_admin_session!(admin_user)
-        session[:admin_user_id]           = nil
-        session[:admin_user_signed_in_at] = nil
-
+      def record_sign_out!(admin_user)
         return unless admin_user
 
-        sign_out_at = Time.current
-
         update_last_sign_in(admin_user)
 
-        admin_user.last_sign_out_at   = sign_out_at
         admin_user.current_sign_in_at = nil
         admin_user.current_sign_in_ip = nil
 
         admin_user.save!
       end
-
-      private
-
-      def update_last_sign_in(admin_user)
-        return if admin_user.current_sign_in_at.blank?
-
-        admin_user.last_sign_in_at = admin_user.current_sign_in_at
-        admin_user.last_sign_in_ip = admin_user.current_sign_in_ip
-      end
     end
   end
 end

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

@@ -5,12 +5,33 @@ module Koi
     extend ActiveSupport::Concern
 
     included do
-      include Koi::Controller::IsAdminController
+      include HasAdminUsers
+      include HasAttachments
+      include Katalyst::Tables::Backend
+      include ::Pagy::Backend
 
-      authenticate_local_admins Rails.env.development?
+      default_form_builder "Koi::FormBuilder"
+      default_table_component "Koi::TableComponent"
+      default_table_query_component "Koi::TableQueryComponent"
+      default_summary_table_component "Koi::SummaryTableComponent"
 
-      helper Koi::ApplicationHelper
-      helper Koi::DefinitionListHelper
+      # Dependency helpers
+      helper Katalyst::GOVUK::Formbuilder::Frontend
+      helper Katalyst::Navigation::FrontendHelper
+      helper Katalyst::Tables::Frontend
+      helper ::Pagy::Frontend
+
+      # Koi Helpers
+      helper FormHelper
+      helper HeaderHelper
+      helper Pagy::Frontend
+
+      # @deprecated to be removed in Koi 5
+      helper IndexActionsHelper
+
+      layout -> { turbo_frame_request? ? "koi/frame" : "koi/application" }
+
+      protect_from_forgery with: :exception
     end
   end
 end

data/app/controllers/well_knowns_controller.rb

@@ -10,6 +10,6 @@ class WellKnownsController < ApplicationController
   private
 
   def set_well_known
-    @well_known = WellKnown.find_by!(name: params.expect(:name))
+    @well_known = WellKnown.find_by!(name: params[:name])
   end
 end

data/app/helpers/koi/form_helper.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Koi
+  module FormHelper
+    # Ensure that admin forms use `admin_` path helpers.
+    def form_with(model: false, url: nil, format: nil, **, &)
+      if model && (url != false)
+        url ||= if format.nil?
+                  polymorphic_path([:admin, model], {})
+                else
+                  polymorphic_path([:admin, model], format: format)
+                end
+      end
+
+      super
+    end
+  end
+end