Class: ActionText::Content
- Includes:
- ContentHelper, Rendering, Serialization
- Defined in:
- actiontext/lib/action_text/content.rb
Overview
# Action Text Content
The ‘ActionText::Content` class wraps an HTML fragment to add support for parsing, rendering and serialization. It can be used to extract links and attachments, convert the fragment to plain text, or serialize the fragment to the database.
The ActionText::RichText record serializes the ‘body` attribute as `ActionText::Content`.
class Message < ActiveRecord::Base
has_rich_text :content
end
= Message.create!(content: "<h1>Funny times!</h1>")
body = .content.body # => #<ActionText::Content "<div class=\"trix-conte...">
body.to_s # => "<h1>Funny times!</h1>"
body.to_plain_text # => "Funny times!"
Instance Attribute Summary collapse
-
#fragment ⇒ Object
readonly
Returns the value of attribute fragment.
Class Method Summary collapse
Instance Method Summary collapse
- #==(other) ⇒ Object
- #append_attachables(attachables) ⇒ Object
- #as_json ⇒ Object
-
#attachables ⇒ Object
Extracts ActionText::Attachables from the HTML fragment:.
- #attachment_galleries ⇒ Object
-
#attachments ⇒ Object
Extracts ActionText::Attachments from the HTML fragment:.
- #gallery_attachments ⇒ Object
-
#initialize(content = nil, options = {}) ⇒ Content
constructor
A new instance of Content.
- #inspect ⇒ Object
-
#links ⇒ Object
Extracts links from the HTML fragment:.
- #render_attachment_galleries(&block) ⇒ Object
- #render_attachments(**options, &block) ⇒ Object
- #to_html ⇒ Object
- #to_partial_path ⇒ Object
-
#to_plain_text ⇒ Object
Returns a plain-text version of the markup contained by the content, with tags removed but HTML entities encoded.
- #to_rendered_html_with_layout ⇒ Object
-
#to_s ⇒ Object
Safely transforms Content into an HTML String.
- #to_trix_html ⇒ Object
Methods included from ActiveSupport::Concern
#append_features, #class_methods, extended, #included, #prepend_features, #prepended
Methods included from Serialization
Methods included from ContentHelper
#render_action_text_attachment, #render_action_text_attachments, #render_action_text_content, #sanitize_action_text_content, #sanitize_content_attachment, #sanitizer_allowed_attributes, #sanitizer_allowed_tags
Constructor Details
#initialize(content = nil, options = {}) ⇒ Content
Returns a new instance of Content.
40 41 42 43 44 45 46 47 48 |
# File 'actiontext/lib/action_text/content.rb', line 40 def initialize(content = nil, = {}) .with_defaults! canonicalize: true if [:canonicalize] @fragment = self.class.fragment_by_canonicalizing_content(content) else @fragment = ActionText::Fragment.wrap(content) end end |
Instance Attribute Details
#fragment ⇒ Object (readonly)
Returns the value of attribute fragment.
27 28 29 |
# File 'actiontext/lib/action_text/content.rb', line 27 def fragment @fragment end |
Class Method Details
.fragment_by_canonicalizing_content(content) ⇒ Object
33 34 35 36 37 |
# File 'actiontext/lib/action_text/content.rb', line 33 def fragment_by_canonicalizing_content(content) fragment = ActionText::Attachment.(content) fragment = ActionText::AttachmentGallery.(fragment) fragment end |
Instance Method Details
#==(other) ⇒ Object
170 171 172 173 174 175 176 |
# 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) ⇒ Object
93 94 95 96 |
# File 'actiontext/lib/action_text/content.rb', line 93 def append_attachables(attachables) = ActionText::Attachment.from_attachables(attachables) self.class.new([self.to_s.presence, *].compact.join("\n")) end |
#as_json ⇒ Object
162 163 164 |
# File 'actiontext/lib/action_text/content.rb', line 162 def as_json(*) to_html end |
#attachables ⇒ Object
Extracts ActionText::Attachables from the HTML fragment:
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]
87 88 89 90 91 |
# File 'actiontext/lib/action_text/content.rb', line 87 def attachables @attachables ||= .map do |node| ActionText::Attachable.from_node(node) end end |
#attachment_galleries ⇒ Object
71 72 73 74 75 |
# File 'actiontext/lib/action_text/content.rb', line 71 def @attachment_galleries ||= .map do |node| (node) end end |
#attachments ⇒ Object
Extracts ActionText::Attachments from the HTML fragment:
attachable = ActiveStorage::Blob.first
html = %Q(<action-text-attachment sgid="#{attachable.attachable_sgid}" caption="Captioned"></action-text-attachment>)
content = ActionText::Content.new(html)
content. # => [#<ActionText::Attachment attachable=#<ActiveStorage::Blob...
65 66 67 68 69 |
# File 'actiontext/lib/action_text/content.rb', line 65 def @attachments ||= .map do |node| (node) end end |
#gallery_attachments ⇒ Object
77 78 79 |
# File 'actiontext/lib/action_text/content.rb', line 77 def @gallery_attachments ||= .flat_map(&:attachments) end |
#inspect ⇒ Object
166 167 168 |
# File 'actiontext/lib/action_text/content.rb', line 166 def inspect "#<#{self.class.name} #{to_html.truncate(25).inspect}>" end |
#links ⇒ Object
Extracts links from the HTML fragment:
html = '<a href="http://example.com/">Example</a>'
content = ActionText::Content.new(html)
content.links # => ["http://example.com/"]
55 56 57 |
# 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) ⇒ Object
109 110 111 112 113 114 |
# File 'actiontext/lib/action_text/content.rb', line 109 def (&block) content = ActionText::AttachmentGallery.(fragment) do |node| block.call((node)) end self.class.new(content, canonicalize: false) end |
#render_attachments(**options, &block) ⇒ Object
98 99 100 101 102 103 104 105 106 107 |
# File 'actiontext/lib/action_text/content.rb', line 98 def (**, &block) content = fragment.replace(ActionText::Attachment.tag_name) do |node| if node.key?("content") sanitized_content = (node.remove_attribute("content").to_s) node["content"] = sanitized_content if sanitized_content.present? end block.call((node, **)) end self.class.new(content, canonicalize: false) end |
#to_html ⇒ Object
139 140 141 |
# File 'actiontext/lib/action_text/content.rb', line 139 def to_html fragment.to_html end |
#to_partial_path ⇒ Object
147 148 149 |
# File 'actiontext/lib/action_text/content.rb', line 147 def to_partial_path "action_text/contents/content" end |
#to_plain_text ⇒ Object
Returns a plain-text version of the markup contained by the content, with tags removed but HTML entities encoded.
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"
NOTE: that the returned string is not HTML safe and should not be rendered in browsers without additional sanitization.
content = ActionText::Content.new("<script>alert()</script>")
content.to_plain_text # => "<script>alert()</script>"
ActionText::ContentHelper.sanitizer.sanitize(content.to_plain_text) # => ""
131 132 133 |
# File 'actiontext/lib/action_text/content.rb', line 131 def to_plain_text (with_full_attributes: false, &:to_plain_text).fragment.to_plain_text end |
#to_rendered_html_with_layout ⇒ Object
143 144 145 |
# 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 ⇒ Object
Safely transforms Content into an 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>"
158 159 160 |
# File 'actiontext/lib/action_text/content.rb', line 158 def to_s to_rendered_html_with_layout end |
#to_trix_html ⇒ Object
135 136 137 |
# File 'actiontext/lib/action_text/content.rb', line 135 def to_trix_html (&:to_trix_attachment).to_html end |