katalyst-koi 4.7.3 → 4.8.0

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

@@ -15,14 +15,14 @@ module Koi
 
     def create_controller_files
       template("controller.rb",
-               File.join("app/controllers/admin",
+               File.join("app/controllers",
                          controller_class_path,
                          "#{controller_file_name}_controller.rb"))
     end
 
     def create_spec_files
       template("controller_spec.rb",
-               File.join("spec/requests/admin",
+               File.join("spec/requests",
                          controller_class_path,
                          "#{controller_file_name}_controller_spec.rb"))
     end
@@ -32,6 +32,10 @@ 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}" }

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

@@ -1,76 +1,74 @@
 # frozen_string_literal: true
 
-module Admin
-  class <%= controller_class_name %>Controller < ApplicationController
-    before_action :set_<%= singular_name %>, only: %i[show edit update destroy]
+class <%= controller_class_name %>Controller < ApplicationController
+  before_action :set_<%= singular_name %>, only: %i[show edit update destroy]
 
-    def index
-      collection = Collection.new.with_params(params).apply(::<%= class_name %>.strict_loading.all)
+  def index
+    collection = Collection.new.with_params(params).apply(::<%= class_name %>.strict_loading.all)
 
-      render locals: { collection: }
-    end
+    render locals: { collection: }
+  end
 
-    def show
-      render locals: { <%= singular_name %>: @<%= singular_name %> }
-    end
+  def show
+    render locals: { <%= singular_name %>: @<%= singular_name %> }
+  end
 
-    def new
-      render locals: { <%= singular_name %>: ::<%= class_name %>.new }
-    end
+  def new
+    render locals: { <%= singular_name %>: ::<%= class_name %>.new }
+  end
 
-    def edit
-      render locals: { <%= singular_name %>: @<%= singular_name %> }
-    end
+  def edit
+    render locals: { <%= singular_name %>: @<%= singular_name %> }
+  end
 
-    def create
-      @<%= singular_name %> = ::<%= class_name %>.new(<%= singular_table_name %>_params)
+  def create
+    @<%= singular_name %> = ::<%= class_name %>.new(<%= singular_table_name %>_params)
 
-      if @<%= singular_name %>.save
-        redirect_to [:admin, @<%= singular_name %>], status: :see_other
-      else
-        render :new, locals: { <%= singular_name %>: @<%= singular_name %> }, status: :unprocessable_entity
-      end
+    if @<%= singular_name %>.save
+      redirect_to [:admin, @<%= singular_name %>], status: :see_other
+    else
+      render :new, locals: { <%= singular_name %>: @<%= singular_name %> }, status: :unprocessable_content
     end
+  end
 
-    def update
-      if @<%= singular_name %>.update(<%= singular_table_name %>_params)
-        redirect_to action: :show, status: :see_other
-      else
-        render :edit, locals: { <%= singular_name %>: @<%= singular_name %> }, status: :unprocessable_entity
-      end
+  def update
+    if @<%= singular_name %>.update(<%= singular_table_name %>_params)
+      redirect_to action: :show, status: :see_other
+    else
+      render :edit, locals: { <%= singular_name %>: @<%= singular_name %> }, status: :unprocessable_content
     end
+  end
 
-    def destroy
-      @<%= singular_name %>.destroy!
+  def destroy
+    @<%= singular_name %>.destroy!
 
-      redirect_to action: :index, status: :see_other
-    end
+    redirect_to action: :index, status: :see_other
+  end
 
-    private
+  private
 
-    # Only allow a list of trusted parameters through.
-    def <%= "#{singular_table_name}_params" %>
-      <%- if attributes_names.empty? -%>
-      params.fetch(:<%= singular_table_name %>, {})
-      <%- else -%>
-      params.require(:<%= singular_table_name %>).permit(<%= permitted_params %>)
-      <%- end -%>
-    end
+  # Only allow a list of trusted parameters through.
+  def <%= "#{singular_table_name}_params" %>
+    <%- if attributes_names.empty? -%>
+    params.fetch(:<%= singular_table_name %>, {})
+    <%- else -%>
+    params.require(:<%= singular_table_name %>).permit(<%= permitted_params %>)
+    <%- end -%>
+  end
 
-    # Use callbacks to share common setup or constraints between actions.
-    def set_<%= singular_name %>
-      @<%= singular_name %> = ::<%= class_name %>.find(params[:id])
-    end
+  # Use callbacks to share common setup or constraints between actions.
+  def set_<%= singular_name %>
+    @<%= singular_name %> = ::<%= class_name %>.find(params[:id])
+  end
 
-    class Collection < Katalyst::Tables::Collection::Base
-      attribute :search, :string
+  class Collection < Katalyst::Tables::Collection::Base
+    attribute :search, :string
 
-      config.sorting  = :<%= search_attribute %>
-      config.paginate = true
+    config.sorting  = :<%= search_attribute %>
+    config.paginate = true
 
-      def filter
-        self.items = items.admin_search(search) if search.present?
-      end
+    def filter
+      self.items = items.admin_search(search) if search.present?
     end
   end
 end

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

@@ -2,7 +2,7 @@
 
 require "rails_helper"
 
-RSpec.describe Admin::<%= controller_class_name %>Controller do
+RSpec.describe <%= controller_class_name %>Controller do
   let(:admin) { create(:admin) }
   let(:model) { create(:<%= singular_name %>) }
 

data/lib/generators/koi/admin_views/admin_views_generator.rb

@@ -12,13 +12,13 @@ module Koi
     argument :attributes, type: :array, default: [], banner: "field:type field:type"
 
     def create_root_folder
-      empty_directory File.join("app/views/admin", controller_file_path)
+      empty_directory File.join("app/views", controller_file_path)
     end
 
     def copy_view_files
       available_views.each do |filename|
         target = filename.gsub("record", singular_name)
-        template filename, File.join("app/views/admin", controller_file_path, target)
+        template filename, File.join("app/views", controller_file_path, target)
       end
     end
 
@@ -28,6 +28,10 @@ module Koi
       %w(index.html.erb edit.html.erb show.html.erb new.html.erb _fields.html.erb)
     end
 
+    def controller_class_path
+      ["admin"] + super
+    end
+
     def govuk_input_for(attribute)
       case attribute.type
       when :string
@@ -47,27 +51,6 @@ module Koi
       end
     end
 
-    def summary_attribute_for(attribute)
-      case attribute.type
-      when :string
-        %(<% dl.text :#{attribute.name} %>)
-      when :integer
-        %(<% dl.number :#{attribute.name} %>)
-      when :boolean
-        %(<% dl.boolean :#{attribute.name} %>)
-      when :date
-        %(<% dl.date :#{attribute.name} %>)
-      when :datetime
-        %(<% dl.datetime :#{attribute.name} %>)
-      when :rich_text
-        %(<% dl.rich_text :#{attribute.name} %>)
-      when :attachment
-        %(<% dl.attachment :#{attribute.name} %>)
-      else
-        %(<% dl.text :#{attribute.name} %>)
-      end
-    end
-
     def index_attribute_for(attribute)
       case attribute.type
       when :integer
@@ -87,6 +70,8 @@ module Koi
       end
     end
 
+    alias_method :summary_attribute_for, :index_attribute_for
+
     def index_attributes
       attributes
     end

data/lib/generators/koi/admin_views/templates/edit.html.erb.tt

@@ -2,7 +2,7 @@
   <%%= render(Koi::Header::EditComponent.new(resource: <%= singular_name %>)) %>
 <%% end %>
 
-<%%= form_with(model: <%= singular_name %>, url: [:admin, <%= singular_name %>], builder: Koi::FormBuilder) do |form| %>
+<%%= form_with(model: <%= singular_name %>, url: <%= show_helper(singular_name, type: :path) %>) do |form| %>
   <%%= render "fields", form: %>
 
   <div class="actions">

data/lib/generators/koi/admin_views/templates/index.html.erb.tt

@@ -5,13 +5,13 @@
 <%%= koi_index_actions create: true, search: true %>
 
 <%%= table_with(collection:) do |row, <%= singular_name %>| %>
-    <% index_attributes.each_with_index do |attribute, index| %>
-    <% if index.zero? %>
-    <%% row.link :<%= attribute.name %> %>
-    <% else %>
-    <%= index_attribute_for attribute %>
-    <% end %>
-    <% end %>
+  <%- index_attributes.each_with_index do |attribute, index| -%>
+  <%- if index.zero? -%>
+  <%% row.link :<%= attribute.name %> %>
+  <%- else -%>
+  <%= index_attribute_for attribute %>
+  <%- end -%>
+  <%- end -%>
 <%% end %>
 
 <%%== pagy_nav(collection.pagination) %>

data/lib/generators/koi/admin_views/templates/new.html.erb.tt

@@ -2,7 +2,7 @@
   <%%= render(Koi::Header::NewComponent.new(model: <%= class_name %>)) %>
 <%% end %>
 
-<%%= form_with(model: <%= singular_name %>, url: [:admin, <%= class_name %>], builder: Koi::FormBuilder) do |form| %>
+<%%= form_with(model: <%= singular_name %>, url: <%= index_helper(type: :path) %>) do |form| %>
   <%%= render "fields", form: %>
 
   <div class="actions">

data/lib/generators/koi/admin_views/templates/show.html.erb.tt

@@ -4,14 +4,18 @@
 
 <h2>Summary</h2>
 
-<%%= render Koi::SummaryListComponent.new(model: <%= singular_name %>) do |dl| %>
-<%- attributes.each do |attribute| -%>
+<%%= summary_table_with(model: <%= singular_name %>) do |row| %>
+  <%- attributes.each_with_index do |attribute, index| -%>
+  <%- if index.zero? -%>
+  <%% row.link :<%= attribute.name %> %>
+  <%- else -%>
   <%= summary_attribute_for attribute %>
-<%- end -%>
+  <%- end -%>
+  <%- end -%>
 <%% end %>
 
 <div class="actions">
-  <%%= button_to "Delete", [:admin, <%= singular_name %>],
+  <%%= button_to "Delete", <%= show_helper(singular_name, type: :path) %>,
                 class:  "button button--secondary",
                 method: :delete,
                 form:   { data: { turbo_confirm: "Are you sure?" } } %>

data/lib/govuk_design_system_formbuilder/elements/document.rb

@@ -8,8 +8,8 @@ module GOVUKDesignSystemFormBuilder
       include FileElement
 
       def initialize(builder, object_name, attribute_name, hint:, label:, caption:, form_group:, mime_types:,
-                     **kwargs, &block)
-        super(builder, object_name, attribute_name, &block)
+                     **kwargs, &)
+        super(builder, object_name, attribute_name, &)
 
         @mime_types      = mime_types
         @label           = label
@@ -59,10 +59,10 @@ module GOVUKDesignSystemFormBuilder
                              hint: {},
                              form_group: {},
                              mime_types: Koi.config.document_mime_types,
-                             **kwargs,
-                             &block)
+                             **,
+                             &)
       Elements::Document.new(
-        self, object_name, attribute_name, label:, caption:, hint:, form_group:, mime_types:, **kwargs, &block
+        self, object_name, attribute_name, label:, caption:, hint:, form_group:, mime_types:, **, &
       ).html
     end
   end

data/lib/govuk_design_system_formbuilder/elements/image.rb

@@ -9,8 +9,8 @@ module GOVUKDesignSystemFormBuilder
       include FileElement
 
       def initialize(builder, object_name, attribute_name, hint:, label:, caption:, form_group:, mime_types:,
-                     **kwargs, &block)
-        super(builder, object_name, attribute_name, &block)
+                     **kwargs, &)
+        super(builder, object_name, attribute_name, &)
 
         @mime_types      = mime_types
         @label           = label
@@ -89,10 +89,10 @@ module GOVUKDesignSystemFormBuilder
                           hint: {},
                           form_group: {},
                           mime_types: Koi.config.image_mime_types,
-                          **kwargs,
-                          &block)
+                          **,
+                          &)
       Elements::Image.new(
-        self, object_name, attribute_name, label:, caption:, hint:, form_group:, mime_types:, **kwargs, &block
+        self, object_name, attribute_name, label:, caption:, hint:, form_group:, mime_types:, **, &
       ).html
     end
   end

data/lib/koi/form_builder.rb

@@ -7,31 +7,31 @@ module Koi
     include GOVUKDesignSystemFormBuilder::Builder
 
     # Generates a submit button for saving admin resources.
-    def admin_save(text = "Save", name: :commit, value: :save, class: "button button--primary", **kwargs)
-      button(text, name:, value:, class:, **kwargs)
+    def admin_save(text = "Save", name: :commit, value: :save, class: "button button--primary", **)
+      button(text, name:, value:, class:, **)
     end
 
     # Generates a delete link formatted as a button that will perform a turbo
     # delete with a confirmation.
-    def admin_delete(text = "Delete", url: nil, confirm: "Are you sure?", data: {}, **kwargs)
+    def admin_delete(text = "Delete", url: nil, confirm: "Are you sure?", data: {}, **)
       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),
-              **kwargs)
+              **)
     end
 
     # Generates an archive link formatted as a button that will perform a turbo
     # delete with a confirmation.
