123456789_123456789_123456789_123456789_123456789_

Class: ActionText::Attachment

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Instance Chain:
self, Attachments::TrixConversion, Attachments::Minification, Attachments::Caching, Attachments::Conversion
Inherits: Object
Defined in: actiontext/lib/action_text/attachment.rb

Overview

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

Constant Summary

Class Attribute Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Attachments::TrixConversion - Included

#to_trix_attachment, #trix_attachment_content

Attachments::Caching - Included

#cache_key, #cache_digest

Attachments::Conversion - Included

#to_editor_attachment, #to_editor_attachment!, #editor_attachment_content

Constructor Details

.new(node, attachable) ⇒ Attachment

[ GitHub ] 

  


# File 'actiontext/lib/action_text/attachment.rb', line 69



def initialize(node, attachable)
  @node = node
  @attachable = attachable
end


  







Class Attribute Details



  

    .tag_name   (rw)
    Also known as: #tag_name
  

  [ GitHub ]


  

  


# File 'actiontext/lib/action_text/attachment.rb', line 23



mattr_accessor :tag_name, default: "action-text-attachment"


  







Class Method Details



  

    .fragment_by_canonicalizing_attachments(content)  
  

  [ GitHub ]


  

  


# File 'actiontext/lib/action_text/attachment.rb', line 28



def fragment_by_canonicalizing_attachments(content)
  fragment_by_minifying_attachments(fragment_by_converting_editor_attachments(content))
end


  








  

    .from_attachable(attachable, attributes = {})  
  

  [ GitHub ]


  

  


# File 'actiontext/lib/action_text/attachment.rb', line 40



def from_attachable(attachable, attributes = {})
  if node = node_from_attributes(attachable.to_rich_text_attributes(attributes))
    new(node, attachable)
  end
end


  








  

    .from_attachables(attachables)  
  

  [ GitHub ]


  

  


# File 'actiontext/lib/action_text/attachment.rb', line 36



def from_attachables(attachables)
  Array(attachables).filter_map { |attachable| from_attachable(attachable) }
end


  








  

    .from_attributes(attributes, attachable = nil)  
  

  [ GitHub ]


  

  


# File 'actiontext/lib/action_text/attachment.rb', line 46



def from_attributes(attributes, attachable = nil)
  if node = node_from_attributes(attributes)
    from_node(node, attachable)
  end
end


  








  

    .from_node(node, attachable = nil)  
  

  [ GitHub ]


  

  


# File 'actiontext/lib/action_text/attachment.rb', line 32



def from_node(node, attachable = nil)
  new(node, attachable || ActionText::Attachable.from_node(node))
end


  








  

    .node_from_attributes(attributes)   (private)
  

  [ GitHub ]


  

  


# File 'actiontext/lib/action_text/attachment.rb', line 53



def node_from_attributes(attributes)
  if attributes = process_attributes(attributes).presence
    ActionText::HtmlConversion.create_element(tag_name, attributes)
  end
end


  








  

    .process_attributes(attributes)   (private)
  

  [ GitHub ]


  

  


# File 'actiontext/lib/action_text/attachment.rb', line 59



def process_attributes(attributes)
  attributes.transform_keys { |key| key.to_s.underscore.dasherize }.slice(*ATTRIBUTES)
end


  







Instance Attribute Details



  

    #attachable   (readonly)
  

  [ GitHub ]


  

  


# File 'actiontext/lib/action_text/attachment.rb', line 64



attr_reader :node, :attachable


  








  

    #node   (readonly)
  

  [ GitHub ]


  

  


# File 'actiontext/lib/action_text/attachment.rb', line 64



attr_reader :node, :attachable


  








  

    #tag_name   (rw)
  

  [ GitHub ]


  

  


# File 'actiontext/lib/action_text/attachment.rb', line 23



mattr_accessor :tag_name, default: "action-text-attachment"


  







Instance Method Details



  

    #attachable_attributes   (private)
  

  [ GitHub ]


  

  


# File 'actiontext/lib/action_text/attachment.rb', line 192



