class ActionText::Attachment

Action Text Attachment¶ ↑

Attachments serialize attachables to HTML or plain text.

class Person < ApplicationRecord
  include ActionText::Attachable
end

attachable = Person.create! name: "Javan"
attachment = ActionText::Attachment.from_attachable(attachable)
attachment.to_html # => "<action-text-attachment sgid=\"BAh7CEk..."

Constants

ATTRIBUTES

Attributes

attachable [R]

node [R]

Public Class Methods

fragment_by_canonicalizing_attachments (content)

# File actiontext/lib/action_text/attachment.rb, line 25
def fragment_by_canonicalizing_attachments(content)
  fragment_by_minifying_attachments(fragment_by_converting_trix_attachments(content))
end

from_attachable (attachable, attributes = {})

# File actiontext/lib/action_text/attachment.rb, line 37
def from_attachable(attachable, attributes = {})
  if node = node_from_attributes(attachable.to_rich_text_attributes(attributes))
    new(node, attachable)
  end
end

from_attachables (attachables)

# File actiontext/lib/action_text/attachment.rb, line 33
def from_attachables(attachables)
  Array(attachables).filter_map { |attachable| from_attachable(attachable) }
end

from_attributes (attributes, attachable = nil)

# File actiontext/lib/action_text/attachment.rb, line 43
def from_attributes(attributes, attachable = nil)
  if node = node_from_attributes(attributes)
    from_node(node, attachable)
  end
end

from_node (node, attachable = nil)

# File actiontext/lib/action_text/attachment.rb, line 29
def from_node(node, attachable = nil)
  new(node, attachable || ActionText::Attachable.from_node(node))
end

new (node, attachable)

# File actiontext/lib/action_text/attachment.rb, line 66
def initialize(node, attachable)
  @node = node
  @attachable = attachable
end

Public Instance Methods

caption ()

# File actiontext/lib/action_text/attachment.rb, line 71
def caption
  node_attributes["caption"].presence
end

full_attributes ()

# File actiontext/lib/action_text/attachment.rb, line 75
def full_attributes
  node_attributes.merge(attachable_attributes).merge(sgid_attributes)
end

inspect ()

# File actiontext/lib/action_text/attachment.rb, line 129
def inspect
  "#<#{self.class.name} attachable=#{attachable.inspect}>"
end

to_html ()

Converts the attachment to HTML.

attachable = Person.create! name: "Javan"
attachment = ActionText::Attachment.from_attachable(attachable)
attachment.to_html # => "<action-text-attachment sgid=\"BAh7CEk...

# File actiontext/lib/action_text/attachment.rb, line 121
def to_html
  HtmlConversion.node_to_html(node)
end

to_plain_text ()

Converts the attachment to plain text.

attachable = ActiveStorage::Blob.find_by filename: "racecar.jpg"
attachment = ActionText::Attachment.from_attachable(attachable)
attachment.to_plain_text # => "[racecar.jpg]"

Use the caption when set:

attachment = ActionText::Attachment.from_attachable(attachable, caption: "Vroom vroom")
attachment.to_plain_text # => "[Vroom vroom]"

The presentation can be overridden by implementing the attachable_plain_text_representation method:

class Person < ApplicationRecord
  include ActionText::Attachable

  def attachable_plain_text_representation
    "[#{name}]"
  end
end

attachable = Person.create! name: "Javan"
attachment = ActionText::Attachment.from_attachable(attachable)
attachment.to_plain_text # => "[Javan]"

# File actiontext/lib/action_text/attachment.rb, line 108
def to_plain_text
  if respond_to?(:attachable_plain_text_representation)
    attachable_plain_text_representation(caption)
  else
    caption.to_s
  end
end

to_s ()

# File actiontext/lib/action_text/attachment.rb, line 125
def to_s
  to_html
end

with_full_attributes ()

# File actiontext/lib/action_text/attachment.rb, line 79
def with_full_attributes
  self.class.from_attributes(full_attributes, attachable)
end