actiontext 7.0.8.2 → 7.1.0.beta1

data/app/helpers/action_text/content_helper.rb

@@ -4,9 +4,9 @@ require "rails-html-sanitizer"
 
 module ActionText
   module ContentHelper
-    mattr_accessor(:sanitizer) { Rails::Html::Sanitizer.safe_list_sanitizer.new }
-    mattr_accessor(:allowed_tags) { sanitizer.class.allowed_tags + [ ActionText::Attachment.tag_name, "figure", "figcaption" ] }
-    mattr_accessor(:allowed_attributes) { sanitizer.class.allowed_attributes + ActionText::Attachment::ATTRIBUTES }
+    mattr_accessor(:sanitizer, default: Rails::HTML4::Sanitizer.safe_list_sanitizer.new)
+    mattr_accessor(:allowed_tags)
+    mattr_accessor(:allowed_attributes)
     mattr_accessor(:scrubber)
 
     def render_action_text_content(content)
@@ -15,7 +15,12 @@ module ActionText
     end
 
     def sanitize_action_text_content(content)
-      sanitizer.sanitize(content.to_html, tags: allowed_tags, attributes: allowed_attributes, scrubber: scrubber).html_safe
+      sanitizer.sanitize(
+        content.to_html,
+        tags: sanitizer_allowed_tags,
+        attributes: sanitizer_allowed_attributes,
+        scrubber: scrubber,
+      ).html_safe
     end
 
     def render_action_text_attachments(content)
@@ -48,5 +53,13 @@ module ActionText
 
       render(**options).chomp
     end
+
+    def sanitizer_allowed_tags
+      allowed_tags || (sanitizer.class.allowed_tags + [ ActionText::Attachment.tag_name, "figure", "figcaption" ])
+    end
+
+    def sanitizer_allowed_attributes
+      allowed_attributes || (sanitizer.class.allowed_attributes + ActionText::Attachment::ATTRIBUTES)
+    end
   end
 end

data/app/helpers/action_text/tag_helper.rb

@@ -50,7 +50,8 @@ module ActionView::Helpers
       options = @options.stringify_keys
       add_default_name_and_id(options)
       options["input"] ||= dom_id(object, [options["id"], :trix_input].compact.join("_")) if object
-      @template_object.rich_text_area_tag(options.delete("name"), options.fetch("value") { value }, options.except("value"))
+      html_tag = @template_object.rich_text_area_tag(options.delete("name"), options.fetch("value") { value }, options.except("value"))
+      error_wrapping(html_tag)
     end
   end
 
@@ -82,6 +83,13 @@ module ActionView::Helpers
   end
 
   class FormBuilder
+    # Wraps ActionView::Helpers::FormHelper#rich_text_area for form builders:
+    #
+    #   <%= 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 = {})
       @template.rich_text_area(@object_name, method, objectify_options(options))
     end

data/app/models/action_text/encrypted_rich_text.rb

@@ -7,3 +7,5 @@ module ActionText
     encrypts :body
   end
 end
+
+ActiveSupport.run_load_hooks :action_text_encrypted_rich_text, ActionText::EncryptedRichText

data/app/models/action_text/rich_text.rb

@@ -1,14 +1,26 @@
 # frozen_string_literal: true
 
 module ActionText
+  # = 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.
+  #
+  #   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!"
+  #
   class RichText < Record
     self.table_name = "action_text_rich_texts"
 
-    serialize :body, ActionText::Content
+    serialize :body, coder: ActionText::Content
     delegate :to_s, :nil?, to: :body
 
     belongs_to :record, polymorphic: true, touch: true
@@ -18,10 +30,26 @@ module ActionText
       self.embeds = body.attachables.grep(ActiveStorage::Blob).uniq if body.present?
     end
 
+    # Returns the +body+ attribute as plain text with all HTML tags removed.
+    #
+    #   message = Message.create!(content: "<h1>Funny times!</h1>")
+    #   message.content.to_plain_text # => "Funny times!"
     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
+    # 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>
     def to_trix_html
       body&.to_trix_html
     end

data/app/views/action_text/attachables/_content_attachment.html.erb

@@ -0,0 +1,3 @@
+<figure class="attachment attachment--content">
+  <%= content_attachment.attachable %>
+</figure>

data/lib/action_text/attachable.rb

