katalyst-koi 4.0.0

data/app/assets/stylesheets/koi/themes/_content.scss

@@ -0,0 +1,5 @@
+@use "katalyst/content/editor";
+
+[data-controller="content--editor--container"] {
+  --heading--h4: 1rem;
+}

data/app/assets/stylesheets/koi/themes/_govuk.scss

@@ -0,0 +1,52 @@
+@use "../utils/typography" as *;
+
+@function govuk-definition($size) {
+  @return (
+    null: (
+      font-size: font-size($size, mobile, px),
+      line-height: line-height($size, mobile, px),
+    ),
+    tablet: (
+      font-size: font-size($size, tablet, px),
+      line-height: line-height($size, tablet, px),
+    ),
+    print: (
+      font-size: font-size($size, print, px),
+      line-height: line-height($size, print, px),
+    )
+  );
+}
+
+$govuk-font-family: "Inter";
+$govuk-text-colour: #{var(--site-text-color)};
+$govuk-typography-scale: (
+  80: govuk-definition(h1),
+  48: govuk-definition(h2),
+  36: govuk-definition(h3),
+  27: govuk-definition(h4),
+  24: govuk-definition(h5),
+  19: govuk-definition(h6),
+  16: govuk-definition(paragraph),
+  14: govuk-definition(small),
+);
+
+$govuk-input-border-colour: #{var(--site-text-color)};
+
+@import "katalyst/govuk/formbuilder";
+
+.govuk-input,
+.govuk-textarea {
+  color: $govuk-text-colour;
+}
+
+.govuk-hint {
+  max-width: var(--text-width);
+}
+
+// in the context of Koi admin forms, hang the error border in the gutter
+// not a generally applicable style
+.govuk-form-group--error {
+  position: relative;
+  margin-left: -18px;
+  padding-left: 13px;
+}

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

@@ -0,0 +1,5 @@
+@use "content";
+@use "govuk";
+@use "kpop";
+@use "navigation";
+@use "trix";

data/app/assets/stylesheets/koi/themes/_kpop.scss

@@ -0,0 +1,5 @@
+@use "katalyst/kpop";
+
+.kpop-content {
+  padding: 1rem 1.5rem;
+}

data/app/assets/stylesheets/koi/themes/_navigation.scss

@@ -0,0 +1,5 @@
+@use "katalyst/navigation/editor";
+
+[data-controller="navigation--editor--menu"] {
+  --heading--h4: 1rem;
+}

data/app/assets/stylesheets/koi/themes/_trix.scss

@@ -0,0 +1,32 @@
+// navigation and content already load trix, ensure they are loaded first
+@use "content";
+@use "navigation";
+
+// overrides for default trix styles to match our button styles
+trix-toolbar {
+  .trix-button-group {
+    border: 1px solid var(--site-text-color);
+    border-radius: 0;
+  }
+
+  .trix-button {
+    color: var(--site-secondary);
+    border-bottom: none;
+  }
+
+  .trix-button:not(:first-child) {
+    border-left: 1px solid var(--site-text-color);
+  }
+
+  .trix-button.trix-active {
+    background-color: var(--site-secondary-light);
+    color: var(--site-on-secondary);
+    border-bottom: none;
+  }
+}
+
+// set a maximim width for the text editor and toolbar to match other inputs
+trix-toolbar,
+trix-editor {
+  max-width: var(--text-width);
+}

data/app/assets/stylesheets/koi/utils/_breakpoints.scss

@@ -0,0 +1,13 @@
+// At a 16px base font size this will be 640px (to match govuk)
+@mixin tablet-breakpoint {
+  @media screen and (max-width: 40rem) {
+    @content;
+  }
+}
+
+// At a 16px base font size this will be 1120px
+@mixin laptop-breakpoint {
+  @media screen and (max-width: 70rem) {
+    @content;
+  }
+}

data/app/assets/stylesheets/koi/utils/_hide.scss

