./tools/rdoc-to-md --only=actiontext -a

Author: skipkayhil

actiontext/app/helpers/action_text/content_helper.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "rails-html-sanitizer"
 
 module ActionText

actiontext/app/helpers/action_text/tag_helper.rb

@@ -1,26 +1,32 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "active_support/core_ext/object/try"
 require "action_view/helpers/tags/placeholderable"
 
 module ActionText
   module TagHelper
     cattr_accessor(:id, instance_accessor: false) { 0 }
 
-    # Returns a +trix-editor+ tag that instantiates the Trix JavaScript editor as well as a hidden field
-    # that Trix will write to on changes, so the content will be sent on form submissions.
+    # Returns a `trix-editor` tag that instantiates the Trix JavaScript editor as
+    # well as a hidden field that Trix will write to on changes, so the content will
+    # be sent on form submissions.
+    #
+    # #### Options
+    # *   `:class` - Defaults to "trix-content" so that default styles will be
+    #     applied. Setting this to a different value will prevent default styles
+    #     from being applied.
+    # *   `[:data][:direct_upload_url]` - Defaults to `rails_direct_uploads_url`.
+    # *   `[:data][:blob_url_template]` - Defaults to
+    #     `rails_service_blob_url(":signed_id", ":filename")`.
     #
-    # ==== Options
-    # * <tt>:class</tt> - Defaults to "trix-content" so that default styles will be applied.
-    #   Setting this to a different value will prevent default styles from being applied.
-    # * <tt>[:data][:direct_upload_url]</tt> - Defaults to +rails_direct_uploads_url+.
-    # * <tt>[:data][:blob_url_template]</tt> - Defaults to <tt>rails_service_blob_url(":signed_id", ":filename")</tt>.
     #
-    # ==== Example
+    # #### Example
     #
-    #   rich_text_area_tag "content", message.content
-    #   # <input type="hidden" name="content" id="trix_input_post_1">
-    #   # <trix-editor id="content" input="trix_input_post_1" class="trix-content" ...></trix-editor>
+    #     rich_text_area_tag "content", message.content
+    #     # <input type="hidden" name="content" id="trix_input_post_1">
+    #     # <trix-editor id="content" input="trix_input_post_1" class="trix-content" ...></trix-editor>
     def rich_text_area_tag(name, value = nil, options = {})
       options = options.symbolize_keys
       form = options.delete(:form)
@@ -56,23 +62,27 @@ def render
   end
 
   module FormHelper
-    # Returns a +trix-editor+ tag that instantiates the Trix JavaScript editor as well as a hidden field
-    # that Trix will write to on changes, so the content will be sent on form submissions.
+    # Returns a `trix-editor` tag that instantiates the Trix JavaScript editor as
+    # well as a hidden field that Trix will write to on changes, so the content will
+    # be sent on form submissions.
+    #
+    # #### Options
+    # *   `:class` - Defaults to "trix-content" which ensures default styling is
+    #     applied.
+    # *   `:value` - Adds a default value to the HTML input tag.
+    # *   `[:data][:direct_upload_url]` - Defaults to `rails_direct_uploads_url`.
+    # *   `[:data][:blob_url_template]` - Defaults to
+    #     `rails_service_blob_url(":signed_id", ":filename")`.
     #
-    # ==== Options
-    # * <tt>:class</tt> - Defaults to "trix-content" which ensures default styling is applied.
-    # * <tt>:value</tt> - Adds a default value to the HTML input tag.
-    # * <tt>[:data][:direct_upload_url]</tt> - Defaults to +rails_direct_uploads_url+.
-    # * <tt>[:data][:blob_url_template]</tt> - Defaults to <tt>rails_service_blob_url(":signed_id", ":filename")</tt>.
     #
-    # ==== Example
-    #   rich_text_area :message, :content
-    #   # <input type="hidden" name="message[content]" id="message_content_trix_input_message_1">
-    #   # <trix-editor id="content" input="message_content_trix_input_message_1" class="trix-content" ...></trix-editor>
+    # #### Example
+    #     rich_text_area :message, :content
+    #     # <input type="hidden" name="message[content]" id="message_content_trix_input_message_1">
+    #     # <trix-editor id="content" input="message_content_trix_input_message_1" class="trix-content" ...></trix-editor>
     #
-    #   rich_text_area :message, :content, value: "<h1>Default message</h1>"
-    #   # <input type="hidden" name="message[content]" id="message_content_trix_input_message_1" value="<h1>Default message</h1>">
-    #   # <trix-editor id="content" input="message_content_trix_input_message_1" class="trix-content" ...></trix-editor>
+    #     rich_text_area :message, :content, value: "<h1>Default message</h1>"
+    #     # <input type="hidden" name="message[content]" id="message_content_trix_input_message_1" value="<h1>Default message</h1>">
+    #     # <trix-editor id="content" input="message_content_trix_input_message_1" class="trix-content" ...></trix-editor>
     def rich_text_area(object_name, method, options = {})
       Tags::ActionText.new(object_name, method, self, options).render
     end