@@ -1,12 +1,31 @@
 # frozen_string_literal: true
 
 module ActionText
+  # = 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]
   module Attachable
     extend ActiveSupport::Concern
 
     LOCATOR_NAME = "attachable"
 
     class << self
+      # 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
       def from_node(node)
         if attachable = attachable_from_sgid(node["sgid"])
           attachable
@@ -15,7 +34,7 @@ module ActionText
         elsif attachable = ActionText::Attachables::RemoteImage.from_node(node)
           attachable
         else
-          ActionText::Attachables::MissingAttachable
+          ActionText::Attachables::MissingAttachable.new(node["sgid"])
         end
       end
 
@@ -37,8 +56,24 @@ module ActionText
       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".
+      #
+      # Override to render a different partial:
+      #
+      #   class User < ApplicationRecord
+      #     def self.to_missing_attachable_partial_path
+      #       "users/missing_attachable"
+      #     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.
     def attachable_sgid
       to_sgid(expires_in: nil, for: LOCATOR_NAME).to_s
     end
@@ -63,14 +98,35 @@ module ActionText
       false
     end
 
+    # Returns the attachable as JSON with the +attachable_sgid+ included.
     def as_json(*)
       super.merge("attachable_sgid" => persisted? ? attachable_sgid : nil)
     end
 
+    # 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
     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+.
+    #
+    # Override to render a different partial:
+    #
+    #   class User < ApplicationRecord
+    #     def to_attachable_partial_path
+    #       "users/attachable"
+    #     end
+    #   end
     def to_attachable_partial_path
       to_partial_path
     end

data/lib/action_text/attachables/content_attachment.rb

@@ -2,37 +2,39 @@
 
 module ActionText
   module Attachables
-    class ContentAttachment
+    class ContentAttachment # :nodoc:
       include ActiveModel::Model
 
       def self.from_node(node)
-        if node["content-type"]
-          if matches = node["content-type"].match(/vnd\.rubyonrails\.(.+)\.html/)
-            attachment = new(name: matches[1])
-            attachment if attachment.valid?
-          end
-        end
+        attachment = new(content_type: node["content-type"], content: node["content"])
+        attachment if attachment.valid?
       end
 
-      attr_accessor :name
-      validates_inclusion_of :name, in: %w( horizontal-rule )
+      attr_accessor :content_type, :content
+
+      validates_format_of :content_type, with: /html/
+      validates_presence_of :content
 
       def attachable_plain_text_representation(caption)
-        case name
-        when "horizontal-rule"
-          " ┄ "
-        else
-          " "
-        end
+        content_instance.fragment.source
+      end
+
+      def to_html
+        @to_html ||= content_instance.render(content_instance)
+      end
+
+      def to_s
+        to_html
       end
 
       def to_partial_path
         "action_text/attachables/content_attachment"
       end
 
-      def to_trix_content_attachment_partial_path
-        "action_text/attachables/content_attachments/#{name.underscore}"
-      end
+      private
+        def content_instance
+          @content_instance ||= ActionText::Content.new(content)
+        end
     end
   end
 end

data/lib/action_text/attachables/missing_attachable.rb

@@ -2,11 +2,25 @@
 
 module ActionText
   module Attachables
-    module MissingAttachable
+    class MissingAttachable
       extend ActiveModel::Naming
 
-      def self.to_partial_path
-        "action_text/attachables/missing_attachable"
+      DEFAULT_PARTIAL_PATH = "action_text/attachables/missing_attachable"
+
+      def initialize(sgid)
+        @sgid = SignedGlobalID.parse(sgid, for: ActionText::Attachable::LOCATOR_NAME)
+      end
+
+      def to_partial_path
+        if model
+          model.to_missing_attachable_partial_path
+        else
+          DEFAULT_PARTIAL_PATH
+        end
+      end
+
+      def model
+        @sgid&.model_name.to_s.safe_constantize
       end
     end
   end

data/lib/action_text/attachment.rb

@@ -3,12 +3,23 @@
 require "active_support/core_ext/object/try"
 
 module ActionText
+  # = Action Text \Attachment
+  #
+  # 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..."
   class Attachment
     include Attachments::TrixConversion, Attachments::Minification, Attachments::Caching
 
     mattr_accessor :tag_name, default: "action-text-attachment"
 
