actiontext 7.1.3.2 → 7.2.0.beta1

data/app/models/action_text/rich_text.rb

@@ -1,55 +1,87 @@
 # 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"
   class RichText < Record
-    self.table_name = "action_text_rich_texts"
+    ##
+    # :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: "<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
 
+    ##
+    # :method: record
+    #
+    # Returns the associated record.
     belongs_to :record, polymorphic: true, touch: true
+
+    ##
+    # :method: embeds
+    #
+    # Returns the `ActiveStorage::Blob`s of the embedded files.
     has_many_attached :embeds
 
     before_save do
       self.embeds = body.attachables.grep(ActiveStorage::Blob).uniq if body.present?
     end
 
-    # Returns the +body+ attribute as plain text with all HTML tags removed.
+    # 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!"
+    #
+    # NOTE: that the returned string is not HTML safe and should not be rendered in
+    # browsers.
     #
-    #   message = Message.create!(content: "<h1>Funny times!</h1>")
-    #   message.content.to_plain_text # => "Funny times!"
+    #     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

data/db/migrate/20180528164100_create_action_text_tables.rb

@@ -20,6 +20,6 @@ class CreateActionTextTables < ActiveRecord::Migration[6.0]
       setting = config.options[config.orm][:primary_key_type]
       primary_key_type = setting || :primary_key
       foreign_key_type = setting || :bigint
-      [primary_key_type, foreign_key_type]
+      [ primary_key_type, foreign_key_type ]
     end
 end

data/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 @@ module ActionText
         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 @@ module ActionText
       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

data/lib/action_text/attachables/content_attachment.rb

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

data/lib/action_text/attachables/missing_attachable.rb

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

data/lib/action_text/attachables/remote_image.rb

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

data/lib/action_text/attachment.rb

@@ -1,19 +1,21 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "active_support/core_ext/object/try"
 
 module ActionText
-  # = Action Text \Attachment
+  # # Action Text Attachment
   #
   # Attachments serialize attachables to HTML or plain text.
   #
-  #   class Person < ApplicationRecord
-  #     include ActionText::Attachable
-  #   end
+  #     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..."
+  #     attachable = Person.create! name: "Javan"
+  #     attachment = ActionText::Attachment.from_attachable(attachable)
+  #     attachment.to_html # => "<action-text-attachment sgid=\"BAh7CEk..."
   class Attachment
     include Attachments::TrixConversion, Attachments::Minification, Attachments::Caching
 
@@ -82,29 +84,29 @@ module ActionText
 
     # 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]"
+    #     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:
+    # Use the `caption` when set:
     #
-    #   attachment = ActionText::Attachment.from_attachable(attachable, caption: "Vroom vroom")
-    #   attachment.to_plain_text # => "[Vroom vroom]"
+    #     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:
+    # `attachable_plain_text_representation` method:
     #
-    #   class Person < ApplicationRecord
-    #     include ActionText::Attachable
+    #     class Person < ApplicationRecord
+    #       include ActionText::Attachable
     #
-    #     def attachable_plain_text_representation
-    #       "[#{name}]"
+    #       def attachable_plain_text_representation
+    #         "[#{name}]"
+    #       end
     #     end
-    #   end
     #
-    #   attachable = Person.create! name: "Javan"
-    #   attachment = ActionText::Attachment.from_attachable(attachable)
-    #   attachment.to_plain_text # => "[Javan]"
+    #     attachable = Person.create! name: "Javan"
+    #     attachment = ActionText::Attachment.from_attachable(attachable)
+    #     attachment.to_plain_text # => "[Javan]"
     def to_plain_text
       if respond_to?(:attachable_plain_text_representation)
         attachable_plain_text_representation(caption)
@@ -115,9 +117,9 @@ module ActionText
 
     # Converts the attachment to HTML.
     #
-    #   attachable = Person.create! name: "Javan"
-    #   attachment = ActionText::Attachment.from_attachable(attachable)
-    #   attachment.to_html # => "<action-text-attachment sgid=\"BAh7CEk...
+    #     attachable = Person.create! name: "Javan"
+    #     attachment = ActionText::Attachment.from_attachable(attachable)
+    #     attachment.to_html # => "<action-text-attachment sgid=\"BAh7CEk...
     def to_html
       HtmlConversion.node_to_html(node)
     end

data/lib/action_text/attachment_gallery.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionText
   class AttachmentGallery
     include ActiveModel::Model

data/lib/action_text/attachments/caching.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionText
   module Attachments
     module Caching

data/lib/action_text/attachments/minification.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionText
   module Attachments
     module Minification

data/lib/action_text/attachments/trix_conversion.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "active_support/core_ext/object/try"
 
 module ActionText

data/lib/action_text/attribute.rb

@@ -1,39 +1,52 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionText
   module Attribute
     extend ActiveSupport::Concern
 
     class_methods do
