katalyst-tables 2.3.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16f4a66ac1715abeba201402eedf3c19f27dbd0c53291b841164ad79f085ec77
-  data.tar.gz: 80aad00ee67b5d3d760a7b47ba3ffc735d704d49edb4e42942197c4d93ff8eea
+  metadata.gz: 73c920aef2dfd59566ab635a3b7f573a6bb6cc6b16548e9e198c23d021d571dd
+  data.tar.gz: 2b2f8000946bda4871efe3ea052b29ff87fdb43cd1eaf1861fd5cdcb0cd52411
 SHA512:
-  metadata.gz: 6713a3de4a8ee62071f3c34e1557691add7b02428eee13f994b107261571de84b6be57b9f1c7c997ab6bd87a23a4fecf68dfd52b311a412e26399b099fac4c0e
-  data.tar.gz: 7fdd72501c7f780181fc2d3a0d182fd989c57a4aa4a4418a90a599c64fbc2bf1c960b27ebb8ce90ae9fdbdb9184c3020976d0f2b7cffbf9f19b5e704341e936c
+  metadata.gz: fe91356719cc1f290f90245cc22742c6d6a328818b42c95412baa10f8affe3a2d1e48e7733d439ec185c48bea7c4bc40f8eff9e986375200d37a3a020a063c75
+  data.tar.gz: c4a65aac6559e0afb91cfde6f6efc4a4f1d06c1e4679fff3e903c94272b3c8f6f51005bd009013fbca60be7d08eb45edc3fba3e5926da15d28c78da449fa736a

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 ## [Unreleased]
 
+## [2.5.0]
+
+- Breaking change: use Rails' object lookup path to find row partials
+  Previously: Nested::ResourceController would have looked for Nested::Model in
+  the controller directory:
+    app/views/nested/resources/_nested_model.html+row.erb
+  After this change, uses Rails' polymorphic partials logic and looks in the
+  model views directory:
+    app/views/nested/models/_model.html+row.erb
+
+## [2.4.0]
+
+- Internal refactor of filters to make it easier to add custom extensions
+  and define nested attributes.
+
 ## [2.3.0]
 
 - Remove support for Ruby < 3.0 (no longer used at Katalyst)

data/app/assets/builds/katalyst/tables.esm.js

@@ -198,7 +198,7 @@ class OrderableListController extends Controller {
 
     // reindex all items based on their new positions
     this.tablesOrderableItemOutlets.forEach((item, index) =>
-      item.updateIndex(index)
+      item.updateIndex(index),
     );
 
     // save the changes
@@ -250,7 +250,7 @@ class OrderableListController extends Controller {
         this.element,
         this.dragItem.row,
         event,
-        this.animate
+        this.animate,
       );
     });
   };
@@ -265,7 +265,7 @@ class OrderableListController extends Controller {
       this.dragState.updateScroll(
         this.element,
         this.dragItem.row,
-        this.animate
+        this.animate,
       );
     });
   };
@@ -325,7 +325,7 @@ class OrderableListController extends Controller {
     if (!this.isDragging) return null;
 
     return this.tablesOrderableItemOutlets.find(
-      (item) => item.id === this.dragState.targetId
+      (item) => item.id === this.dragState.targetId,
     );
   }
 
@@ -337,7 +337,7 @@ class OrderableListController extends Controller {
    */
   get #currentItems() {
     return this.tablesOrderableItemOutlets.toSorted(
-      (a, b) => a.comparisonIndex - b.comparisonIndex
+      (a, b) => a.comparisonIndex - b.comparisonIndex,
     );
   }
 
@@ -349,7 +349,7 @@ class OrderableListController extends Controller {
    */
   #targetItem(element) {
     return this.tablesOrderableItemOutlets.find(
-      (item) => item.element === element
+      (item) => item.element === element,
     );
   }
 
@@ -455,7 +455,7 @@ class OrderableFormController extends Controller {
     this.element.insertAdjacentHTML(
       "beforeend",
       `<input type="hidden" name="${id_name}" value="${id_value}" data-generated>
-              <input type="hidden" name="${index_name}" value="${item.index}" data-generated>`
+              <input type="hidden" name="${index_name}" value="${item.index}" data-generated>`,
     );
   }
 

data/app/assets/builds/katalyst/tables.js

@@ -198,7 +198,7 @@ class OrderableListController extends Controller {
 
     // reindex all items based on their new positions
     this.tablesOrderableItemOutlets.forEach((item, index) =>
-      item.updateIndex(index)
+      item.updateIndex(index),
     );
 
     // save the changes
@@ -250,7 +250,7 @@ class OrderableListController extends Controller {
         this.element,
         this.dragItem.row,
         event,
-        this.animate
+        this.animate,
       );
     });
   };
@@ -265,7 +265,7 @@ class OrderableListController extends Controller {
       this.dragState.updateScroll(
         this.element,
         this.dragItem.row,
-        this.animate
+        this.animate,
       );
     });
   };
@@ -325,7 +325,7 @@ class OrderableListController extends Controller {
     if (!this.isDragging) return null;
 
     return this.tablesOrderableItemOutlets.find(
-      (item) => item.id === this.dragState.targetId
+      (item) => item.id === this.dragState.targetId,
     );
   }
 
@@ -337,7 +337,7 @@ class OrderableListController extends Controller {
    */
   get #currentItems() {
     return this.tablesOrderableItemOutlets.toSorted(
-      (a, b) => a.comparisonIndex - b.comparisonIndex
+      (a, b) => a.comparisonIndex - b.comparisonIndex,
     );
   }
 
@@ -349,7 +349,7 @@ class OrderableListController extends Controller {
    */
   #targetItem(element) {
     return this.tablesOrderableItemOutlets.find(
-      (item) => item.element === element
+      (item) => item.element === element,
     );
   }
 
@@ -455,7 +455,7 @@ class OrderableFormController extends Controller {
     this.element.insertAdjacentHTML(
       "beforeend",
       `<input type="hidden" name="${id_name}" value="${id_value}" data-generated>
-              <input type="hidden" name="${index_name}" value="${item.index}" data-generated>`
+              <input type="hidden" name="${index_name}" value="${item.index}" data-generated>`,
     );
   }
 

data/app/assets/builds/katalyst/tables.min.js.map

