-
Notifications
You must be signed in to change notification settings - Fork 516
Fix review findings immersed in #2520 #2521
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
300e68b
c288631
7105f36
6d6cf72
1d75825
6eefa33
c99dfdc
3ceac97
3dd75bd
bcbe6e5
961ebe7
bf7c651
2ca859a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -22,6 +22,8 @@ | |
|
|
||
| import com.diffplug.spotless.annotations.Internal; | ||
|
|
||
| import static java.lang.System.lineSeparator; | ||
|
|
||
| /** | ||
| * **Warning:** Use this class at your own risk. It is an implementation detail and is not | ||
| * guaranteed to exist in future versions. | ||
|
|
@@ -67,7 +69,7 @@ | |
| } | ||
|
|
||
| if (isSqlEndsWithNewLine) { | ||
| after.append(getDefaultLineSeparator()); | ||
| after.append(lineSeparator()); | ||
| } | ||
|
|
||
| return after.toString(); | ||
|
|
@@ -388,19 +390,12 @@ | |
| return sqlDialect.getKeywordType(name) == DBPKeywordType.FUNCTION; | ||
| } | ||
|
|
||
| private static String getDefaultLineSeparator() { | ||
| return System.getProperty("line.separator", "\n"); | ||
| } | ||
|
|
||
| private int insertReturnAndIndent(final List<FormatterToken> argList, final int argIndex, final int argIndent) { | ||
| if (functionBracket.contains(Boolean.TRUE)) | ||
| return 0; | ||
| try { | ||
| final String defaultLineSeparator = getDefaultLineSeparator(); | ||
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. DRY. |
||
| StringBuilder s = new StringBuilder(defaultLineSeparator); | ||
| for (int index = 0; index < argIndent; index++) { | ||
| s.append(formatterCfg.getIndentString()); | ||
| } | ||
| StringBuilder s = new StringBuilder(lineSeparator()); | ||
| s.append(String.valueOf(formatterCfg.getIndentString()).repeat(Math.max(0, argIndent))); | ||
| if (argIndex > 0) { | ||
| final FormatterToken token = argList.get(argIndex); | ||
| final FormatterToken prevToken = argList.get(argIndex - 1); | ||
|
|
@@ -409,10 +404,7 @@ | |
| prevToken.getType() != TokenType.END) { | ||
| s.setCharAt(0, ' '); | ||
| s.setLength(1); | ||
|
|
||
| final String comment = token.getString(); | ||
| final String withoutTrailingWhitespace = comment.replaceFirst("\\s*$", ""); | ||
| token.setString(withoutTrailingWhitespace); | ||
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| token.setString(token.getString().replaceFirst("\\s*$", "")); | ||
Check failureCode scanning / CodeQL Polynomial regular expression used on uncontrolled data High
This
regular expression Error loading related location Loading user-provided value Error loading related location Loading
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. might be, logic is same as before. Just the field burden imposing coupling was inlined to avoid boilerplate. So only removed the documentation overhead in favor of 1 LOC concise possible statement. |
||
| } | ||
| } | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,178 @@ | ||
| /* | ||
| * Copyright 2025 DiffPlug | ||
| * | ||
| * 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 | ||
| * | ||
| * http://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 com.diffplug.spotless.pom; | ||
|
|
||
| import static java.lang.System.lineSeparator; | ||
| import static org.assertj.core.api.Assertions.assertThat; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| class SortPomCfgTest { | ||
|
|
||
| @Test | ||
| void testDefaultValues() { | ||
| SortPomCfg cfg = new SortPomCfg(); | ||
|
|
||
| // Test default values using AssertJ | ||
| assertThat(cfg.version).isEqualTo("4.0.0"); | ||
| assertThat(cfg.encoding).isEqualTo("UTF-8"); | ||
| assertThat(cfg.lineSeparator).isEqualTo(lineSeparator()); | ||
| assertThat(cfg.expandEmptyElements).isFalse(); | ||
| assertThat(cfg.spaceBeforeCloseEmptyElement).isFalse(); | ||
| assertThat(cfg.keepBlankLines).isTrue(); | ||
| assertThat(cfg.endWithNewline).isTrue(); | ||
| assertThat(cfg.nrOfIndentSpace).isEqualTo(2); | ||
| assertThat(cfg.indentBlankLines).isFalse(); | ||
| assertThat(cfg.indentSchemaLocation).isFalse(); | ||
| assertThat(cfg.indentAttribute).isNull(); | ||
| assertThat(cfg.predefinedSortOrder).isEqualTo("recommended_2008_06"); | ||
| assertThat(cfg.quiet).isFalse(); | ||
| assertThat(cfg.sortOrderFile).isNull(); | ||
| assertThat(cfg.sortDependencies).isNull(); | ||
| assertThat(cfg.sortDependencyManagement).isNull(); | ||
| assertThat(cfg.sortDependencyExclusions).isNull(); | ||
| assertThat(cfg.sortPlugins).isNull(); | ||
| assertThat(cfg.sortProperties).isFalse(); | ||
| assertThat(cfg.sortModules).isFalse(); | ||
| assertThat(cfg.sortExecutions).isFalse(); | ||
| } | ||
|
|
||
| @Test | ||
| void testFieldSetters() { | ||
| SortPomCfg cfg = new SortPomCfg(); | ||
|
|
||
| // Set all fields | ||
| cfg.version = "4.1.0"; | ||
| cfg.encoding = "ISO-8859-1"; | ||
| cfg.lineSeparator = "\n"; | ||
| cfg.expandEmptyElements = true; | ||
| cfg.spaceBeforeCloseEmptyElement = true; | ||
| cfg.keepBlankLines = false; | ||
| cfg.endWithNewline = false; | ||
| cfg.nrOfIndentSpace = 4; | ||
| cfg.indentBlankLines = true; | ||
| cfg.indentSchemaLocation = true; | ||
| cfg.indentAttribute = "attribute"; | ||
| cfg.predefinedSortOrder = "custom"; | ||
| cfg.quiet = true; | ||
| cfg.sortOrderFile = "sortOrder.xml"; | ||
| cfg.sortDependencies = "groupId,artifactId"; | ||
| cfg.sortDependencyManagement = "scope,groupId"; | ||
| cfg.sortDependencyExclusions = "artifactId"; | ||
| cfg.sortPlugins = "groupId"; | ||
| cfg.sortProperties = true; | ||
| cfg.sortModules = true; | ||
| cfg.sortExecutions = true; | ||
|
|
||
| // Verify all set values with AssertJ | ||
| assertThat(cfg.version).isEqualTo("4.1.0"); | ||
| assertThat(cfg.encoding).isEqualTo("ISO-8859-1"); | ||
| assertThat(cfg.lineSeparator).isEqualTo("\n"); | ||
| assertThat(cfg.expandEmptyElements).isTrue(); | ||
| assertThat(cfg.spaceBeforeCloseEmptyElement).isTrue(); | ||
| assertThat(cfg.keepBlankLines).isFalse(); | ||
| assertThat(cfg.endWithNewline).isFalse(); | ||
| assertThat(cfg.nrOfIndentSpace).isEqualTo(4); | ||
| assertThat(cfg.indentBlankLines).isTrue(); | ||
| assertThat(cfg.indentSchemaLocation).isTrue(); | ||
| assertThat(cfg.indentAttribute).isEqualTo("attribute"); | ||
| assertThat(cfg.predefinedSortOrder).isEqualTo("custom"); | ||
| assertThat(cfg.quiet).isTrue(); | ||
| assertThat(cfg.sortOrderFile).isEqualTo("sortOrder.xml"); | ||
| assertThat(cfg.sortDependencies).isEqualTo("groupId,artifactId"); | ||
| assertThat(cfg.sortDependencyManagement).isEqualTo("scope,groupId"); | ||
| assertThat(cfg.sortDependencyExclusions).isEqualTo("artifactId"); | ||
| assertThat(cfg.sortPlugins).isEqualTo("groupId"); | ||
| assertThat(cfg.sortProperties).isTrue(); | ||
| assertThat(cfg.sortModules).isTrue(); | ||
| assertThat(cfg.sortExecutions).isTrue(); | ||
| } | ||
|
|
||
| @Test | ||
| void testNullHandling() { | ||
| SortPomCfg cfg = new SortPomCfg(); | ||
|
|
||
| // Set nullable fields to null | ||
| cfg.version = null; | ||
| cfg.encoding = null; | ||
| cfg.lineSeparator = null; | ||
| cfg.indentAttribute = null; | ||
| cfg.predefinedSortOrder = null; | ||
| cfg.sortOrderFile = null; | ||
| cfg.sortDependencies = null; | ||
| cfg.sortDependencyManagement = null; | ||
| cfg.sortDependencyExclusions = null; | ||
| cfg.sortPlugins = null; | ||
|
|
||
| // Verify null values with AssertJ | ||
| assertThat(cfg.version).isNull(); | ||
| assertThat(cfg.encoding).isNull(); | ||
| assertThat(cfg.lineSeparator).isNull(); | ||
| assertThat(cfg.indentAttribute).isNull(); | ||
| assertThat(cfg.predefinedSortOrder).isNull(); | ||
| assertThat(cfg.sortOrderFile).isNull(); | ||
| assertThat(cfg.sortDependencies).isNull(); | ||
| assertThat(cfg.sortDependencyManagement).isNull(); | ||
| assertThat(cfg.sortDependencyExclusions).isNull(); | ||
| assertThat(cfg.sortPlugins).isNull(); | ||
| } | ||
|
|
||
| @Test | ||
| void testBooleanFieldsEdgeCases() { | ||
| SortPomCfg cfg = new SortPomCfg(); | ||
|
|
||
| // Toggle all boolean fields | ||
| cfg.expandEmptyElements = !cfg.expandEmptyElements; | ||
| cfg.spaceBeforeCloseEmptyElement = !cfg.spaceBeforeCloseEmptyElement; | ||
| cfg.keepBlankLines = !cfg.keepBlankLines; | ||
| cfg.endWithNewline = !cfg.endWithNewline; | ||
| cfg.indentBlankLines = !cfg.indentBlankLines; | ||
| cfg.indentSchemaLocation = !cfg.indentSchemaLocation; | ||
| cfg.quiet = !cfg.quiet; | ||
| cfg.sortProperties = !cfg.sortProperties; | ||
| cfg.sortModules = !cfg.sortModules; | ||
| cfg.sortExecutions = !cfg.sortExecutions; | ||
|
|
||
| // Verify all boolean fields are toggled | ||
| assertThat(cfg.expandEmptyElements).isTrue(); | ||
| assertThat(cfg.spaceBeforeCloseEmptyElement).isTrue(); | ||
| assertThat(cfg.keepBlankLines).isFalse(); | ||
| assertThat(cfg.endWithNewline).isFalse(); | ||
| assertThat(cfg.indentBlankLines).isTrue(); | ||
| assertThat(cfg.indentSchemaLocation).isTrue(); | ||
| assertThat(cfg.quiet).isTrue(); | ||
| assertThat(cfg.sortProperties).isTrue(); | ||
| assertThat(cfg.sortModules).isTrue(); | ||
| assertThat(cfg.sortExecutions).isTrue(); | ||
| } | ||
|
|
||
| @Test | ||
| void testNumericFieldEdgeCases() { | ||
| SortPomCfg cfg = new SortPomCfg(); | ||
|
|
||
| // Test minimum value | ||
| cfg.nrOfIndentSpace = 0; | ||
| assertThat(cfg.nrOfIndentSpace).isZero(); | ||
|
|
||
| // Test negative value | ||
| cfg.nrOfIndentSpace = -1; | ||
| assertThat(cfg.nrOfIndentSpace).isNegative(); | ||
|
|
||
| // Test large value | ||
| cfg.nrOfIndentSpace = Integer.MAX_VALUE; | ||
| assertThat(cfg.nrOfIndentSpace).isEqualTo(Integer.MAX_VALUE); | ||
| } | ||
| } |
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
feature envy, reimplementing java.