3500571b43
Extensible layout --- Expose how we render the HTML _surrounding_ rich text content as an extensible `layouts/action_text/contents/_content.html.erb` template to encourage user-land customizations, while retaining private API control over how the rich text itself is rendered by moving the `#render_action_text_content` helper invocation to the `action_text/contents/_content.html.erb` partial. Extensible Attachable `#to_attachable_partial_path` --- When an application declares a canonical partial for a record, there is no way to override which partial is used when transformed to Rich Text. For example, a default `Person < ApplicationRecord` instance returns `"people/person"` from calls to `#to_partial_path`, resulting in the `app/views/people/_person.html.erb` partial being rendered. Prior to this change, when encountering an `<action-text-attachment sgid="...">` element, ActionText retrieved the corresponding `Attachable` instance (usually an `ActiveRecord::Base` instance) and transformed it to rich text HTML by rendering the partial that corresponds to its `#to_partial_path`. This proposed change instead invokes `Attachable#to_attachable_partial_path`. By default, `#to_attachable_partial_path` is an alias for `#to_partial_path`. Guides --- Extend the `guides/action_text_overview` document to describe how to customize these templates, and to better illustrate how ActionText::Attachable instances are rendered into HTML.
91 lines
2.3 KiB
Ruby
91 lines
2.3 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module ActionText
|
|
module Attachable
|
|
extend ActiveSupport::Concern
|
|
|
|
LOCATOR_NAME = "attachable"
|
|
|
|
class << self
|
|
def from_node(node)
|
|
if attachable = attachable_from_sgid(node["sgid"])
|
|
attachable
|
|
elsif attachable = ActionText::Attachables::ContentAttachment.from_node(node)
|
|
attachable
|
|
elsif attachable = ActionText::Attachables::RemoteImage.from_node(node)
|
|
attachable
|
|
else
|
|
ActionText::Attachables::MissingAttachable
|
|
end
|
|
end
|
|
|
|
def from_attachable_sgid(sgid, options = {})
|
|
method = sgid.is_a?(Array) ? :locate_many_signed : :locate_signed
|
|
record = GlobalID::Locator.public_send(method, sgid, options.merge(for: LOCATOR_NAME))
|
|
record || raise(ActiveRecord::RecordNotFound)
|
|
end
|
|
|
|
private
|
|
def attachable_from_sgid(sgid)
|
|
from_attachable_sgid(sgid)
|
|
rescue ActiveRecord::RecordNotFound
|
|
nil
|
|
end
|
|
end
|
|
|
|
class_methods do
|
|
def from_attachable_sgid(sgid)
|
|
ActionText::Attachable.from_attachable_sgid(sgid, only: self)
|
|
end
|
|
end
|
|
|
|
def attachable_sgid
|
|
to_sgid(expires_in: nil, for: LOCATOR_NAME).to_s
|
|
end
|
|
|
|
def attachable_content_type
|
|
try(:content_type) || "application/octet-stream"
|
|
end
|
|
|
|
def attachable_filename
|
|
filename.to_s if respond_to?(:filename)
|
|
end
|
|
|
|
def attachable_filesize
|
|
try(:byte_size) || try(:filesize)
|
|
end
|
|
|
|
def attachable_metadata
|
|
try(:metadata) || {}
|
|
end
|
|
|
|
def previewable_attachable?
|
|
false
|
|
end
|
|
|
|
def as_json(*)
|
|
super.merge(attachable_sgid: attachable_sgid)
|
|
end
|
|
|
|
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
|
|
attrs[:content_type] = attachable_content_type
|
|
attrs[:previewable] = true if previewable_attachable?
|
|
attrs[:filename] = attachable_filename
|
|
attrs[:filesize] = attachable_filesize
|
|
attrs[:width] = attachable_metadata[:width]
|
|
attrs[:height] = attachable_metadata[:height]
|
|
end.compact
|
|
end
|
|
end
|
|
end
|