@@ -1 +1 @@
-{"version":3,"file":"tables.min.js","sources":["../../../javascript/tables/orderable/list_controller.js","../../../javascript/tables/application.js","../../../javascript/tables/turbo/collection_controller.js","../../../javascript/tables/orderable/item_controller.js","../../../javascript/tables/orderable/form_controller.js"],"sourcesContent":["import { Controller } from \"@hotwired/stimulus\";\n\nexport default class OrderableListController extends Controller {\n  static outlets = [\"tables--orderable--item\", \"tables--orderable--form\"];\n\n  //region State transitions\n\n  startDragging(dragState) {\n    this.dragState = dragState;\n\n    document.addEventListener(\"mousemove\", this.mousemove);\n    document.addEventListener(\"mouseup\", this.mouseup);\n    window.addEventListener(\"scroll\", this.scroll, true);\n\n    this.element.style.position = \"relative\";\n  }\n\n  stopDragging() {\n    const dragState = this.dragState;\n    delete this.dragState;\n\n    document.removeEventListener(\"mousemove\", this.mousemove);\n    document.removeEventListener(\"mouseup\", this.mouseup);\n    window.removeEventListener(\"scroll\", this.scroll, true);\n\n    this.element.removeAttribute(\"style\");\n    this.tablesOrderableItemOutlets.forEach((item) => item.reset());\n\n    return dragState;\n  }\n\n  drop() {\n    // note: early returns guard against turbo updates that prevent us finding\n    // the right item to drop on. In this situation it's better to discard the\n    // drop than to drop in the wrong place.\n\n    const dragItem = this.dragItem;\n\n    if (!dragItem) return;\n\n    const newIndex = dragItem.dragIndex;\n    const targetItem = this.tablesOrderableItemOutlets[newIndex];\n\n    if (!targetItem) return;\n\n    // swap the dragged item into the correct position for its current offset\n    if (newIndex < dragItem.index) {\n      targetItem.row.insertAdjacentElement(\"beforebegin\", dragItem.row);\n    } else if (newIndex > dragItem.index) {\n      targetItem.row.insertAdjacentElement(\"afterend\", dragItem.row);\n    }\n\n    // reindex all items based on their new positions\n    this.tablesOrderableItemOutlets.forEach((item, index) =>\n      item.updateIndex(index)\n    );\n\n    // save the changes\n    this.commitChanges();\n  }\n\n  commitChanges() {\n    // clear any existing inputs to prevent duplicates\n    this.tablesOrderableFormOutlet.clear();\n\n    // insert any items that have changed position\n    this.tablesOrderableItemOutlets.forEach((item) => {\n      if (item.hasChanges) this.tablesOrderableFormOutlet.add(item);\n    });\n\n    this.tablesOrderableFormOutlet.submit();\n  }\n\n  //endregion\n\n  //region Events\n\n  mousedown(event) {\n    if (this.isDragging) return;\n\n    const target = this.#targetItem(event.target);\n\n    if (!target) return;\n\n    event.preventDefault(); // prevent built-in drag\n\n    this.startDragging(new DragState(this.element, event, target.id));\n\n    this.dragState.updateCursor(this.element, target.row, event, this.animate);\n  }\n\n  mousemove = (event) => {\n    if (!this.isDragging) return;\n\n    event.preventDefault(); // prevent build-in drag\n\n    if (this.ticking) return;\n\n    this.ticking = true;\n\n    window.requestAnimationFrame(() => {\n      this.ticking = false;\n      this.dragState.updateCursor(\n        this.element,\n        this.dragItem.row,\n        event,\n        this.animate\n      );\n    });\n  };\n\n  scroll = (event) => {\n    if (!this.isDragging || this.ticking) return;\n\n    this.ticking = true;\n\n    window.requestAnimationFrame(() => {\n      this.ticking = false;\n      this.dragState.updateScroll(\n        this.element,\n        this.dragItem.row,\n        this.animate\n      );\n    });\n  };\n\n  mouseup = (event) => {\n    if (!this.isDragging) return;\n\n    this.drop();\n    this.stopDragging();\n    this.tablesOrderableFormOutlets.forEach((form) => delete form.dragState);\n  };\n\n  tablesOrderableFormOutletConnected(form, element) {\n    if (form.dragState) {\n      // restore the previous controller's state\n      this.startDragging(form.dragState);\n    }\n  }\n\n  tablesOrderableFormOutletDisconnected(form, element) {\n    if (this.isDragging) {\n      // cache drag state in the form\n      form.dragState = this.stopDragging();\n    }\n  }\n\n  //endregion\n\n  //region Helpers\n\n  /**\n   * Updates the position of the drag item with a relative offset. Updates\n   * other items relative to the new position of the drag item, as required.\n   *\n   * @callback {OrderableListController~animate}\n   * @param {number} offset\n   */\n  animate = (offset) => {\n    const dragItem = this.dragItem;\n\n    // Visually update the dragItem so it follows the cursor\n    dragItem.dragUpdate(offset);\n\n    // Visually updates the position of all items in the list relative to the\n    // dragged item. No actual changes to orderings at this stage.\n    this.#currentItems.forEach((item, index) => {\n      if (item === dragItem) return;\n      item.updateVisually(index);\n    });\n  };\n\n  get isDragging() {\n    return !!this.dragState;\n  }\n\n  get dragItem() {\n    if (!this.isDragging) return null;\n\n    return this.tablesOrderableItemOutlets.find(\n      (item) => item.id === this.dragState.targetId\n    );\n  }\n\n  /**\n   * Returns the current items in the list, sorted by their current index.\n   * Current uses the drag index if the item is being dragged, if set.\n   *\n   * @returns {Array[OrderableRowController]}\n   */\n  get #currentItems() {\n    return this.tablesOrderableItemOutlets.toSorted(\n      (a, b) => a.comparisonIndex - b.comparisonIndex\n    );\n  }\n\n  /**\n   * Returns the item outlet that was clicked on, if any.\n   *\n   * @param element {HTMLElement} the clicked ordinal cell\n   * @returns {OrderableRowController}\n   */\n  #targetItem(element) {\n    return this.tablesOrderableItemOutlets.find(\n      (item) => item.element === element\n    );\n  }\n\n  //endregion\n}\n\n/**\n * During drag we want to be able to translate a document-relative coordinate\n * into a coordinate relative to the list element. This state object calculates\n * and stores internal state so that we can translate absolute page coordinates\n * from mouse events into relative offsets for the list items within the list\n * element.\n *\n * We also keep track of the drag target so that if the controller is attached\n * to a new element during the drag we can continue after the turbo update.\n */\nclass DragState {\n  /**\n   * @param list {HTMLElement} the list controller's element (tbody)\n   * @param event {MouseEvent} the initial event\n   * @param id {String} the id of the element being dragged\n   */\n  constructor(list, event, id) {\n    // cursor offset is the offset of the cursor relative to the drag item\n    this.cursorOffset = event.offsetY;\n\n    // initial offset is the offset position of the drag item at drag start\n    this.initialPosition = event.target.offsetTop - list.offsetTop;\n\n    // id of the item being dragged\n    this.targetId = id;\n  }\n\n  /**\n   * Calculates the offset of the drag item relative to its initial position.\n   *\n   * @param list {HTMLElement} the list controller's element (tbody)\n   * @param row {HTMLElement} the row being dragged\n   * @param event {MouseEvent} the current event\n   * @param callback {OrderableListController~animate} updates the drag item with a relative offset\n   */\n  updateCursor(list, row, event, callback) {\n    // Calculate and store the list offset relative to the viewport\n    // This value is cached so we can calculate the outcome of any scroll events\n    this.listOffset = list.getBoundingClientRect().top;\n\n    // Calculate the position of the cursor relative to the list.\n    // Accounts for scroll offsets by using the item's bounding client rect.\n    const cursorPosition = event.clientY - this.listOffset;\n\n    // intended item position relative to the list, from cursor position\n    let itemPosition = cursorPosition - this.cursorOffset;\n\n    this.#updateItemPosition(list, row, itemPosition, callback);\n  }\n\n  /**\n   * Animates the item's position as the list scrolls. Requires a previous call\n   * to set the scroll offset.\n   *\n   * @param list {HTMLElement} the list controller's element (tbody)\n   * @param row {HTMLElement} the row being dragged\n   * @param callback {OrderableListController~animate} updates the drag item with a relative offset\n   */\n  updateScroll(list, row, callback) {\n    const previousScrollOffset = this.listOffset;\n\n    // Calculate and store the list offset relative to the viewport\n    // This value is cached so we can calculate the outcome of any scroll events\n    this.listOffset = list.getBoundingClientRect().top;\n\n    // Calculate the change in scroll offset since the last update\n    const scrollDelta = previousScrollOffset - this.listOffset;\n\n    // intended item position relative to the list, from cursor position\n    const position = this.position + scrollDelta;\n\n    this.#updateItemPosition(list, row, position, callback);\n  }\n\n  #updateItemPosition(list, row, position, callback) {\n    // ensure itemPosition is within the bounds of the list (tbody)\n    position = Math.max(position, 0);\n    position = Math.min(position, list.offsetHeight - row.offsetHeight);\n\n    // cache the item's position relative to the list for use in scroll events\n    this.position = position;\n\n    // Item has position: relative, so we want to calculate the amount to move\n    // the item relative to it's DOM position to represent how much it has been\n    // dragged by.\n    const offset = position - this.initialPosition;\n\n    // Convert itemPosition from offset relative to list to offset relative to\n    // its position within the DOM (if it hadn't moved).\n    callback(offset);\n  }\n}\n","import TurboCollectionController from \"./turbo/collection_controller\";\nimport ItemController from \"./orderable/item_controller\";\nimport ListController from \"./orderable/list_controller\";\nimport FormController from \"./orderable/form_controller\";\n\nconst Definitions = [\n  {\n    identifier: \"tables--turbo--collection\",\n    controllerConstructor: TurboCollectionController,\n  },\n  {\n    identifier: \"tables--orderable--item\",\n    controllerConstructor: ItemController,\n  },\n  {\n    identifier: \"tables--orderable--list\",\n    controllerConstructor: ListController,\n  },\n  {\n    identifier: \"tables--orderable--form\",\n    controllerConstructor: FormController,\n  },\n];\n\nexport { Definitions as default };\n","import { Controller } from \"@hotwired/stimulus\";\nimport { Turbo } from \"@hotwired/turbo-rails\";\n\nexport default class TurboCollectionController extends Controller {\n  static values = {\n    query: String,\n    sort: String,\n  };\n\n  queryValueChanged(query) {\n    Turbo.navigator.history.replace(this.#url(query));\n  }\n\n  sortValueChanged(sort) {\n    document.querySelectorAll(this.#sortSelector).forEach((input) => {\n      if (input) input.value = sort;\n    });\n  }\n\n  get #sortSelector() {\n    return \"input[name='sort']\";\n  }\n\n  #url(query) {\n    const frame = this.element.closest(\"turbo-frame\");\n    let url;\n\n    if (frame) {\n      url = new URL(frame.baseURI);\n    } else {\n      url = new URL(window.location.href);\n    }\n\n    url.search = query;\n\n    return url;\n  }\n}\n","import { Controller } from \"@hotwired/stimulus\";\n\nexport default class OrderableRowController extends Controller {\n  static values = {\n    params: Object,\n  };\n\n  connect() {\n    // index from server may be inconsistent with the visual ordering,\n    // especially if this is a new node. Use positional indexes instead,\n    // as these are the values we will send on save.\n    this.index = domIndex(this.row);\n  }\n\n  paramsValueChanged(params) {\n    this.id = params.id_value;\n  }\n\n  dragUpdate(offset) {\n    this.dragOffset = offset;\n    this.row.style.position = \"relative\";\n    this.row.style.top = offset + \"px\";\n    this.row.style.zIndex = \"1\";\n    this.row.toggleAttribute(\"dragging\", true);\n  }\n\n  /**\n   * Called on items that are not the dragged item during drag. Updates the\n   * visual position of the item relative to the dragged item.\n   *\n   * @param index {number} intended index of the item during drag\n   */\n  updateVisually(index) {\n    this.row.style.position = \"relative\";\n    this.row.style.top = `${\n      this.row.offsetHeight * (index - this.dragIndex)\n    }px`;\n  }\n\n  /**\n   * Set the index value of the item. This is called on all items after a drop\n   * event. If the index is different to the params index then this item has\n   * changed.\n   *\n   * @param index {number} the new index value\n   */\n  updateIndex(index) {\n    this.index = index;\n  }\n\n  /**\n   * Restore any visual changes made during drag and remove the drag state.\n   */\n  reset() {\n    delete this.dragOffset;\n    this.row.removeAttribute(\"style\");\n    this.row.removeAttribute(\"dragging\");\n  }\n\n  /**\n   * @returns {boolean} true when the item has a change to its index value\n   */\n  get hasChanges() {\n    return this.paramsValue.index_value !== this.index;\n  }\n\n  /**\n   * Calculate the relative index of the item during drag. This is used to\n   * sort items during drag as it takes into account any uncommitted changes\n   * to index caused by the drag offset.\n   *\n   * @returns {number} index for the purposes of drag and drop ordering\n   */\n  get dragIndex() {\n    if (this.dragOffset && this.dragOffset !== 0) {\n      return this.index + Math.round(this.dragOffset / this.row.offsetHeight);\n    } else {\n      return this.index;\n    }\n  }\n\n  /**\n   * Index value for use in comparisons during drag. This is used to determine\n   * whether the dragged item is above or below another item. If this item is\n   * being dragged then we offset the index by 0.5 to ensure that it jumps up\n   * or down when it reaches the midpoint of the item above or below it.\n   *\n   * @returns {number}\n   */\n  get comparisonIndex() {\n    if (this.dragOffset) {\n      return this.dragIndex + (this.dragOffset > 0 ? 0.5 : -0.5);\n    } else {\n      return this.index;\n    }\n  }\n\n  /**\n   * The containing row element.\n   *\n   * @returns {HTMLElement}\n   */\n  get row() {\n    return this.element.parentElement;\n  }\n}\n\nfunction domIndex(element) {\n  return Array.from(element.parentElement.children).indexOf(element);\n}\n","import { Controller } from \"@hotwired/stimulus\";\n\nexport default class OrderableFormController extends Controller {\n  add(item) {\n    const { id_name, id_value, index_name } = item.paramsValue;\n    this.element.insertAdjacentHTML(\n      \"beforeend\",\n      `<input type=\"hidden\" name=\"${id_name}\" value=\"${id_value}\" data-generated>\n              <input type=\"hidden\" name=\"${index_name}\" value=\"${item.index}\" data-generated>`\n    );\n  }\n\n  submit() {\n    if (this.inputs.length === 0) return;\n\n    this.element.requestSubmit();\n  }\n\n  clear() {\n    this.inputs.forEach((input) => input.remove());\n  }\n\n  get inputs() {\n    return this.element.querySelectorAll(\"input[data-generated]\");\n  }\n}\n"],"names":["DragState","constructor","list","event","id","this","cursorOffset","offsetY","initialPosition","target","offsetTop","targetId","updateCursor","row","callback","listOffset","getBoundingClientRect","top","itemPosition","clientY","updateItemPosition","updateScroll","previousScrollOffset","scrollDelta","position","Math","max","min","offsetHeight","Definitions","identifier","controllerConstructor","Controller","static","query","String","sort","queryValueChanged","Turbo","navigator","history","replace","url","sortValueChanged","document","querySelectorAll","sortSelector","forEach","input","value","frame","element","closest","URL","baseURI","window","location","href","search","params","Object","connect","index","Array","from","parentElement","children","indexOf","paramsValueChanged","id_value","dragUpdate","offset","dragOffset","style","zIndex","toggleAttribute","updateVisually","dragIndex","updateIndex","reset","removeAttribute","hasChanges","paramsValue","index_value","round","comparisonIndex","startDragging","dragState","addEventListener","mousemove","mouseup","scroll","stopDragging","removeEventListener","tablesOrderableItemOutlets","item","drop","dragItem","newIndex","targetItem","insertAdjacentElement","commitChanges","tablesOrderableFormOutlet","clear","add","submit","mousedown","isDragging","preventDefault","animate","ticking","requestAnimationFrame","tablesOrderableFormOutlets","form","tablesOrderableFormOutletConnected","tablesOrderableFormOutletDisconnected","currentItems","find","toSorted","a","b","id_name","index_name","insertAdjacentHTML","inputs","length","requestSubmit","remove"],"mappings":"8FA8NA,MAAMA,EAMJ,WAAAC,CAAYC,EAAMC,EAAOC,GAEvBC,KAAKC,aAAeH,EAAMI,QAG1BF,KAAKG,gBAAkBL,EAAMM,OAAOC,UAAYR,EAAKQ,UAGrDL,KAAKM,SAAWP,CACjB,CAUD,YAAAQ,CAAaV,EAAMW,EAAKV,EAAOW,GAG7BT,KAAKU,WAAab,EAAKc,wBAAwBC,IAO/C,IAAIC,EAHmBf,EAAMgB,QAAUd,KAAKU,WAGRV,KAAKC,aAEzCD,MAAKe,EAAoBlB,EAAMW,EAAKK,EAAcJ,EACnD,CAUD,YAAAO,CAAanB,EAAMW,EAAKC,GACtB,MAAMQ,EAAuBjB,KAAKU,WAIlCV,KAAKU,WAAab,EAAKc,wBAAwBC,IAG/C,MAAMM,EAAcD,EAAuBjB,KAAKU,WAG1CS,EAAWnB,KAAKmB,SAAWD,EAEjClB,MAAKe,EAAoBlB,EAAMW,EAAKW,EAAUV,EAC/C,CAED,EAAAM,CAAoBlB,EAAMW,EAAKW,EAAUV,GAEvCU,EAAWC,KAAKC,IAAIF,EAAU,GAC9BA,EAAWC,KAAKE,IAAIH,EAAUtB,EAAK0B,aAAef,EAAIe,cAGtDvB,KAAKmB,SAAWA,EAShBV,EAJeU,EAAWnB,KAAKG,gBAKhC,ECzSE,MAACqB,EAAc,CAClB,CACEC,WAAY,4BACZC,sBCLW,cAAwCC,EACrDC,cAAgB,CACdC,MAAOC,OACPC,KAAMD,QAGR,iBAAAE,CAAkBH,GAChBI,EAAMC,UAAUC,QAAQC,QAAQpC,MAAKqC,EAAKR,GAC3C,CAED,gBAAAS,CAAiBP,GACfQ,SAASC,iBAAiBxC,MAAKyC,GAAeC,SAASC,IACjDA,IAAOA,EAAMC,MAAQb,EAAI,GAEhC,CAED,KAAIU,GACF,MAAO,oBACR,CAED,EAAAJ,CAAKR,GACH,MAAMgB,EAAQ7C,KAAK8C,QAAQC,QAAQ,eACnC,IAAIV,EAUJ,OAPEA,EADEQ,EACI,IAAIG,IAAIH,EAAMI,SAEd,IAAID,IAAIE,OAAOC,SAASC,MAGhCf,EAAIgB,OAASxB,EAENQ,CACR,ID1BD,CACEZ,WAAY,0BACZC,sBEVW,cAAqCC,EAClDC,cAAgB,CACd0B,OAAQC,QAGV,OAAAC,GAoGF,IAAkBV,EAhGd9C,KAAKyD,OAgGSX,EAhGQ9C,KAAKQ,IAiGtBkD,MAAMC,KAAKb,EAAQc,cAAcC,UAAUC,QAAQhB,GAhGzD,CAED,kBAAAiB,CAAmBT,GACjBtD,KAAKD,GAAKuD,EAAOU,QAClB,CAED,UAAAC,CAAWC,GACTlE,KAAKmE,WAAaD,EAClBlE,KAAKQ,IAAI4D,MAAMjD,SAAW,WAC1BnB,KAAKQ,IAAI4D,MAAMxD,IAAMsD,EAAS,KAC9BlE,KAAKQ,IAAI4D,MAAMC,OAAS,IACxBrE,KAAKQ,IAAI8D,gBAAgB,YAAY,EACtC,CAQD,cAAAC,CAAed,GACbzD,KAAKQ,IAAI4D,MAAMjD,SAAW,WAC1BnB,KAAKQ,IAAI4D,MAAMxD,IACbZ,KAAKQ,IAAIe,cAAgBkC,EAAQzD,KAAKwE,WADnB,IAGtB,CASD,WAAAC,CAAYhB,GACVzD,KAAKyD,MAAQA,CACd,CAKD,KAAAiB,UACS1E,KAAKmE,WACZnE,KAAKQ,IAAImE,gBAAgB,SACzB3E,KAAKQ,IAAImE,gBAAgB,WAC1B,CAKD,cAAIC,GACF,OAAO5E,KAAK6E,YAAYC,cAAgB9E,KAAKyD,KAC9C,CASD,aAAIe,GACF,OAAIxE,KAAKmE,YAAkC,IAApBnE,KAAKmE,WACnBnE,KAAKyD,MAAQrC,KAAK2D,MAAM/E,KAAKmE,WAAanE,KAAKQ,IAAIe,cAEnDvB,KAAKyD,KAEf,CAUD,mBAAIuB,GACF,OAAIhF,KAAKmE,WACAnE,KAAKwE,WAAaxE,KAAKmE,WAAa,EAAI,IAAO,IAE/CnE,KAAKyD,KAEf,CAOD,OAAIjD,GACF,OAAOR,KAAK8C,QAAQc,aACrB,IF1FD,CACEnC,WAAY,0BACZC,sBDdW,cAAsCC,EACnDC,eAAiB,CAAC,0BAA2B,2BAI7C,aAAAqD,CAAcC,GACZlF,KAAKkF,UAAYA,EAEjB3C,SAAS4C,iBAAiB,YAAanF,KAAKoF,WAC5C7C,SAAS4C,iBAAiB,UAAWnF,KAAKqF,SAC1CnC,OAAOiC,iBAAiB,SAAUnF,KAAKsF,QAAQ,GAE/CtF,KAAK8C,QAAQsB,MAAMjD,SAAW,UAC/B,CAED,YAAAoE,GACE,MAAML,EAAYlF,KAAKkF,UAUvB,cATOlF,KAAKkF,UAEZ3C,SAASiD,oBAAoB,YAAaxF,KAAKoF,WAC/C7C,SAASiD,oBAAoB,UAAWxF,KAAKqF,SAC7CnC,OAAOsC,oBAAoB,SAAUxF,KAAKsF,QAAQ,GAElDtF,KAAK8C,QAAQ6B,gBAAgB,SAC7B3E,KAAKyF,2BAA2B/C,SAASgD,GAASA,EAAKhB,UAEhDQ,CACR,CAED,IAAAS,GAKE,MAAMC,EAAW5F,KAAK4F,SAEtB,IAAKA,EAAU,OAEf,MAAMC,EAAWD,EAASpB,UACpBsB,EAAa9F,KAAKyF,2BAA2BI,GAE9CC,IAGDD,EAAWD,EAASnC,MACtBqC,EAAWtF,IAAIuF,sBAAsB,cAAeH,EAASpF,KACpDqF,EAAWD,EAASnC,OAC7BqC,EAAWtF,IAAIuF,sBAAsB,WAAYH,EAASpF,KAI5DR,KAAKyF,2BAA2B/C,SAAQ,CAACgD,EAAMjC,IAC7CiC,EAAKjB,YAAYhB,KAInBzD,KAAKgG,gBACN,CAED,aAAAA,GAEEhG,KAAKiG,0BAA0BC,QAG/BlG,KAAKyF,2BAA2B/C,SAASgD,IACnCA,EAAKd,YAAY5E,KAAKiG,0BAA0BE,IAAIT,EAAK,IAG/D1F,KAAKiG,0BAA0BG,QAChC,CAMD,SAAAC,CAAUvG,GACR,GAAIE,KAAKsG,WAAY,OAErB,MAAMlG,EAASJ,MAAK8F,EAAYhG,EAAMM,QAEjCA,IAELN,EAAMyG,iBAENvG,KAAKiF,cAAc,IAAItF,EAAUK,KAAK8C,QAAShD,EAAOM,EAAOL,KAE7DC,KAAKkF,UAAU3E,aAAaP,KAAK8C,QAAS1C,EAAOI,IAAKV,EAAOE,KAAKwG,SACnE,CAEDpB,UAAatF,IACNE,KAAKsG,aAEVxG,EAAMyG,iBAEFvG,KAAKyG,UAETzG,KAAKyG,SAAU,EAEfvD,OAAOwD,uBAAsB,KAC3B1G,KAAKyG,SAAU,EACfzG,KAAKkF,UAAU3E,aACbP,KAAK8C,QACL9C,KAAK4F,SAASpF,IACdV,EACAE,KAAKwG,QACN,KACD,EAGJlB,OAAUxF,IACHE,KAAKsG,aAActG,KAAKyG,UAE7BzG,KAAKyG,SAAU,EAEfvD,OAAOwD,uBAAsB,KAC3B1G,KAAKyG,SAAU,EACfzG,KAAKkF,UAAUlE,aACbhB,KAAK8C,QACL9C,KAAK4F,SAASpF,IACdR,KAAKwG,QACN,IACD,EAGJnB,QAAWvF,IACJE,KAAKsG,aAEVtG,KAAK2F,OACL3F,KAAKuF,eACLvF,KAAK2G,2BAA2BjE,SAASkE,UAAgBA,EAAK1B,YAAU,EAG1E,kCAAA2B,CAAmCD,EAAM9D,GACnC8D,EAAK1B,WAEPlF,KAAKiF,cAAc2B,EAAK1B,UAE3B,CAED,qCAAA4B,CAAsCF,EAAM9D,GACtC9C,KAAKsG,aAEPM,EAAK1B,UAAYlF,KAAKuF,eAEzB,CAaDiB,QAAWtC,IACT,MAAM0B,EAAW5F,KAAK4F,SAGtBA,EAAS3B,WAAWC,GAIpBlE,MAAK+G,EAAcrE,SAAQ,CAACgD,EAAMjC,KAC5BiC,IAASE,GACbF,EAAKnB,eAAed,EAAM,GAC1B,EAGJ,cAAI6C,GACF,QAAStG,KAAKkF,SACf,CAED,YAAIU,GACF,OAAK5F,KAAKsG,WAEHtG,KAAKyF,2BAA2BuB,MACpCtB,GAASA,EAAK3F,KAAOC,KAAKkF,UAAU5E,WAHV,IAK9B,CAQD,KAAIyG,GACF,OAAO/G,KAAKyF,2BAA2BwB,UACrC,CAACC,EAAGC,IAAMD,EAAElC,gBAAkBmC,EAAEnC,iBAEnC,CAQD,EAAAc,CAAYhD,GACV,OAAO9C,KAAKyF,2BAA2BuB,MACpCtB,GAASA,EAAK5C,UAAYA,GAE9B,IC7LD,CACErB,WAAY,0BACZC,sBGlBW,cAAsCC,EACnD,GAAAwE,CAAIT,GACF,MAAM0B,QAAEA,EAAOpD,SAAEA,EAAQqD,WAAEA,GAAe3B,EAAKb,YAC/C7E,KAAK8C,QAAQwE,mBACX,YACA,8BAA8BF,aAAmBpD,gEACZqD,aAAsB3B,EAAKjC,yBAEnE,CAED,MAAA2C,GAC6B,IAAvBpG,KAAKuH,OAAOC,QAEhBxH,KAAK8C,QAAQ2E,eACd,CAED,KAAAvB,GACElG,KAAKuH,OAAO7E,SAASC,GAAUA,EAAM+E,UACtC,CAED,UAAIH,GACF,OAAOvH,KAAK8C,QAAQN,iBAAiB,wBACtC"}
+{"version":3,"file":"tables.min.js","sources":["../../../javascript/tables/orderable/list_controller.js","../../../javascript/tables/application.js","../../../javascript/tables/turbo/collection_controller.js","../../../javascript/tables/orderable/item_controller.js","../../../javascript/tables/orderable/form_controller.js"],"sourcesContent":["import { Controller } from \"@hotwired/stimulus\";\n\nexport default class OrderableListController extends Controller {\n  static outlets = [\"tables--orderable--item\", \"tables--orderable--form\"];\n\n  //region State transitions\n\n  startDragging(dragState) {\n    this.dragState = dragState;\n\n    document.addEventListener(\"mousemove\", this.mousemove);\n    document.addEventListener(\"mouseup\", this.mouseup);\n    window.addEventListener(\"scroll\", this.scroll, true);\n\n    this.element.style.position = \"relative\";\n  }\n\n  stopDragging() {\n    const dragState = this.dragState;\n    delete this.dragState;\n\n    document.removeEventListener(\"mousemove\", this.mousemove);\n    document.removeEventListener(\"mouseup\", this.mouseup);\n    window.removeEventListener(\"scroll\", this.scroll, true);\n\n    this.element.removeAttribute(\"style\");\n    this.tablesOrderableItemOutlets.forEach((item) => item.reset());\n\n    return dragState;\n  }\n\n  drop() {\n    // note: early returns guard against turbo updates that prevent us finding\n    // the right item to drop on. In this situation it's better to discard the\n    // drop than to drop in the wrong place.\n\n    const dragItem = this.dragItem;\n\n    if (!dragItem) return;\n\n    const newIndex = dragItem.dragIndex;\n    const targetItem = this.tablesOrderableItemOutlets[newIndex];\n\n    if (!targetItem) return;\n\n    // swap the dragged item into the correct position for its current offset\n    if (newIndex < dragItem.index) {\n      targetItem.row.insertAdjacentElement(\"beforebegin\", dragItem.row);\n    } else if (newIndex > dragItem.index) {\n      targetItem.row.insertAdjacentElement(\"afterend\", dragItem.row);\n    }\n\n    // reindex all items based on their new positions\n    this.tablesOrderableItemOutlets.forEach((item, index) =>\n      item.updateIndex(index),\n    );\n\n    // save the changes\n    this.commitChanges();\n  }\n\n  commitChanges() {\n    // clear any existing inputs to prevent duplicates\n    this.tablesOrderableFormOutlet.clear();\n\n    // insert any items that have changed position\n    this.tablesOrderableItemOutlets.forEach((item) => {\n      if (item.hasChanges) this.tablesOrderableFormOutlet.add(item);\n    });\n\n    this.tablesOrderableFormOutlet.submit();\n  }\n\n  //endregion\n\n  //region Events\n\n  mousedown(event) {\n    if (this.isDragging) return;\n\n    const target = this.#targetItem(event.target);\n\n    if (!target) return;\n\n    event.preventDefault(); // prevent built-in drag\n\n    this.startDragging(new DragState(this.element, event, target.id));\n\n    this.dragState.updateCursor(this.element, target.row, event, this.animate);\n  }\n\n  mousemove = (event) => {\n    if (!this.isDragging) return;\n\n    event.preventDefault(); // prevent build-in drag\n\n    if (this.ticking) return;\n\n    this.ticking = true;\n\n    window.requestAnimationFrame(() => {\n      this.ticking = false;\n      this.dragState.updateCursor(\n        this.element,\n        this.dragItem.row,\n        event,\n        this.animate,\n      );\n    });\n  };\n\n  scroll = (event) => {\n    if (!this.isDragging || this.ticking) return;\n\n    this.ticking = true;\n\n    window.requestAnimationFrame(() => {\n      this.ticking = false;\n      this.dragState.updateScroll(\n        this.element,\n        this.dragItem.row,\n        this.animate,\n      );\n    });\n  };\n\n  mouseup = (event) => {\n    if (!this.isDragging) return;\n\n    this.drop();\n    this.stopDragging();\n    this.tablesOrderableFormOutlets.forEach((form) => delete form.dragState);\n  };\n\n  tablesOrderableFormOutletConnected(form, element) {\n    if (form.dragState) {\n      // restore the previous controller's state\n      this.startDragging(form.dragState);\n    }\n  }\n\n  tablesOrderableFormOutletDisconnected(form, element) {\n    if (this.isDragging) {\n      // cache drag state in the form\n      form.dragState = this.stopDragging();\n    }\n  }\n\n  //endregion\n\n  //region Helpers\n\n  /**\n   * Updates the position of the drag item with a relative offset. Updates\n   * other items relative to the new position of the drag item, as required.\n   *\n   * @callback {OrderableListController~animate}\n   * @param {number} offset\n   */\n  animate = (offset) => {\n    const dragItem = this.dragItem;\n\n    // Visually update the dragItem so it follows the cursor\n    dragItem.dragUpdate(offset);\n\n    // Visually updates the position of all items in the list relative to the\n    // dragged item. No actual changes to orderings at this stage.\n    this.#currentItems.forEach((item, index) => {\n      if (item === dragItem) return;\n      item.updateVisually(index);\n    });\n  };\n\n  get isDragging() {\n    return !!this.dragState;\n  }\n\n  get dragItem() {\n    if (!this.isDragging) return null;\n\n    return this.tablesOrderableItemOutlets.find(\n      (item) => item.id === this.dragState.targetId,\n    );\n  }\n\n  /**\n   * Returns the current items in the list, sorted by their current index.\n   * Current uses the drag index if the item is being dragged, if set.\n   *\n   * @returns {Array[OrderableRowController]}\n   */\n  get #currentItems() {\n    return this.tablesOrderableItemOutlets.toSorted(\n      (a, b) => a.comparisonIndex - b.comparisonIndex,\n    );\n  }\n\n  /**\n   * Returns the item outlet that was clicked on, if any.\n   *\n   * @param element {HTMLElement} the clicked ordinal cell\n   * @returns {OrderableRowController}\n   */\n  #targetItem(element) {\n    return this.tablesOrderableItemOutlets.find(\n      (item) => item.element === element,\n    );\n  }\n\n  //endregion\n}\n\n/**\n * During drag we want to be able to translate a document-relative coordinate\n * into a coordinate relative to the list element. This state object calculates\n * and stores internal state so that we can translate absolute page coordinates\n * from mouse events into relative offsets for the list items within the list\n * element.\n *\n * We also keep track of the drag target so that if the controller is attached\n * to a new element during the drag we can continue after the turbo update.\n */\nclass DragState {\n  /**\n   * @param list {HTMLElement} the list controller's element (tbody)\n   * @param event {MouseEvent} the initial event\n   * @param id {String} the id of the element being dragged\n   */\n  constructor(list, event, id) {\n    // cursor offset is the offset of the cursor relative to the drag item\n    this.cursorOffset = event.offsetY;\n\n    // initial offset is the offset position of the drag item at drag start\n    this.initialPosition = event.target.offsetTop - list.offsetTop;\n\n    // id of the item being dragged\n    this.targetId = id;\n  }\n\n  /**\n   * Calculates the offset of the drag item relative to its initial position.\n   *\n   * @param list {HTMLElement} the list controller's element (tbody)\n   * @param row {HTMLElement} the row being dragged\n   * @param event {MouseEvent} the current event\n   * @param callback {OrderableListController~animate} updates the drag item with a relative offset\n   */\n  updateCursor(list, row, event, callback) {\n    // Calculate and store the list offset relative to the viewport\n    // This value is cached so we can calculate the outcome of any scroll events\n    this.listOffset = list.getBoundingClientRect().top;\n\n    // Calculate the position of the cursor relative to the list.\n    // Accounts for scroll offsets by using the item's bounding client rect.\n    const cursorPosition = event.clientY - this.listOffset;\n\n    // intended item position relative to the list, from cursor position\n    let itemPosition = cursorPosition - this.cursorOffset;\n\n    this.#updateItemPosition(list, row, itemPosition, callback);\n  }\n\n  /**\n   * Animates the item's position as the list scrolls. Requires a previous call\n   * to set the scroll offset.\n   *\n   * @param list {HTMLElement} the list controller's element (tbody)\n   * @param row {HTMLElement} the row being dragged\n   * @param callback {OrderableListController~animate} updates the drag item with a relative offset\n   */\n  updateScroll(list, row, callback) {\n    const previousScrollOffset = this.listOffset;\n\n    // Calculate and store the list offset relative to the viewport\n    // This value is cached so we can calculate the outcome of any scroll events\n    this.listOffset = list.getBoundingClientRect().top;\n\n    // Calculate the change in scroll offset since the last update\n    const scrollDelta = previousScrollOffset - this.listOffset;\n\n    // intended item position relative to the list, from cursor position\n    const position = this.position + scrollDelta;\n\n    this.#updateItemPosition(list, row, position, callback);\n  }\n\n  #updateItemPosition(list, row, position, callback) {\n    // ensure itemPosition is within the bounds of the list (tbody)\n    position = Math.max(position, 0);\n    position = Math.min(position, list.offsetHeight - row.offsetHeight);\n\n    // cache the item's position relative to the list for use in scroll events\n    this.position = position;\n\n    // Item has position: relative, so we want to calculate the amount to move\n    // the item relative to it's DOM position to represent how much it has been\n    // dragged by.\n    const offset = position - this.initialPosition;\n\n    // Convert itemPosition from offset relative to list to offset relative to\n    // its position within the DOM (if it hadn't moved).\n    callback(offset);\n  }\n}\n","import TurboCollectionController from \"./turbo/collection_controller\";\nimport ItemController from \"./orderable/item_controller\";\nimport ListController from \"./orderable/list_controller\";\nimport FormController from \"./orderable/form_controller\";\n\nconst Definitions = [\n  {\n    identifier: \"tables--turbo--collection\",\n    controllerConstructor: TurboCollectionController,\n  },\n  {\n    identifier: \"tables--orderable--item\",\n    controllerConstructor: ItemController,\n  },\n  {\n    identifier: \"tables--orderable--list\",\n    controllerConstructor: ListController,\n  },\n  {\n    identifier: \"tables--orderable--form\",\n    controllerConstructor: FormController,\n  },\n];\n\nexport { Definitions as default };\n","import { Controller } from \"@hotwired/stimulus\";\nimport { Turbo } from \"@hotwired/turbo-rails\";\n\nexport default class TurboCollectionController extends Controller {\n  static values = {\n    query: String,\n    sort: String,\n  };\n\n  queryValueChanged(query) {\n    Turbo.navigator.history.replace(this.#url(query));\n  }\n\n  sortValueChanged(sort) {\n    document.querySelectorAll(this.#sortSelector).forEach((input) => {\n      if (input) input.value = sort;\n    });\n  }\n\n  get #sortSelector() {\n    return \"input[name='sort']\";\n  }\n\n  #url(query) {\n    const frame = this.element.closest(\"turbo-frame\");\n    let url;\n\n    if (frame) {\n      url = new URL(frame.baseURI);\n    } else {\n      url = new URL(window.location.href);\n    }\n\n    url.search = query;\n\n    return url;\n  }\n}\n","import { Controller } from \"@hotwired/stimulus\";\n\nexport default class OrderableRowController extends Controller {\n  static values = {\n    params: Object,\n  };\n\n  connect() {\n    // index from server may be inconsistent with the visual ordering,\n    // especially if this is a new node. Use positional indexes instead,\n    // as these are the values we will send on save.\n    this.index = domIndex(this.row);\n  }\n\n  paramsValueChanged(params) {\n    this.id = params.id_value;\n  }\n\n  dragUpdate(offset) {\n    this.dragOffset = offset;\n    this.row.style.position = \"relative\";\n    this.row.style.top = offset + \"px\";\n    this.row.style.zIndex = \"1\";\n    this.row.toggleAttribute(\"dragging\", true);\n  }\n\n  /**\n   * Called on items that are not the dragged item during drag. Updates the\n   * visual position of the item relative to the dragged item.\n   *\n   * @param index {number} intended index of the item during drag\n   */\n  updateVisually(index) {\n    this.row.style.position = \"relative\";\n    this.row.style.top = `${\n      this.row.offsetHeight * (index - this.dragIndex)\n    }px`;\n  }\n\n  /**\n   * Set the index value of the item. This is called on all items after a drop\n   * event. If the index is different to the params index then this item has\n   * changed.\n   *\n   * @param index {number} the new index value\n   */\n  updateIndex(index) {\n    this.index = index;\n  }\n\n  /**\n   * Restore any visual changes made during drag and remove the drag state.\n   */\n  reset() {\n    delete this.dragOffset;\n    this.row.removeAttribute(\"style\");\n    this.row.removeAttribute(\"dragging\");\n  }\n\n  /**\n   * @returns {boolean} true when the item has a change to its index value\n   */\n  get hasChanges() {\n    return this.paramsValue.index_value !== this.index;\n  }\n\n  /**\n   * Calculate the relative index of the item during drag. This is used to\n   * sort items during drag as it takes into account any uncommitted changes\n   * to index caused by the drag offset.\n   *\n   * @returns {number} index for the purposes of drag and drop ordering\n   */\n  get dragIndex() {\n    if (this.dragOffset && this.dragOffset !== 0) {\n      return this.index + Math.round(this.dragOffset / this.row.offsetHeight);\n    } else {\n      return this.index;\n    }\n  }\n\n  /**\n   * Index value for use in comparisons during drag. This is used to determine\n   * whether the dragged item is above or below another item. If this item is\n   * being dragged then we offset the index by 0.5 to ensure that it jumps up\n   * or down when it reaches the midpoint of the item above or below it.\n   *\n   * @returns {number}\n   */\n  get comparisonIndex() {\n    if (this.dragOffset) {\n      return this.dragIndex + (this.dragOffset > 0 ? 0.5 : -0.5);\n    } else {\n      return this.index;\n    }\n  }\n\n  /**\n   * The containing row element.\n   *\n   * @returns {HTMLElement}\n   */\n  get row() {\n    return this.element.parentElement;\n  }\n}\n\nfunction domIndex(element) {\n  return Array.from(element.parentElement.children).indexOf(element);\n}\n","import { Controller } from \"@hotwired/stimulus\";\n\nexport default class OrderableFormController extends Controller {\n  add(item) {\n    const { id_name, id_value, index_name } = item.paramsValue;\n    this.element.insertAdjacentHTML(\n      \"beforeend\",\n      `<input type=\"hidden\" name=\"${id_name}\" value=\"${id_value}\" data-generated>\n              <input type=\"hidden\" name=\"${index_name}\" value=\"${item.index}\" data-generated>`,\n    );\n  }\n\n  submit() {\n    if (this.inputs.length === 0) return;\n\n    this.element.requestSubmit();\n  }\n\n  clear() {\n    this.inputs.forEach((input) => input.remove());\n  }\n\n  get inputs() {\n    return this.element.querySelectorAll(\"input[data-generated]\");\n  }\n}\n"],"names":["DragState","constructor","list","event","id","this","cursorOffset","offsetY","initialPosition","target","offsetTop","targetId","updateCursor","row","callback","listOffset","getBoundingClientRect","top","itemPosition","clientY","updateItemPosition","updateScroll","previousScrollOffset","scrollDelta","position","Math","max","min","offsetHeight","Definitions","identifier","controllerConstructor","Controller","static","query","String","sort","queryValueChanged","Turbo","navigator","history","replace","url","sortValueChanged","document","querySelectorAll","sortSelector","forEach","input","value","frame","element","closest","URL","baseURI","window","location","href","search","params","Object","connect","index","Array","from","parentElement","children","indexOf","paramsValueChanged","id_value","dragUpdate","offset","dragOffset","style","zIndex","toggleAttribute","updateVisually","dragIndex","updateIndex","reset","removeAttribute","hasChanges","paramsValue","index_value","round","comparisonIndex","startDragging","dragState","addEventListener","mousemove","mouseup","scroll","stopDragging","removeEventListener","tablesOrderableItemOutlets","item","drop","dragItem","newIndex","targetItem","insertAdjacentElement","commitChanges","tablesOrderableFormOutlet","clear","add","submit","mousedown","isDragging","preventDefault","animate","ticking","requestAnimationFrame","tablesOrderableFormOutlets","form","tablesOrderableFormOutletConnected","tablesOrderableFormOutletDisconnected","currentItems","find","toSorted","a","b","id_name","index_name","insertAdjacentHTML","inputs","length","requestSubmit","remove"],"mappings":"8FA8NA,MAAMA,EAMJ,WAAAC,CAAYC,EAAMC,EAAOC,GAEvBC,KAAKC,aAAeH,EAAMI,QAG1BF,KAAKG,gBAAkBL,EAAMM,OAAOC,UAAYR,EAAKQ,UAGrDL,KAAKM,SAAWP,CACjB,CAUD,YAAAQ,CAAaV,EAAMW,EAAKV,EAAOW,GAG7BT,KAAKU,WAAab,EAAKc,wBAAwBC,IAO/C,IAAIC,EAHmBf,EAAMgB,QAAUd,KAAKU,WAGRV,KAAKC,aAEzCD,MAAKe,EAAoBlB,EAAMW,EAAKK,EAAcJ,EACnD,CAUD,YAAAO,CAAanB,EAAMW,EAAKC,GACtB,MAAMQ,EAAuBjB,KAAKU,WAIlCV,KAAKU,WAAab,EAAKc,wBAAwBC,IAG/C,MAAMM,EAAcD,EAAuBjB,KAAKU,WAG1CS,EAAWnB,KAAKmB,SAAWD,EAEjClB,MAAKe,EAAoBlB,EAAMW,EAAKW,EAAUV,EAC/C,CAED,EAAAM,CAAoBlB,EAAMW,EAAKW,EAAUV,GAEvCU,EAAWC,KAAKC,IAAIF,EAAU,GAC9BA,EAAWC,KAAKE,IAAIH,EAAUtB,EAAK0B,aAAef,EAAIe,cAGtDvB,KAAKmB,SAAWA,EAShBV,EAJeU,EAAWnB,KAAKG,gBAKhC,ECzSE,MAACqB,EAAc,CAClB,CACEC,WAAY,4BACZC,sBCLW,cAAwCC,EACrDC,cAAgB,CACdC,MAAOC,OACPC,KAAMD,QAGR,iBAAAE,CAAkBH,GAChBI,EAAMC,UAAUC,QAAQC,QAAQpC,MAAKqC,EAAKR,GAC3C,CAED,gBAAAS,CAAiBP,GACfQ,SAASC,iBAAiBxC,MAAKyC,GAAeC,SAASC,IACjDA,IAAOA,EAAMC,MAAQb,EAAI,GAEhC,CAED,KAAIU,GACF,MAAO,oBACR,CAED,EAAAJ,CAAKR,GACH,MAAMgB,EAAQ7C,KAAK8C,QAAQC,QAAQ,eACnC,IAAIV,EAUJ,OAPEA,EADEQ,EACI,IAAIG,IAAIH,EAAMI,SAEd,IAAID,IAAIE,OAAOC,SAASC,MAGhCf,EAAIgB,OAASxB,EAENQ,CACR,ID1BD,CACEZ,WAAY,0BACZC,sBEVW,cAAqCC,EAClDC,cAAgB,CACd0B,OAAQC,QAGV,OAAAC,GAoGF,IAAkBV,EAhGd9C,KAAKyD,OAgGSX,EAhGQ9C,KAAKQ,IAiGtBkD,MAAMC,KAAKb,EAAQc,cAAcC,UAAUC,QAAQhB,GAhGzD,CAED,kBAAAiB,CAAmBT,GACjBtD,KAAKD,GAAKuD,EAAOU,QAClB,CAED,UAAAC,CAAWC,GACTlE,KAAKmE,WAAaD,EAClBlE,KAAKQ,IAAI4D,MAAMjD,SAAW,WAC1BnB,KAAKQ,IAAI4D,MAAMxD,IAAMsD,EAAS,KAC9BlE,KAAKQ,IAAI4D,MAAMC,OAAS,IACxBrE,KAAKQ,IAAI8D,gBAAgB,YAAY,EACtC,CAQD,cAAAC,CAAed,GACbzD,KAAKQ,IAAI4D,MAAMjD,SAAW,WAC1BnB,KAAKQ,IAAI4D,MAAMxD,IACbZ,KAAKQ,IAAIe,cAAgBkC,EAAQzD,KAAKwE,WADnB,IAGtB,CASD,WAAAC,CAAYhB,GACVzD,KAAKyD,MAAQA,CACd,CAKD,KAAAiB,UACS1E,KAAKmE,WACZnE,KAAKQ,IAAImE,gBAAgB,SACzB3E,KAAKQ,IAAImE,gBAAgB,WAC1B,CAKD,cAAIC,GACF,OAAO5E,KAAK6E,YAAYC,cAAgB9E,KAAKyD,KAC9C,CASD,aAAIe,GACF,OAAIxE,KAAKmE,YAAkC,IAApBnE,KAAKmE,WACnBnE,KAAKyD,MAAQrC,KAAK2D,MAAM/E,KAAKmE,WAAanE,KAAKQ,IAAIe,cAEnDvB,KAAKyD,KAEf,CAUD,mBAAIuB,GACF,OAAIhF,KAAKmE,WACAnE,KAAKwE,WAAaxE,KAAKmE,WAAa,EAAI,IAAO,IAE/CnE,KAAKyD,KAEf,CAOD,OAAIjD,GACF,OAAOR,KAAK8C,QAAQc,aACrB,IF1FD,CACEnC,WAAY,0BACZC,sBDdW,cAAsCC,EACnDC,eAAiB,CAAC,0BAA2B,2BAI7C,aAAAqD,CAAcC,GACZlF,KAAKkF,UAAYA,EAEjB3C,SAAS4C,iBAAiB,YAAanF,KAAKoF,WAC5C7C,SAAS4C,iBAAiB,UAAWnF,KAAKqF,SAC1CnC,OAAOiC,iBAAiB,SAAUnF,KAAKsF,QAAQ,GAE/CtF,KAAK8C,QAAQsB,MAAMjD,SAAW,UAC/B,CAED,YAAAoE,GACE,MAAML,EAAYlF,KAAKkF,UAUvB,cATOlF,KAAKkF,UAEZ3C,SAASiD,oBAAoB,YAAaxF,KAAKoF,WAC/C7C,SAASiD,oBAAoB,UAAWxF,KAAKqF,SAC7CnC,OAAOsC,oBAAoB,SAAUxF,KAAKsF,QAAQ,GAElDtF,KAAK8C,QAAQ6B,gBAAgB,SAC7B3E,KAAKyF,2BAA2B/C,SAASgD,GAASA,EAAKhB,UAEhDQ,CACR,CAED,IAAAS,GAKE,MAAMC,EAAW5F,KAAK4F,SAEtB,IAAKA,EAAU,OAEf,MAAMC,EAAWD,EAASpB,UACpBsB,EAAa9F,KAAKyF,2BAA2BI,GAE9CC,IAGDD,EAAWD,EAASnC,MACtBqC,EAAWtF,IAAIuF,sBAAsB,cAAeH,EAASpF,KACpDqF,EAAWD,EAASnC,OAC7BqC,EAAWtF,IAAIuF,sBAAsB,WAAYH,EAASpF,KAI5DR,KAAKyF,2BAA2B/C,SAAQ,CAACgD,EAAMjC,IAC7CiC,EAAKjB,YAAYhB,KAInBzD,KAAKgG,gBACN,CAED,aAAAA,GAEEhG,KAAKiG,0BAA0BC,QAG/BlG,KAAKyF,2BAA2B/C,SAASgD,IACnCA,EAAKd,YAAY5E,KAAKiG,0BAA0BE,IAAIT,EAAK,IAG/D1F,KAAKiG,0BAA0BG,QAChC,CAMD,SAAAC,CAAUvG,GACR,GAAIE,KAAKsG,WAAY,OAErB,MAAMlG,EAASJ,MAAK8F,EAAYhG,EAAMM,QAEjCA,IAELN,EAAMyG,iBAENvG,KAAKiF,cAAc,IAAItF,EAAUK,KAAK8C,QAAShD,EAAOM,EAAOL,KAE7DC,KAAKkF,UAAU3E,aAAaP,KAAK8C,QAAS1C,EAAOI,IAAKV,EAAOE,KAAKwG,SACnE,CAEDpB,UAAatF,IACNE,KAAKsG,aAEVxG,EAAMyG,iBAEFvG,KAAKyG,UAETzG,KAAKyG,SAAU,EAEfvD,OAAOwD,uBAAsB,KAC3B1G,KAAKyG,SAAU,EACfzG,KAAKkF,UAAU3E,aACbP,KAAK8C,QACL9C,KAAK4F,SAASpF,IACdV,EACAE,KAAKwG,QACN,KACD,EAGJlB,OAAUxF,IACHE,KAAKsG,aAActG,KAAKyG,UAE7BzG,KAAKyG,SAAU,EAEfvD,OAAOwD,uBAAsB,KAC3B1G,KAAKyG,SAAU,EACfzG,KAAKkF,UAAUlE,aACbhB,KAAK8C,QACL9C,KAAK4F,SAASpF,IACdR,KAAKwG,QACN,IACD,EAGJnB,QAAWvF,IACJE,KAAKsG,aAEVtG,KAAK2F,OACL3F,KAAKuF,eACLvF,KAAK2G,2BAA2BjE,SAASkE,UAAgBA,EAAK1B,YAAU,EAG1E,kCAAA2B,CAAmCD,EAAM9D,GACnC8D,EAAK1B,WAEPlF,KAAKiF,cAAc2B,EAAK1B,UAE3B,CAED,qCAAA4B,CAAsCF,EAAM9D,GACtC9C,KAAKsG,aAEPM,EAAK1B,UAAYlF,KAAKuF,eAEzB,CAaDiB,QAAWtC,IACT,MAAM0B,EAAW5F,KAAK4F,SAGtBA,EAAS3B,WAAWC,GAIpBlE,MAAK+G,EAAcrE,SAAQ,CAACgD,EAAMjC,KAC5BiC,IAASE,GACbF,EAAKnB,eAAed,EAAM,GAC1B,EAGJ,cAAI6C,GACF,QAAStG,KAAKkF,SACf,CAED,YAAIU,GACF,OAAK5F,KAAKsG,WAEHtG,KAAKyF,2BAA2BuB,MACpCtB,GAASA,EAAK3F,KAAOC,KAAKkF,UAAU5E,WAHV,IAK9B,CAQD,KAAIyG,GACF,OAAO/G,KAAKyF,2BAA2BwB,UACrC,CAACC,EAAGC,IAAMD,EAAElC,gBAAkBmC,EAAEnC,iBAEnC,CAQD,EAAAc,CAAYhD,GACV,OAAO9C,KAAKyF,2BAA2BuB,MACpCtB,GAASA,EAAK5C,UAAYA,GAE9B,IC7LD,CACErB,WAAY,0BACZC,sBGlBW,cAAsCC,EACnD,GAAAwE,CAAIT,GACF,MAAM0B,QAAEA,EAAOpD,SAAEA,EAAQqD,WAAEA,GAAe3B,EAAKb,YAC/C7E,KAAK8C,QAAQwE,mBACX,YACA,8BAA8BF,aAAmBpD,gEACZqD,aAAsB3B,EAAKjC,yBAEnE,CAED,MAAA2C,GAC6B,IAAvBpG,KAAKuH,OAAOC,QAEhBxH,KAAK8C,QAAQ2E,eACd,CAED,KAAAvB,GACElG,KAAKuH,OAAO7E,SAASC,GAAUA,EAAM+E,UACtC,CAED,UAAIH,GACF,OAAOvH,KAAK8C,QAAQN,iBAAiB,wBACtC"}