@@ -81,9 +91,9 @@ def rich_text_area(object_name, method, options = {})
   class FormBuilder
     # Wraps ActionView::Helpers::FormHelper#rich_text_area for form builders:
     #
-    #   <%= form_with model: @message do |f| %>
-    #     <%= f.rich_text_area :content %>
-    #   <% end %>
+    #     <%= form_with model: @message do |f| %>
+    #       <%= f.rich_text_area :content %>
+    #     <% end %>
     #
     # Please refer to the documentation of the base helper for details.
     def rich_text_area(method, options = {})

actiontext/app/models/action_text/encrypted_rich_text.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionText
   class EncryptedRichText < RichText
     encrypts :body

actiontext/app/models/action_text/record.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionText
   class Record < ActiveRecord::Base # :nodoc:
     self.abstract_class = true

actiontext/app/models/action_text/rich_text.rb

@@ -1,37 +1,40 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionText
-  # = Action Text \RichText
+  # # Action Text RichText
   #
-  # The RichText record holds the content produced by the Trix editor in a serialized +body+ attribute.
-  # It also holds all the references to the embedded files, which are stored using Active Storage.
-  # This record is then associated with the Active Record model the application desires to have
-  # rich text content using the +has_rich_text+ class method.
+  # The RichText record holds the content produced by the Trix editor in a
+  # serialized `body` attribute. It also holds all the references to the embedded
+  # files, which are stored using Active Storage. This record is then associated
+  # with the Active Record model the application desires to have rich text content
+  # using the `has_rich_text` class method.
   #
-  #   class Message < ActiveRecord::Base
-  #     has_rich_text :content
-  #   end
+  #     class Message < ActiveRecord::Base
+  #       has_rich_text :content
+  #     end
   #
-  #   message = Message.create!(content: "<h1>Funny times!</h1>")
-  #   message.content #=> #<ActionText::RichText....
-  #   message.content.to_s # => "<h1>Funny times!</h1>"
-  #   message.content.to_plain_text # => "Funny times!"
+  #     message = Message.create!(content: "<h1>Funny times!</h1>")
+  #     message.content #=> #<ActionText::RichText....
+  #     message.content.to_s # => "<h1>Funny times!</h1>"
+  #     message.content.to_plain_text # => "Funny times!"
   #
-  #   message = Message.create!(content: "<div onclick='action()'>safe<script>unsafe</script></div>")
-  #   message.content #=> #<ActionText::RichText....
-  #   message.content.to_s # => "<div>safeunsafe</div>"
-  #   message.content.to_plain_text # => "safeunsafe"
+  #     message = Message.create!(content: "<div onclick='action()'>safe<script>unsafe</script></div>")
+  #     message.content #=> #<ActionText::RichText....
+  #     message.content.to_s # => "<div>safeunsafe</div>"
+  #     message.content.to_plain_text # => "safeunsafe"
   class RichText < Record
     ##
     # :method: to_s
     #
     # Safely transforms RichText into an HTML String.
     #
-    #   message = Message.create!(content: "<h1>Funny times!</h1>")
-    #   message.content.to_s # => "<h1>Funny times!</h1>"
+    #     message = Message.create!(content: "<h1>Funny times!</h1>")
+    #     message.content.to_s # => "<h1>Funny times!</h1>"
     #
-    #   message = Message.create!(content: "<div onclick='action()'>safe<script>unsafe</script></div>")
-    #   message.content.to_s # => "<div>safeunsafe</div>"
+    #     message = Message.create!(content: "<div onclick='action()'>safe<script>unsafe</script></div>")
+    #     message.content.to_s # => "<div>safeunsafe</div>"
 
     serialize :body, coder: ActionText::Content
     delegate :to_s, :nil?, to: :body
@@ -43,32 +46,33 @@ class RichText < Record
       self.embeds = body.attachables.grep(ActiveStorage::Blob).uniq if body.present?
     end
 
-    # Returns a plain-text version of the markup contained by the +body+ attribute,
+    # Returns a plain-text version of the markup contained by the `body` attribute,
     # with tags removed but HTML entities encoded.
     #
-    #   message = Message.create!(content: "<h1>Funny times!</h1>")
-    #   message.content.to_plain_text # => "Funny times!"
+    #     message = Message.create!(content: "<h1>Funny times!</h1>")
+    #     message.content.to_plain_text # => "Funny times!"
     #