-      # Provides access to a dependent RichText model that holds the body and attachments for a single named rich text attribute.
-      # This dependent attribute is lazily instantiated and will be auto-saved when it's been changed. Example:
+      # Provides access to a dependent RichText model that holds the body and
+      # attachments for a single named rich text attribute. This dependent attribute
+      # is lazily instantiated and will be auto-saved when it's been changed. Example:
+      #
+      #     class Message < ActiveRecord::Base
+      #       has_rich_text :content
+      #     end
+      #
+      #     message = Message.create!(content: "<h1>Funny times!</h1>")
+      #     message.content? #=> true
+      #     message.content.to_s # => "<h1>Funny times!</h1>"
+      #     message.content.to_plain_text # => "Funny times!"
       #
-      #   class Message < ActiveRecord::Base
-      #     has_rich_text :content
-      #   end
+      # The dependent RichText model will also automatically process attachments links
+      # as sent via the Trix-powered editor. These attachments are associated with the
+      # RichText model using Active Storage.
       #
-      #   message = Message.create!(content: "<h1>Funny times!</h1>")
-      #   message.content? #=> true
-      #   message.content.to_s # => "<h1>Funny times!</h1>"
-      #   message.content.to_plain_text # => "Funny times!"
+      # If you wish to preload the dependent RichText model, you can use the named
+      # scope:
       #
-      # The dependent RichText model will also automatically process attachments links as sent via the Trix-powered editor.
-      # These attachments are associated with the RichText model using Active Storage.
+      #     Message.all.with_rich_text_content # Avoids N+1 queries when you just want the body, not the attachments.
+      #     Message.all.with_rich_text_content_and_embeds # Avoids N+1 queries when you just want the body and attachments.
+      #     Message.all.with_all_rich_text # Loads all rich text associations.
       #
-      # If you wish to preload the dependent RichText model, you can use the named scope:
+      # #### Options
       #
-      #   Message.all.with_rich_text_content # Avoids N+1 queries when you just want the body, not the attachments.
-      #   Message.all.with_rich_text_content_and_embeds # Avoids N+1 queries when you just want the body and attachments.
-      #   Message.all.with_all_rich_text # Loads all rich text associations.
+      # *   `:encrypted` - Pass true to encrypt the rich text attribute. The
+      #     encryption will be non-deterministic. See
+      #     `ActiveRecord::Encryption::EncryptableRecord.encrypts`. Default: false.
       #
-      # ==== Options
+      # *   `:strict_loading` - Pass true to force strict loading. When omitted,
+      #     `strict_loading:` will be set to the value of the
+      #     `strict_loading_by_default` class attribute (false by default).
       #
-      # * <tt>:encrypted</tt> - Pass true to encrypt the rich text attribute. The encryption will be non-deterministic. See
-      #   +ActiveRecord::Encryption::EncryptableRecord.encrypts+. Default: false.
       #
-      # * <tt>:strict_loading</tt> - Pass true to force strict loading. When
-      #   omitted, <tt>strict_loading:</tt> will be set to the value of the
-      #   <tt>strict_loading_by_default</tt> class attribute (false by default).
+      # Note: Action Text relies on polymorphic associations, which in turn store
+      # class names in the database. When renaming classes that use `has_rich_text`,
+      # make sure to also update the class names in the
+      # `action_text_rich_texts.record_type` polymorphic type column of the
+      # corresponding rows.
       def has_rich_text(name, encrypted: false, strict_loading: strict_loading_by_default)
         class_eval <<-CODE, __FILE__, __LINE__ + 1
           def #{name}
@@ -60,9 +73,10 @@ module ActionText
 
       # Eager load all dependent RichText models in bulk.
       def with_all_rich_text
-        eager_load(rich_text_association_names)
+        includes(rich_text_association_names)
       end
 
+      # Returns the names of all rich text associations.
       def rich_text_association_names
         reflect_on_all_associations(:has_one).collect(&:name).select { |n| n.start_with?("rich_text_") }
       end

data/lib/action_text/content.rb

@@ -1,29 +1,32 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionText
-  # = Action Text \Content
+  # # Action Text Content
   #
-  # The +ActionText::Content+ class wraps an HTML fragment to add support for
+  # The `ActionText::Content` class wraps an HTML fragment to add support for
   # parsing, rendering and serialization. It can be used to extract links and
-  # attachments, convert the fragment to plain text, or serialize the fragment
-  # to the database.
+  # attachments, convert the fragment to plain text, or serialize the fragment to
+  # the database.
   #
   # The ActionText::RichText record serializes the `body` attribute as
-  # +ActionText::Content+.
+  # `ActionText::Content`.
   #