data/app/components/concerns/katalyst/tables/configurable_component.rb

@@ -24,9 +24,9 @@ module Katalyst
         # other tables.
         def config_component(name, component_name: "#{name}_component", default: nil) # rubocop:disable Metrics/MethodLength
           config_accessor(name)
-          config.public_send("#{name}=", default)
+          config.public_send(:"#{name}=", default)
           define_method(component_name) do
-            return instance_variable_get("@#{component_name}") if instance_variable_defined?("@#{component_name}")
+            return instance_variable_get(:"@#{component_name}") if instance_variable_defined?(:"@#{component_name}")
 
             klass     = config.public_send(name)
             component = klass ? self.class.const_get(klass) : nil
@@ -37,7 +37,7 @@ module Katalyst
               component.extend(HiddenSubcomponent)
             end
 
-            instance_variable_set("@#{component_name}", component) if component
+            instance_variable_set(:"@#{component_name}", component) if component
           end
         end
       end

data/app/components/concerns/katalyst/tables/has_table_content.rb

@@ -20,13 +20,24 @@ module Katalyst
       private
 
       def row_proc
-        @row_proc ||= @__vc_render_in_block || method(:row_partial)
+        if @row_proc
+          @row_proc
+        elsif @__vc_render_in_block
+          @row_proc = @__vc_render_in_block
+        else
+          @row_proc = Proc.new do |row, object|
+            row_renderer.render_row(row, object, view_context)
+          end
+        end
       end
 
