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

Constants

LOCATOR_NAME = "attachable"

Class Public methods

from_attachable_sgid(sgid, options = {})

πŸ“ Source code 
# File actiontext/lib/action_text/attachable.rb, line 43
      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 31
      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 83
    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 87
    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 91
    def attachable_filesize
      try(:byte_size) || try(:filesize)
    end
πŸ”Ž See on GitHub

attachable_metadata()

πŸ“ Source code 
# File actiontext/lib/action_text/attachable.rb, line 95
    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 79
    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 58
      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 99
    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 127
    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 72
      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 131
    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 113
    def to_trix_content_attachment_partial_path
      to_partial_path
    end
πŸ”Ž See on GitHub