actiontext 7.0.10 → 7.1.0.beta1

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  = 10
-    PRE   = nil
+    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/plain_text_conversion.rb

@@ -63,12 +63,7 @@ module ActionText
 
       def plain_text_for_blockquote_node(node, index)
         text = plain_text_for_block(node)
-        return "“”" if text.blank?
-
-        text = text.dup
-        text.insert(text.rindex(/\S/) + 1, "”")
-        text.insert(text.index(/\S/), "“")
-        text
+        text.sub(/\A(\s*)(.+?)(\s*)\Z/m, '\1“\2”\3')
       end
 
       def plain_text_for_li_node(node, index)

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

data/lib/action_text/trix_attachment.rb

@@ -39,10 +39,10 @@ module ActionText
         end
 
         def typecast_attribute_values(attributes)
-          attributes.map do |key, value|
+          attributes.to_h do |key, value|
             typecast = ATTRIBUTE_TYPES[key] || ATTRIBUTE_TYPES[:default]
             [key, typecast.call(value)]
-          end.to_h
+          end
         end
     end
 

data/lib/action_text/version.rb

@@ -3,7 +3,7 @@
 require_relative "gem_version"
 
 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.version
     gem_version
   end

data/lib/action_text.rb

@@ -3,8 +3,13 @@
 require "active_support"
 require "active_support/rails"
 
+require "action_text/version"
+require "action_text/deprecator"
+
 require "nokogiri"
 
+# :markup: markdown
+# :include: actiontext/README.md
 module ActionText
   extend ActiveSupport::Autoload
 
@@ -37,4 +42,18 @@ module ActionText
     autoload :Minification
     autoload :TrixConversion
   end
+
+  class << self
+    def html_document_class
+      return @html_document_class if defined?(@html_document_class)
+      @html_document_class =
+        defined?(Nokogiri::HTML5) ? Nokogiri::HTML5::Document : Nokogiri::HTML4::Document
+    end
+
+    def html_document_fragment_class
+      return @html_document_fragment_class if defined?(@html_document_fragment_class)
+      @html_document_fragment_class =
+        defined?(Nokogiri::HTML5) ? Nokogiri::HTML5::DocumentFragment : Nokogiri::HTML4::DocumentFragment
+    end
+  end
 end

data/lib/generators/action_text/install/install_generator.rb

@@ -9,8 +9,10 @@ module ActionText
       source_root File.expand_path("templates", __dir__)
 
       def install_javascript_dependencies
-        if Pathname(destination_root).join("package.json").exist?
-          say "Installing JavaScript dependencies", :green
+        say "Installing JavaScript dependencies", :green
+        if using_bun?
+          run "bun add @rails/actiontext trix"
+        elsif using_node?
           run "yarn add @rails/actiontext trix"
         end
       end
@@ -19,7 +21,7 @@ module ActionText
         destination = Pathname(destination_root)
 
         if (application_javascript_path = destination.join("app/javascript/application.js")).exist?
-          insert_into_file application_javascript_path.to_s, %(import "trix"\nimport "@rails/actiontext"\n)
+          insert_into_file application_javascript_path.to_s, %(\nimport "trix"\nimport "@rails/actiontext"\n)
         else
           say <<~INSTRUCTIONS, :green
             You must import the @rails/actiontext and trix JavaScript modules in your application entrypoint.
@@ -66,6 +68,21 @@ module ActionText
         rails_command "railties:install:migrations FROM=active_storage,action_text", inline: true
       end
 
+      def using_js_runtime?
+        @using_js_runtime ||= Pathname(destination_root).join("package.json").exist?
+      end
+
+      def using_bun?
+        # Cannot assume yarn.lock has been generated yet so we look for
+        # a file known to be generated by the jsbundling-rails gem
+        @using_bun ||= using_js_runtime? && Pathname(destination_root).join("bun.config.js").exist?
+      end
+
+      def using_node?
+        # Bun is the only runtime that _isn't_ node.
+        @using_node ||= using_js_runtime? && !Pathname(destination_root).join("bun.config.js").exist?
+      end
+
       hook_for :test_framework
     end
   end

data/lib/generators/action_text/install/templates/actiontext.css

