katalyst-koi 4.8.0 → 4.9.0

data/app/components/koi/table_query_component.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Koi
+  class TableQueryComponent < Katalyst::Tables::QueryComponent
+    def call
+      content_tag(:"koi-toolbar") do
+        render_parent
+      end
+    end
+
+    private
+
+    using Katalyst::HtmlAttributes::HasHtmlAttributes
+
+    def default_html_attributes
+      super.merge_html(data: { action: %w[
+                         shortcut:search@document->tables--query#focus
+                       ] })
+    end
+  end
+end

data/app/controllers/admin/admin_users_controller.rb

@@ -60,25 +60,15 @@ module Admin
       params.require(:admin).permit(:name, :email, :password, :archived)
     end
 
-    class Collection < Katalyst::Tables::Collection::Base
-      attribute :search, :string, default: ""
-      attribute :scope, :string, default: "active"
-
+    class Collection < Admin::Collection
       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
+      attribute :name, :string
+      attribute :email, :string
+      attribute :status, :archivable, default: :active
+      attribute :last_sign_in_at, :date
+      attribute :sign_in_count, :integer
     end
   end
 end

data/app/controllers/admin/url_rewrites_controller.rb

@@ -59,25 +59,13 @@ module Admin
       @url_rewrite = UrlRewrite.find(params[:id])
     end
 
-    class Collection < Katalyst::Tables::Collection::Base
-      attribute :search, :string, default: ""
-      attribute :scope, :string, default: "active"
-
+    class Collection < Admin::Collection
       config.sorting  = "from"
       config.paginate = true
 
-      def filter
-        self.items = items.admin_search(search) if search.present?
-
-        self.items = case scope&.to_sym
-                     when :active
-                       items.where(active: true)
-                     when :inactive
-                       items.where(active: false)
-                     else
-                       items
-                     end
-      end
+      attribute :from, :string
+      attribute :to, :string
+      attribute :active, :boolean
     end
   end
 end

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

@@ -12,7 +12,7 @@ module Koi
       def webauthn_relying_party
         @webauthn_relying_party ||=
           WebAuthn::RelyingParty.new(
-            name:   "Koi Admin",
+            name:   Koi.config.admin_name,
             origin: request.base_url,
           )
       end

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

@@ -19,6 +19,7 @@ module Koi
 
         default_form_builder "Koi::FormBuilder"
         default_table_component Koi::TableComponent
+        default_table_query_component Koi::TableQueryComponent
         default_summary_table_component Koi::SummaryTableComponent
 
         helper Katalyst::GOVUK::Formbuilder::Frontend

data/app/helpers/koi/index_actions_helper.rb

@@ -71,7 +71,7 @@ module Koi
       form.search_field(:search,
                         placeholder: t("koi.labels.search", default: "Search"),
                         value:       params[:search],
-                        data:        { index_actions_target: "search" })
+                        data:        { index_actions_target: "search", turbo_permanent: "" })
     end
 
     def links(form, &)

data/app/models/admin/collection.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Admin
+  class Collection < Katalyst::Tables::Collection::Base
+    include Katalyst::Tables::Collection::Query
+
+    attribute :search, :search, scope: :admin_search
+  end
+end

data/app/models/concerns/koi/model/archivable.rb

@@ -2,6 +2,27 @@
 
 module Koi
   module Model
+    # Add support for archiving using an `:archived_at` column. Adds scopes for
+    # including/excluding collection elements based on whether they have an
+    # archived_at date set or not.
+    #
+    # Usage:
+    # Include this module in your model and add the `archived_at` column via a
+    # migration.
+    #
+    # Examples:
+    #     Model.all # default scope, excludes archived
+    #     Model.archived # only returns archived records
+    #     Model.with_archived # returns all records
+    #
+    # Filtering:
+    # Use the custom `:archivable` enum attribute in Admin::Collections to
+    # filter on this property, e.g.
+    #
+    #     attribute :status, :archivable, default: :active
+    #
+    # Note: although it's theoretically possible to archive something in the
+    # future, this module does not support queries using dates.
     module Archivable
       extend ActiveSupport::Concern
 
@@ -10,6 +31,17 @@ module Koi
         scope :archived, -> { unscope(where: :archived_at).where.not(archived_at: nil) }
         scope :with_archived, -> { unscope(where: :archived_at) }
 