-    ATTRIBUTES = %w( sgid content-type url href filename filesize width height previewable presentation caption )
+    ATTRIBUTES = %w( sgid content-type url href filename filesize width height previewable presentation caption content )
 
     class << self
       def fragment_by_canonicalizing_attachments(content)
@@ -69,6 +80,31 @@ module ActionText
       self.class.from_attributes(full_attributes, attachable)
     end
 
+    # 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]"
     def to_plain_text
       if respond_to?(:attachable_plain_text_representation)
         attachable_plain_text_representation(caption)
@@ -77,6 +113,11 @@ module ActionText
       end
     end
 
+    # Converts the attachment to HTML.
+    #
+    #   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
@@ -91,7 +132,7 @@ module ActionText
 
     private
       def node_attributes
-        @node_attributes ||= ATTRIBUTES.map { |name| [ name.underscore, node[name] ] }.to_h.compact
+        @node_attributes ||= ATTRIBUTES.to_h { |name| [ name.underscore, node[name] ] }.compact
       end
 
       def attachable_attributes

data/lib/action_text/attribute.rb

@@ -26,11 +26,15 @@ module ActionText
       #   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.
       #
-      #  === Options
+      # ==== Options
       #
-      #  * <tt>:encrypted</tt> - Pass true to encrypt the rich text attribute. The encryption will be non-deterministic. See
-      #  +ActiveRecord::Encryption::EncryptableRecord.encrypts+. Default: false.
-      def has_rich_text(name, encrypted: false)
+      # * <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).
+      def has_rich_text(name, encrypted: false, strict_loading: strict_loading_by_default)
         class_eval <<-CODE, __FILE__, __LINE__ + 1
           def #{name}
             rich_text_#{name} || build_rich_text_#{name}
@@ -47,7 +51,8 @@ module ActionText
 
         rich_text_class_name = encrypted ? "ActionText::EncryptedRichText" : "ActionText::RichText"
         has_one :"rich_text_#{name}", -> { where(name: name) },
-          class_name: rich_text_class_name, as: :record, inverse_of: :record, autosave: true, dependent: :destroy
+          class_name: rich_text_class_name, as: :record, inverse_of: :record, autosave: true, dependent: :destroy,
+          strict_loading: strict_loading
 
         scope :"with_rich_text_#{name}", -> { includes("rich_text_#{name}") }
         scope :"with_rich_text_#{name}_and_embeds", -> { includes("rich_text_#{name}": { embeds_attachments: :blob }) }

data/lib/action_text/content.rb

@@ -1,6 +1,24 @@
 # frozen_string_literal: true
 
 module ActionText
+  # = Action Text \Content
+  #
+  # 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.
+  #
+  # The ActionText::RichText record serializes the `body` attribute as
+  # +ActionText::Content+.
+  #
+  #   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!"
   class Content
     include Rendering, Serialization
 
@@ -26,10 +44,21 @@ module ActionText
       end
     end
 
+    # Extracts links from the HTML fragment:
+    #
+    #   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...
     def attachments
       @attachments ||= attachment_nodes.map do |node|
         attachment_for_node(node)
@@ -46,6 +75,12 @@ module ActionText
       @gallery_attachments ||= attachment_galleries.flat_map(&:attachments)
     end
 
+    # 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]
     def attachables
       @attachables ||= attachment_nodes.map do |node|
         ActionText::Attachable.from_node(node)
@@ -71,6 +106,10 @@ module ActionText
       self.class.new(content, canonicalize: false)
     end
 
+    # Returns the content as plain text with all HTML tags removed.
+    #
+    #   content = ActionText::Content.new("<h1>Funny times!</h1>")
+    #   content.to_plain_text # => "Funny times!"
     def to_plain_text
       render_attachments(with_full_attributes: false, &:to_plain_text).fragment.to_plain_text
     end
@@ -100,11 +139,13 @@ module ActionText
     end
 
     def inspect
-      "#<#{self.class.name} #{to_s.truncate(25).inspect}>"
+      "#<#{self.class.name} #{to_html.truncate(25).inspect}>"
     end
 
     def ==(other)
-      if other.is_a?(self.class)
+      if self.class == other.class
+        to_html == other.to_html
+      elsif other.is_a?(self.class)
         to_s == other.to_s
       end
     end

data/lib/action_text/deprecator.rb

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

data/lib/action_text/engine.rb

