actiontext 7.1.5.2 → 8.1.2.1

data/lib/action_text/plain_text_conversion.rb

@@ -1,68 +1,76 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionText
   module PlainTextConversion
     extend self
 
     def node_to_plain_text(node)
-      remove_trailing_newlines(plain_text_for_node(node))
+      BottomUpReducer.new(node).reduce do |n, child_values|
+        plain_text_for_node(n, child_values)
+      end.then(&method(:remove_trailing_newlines))
     end
 
     private
-      def plain_text_for_node(node, index = 0)
+      def plain_text_for_node(node, child_values)
         if respond_to?(plain_text_method_for_node(node), true)
-          send(plain_text_method_for_node(node), node, index)
+          send(plain_text_method_for_node(node), node, child_values)
         else
-          plain_text_for_node_children(node)
+          plain_text_for_child_values(child_values)
         end
       end
 
-      def plain_text_for_node_children(node)
-        texts = []
-        node.children.each_with_index do |child, index|
-          texts << plain_text_for_node(child, index)
-        end
-        texts.join
-      end
-
       def plain_text_method_for_node(node)
         :"plain_text_for_#{node.name}_node"
       end
 
-      def plain_text_for_block(node, index = 0)
-        "#{remove_trailing_newlines(plain_text_for_node_children(node))}\n\n"
+      def plain_text_for_child_values(child_values)
+        child_values.join
+      end
+
+      def plain_text_for_unsupported_node(node, _child_values)
+        ""
+      end
+
+      %i[ script style].each do |element|
+        alias_method :"plain_text_for_#{element}_node", :plain_text_for_unsupported_node
+      end
+
+      def plain_text_for_block(node, child_values)
+        "#{remove_trailing_newlines(plain_text_for_child_values(child_values))}\n\n"
       end
 
       %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))}"
+      def plain_text_for_list(node, child_values)
+        "#{break_if_nested_list(node, plain_text_for_block(node, child_values))}"
       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)
+      def plain_text_for_br_node(node, _child_values)
         "\n"
       end
 
-      def plain_text_for_text_node(node, index)
+      def plain_text_for_text_node(node, _child_values)
         remove_trailing_newlines(node.text)
       end
 
-      def plain_text_for_div_node(node, index)
-        "#{remove_trailing_newlines(plain_text_for_node_children(node))}\n"
+      def plain_text_for_div_node(node, child_values)
+        "#{remove_trailing_newlines(plain_text_for_child_values(child_values))}\n"
       end
 
-      def plain_text_for_figcaption_node(node, index)
-        "[#{remove_trailing_newlines(plain_text_for_node_children(node))}]"
+      def plain_text_for_figcaption_node(node, child_values)
+        "[#{remove_trailing_newlines(plain_text_for_child_values(child_values))}]"
       end
 
-      def plain_text_for_blockquote_node(node, index)
-        text = plain_text_for_block(node)
+      def plain_text_for_blockquote_node(node, child_values)
+        text = plain_text_for_block(node, child_values)
         return "“”" if text.blank?
 
         text = text.dup
@@ -71,9 +79,9 @@ module ActionText
         text
       end
 
-      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))
+      def plain_text_for_li_node(node, child_values)
+        bullet = bullet_for_li_node(node)
+        text = remove_trailing_newlines(plain_text_for_child_values(child_values))
         indentation = indentation_for_li_node(node)
 
         "#{indentation}#{bullet} #{text}\n"
@@ -83,8 +91,9 @@ module ActionText
         text.chomp("")
       end
 
-      def bullet_for_li_node(node, index)
+      def bullet_for_li_node(node)
         if list_node_name_for_li_node(node) == "ol"
+          index = node.parent.elements.index(node)
           "#{index + 1}."
         else
           "•"
@@ -113,5 +122,33 @@ module ActionText
           text
         end
       end
+
+      class BottomUpReducer # :nodoc:
+        def initialize(node)
+          @node = node
+          @values = {}
+        end
+
+        def reduce(&block)
+          traverse_bottom_up(@node) do |n|
+            child_values = @values.values_at(*n.children)
+            @values[n] = block.call(n, child_values)
+          end
+          @values[@node]
+        end
+
+        private
+          def traverse_bottom_up(node, &block)
+            call_stack, processing_stack = [ node ], []
+
+            until call_stack.empty?
+              node = call_stack.pop
+              processing_stack.push(node)
+              call_stack.concat node.children
+            end
+
+            processing_stack.reverse_each(&block)
+          end
+      end
   end
 end

data/lib/action_text/rendering.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require "active_support/concern"
+# :markup: markdown
+
 require "active_support/core_ext/module/attribute_accessors_per_thread"
 
 module ActionText

data/lib/action_text/serialization.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionText
   module Serialization
     extend ActiveSupport::Concern

data/lib/action_text/system_test_helper.rb

@@ -1,55 +1,74 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionText
   module SystemTestHelper
     # Locates a Trix editor and fills it in with the given HTML.
     #
     # The editor can be found by:
-    # * its +id+
-    # * its +placeholder+
-    # * the text from its +label+ element
-    # * its +aria-label+
-    # * the +name+ of its input
+    #
+    # *   its `id`
+    # *   its `placeholder`
+    # *   the text from its `label` element
+    # *   its `aria-label`
+    # *   the `name` of its input
+    #
+    # Additional options are forwarded to Capybara as filters
     #
     # Examples:
     #
-    #   # <trix-editor id="message_content" ...></trix-editor>
-    #   fill_in_rich_text_area "message_content", with: "Hello <em>world!</em>"
+    #     # <trix-editor id="message_content" ...></trix-editor>
+    #     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>"
+    #     # <trix-editor placeholder="Your message here" ...></trix-editor>
+    #     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>"
+    #     # <label for="message_content">Message content</label>
+    #     # <trix-editor id="message_content" ...></trix-editor>
+    #     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>"
+    #     # <trix-editor aria-label="Message content" ...></trix-editor>
+    #     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)
+    #     # <input id="trix_input_1" name="message[content]" type="hidden">
+    #     # <trix-editor input="trix_input_1"></trix-editor>
+    #     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(<<~JS, with.to_s)
+        if ("value" in this) {
+          this.value = arguments[0]
+        } else {
+          this.editor.loadHTML(arguments[0])
+        }
+      JS
     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|
+      xpath = XPath.descendant[[
+        XPath.attribute(:role) == "textbox",
+        (XPath.attribute(:contenteditable) == "") | (XPath.attribute(:contenteditable) == "true")
+      ].reduce(:&)]
+
+      if locator.nil?
+        xpath
+      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.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/action_text/trix_attachment.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionText
   class TrixAttachment
     TAG_NAME = "figure"

data/lib/action_text/version.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require_relative "gem_version"
 
 module ActionText
-  # Returns the currently loaded version of Action Text as a +Gem::Version+.
+  # Returns the currently loaded version of Action Text as a `Gem::Version`.
   def self.version
     gem_version
   end

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "pathname"
 require "json"
 
@@ -34,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",
@@ -57,13 +47,6 @@ module ActionText
           "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
         rails_command "railties:install:migrations FROM=active_storage,action_text", inline: true
       end
@@ -73,8 +56,8 @@ module ActionText
       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
+        # 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