+        scope :status, ->(status) do
+          case status.to_s
+          when "active"
+            not_archived
+          when "archived"
+            archived
+          else
+            with_archived
+          end
+        end
+
         default_scope { not_archived }
 
         alias_method :archived?, :archived

data/app/views/admin/admin_users/index.html.erb

@@ -1,10 +1,10 @@
 <% content_for :header do %>
-  <%= render Koi::Header::IndexComponent.new(model: Admin::User) %>
+  <%= render Koi::Header::IndexComponent.new(model: Admin::User) do |component| %>
+    <% component.with_action "New", new_admin_admin_user_path %>
+  <% end %>
 <% end %>
 
-<%= koi_index_actions create: true, search: true do %>
-  <%= select_tag(:scope, options_for_select([["Active", :active], ["All", :all], ["Archived", :archived]], params[:scope])) %>
-<% end %>
+<%= table_query_with(collection:) %>
 
 <%= table_with(collection:) do |row, admin| %>
   <%= row.link :name, url: :admin_admin_user_path %>

data/app/views/admin/url_rewrites/index.html.erb

@@ -1,11 +1,11 @@
 <%# locals: { table:, collection } %>
 <% content_for :header do %>
-  <%= render Koi::Header::IndexComponent.new(model: UrlRewrite) %>
+  <%= render Koi::Header::IndexComponent.new(model: UrlRewrite) do |component| %>
+    <% component.with_action "New", new_admin_url_rewrite_path %>
+  <% end %>
 <% end %>
 
-<%= koi_index_actions create: true, search: true do |form| %>
-  <%= select_tag(:scope, options_for_select([["Active", :active], ["All", :all], ["Inactive", :inactive]], params[:scope])) %>
-<% end %>
+<%= table_query_with(collection:) %>
 
 <%= table_with(collection:) do |row, url_rewrite| %>
   <%= row.link :from, url: [:admin, url_rewrite] %>

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

@@ -5,7 +5,7 @@
   <meta charset="UTF-8">
 
   <!-- title -->
-  <title>Koi <%= "- #{yield :title}" if content_for? :title %></title>
+  <title><%= Koi.config.admin_name %><%= " - #{yield :title}" if content_for? :title %></title>
 
   <!-- META -->
   <%= csrf_meta_tags %>

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

@@ -3,9 +3,12 @@
 require "rails/generators/named_base"
 require "rails/generators/resource_helpers"
 
+require_relative "../helpers/admin_generator_attributes"
+
 module Koi
   class AdminControllerGenerator < Rails::Generators::NamedBase
     include Rails::Generators::ResourceHelpers
+    include Helpers::AdminGeneratorAttributes
 
     source_root File.expand_path("templates", __dir__)
 
@@ -48,7 +51,7 @@ module Koi
       attribute&.attachments?
     end
 
-    def search_attribute
+    def sort_attribute
       attributes.find { |attr| attr.type == :string }&.name
     end
   end

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

@@ -61,14 +61,15 @@ class <%= controller_class_name %>Controller < ApplicationController
     @<%= singular_name %> = ::<%= class_name %>.find(params[:id])
   end
 
-  class Collection < Katalyst::Tables::Collection::Base
-    attribute :search, :string
-
-    config.sorting  = :<%= search_attribute %>
+  class Collection < Admin::Collection
+    config.sorting  = :<%= sort_attribute %>
     config.paginate = true
 
-    def filter
-      self.items = items.admin_search(search) if search.present?
-    end
+    <%- attributes.each do |attribute| -%>
+    <% definition = collection_attribute_for(attribute) -%>
+    <%- if definition.present? -%>
+    <%= definition %>
+    <%- end -%>
+    <%- end -%>
   end
 end

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

@@ -28,11 +28,11 @@ RSpec.describe <%= controller_class_name %>Controller do
     end
 
     context "with sort parameter" do
-      let(:action) { get polymorphic_path([:admin, <%= class_name %>], sort: "<%= search_attribute %> desc") }
+      let(:action) { get polymorphic_path([:admin, <%= class_name %>], sort: "<%= sort_attribute %> desc") }
 
       before do
-        create(:<%= singular_name %>, <%= search_attribute %>: "first")
-        create(:<%= singular_name %>, <%= search_attribute %>: "second")
+        create(:<%= singular_name %>, <%= sort_attribute %>: "first")
+        create(:<%= singular_name %>, <%= sort_attribute %>: "second")
       end
 
       it "finds first in second place" do
