each_line instead of split

Author: kddnewton

lib/syntax_tree/formatter.rb

@@ -4,26 +4,6 @@ module SyntaxTree
   # A slightly enhanced PP that knows how to format recursively including
   # comments.
   class Formatter < PrettierPrint
-    # It's very common to use seplist with ->(q) { q.breakable_return }. We wrap
-    # that pattern into an object to cut down on having to create a bunch of
-    # lambdas all over the place.
-    class BreakableReturnSeparator
-      def call(q)
-        q.breakable_return
-      end
-    end
-
-    # Similar to the previous, it's common to ->(q) { q.breakable_space }. We
-    # also wrap that pattern into an object to cut down on lambdas.
-    class BreakableSpaceSeparator
-      def call(q)
-        q.breakable_space
-      end
-    end
-
-    BREAKABLE_RETURN_SEPARATOR = BreakableReturnSeparator.new
-    BREAKABLE_SPACE_SEPARATOR = BreakableSpaceSeparator.new
-
     # We want to minimize as much as possible the number of options that are
     # available in syntax tree. For the most part, if users want non-default
     # formatting, they should override the format methods on the specific nodes
@@ -82,20 +62,39 @@ def format(node, stackable: true)
       # If there are comments, then we're going to format them around the node
       # so that they get printed properly.
       if node.comments.any?
-        leading, trailing = node.comments.partition(&:leading?)
+        trailing = []
+        last_leading = nil
 
-        # Print all comments that were found before the node.
-        leading.each do |comment|
-          comment.format(self)
-          breakable(force: true)
+        # First, we're going to print all of the comments that were found before
+        # the node. We'll also gather up any trailing comments that we find.
+        node.comments.each do |comment|
+          if comment.leading?
+            comment.format(self)
+            breakable(force: true)
+            last_leading = comment
+          else
+            trailing << comment
+          end
         end
 
         # If the node has a stree-ignore comment right before it, then we're
         # going to just print out the node as it was seen in the source.
         doc =
-          if leading.last&.ignore?
+          if last_leading&.ignore?
             range = source[node.location.start_char...node.location.end_char]
-            seplist(range.split(/\r?\n/, -1), Formatter::BREAKABLE_RETURN_SEPARATOR) { |line| text(line) }
+            first = true
+
+            range.each_line(chomp: true) do |line|
+              if first
+                first = false
+              else
+                breakable_return
+              end
+
+              text(line)
+            end
+
+            breakable_return if range.end_with?("\n")
           else
             node.format(self)
           end

lib/syntax_tree/node.rb

@@ -328,7 +328,19 @@ def deconstruct_keys(_keys)
     def format(q)
       q.text("__END__")
       q.breakable_force
-      q.seplist(value.split(/\r?\n/, -1), Formatter::BREAKABLE_RETURN_SEPARATOR) { |line| q.text(line) }
+
+      first = true
+      value.each_line(chomp: true) do |line|
+        if first
+          first = false
+        else
+          q.breakable_return
+        end
+
+        q.text(line)
+      end
+
+      q.breakable_return if value.end_with?("\n")
     end
   end
 
@@ -792,6 +804,17 @@ def format(q)
   #     [one, two, three]
   #
   class ArrayLiteral < Node
+    # It's very common to use seplist with ->(q) { q.breakable_space }. We wrap
+    # that pattern into an object to cut down on having to create a bunch of
+    # lambdas all over the place.
+    class BreakableSpaceSeparator
+      def call(q)
+        q.breakable_space
+      end
+    end
+
+    BREAKABLE_SPACE_SEPARATOR = BreakableSpaceSeparator.new
+
     # Formats an array of multiple simple string literals into the %w syntax.
     class QWordsFormatter
       # [Args] the contents of the array
@@ -806,7 +829,7 @@ def format(q)
         q.group do
           q.indent do
             q.breakable_empty
-            q.seplist(contents.parts, Formatter::BREAKABLE_SPACE_SEPARATOR) do |part|
+            q.seplist(contents.parts, BREAKABLE_SPACE_SEPARATOR) do |part|
               if part.is_a?(StringLiteral)
                 q.format(part.parts.first)
               else
@@ -834,7 +857,7 @@ def format(q)
         q.group do
           q.indent do
             q.breakable_empty