-  #   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>")
-  #   body = message.content.body # => #<ActionText::Content "<div class=\"trix-conte...">
-  #   body.to_s # => "<h1>Funny times!</h1>"
-  #   body.to_plain_text # => "Funny times!"
+  #     message = Message.create!(content: "<h1>Funny times!</h1>")
+  #     body = message.content.body # => #<ActionText::Content "<div class=\"trix-conte...">
+  #     body.to_s # => "<h1>Funny times!</h1>"
+  #     body.to_plain_text # => "Funny times!"
   class Content
     include Rendering, Serialization
 
     attr_reader :fragment
 
+    delegate :deconstruct, to: :fragment
     delegate :blank?, :empty?, :html_safe, :present?, to: :to_html # Delegating to to_html to avoid including the layout
 
     class << self
@@ -46,19 +49,19 @@ module ActionText
 
     # Extracts links from the HTML fragment:
     #
-    #   html = '<a href="http://example.com/">Example</a>'
-    #   content = ActionText::Content.new(html)
-    #   content.links # => ["http://example.com/"]
+    #     html = '<a href="http://example.com/">Example</a>'
+    #     content = ActionText::Content.new(html)
+    #     content.links # => ["http://example.com/"]
     def links
       @links ||= fragment.find_all("a[href]").map { |a| a["href"] }.uniq
     end
 
     # Extracts +ActionText::Attachment+s from the HTML fragment:
     #
-    #   attachable = ActiveStorage::Blob.first
-    #   html = %Q(<action-text-attachment sgid="#{attachable.attachable_sgid}" caption="Captioned"></action-text-attachment>)
-    #   content = ActionText::Content.new(html)
-    #   content.attachments # => [#<ActionText::Attachment attachable=#<ActiveStorage::Blob...
+    #     attachable = ActiveStorage::Blob.first
+    #     html = %Q(<action-text-attachment sgid="#{attachable.attachable_sgid}" caption="Captioned"></action-text-attachment>)
+    #     content = ActionText::Content.new(html)
+    #     content.attachments # => [#<ActionText::Attachment attachable=#<ActiveStorage::Blob...
     def attachments
       @attachments ||= attachment_nodes.map do |node|
         attachment_for_node(node)
@@ -77,10 +80,10 @@ module ActionText
 
     # Extracts +ActionText::Attachable+s from the HTML fragment:
     #
-    #   attachable = ActiveStorage::Blob.first
-    #   html = %Q(<action-text-attachment sgid="#{attachable.attachable_sgid}" caption="Captioned"></action-text-attachment>)
-    #   content = ActionText::Content.new(html)
-    #   content.attachables # => [attachable]
+    #     attachable = ActiveStorage::Blob.first
+    #     html = %Q(<action-text-attachment sgid="#{attachable.attachable_sgid}" caption="Captioned"></action-text-attachment>)
+    #     content = ActionText::Content.new(html)
+    #     content.attachables # => [attachable]
     def attachables
       @attachables ||= attachment_nodes.map do |node|
         ActionText::Attachable.from_node(node)
@@ -106,10 +109,20 @@ module ActionText
       self.class.new(content, canonicalize: false)
     end
 
-    # Returns the content as plain text with all HTML tags removed.
+    # Returns a plain-text version of the markup contained by the content, with tags
+    # removed but HTML entities encoded.
+    #
+    #     content = ActionText::Content.new("<h1>Funny times!</h1>")
+    #     content.to_plain_text # => "Funny times!"
+    #
+    #     content = ActionText::Content.new("<div onclick='action()'>safe<script>unsafe</script></div>")
+    #     content.to_plain_text # => "safeunsafe"
     #
-    #   content = ActionText::Content.new("<h1>Funny times!</h1>")
-    #   content.to_plain_text # => "Funny times!"
+    # NOTE: that the returned string is not HTML safe and should not be rendered in
+    # browsers.
+    #
+    #     content = ActionText::Content.new("&lt;script&gt;alert()&lt;/script&gt;")
+    #     content.to_plain_text # => "<script>alert()</script>"
     def to_plain_text
       render_attachments(with_full_attributes: false, &:to_plain_text).fragment.to_plain_text
     end
@@ -130,6 +143,13 @@ module ActionText
       "action_text/contents/content"
     end
 
+    # Safely transforms Content into an HTML String.
+    #
+    #     content = ActionText::Content.new(content: "<h1>Funny times!</h1>")
+    #     content.to_s # => "<h1>Funny times!</h1>"
+    #
+    #     content = ActionText::Content.new("<div onclick='action()'>safe<script>unsafe</script></div>")
+    #     content.to_s # => "<div>safeunsafe</div>"
     def to_s
       to_rendered_html_with_layout
     end

data/lib/action_text/deprecator.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionText
   def self.deprecator # :nodoc:
     @deprecator ||= ActiveSupport::Deprecation.new

data/lib/action_text/encryption.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionText
   module Encryption
     def encrypt

data/lib/action_text/engine.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "rails"
 require "action_controller/railtie"
 require "active_record/railtie"