actiontext 7.2.1.1 → 8.0.0.rc1

data/app/helpers/action_text/tag_helper.rb

@@ -24,10 +24,10 @@ module ActionText
     #
     # #### Example
     #
-    #     rich_text_area_tag "content", message.content
+    #     rich_textarea_tag "content", message.content
     #     # <input type="hidden" name="content" id="trix_input_post_1">
     #     # <trix-editor id="content" input="trix_input_post_1" class="trix-content" ...></trix-editor>
-    def rich_text_area_tag(name, value = nil, options = {})
+    def rich_textarea_tag(name, value = nil, options = {})
       options = options.symbolize_keys
       form = options.delete(:form)
 
@@ -43,6 +43,7 @@ module ActionText
 
       input_tag + editor_tag
     end
+    alias_method :rich_text_area_tag, :rich_textarea_tag
   end
 end
 
@@ -56,7 +57,7 @@ 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
-      html_tag = @template_object.rich_text_area_tag(options.delete("name"), options.fetch("value") { value }, options.except("value"))
+      html_tag = @template_object.rich_textarea_tag(options.delete("name"), options.fetch("value") { value }, options.except("value"))
       error_wrapping(html_tag)
     end
   end
@@ -76,28 +77,30 @@ module ActionView::Helpers
     #
     #
     # #### Example
-    #     rich_text_area :message, :content
+    #     rich_textarea :message, :content
     #     # <input type="hidden" name="message[content]" id="message_content_trix_input_message_1">
     #     # <trix-editor id="content" input="message_content_trix_input_message_1" class="trix-content" ...></trix-editor>
     #
-    #     rich_text_area :message, :content, value: "<h1>Default message</h1>"
+    #     rich_textarea :message, :content, value: "<h1>Default message</h1>"
     #     # <input type="hidden" name="message[content]" id="message_content_trix_input_message_1" value="<h1>Default message</h1>">
     #     # <trix-editor id="content" input="message_content_trix_input_message_1" class="trix-content" ...></trix-editor>
-    def rich_text_area(object_name, method, options = {})
+    def rich_textarea(object_name, method, options = {})
       Tags::ActionText.new(object_name, method, self, options).render
     end
+    alias_method :rich_text_area, :rich_textarea
   end
 
   class FormBuilder
-    # Wraps ActionView::Helpers::FormHelper#rich_text_area for form builders:
+    # Wraps ActionView::Helpers::FormHelper#rich_textarea for form builders:
     #
     #     <%= form_with model: @message do |f| %>
-    #       <%= f.rich_text_area :content %>
+    #       <%= f.rich_textarea :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))
+    def rich_textarea(method, options = {})
+      @template.rich_textarea(@object_name, method, objectify_options(options))
     end
+    alias_method :rich_text_area, :rich_textarea
   end
 end

data/app/javascript/actiontext/attachment_upload.js

