rails--rails/actiontext/lib/action_text/content.rb

133 lines
3.6 KiB
Ruby
Raw Normal View History

# frozen_string_literal: true
module ActionText
2018-02-08 00:26:19 +00:00
class Content
include Rendering, Serialization
2019-01-05 00:43:11 +00:00
2018-02-08 00:26:19 +00:00
attr_reader :fragment
delegate :blank?, :empty?, :html_safe, :present?, to: :to_html # Delegating to to_html to avoid including the layout
2018-02-08 00:26:19 +00:00
2018-10-03 16:46:05 +00:00
class << self
def fragment_by_canonicalizing_content(content)
fragment = ActionText::Attachment.fragment_by_canonicalizing_attachments(content)
fragment = ActionText::AttachmentGallery.fragment_by_canonicalizing_attachment_galleries(fragment)
fragment
end
end
def initialize(content = nil, options = {})
options.with_defaults! canonicalize: true
if options[:canonicalize]
@fragment = self.class.fragment_by_canonicalizing_content(content)
else
@fragment = ActionText::Fragment.wrap(content)
end
2018-02-08 00:26:19 +00:00
end
def links
@links ||= fragment.find_all("a[href]").map { |a| a["href"] }.uniq
end
def attachments
@attachments ||= attachment_nodes.map do |node|
attachment_for_node(node)
end
end
2018-10-03 16:46:05 +00:00
def attachment_galleries
@attachment_galleries ||= attachment_gallery_nodes.map do |node|
attachment_gallery_for_node(node)
end
end
def gallery_attachments
@gallery_attachments ||= attachment_galleries.flat_map(&:attachments)
end
2018-02-08 00:26:19 +00:00
def attachables
@attachables ||= attachment_nodes.map do |node|
ActionText::Attachable.from_node(node)
2018-02-08 00:26:19 +00:00
end
end
def append_attachables(attachables)
attachments = ActionText::Attachment.from_attachables(attachables)
2018-02-08 00:26:19 +00:00
self.class.new([self.to_s.presence, *attachments].compact.join("\n"))
end
def render_attachments(**options, &block)
content = fragment.replace(ActionText::Attachment.tag_name) do |node|
2018-02-08 00:26:19 +00:00
block.call(attachment_for_node(node, **options))
end
2018-10-03 16:46:05 +00:00
self.class.new(content, canonicalize: false)
end
def render_attachment_galleries(&block)
2018-10-03 16:46:05 +00:00
content = ActionText::AttachmentGallery.fragment_by_replacing_attachment_gallery_nodes(fragment) do |node|
block.call(attachment_gallery_for_node(node))
2018-10-03 16:46:05 +00:00
end
self.class.new(content, canonicalize: false)
2018-02-08 00:26:19 +00:00
end
def to_plain_text
2018-10-03 16:46:05 +00:00
render_attachments(with_full_attributes: false, &:to_plain_text).fragment.to_plain_text
2018-02-08 00:26:19 +00:00
end
def to_trix_html
render_attachments(&:to_trix_attachment).to_html
end
def to_html
2018-10-03 16:46:05 +00:00
fragment.to_html
end
def to_rendered_html_with_layout
2020-09-30 03:16:18 +00:00
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
2018-02-08 00:26:19 +00:00
def to_s
2018-10-03 16:46:05 +00:00
to_rendered_html_with_layout
2018-02-08 00:26:19 +00:00
end
def as_json(*)
to_html
end
def inspect
Don't render layout in ActionText::Content#inspect Prior to this commit, `ActionText::Content#inspect` called `#to_s` and truncated the result to 25 characters. However, `#to_s` calls `#to_rendered_html_with_layout` which, by default, renders the same first 25 characters for every instance. For example, with models such as: ```ruby class Message < ActiveRecord::Base has_rich_text :content end Message.create(content: "first message") Message.create(content: "second message") Message.create(content: "third message") ``` The output of `#inspect` is indistinguishable: ```irb irb> Message.all.map { |message| message.content.body } Rendered .../actiontext/app/views/action_text/contents/_content.html.erb within layouts/action_text/contents/_content (Duration: 2.4ms | Allocations: 881) Rendered .../actiontext/app/views/action_text/contents/_content.html.erb within layouts/action_text/contents/_content (Duration: 0.7ms | Allocations: 257) Rendered .../actiontext/app/views/action_text/contents/_content.html.erb within layouts/action_text/contents/_content (Duration: 0.6ms | Allocations: 257) => [#<ActionText::Content "<div class=\"trix-conte...">, #<ActionText::Content "<div class=\"trix-conte...">, #<ActionText::Content "<div class=\"trix-conte...">] ``` This commit changes `#inspect` to call `#to_html`, which does not render the Action Text layout. So the output of `#inspect` will be: ```irb irb> Message.all.map { |message| message.content.body } => [#<ActionText::Content "first message">, #<ActionText::Content "second message">, #<ActionText::Content "third message">] ```
2022-02-01 17:58:12 +00:00
"#<#{self.class.name} #{to_html.truncate(25).inspect}>"
2018-02-08 00:26:19 +00:00
end
def ==(other)
if other.is_a?(self.class)
to_s == other.to_s
end
end
private
def attachment_nodes
@attachment_nodes ||= fragment.find_all(ActionText::Attachment.tag_name)
2018-02-08 00:26:19 +00:00
end
2018-10-03 16:46:05 +00:00
def attachment_gallery_nodes
@attachment_gallery_nodes ||= ActionText::AttachmentGallery.find_attachment_gallery_nodes(fragment)
end
2018-02-08 00:26:19 +00:00
def attachment_for_node(node, with_full_attributes: true)
attachment = ActionText::Attachment.from_node(node)
2018-02-08 00:26:19 +00:00
with_full_attributes ? attachment.with_full_attributes : attachment
end
2018-10-03 16:46:05 +00:00
def attachment_gallery_for_node(node)
2018-10-03 16:46:05 +00:00
ActionText::AttachmentGallery.from_node(node)
end
2018-02-08 00:26:19 +00:00
end
end
2019-01-05 00:43:11 +00:00
ActiveSupport.run_load_hooks :action_text_content, ActionText::Content