@@ -0,0 +1,11 @@
+.hidden,
+[hidden],
+[data-hide] {
+  display: none !important;
+}
+
+[data-collapsed] {
+  max-height: 0;
+  overflow: hidden;
+  margin-bottom: 0 !important;
+}

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

@@ -0,0 +1,2 @@
+@use "breakpoints";
+@use "hide";

data/app/assets/stylesheets/koi/utils/_typography.scss

@@ -0,0 +1,24 @@
+@use "sass:math";
+
+$-font-sizes: () !default;
+$-line-heights: () !default;
+
+@function font-size($size, $breakpoint: null, $unit: rem) {
+  $font-size: map-get($-font-sizes, $size);
+
+  @if $unit == rem {
+    @return $font-size;
+  } @else if $unit == px {
+    @return math.div($font-size, 1rem) * 16px;
+  }
+}
+
+@function line-height($size, $breakpoint: null, $unit: em) {
+  $line-height: map-get($-line-heights, $size);
+
+  @if $unit == em {
+    @return $line-height;
+  } @else if $unit == px {
+    @return math.div($line-height, 1em) * 16px;
+  }
+}

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Koi
+  module Header
+    class EditComponent < ViewComponent::Base
+      attr_reader :model, :resource
+
+      delegate :with_breadcrumb, :with_action, to: :@header
+
+      def initialize(resource:, title: nil)
+        super
+
+        @resource = resource
+        @title = title
+
+        @header = HeaderComponent.new(title: self.title)
+      end
+
+      def call
+        render @header do |header|
+          # capture nested component
+          @header = header
+
+          # render block, if any (delegating slots to header)
+          content
+
+          # add our breadcrumbs and actions
+          add_index(header)
+          add_show(header)
+        end
+      end
+
+      def title
+        @title || "Edit #{resource.model_name.human.downcase}"
+      end
+
+      def resource_title
+        title = Koi.config.resource_name_candidates.reduce(nil) do |name, key|
+          name || resource.respond_to?(key) && resource.public_send(key)
+        end
+
+        title.presence || resource.model_name.human
+      end
+
+      def add_index(header)
+        header.with_breadcrumb(resource.model_name.human.pluralize, url_for(action: :index))
+      rescue ActionController::UrlGenerationError
+        nil
+      end
+
+      def add_show(header)
+        header.with_breadcrumb(resource_title, url_for(action: :show))
+      rescue ActionController::UrlGenerationError
+        nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Koi
+  module Header
+    class IndexComponent < ViewComponent::Base
+      attr_reader :model
+
+      delegate :with_breadcrumb, :with_action, to: :@header
+
+      def initialize(model:, title: model.model_name.human.pluralize)
+        super
+
+        @header = HeaderComponent.new(title:)
+        @model  = model
+        @title  = title
+      end
+
+      def call
+        render @header.with_content(content || "")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Koi
+  module Header
+    class NewComponent < ViewComponent::Base
+      attr_reader :model
+
+      delegate :with_breadcrumb, :with_action, to: :@header
+
+      def initialize(model:, title: nil)
+        super
+
+        @model  = model
+        @title  = title
+
+        @header = HeaderComponent.new(title: self.title)
+      end
+
+      def call
+        render @header do |header|
+          # render block, if any (delegating slots to header)
+          content
+
+          # add our breadcrumbs and actions
+          add_index(header)
+        end
+      end
+
+      def title
+        @title || "New #{model.model_name.human.downcase}"
+      end
+
+      def add_index(header)
+        header.with_breadcrumb(model.model_name.human.pluralize, url_for(action: :index))
+      rescue ActionController::UrlGenerationError
+        nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Koi
+  module Header
+    class ShowComponent < ViewComponent::Base
+      attr_reader :resource
+
+      delegate :with_breadcrumb, :with_action, to: :@header
+
+      def initialize(resource:, title: nil)
+        super
+
+        @title    = title
+        @resource = resource
+
+        @header = HeaderComponent.new(title: self.title)
+      end
+
+      def call
+        render @header do |header|
+          # render block, if any (delegating slots to header)
+          content
+
+          # add our breadcrumbs and actions
+          add_index(header)
+          add_edit(header)
+        end
+      end
+
+      def title
+        title = Koi.config.resource_name_candidates.reduce(@title) do |name, key|
+          name || resource.respond_to?(key) && resource.public_send(key)
+        end
+
+        title.presence || resource.model_name.human
+      end
+
+      def add_index(header)
+        header.with_breadcrumb(resource.model_name.human.pluralize, url_for(action: :index))
+      rescue ActionController::UrlGenerationError
+        nil
+      end
+
+      def add_edit(header)
+        header.with_action("Edit", url_for(action: :edit))
+      rescue ActionController::UrlGenerationError
+        nil
+      end
+    end
+  end
+end

