rubocop-katalyst 3.1.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 408d4a24b9d76524197c2d2773434353c0a90752578516322fbf78731d13839e
-  data.tar.gz: cc011b88f7a8798268c95a79da2ed7c1a7fa0da56b323e11735ff9ca1af22cce
+  metadata.gz: 04b7a088100580edc042b6f9197cfbb64c8b2aa3c8d978f0f4387f5774893d1c
+  data.tar.gz: 9bf922ffa58eb94577825d45d1e517e250cba503b0149f4fdde6858928777491
 SHA512:
-  metadata.gz: 44dd1cab9b0424474fbaf1829d9279d6ae43e6e9a375b6f15f66ada55c5deaa7df66b306c79a2bc6769754797d0bbbd41d6942614c1efe93806e6f96f949f56b
-  data.tar.gz: 1cf92f1bf724c885a5bbaf4773c42d2bd9a33bcdd3f3f21edf6c0353953084c286e66976aa946bd5ef61f8753b8fc0eafab8ea9d5cf5873d28e7ebda52228a8c
+  metadata.gz: bd0f4a6fc15f050e509908df4c3663945e290aac33dc861e371a376ae26705a20c0406ba31d663aee0e8aaeeaa85a6880e94246cfaa6109059fef8c0876667f7
+  data.tar.gz: 896c9831d3abfe2459bf44982a50e5ae8b17f4f4b8183fbaf43ef0be790fd06e0dc479876c75a75ca4d475453f09b37a429bc9acd8d3c8474bb5f623a952dd4a

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## [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
+  have associations but don't use the library-provided `duplicates_association`
+  helper.
+
 ## [3.1.0] - 2026-08-14
 
 - Add Koi department for custom cops specific to katalyst-koi projects,

data/config/rubocop-koi.yml

@@ -1,10 +1,36 @@
 # Custom cops for projects built on Koi (katalyst-koi).
-#
-# These cops target admin views, which are only linted when RuboCop runs
-# through erb_lint, so they take effect via `rake erb_lint`.
 Koi:
   Enabled: true
 
+Koi/DuplicatesAssociation:
+  Description: "Owned detail associations on content items should declare duplicates_association."
+  Enabled: true
+  Safe: true
+  SafeAutoCorrect: false
+  VersionAdded: "3.2"
+  BaseClasses:
+    - Katalyst::Content::Item
+  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:
   Description: "Tables should have a single record link, rendered as the row heading."
   Enabled: true

data/lib/rubocop/cop/katalyst_cops.rb

@@ -1,3 +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/duplicates_association.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Koi
+      # Content items are duplicated for copy-on-write editing, and owned
+      # detail records must be duplicated with them. katalyst-content
+      # provides `duplicates_association` for this; without it the duplicate
+      # silently loses the detail record when the item is next edited.
+      #
+      # An association is considered an owned detail when it declares
+      # `dependent: :destroy` and is autosaved, either explicitly with
+      # `autosave: true` or implicitly via `accepts_nested_attributes_for`.
+      #
+      # The cop only applies where `duplicates_association` is available:
+      # classes that extend one of the configured `BaseClasses`
+      # (`Katalyst::Content::Item` by default), include
+      # `Katalyst::Content::DuplicatesAssociations`, or already call
+      # `duplicates_association`.
+      #
+      # @example
+      #   # bad
+      #   class Embed < Katalyst::Content::Item
+      #     has_one :embed_detail, autosave: true, dependent: :destroy
+      #   end
+      #
+      #   # good
+      #   class Embed < Katalyst::Content::Item
+      #     has_one :embed_detail, autosave: true, dependent: :destroy
+      #     duplicates_association :embed_detail
+      #   end
+      class DuplicatesAssociation < Base
+        extend AutoCorrector
+
+        MSG = "Owned associations are duplicated with the item; " \
+              "declare `duplicates_association :%<name>s`."
+
+        RESTRICT_ON_SEND = %i[has_one has_many].freeze
+
+        BASE_CLASSES_DEFAULT = ["Katalyst::Content::Item"].freeze
+
+        # @!method association(node)
+        def_node_matcher :association, <<~PATTERN
+          (send nil? {:has_one :has_many} (sym $_) $(hash ...))
+        PATTERN
+
+        # @!method duplicates_association_names(node)
+        def_node_search :duplicates_association_names, <<~PATTERN
+          (send nil? :duplicates_association (sym $_)+)
+        PATTERN
+
+        # @!method includes_concern?(node)
+        def_node_search :includes_concern?, <<~PATTERN
+          (send nil? :include (const _ :DuplicatesAssociations))
+        PATTERN
+
+        # @!method nested_attributes(node)
+        def_node_search :nested_attributes, <<~PATTERN
+          $(send nil? :accepts_nested_attributes_for (sym $_) ...)
+        PATTERN
+
+        def on_send(node)
+          association(node) do |name, options|
+            klass = node.each_ancestor(:class).first
+            return unless klass
+            return unless owned?(klass, name, options)
+            return unless duplication_available?(klass)
+            return if declared?(klass, name)
+
+            add_offense(node, message: format(MSG, name:)) do |corrector|
+              anchor = nested_attributes_node(klass, name) || node
+              corrector.insert_after(anchor, "\n#{' ' * anchor.loc.column}duplicates_association :#{name}")
+            end
+          end
+        end
+
+        private
+
+        def owned?(klass, name, options)
+          option?(options, :dependent, :destroy) &&
+            (option?(options, :autosave, true) || nested_attributes_node(klass, name))
+        end
+
+        def option?(options, key, value)
+          options.pairs.any? do |pair|
+            pair.key.sym_type? && pair.key.value == key && option_value?(pair.value, value)
+          end
+        end
+
+        def option_value?(node, value)
+          case value
+          when true then node.true_type?
+          when Symbol then node.sym_type? && node.value == value
+          end
+        end
+
+        def duplication_available?(klass)
+          base_classes.include?(klass.parent_class&.source) ||
+            includes_concern?(klass) ||
+            duplicates_association_names(klass).any?
+        end
+
+        def base_classes
+          cop_config.fetch("BaseClasses", BASE_CLASSES_DEFAULT)
+        end
+
+        def declared?(klass, name)
+          duplicates_association_names(klass).any? { |names| names.include?(name) }
+        end
+
+        def nested_attributes_node(klass, name)
+          nested_attributes(klass).find { |_node, sym| sym == name }&.first
+        end
+      end
+    end
+  end
+end

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.1.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Katalyst Interactive
@@ -160,6 +160,8 @@ files:
 - config/rubocop-security.yml
 - 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