-    def admin_archive(text = "Archive", **kwargs)
-      admin_delete(text, **kwargs)
+    def admin_archive(text = "Archive", **)
+      admin_delete(text, **)
     end
 
     # 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, **kwargs)
-      link_to(text, url, class: "button button--text", **kwargs)
+    def admin_discard(text = "Discard", url: :back, **)
+      link_to(text, url, class: "button button--text", **)
     end
 
     # @api internal
@@ -42,7 +42,7 @@ module Koi
         hint[:text] ||= t("helpers.hint.default.document", max_size: @template.number_to_human_size(max_size))
       end
 
-      super(attribute_name, hint:, **, &)
+      super
     end
 
     # @api internal
@@ -53,20 +53,20 @@ module Koi
         hint[:text] ||= t("helpers.hint.default.document", max_size: @template.number_to_human_size(max_size))
       end
 
-      super(attribute_name, hint:, **, &)
+      super
     end
 
     # Use content editor trix setup by default.
     #
     # @api internal
     # @see GOVUKDesignSystemFormBuilder::Builder#govuk_rich_text_area
-    def govuk_rich_text_area(attribute_name, data: {}, **kwargs, &block)
+    def govuk_rich_text_area(attribute_name, data: {}, **, &)
       data = data.reverse_merge(
         direct_upload_url: @template.katalyst_content.direct_uploads_url,
         controller:        "content--editor--trix",
         action:            "trix-initialize->content--editor--trix#trixInitialize",
       )
