Merge pull request #435 from domaframework/fix/sql-format-top-keyword-space

Add Formatting Support for Table Modification Queries

Author: xterao

src/main/java/org/domaframework/doma/intellij/tokens/SqlKeywordTokenUtil.java

@@ -35,6 +35,7 @@ public class SqlKeywordTokenUtil {
             "between",
             "breadth",
             "by",
+            "cascade",
             "case",
             "change",
             "check",
@@ -95,6 +96,7 @@ public class SqlKeywordTokenUtil {
             "recursive",
             "references",
             "rename",
+            "restrict",
             "returning",
             "right",
             "row",

src/main/kotlin/org/domaframework/doma/intellij/formatter/block/SqlFileBlock.kt

@@ -462,6 +462,10 @@ open class SqlFileBlock(
         val childBlock1: SqlBlock? = child1 as? SqlBlock
         val childBlock2: SqlBlock = child2 as SqlBlock
 
+        if (childBlock1 == null) {
+            return SqlCustomSpacingBuilder.nonSpacing
+        }
+
         // The end of a line comment element is a newline, so just add a space for the indent.
         if (childBlock1 is SqlLineCommentBlock) {
             return SqlCustomSpacingBuilder().getSpacing(childBlock2)
@@ -544,7 +548,7 @@ open class SqlFileBlock(
             }
         }
 
-        if (childBlock1?.node?.elementType == SqlTypes.DOT ||
+        if (childBlock1.node.elementType == SqlTypes.DOT ||
             childBlock2.node.elementType == SqlTypes.DOT
         ) {
             return SqlCustomSpacingBuilder.nonSpacing
@@ -588,7 +592,7 @@ open class SqlFileBlock(
                 }
 
                 is SqlFunctionParamBlock -> {
-                    return if (childBlock1?.node?.elementType in listOf(SqlTypes.FUNCTION_NAME, SqlTypes.WORD)) {
+                    return if (childBlock1.node.elementType in listOf(SqlTypes.FUNCTION_NAME, SqlTypes.WORD)) {
                         SqlCustomSpacingBuilder.nonSpacing
                     } else {
                         SqlCustomSpacingBuilder.normalSpacing
@@ -617,7 +621,7 @@ open class SqlFileBlock(
                     ?.let { return it }
         }
 
-        if (childBlock1 is SqlBlock && (childBlock2 is SqlCommaBlock || childBlock2 is SqlColumnRawGroupBlock)) {
+        if (childBlock2 is SqlCommaBlock || childBlock2 is SqlColumnRawGroupBlock) {
             SqlCustomSpacingBuilder()
                 .getSpacingWithIndentComma(childBlock1, childBlock2)
                 ?.let { return it }

src/main/kotlin/org/domaframework/doma/intellij/formatter/block/comma/SqlCommaBlock.kt

@@ -27,6 +27,7 @@ import org.domaframework.doma.intellij.formatter.block.group.keyword.insert.SqlI
 import org.domaframework.doma.intellij.formatter.block.group.keyword.insert.SqlInsertValueGroupBlock
 import org.domaframework.doma.intellij.formatter.block.group.keyword.second.SqlFromGroupBlock
 import org.domaframework.doma.intellij.formatter.block.group.keyword.second.SqlSecondKeywordBlock
+import org.domaframework.doma.intellij.formatter.block.group.keyword.second.SqlTableModifySecondGroupBlock
 import org.domaframework.doma.intellij.formatter.block.group.keyword.second.SqlValuesGroupBlock
 import org.domaframework.doma.intellij.formatter.block.group.keyword.update.SqlUpdateColumnGroupBlock
 import org.domaframework.doma.intellij.formatter.block.group.keyword.update.SqlUpdateSetGroupBlock
@@ -144,6 +145,16 @@ open class SqlCommaBlock(
                         val parentIndent = firstChild?.indent ?: parent.indent
                         parentIndent.groupIndentLen.plus(1)
                     }
+                    is SqlTableModifySecondGroupBlock -> {
+                        val grand = parent.parentBlock
+                        if (grand is SqlElConditionLoopCommentBlock ||
+                            parent.childBlocks.firstOrNull() is SqlElConditionLoopCommentBlock
+                        ) {
+                            parent.indent.indentLen.plus(2)
+                        } else {
+                            parent.indent.indentLen
+                        }
+                    }
                     else -> {
                         // No indent after ORDER BY within function parameters
                         val grand = parent.parentBlock
@@ -181,7 +192,8 @@ open class SqlCommaBlock(
             if (conditionParent is SqlFunctionParamBlock) {
                 return false
             }
-            return TypeUtil.isExpectedClassType(EXPECTED_TYPES, parent)
+            return TypeUtil.isExpectedClassType(EXPECTED_TYPES, parent) ||
+                childBlocks.firstOrNull() is SqlElConditionLoopCommentBlock
         }
         return false
     }

src/main/kotlin/org/domaframework/doma/intellij/formatter/block/conflict/SqlDoGroupBlock.kt

@@ -18,6 +18,7 @@ package org.domaframework.doma.intellij.formatter.block.conflict
 import com.intellij.lang.ASTNode
 import org.domaframework.doma.intellij.formatter.block.SqlBlock
 import org.domaframework.doma.intellij.formatter.block.group.keyword.SqlKeywordGroupBlock
+import org.domaframework.doma.intellij.formatter.block.group.keyword.second.SqlTableModifySecondGroupBlock
 import org.domaframework.doma.intellij.formatter.util.IndentType
 import org.domaframework.doma.intellij.formatter.util.SqlBlockFormattingContext
 
@@ -36,7 +37,7 @@ class SqlDoGroupBlock(
 
     override fun setParentGroupBlock(lastGroup: SqlBlock?) {
         super.setParentGroupBlock(lastGroup)
-        indent.indentLen = 0
+        indent.indentLen = createBlockIndentLen()
         indent.groupIndentLen = getNodeText().length
     }
 
@@ -46,5 +47,13 @@ class SqlDoGroupBlock(
         }
     }
 
+    override fun createBlockIndentLen(): Int {
+        val prevBlock = prevBlocks.lastOrNull()
+        if (prevBlock is SqlTableModifySecondGroupBlock) {
+            return prevBlock.indent.indentLen
+        }
+        return 0
+    }
+
     override fun isSaveSpace(lastGroup: SqlBlock?) = true
 }

src/main/kotlin/org/domaframework/doma/intellij/formatter/block/group/column/SqlColumnRawGroupBlock.kt

@@ -17,6 +17,8 @@ package org.domaframework.doma.intellij.formatter.block.group.column
 
 import com.intellij.lang.ASTNode
 import org.domaframework.doma.intellij.formatter.block.SqlBlock
+import org.domaframework.doma.intellij.formatter.block.comment.SqlElConditionLoopCommentBlock
+import org.domaframework.doma.intellij.formatter.block.group.keyword.second.SqlTableModifySecondGroupBlock
 import org.domaframework.doma.intellij.formatter.block.group.keyword.top.SqlSelectQueryGroupBlock
 import org.domaframework.doma.intellij.formatter.block.group.keyword.update.SqlUpdateColumnGroupBlock
 import org.domaframework.doma.intellij.formatter.block.group.keyword.with.SqlWithQueryGroupBlock
@@ -56,15 +58,31 @@ class SqlColumnRawGroupBlock(
     }
 
     override fun createBlockIndentLen(): Int =
-        if (parentBlock is SqlWithQueryGroupBlock) {
-            parentBlock
-                ?.childBlocks
-                ?.dropLast(1)
-                ?.lastOrNull()
-                ?.indent
-                ?.indentLen ?: offset
-        } else {
-            parentBlock?.indent?.groupIndentLen?.plus(1) ?: offset
+        when (parentBlock) {
+            is SqlWithQueryGroupBlock -> {
+                parentBlock
+                    ?.childBlocks
+                    ?.dropLast(1)
+                    ?.lastOrNull()
+                    ?.indent
+                    ?.indentLen ?: offset
+            }
+
+            is SqlTableModifySecondGroupBlock -> {
+                parentBlock?.let { parent ->
+                    val grand = parent.parentBlock
+                    if (grand is SqlElConditionLoopCommentBlock ||
+                        parent.childBlocks.firstOrNull() is SqlElConditionLoopCommentBlock
+                    ) {
+                        parent.indent.indentLen.plus(2)
+                    } else {
+                        parent.indent.indentLen
+                    }
+                } ?: offset
+            }
+
+            else ->
+                parentBlock?.indent?.groupIndentLen?.plus(1) ?: offset
         }
 
     override fun isSaveSpace(lastGroup: SqlBlock?): Boolean = !isFirstColumnGroup

src/main/kotlin/org/domaframework/doma/intellij/formatter/block/group/keyword/SqlKeywordGroupBlock.kt

@@ -176,7 +176,9 @@ open class SqlKeywordGroupBlock(
         } ?: return 1
     }
 
-    override fun createGroupIndentLen(): Int = indent.indentLen.plus(topKeywordBlocks.sumOf { it.getNodeText().length.plus(1) }.minus(1))
+    override fun createGroupIndentLen(): Int = indent.indentLen.plus(getTotalTopKeywordLength())
+
+    fun getTotalTopKeywordLength(): Int = topKeywordBlocks.sumOf { it.getNodeText().length.plus(1) }.minus(1)
 
     override fun isSaveSpace(lastGroup: SqlBlock?): Boolean {
         val conditionLastGroup =

src/main/kotlin/org/domaframework/doma/intellij/formatter/block/group/keyword/condition/SqlConditionKeywordGroupBlock.kt

@@ -18,6 +18,7 @@ package org.domaframework.doma.intellij.formatter.block.group.keyword.condition
 import com.intellij.lang.ASTNode
 import org.domaframework.doma.intellij.formatter.block.SqlBlock
 import org.domaframework.doma.intellij.formatter.block.comment.SqlElConditionLoopCommentBlock
+import org.domaframework.doma.intellij.formatter.block.group.keyword.create.SqlCreateKeywordGroupBlock
 import org.domaframework.doma.intellij.formatter.block.group.keyword.option.SqlSecondOptionKeywordGroupBlock
 import org.domaframework.doma.intellij.formatter.block.group.keyword.second.SqlWhereGroupBlock
 import org.domaframework.doma.intellij.formatter.block.group.subgroup.SqlSubGroupBlock
@@ -49,22 +50,23 @@ class SqlConditionKeywordGroupBlock(
 
     // If AND appears after OR, change it so that it is right-justified.
     override fun createBlockIndentLen(): Int {
-        parentBlock?.let { parent ->
-            val groupLen = parent.indent.groupIndentLen
-            return if (parent is SqlElConditionLoopCommentBlock) {
-                parent.indent.groupIndentLen
-            } else if (parent is SqlSubGroupBlock) {
-                if (getNodeText() == "and") {
-                    groupLen
-                } else {
-                    groupLen.plus(1)
-                }
-            } else {
-                return parent.indent.groupIndentLen.minus(getNodeText().length)
-            }
-        } ?: return 1
+        val parent = parentBlock ?: return 1
+        val groupLen = parent.indent.groupIndentLen
+
+        return when (parent) {
+            is SqlElConditionLoopCommentBlock -> parent.indent.groupIndentLen
+            is SqlSubGroupBlock -> calculateSubGroupIndent(groupLen)
+            else -> parent.indent.groupIndentLen - getNodeText().length
+        }
     }
 
+    private fun calculateSubGroupIndent(groupLen: Int): Int =
+        if (getNodeText() == "and") {
+            groupLen
+        } else {
+            groupLen + 1
+        }
+
     override fun createGroupIndentLen(): Int {
         parentBlock?.let { parent ->
             if (parent is SqlWhereGroupBlock) {
@@ -74,4 +76,11 @@ class SqlConditionKeywordGroupBlock(
         }
         return 0
     }
+
+    override fun isSaveSpace(lastGroup: SqlBlock?): Boolean {
+        if (lastGroup is SqlCreateKeywordGroupBlock) {
+            return false
+        }
+        return super.isSaveSpace(lastGroup)
+    }
 }

src/main/kotlin/org/domaframework/doma/intellij/formatter/block/group/keyword/option/SqlExistsGroupBlock.kt

@@ -19,7 +19,9 @@ import com.intellij.lang.ASTNode
 import org.domaframework.doma.intellij.formatter.block.SqlBlock
 import org.domaframework.doma.intellij.formatter.block.comment.SqlElConditionLoopCommentBlock
 import org.domaframework.doma.intellij.formatter.block.group.keyword.SqlKeywordGroupBlock
-import org.domaframework.doma.intellij.formatter.block.group.keyword.create.SqlCreateTableColumnDefinitionRawGroupBlock
+import org.domaframework.doma.intellij.formatter.block.group.keyword.create.SqlCreateKeywordGroupBlock
+import org.domaframework.doma.intellij.formatter.block.group.keyword.second.SqlTableModifySecondGroupBlock
+import org.domaframework.doma.intellij.formatter.block.group.keyword.top.SqlTableModificationKeyword
 import org.domaframework.doma.intellij.formatter.util.IndentType
 import org.domaframework.doma.intellij.formatter.util.SqlBlockFormattingContext
 
@@ -44,11 +46,14 @@ class SqlExistsGroupBlock(
 
     override fun createGroupIndentLen(): Int {
         val parentGroupIndent = parentBlock?.indent?.groupIndentLen ?: 0
-        return topKeywordBlocks.sumOf { it.getNodeText().length.plus(1) }.plus(parentGroupIndent).minus(1)
+        return getTotalTopKeywordLength().plus(parentGroupIndent)
     }
 
     override fun isSaveSpace(lastGroup: SqlBlock?): Boolean {
-        if (lastGroup is SqlCreateTableColumnDefinitionRawGroupBlock) {
+        if (lastGroup is SqlTableModificationKeyword ||
+            lastGroup is SqlTableModifySecondGroupBlock ||
+            lastGroup is SqlCreateKeywordGroupBlock
+        ) {
             return false
         }
         return super.isSaveSpace(lastGroup)

src/main/kotlin/org/domaframework/doma/intellij/formatter/block/group/keyword/second/SqlTableModifySecondGroupBlock.kt

@@ -0,0 +1,40 @@
+/*
+ * 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.block.group.keyword.second
+
+import com.intellij.lang.ASTNode
+import org.domaframework.doma.intellij.formatter.block.SqlBlock
+import org.domaframework.doma.intellij.formatter.block.group.column.SqlColumnRawGroupBlock
+import org.domaframework.doma.intellij.formatter.util.SqlBlockFormattingContext
+
+class SqlTableModifySecondGroupBlock(
+    node: ASTNode,
+    context: SqlBlockFormattingContext,
+) : SqlSecondKeywordBlock(
+        node,
+        context,
+    ) {
+    override fun createBlockIndentLen(): Int {
+        val prevBlock = prevBlocks.lastOrNull()
+        if (prevBlock is SqlTableModifySecondGroupBlock) {
+            return prevBlock.indent.indentLen
+        }
+
+        return super.createBlockIndentLen()
+    }
+
+    override fun isSaveSpace(lastGroup: SqlBlock?): Boolean = parentBlock !is SqlColumnRawGroupBlock
+}

src/main/kotlin/org/domaframework/doma/intellij/formatter/block/group/keyword/top/SqlTableModificationKeyword.kt

@@ -0,0 +1,65 @@
+/*
+ * 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.block.group.keyword.top
+
+import com.intellij.lang.ASTNode
+import org.domaframework.doma.intellij.formatter.block.SqlBlock
+import org.domaframework.doma.intellij.formatter.block.comment.SqlElConditionLoopCommentBlock
+import org.domaframework.doma.intellij.formatter.block.group.keyword.SqlKeywordGroupBlock
+import org.domaframework.doma.intellij.formatter.util.IndentType
+import org.domaframework.doma.intellij.formatter.util.SqlBlockFormattingContext
+
+class SqlTableModificationKeyword(
+    node: ASTNode,
+    context: SqlBlockFormattingContext,
+) : SqlTopQueryGroupBlock(
+        node,
+        context,
+    ) {
+    override fun setParentGroupBlock(lastGroup: SqlBlock?) {
+        super.setParentGroupBlock(lastGroup)
+        indent.indentLen = createBlockIndentLen()
+        indent.groupIndentLen = createGroupIndentLen()
+    }
+
+    override fun createBlockIndentLen(): Int {
+        return parentBlock?.let { parent ->
+            val rootBlock =
+                if (parent is SqlElConditionLoopCommentBlock) {
+                    parent.tempParentBlock
+                } else if (parent.indent.indentLevel == IndentType.FILE) {
+                    null
+                } else {
+                    parent
+                }
+
+            return if (rootBlock is SqlKeywordGroupBlock) {
+                rootBlock.getTotalTopKeywordLength().minus(getNodeText().length)
+            } else {
+                rootBlock?.indent?.groupIndentLen ?: 0
+            }
+        } ?: 0
+    }
+
+    override fun createGroupIndentLen(): Int =
+        parentBlock?.let { parent ->
+            if (parent is SqlElConditionLoopCommentBlock) {
+                parent.indent.indentLen
+            } else {
+                getTotalTopKeywordLength()
+            }
+        } ?: getTotalTopKeywordLength()
+}