Module: ActionText::Attachable

Extended by:
ActiveSupport::Concern
Defined in:
actiontext/lib/action_text/attachable.rb

Overview

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]

Constant Summary collapse

LOCATOR_NAME = 
"attachable"

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ActiveSupport::Concern

append_features, class_methods, extended, included, prepend_features, prepended

Class Method Details

.from_attachable_sgid(sgid, options = {}) ⇒ Object 



41
42
43
44
45
 
# 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

.from_node(node) ⇒ Object

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



29
30
31
32
33
34
35
36
37
38
39
 
# 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

Instance Method Details

#as_json ⇒ Object

Returns the attachable as JSON with the attachable_sgid included.



102
103
104
 
# File 'actiontext/lib/action_text/attachable.rb', line 102

def as_json(*)
  super.merge("attachable_sgid" => persisted? ? attachable_sgid : nil)
end

#attachable_content_type ⇒ Object 



81
82
83
 
# File 'actiontext/lib/action_text/attachable.rb', line 81

def attachable_content_type
  try(:content_type) || "application/octet-stream"
end

#attachable_filename ⇒ Object 



85
86
87
 
# File 'actiontext/lib/action_text/attachable.rb', line 85

def attachable_filename
  filename.to_s if respond_to?(:filename)
end

#attachable_filesize ⇒ Object 



89
90
91
 
# File 'actiontext/lib/action_text/attachable.rb', line 89

def attachable_filesize
  try(:byte_size) || try(:filesize)
end

#attachable_metadata ⇒ Object 



93
94
95
 
# File 'actiontext/lib/action_text/attachable.rb', line 93

def attachable_metadata
  try(:metadata) || {}
end

#attachable_sgid ⇒ Object

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.



77
78
79
 
# File 'actiontext/lib/action_text/attachable.rb', line 77

def attachable_sgid
  to_sgid(expires_in: nil, for: LOCATOR_NAME).to_s
end

#previewable_attachable? ⇒ Boolean

Returns:

  • (Boolean) 


97
98
99
 
# File 'actiontext/lib/action_text/attachable.rb', line 97

def previewable_attachable?
  false
end

#to_attachable_partial_path ⇒ Object

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



130
131
132
 
# File 'actiontext/lib/action_text/attachable.rb', line 130

def to_attachable_partial_path
  to_partial_path
end

#to_rich_text_attributes(attributes = {}) ⇒ Object 



134
135
136
137
138
139
140
141
142
143
144
 
# File 'actiontext/lib/action_text/attachable.rb', line 134

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

#to_trix_content_attachment_partial_path ⇒ Object

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



116
117
118
 
# File 'actiontext/lib/action_text/attachable.rb', line 116

def to_trix_content_attachment_partial_path
  to_partial_path
end