-      super(attribute_name, data:, **kwargs, &block)
+      super
     end
   end
 end

data/lib/koi/menu/builder.rb

@@ -27,10 +27,10 @@ module Koi
         end
       end
 
-      def add_menu(title:, **options, &)
+      def add_menu(title:, **, &)
         @menu.items.build(type:  Katalyst::Navigation::Heading.name,
                           title:,
-                          **options,
+                          **,
                           index: @index,
                           depth: @depth)
         @index += 1
@@ -39,21 +39,21 @@ module Koi
         @depth -= 1
       end
 
-      def add_link(title:, url:, **options)
+      def add_link(title:, url:, **)
         @menu.items.build(type:  Katalyst::Navigation::Link.name,
                           title:,
                           url:,
-                          **options,
+                          **,
                           index: @index,
                           depth: @depth)
         @index += 1
       end
 
-      def add_button(title:, url:, **options)
+      def add_button(title:, url:, **)
         @menu.items.build(type:  Katalyst::Navigation::Button.name,
                           title:,
                           url:,
-                          **options,
+                          **,
                           index: @index,
                           depth: @depth)
         @index += 1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-koi
 version: !ruby/object:Gem::Version
-  version: 4.7.3
+  version: 4.8.0
 platform: ruby
 authors:
 - Katalyst Interactive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-30 00:00:00.000000000 Z
