Merge pull request rails#40308 from seanpdoyle/action-text-rendering-guides

Improve ActionText extensiblibility

Author: rafaelfranca

actiontext/CHANGELOG.md

@@ -1,3 +1,11 @@
+*   Expose how we render the HTML _surrounding_ rich text content as an
+    extensible `layouts/action_view/contents/_content.html.erb` template to
+    encourage user-land customizations, while retaining private API control over how
+    the rich text itself is rendered by `action_text/contents/_content.html.erb`
+    partial.
+
+    *Sean Doyle*
+
 *   Add `with_all_rich_text` method to eager load all rich text associations on a model at once.
 
     *Matt Swanson*, *DHH*

actiontext/app/helpers/action_text/content_helper.rb

@@ -22,17 +22,31 @@ def render_action_text_attachments(content)
       content.render_attachments do |attachment|
         unless attachment.in?(content.gallery_attachments)
           attachment.node.tap do |node|
-            node.inner_html = render(attachment, in_gallery: false).chomp
+            node.inner_html = render_action_text_attachment attachment, locals: { in_gallery: false }
           end
         end
       end.render_attachment_galleries do |attachment_gallery|
         render(layout: attachment_gallery, object: attachment_gallery) do
           attachment_gallery.attachments.map do |attachment|
-            attachment.node.inner_html = render(attachment, in_gallery: true).chomp
+            attachment.node.inner_html = render_action_text_attachment attachment, locals: { in_gallery: true }
             attachment.to_html
           end.join.html_safe
         end.chomp
       end
     end
+
+    def render_action_text_attachment(attachment, locals: {}) #:nodoc:
+      options = { locals: locals, object: attachment, partial: attachment }
+
+      if attachment.respond_to?(:to_attachable_partial_path)
+        options[:partial] = attachment.to_attachable_partial_path
+      end
+
+      if attachment.respond_to?(:model_name)
+        options[:as] = attachment.model_name.element
+      end
+
+      render(**options).chomp
+    end
   end
 end

actiontext/app/views/action_text/content/_layout.html.erb

@@ -0,0 +1 @@
+<%= render_action_text_content(content) %>

actiontext/app/views/action_text/contents/_content.html.erb

@@ -0,0 +1,3 @@
+<div class="trix-content">
+  <%= yield -%>
+</div>

actiontext/app/views/layouts/action_text/contents/_content.html.erb

@@ -71,6 +71,10 @@ def to_trix_content_attachment_partial_path
       to_partial_path
     end
 
+    def to_attachable_partial_path
+      to_partial_path
+    end
+
     def to_rich_text_attributes(attributes = {})
       attributes.dup.tap do |attrs|
         attrs[:sgid] = attachable_sgid

actiontext/lib/action_text/attachable.rb

@@ -84,7 +84,11 @@ def to_html
     end
 
     def to_rendered_html_with_layout
-      render partial: "action_text/content/layout", formats: :html, locals: { content: self }
+      render layout: "action_text/contents/content", partial: to_partial_path, formats: :html, locals: { content: self }
+    end
+
+    def to_partial_path
+      "action_text/contents/content"
     end
 
     def to_s

actiontext/lib/action_text/content.rb

@@ -47,6 +47,9 @@ def create_actiontext_files
 
         copy_file "#{GEM_ROOT}/app/views/active_storage/blobs/_blob.html.erb",
           "app/views/active_storage/blobs/_blob.html.erb"
+
+        copy_file "#{GEM_ROOT}/app/views/layouts/action_text/contents/_content.html.erb",
+          "app/views/layouts/action_text/contents/_content.html.erb"
       end
 
       def create_migrations

actiontext/lib/generators/action_text/install/install_generator.rb

@@ -4,4 +4,8 @@ class Person < ApplicationRecord
   def to_trix_content_attachment_partial_path
     "people/trix_content_attachment"
   end
+
+  def to_attachable_partial_path
+    "people/attachable"
+  end
 end

actiontext/test/dummy/app/models/person.rb

@@ -0,0 +1 @@
+<span class="mentioned-person"><%= person.name %></span>