Action Text `Content`¶ ↑

类 ActionText::Content 封装了一个 HTML 片段，以支持解析、渲染和序列化。它可以用于提取链接和附件，将片段转换为纯文本，或将片段序列化到数据库。

ActionText::RichText 记录将 body 属性序列化为 ActionText::Content。

class Message < ActiveRecord::Base
  has_rich_text :content
end

message = Message.create!(content: "<h1>Funny times!</h1>")
body = message.content.body # => #<ActionText::Content "<div class=\"trix-conte...">
body.to_s # => "<h1>Funny times!</h1>"
body.to_plain_text # => "Funny times!"

方法

#

A

append_attachables,
as_json,
attachables,
attachment_galleries,
attachments

F

fragment_by_canonicalizing_content

G

gallery_attachments

I

inspect

L

links

N

R

render_attachment_galleries,
render_attachments

T

to_html,
to_partial_path,
to_plain_text,
to_rendered_html_with_layout,
to_s,
to_trix_html

Attributes

[R]

fragment

类公共方法

fragment_by_canonicalizing_content(content) 链接

来源: 显示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 33
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

new(content = nil, options = {}) 链接

来源: 显示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 40
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
end

实例公共方法

==(other) 链接

来源: 显示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 170
def ==(other)
  if self.class == other.class
    to_html == other.to_html
  elsif other.is_a?(self.class)
    to_s == other.to_s
  end
end

append_attachables(attachables) 链接

来源: 显示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 93
def append_attachables(attachables)
  attachments = ActionText::Attachment.from_attachables(attachables)
  self.class.new([self.to_s.presence, *attachments].compact.join("\n"))
end

as_json(*) 链接

来源: 显示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 162
def as_json(*)
  to_html
end

attachables() 链接

从 HTML 片段中提取 ActionText::Attachable 对象

attachable = ActiveStorage::Blob.first
html = %Q(<action-text-attachment sgid="#{attachable.attachable_sgid}" caption="Captioned"></action-text-attachment>)
content = ActionText::Content.new(html)
content.attachables # => [attachable]

来源: 显示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 87
def attachables
  @attachables ||= attachment_nodes.map do |node|
    ActionText::Attachable.from_node(node)
  end
end

attachment_galleries() 链接

来源: 显示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 71
def attachment_galleries
  @attachment_galleries ||= attachment_gallery_nodes.map do |node|
    attachment_gallery_for_node(node)
  end
end

attachments() 链接

从 HTML 片段中提取 ActionText::Attachment 对象

attachable = ActiveStorage::Blob.first
html = %Q(<action-text-attachment sgid="#{attachable.attachable_sgid}" caption="Captioned"></action-text-attachment>)
content = ActionText::Content.new(html)
content.attachments # => [#<ActionText::Attachment attachable=#<ActiveStorage::Blob...

来源: 显示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 65
def attachments
  @attachments ||= attachment_nodes.map do |node|
    attachment_for_node(node)
  end
end

gallery_attachments() 链接

来源: 显示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 77
def gallery_attachments
  @gallery_attachments ||= attachment_galleries.flat_map(&:attachments)
end

inspect() 链接

来源: 显示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 166
def inspect
  "#<#{self.class.name} #{to_html.truncate(25).inspect}>"
end

links() 链接

从 HTML 片段中提取链接

html = '<a href="http://example.com/">Example</a>'
content = ActionText::Content.new(html)
content.links # => ["http://example.com/"]

来源: 显示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 55
def links
  @links ||= fragment.find_all("a[href]").map { |a| a["href"] }.uniq
end

render_attachment_galleries(&block) 链接

来源: 显示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 109
def render_attachment_galleries(&block)
  content = ActionText::AttachmentGallery.fragment_by_replacing_attachment_gallery_nodes(fragment) do |node|
    block.call(attachment_gallery_for_node(node))
  end
  self.class.new(content, canonicalize: false)
end

render_attachments(**options, &block) 链接

来源: 显示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 98
def render_attachments(**options, &block)
  content = fragment.replace(ActionText::Attachment.tag_name) do |node|
    if node.key?("content")
      sanitized_content = sanitize_content_attachment(node.remove_attribute("content").to_s)
      node["content"] = sanitized_content if sanitized_content.present?
    end
    block.call(attachment_for_node(node, **options))
  end
  self.class.new(content, canonicalize: false)
end

to_html() 链接

来源: 显示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 139
def to_html
  fragment.to_html
end

to_partial_path() 链接

来源: 显示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 147
def to_partial_path
  "action_text/contents/content"
end

to_plain_text() 链接

返回内容所包含的标记的纯文本版本，去除标签但对 HTML 实体进行编码。

content = ActionText::Content.new("<h1>Funny times!</h1>")
content.to_plain_text # => "Funny times!"

content = ActionText::Content.new("<div onclick='action()'>safe<script>unsafe</script></div>")
content.to_plain_text # => "safeunsafe"

注意：返回的字符串不安全，不应在未进行额外清理的情况下在浏览器中渲染。

content = ActionText::Content.new("&lt;script&gt;alert()&lt;/script&gt;")
content.to_plain_text # => "<script>alert()</script>"
ActionText::ContentHelper.sanitizer.sanitize(content.to_plain_text) # => ""

来源: 显示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 131
def to_plain_text
  render_attachments(with_full_attributes: false, &:to_plain_text).fragment.to_plain_text
end

to_rendered_html_with_layout() 链接

来源: 显示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 143
def to_rendered_html_with_layout
  render layout: "action_text/contents/content", partial: to_partial_path, formats: :html, locals: { content: self }
end

to_s() 链接

安全地将 Content 转换为 HTML String。

content = ActionText::Content.new(content: "<h1>Funny times!</h1>")
content.to_s # => "<h1>Funny times!</h1>"

content = ActionText::Content.new("<div onclick='action()'>safe<script>unsafe</script></div>")
content.to_s # => "<div>safeunsafe</div>"

来源: 显示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 158
def to_s
  to_rendered_html_with_layout
end

to_trix_html() 链接

来源: 显示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 135
def to_trix_html
  render_attachments(&:to_trix_attachment).to_html
end

类 ActionText::Content < Object

Action Text Content¶ ↑

Attributes

类公共方法

fragment_by_canonicalizing_content(content) 链接

new(content = nil, options = {}) 链接

实例公共方法

==(other) 链接

append_attachables(attachables) 链接

as_json(*) 链接

attachables() 链接

attachment_galleries() 链接

attachments() 链接

gallery_attachments() 链接

inspect() 链接

links() 链接

render_attachment_galleries(&block) 链接

render_attachments(**options, &block) 链接

to_html() 链接

to_partial_path() 链接

to_plain_text() 链接

to_rendered_html_with_layout() 链接

to_s() 链接

to_trix_html() 链接

Action Text `Content`¶ ↑