+date: 2024-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -260,6 +260,7 @@ files:
 - app/assets/javascripts/koi/controllers/keyboard_controller.js
 - app/assets/javascripts/koi/controllers/navigation_controller.js
 - app/assets/javascripts/koi/controllers/navigation_toggle_controller.js
+- app/assets/javascripts/koi/controllers/pagy_nav_controller.js
 - app/assets/javascripts/koi/controllers/show_hide_controller.js
 - app/assets/javascripts/koi/controllers/sluggable_controller.js
 - app/assets/javascripts/koi/controllers/webauthn_authentication_controller.js
@@ -272,17 +273,16 @@ files:
 - app/assets/stylesheets/koi/base/_input.scss
 - app/assets/stylesheets/koi/base/_link.scss
 - app/assets/stylesheets/koi/base/_list.scss
+- app/assets/stylesheets/koi/base/_tables.scss
 - app/assets/stylesheets/koi/base/_typography.scss
 - app/assets/stylesheets/koi/components/_actions-group.scss
 - app/assets/stylesheets/koi/components/_clipboard.scss
 - app/assets/stylesheets/koi/components/_document-field.scss
 - app/assets/stylesheets/koi/components/_image-field.scss
 - app/assets/stylesheets/koi/components/_index-actions.scss
-- app/assets/stylesheets/koi/components/_index-table.scss
 - app/assets/stylesheets/koi/components/_index.scss
 - app/assets/stylesheets/koi/components/_pagy.scss
 - app/assets/stylesheets/koi/components/_summary-list.scss
-- app/assets/stylesheets/koi/components/index-table/_ordinal.scss
 - app/assets/stylesheets/koi/layouts/_banner.scss
 - app/assets/stylesheets/koi/layouts/_content.scss
 - app/assets/stylesheets/koi/layouts/_flash.scss
@@ -303,6 +303,7 @@ files:
 - app/assets/stylesheets/koi/utils/_hide.scss
 - app/assets/stylesheets/koi/utils/_index.scss
 - app/assets/stylesheets/koi/utils/_typography.scss
