rubocop-katalyst 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca026117c849f4df349fe5c67aed0695aedfc780a64af122996eb3d51fc3cc28
-  data.tar.gz: db9a73d62f9d1f0005540ae233de188ce4fa7486272a06387ac72335b8bc3037
+  metadata.gz: 04b7a088100580edc042b6f9197cfbb64c8b2aa3c8d978f0f4387f5774893d1c
+  data.tar.gz: 9bf922ffa58eb94577825d45d1e517e250cba503b0149f4fdde6858928777491
 SHA512:
-  metadata.gz: 752ce4174f0ea3121ba76a2cfe72c49771e0069dc4f940eda114f789ed13a73cc1dbe88558efb4a193765c3b5038003a8af8a2c3979a4b126d515d5b171304c2
-  data.tar.gz: d9dd3b37ec0884d11b0d08a0ceb228315174b00ffdc6736246bd1da5e9f8271f7fa1d2af91809170d5ebfc2d0f664daba801d0d8b0ac5be4ed7d46b8150859c7
+  metadata.gz: bd0f4a6fc15f050e509908df4c3663945e290aac33dc861e371a376ae26705a20c0406ba31d663aee0e8aaeeaa85a6880e94246cfaa6109059fef8c0876667f7
+  data.tar.gz: 896c9831d3abfe2459bf44982a50e5ae8b17f4f4b8183fbaf43ef0be790fd06e0dc479876c75a75ca4d475453f09b37a429bc9acd8d3c8474bb5f623a952dd4a

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [3.3.0] - 2026-08-18
+
+- Add Koi/TableAsset cop: admin index tables (index/archived views, row and
+  table partials) should not render images or attachments. Flags
+  `row.attachment` cells and `image_tag`/`image_pack_tag` helpers as a smell,
+  without autocorrection.
+
 ## [3.2.0] - 2026-08-17
 
 - Add Koi/DuplicatesAssociation identifying Katalyst::Content items that

data/config/rubocop-koi.yml

@@ -13,6 +13,22 @@ Koi/DuplicatesAssociation:
   Include:
     - "**/app/models/**/*.rb"
 
+# Targets admin index views, which are only linted when RuboCop runs
+# through erb_lint, so it takes effect via `rake erb_lint`. `_table`
+# partials are included because they render index-style tables of child
+# records within a parent view.
+Koi/TableAsset:
+  Description: "Index tables should not render images or attachments."
+  Enabled: true
+  Safe: true
+  SafeAutoCorrect: false
+  VersionAdded: "3.3"
+  Include:
+    - "**/app/views/admin/**/index.html.erb"
+    - "**/app/views/admin/**/archived.html.erb"
+    - "**/app/views/admin/**/*.html+row.erb"
+    - "**/app/views/admin/**/_table*.erb"
+
 # Targets admin views, which are only linted when RuboCop runs through
 # erb_lint, so it takes effect via `rake erb_lint`.
 Koi/TableLinkHeading:

data/lib/rubocop/cop/katalyst_cops.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 
 require_relative "koi/duplicates_association"
+require_relative "koi/table_asset"
 require_relative "koi/table_link_heading"

data/lib/rubocop/cop/koi/table_asset.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Koi
+      # Koi admin index tables should not render images or attachments.
+      # Index views are for scanning and comparing records; rendering assets
+      # makes rows uneven, slows the page down (variant generation and blob
+      # queries per row), and rarely helps identify a record. Display text in
+      # the table and show the asset on the record's page instead.
+      #
+      # This cop flags `row.attachment` cells and `image_tag`/`image_pack_tag`
+      # helpers. It does not autocorrect; it identifies a smell for a human to
+      # resolve.
+      #
+      # This cop only takes effect through erb_lint: plain `rubocop` does not
+      # inspect `.erb` files, and the `Include` configuration restricts it to
+      # Koi admin index views, so `row.attachment` in show views is fine.
+      #
+      # @example
+      #   # bad
+      #   row.attachment :image, variant: :admin_thumb
+      #
+      #   # bad
+      #   row.cell(:image) { image_tag(record.image.variant(:thumb)) }
+      #
+      #   # good
+      #   row.text :name
+      class TableAsset < Base
+        # This cop never registers a correction, but it must advertise
+        # autocorrect support: erb_lint mobilizes RuboCop in autocorrect mode,
+        # where non-autocorrecting cops are skipped for any fragment that an
+        # autocorrecting cop has corrected (see RuboCop::Cop::Team).
+        extend AutoCorrector
+
+        MSG_ATTACHMENT = "Avoid attachments in index tables; display text in the table " \
+                         "and show the attachment on the record's page instead."
+        MSG_IMAGE      = "Avoid images in index tables; display text in the table " \
+                         "and show the image on the record's page instead."
+
+        RESTRICT_ON_SEND = %i[attachment image_tag image_pack_tag].freeze
+
+        # @!method row_attachment?(node)
+        def_node_matcher :row_attachment?, <<~PATTERN
+          (send {(send nil? :row) (lvar :row)} :attachment ...)
+        PATTERN
+
+        # @!method image_helper?(node)
+        def_node_matcher :image_helper?, <<~PATTERN
+          (send nil? {:image_tag :image_pack_tag} ...)
+        PATTERN
+
+        def on_send(node)
+          if row_attachment?(node)
+            add_offense(node, message: MSG_ATTACHMENT)
+          elsif image_helper?(node)
+            add_offense(node, message: MSG_IMAGE)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-katalyst
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Katalyst Interactive
@@ -161,6 +161,7 @@ files:
 - config/rubocop-style.yml
 - lib/rubocop/cop/katalyst_cops.rb
 - lib/rubocop/cop/koi/duplicates_association.rb
+- lib/rubocop/cop/koi/table_asset.rb
 - lib/rubocop/cop/koi/table_link_heading.rb
 - lib/rubocop/katalyst.rb
 - lib/rubocop/katalyst/erb_lint_task.rb