Action Text Attachable

Include this module to make a record attachable to an ActionText::Content.

class Person < ApplicationRecord
  include ActionText::Attachable
end

person = Person.create! name: "Javan"
html = %Q(<action-text-attachment sgid="#{person.attachable_sgid}"></action-text-attachment>)
content = ActionText::Content.new(html)
content.attachables # => [person]

Methods

attachable_content_type
attachable_filename
attachable_filesize
attachable_metadata
attachable_sgid
from_attachable_sgid
from_attachable_sgid
from_node
previewable_attachable?
to_attachable_partial_path
to_missing_attachable_partial_path
to_rich_text_attributes
to_trix_content_attachment_partial_path

Constants

LOCATOR_NAME

"attachable"

Class Public methods

from_attachable_sgid(sgid, options = {})

📝 Source code

# File actiontext/lib/action_text/attachable.rb, line 41
      def from_attachable_sgid(sgid, options = {})
        method = sgid.is_a?(Array) ? :locate_many_signed : :locate_signed
        record = GlobalID::Locator.public_send(method, sgid, options.merge(for: LOCATOR_NAME))
        record || raise(ActiveRecord::RecordNotFound)
      end

🔎 See on GitHub

from_node(node)

Extracts the ActionText::Attachable from the attachment HTML node:

person = Person.create! name: "Javan"
html = %Q(<action-text-attachment sgid="#{person.attachable_sgid}"></action-text-attachment>)
fragment = ActionText::Fragment.wrap(html)
attachment_node = fragment.find_all(ActionText::Attachment.tag_name).first
ActionText::Attachable.from_node(attachment_node) # => person

📝 Source code

# File actiontext/lib/action_text/attachable.rb, line 29
      def from_node(node)
        if attachable = attachable_from_sgid(node["sgid"])
          attachable
        elsif attachable = ActionText::Attachables::ContentAttachment.from_node(node)
          attachable
        elsif attachable = ActionText::Attachables::RemoteImage.from_node(node)
          attachable
        else
          ActionText::Attachables::MissingAttachable.new(node["sgid"])
        end
      end

🔎 See on GitHub

Instance Public methods

attachable_content_type()

📝 Source code

# File actiontext/lib/action_text/attachable.rb, line 81
    def attachable_content_type
      try(:content_type) || "application/octet-stream"
    end

🔎 See on GitHub

attachable_filename()

📝 Source code

# File actiontext/lib/action_text/attachable.rb, line 85
    def attachable_filename
      filename.to_s if respond_to?(:filename)
    end

🔎 See on GitHub

attachable_filesize()

📝 Source code

# File actiontext/lib/action_text/attachable.rb, line 89
    def attachable_filesize
      try(:byte_size) || try(:filesize)
    end

🔎 See on GitHub

attachable_metadata()

📝 Source code

# File actiontext/lib/action_text/attachable.rb, line 93
    def attachable_metadata
      try(:metadata) || {}
    end

🔎 See on GitHub

attachable_sgid()

Returns the Signed Global ID for the attachable. The purpose of the ID is set to ‘attachable’ so it can’t be reused for other purposes.

📝 Source code

# File actiontext/lib/action_text/attachable.rb, line 77
    def attachable_sgid
      to_sgid(expires_in: nil, for: LOCATOR_NAME).to_s
    end

🔎 See on GitHub

from_attachable_sgid(sgid)

📝 Source code

# File actiontext/lib/action_text/attachable.rb, line 56
      def from_attachable_sgid(sgid)
        ActionText::Attachable.from_attachable_sgid(sgid, only: self)
      end

🔎 See on GitHub

previewable_attachable?()

📝 Source code

# File actiontext/lib/action_text/attachable.rb, line 97
    def previewable_attachable?
      false
    end

🔎 See on GitHub

to_attachable_partial_path()

Returns the path to the partial that is used for rendering the attachable. Defaults to to_partial_path.

Override to render a different partial:

class User < ApplicationRecord
  def to_attachable_partial_path
    "users/attachable"
  end
end

📝 Source code

# File actiontext/lib/action_text/attachable.rb, line 125
    def to_attachable_partial_path
      to_partial_path
    end

🔎 See on GitHub

to_missing_attachable_partial_path()

Returns the path to the partial that is used for rendering missing attachables. Defaults to “action_text/attachables/missing_attachable”.

Override to render a different partial:

class User < ApplicationRecord
  def self.to_missing_attachable_partial_path
    "users/missing_attachable"
  end
end

📝 Source code

# File actiontext/lib/action_text/attachable.rb, line 70
      def to_missing_attachable_partial_path
        ActionText::Attachables::MissingAttachable::DEFAULT_PARTIAL_PATH
      end

🔎 See on GitHub

to_rich_text_attributes(attributes = {})

📝 Source code

# File actiontext/lib/action_text/attachable.rb, line 129
    def to_rich_text_attributes(attributes = {})
      attributes.dup.tap do |attrs|
        attrs[:sgid] = attachable_sgid
        attrs[:content_type] = attachable_content_type
        attrs[:previewable] = true if previewable_attachable?
        attrs[:filename] = attachable_filename
        attrs[:filesize] = attachable_filesize
        attrs[:width] = attachable_metadata[:width]
        attrs[:height] = attachable_metadata[:height]
      end.compact
    end

🔎 See on GitHub

to_trix_content_attachment_partial_path()

Returns the path to the partial that is used for rendering the attachable in Trix. Defaults to to_partial_path.

Override to render a different partial:

class User < ApplicationRecord
  def to_trix_content_attachment_partial_path
    "users/trix_content_attachment"
  end
end

📝 Source code

# File actiontext/lib/action_text/attachable.rb, line 111
    def to_trix_content_attachment_partial_path
      to_partial_path
    end

🔎 See on GitHub