data/app/components/koi/header_component.html.erb

@@ -0,0 +1,16 @@
+<% content_for :title, @title %>
+<header>
+  <h1 class="heading"><%= @title %></h1>
+
+  <div class="breadcrumbs" role="navigation" aria-label="Breadcrumbs">
+    <% breadcrumbs.each do |breadcrumb| %>
+      <%= breadcrumb %>
+    <% end %>
+  </div>
+
+  <div class="actions" role="navigation" aria-label="Related pages">
+    <% actions.each do |action| %>
+      <%= action %>
+    <% end %>
+  </div>
+</header>

data/app/components/koi/header_component.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Koi
+  class HeaderComponent < ViewComponent::Base
+    renders_many :actions, "LinkComponent"
+    renders_many :breadcrumbs, "LinkComponent"
+
+    def initialize(title:)
+      super
+
+      @title = title
+    end
+
+    class LinkComponent < ViewComponent::Base
+      def initialize(name, path, **options)
+        super
+
+        @name    = name
+        @path    = path
+        @options = options
+      end
+
+      def call
+        link_to @name, @path, **@options
+      end
+    end
+  end
+end

data/app/components/koi/index_table_component.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Koi
+  class IndexTableComponent < ViewComponent::Base
+    attr_reader :table, :pagination, :id, :pagy_id
+
+    def initialize(collection:, id: "index-table", **options)
+      super
+
+      @id = id
+      @pagy_id = "#{id}-pagination"
+      @table = Katalyst::Turbo::TableComponent.new(collection:, id:, class: "index-table", caption: true, **options)
+      @pagination = Katalyst::Turbo::PagyNavComponent.new(collection:, id: pagy_id) if collection.paginate?
+    end
+
+    def call
+      concat(table.render_in(view_context))
+      concat(pagination.render_in(view_context)) if pagination
+    end
+  end
+end

data/app/controllers/admin/admin_users_controller.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Admin
+  class AdminUsersController < ApplicationController
+    before_action :set_admin, only: %i[show edit update destroy]
+
+    attr_reader :admin
+
+    def index
+      collection = Collection.new.with_params(params).apply(Admin::User.strict_loading)
+      table      = Koi::IndexTableComponent.new(collection:)
+
+      respond_to do |format|
+        format.turbo_stream { render(table) } if self_referred?
+        format.html { render :index, locals: { table:, collection: } }
+      end
+    end
+
+    def show
+      render :show, locals: { admin: }
+    end
+
+    def new
+      @admin = Admin::User.new
+
+      render :new, locals: { admin: }
+    end
+
+    def edit
+      render :edit, locals: { admin: }
+    end
+
+    def create
+      admin = Admin::User.new(admin_user_params)
+
+      if admin.save
+        redirect_to admin_admin_user_path(admin)
+      else
+        render :new, locals: { admin: }, status: :unprocessable_entity
+      end
+    end
+
+    def update
+      if admin.update(admin_user_params)
+        redirect_to action: :show
+      else
+        render :edit, locals: { admin: }, status: :unprocessable_entity
+      end
+    end
+
+    def destroy
+      admin.destroy
+
+      redirect_to admin_admin_users_path
+    end
+
+    private
+
+    def set_admin
+      @admin = Admin::User.with_archived.find(params[:id])
+    end
+
+    def admin_user_params
+      params.require(:admin).permit(:name, :email, :password, :archived)
+    end
+
+    class Collection < Katalyst::Tables::Collection::Base
+      attribute :search, :string, default: ""
+      attribute :scope, :string, default: "active"
+
+      config.sorting  = :name
+      config.paginate = true
+
+      def filter
+        self.items = items.admin_search(search) if search.present?
+
+        self.items = case scope&.to_sym
+                     when :archived
+                       items.archived
+                     when :all
+                       items.with_archived
+                     else
+                       items
+                     end
+      end
+    end
+  end
+end