+- app/components/concerns/koi/tables/cells.rb
 - app/components/koi/content/editor/errors_component.html.erb
 - app/components/koi/content/editor/errors_component.rb
 - app/components/koi/content/editor/item_form_component.html.erb
@@ -326,7 +327,10 @@ files:
 - app/components/koi/summary_list/text_component.rb
 - app/components/koi/summary_list_component.html.erb
 - app/components/koi/summary_list_component.rb
+- app/components/koi/summary_table_component.rb
+- app/components/koi/table_component.rb
 - app/components/koi/tables/cells/attachment_component.rb
+- app/components/koi/tables/cells/enum_component.rb
 - app/components/koi/tables/cells/link_component.rb
 - app/components/koi/tables/table_component.rb
 - app/controllers/admin/admin_users_controller.rb
@@ -346,6 +350,7 @@ files:
 - app/helpers/koi/date_helper.rb
 - app/helpers/koi/definition_list_helper.rb
 - app/helpers/koi/index_actions_helper.rb
+- app/helpers/koi/pagy.rb
 - app/jobs/koi/application_job.rb
 - app/mailers/koi/application_mailer.rb
 - app/models/admin/credential.rb

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

@@ -1,147 +0,0 @@
-@use "index-table/ordinal" as *;
-
-@mixin sort-icon {
-  display: inline-block;
-  content: " ";
-  position: relative;
-  right: -1rem;
-  background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 13'%3E%3Cpath d='M.541 0l11.125 12.573a.5.5 0 00.749 0L23.541 0h-23z' fill='%23000' fill-rule='evenodd'/%3E%3C/svg%3E");
-  background-size: 14px 14px;
-  height: 14px;
-  width: 14px;
-}
-
-$grey: #f0ecf3 !default;
-
-$table-header-color: transparent !default;
-$row-border-color: $grey !default;
-$row-height: 48px !default;
-$cell-spacing: 0.5rem !default;
-
-$width-small: 6rem !default;
-$width-medium: 12rem !default;
-$width-large: 16rem !default;
-
-.index-table {
-  --row-height: #{$row-height};
-  --cell-spacing: #{$cell-spacing};
-  --table-header-color: #{$table-header-color};
-  --row-border-color: #{$row-border-color};
-
-  --width-small: #{$width-small};
-  --width-medium: #{$width-medium};
-  --width-large: #{$width-large};
-}
-
-.index-table {
-  border: none;
-  table-layout: fixed;
-  border-collapse: collapse;
-  text-align: left;
-  width: 100%;
-
-  thead {
-    background: var(--table-header-color);
-  }
-
-  tr {
-    height: var(--row-height);
-    line-height: var(--row-height);
-  }
-
-  th,
-  td {
-    border: none;
-    box-shadow: inset 0px -1px 0px var(--row-border-color);
-    overflow: hidden;
-    text-overflow: ellipsis;
-    vertical-align: top;
-    white-space: nowrap;
-    background-color: white;
-    padding-right: var(--cell-spacing);
-
-    &:last-child {
-      padding-right: 0;
-    }
-
-    > a {
-      display: block;
-      overflow: hidden;
-      white-space: nowrap;
-      text-overflow: ellipsis;
-      text-decoration: none;
-    }
-
-    > img,
-    > a > img {
-      max-height: 3rem;
-      padding: 0;
-    }
-
-    > .trix-content {
-      overflow: hidden;
-      text-overflow: ellipsis;
-    }
-  }
-
-  th {
-    font-weight: bold;
-  }
-
-  thead th {
-    // types defined first so they can be overridden with width classes
-    &.type-boolean,
-    &.type-number {
-      width: var(--width-small);
-    }
-
-    &.type-date,
-    &.type-currency {
-      width: var(--width-medium);
-    }
-
-    &.type-datetime {
-      width: var(--width-large);
-    }
-
-    &.width-s {
-      width: var(--width-small);
-    }
-
-    &.width-m {
-      width: var(--width-medium);
-    }
-
-    &.width-l {
-      width: var(--width-large);
-    }
-  }
-
-  td {
-    &.type-currency,
-    &.type-number {
-      text-align: right;
-    }
-  }
-
-  thead a.ascending:after,
-  [data-sort="asc"] a::after {
-    @include sort-icon;
-    top: 0;
-    transform: rotate(180deg);
-  }
-
-  thead a.descending:after,
-  [data-sort="desc"] a::after {
-    @include sort-icon;
-    top: 4px;
-  }
-
-  .button_to {
-    line-height: 1.5;
-  }
-
-  caption {
-    margin: 2rem 0;
-  }
-}