Create an abstract class to share trailing whitespace removal logic in the PostProcessor for both regular SQL files and injected SQL.

Author: xterao

src/main/kotlin/org/domaframework/doma/intellij/formatter/processor/SqlFormatPostProcessor.kt

@@ -0,0 +1,77 @@
+/*
+ * Copyright Doma Tools Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.domaframework.doma.intellij.formatter.processor
+
+import com.intellij.lang.injection.InjectedLanguageManager
+import com.intellij.openapi.application.ApplicationManager
+import com.intellij.openapi.command.WriteCommandAction
+import com.intellij.openapi.editor.Document
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.util.TextRange
+import com.intellij.psi.PsiDocumentManager
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiFile
+import com.intellij.psi.codeStyle.CodeStyleSettings
+import org.domaframework.doma.intellij.setting.SqlLanguage
+
+class SqlFormatPostProcessor : SqlPostProcessor() {
+    override fun processElement(
+        source: PsiElement,
+        settings: CodeStyleSettings,
+    ): PsiElement = source
+
+    override fun processText(
+        source: PsiFile,
+        rangeToReformat: TextRange,
+        settings: CodeStyleSettings,
+    ): TextRange {
+        if (!isSqlFile(source) || isInjectedSqlFile(source)) {
+            return rangeToReformat
+        }
+
+        val document = getDocument(source) ?: return rangeToReformat
+        val processedText = processDocumentText(document.text, true)
+
+        if (document.text == processedText) {
+            return rangeToReformat
+        }
+
+        updateDocument(source.project, document, processedText)
+        return TextRange(0, processedText.length)
+    }
+
+    private fun isSqlFile(source: PsiFile): Boolean = source.language == SqlLanguage.INSTANCE
+
+    private fun isInjectedSqlFile(source: PsiFile): Boolean {
+        val injectedLanguageManager = InjectedLanguageManager.getInstance(source.project)
+        return injectedLanguageManager.isInjectedFragment(source)
+    }
+
+    private fun getDocument(source: PsiFile) = PsiDocumentManager.getInstance(source.project).getDocument(source)
+
+    private fun updateDocument(
+        project: Project,
+        document: Document,
+        newText: String,
+    ) {
+        ApplicationManager.getApplication().invokeAndWait {
+            WriteCommandAction.runWriteCommandAction(project) {
+                document.setText(newText)
+                PsiDocumentManager.getInstance(project).commitDocument(document)
+            }
+        }
+    }
+}

src/main/kotlin/org/domaframework/doma/intellij/formatter/processor/SqlInjectionPostProcessor.kt

@@ -20,12 +20,11 @@ import com.intellij.openapi.util.TextRange
 import com.intellij.psi.PsiElement
 import com.intellij.psi.PsiFile
 import com.intellij.psi.codeStyle.CodeStyleSettings
-import com.intellij.psi.impl.source.codeStyle.PostFormatProcessor
 import org.domaframework.doma.intellij.common.dao.getDaoClass
 import org.domaframework.doma.intellij.common.isJavaOrKotlinFileType
 import org.domaframework.doma.intellij.formatter.visitor.DaoInjectionSqlVisitor
 
-class SqlInjectionPostProcessor : PostFormatProcessor {
+class SqlInjectionPostProcessor : SqlPostProcessor() {
     override fun processElement(
         element: PsiElement,
         settings: CodeStyleSettings,
@@ -46,6 +45,8 @@ class SqlInjectionPostProcessor : PostFormatProcessor {
         val project: Project = element.project
         val visitor = DaoInjectionSqlVisitor(element, project)
         element.accept(visitor)
-        visitor.processAll()
+        visitor.processAll { text, skipFinalLineBreak ->
+            processDocumentText(text, skipFinalLineBreak)
+        }
     }
 }

src/main/kotlin/org/domaframework/doma/intellij/formatter/processor/SqlPostProcessor.kt

@@ -15,58 +15,32 @@
  */
 package org.domaframework.doma.intellij.formatter.processor
 
-import com.intellij.openapi.application.ApplicationManager
-import com.intellij.openapi.command.WriteCommandAction
-import com.intellij.openapi.editor.Document
-import com.intellij.openapi.project.Project
 import com.intellij.openapi.util.TextRange
-import com.intellij.psi.PsiDocumentManager
 import com.intellij.psi.PsiElement
 import com.intellij.psi.PsiFile
 import com.intellij.psi.codeStyle.CodeStyleSettings
 import com.intellij.psi.impl.source.codeStyle.PostFormatProcessor
-import org.domaframework.doma.intellij.common.util.InjectionSqlUtil.isInjectedSqlFile
 import org.domaframework.doma.intellij.common.util.StringUtil
-import org.domaframework.doma.intellij.setting.SqlLanguage
 
-class SqlPostProcessor : PostFormatProcessor {
+abstract class SqlPostProcessor : PostFormatProcessor {
     companion object {
         private const val FILE_END_PADDING = " ${StringUtil.LINE_SEPARATE}"
     }
 
     private val trailingSpacesRegex = Regex(" +(\r?\n)")
 
     override fun processElement(
-        source: PsiElement,
+        element: PsiElement,
         settings: CodeStyleSettings,
-    ): PsiElement = source
+    ): PsiElement = element
 
     override fun processText(
         source: PsiFile,
         rangeToReformat: TextRange,
         settings: CodeStyleSettings,
-    ): TextRange {
-        if (!isSqlFile(source) || isInjectedSqlFile(source)) {
-            return rangeToReformat
-        }
+    ): TextRange = rangeToReformat
 
-        val originalDocument = getDocument(source)
-        val document = originalDocument ?: source.fileDocument
-        val processedText = processDocumentText(document.text, originalDocument != null)
-
-        if (document.text == processedText) {
-            return rangeToReformat
-        }
-
-        updateDocument(source.project, document, processedText)
-        return TextRange(0, processedText.length)
-    }
-
-    private fun isSqlFile(source: PsiFile): Boolean = source.language == SqlLanguage.INSTANCE
-
-    private fun getDocument(source: PsiFile) = PsiDocumentManager.getInstance(source.project).getDocument(source)
-
-    private fun processDocumentText(
+    protected fun processDocumentText(
         originalText: String,
         existsOriginalDocument: Boolean,
     ): String {
@@ -82,17 +56,4 @@ class SqlPostProcessor : PostFormatProcessor {
     ): String =
         text.trimEnd() +
             if (isEndSpace) FILE_END_PADDING else ""
-
-    private fun updateDocument(
-        project: Project,
-        document: Document,
-        newText: String,
-    ) {
-        ApplicationManager.getApplication().invokeAndWait {
-            WriteCommandAction.runWriteCommandAction(project) {
-                document.setText(newText)
-                PsiDocumentManager.getInstance(project).commitDocument(document)
-            }
-        }
-    }
 }

src/main/resources/META-INF/plugin.xml

@@ -66,7 +66,7 @@
     <lang.formatter language="DomaSql"
       implementationClass="org.domaframework.doma.intellij.formatter.builder.SqlFormattingModelBuilder"/>
     <preFormatProcessor implementation="org.domaframework.doma.intellij.formatter.processor.SqlFormatPreProcessor" />
-    <postFormatProcessor implementation="org.domaframework.doma.intellij.formatter.processor.SqlPostProcessor" />
+    <postFormatProcessor implementation="org.domaframework.doma.intellij.formatter.processor.SqlFormatPostProcessor" />
     <postFormatProcessor implementation="org.domaframework.doma.intellij.formatter.processor.SqlInjectionPostProcessor" />
 
     <!-- CustomLanguage -->