def attachable_attributes
  @attachable_attributes ||= (attachable.try(:to_rich_text_attributes) || {}).stringify_keys
end


  








  

    #caption  
  

  [ GitHub ]


  

  


# File 'actiontext/lib/action_text/attachment.rb', line 74



def caption
  node_attributes["caption"].presence
end


  








  

    #full_attributes  
  

  [ GitHub ]


  

  


# File 'actiontext/lib/action_text/attachment.rb', line 78



def full_attributes
  node_attributes.merge(attachable_attributes).merge(sgid_attributes)
end


  








  

    #instance_variables_to_inspect   (private)
  

  [ GitHub ]


  

  


# File 'actiontext/lib/action_text/attachment.rb', line 184



def instance_variables_to_inspect
  [:@attachable].freeze
end


  








  

    #node_attributes   (private)
  

  [ GitHub ]


  

  


# File 'actiontext/lib/action_text/attachment.rb', line 188



def node_attributes
  @node_attributes ||= ATTRIBUTES.to_h { |name| [ name.underscore, node[name] ] }.compact
end


  








  

    #sgid_attributes   (private)
  

  [ GitHub ]


  

  


# File 'actiontext/lib/action_text/attachment.rb', line 196



def sgid_attributes
  @sgid_attributes ||= node_attributes.slice("sgid").presence || attachable_attributes.slice("sgid")
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...


  



  [ GitHub ]


  

  


# File 'actiontext/lib/action_text/attachment.rb', line 173



def to_html
  HtmlConversion.node_to_html(node)
end


  








  

    #to_markdown(attachment_links: false)  
  



  

    

Converts the attachment to Markdown.



By default, ::ActiveStorage blob attachments render as bracketed text:



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



Use the #caption when set:



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



When attachment_links is true and a rendering context is available (e.g., controller or mailer action), ::ActiveStorage blob attachments generate Markdown links with URLs.



# Image blob
attachment.to_markdown(attachment_links: true) # => "!{http://example.com/rails/active_storage/blobs/... racecar.jpg}"

# Non-image blob
attachment.to_markdown(attachment_links: true) # => "{http://example.com/rails/active_storage/blobs/... report.pdf}"



Remote images always render as Markdown links regardless of attachment_links:



content = ActionText::Content.new('<action-text-attachment content-type="image/jpeg" url="https://example.com/photo.jpg" caption="A photo"></action-text-attachment>')
content.to_markdown # => "!{https://example.com/photo.jpg A photo}"



The presentation can be overridden by implementing the attachable_markdown_representation method:



class Person < ApplicationRecord
  include ActionText::Attachable

  def attachable_markdown_representation(caption, attachment_links: false)
    MarkdownConversion.markdown_link("@#{name}", Rails.application.routes.url_helpers.person_url(self))
  end
end

attachable = Person.create! name: "Javan"
attachment = ActionText::Attachment.from_attachable(attachable)
attachment.to_markdown # => "{http://example.com/people/1 @Javan}"


  



  [ GitHub ]


  

  


# File 'actiontext/lib/action_text/attachment.rb', line 160



def to_markdown(attachment_links: false)
  if respond_to?(:attachable_markdown_representation)
    attachable_markdown_representation(caption, attachment_links: attachment_links)
  else
    caption.to_s
  end
end


  








  

    #to_param  
  

  [ GitHub ]


  

  


# File 'actiontext/lib/action_text/attachment.rb', line 66



delegate :to_param, to: :attachable


  








  

    #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]"


  



  [ GitHub ]


  

  


# File 'actiontext/lib/action_text/attachment.rb', line 111



def to_plain_text
  if respond_to?(:attachable_plain_text_representation)
    attachable_plain_text_representation(caption)
  else
    caption.to_s
  end
end


  








  

    #to_s  
  

  [ GitHub ]


  

  


# File 'actiontext/lib/action_text/attachment.rb', line 177



def to_s
  to_html
end


  








  

    #with_full_attributes  
  

  [ GitHub ]


  

  


# File 'actiontext/lib/action_text/attachment.rb', line 82



def with_full_attributes
  self.class.from_attributes(full_attributes, attachable)
end