@@ -19,6 +19,10 @@ module ActionText
       #{root}/app/models
     )
 
+    initializer "action_text.deprecator", before: :load_environment_config do |app|
+      app.deprecators[:action_text] = ActionText.deprecator
+    end
+
     initializer "action_text.attribute" do
       ActiveSupport.on_load(:active_record) do
         include ActionText::Attribute
@@ -51,20 +55,16 @@ module ActionText
     end
 
     initializer "action_text.helper" do
-      %i[action_controller_base action_mailer].each do |abstract_controller|
-        ActiveSupport.on_load(abstract_controller) do
+      %i[action_controller_base action_mailer].each do |base|
+        ActiveSupport.on_load(base) do
           helper ActionText::Engine.helpers
         end
       end
     end
 
     initializer "action_text.renderer" do
-      ActiveSupport.on_load(:action_text_content) do
-        self.default_renderer = Class.new(ActionController::Base).renderer
-      end
-
-      %i[action_controller_base action_mailer].each do |abstract_controller|
-        ActiveSupport.on_load(abstract_controller) do
+      %i[action_controller_base action_mailer].each do |base|
+        ActiveSupport.on_load(base) do
           around_action do |controller, action|
             ActionText::Content.with_renderer(controller, &action)
           end
@@ -82,5 +82,11 @@ module ActionText
     initializer "action_text.configure" do |app|
       ActionText::Attachment.tag_name = app.config.action_text.attachment_tag_name
     end
+
+    config.after_initialize do |app|
+      if klass = app.config.action_text.sanitizer_vendor
+        ActionText::ContentHelper.sanitizer = klass.safe_list_sanitizer.new
+      end
+    end
   end
 end

data/lib/action_text/fixture_set.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module ActionText
+  # = Action Text \FixtureSet
+  #
   # Fixtures are a way of organizing data that you want to test against; in
   # short, sample data.
   #

data/lib/action_text/fragment.rb

@@ -7,7 +7,7 @@ module ActionText
         case fragment_or_html
         when self
           fragment_or_html
-        when Nokogiri::HTML::DocumentFragment
+        when Nokogiri::XML::DocumentFragment # base class for all fragments
           new(fragment_or_html)
         else
           from_html(fragment_or_html)
@@ -30,14 +30,15 @@ module ActionText
     end
 
     def update
-      yield source = self.source.clone
+      yield source = self.source.dup
       self.class.new(source)
     end
 
     def replace(selector)
       update do |source|
         source.css(selector).each do |node|
-          node.replace(yield(node).to_s)
+          replacement_node = yield(node)
+          node.replace(replacement_node.to_s) if node != replacement_node
         end
       end
     end

data/lib/action_text/gem_version.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
 module ActionText
-  # Returns the currently loaded version of Action Text as a <tt>Gem::Version</tt>.
+  # Returns the currently loaded version of Action Text as a +Gem::Version+.
   def self.gem_version
     Gem::Version.new VERSION::STRING
   end
 
   module VERSION
     MAJOR = 7
-    MINOR = 0
-    TINY  = 8
-    PRE   = "2"
+    MINOR = 1
+    TINY  = 0
+    PRE   = "beta1"
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

data/lib/action_text/html_conversion.rb

@@ -18,7 +18,7 @@ module ActionText
 
     private
       def document
-        Nokogiri::HTML::Document.new.tap { |doc| doc.encoding = "UTF-8" }
+        ActionText.html_document_class.new.tap { |doc| doc.encoding = "UTF-8" }
       end
   end
 end

data/lib/action_text/rendering.rb

@@ -8,12 +8,15 @@ module ActionText
     extend ActiveSupport::Concern
 
     included do
-      cattr_accessor :default_renderer, instance_accessor: false
       thread_cattr_accessor :renderer, instance_accessor: false
       delegate :render, to: :class
     end
 
     class_methods do
+      def action_controller_renderer
+        @action_controller_renderer ||= Class.new(ActionController::Base).renderer
+      end
+
       def with_renderer(renderer)
         previous_renderer = self.renderer
         self.renderer = renderer
@@ -23,7 +26,7 @@ module ActionText
       end
 
       def render(*args, &block)
-        (renderer || default_renderer).render_to_string(*args, &block)
+        (renderer || action_controller_renderer).render_to_string(*args, &block)
       end
     end
   end