-    # NOTE: that the returned string is not HTML safe and should not be rendered in browsers.
+    # NOTE: that the returned string is not HTML safe and should not be rendered in
+    # browsers.
     #
-    #   message = Message.create!(content: "&lt;script&gt;alert()&lt;/script&gt;")
-    #   message.content.to_plain_text # => "<script>alert()</script>"
+    #     message = Message.create!(content: "&lt;script&gt;alert()&lt;/script&gt;")
+    #     message.content.to_plain_text # => "<script>alert()</script>"
     def to_plain_text
       body&.to_plain_text.to_s
     end
 
-    # Returns the +body+ attribute in a format that makes it editable in the Trix
+    # Returns the `body` attribute in a format that makes it editable in the Trix
     # editor. Previews of attachments are rendered inline.
     #
-    #   content = "<h1>Funny Times!</h1><figure data-trix-attachment='{\"sgid\":\"..."\}'></figure>"
-    #   message = Message.create!(content: content)
-    #   message.content.to_trix_html # =>
-    #   # <div class="trix-content">
-    #   #   <h1>Funny times!</h1>
-    #   #   <figure data-trix-attachment='{\"sgid\":\"..."\}'>
-    #   #      <img src="http://example.org/rails/active_storage/.../funny.jpg">
-    #   #   </figure>
-    #   # </div>
+    #     content = "<h1>Funny Times!</h1><figure data-trix-attachment='{\"sgid\":\"..."\}'></figure>"
+    #     message = Message.create!(content: content)
+    #     message.content.to_trix_html # =>
+    #     # <div class="trix-content">
+    #     #   <h1>Funny times!</h1>
+    #     #   <figure data-trix-attachment='{\"sgid\":\"..."\}'>
+    #     #      <img src="http://example.org/rails/active_storage/.../funny.jpg">
+    #     #   </figure>
+    #     # </div>
     def to_trix_html
       body&.to_trix_html
     end

actiontext/lib/action_text/attachable.rb

@@ -1,31 +1,33 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionText
-  # = Action Text \Attachable
+  # # Action Text Attachable
   #
   # Include this module to make a record attachable to an ActionText::Content.
   #
-  #   class Person < ApplicationRecord
-  #     include ActionText::Attachable
-  #   end
+  #     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]
+  #     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]
   module Attachable
     extend ActiveSupport::Concern
 
     LOCATOR_NAME = "attachable"
 
     class << self
-      # Extracts the +ActionText::Attachable+ from the attachment HTML 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
+      #     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
       def from_node(node)
         if attachable = attachable_from_sgid(node["sgid"])
           attachable
@@ -57,23 +59,23 @@ def from_attachable_sgid(sgid)
         ActionText::Attachable.from_attachable_sgid(sgid, only: self)
       end
 
-      # Returns the path to the partial that is used for rendering missing attachables.
-      # Defaults to "action_text/attachables/missing_attachable".
+      # 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"
+      #     class User < ApplicationRecord
+      #       def self.to_missing_attachable_partial_path
+      #         "users/missing_attachable"
+      #       end
       #     end
-      #   end
       def to_missing_attachable_partial_path
         ActionText::Attachables::MissingAttachable::DEFAULT_PARTIAL_PATH
       end
     end
 
-    # 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.
+    # 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.
     def attachable_sgid
       to_sgid(expires_in: nil, for: LOCATOR_NAME).to_s
     end
@@ -98,30 +100,30 @@ def previewable_attachable?
       false
     end
 
-    # Returns the path to the partial that is used for rendering the attachable
-    # in Trix. Defaults to +to_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"
+    #     class User < ApplicationRecord
+    #       def to_trix_content_attachment_partial_path
+    #         "users/trix_content_attachment"
+    #       end
     #     end
-    #   end
     def to_trix_content_attachment_partial_path
       to_partial_path
     end
 
     # Returns the path to the partial that is used for rendering the attachable.
-    # Defaults to +to_partial_path+.
+    # Defaults to `to_partial_path`.
     #
     # Override to render a different partial:
     #
-    #   class User < ApplicationRecord
-    #     def to_attachable_partial_path
-    #       "users/attachable"
+    #     class User < ApplicationRecord
+    #       def to_attachable_partial_path
+    #         "users/attachable"
+    #       end
     #     end
-    #   end
     def to_attachable_partial_path
       to_partial_path
     end

actiontext/lib/action_text/attachables/content_attachment.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionText
   module Attachables
     class ContentAttachment # :nodoc:

actiontext/lib/action_text/attachables/missing_attachable.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionText
   module Attachables
     class MissingAttachable

actiontext/lib/action_text/attachables/remote_image.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionText
   module Attachables
     class RemoteImage