-      def row_partial(row, record = nil)
-        partial = @partial || model_name&.param_key&.to_s
-        as      = @as || model_name&.param_key&.to_sym
-        render(partial: partial, variants: [:row], formats: [:html], locals: { as => record, row: row })
+      def row_renderer
+        @row_renderer ||= RowRenderer.new(@lookup_context,
+                                          collection: collection,
+                                          as:         @as,
+                                          partial:    @partial,
+                                          variants:   [:row],
+                                          formats:    [:html])
       end
     end
   end

data/app/components/concerns/katalyst/tables/row_renderer.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Tables
+    class RowRenderer < ActionView::PartialRenderer # :nodoc:
+      include ObjectRendering
+
+      def initialize(lookup_context, collection:, partial:, **options)
+        super(lookup_context, options)
+
+        @collection = collection
+        @partial    = partial
+      end
+
+      def render_row(row, object, view_context)
+        @row    = row
+        @object = object
+
+        if @partial.blank?
+          example  = example_for(@collection)
+          @partial = partial_path(example, view_context) if example.present?
+        end
+
+        # if we still cannot find an example return an empty table (no header row)
+        return "" if @partial.blank?
+
+        @local_name ||= local_variable(@partial)
+        render(@partial, view_context, nil)
+      end
+
+      private
+
+      def example_for(collection)
+        if collection.respond_to?(:items)
+          example_for(collection.items)
+        elsif collection.respond_to?(:any?) && collection.any?
+          collection.first
+        elsif collection.respond_to?(:model)
+          collection.model.new
+        end
+        # if none of the above strategies match, return nil
+      rescue ArgumentError
+        nil # if we could not construct an example without passing arguments, return nil
+      end
+
+      def template_keys(path)
+        super + [@local_name, :row]
+      end
+
+      def render_partial_template(view, locals, template, layout, block)
+        locals[@local_name || template.variable] = @object
+        locals[:row]                             = @row
+        super(view, locals, template, layout, block)
+      end
+    end
+  end
+end

