actiontext 6.1.4 → 7.0.0.rc1

data/lib/action_text/attachments/minification.rb

@@ -7,7 +7,7 @@ module ActionText
 
       class_methods do
         def fragment_by_minifying_attachments(content)
-          Fragment.wrap(content).replace(ActionText::Attachment::SELECTOR) do |node|
+          Fragment.wrap(content).replace(ActionText::Attachment.tag_name) do |node|
             node.tap { |n| n.inner_html = "" }
           end
         end

data/lib/action_text/attribute.rb

@@ -24,7 +24,13 @@ module ActionText
       #
       #   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.
-      def has_rich_text(name)
+      #   Message.all.with_all_rich_text # Loads all rich text associations.
+      #
+      #  === 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)
         class_eval <<-CODE, __FILE__, __LINE__ + 1
           def #{name}
             rich_text_#{name} || build_rich_text_#{name}
@@ -39,12 +45,22 @@ module ActionText
           end
         CODE
 
+        rich_text_class_name = encrypted ? "ActionText::EncryptedRichText" : "ActionText::RichText"
         has_one :"rich_text_#{name}", -> { where(name: name) },
-          class_name: "ActionText::RichText", as: :record, inverse_of: :record, autosave: true, dependent: :destroy
+          class_name: rich_text_class_name, as: :record, inverse_of: :record, autosave: true, dependent: :destroy
 
         scope :"with_rich_text_#{name}", -> { includes("rich_text_#{name}") }
         scope :"with_rich_text_#{name}_and_embeds", -> { includes("rich_text_#{name}": { embeds_attachments: :blob }) }
       end
+
+      # Eager load all dependent RichText models in bulk.
+      def with_all_rich_text
+        eager_load(rich_text_association_names)
+      end
+
+      def rich_text_association_names
+        reflect_on_all_associations(:has_one).collect(&:name).select { |n| n.start_with?("rich_text_") }
+      end
     end
   end
 end

data/lib/action_text/content.rb

@@ -58,7 +58,7 @@ module ActionText
     end
 
     def render_attachments(**options, &block)
-      content = fragment.replace(ActionText::Attachment::SELECTOR) do |node|
+      content = fragment.replace(ActionText::Attachment.tag_name) do |node|
         block.call(attachment_for_node(node, **options))
       end
       self.class.new(content, canonicalize: false)
@@ -84,7 +84,11 @@ module ActionText
     end
 
     def to_rendered_html_with_layout
-      render partial: "action_text/content/layout", formats: :html, locals: { content: self }
+      render layout: "action_text/contents/content", partial: to_partial_path, formats: :html, locals: { content: self }
+    end
+
+    def to_partial_path
+      "action_text/contents/content"
     end
 
     def to_s
@@ -107,7 +111,7 @@ module ActionText
 
     private
       def attachment_nodes
-        @attachment_nodes ||= fragment.find_all(ActionText::Attachment::SELECTOR)
+        @attachment_nodes ||= fragment.find_all(ActionText::Attachment.tag_name)
       end
 
       def attachment_gallery_nodes

data/lib/action_text/encryption.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ActionText
+  module Encryption
+    def encrypt
+      transaction do
+        super
+        encrypt_rich_texts if has_encrypted_rich_texts?
+      end
+    end
+
+    def decrypt
+      transaction do
+        super
+        decrypt_rich_texts if has_encrypted_rich_texts?
+      end
+    end
+
+    private
+      def encrypt_rich_texts
+        encryptable_rich_texts.each(&:encrypt)
+      end
+
+      def decrypt_rich_texts
+        encryptable_rich_texts.each(&:decrypt)
+      end
+
+      def has_encrypted_rich_texts?
+        encryptable_rich_texts.present?
+      end
+
+      def encryptable_rich_texts
+        @encryptable_rich_texts ||= self.class.rich_text_association_names
+          .filter_map { |attribute_name| send(attribute_name) }
+          .find_all { |record| record.is_a?(ActionText::EncryptedRichText) }
+      end
+  end
+end

data/lib/action_text/engine.rb

@@ -11,6 +11,9 @@ module ActionText
   class Engine < Rails::Engine
     isolate_namespace ActionText
     config.eager_load_namespaces << ActionText
