katalyst-koi 5.1.0 → 5.2.0

data/app/javascript/koi/controllers/index.js

@@ -14,14 +14,11 @@ application.load(tables);
 
 import ClipboardController from "./clipboard_controller";
 import FlashController from "./flash_controller";
-import FormRequestSubmitController from "./form_request_submit_controller";
-import IndexActionsController from "./index_actions_controller";
 import KeyboardController from "./keyboard_controller";
 import ModalController from "./modal_controller";
 import NavigationController from "./navigation_controller";
 import NavigationToggleController from "./navigation_toggle_controller";
 import PagyNavController from "./pagy_nav_controller";
-import ShowHideController from "./show_hide_controller";
 import SluggableController from "./sluggable_controller";
 import WebauthnAuthenticationController from "./webauthn_authentication_controller";
 import WebauthnRegistrationController from "./webauthn_registration_controller";
@@ -35,14 +32,6 @@ const Definitions = [
     identifier: "flash",
     controllerConstructor: FlashController,
   },
-  {
-    identifier: "form-request-submit",
-    controllerConstructor: FormRequestSubmitController,
-  },
-  {
-    identifier: "index-actions",
-    controllerConstructor: IndexActionsController,
-  },
   {
     identifier: "keyboard",
     controllerConstructor: KeyboardController,
@@ -63,10 +52,6 @@ const Definitions = [
     identifier: "pagy-nav",
     controllerConstructor: PagyNavController,
   },
-  {
-    identifier: "show-hide",
-    controllerConstructor: ShowHideController,
-  },
   {
     identifier: "sluggable",
     controllerConstructor: SluggableController,

data/config/locales/pagy/en.yml

@@ -0,0 +1,24 @@
+en:
+  pagy:
+    p11n: 'OneOther'
+    aria_label:
+      nav:
+        one: "Pagination"
+        other: "Pagination"
+      prev: "Previous page"
+      previous: "Previous page" # @deprecated
+      next: "Next page"
+    prev: "←  Previous" # @deprecated
+    previous: "←  Previous"
+    next: "Next  →"
+    gap: "…"
+    item_name:
+      one: "item"
+      other: "items"
+    info_tag:
+      no_count: "Page %{page} of %{pages}"
+      no_items: "No %{item_name} found"
+      single_page: "Displaying %{count} %{item_name}"
+      multiple_pages: "Displaying %{item_name} %{from}-%{to} of %{count} in total"
+    input_nav_js: "Page %{page_input} of %{pages}"
+    limit_tag_js: "Show %{limit_input} %{item_name} per page"

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

@@ -41,9 +41,9 @@ class <%= controller_class_name %>Controller < ApplicationController
     @<%= singular_name %> = <%= class_name %>.new(<%= singular_table_name %>_params)
 
     if <%= singular_name %>.save
-      redirect_to <%= admin_show_helper %>, status: :see_other
+      redirect_to(<%= admin_show_helper %>, status: :see_other)
     else
-      render :new, locals: { <%= singular_name %>: }, status: :unprocessable_content
+      render(:new, locals: { <%= singular_name %>: }, status: :unprocessable_content)
     end
   end
 
@@ -51,7 +51,7 @@ class <%= controller_class_name %>Controller < ApplicationController
     if <%= singular_name %>.update(<%= singular_table_name %>_params)
       redirect_to <%= admin_show_helper %>, status: :see_other
     else
-      render :edit, locals: { <%= singular_name %>: }, status: :unprocessable_content
+      render(:edit, locals: { <%= singular_name %>: }, status: :unprocessable_content)
     end
   end
 
@@ -59,13 +59,13 @@ class <%= controller_class_name %>Controller < ApplicationController
   def archive
     <%= class_name %>.where(id: params[:id]).each(&:archive!)
 
-    redirect_back(fallback_location: <%= admin_index_helper %>, status: :see_other)
+    redirect_back_or_to(<%= admin_index_helper %>, status: :see_other)
   end
 
   def restore
     <%= class_name %>.archived.where(id: params[:id]).each(&:restore!)
 
-    redirect_back(fallback_location: <%= admin_index_helper %>, status: :see_other)
+    redirect_back_or_to(<%= admin_index_helper %>, status: :see_other)
   end
   <%- end -%>
 
@@ -75,7 +75,7 @@ class <%= controller_class_name %>Controller < ApplicationController
       <%= class_name %>.find(id).update(attrs)
     end
 
-    redirect_back(fallback_location: <%= admin_index_helper %>, status: :see_other)
+    redirect_back_or_to(<%= admin_index_helper %>, status: :see_other)
   end
   <%- end -%>
 
@@ -84,7 +84,7 @@ class <%= controller_class_name %>Controller < ApplicationController
     if <%= singular_name %>.archived?
       <%= singular_name %>.destroy!
 
-      redirect_to <%= admin_index_helper %>, status: :see_other
+      redirect_to(<%= admin_index_helper %>, status: :see_other)
     else
       <%= singular_name %>.archive!
 
@@ -93,7 +93,7 @@ class <%= controller_class_name %>Controller < ApplicationController
     <%- else -%>
     <%= singular_name %>.destroy!
 
-    redirect_to <%= admin_index_helper %>, status: :see_other
+    redirect_to(<%= admin_index_helper %>, status: :see_other)
     <%- end -%>
   end
 

data/lib/koi/engine.rb

@@ -64,7 +64,12 @@ module Koi
     end
 
     initializer "koi.pagination" do
-      Pagy::I18n.load(locale: "en", filepath: root.join("config/locales/pagy.en.yml"))
+      if Pagy::I18n.respond_to?(:pathnames)
+        Pagy::I18n.pathnames << root.join("config/locales/pagy")
+      else
+        # @deprecated support for Pagy <43
+        Pagy::I18n.load(locale: "en", filepath: root.join("config/locales/pagy/en.yml"))
+      end
     end
 
     initializer "koi.views" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-koi
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Katalyst Interactive
@@ -227,7 +227,6 @@ extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - README.md
-- Upgrade.md
 - app/assets/builds/katalyst/koi.esm.js
 - app/assets/builds/katalyst/koi.js
 - app/assets/builds/katalyst/koi.min.js
@@ -272,7 +271,6 @@ files:
 - app/assets/stylesheets/koi/blocks/clipboard.css
 - app/assets/stylesheets/koi/blocks/flash.css
 - app/assets/stylesheets/koi/blocks/icon.css
-- app/assets/stylesheets/koi/blocks/index-actions.css
 - app/assets/stylesheets/koi/blocks/index.css
 - app/assets/stylesheets/koi/blocks/modal.css
 - app/assets/stylesheets/koi/blocks/navigation.css
@@ -352,16 +350,13 @@ files:
 - app/controllers/well_knowns_controller.rb
 - app/helpers/koi/form_helper.rb
 - app/helpers/koi/header_helper.rb
-- app/helpers/koi/index_actions_helper.rb
 - app/helpers/koi/modal_helper.rb
 - app/helpers/koi/pagy.rb
 - app/javascript/koi/application.js
 - app/javascript/koi/controllers/application.js
 - app/javascript/koi/controllers/clipboard_controller.js
 - app/javascript/koi/controllers/flash_controller.js
-- app/javascript/koi/controllers/form_request_submit_controller.js
 - app/javascript/koi/controllers/index.js
-- app/javascript/koi/controllers/index_actions_controller.js
 - app/javascript/koi/controllers/keyboard_controller.js
 - app/javascript/koi/controllers/modal_controller.js
 - app/javascript/koi/controllers/navigation_controller.js
@@ -440,7 +435,7 @@ files:
 - config/initializers/flipper.rb
 - config/initializers/inflections.rb
 - config/locales/koi.en.yml
-- config/locales/pagy.en.yml
+- config/locales/pagy/en.yml
 - config/routes.rb
 - db/migrate/20120220130849_devise_create_admins.rb
 - db/migrate/20130509235316_add_url_rewriter.rb

data/Upgrade.md

@@ -1,10 +0,0 @@
-# Breaking changes and Upgrade Paths
-
-## Koi 4.2
-
-Koi 4.2 requires Kpop >= 3.0 for modals.
-
-## Koi 4
-
-Koi 4 is a breaking change from previous versions and does not have a
-straightforward upgrade path.

data/app/assets/stylesheets/koi/blocks/index-actions.css

@@ -1,69 +0,0 @@
-.index-actions > form {
-  display: flex;
-  align-items: stretch;
-  justify-content: space-between;
-  margin-bottom: 1rem;
-
-  // checkbox styles based on govuk-frontend
-
-  input[type="checkbox"] {
-    cursor: pointer;
-    position: absolute;
-    z-index: 1;
-    top: 0;
-    bottom: 0;
-    left: 0;
-    width: 2.5rem;
-    opacity: 0;
-  }
-
-  label:has(input[type="checkbox"]) {
-    display: inline-block;
-    position: relative;
-    margin-bottom: 0;
-    padding: 0 0 0 calc(2.5rem + 5px);
-    line-height: 2.5rem;
-    cursor: pointer;
-    -ms-touch-action: manipulation;
-    touch-action: manipulation;
-  }
-
-  label:has(input[type="checkbox"])::before {
-    content: "";
-    box-sizing: border-box;
-    position: absolute;
-    top: 0;
-    bottom: 0;
-    left: 0;
-    aspect-ratio: 1/1;
-    border: 2px solid currentcolor;
-    background: transparent;
-  }
-
-  label:has(input[type="checkbox"]:focus)::before {
-    border-width: 4px;
-    outline: 3px solid transparent;
-    outline-offset: 1px;
-    box-shadow: 0 0 0 3px #ffdd00;
-  }
-
-  label:has(input[type="checkbox"])::after {
-    content: "";
-    box-sizing: border-box;
-    position: absolute;
-    top: 12px;
-    left: 9px;
-    width: 23px;
-    height: 12px;
-    transform: rotate(-45deg);
-    border: solid;
-    border-width: 0 0 5px 5px;
-    border-top-color: transparent;
-    opacity: 0;
-    background: transparent;
-  }
-
-  label:has(input[type="checkbox"][checked])::after {
-    opacity: 1;
-  }
-}

data/app/helpers/koi/index_actions_helper.rb

@@ -1,98 +0,0 @@
-# frozen_string_literal: true
-
-module Koi
-  module IndexActionsHelper
-    # @deprecated to be removed in Koi 5
-    def koi_index_actions(search: false, create: false, &)
-      IndexActionsBuilder.new(self, search:, create:).render(&)
-    end
-  end
-
-  class IndexActionsBuilder
-    delegate_missing_to :@context
-
-    def initialize(context, search:, create:)
-      @context = context
-      @search  = search
-      @create  = create
-    end
-
-    def search?
-      !!@search
-    end
-
-    def create?
-      !!@create
-    end
-
-    def render(&)
-      tag.nav class: "index-actions", data: { controller: "index-actions", action: actions } do
-        form_with(**search_options,
-                  data: { controller:   "search",
-                          turbo_action: "replace",
-                          action:       <<~ACTIONS,
-                            input->index-actions#update
-                            change->index-actions#update
-                            submit->index-actions#submit
-                          ACTIONS
-                  }) do |form|
-          concat(links(form, &))
-          concat(sort_input(form))
-          concat(search(form)) if create? || search?
-        end
-      end
-    end
-
-    def search(form)
-      tag.div class: "actions" do
-        concat(search_button(form)) if search?
-        concat(create_button(form)) if create?
-        concat(search_input(form)) if search?
-      end
-    end
-
-    def sort_input(form)
-      form.hidden_field(:sort, value: params[:sort], data: { index_actions_target: "sort" })
-    end
-
-    # Hidden button to trigger search, avoids triggering create instead.
-    def search_button(form)
-      form.submit("Search", hidden: "")
-    end
-
-    def create_button(_form)
-      tag.button(t("koi.labels.new", default: "New"),
-                 type:       :submit,
-                 formaction: @create == true ? url_for(action: :new) : new_polymorphic_path(@create),
-                 class:      "button--primary",
-                 data:       { index_actions_target: "create" })
-    end
-
-    def search_input(form)
-      form.search_field(:search,
-                        placeholder: t("koi.labels.search", default: "Search"),
-                        value:       params[:search],
-                        data:        { index_actions_target: "search", turbo_permanent: "" })
-    end
-
-    def links(form, &)
-      tag.div(class: "actions") do
-        yield(form) if block_given?
-      end
-    end
-
-    def actions
-      [
-        ("shortcut:cancel@document->index-actions#clear" if search?),
-        ("shortcut:create@document->index-actions#create" if create?),
-        ("shortcut:search@document->index-actions#search" if search?),
-      ].compact.join(" ")
-    end
-
-    def search_options
-      options = { url: request.path, method: :get, scope: "" }
-      options.merge!(@search) if @search.is_a?(Hash)
-      options
-    end
-  end
-end

data/app/javascript/koi/controllers/form_request_submit_controller.js

@@ -1,11 +0,0 @@
-import { Controller } from "@hotwired/stimulus";
-
-/**
- A stimulus controller to request form submissions.
- This controller should be attached to a form element.
- */
-export default class FormRequestSubmitController extends Controller {
-  requestSubmit() {
-    this.element.requestSubmit();
-  }
-}

data/app/javascript/koi/controllers/index_actions_controller.js

@@ -1,60 +0,0 @@
-import { Controller } from "@hotwired/stimulus";
-
-export default class IndexActionsController extends Controller {
-  static targets = ["create", "search", "sort"];
-
-  initialize() {
-    // debounce search
-    this.update = debounce(this, this.update);
-  }
-
-  disconnect() {
-    clearTimeout(this.timer);
-  }
-
-  create() {
-    this.createTarget.click();
-  }
-
-  search() {
-    this.searchTarget.focus();
-  }
-
-  clear() {
-    this.searchTarget.value = "";
-    this.searchTarget.closest("form").requestSubmit();
-  }
-
-  update() {
-    this.searchTarget.closest("form").requestSubmit();
-  }
-
-  submit() {
-    const shouldFocus = document.activeElement === this.searchTarget;
-
-    if (this.searchTarget.value === "") {
-      this.searchTarget.disabled = true;
-    }
-    if (this.sortTarget.value === "") {
-      this.sortTarget.disabled = true;
-    }
-
-    // restore state and focus after submit
-    Promise.resolve().then(() => {
-      this.searchTarget.disabled = false;
-      this.sortTarget.disabled = false;
-      if (shouldFocus) {
-        this.searchTarget.focus();
-      }
-    });
-  }
-}
-
-function debounce(self, f) {
-  return (...args) => {
-    clearTimeout(self.timer);
-    self.timer = setTimeout(() => {
-      f.apply(self, ...args);
-    }, 300);
-  };
-}

data/config/locales/pagy.en.yml

@@ -1,11 +0,0 @@
-en:
-  pagy:
-    aria_label:
-      nav:
-        one: "Pagination"
-        other: "Pagination"
-      prev: "Previous page"
-      next: "Next page"
-    prev: "←  Previous"
-    next: "Next  →"
-    gap: "…"