data/app/components/katalyst/table_component.rb

@@ -30,7 +30,7 @@ module Katalyst
     # - `header`: whether to render the header row (defaults to true, supports options)
     # - `caption`: whether to render the caption (defaults to true, supports options)
     # - `object_name`: the name of the object to use for partial rendering (defaults to collection.model_name.i18n_key)
-    # - `partial`: the name of the partial to use for rendering each row (defaults to collection.model_name.param_key)
+    # - `partial`: the name of the partial to use for rendering each row (defaults to to_partial_path on the object)
     # - `as`: the name of the local variable to use for rendering each row (defaults to collection.model_name.param_key)
     # In addition to these options, standard HTML attributes can be passed which will be added to the table tag.
     def initialize(collection:,
@@ -40,7 +40,8 @@ module Katalyst
                    **html_attributes)
       @collection = collection
 
-      # sorting: instance of Katalyst::Tables::Backend::SortForm. If not provided will be inferred from the collection.
+      # sorting: instance of Katalyst::Tables::Collection::SortForm.
+      # If not provided will be inferred from the collection.
       @sorting = sorting || html_attributes.delete(:sort) # backwards compatibility with old `sort` option
 
       # header: true means render the header row, header: false means no header row, if a hash, passes as options

data/{lib → app/controllers/concerns}/katalyst/tables/backend.rb