+
+    config.action_text = ActiveSupport::OrderedOptions.new
+    config.action_text.attachment_tag_name = "action-text-attachment"
     config.autoload_once_paths = %W(
       #{root}/app/helpers
       #{root}/app/models
@@ -19,6 +22,13 @@ module ActionText
     initializer "action_text.attribute" do
       ActiveSupport.on_load(:active_record) do
         include ActionText::Attribute
+        prepend ActionText::Encryption
+      end
+    end
+
+    initializer "action_text.asset" do
+      if Rails.application.config.respond_to?(:assets)
+        Rails.application.config.assets.precompile += %w( actiontext.js trix.js trix.css )
       end
     end
 
@@ -68,5 +78,9 @@ module ActionText
         include ActionText::SystemTestHelper
       end
     end
+
+    initializer "action_text.configure" do |app|
+      ActionText::Attachment.tag_name = app.config.action_text.attachment_tag_name
+    end
   end
 end

data/lib/action_text/fixture_set.rb

@@ -1,7 +1,62 @@
 # frozen_string_literal: true
 
 module ActionText
+  # Fixtures are a way of organizing data that you want to test against; in
+  # short, sample data.
+  #
+  # To learn more about fixtures, read the
+  # {ActiveRecord::FixtureSet}[rdoc-ref:ActiveRecord::FixtureSet] documentation.
+  #
+  # === YAML
+  #
+  # Like other Active Record-backed models, ActionText::RichText records inherit
+  # from ActiveRecord::Base instances and can therefore be populated by
+  # fixtures.
+  #
+  # Consider an <tt>Article</tt> class:
+  #
+  #   class Article < ApplicationRecord
+  #     has_rich_text :content
+  #   end
+  #
+  # To declare fixture data for the related <tt>content</tt>, first declare fixture
+  # data for <tt>Article</tt> instances in <tt>test/fixtures/articles.yml</tt>:
+  #
+  #   first:
+  #     title: An Article
+  #
+  # Then declare the <tt>ActionText::RichText</tt> fixture data in
+  # <tt>test/fixtures/action_text/rich_texts.yml</tt>, making sure to declare
+  # each entry's <tt>record:</tt> key as a polymorphic relationship:
+  #
+  #   first:
+  #     record: first (Article)
+  #     name: content
+  #     body: <div>Hello, world.</div>
+  #
+  # When processed, Active Record will insert database records for each fixture
+  # entry and will ensure the Action Text relationship is intact.
   class FixtureSet
+    # Fixtures support Action Text attachments as part of their <tt>body</tt>
+    # HTML.
+    #
+    # === Examples
+    #
+    # For example, consider a second <tt>Article</tt> fixture declared in
+    # <tt>test/fixtures/articles.yml</tt>:
+    #
+    #   second:
+    #     title: Another Article
+    #
+    # You can attach a mention of <tt>articles(:first)</tt> to <tt>second</tt>'s
+    # <tt>content</tt> by embedding a call to <tt>ActionText::FixtureSet.attachment</tt>
+    # in the <tt>body:</tt> value in <tt>test/fixtures/action_text/rich_texts.yml</tt>:
+    #
+    #   second:
+    #     record: second (Article)
+    #     name: content
+    #     body: <div>Hello, <%= ActionText::FixtureSet.attachment("articles", :first) %></div>
+    #
     def self.attachment(fixture_set_name, label, column_type: :integer)
       signed_global_id = ActiveRecord::FixtureSet.signed_global_id fixture_set_name, label,
         column_type: column_type, for: ActionText::Attachable::LOCATOR_NAME

data/lib/action_text/gem_version.rb

@@ -7,10 +7,10 @@ module ActionText
   end
 
   module VERSION
-    MAJOR = 6
-    MINOR = 1
-    TINY  = 4
-    PRE   = nil
+    MAJOR = 7
+    MINOR = 0
+    TINY  = 0
+    PRE   = "rc1"
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

data/lib/action_text/plain_text_conversion.rb

@@ -33,10 +33,18 @@ module ActionText
         "#{remove_trailing_newlines(plain_text_for_node_children(node))}\n\n"
       end
 
-      %i[ h1 p ul ol ].each do |element|
+      %i[ h1 p ].each do |element|
         alias_method :"plain_text_for_#{element}_node", :plain_text_for_block
       end
 
+      def plain_text_for_list(node, index)
+        "#{break_if_nested_list(node, plain_text_for_block(node))}"
+      end
+
+      %i[ ul ol ].each do |element|
+        alias_method :"plain_text_for_#{element}_node", :plain_text_for_list
+      end
+
       def plain_text_for_br_node(node, index)
         "\n"
       end
@@ -61,7 +69,9 @@ module ActionText
       def plain_text_for_li_node(node, index)
         bullet = bullet_for_li_node(node, index)
         text = remove_trailing_newlines(plain_text_for_node_children(node))
-        "#{bullet} #{text}\n"
+        indentation = indentation_for_li_node(node)
+
+        "#{indentation}#{bullet} #{text}\n"
       end
 
       def remove_trailing_newlines(text)
@@ -79,5 +89,24 @@ module ActionText
       def list_node_name_for_li_node(node)
         node.ancestors.lazy.map(&:name).grep(/^[uo]l$/).first
       end
+
+      def indentation_for_li_node(node)
+        depth = list_node_depth_for_node(node)
+        if depth > 1
+          "  " * (depth - 1)
+        end
+      end
+
+      def list_node_depth_for_node(node)
+        node.ancestors.map(&:name).grep(/^[uo]l$/).count
+      end
+
+      def break_if_nested_list(node, text)
+        if list_node_depth_for_node(node) > 0
+          "\n#{text}"
+        else
+          text
+        end
+      end
   end
 end

data/lib/action_text/rendering.rb

@@ -4,7 +4,7 @@ require "active_support/concern"
 require "active_support/core_ext/module/attribute_accessors_per_thread"
 
 module ActionText
-  module Rendering #:nodoc:
+  module Rendering # :nodoc:
     extend ActiveSupport::Concern
 
     included do

data/lib/action_text/serialization.rb

@@ -15,6 +15,8 @@ module ActionText
           nil
         when self
           content.to_html
+        when ActionText::RichText
+          content.body.to_html
         else
           new(content).to_html
         end

data/lib/action_text/trix_attachment.rb

@@ -9,9 +9,9 @@ module ActionText
     ATTRIBUTES = %w( sgid contentType url href filename filesize width height previewable content ) + COMPOSED_ATTRIBUTES
     ATTRIBUTE_TYPES = {
       "previewable" => ->(value) { value.to_s == "true" },
-      "filesize"    => ->(value) { Integer(value.to_s) rescue value },
-      "width"       => ->(value) { Integer(value.to_s) rescue nil },
-      "height"      => ->(value) { Integer(value.to_s) rescue nil },
+      "filesize"    => ->(value) { Integer(value.to_s, exception: false) || value },
+      "width"       => ->(value) { Integer(value.to_s, exception: false) },
+      "height"      => ->(value) { Integer(value.to_s, exception: false) },
       :default      => ->(value) { value.to_s }
     }
 

data/lib/action_text.rb

@@ -13,6 +13,7 @@ module ActionText
   autoload :Attachment
   autoload :Attribute
   autoload :Content
+  autoload :Encryption
   autoload :Fragment
   autoload :FixtureSet
   autoload :HtmlConversion

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

@@ -9,43 +9,57 @@ module ActionText
       source_root File.expand_path("templates", __dir__)
 
       def install_javascript_dependencies
-        rails_command "app:binstub:yarn", inline: true
-
-        say "Installing JavaScript dependencies", :green
-        run "#{Thor::Util.ruby_command} bin/yarn add #{js_dependencies.map { |name, version| "#{name}@#{version}" }.join(" ")}",
-          abort_on_failure: true, capture: true
+        if Pathname(destination_root).join("package.json").exist?
+          say "Installing JavaScript dependencies", :green
+          run "yarn add @rails/actiontext trix"
+        end
       end
 
-      def append_dependencies_to_package_file
-        if (app_javascript_pack_path = Pathname.new("app/javascript/packs/application.js")).exist?
-          js_dependencies.each_key do |dependency|
-            line = %[require("#{dependency}")]
+      def append_javascript_dependencies
+        destination = Pathname(destination_root)
 
-            unless app_javascript_pack_path.read.include? line
-              say "Adding #{dependency} to #{app_javascript_pack_path}", :green
-              append_to_file app_javascript_pack_path, "\n#{line}"
-            end
-          end
+        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)
         else