-            q.seplist(contents.parts, Formatter::BREAKABLE_SPACE_SEPARATOR) do |part|
+            q.seplist(contents.parts, BREAKABLE_SPACE_SEPARATOR) do |part|
               q.format(part.value)
             end
           end
@@ -4034,9 +4057,19 @@ def format(q)
         parts.each do |part|
           if part.is_a?(TStringContent)
             value = Quotes.normalize(part.value, closing_quote)
-            q.seplist(value.split(/\r?\n/, -1), Formatter::BREAKABLE_RETURN_SEPARATOR) do |text|
-              q.text(text)
+            first = true
+
+            value.each_line(chomp: true) do |line|
+              if first
+                first = false
+              else
+                q.breakable_return
+              end
+
+              q.text(line)
             end
+
+            q.breakable_return if value.end_with?("\n")
           else
             q.format(part)
           end
@@ -4957,30 +4990,32 @@ def deconstruct_keys(_keys)
 
     # This is a very specific behavior where you want to force a newline, but
     # don't want to force the break parent.
-    class Separator
-      DOC = PrettierPrint::Breakable.new(" ", 1, indent: false, force: true)
-
-      def call(q)
-        q.target << DOC
-      end
-    end
-
-    # We're going to keep an instance around so we don't have to allocate a new
-    # one every time we format a heredoc.
-    SEPARATOR = Separator.new
+    SEPARATOR = PrettierPrint::Breakable.new(" ", 1, indent: false, force: true)
 
     def format(q)
       q.group do
         q.format(beginning)
 
         q.line_suffix(priority: Formatter::HEREDOC_PRIORITY) do
           q.group do
-            SEPARATOR.call(q)
+            q.target << SEPARATOR
 
             parts.each do |part|
               if part.is_a?(TStringContent)
-                texts = part.value.split(/\r?\n/, -1)
-                q.seplist(texts, SEPARATOR) { |text| q.text(text) }
+                value = part.value
+                first = true
+
+                value.each_line(chomp: true) do |line|
+                  if first
+                    first = false
+                  else
+                    q.target << SEPARATOR
+                  end
+
+                  q.text(line)
+                end
+
+                q.target << SEPARATOR if value.end_with?("\n")
               else
                 q.format(part)
               end
@@ -7295,7 +7330,7 @@ def format(q)
       q.group do
         q.indent do
           q.breakable_empty
-          q.seplist(elements, Formatter::BREAKABLE_SPACE_SEPARATOR) do |element|
+          q.seplist(elements, ArrayLiteral::BREAKABLE_SPACE_SEPARATOR) do |element|
             q.format(element)
           end
         end
@@ -7388,7 +7423,7 @@ def format(q)
       q.group do
         q.indent do
           q.breakable_empty
-          q.seplist(elements, Formatter::BREAKABLE_SPACE_SEPARATOR) do |element|
+          q.seplist(elements, ArrayLiteral::BREAKABLE_SPACE_SEPARATOR) do |element|
             q.format(element)
           end
         end
@@ -8626,9 +8661,19 @@ def format(q)
         parts.each do |part|
           if part.is_a?(TStringContent)
             value = Quotes.normalize(part.value, closing_quote)
-            q.seplist(value.split(/\r?\n/, -1), Formatter::BREAKABLE_RETURN_SEPARATOR) do |text|
-              q.text(text)
+            first = true
+
+            value.each_line(chomp: true) do |line|
+              if first
+                first = false
+              else
+                q.breakable_return
+              end
+
+              q.text(line)
             end
+
+            q.breakable_return if value.end_with?("\n")
           else
             q.format(part)
           end
@@ -8845,7 +8890,7 @@ def format(q)
       q.group do
         q.indent do
           q.breakable_empty
-          q.seplist(elements, Formatter::BREAKABLE_SPACE_SEPARATOR) do |element|
+          q.seplist(elements, ArrayLiteral::BREAKABLE_SPACE_SEPARATOR) do |element|
             q.format(element)
           end
         end
@@ -10184,7 +10229,7 @@ def format(q)
       q.group do
         q.indent do
           q.breakable_empty
-          q.seplist(elements, Formatter::BREAKABLE_SPACE_SEPARATOR) do |element|
+          q.seplist(elements, ArrayLiteral::BREAKABLE_SPACE_SEPARATOR) do |element|
             q.format(element)
           end
         end