actiontext 6.1.4.1 → 7.0.0.alpha1

data/app/models/action_text/encrypted_rich_text.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ActionText
+  class EncryptedRichText < RichText
+    self.table_name = "action_text_rich_texts"
+
+    encrypts :body
+  end
+end

data/app/models/action_text/record.rb

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

data/app/models/action_text/rich_text.rb

@@ -22,6 +22,10 @@ module ActionText
       body&.to_plain_text.to_s
     end
 
+    def to_trix_html
+      body&.to_trix_html
+    end
+
     delegate :blank?, :empty?, :present?, to: :to_plain_text
   end
 end

data/app/views/action_text/contents/_content.html.erb

@@ -0,0 +1 @@
+<%= render_action_text_content(content) %>

data/app/views/layouts/action_text/contents/_content.html.erb

@@ -0,0 +1,3 @@
+<div class="trix-content">
+  <%= yield -%>
+</div>

data/db/migrate/20180528164100_create_action_text_tables.rb

@@ -1,13 +1,25 @@
 class CreateActionTextTables < ActiveRecord::Migration[6.0]
   def change
-    create_table :action_text_rich_texts do |t|
+    # Use Active Record's configured type for primary and foreign keys
+    primary_key_type, foreign_key_type = primary_and_foreign_key_types
+
+    create_table :action_text_rich_texts, id: primary_key_type do |t|
       t.string     :name, null: false
       t.text       :body, size: :long
-      t.references :record, null: false, polymorphic: true, index: false
+      t.references :record, null: false, polymorphic: true, index: false, type: foreign_key_type
 
       t.timestamps
 
       t.index [ :record_type, :record_id, :name ], name: "index_action_text_rich_texts_uniqueness", unique: true
     end
   end
+
+  private
+    def primary_and_foreign_key_types
+      config = Rails.configuration.generators
+      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]
+    end
 end

data/lib/action_text/attachable.rb

@@ -71,6 +71,10 @@ module ActionText
       to_partial_path
     end
 
+    def to_attachable_partial_path
+      to_partial_path
+    end
+
     def to_rich_text_attributes(attributes = {})
       attributes.dup.tap do |attrs|
         attrs[:sgid] = attachable_sgid

data/lib/action_text/attachment.rb

@@ -6,8 +6,8 @@ module ActionText
   class Attachment
     include Attachments::TrixConversion, Attachments::Minification, Attachments::Caching
 
-    TAG_NAME = "action-text-attachment"
-    SELECTOR = TAG_NAME
+    mattr_accessor :tag_name, default: "action-text-attachment"
+
     ATTRIBUTES = %w( sgid content-type url href filename filesize width height previewable presentation caption )
 
     class << self
@@ -20,7 +20,7 @@ module ActionText
       end
 
       def from_attachables(attachables)
-        Array(attachables).map { |attachable| from_attachable(attachable) }.compact
+        Array(attachables).filter_map { |attachable| from_attachable(attachable) }
       end
 
       def from_attachable(attachable, attributes = {})
@@ -38,7 +38,7 @@ module ActionText
       private
         def node_from_attributes(attributes)
           if attributes = process_attributes(attributes).presence
-            ActionText::HtmlConversion.create_element(TAG_NAME, attributes)
+            ActionText::HtmlConversion.create_element(tag_name, attributes)
           end
         end
 

data/lib/action_text/attachment_gallery.rb

@@ -4,6 +4,9 @@ module ActionText
   class AttachmentGallery
     include ActiveModel::Model
 
+    TAG_NAME = "div"
+    private_constant :TAG_NAME
+
     class << self
       def fragment_by_canonicalizing_attachment_galleries(content)
         fragment_by_replacing_attachment_gallery_nodes(content) do |node|
@@ -20,12 +23,12 @@ module ActionText
       end
 
       def find_attachment_gallery_nodes(content)
-        Fragment.wrap(content).find_all(SELECTOR).select do |node|
+        Fragment.wrap(content).find_all(selector).select do |node|
           node.children.all? do |child|
             if child.text?
               /\A(\n|\ )*\z/.match?(child.text)
             else
-              child.matches? ATTACHMENT_SELECTOR
+              child.matches? attachment_selector
             end
           end
         end
@@ -34,6 +37,14 @@ module ActionText
       def from_node(node)
         new(node)
       end
+
+      def attachment_selector
+        "#{ActionText::Attachment.tag_name}[presentation=gallery]"
+      end
+
+      def selector
+        "#{TAG_NAME}:has(#{attachment_selector} + #{attachment_selector})"
+      end
     end
 
     attr_reader :node
@@ -43,7 +54,7 @@ module ActionText
     end
 
     def attachments
-      @attachments ||= node.css(ATTACHMENT_SELECTOR).map do |node|
+      @attachments ||= node.css(ActionText::AttachmentGallery.attachment_selector).map do |node|
         ActionText::Attachment.from_node(node).with_full_attributes
       end
     end
@@ -55,11 +66,5 @@ module ActionText
     def inspect
       "#<#{self.class.name} size=#{size.inspect}>"
     end
-
-    TAG_NAME = "div"
-    ATTACHMENT_SELECTOR = "#{ActionText::Attachment::SELECTOR}[presentation=gallery]"
-    SELECTOR = "#{TAG_NAME}:has(#{ATTACHMENT_SELECTOR} + #{ATTACHMENT_SELECTOR})"
-
-    private_constant :TAG_NAME, :ATTACHMENT_SELECTOR, :SELECTOR
   end
 end

data/lib/action_text/attachments/caching.rb

@@ -9,7 +9,7 @@ module ActionText
 
       private
         def cache_digest
-          Digest::SHA256.hexdigest(node.to_s)
+          OpenSSL::Digest::SHA256.hexdigest(node.to_s)
         end
     end
   end

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,56 @@
 # 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 therefore can be populated by
+  # fixtures.
+  #
+  # Consider a hypothetical <tt>Article</tt> model class, its related fixture
+  # data, as well as fixture data for related ActionText::RichText records:
+  #
+  #   # app/models/article.rb
+  #   class Article < ApplicationRecord
+  #     has_rich_text :content
+  #   end
+  #
+  #   # tests/fixtures/articles.yml
+  #   first:
+  #     title: An Article
+  #
+  #   # tests/fixtures/action_text/rich_texts.yml
+  #   first_content:
+  #     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> record that mentions the
+    # first as part of its <tt>content</tt> HTML:
+    #
+    #   # tests/fixtures/articles.yml
+    #   second:
+    #     title: Another Article
+    #
+    #   # tests/fixtures/action_text/rich_texts.yml
+    #   second_content:
+    #     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   = "1"
+    MAJOR = 7
+    MINOR = 0
+    TINY  = 0
+    PRE   = "alpha1"
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   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/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,45 @@ 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"
+        template "actiontext.css", "app/assets/stylesheets/actiontext.css"
+
+        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 +55,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