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..."

Methods

Constants

ATTRIBUTES = %w( sgid content-type url href filename filesize width height previewable presentation caption content )

Attributes

[R] attachable
[R] node

Class Public methods

fragment_by_canonicalizing_attachments(content)

📝 Source code 
# File actiontext/lib/action_text/attachment.rb, line 27
      def fragment_by_canonicalizing_attachments(content)
        fragment_by_minifying_attachments(fragment_by_converting_trix_attachments(content))
      end
🔎 See on GitHub

from_attachable(attachable, attributes = {})

📝 Source code 
# File actiontext/lib/action_text/attachment.rb, line 39
      def from_attachable(attachable, attributes = {})
        if node = node_from_attributes(attachable.to_rich_text_attributes(attributes))
          new(node, attachable)
        end
      end
🔎 See on GitHub

from_attachables(attachables)

📝 Source code 
# File actiontext/lib/action_text/attachment.rb, line 35
      def from_attachables(attachables)
        Array(attachables).filter_map { |attachable| from_attachable(attachable) }
      end
🔎 See on GitHub

from_attributes(attributes, attachable = nil)

📝 Source code 
# File actiontext/lib/action_text/attachment.rb, line 45
      def from_attributes(attributes, attachable = nil)
        if node = node_from_attributes(attributes)
          from_node(node, attachable)
        end
      end
🔎 See on GitHub

from_node(node, attachable = nil)

📝 Source code 
# File actiontext/lib/action_text/attachment.rb, line 31
      def from_node(node, attachable = nil)
        new(node, attachable || ActionText::Attachable.from_node(node))
      end
🔎 See on GitHub

new(node, attachable)

📝 Source code 
# File actiontext/lib/action_text/attachment.rb, line 68
    def initialize(node, attachable)
      @node = node
      @attachable = attachable
    end
🔎 See on GitHub

Instance Public methods

caption()

📝 Source code 
# File actiontext/lib/action_text/attachment.rb, line 73
    def caption
      node_attributes["caption"].presence
    end
🔎 See on GitHub

full_attributes()

📝 Source code 
# File actiontext/lib/action_text/attachment.rb, line 77
    def full_attributes
      node_attributes.merge(attachable_attributes).merge(sgid_attributes)
    end
🔎 See on GitHub

inspect()

📝 Source code 
# File actiontext/lib/action_text/attachment.rb, line 131
    def inspect
      "#<#{self.class.name} attachable=#{attachable.inspect}>"
    end
🔎 See on GitHub

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...
📝 Source code 
# File actiontext/lib/action_text/attachment.rb, line 123
    def to_html
      HtmlConversion.node_to_html(node)
    end
🔎 See on GitHub

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]"
📝 Source code 
# File actiontext/lib/action_text/attachment.rb, line 110
    def to_plain_text
      if respond_to?(:attachable_plain_text_representation)
        attachable_plain_text_representation(caption)
      else
        caption.to_s
      end
    end
🔎 See on GitHub

to_s()

📝 Source code 
# File actiontext/lib/action_text/attachment.rb, line 127
    def to_s
      to_html
    end
🔎 See on GitHub

with_full_attributes()

📝 Source code 
# File actiontext/lib/action_text/attachment.rb, line 81
    def with_full_attributes
      self.class.from_attributes(full_attributes, attachable)
    end
🔎 See on GitHub