-          say <<~WARNING, :red
-            WARNING: Action Text can't locate your JavaScript bundle to add its package dependencies.
-
-            Add these lines to any bundles:
-
-            require("trix")
-            require("@rails/actiontext")
+          say <<~INSTRUCTIONS, :green
+            You must import the @rails/actiontext and trix JavaScript modules in your application entrypoint.
+          INSTRUCTIONS
+        end
 
-            Alternatively, install and setup the webpacker gem then rerun `bin/rails action_text:install`
-            to have these dependencies added automatically.
-          WARNING
+        if (importmap_path = destination.join("config/importmap.rb")).exist?
+          append_to_file importmap_path.to_s, %(pin "trix"\npin "@rails/actiontext", to: "actiontext.js"\n)
         end
       end
 
       def create_actiontext_files
-        template "actiontext.scss", "app/assets/stylesheets/actiontext.scss"
+        destination = Pathname(destination_root)
+
+        template "actiontext.css", "app/assets/stylesheets/actiontext.css"
+
+        unless destination.join("app/assets/application.css").exist?
+          if (stylesheets = Dir.glob "#{destination_root}/app/assets/stylesheets/application.*.{scss,css}").length > 0
+            insert_into_file stylesheets.first.to_s, %(@import 'actiontext.css';)
+          else
+            say <<~INSTRUCTIONS, :green
+              To use the Trix editor, you must require 'app/assets/stylesheets/actiontext.css' in your base stylesheet.
+            INSTRUCTIONS
+          end
+        end
+
+        gem_root = "#{__dir__}/../../../.."
 