data/app/controllers/admin/application_controller.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Admin
+  class ApplicationController < ActionController::Base
+    include Koi::Controller::IsAdminController
+
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/admin/caches_controller.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Admin
+  class CachesController < ApplicationController
+    def destroy
+      Rails.logger.warn("[CACHE CLEAR] - Cleaning entire cache manually by #{current_admin} request")
+      Rails.cache.clear
+      redirect_back(fallback_location: admin_dashboard_path)
+    end
+  end
+end

data/app/controllers/admin/credentials_controller.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Admin
+  class CredentialsController < ApplicationController
+    include Koi::Controller::HasWebauthn
+
+    layout "kpop"
+
+    def new
+      unless current_admin.webauthn_id
+        current_admin.update!(webauthn_id: WebAuthn.generate_user_id)
+      end
+
+      options = webauthn_relying_party.options_for_registration(
+        user:    {
+          id:           current_admin.webauthn_id,
+          name:         current_admin.email,
+          display_name: current_admin.to_s,
+        },
+        exclude: current_admin.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: { options: }
+    end
+
+    def create
+      redirect_to(action: :new) if session[:creation_challenge].blank?
+
+      webauthn_credential = webauthn_relying_party.verify_registration(
+        JSON.parse(credential_params[:response]),
+        session.delete(:creation_challenge),
+      )
+
+      credential = current_admin.credentials.find_or_initialize_by(
+        external_id: webauthn_credential.id,
+      )
+
+      credential.update!(
+        nickname:   credential_params[:nickname],
+        public_key: webauthn_credential.public_key,
+        sign_count: webauthn_credential.sign_count,
+      )
+
+      redirect_to admin_admin_user_path(current_admin), status: :see_other
+    end
+
+    def destroy
+      credential = current_admin.credentials.find(params[:id])
+      credential.destroy!
+
+      redirect_to admin_admin_user_path(current_admin), status: :see_other
+    end
+
+    private
+
+    def credential_params
+      params.require(:admin_credential).permit(:nickname, :response)
+    end
+  end
+end

data/app/controllers/admin/dashboards_controller.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Admin
+  class DashboardsController < ApplicationController
+    def show; end
+  end
+end

data/app/controllers/admin/sessions_controller.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Admin
+  class SessionsController < ApplicationController
+    include Koi::Controller::HasWebauthn
+
+    skip_before_action :authenticate_admin, only: %i[new create]
+
+    layout "koi/login"
+
+    def new
+      return redirect_to admin_dashboard_path if admin_signed_in?
+
+      render :new, locals: { admin_user: Admin::User.new }
+    end
+
+    def create
+      if (admin_user = webauthn_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"
+      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: }
+      end
+    end
+
+    def destroy
+      record_sign_out!(current_admin_user)
+
+      session[:admin_user_id] = nil
+
+      redirect_to admin_dashboard_path, notice: "You have been logged out"
+    end
+
+    private
+
+    def session_params
+      params.require(:admin).permit(:email, :password, :response)
+    end
+
+    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 = Time.current
+      admin_user.current_sign_in_ip = request.remote_ip
+      admin_user.sign_in_count      = admin_user.sign_in_count + 1
+
+      admin_user.save!
+    end
+
+    def record_sign_out!(admin_user)
+      update_last_sign_in(admin_user)
+
+      admin_user.current_sign_in_at = nil
+      admin_user.current_sign_in_ip = nil
+
+      admin_user.save!
+    end
+  end
+end