@@ -1,4 +1,4 @@
-import { DirectUpload } from "@rails/activestorage"
+import { DirectUpload, dispatchEvent } from "@rails/activestorage"
 
 export class AttachmentUpload {
   constructor(attachment, element) {
@@ -9,24 +9,29 @@ export class AttachmentUpload {
 
   start() {
     this.directUpload.create(this.directUploadDidComplete.bind(this))
+    this.dispatch("start")
   }
 
   directUploadWillStoreFileWithXHR(xhr) {
     xhr.upload.addEventListener("progress", event => {
       const progress = event.loaded / event.total * 100
       this.attachment.setUploadProgress(progress)
+      if (progress) {
+        this.dispatch("progress", { progress: progress })
+      }
     })
   }
 
   directUploadDidComplete(error, attributes) {
     if (error) {
-      throw new Error(`Direct upload failed: ${error}`)
+      this.dispatchError(error)
+    } else {
+      this.attachment.setAttributes({
+        sgid: attributes.attachable_sgid,
+        url: this.createBlobUrl(attributes.signed_id, attributes.filename)
+      })
+      this.dispatch("end")
     }
-
-    this.attachment.setAttributes({
-      sgid: attributes.attachable_sgid,
-      url: this.createBlobUrl(attributes.signed_id, attributes.filename)
-    })
   }
 
   createBlobUrl(signedId, filename) {
@@ -35,6 +40,18 @@ export class AttachmentUpload {
       .replace(":filename", encodeURIComponent(filename))
   }
 
+  dispatch(name, detail = {}) {
+    detail.attachment = this.attachment
+    return dispatchEvent(this.element, `direct-upload:${name}`, { detail })
+  }
+
+  dispatchError(error) {
+    const event = this.dispatch("error", { error })
+    if (!event.defaultPrevented) {
+      alert(error);
+    }
+  }
+
   get directUploadUrl() {
     return this.element.dataset.directUploadUrl
   }

data/lib/action_text/attribute.rb

@@ -41,13 +41,16 @@ module ActionText
       #     `strict_loading:` will be set to the value of the
       #     `strict_loading_by_default` class attribute (false by default).
       #
+      # *   `:store_if_blank` - Pass false to not create RichText records with empty values,
+      #     if a blank value is provided. Default: true.
+      #
       #
       # 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)
+      def has_rich_text(name, encrypted: false, strict_loading: strict_loading_by_default, store_if_blank: true)
         class_eval <<-CODE, __FILE__, __LINE__ + 1
           def #{name}
             rich_text_#{name} || build_rich_text_#{name}
@@ -56,12 +59,29 @@ module ActionText
           def #{name}?
             rich_text_#{name}.present?
           end
-
-          def #{name}=(body)
-            self.#{name}.body = body
-          end
         CODE
 
+        if store_if_blank
+          class_eval <<-CODE, __FILE__, __LINE__ + 1
+            def #{name}=(body)
+              self.#{name}.body = body
+            end
+          CODE
+        else
+          class_eval <<-CODE, __FILE__, __LINE__ + 1
+            def #{name}=(body)
+              if body.present?
+                self.#{name}.body = body
+              else
+                if #{name}?
+                  self.#{name}.body = body
+                  self.#{name}.mark_for_destruction
+                end
+              end
+            end
+          CODE
+        end
+
         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,

data/lib/action_text/gem_version.rb

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

data/lib/action_text/plain_text_conversion.rb

@@ -65,12 +65,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/system_test_helper.rb

@@ -17,42 +17,45 @@ module ActionText
     # Examples:
     #
     #     # <trix-editor id="message_content" ...></trix-editor>
-    #     fill_in_rich_text_area "message_content", with: "Hello <em>world!</em>"
+    #     fill_in_rich_textarea "message_content", with: "Hello <em>world!</em>"
     #
     #     # <trix-editor placeholder="Your message here" ...></trix-editor>
-    #     fill_in_rich_text_area "Your message here", with: "Hello <em>world!</em>"
+    #     fill_in_rich_textarea "Your message here", with: "Hello <em>world!</em>"
     #
     #     # <label for="message_content">Message content</label>
     #     # <trix-editor id="message_content" ...></trix-editor>
-    #     fill_in_rich_text_area "Message content", with: "Hello <em>world!</em>"
+    #     fill_in_rich_textarea "Message content", with: "Hello <em>world!</em>"
     #
     #     # <trix-editor aria-label="Message content" ...></trix-editor>
-    #     fill_in_rich_text_area "Message content", with: "Hello <em>world!</em>"
+    #     fill_in_rich_textarea "Message content", with: "Hello <em>world!</em>"
     #
     #     # <input id="trix_input_1" name="message[content]" type="hidden">
     #     # <trix-editor input="trix_input_1"></trix-editor>
-    #     fill_in_rich_text_area "message[content]", with: "Hello <em>world!</em>"
-    def fill_in_rich_text_area(locator = nil, with:)
-      find(:rich_text_area, locator).execute_script("this.editor.loadHTML(arguments[0])", with.to_s)
+    #     fill_in_rich_textarea "message[content]", with: "Hello <em>world!</em>"
+    def fill_in_rich_textarea(locator = nil, with:)
+      find(:rich_textarea, locator).execute_script("this.editor.loadHTML(arguments[0])", with.to_s)
     end
+    alias_method :fill_in_rich_text_area, :fill_in_rich_textarea
   end
 end
 
-Capybara.add_selector :rich_text_area do
-  label "rich-text area"
-  xpath do |locator|
-    if locator.nil?
-      XPath.descendant(:"trix-editor")
-    else
-      input_located_by_name = XPath.anywhere(:input).where(XPath.attr(:name) == locator).attr(:id)
-      input_located_by_label = XPath.anywhere(:label).where(XPath.string.n.is(locator)).attr(:for)
+%i[rich_textarea rich_text_area].each do |rich_textarea|
+  Capybara.add_selector rich_textarea do
+    label "rich-text area"
+    xpath do |locator|
+      if locator.nil?
+        XPath.descendant(:"trix-editor")
+      else
+        input_located_by_name = XPath.anywhere(:input).where(XPath.attr(:name) == locator).attr(:id)
+        input_located_by_label = XPath.anywhere(:label).where(XPath.string.n.is(locator)).attr(:for)
 
-      XPath.descendant(:"trix-editor").where \
-        XPath.attr(:id).equals(locator) |
-        XPath.attr(:placeholder).equals(locator) |
-        XPath.attr(:"aria-label").equals(locator) |
-        XPath.attr(:input).equals(input_located_by_name) |
-        XPath.attr(:id).equals(input_located_by_label)
+        XPath.descendant(:"trix-editor").where \
+          XPath.attr(:id).equals(locator) |
+          XPath.attr(:placeholder).equals(locator) |
+          XPath.attr(:"aria-label").equals(locator) |
+          XPath.attr(:input).equals(input_located_by_name) |
+          XPath.attr(:id).equals(input_located_by_label)
+      end
     end
   end
 end

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

@@ -36,20 +36,8 @@ module ActionText
       end
 
       def create_actiontext_files
-        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",