katalyst-tables 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5324d0bccadf307f48cb2199b8ba9123cb519756dda81cfc0c4c88a4abdfd886
-  data.tar.gz: ad299f1c8f62454aa3433b00cf4c0b69dacfe59cd6cfe598ab3ea2969cedecde
+  metadata.gz: 73c920aef2dfd59566ab635a3b7f573a6bb6cc6b16548e9e198c23d021d571dd
+  data.tar.gz: 2b2f8000946bda4871efe3ea052b29ff87fdb43cd1eaf1861fd5cdcb0cd52411
 SHA512:
-  metadata.gz: bd4daa1c09acaab6e85cbf787cfafb51303c9f030f26f15ca5f0a593da02c5dd526bf73d07b5cf6a99bfc267f2ea2a17d837e5eae81d607df2ad7788a9a99260
-  data.tar.gz: 143552907f2bf01ad256fc6e24b06404db1f173fe2ce3f4dca802eacd903fc5ab2f950a7c8c9ff6b086efe00c8838b8eca9dfbb2edcc0cc61d76717f6ca171ac
+  metadata.gz: fe91356719cc1f290f90245cc22742c6d6a328818b42c95412baa10f8affe3a2d1e48e7733d439ec185c48bea7c4bc40f8eff9e986375200d37a3a020a063c75
+  data.tar.gz: c4a65aac6559e0afb91cfde6f6efc4a4f1d06c1e4679fff3e903c94272b3c8f6f51005bd009013fbca60be7d08eb45edc3fba3e5926da15d28c78da449fa736a

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [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

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

@@ -20,27 +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_path
-        @as      ||= template_name
-        render(partial: @partial, variants: [:row], formats: [:html], locals: { @as => record, row: row })
-      end
-
-      def partial_path
-        # Collection::Base overwrites param_key for form_with compatibility
-        items.model_name.param_key.to_s
-      end
-
-      def template_name
-        # Collection::Base overwrites param_key for form_with compatibility
-        items.model_name.param_key.to_sym
-      end
-
-      def items
-        collection.respond_to?(:items) ? collection.items : collection
+      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:,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-tables
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Katalyst Interactive
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-08 00:00:00.000000000 Z
+date: 2024-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: katalyst-html-attributes
@@ -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
@@ -115,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