fix: comment Ruby lines inside multiline ERB tags with toggleBlockComment

Author: RSeven

javascript/packages/language-server/src/comment_service.ts

@@ -96,6 +96,10 @@ export class CommentService {
     const startLine = range.start.line
     const endLine = range.end.line
 
+    if (this.selectionIsInsideMultilineERBTag(document, startLine, endLine)) {
+      return this.toggleRubyLineComments(document, startLine, endLine)
+    }
+
     const firstLineText = document.getText(Range.create(startLine, 0, startLine + 1, 0)).replace(/\n$/, "")
     const lastLineText = document.getText(Range.create(endLine, 0, endLine + 1, 0)).replace(/\n$/, "")
     const isWrapped = firstLineText.trim() === "<% if false %>" && lastLineText.trim() === "<% end %>"
@@ -187,6 +191,46 @@ export class CommentService {
     return false
   }
 
+  private selectionIsInsideMultilineERBTag(document: TextDocument, startLine: number, endLine: number): boolean {
+    let hasRubyLine = false
+
+    for (let line = startLine; line <= endLine; line++) {
+      const lineText = document.getText(Range.create(line, 0, line + 1, 0)).replace(/\n$/, "")
+
+      if (lineText.trim() === "") continue
+      if (!this.lineIsInsideMultilineERBTag(document, line)) return false
+
+      hasRubyLine = true
+    }
+
+    return hasRubyLine
+  }
+
+  private toggleRubyLineComments(document: TextDocument, startLine: number, endLine: number): TextEdit[] {
+    const lineTexts: { line: number, text: string }[] = []
+
+    for (let line = startLine; line <= endLine; line++) {
+      const text = document.getText(Range.create(line, 0, line + 1, 0)).replace(/\n$/, "")
+
+      if (text.trim() !== "") {
+        lineTexts.push({ line, text })
+      }
+    }
+
+    const allCommented = lineTexts.every(({ text }) => text.trimStart().startsWith("#"))
+
+    return lineTexts.map(({ line, text }) => {
+      if (allCommented) {
+        return this.uncommentRubyLine(text, line)!
+      }
+
+      const indent = this.getIndentation(text)
+      const content = text.trimStart()
+
+      return TextEdit.replace(Range.create(line, 0, line, text.length), `${indent}# ${content}`)
+    }).filter(edit => edit !== null)
+  }
+
   private uncommentLine(info: LineInfo, lineText: string, collector: LineContextCollector): TextEdit | null {
     const lineRange = Range.create(info.line, 0, info.line, lineText.length)
     const indent = this.getIndentation(lineText)

javascript/packages/language-server/test/comment_service.test.ts

@@ -1108,6 +1108,14 @@ describe("CommentService", () => {
         const startEdit = edits.find(edit => edit.newText.includes("<% if false %>"))
         expect(startEdit?.newText).toBe("  <% if false %>\n")
       })
+
+      it("comments an internal Ruby line inside a multiline ERB tag", () => {
+        const original = `<%\n  a\n%>`
+        const document = createDocument(original)
+        const edits = service.toggleBlockComment(document, lineRange(1))
+
+        expect(applyEdits(original, edits)).toBe(`<%\n  # a\n%>`)
+      })
     })
 
     describe("round-trip", () => {
@@ -1132,6 +1140,19 @@ describe("CommentService", () => {
           <%= render "thing" %>
         `.trim())
       })
+
+      it("round-trips an internal Ruby line inside a multiline ERB tag", () => {
+        const original = `<%\n  a\n%>`
+        const document1 = createDocument(original)
+        const commented = applyEdits(original, service.toggleBlockComment(document1, lineRange(1)))
+
+        expect(commented).toBe(`<%\n  # a\n%>`)
+
+        const document2 = createDocument(commented)
+        const uncommented = applyEdits(commented, service.toggleBlockComment(document2, lineRange(1)))
+
+        expect(uncommented).toBe(original)
+      })
     })
 
 describe("unwrapping", () => {