@@ -45,8 +45,8 @@ RSpec.describe <%= controller_class_name %>Controller do
       let(:action) { get polymorphic_path([:admin, <%= class_name %>], search: "first") }
 
       before do
-        create(:<%= singular_name %>, <%= search_attribute %>: "first")
-        create(:<%= singular_name %>, <%= search_attribute %>: "second")
+        create(:<%= singular_name %>, <%= sort_attribute %>: "first")
+        create(:<%= singular_name %>, <%= sort_attribute %>: "second")
       end
 
       it "finds the needle" do

data/lib/generators/koi/admin_route/admin_route_generator.rb

@@ -26,10 +26,28 @@ module Koi
     end
 
     def add_navigation
-      insert_into_file("config/initializers/koi.rb",
-                       "  \"#{[*regular_class_path.map(&:humanize),
-                               human_name.pluralize].join(' ')}\" => \"/admin#{route_url}\",\n",
-                       after: "Koi::Menu.modules = {\n")
+      gsub_file("config/initializers/koi.rb", /Koi::Menu.modules = ({}|{\n(?:\s+.*\n)*})\n/) do |match|
+        config        = eval(match) # rubocop:disable Security/Eval # we know that this only during generation
+        label         = [*regular_class_path.map(&:humanize), human_name.pluralize].join(" ")
+        path          = "/admin#{route_url}"
+        config[label] = path
+        config        = config.sort.to_h
+        StringIO.new.tap do |io|
+          io.puts "Koi::Menu.modules = {"
+          config.each do |k, v|
+            if v.is_a?(Hash)
+              io.puts "  #{k.inspect} => {"
+              v.each do |kk, vv|
+                io.puts "    #{kk.inspect} => #{vv.inspect},"
+              end
+              io.puts "  },"
+            else
+              io.puts "  #{k.inspect} => #{v.inspect},"
+            end
+          end
+          io.puts "}"
+        end.string
+      end
     end
 
     private
@@ -37,9 +55,9 @@ module Koi
     # See Rails::Generators::Actions
     # Replaces hard-coded route with admin route file
     def route(routing_code, namespace: nil)
-      namespace = Array(namespace)
+      namespace         = Array(namespace)
       namespace_pattern = route_namespace_pattern(namespace)
-      routing_code = namespace.reverse.reduce(routing_code) do |code, name|
+      routing_code      = namespace.reverse.reduce(routing_code) do |code, name|
         "namespace :#{name} do\n#{rebase_indentation(code, 2)}end"
       end
 
@@ -48,7 +66,7 @@ module Koi
       in_root do
         if (namespace_match = match_file(route_file, namespace_pattern))
           base_indent, *, existing_block_indent = namespace_match.captures.compact.map(&:length)