@@ -3,11 +3,7 @@
  * the trix-editor content (whether displayed or under editing). Feel free to incorporate this
  * inclusion directly in any other asset bundle and remove this file.
  *
-<%- if defined?(Webpacker::Engine) -%>
- *= require trix/dist/trix
-<%- else -%>
  *= require trix
-<% end -%>
 */
 
 /*

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rails/actiontext",
-  "version": "7.0.1000",
+  "version": "7.1.0-beta1",
   "description": "Edit and display rich text in Rails applications",
   "main": "app/assets/javascripts/actiontext.js",
   "type": "module",
@@ -15,23 +15,24 @@
   "bugs": {
     "url": "https://github.com/rails/rails/issues"
   },
-  "author": "Basecamp, LLC",
+  "author": "37signals LLC",
   "contributors": [
     "Javan Makhmali <javan@javan.us>",
     "Sam Stephenson <sstephenson@gmail.com>"
   ],
   "license": "MIT",
   "dependencies": {
-    "@rails/activestorage": ">= 7.0.0-alpha1"
+    "@rails/activestorage": ">= 7.1.0-alpha",
+    "webpack": "^4.17.1"
   },
   "peerDependencies": {
-    "trix": "^1.3.1"
+    "trix": "^2.0.0"
   },
   "devDependencies": {
-    "@rollup/plugin-node-resolve": "^11.0.1",
     "@rollup/plugin-commonjs": "^19.0.1",
+    "@rollup/plugin-node-resolve": "^11.0.1",
     "rollup": "^2.35.1",
-    "trix": "^1.3.1"
+    "trix": "^2.0.0"
   },
   "scripts": {
     "build": "rollup --config rollup.config.js"

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: actiontext
 version: !ruby/object:Gem::Version
-  version: 7.0.10
+  version: 7.1.0.beta1
 platform: ruby
 authors:
 - Javan Makhmali
 - Sam Stephenson
 - David Heinemeier Hansson
+autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2023-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,56 +18,56 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.0.10
+        version: 7.1.0.beta1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.0.10
+        version: 7.1.0.beta1
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.0.10
+        version: 7.1.0.beta1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.0.10
+        version: 7.1.0.beta1
 - !ruby/object:Gem::Dependency
   name: activestorage
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.0.10
+        version: 7.1.0.beta1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.0.10
+        version: 7.1.0.beta1
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.0.10
+        version: 7.1.0.beta1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.0.10
+        version: 7.1.0.beta1
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -117,6 +118,7 @@ files:
 - app/models/action_text/encrypted_rich_text.rb
 - app/models/action_text/record.rb
 - app/models/action_text/rich_text.rb
+- app/views/action_text/attachables/_content_attachment.html.erb
 - app/views/action_text/attachables/_missing_attachable.html.erb
 - app/views/action_text/attachables/_remote_image.html.erb
 - app/views/action_text/attachment_galleries/_attachment_gallery.html.erb
@@ -136,6 +138,7 @@ files:
 - lib/action_text/attachments/trix_conversion.rb
 - lib/action_text/attribute.rb
 - lib/action_text/content.rb
+- lib/action_text/deprecator.rb
 - lib/action_text/encryption.rb
 - lib/action_text/engine.rb
 - lib/action_text/fixture_set.rb
@@ -159,11 +162,12 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rails/rails/issues
-  changelog_uri: https://github.com/rails/rails/blob/v7.0.10/actiontext/CHANGELOG.md
-  documentation_uri: https://api.rubyonrails.org/v7.0.10/
+  changelog_uri: https://github.com/rails/rails/blob/v7.1.0.beta1/actiontext/CHANGELOG.md
+  documentation_uri: https://api.rubyonrails.org/v7.1.0.beta1/
   mailing_list_uri: https://discuss.rubyonrails.org/c/rubyonrails-talk
-  source_code_uri: https://github.com/rails/rails/tree/v7.0.10/actiontext
+  source_code_uri: https://github.com/rails/rails/tree/v7.1.0.beta1/actiontext
   rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -174,11 +178,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.4.18
+signing_key:
 specification_version: 4
 summary: Rich text framework.
 test_files: []