@@ -1,10 +1,5 @@
 # frozen_string_literal: true
 
-require "active_support"
-require "active_support/concern"
-
-require_relative "backend/sort_form"
-
 module Katalyst
   module Tables
     # Utilities for controllers that are generating collections for visualisation
@@ -14,6 +9,10 @@ module Katalyst
     module Backend
       extend ActiveSupport::Concern
 
+      # @deprecated backwards compatibility
+      class SortForm < Katalyst::Tables::Collection::SortForm
+      end
+
       # Sort the given collection by params[:sort], which is set when a user
       # interacts with a column header in a frontend table view.
       #

data/{lib → app/helpers}/katalyst/tables/frontend.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "frontend/helper"
-
 module Katalyst
   module Tables
     # View Helper for generating HTML tables. Include in your ApplicationHelper, or similar.

data/app/javascript/tables/orderable/form_controller.js

@@ -6,7 +6,7 @@ export default class OrderableFormController extends Controller {
     this.element.insertAdjacentHTML(
       "beforeend",
       `<input type="hidden" name="${id_name}" value="${id_value}" data-generated>
-              <input type="hidden" name="${index_name}" value="${item.index}" data-generated>`
+              <input type="hidden" name="${index_name}" value="${item.index}" data-generated>`,
     );
   }
 

data/app/javascript/tables/orderable/list_controller.js

@@ -52,7 +52,7 @@ export default class OrderableListController extends Controller {
 
     // reindex all items based on their new positions
     this.tablesOrderableItemOutlets.forEach((item, index) =>
-      item.updateIndex(index)
+      item.updateIndex(index),
     );
 
     // save the changes
@@ -104,7 +104,7 @@ export default class OrderableListController extends Controller {
         this.element,
         this.dragItem.row,
         event,
-        this.animate
+        this.animate,
       );
     });
   };
@@ -119,7 +119,7 @@ export default class OrderableListController extends Controller {
       this.dragState.updateScroll(
         this.element,
         this.dragItem.row,
-        this.animate
+        this.animate,
       );
     });
   };
@@ -179,7 +179,7 @@ export default class OrderableListController extends Controller {
     if (!this.isDragging) return null;
 
     return this.tablesOrderableItemOutlets.find(
-      (item) => item.id === this.dragState.targetId
+      (item) => item.id === this.dragState.targetId,
     );
   }
 
@@ -191,7 +191,7 @@ export default class OrderableListController extends Controller {
    */
   get #currentItems() {
     return this.tablesOrderableItemOutlets.toSorted(
-      (a, b) => a.comparisonIndex - b.comparisonIndex
+      (a, b) => a.comparisonIndex - b.comparisonIndex,
     );
   }
 
@@ -203,7 +203,7 @@ export default class OrderableListController extends Controller {
    */
   #targetItem(element) {
     return this.tablesOrderableItemOutlets.find(
-      (item) => item.element === element
+      (item) => item.element === element,
     );
   }
 

data/app/models/concerns/katalyst/tables/collection/core.rb

@@ -11,6 +11,7 @@ module Katalyst
         include ActiveModel::Dirty
         include ActiveSupport::Configurable
 
+        include HasParams
         include Reducers
 
         class_methods do
@@ -29,8 +30,7 @@ module Katalyst
         included do
           attr_accessor :items
 
-          delegate :model, :each, :count, :empty?, to: :items, allow_nil: true
-          delegate :model_name, to: :model, allow_nil: true
+          delegate :each, :count, :empty?, to: :items, allow_nil: true
         end
 
         def initialize(**options)
@@ -39,18 +39,6 @@ module Katalyst
           clear_changes_information
         end
 
-        def filter
-          # no-op by default
-        end
-
-        def filtered?
-          self.class.new.filters != filters
-        end
-
-        def filters
-          attributes.except("page", "sort")
-        end
-
         def apply(items)
           @items = items
           reducers.build do |_|
@@ -59,21 +47,6 @@ module Katalyst
           end.call(self)
           self
         end
-
-        def with_params(params)
-          self.attributes = params.permit(self.class.permitted_params)
-
-          self
-        end
-
-        # Returns a hash of the current attributes that have changed from defaults.
-        def to_params
-          attributes.slice(*changed)
-        end
-
-        def inspect
-          "#<#{self.class.name} @attributes=#{attributes.inspect} @model=\"#{model}\" @count=#{items&.count}>"
-        end
       end
     end
   end

data/app/models/concerns/katalyst/tables/collection/filtering.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Tables
+    module Collection
+      using HasParams
+
+      module Filtering # :nodoc:
+        def filter
+          # no-op by default
+        end
+
+        def filtered?
+          filters.any?
+        end
+
+        def filters
+          changed_attributes.except("sort", "page")
+        end
+      end
+    end
+  end
+end

data/app/models/concerns/katalyst/tables/collection/has_params.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Tables
+    module Collection
+      module HasParams # :nodoc:
+        extend ActiveSupport::Concern
+
+        refine Object do
+          def to_params
+            as_json
+          end
+        end
+
+        refine ActiveModel::AttributeSet do
+          def to_params
+            to_h.transform_values(&:to_params).as_json
+          end
+        end
+
+        refine ActiveModel::Attributes do
+          def to_params
+            if respond_to?(:changed)
+              @attributes.to_params.slice(*changed)
+            else
+              @attributes.to_params
+            end
+          end
+        end
+
+        using HasParams
+
+        # Returns a hash of the current attributes that have changed from defaults.
+        # This uses Refinements internally so it needs to be exposed publicly with this super call.
+        # rubocop:disable Lint/UselessMethodDefinition
+        def to_params
+          super
+        end
+        # rubocop:enable Lint/UselessMethodDefinition
+      end
+    end
+  end
+end

data/app/models/concerns/katalyst/tables/collection/sorting.rb

@@ -22,7 +22,7 @@ module Katalyst
         end
 
         def initialize(sorting: config.sorting, **options)
-          @sorting = Backend::SortForm.parse(sorting) if sorting
+          @sorting = SortForm.parse(sorting) if sorting
 
           super(sort: sorting, **options) # set default sort based on config
         end
@@ -31,7 +31,7 @@ module Katalyst
           return unless @sorting
 
           # update internal proxy
-          @sorting = Backend::SortForm.parse(value, default: attribute_was(:sort))
+          @sorting = SortForm.parse(value, default: attribute_was(:sort))
 
           # update attribute based on normalized value
           super(@sorting.to_param)

data/app/models/katalyst/tables/{collection.rb → collection/base.rb}

@@ -3,7 +3,9 @@
 module Katalyst
   module Tables
     module Collection
-      # Entry point for creating a collection for use with table components.
+      # Entry point for creating a collection for use with table components
+      # where filter params are flat, e.g. ?search=query
+      #
       # This class is intended to be subclassed, i.e.:
       #
       # class ApplicationController < ActionController::Base
@@ -21,11 +23,35 @@ module Katalyst
       # ````
       class Base
         include Core
+        include Filtering
         include Pagination
         include Sorting
 
         use(Sorting::Sort)
         use(Pagination::Paginate)
+
+        def self.with_params(params)
+          new.with_params(params)
+        end
+
+        def model_name
+          @model_name ||= items.model_name.dup.tap do |name|
+            name.param_key = ""
+          end
+        end
+
+        def with_params(params)
+          # test support
+          params = ActionController::Parameters.new(params) unless params.is_a?(ActionController::Parameters)
+
+          self.attributes = params.permit(self.class.permitted_params)
+
+          self
+        end
+
+        def inspect
+          "#<#{self.class.name} @attributes=#{attributes.inspect} @model_name=\"#{model_name}\" @count=#{items&.count}>"
+        end
       end
     end
   end

data/app/models/katalyst/tables/collection/filter.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Tables
+    module Collection
+      # Entry point for creating a collection for use with table components
+      # where filter params are nested, e.g. ?filters[search]=query
+      #
+      # This class is intended to be subclassed, i.e.:
+      #
+      # class ApplicationController < ActionController::Base
+      #   class Collection < Katalyst::Tables::Collection::Base
+      #     ...
+      #   end
+      # end
+      #
+      # In the context of a controller action, construct a collection, apply it
+      # to a model, then pass the result to the view component:
+      # ```
+      # collection = Collection.new.with_params(params).apply(People.all)
+      # table = Katalyst::TableComponent.new(collection: collection)
+      # render table
+      # ````
+      class Filter
+        include Core
+        include Filtering
+        include Pagination
+        include Sorting
+
+        use(Sorting::Sort)
+        use(Pagination::Paginate)
+
+        def self.with_params(params)
+          new.with_params(params)
+        end
+
+        def self.permitted_params
+          super.excluding("sort", "page")
+        end
+
+        attr_reader :param_key
+
+        def initialize(param_key: :filters, **options)
+          super(**options)
+
+          @param_key = param_key.to_sym
+        end
+
+        def model_name
+          @model_name ||= items.model_name.tap do |name|
+            name.param_key = param_key
+          end
+        end
+
+        def with_params(params)
+          params  = params.permit(:sort, :page, param_key => self.class.permitted_params)
+          filters = params[param_key]
+
+          self.attributes = filters if filters.present?
+          self.attributes = params.slice("page", "sort")
+
+          self
+        end
+
+        def to_params
+          if filtered?
+            { param_key.to_s => super.except("sort", "page") }.merge(super.slice("sort", "page"))
+          else
+            super.slice("sort", "page")
+          end
+        end
+
+        def inspect
+          "#<#{self.class.name} @param_key=#{param_key.inspect} " +
+            "@attributes=#{attributes.inspect} @model=\"#{model}\" @count=#{items&.count}>"
+        end
+      end
+    end
+  end
+end

data/{lib/katalyst/tables/backend → app/models/katalyst/tables/collection}/sort_form.rb

@@ -2,7 +2,7 @@
 
 module Katalyst
   module Tables
-    module Backend
+    module Collection
       # A FormObject (model) representing the sort state of controller for a given
       # collection/parameter.
       class SortForm
@@ -37,8 +37,8 @@ module Katalyst
         # @param column [String, Symbol]
         # @return [true, false]
         def supports?(collection, column)
-          collection.respond_to?("order_by_#{column}") ||
-            collection.model.has_attribute?(column.to_s)
+          scope_for(collection).respond_to?(:"order_by_#{column}") ||
+            model_for(collection).has_attribute?(column.to_s)
         end
 
         # Returns the current sort behaviour of the given column, for use as a
@@ -72,8 +72,8 @@ module Katalyst
         def apply(collection)
           return [self, collection] if column.nil?
 
-          if collection.respond_to?("order_by_#{column}")
-            collection = collection.reorder(nil).public_send("order_by_#{column}", direction.to_sym)
+          if collection.respond_to?(:"order_by_#{column}")
+            collection = collection.reorder(nil).public_send(:"order_by_#{column}", direction.to_sym)
           elsif collection.model.has_attribute?(column)
             collection = collection.reorder(column => direction)
           else
@@ -88,6 +88,14 @@ module Katalyst
         def clear!
           self.column = self.direction = nil
         end
+
+        def scope_for(collection)
+          collection.is_a?(Core) ? collection.items : collection
+        end
+
+        def model_for(collection)
+          scope_for(collection).model
+        end
       end
     end
   end

data/lib/katalyst/tables.rb

@@ -3,11 +3,7 @@
 require "view_component"
 require "katalyst/html_attributes"
 
-require_relative "tables/backend"
 require_relative "tables/engine"
-require_relative "tables/frontend"
-
-require_relative "tables/engine" if Object.const_defined?(:Rails)
 
 module Katalyst
   module Tables

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-tables
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.5.0
 platform: ruby
 authors:
 - Katalyst Interactive
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-15 00:00:00.000000000 Z
+date: 2024-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: katalyst-html-attributes
@@ -38,8 +38,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Builder-style HTML table generator for building tabular index views.
-  Supports sorting by columns.
+description: HTML table generator for building tabular index views with filtering,
+  sorting, and pagination.
 email:
 - devs@katalyst.com.au
 executables: []
@@ -57,6 +57,7 @@ files:
 - app/components/concerns/katalyst/tables/configurable_component.rb
 - app/components/concerns/katalyst/tables/has_table_content.rb
 - app/components/concerns/katalyst/tables/orderable.rb
+- app/components/concerns/katalyst/tables/row_renderer.rb
 - app/components/concerns/katalyst/tables/sortable.rb
 - app/components/concerns/katalyst/tables/turbo_replaceable.rb
 - app/components/katalyst/table_component.html.erb
@@ -70,33 +71,36 @@ files:
 - app/components/katalyst/tables/pagy_nav_component.rb
 - app/components/katalyst/turbo/pagy_nav_component.rb
 - app/components/katalyst/turbo/table_component.rb
+- app/controllers/concerns/katalyst/tables/backend.rb
+- app/helpers/katalyst/tables/frontend.rb
+- app/helpers/katalyst/tables/frontend/helper.rb
 - app/javascript/tables/application.js
 - app/javascript/tables/orderable/form_controller.js
 - app/javascript/tables/orderable/item_controller.js
 - app/javascript/tables/orderable/list_controller.js
 - app/javascript/tables/turbo/collection_controller.js
 - app/models/concerns/katalyst/tables/collection/core.rb
+- app/models/concerns/katalyst/tables/collection/filtering.rb
+- app/models/concerns/katalyst/tables/collection/has_params.rb
 - app/models/concerns/katalyst/tables/collection/pagination.rb
 - app/models/concerns/katalyst/tables/collection/reducers.rb
 - app/models/concerns/katalyst/tables/collection/sorting.rb
-- app/models/katalyst/tables/collection.rb
+- app/models/katalyst/tables/collection/base.rb
+- app/models/katalyst/tables/collection/filter.rb
+- app/models/katalyst/tables/collection/sort_form.rb
 - config/importmap.rb
 - config/locales/tables.en.yml
 - lib/katalyst/tables.rb
-- lib/katalyst/tables/backend.rb
-- lib/katalyst/tables/backend/sort_form.rb
 - lib/katalyst/tables/engine.rb
-- lib/katalyst/tables/frontend.rb
-- lib/katalyst/tables/frontend/helper.rb
-homepage: https://github.com/katalyst/katalyst-tables
+homepage: https://github.com/katalyst/tables
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
   rubygems_mfa_required: 'true'
-  homepage_uri: https://github.com/katalyst/katalyst-tables
-  source_code_uri: https://github.com/katalyst/katalyst-tables
-  changelog_uri: https://github.com/katalyst/katalyst-tables/blobs/main/CHANGELOG.md
+  homepage_uri: https://github.com/katalyst/tables
+  source_code_uri: https://github.com/katalyst/tables
+  changelog_uri: https://github.com/katalyst/tables/blobs/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -112,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: HTML table generator for Rails views