-          existing_line_pattern = /^ {,#{existing_block_indent}}\S.+\n?/
+          existing_line_pattern                 = /^ {,#{existing_block_indent}}\S.+\n?/
           routing_code = rebase_indentation(routing_code, base_indent + 2).gsub(existing_line_pattern, "")
           namespace_pattern = /#{Regexp.escape namespace_match.to_s}/
         end
@@ -61,7 +79,7 @@ module Koi
     # Replaces Routes.draw with namespace :admin as the search term
     def route_namespace_pattern(namespace)
       namespace.each_with_index.reverse_each.reduce(nil) do |pattern, (name, i)|
-        cummulative_margin = "\\#{i + 1}[ ]{2}"
+        cummulative_margin     = "\\#{i + 1}[ ]{2}"
         blank_or_indented_line = "^[ ]*\n|^#{cummulative_margin}.*\n"
         "(?:(?:#{blank_or_indented_line})*?^(#{cummulative_margin})namespace :#{name} do\n#{pattern})?"
       end.then do |pattern|

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

@@ -3,9 +3,12 @@
 require "rails/generators/named_base"
 require "rails/generators/resource_helpers"
 
+require_relative "../helpers/admin_generator_attributes"
+
 module Koi
   class AdminViewsGenerator < Rails::Generators::NamedBase
     include Rails::Generators::ResourceHelpers
+    include Helpers::AdminGeneratorAttributes
 
     source_root File.expand_path("templates", __dir__)
 
@@ -31,49 +34,5 @@ module Koi
     def controller_class_path
       ["admin"] + super
     end
-
-    def govuk_input_for(attribute)
-      case attribute.type
-      when :string
-        %(<%= form.govuk_text_field :#{attribute.name} %>)
-      when :integer
-        %(<%= form.govuk_number_field :#{attribute.name} %>)
-      when :boolean
-        %(<%= form.govuk_check_box_field :#{attribute.name} %>)
-      when :date
-        %(<%= form.govuk_date_field :#{attribute.name}, legend: { size: "s" } %>)
-      when :rich_text, :text
-        %(<%= form.govuk_rich_text_area :#{attribute.name} %>)
-      when :attachment
-        %(<%= form.govuk_image_field :#{attribute.name} %>)
-      else
-        ""
-      end
-    end
-
-    def index_attribute_for(attribute)
-      case attribute.type
-      when :integer
-        %(<% row.number :#{attribute.name} %>)
-      when :boolean
-        %(<% row.boolean :#{attribute.name} %>)
-      when :date
-        %(<% row.date :#{attribute.name} %>)
-      when :datetime
-        %(<% row.datetime :#{attribute.name} %>)
-      when :rich_text
-        %(<% row.rich_text :#{attribute.name} %>)
-      when :attachment
-        %(<% row.attachment :#{attribute.name} %>)
-      else
-        %(<% row.text :#{attribute.name} %>)
-      end
-    end
-
-    alias_method :summary_attribute_for, :index_attribute_for
-
-    def index_attributes
-      attributes
-    end
   end
 end

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

@@ -1,8 +1,10 @@
 <%% content_for :header do %>
-  <%%= render(Koi::Header::IndexComponent.new(model: <%= class_name %>)) %>
+  <%%= render(Koi::Header::IndexComponent.new(model: <%= class_name %>)) do |component| %>
+    <%% component.with_action "New", <%= new_helper(type: :path) %> %>
+  <%% end %>
 <%% end %>
 
-<%%= koi_index_actions create: true, search: true %>
+<%%= table_query_with(collection:) %>
 
 <%%= table_with(collection:) do |row, <%= singular_name %>| %>
   <%- index_attributes.each_with_index do |attribute, index| -%>

data/lib/generators/koi/helpers/admin_generator_attributes.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Koi
+  module Helpers
+    module AdminGeneratorAttributes
+      extend ActiveSupport::Concern
+
+      def govuk_input_for(attribute)
+        case attribute.type
+        when :string
+          %(<%= form.govuk_text_field :#{attribute.name} %>)
+        when :integer
+          %(<%= form.govuk_number_field :#{attribute.name} %>)
+        when :boolean
+          %(<%= form.govuk_check_box_field :#{attribute.name} %>)
+        when :date
+          %(<%= form.govuk_date_field :#{attribute.name}, legend: { size: "s" } %>)
+        when :rich_text, :text
+          %(<%= form.govuk_rich_text_area :#{attribute.name} %>)
+        when :attachment
+          %(<%= form.govuk_image_field :#{attribute.name} %>)
+        else
+          ""
+        end
+      end
+
+      def index_attribute_for(attribute)
+        case attribute.type
+        when :integer
+          %(<% row.number :#{attribute.name} %>)
+        when :boolean
+          %(<% row.boolean :#{attribute.name} %>)
+        when :date
+          %(<% row.date :#{attribute.name} %>)
+        when :datetime
+          %(<% row.datetime :#{attribute.name} %>)
+        when :rich_text
+          %(<% row.rich_text :#{attribute.name} %>)
+        when :attachment
+          %(<% row.attachment :#{attribute.name} %>)
+        else
+          %(<% row.text :#{attribute.name} %>)
+        end
+      end
+
+      alias_method :summary_attribute_for, :index_attribute_for
+
+      def collection_attribute_for(attribute)
+        case attribute.type
+        when :string
+          %(attribute :#{attribute.name}, :string)
+        when :integer
+          %(attribute :#{attribute.name}, :integer)
+        when :boolean
+          %(attribute :#{attribute.name}, :boolean)
+        when :date, :datetime
+          %(attribute :#{attribute.name}, :date)
+        end
+      end
+
+      def index_attributes
+        attributes
+      end
+    end
+  end
+end

data/lib/koi/collection/type/archivable.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Koi
+  module Collection
+    module Type
+      # Add support for `attribute :status, :archivable, default: :active` to
+      # Koi collections to support filtering on Koi::Model::Archivable models.
+      class Archivable < Katalyst::Tables::Collection::Type::Enum
+        def initialize
+          super(multiple: false, scope: :status)
+        end
+
+        def type
+          :archivable
+        end
+
+        def examples_for(...)
+          %i[active archived all]
+        end
+      end
+    end
+  end
+end

data/lib/koi/collection.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "koi/collection/type/archivable"
+
+module Koi
+  module Collection
+    class << self
+      Katalyst::Tables::Collection::Type.register(:archivable, Koi::Collection::Type::Archivable)
+    end
+  end
+end

data/lib/koi/config.rb

@@ -7,6 +7,8 @@ module Koi
   class Config
     include ActiveSupport::Configurable
 
+    config_accessor(:admin_name) { "Koi" }
+
     config_accessor(:resource_name_candidates) { %i[title name] }
 
     config_accessor(:admin_stylesheet) { "koi/admin" }

data/lib/koi.rb

@@ -14,6 +14,7 @@ require "webauthn"
 require "koi/form_builder"
 require "koi/menu"
 require "koi/caching"
+require "koi/collection"
 require "koi/config"
 require "koi/engine"
 require "koi/extensions"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-koi
 version: !ruby/object:Gem::Version
-  version: 4.8.0
+  version: 4.9.0
 platform: ruby
 authors:
 - Katalyst Interactive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-14 00:00:00.000000000 Z
+date: 2024-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -265,6 +265,8 @@ files:
 - app/assets/javascripts/koi/controllers/sluggable_controller.js
 - app/assets/javascripts/koi/controllers/webauthn_authentication_controller.js
 - app/assets/javascripts/koi/controllers/webauthn_registration_controller.js
+- app/assets/javascripts/koi/elements/index.js
+- app/assets/javascripts/koi/elements/toolbar.js
 - app/assets/javascripts/koi/utils/transition.js
 - app/assets/stylesheets/koi/admin.scss
 - app/assets/stylesheets/koi/base/_button.scss
@@ -282,7 +284,9 @@ files:
 - app/assets/stylesheets/koi/components/_index-actions.scss
 - app/assets/stylesheets/koi/components/_index.scss
 - app/assets/stylesheets/koi/components/_pagy.scss
+- app/assets/stylesheets/koi/components/_query.scss
 - app/assets/stylesheets/koi/components/_summary-list.scss
+- app/assets/stylesheets/koi/components/_toolbar.scss
 - app/assets/stylesheets/koi/layouts/_banner.scss
 - app/assets/stylesheets/koi/layouts/_content.scss
 - app/assets/stylesheets/koi/layouts/_flash.scss
@@ -329,8 +333,8 @@ files:
 - app/components/koi/summary_list_component.rb
 - app/components/koi/summary_table_component.rb
 - app/components/koi/table_component.rb
+- app/components/koi/table_query_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
@@ -353,6 +357,7 @@ files:
 - app/helpers/koi/pagy.rb
 - app/jobs/koi/application_job.rb
 - app/mailers/koi/application_mailer.rb
+- app/models/admin/collection.rb
 - app/models/admin/credential.rb
 - app/models/admin/user.rb
 - app/models/application_record.rb
@@ -438,12 +443,15 @@ files:
 - lib/generators/koi/admin_views/templates/index.html.erb.tt
 - lib/generators/koi/admin_views/templates/new.html.erb.tt
 - lib/generators/koi/admin_views/templates/show.html.erb.tt
+- lib/generators/koi/helpers/admin_generator_attributes.rb
 - lib/govuk_design_system_formbuilder/concerns/file_element.rb
 - lib/govuk_design_system_formbuilder/elements/document.rb
 - lib/govuk_design_system_formbuilder/elements/image.rb
 - lib/katalyst/koi.rb
 - lib/koi.rb
 - lib/koi/caching.rb
+- lib/koi/collection.rb
+- lib/koi/collection/type/archivable.rb
 - lib/koi/config.rb
 - lib/koi/engine.rb
 - lib/koi/extensions.rb
@@ -475,7 +483,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: Koi CMS admin framework

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

@@ -1,27 +0,0 @@
-# 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