-        copy_file "#{GEM_ROOT}/app/views/active_storage/blobs/_blob.html.erb",
+        copy_file "#{gem_root}/app/views/active_storage/blobs/_blob.html.erb",
           "app/views/active_storage/blobs/_blob.html.erb"
+
+        copy_file "#{gem_root}/app/views/layouts/action_text/contents/_content.html.erb",
+          "app/views/layouts/action_text/contents/_content.html.erb"
+      end
+
+      def enable_image_processing_gem
+        if (gemfile_path = Pathname(destination_root).join("Gemfile")).exist?
+          say "Ensure image_processing gem has been enabled so image uploads will work (remember to bundle!)"
+          uncomment_lines gemfile_path, /gem "image_processing"/
+        end
       end
 
       def create_migrations
@@ -53,15 +67,6 @@ module ActionText
       end
 
       hook_for :test_framework
-
-      private
-        GEM_ROOT = "#{__dir__}/../../../.."
-
-        def js_dependencies
-          js_package = JSON.load(Pathname.new("#{GEM_ROOT}/package.json"))
-          js_package["peerDependencies"].merge \
-            js_package["name"] => "^#{js_package["version"]}"
-        end
     end
   end
 end

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

@@ -0,0 +1,35 @@
+/*
+ * Provides a drop-in pointer for the default Trix stylesheet that will format the toolbar and
+ * 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 -%>
+*/
+
+/*
+ * We need to override trix.css’s image gallery styles to accommodate the
+ * <action-text-attachment> element we wrap around attachments. Otherwise,
+ * images in galleries will be squished by the max-width: 33%; rule.
+*/
+.trix-content .attachment-gallery > action-text-attachment,
+.trix-content .attachment-gallery > .attachment {
+  flex: 1 0 33%;
+  padding: 0 0.5em;
+  max-width: 33%;
+}
+
+.trix-content .attachment-gallery.attachment-gallery--2 > action-text-attachment,
+.trix-content .attachment-gallery.attachment-gallery--2 > .attachment, .trix-content .attachment-gallery.attachment-gallery--4 > action-text-attachment,
+.trix-content .attachment-gallery.attachment-gallery--4 > .attachment {
+  flex-basis: 50%;
+  max-width: 50%;
+}
+
+.trix-content action-text-attachment .attachment {
+  padding: 0 !important;
+  max-width: 100% !important;
+}

data/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@rails/actiontext",
-  "version": "6.1.4",
+  "version": "7.0.0-rc1",
   "description": "Edit and display rich text in Rails applications",
   "main": "app/javascript/actiontext/index.js",
+  "type": "module",
   "files": [
     "app/javascript/actiontext/*.js"
   ],
@@ -21,9 +22,18 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "@rails/activestorage": "^6.0.0"
+    "@rails/activestorage": ">= 7.0.0-alpha1"
   },
   "peerDependencies": {
-    "trix": "^1.2.0"
+    "trix": "^1.3.1"
+  },
+  "devDependencies": {
+    "@rollup/plugin-node-resolve": "^11.0.1",
+    "@rollup/plugin-commonjs": "^19.0.1",
+    "rollup": "^2.35.1",
+    "trix": "^1.3.1"
+  },
+  "scripts": {
+    "build": "rollup --config rollup.config.js"
   }
 }