fix AlignDeclarationsRule for complex table types (#129)

Author: jmgrassau

com.sap.adt.abapcleaner/src/com/sap/adt/abapcleaner/rules/alignment/AlignDeclarationsRule.java

@@ -563,17 +563,22 @@ private Token readDeclarationLine(AlignLine line, Token token, int additionalInd
 		Token typeEnd = token;
 		while (typeEnd != null && !typeEnd.isAnyKeyword("LENGTH", "DECIMALS", "VALUE", "READ-ONLY") && !typeEnd.textEqualsAny(".", ",")) {
 			// do not align table declarations with "WITH ... KEY ..." sections, because they usually should not be put on a single line; 
-			// however, do accept the short cases of "WITH EMPTY KEY" and "WITH [UNIQUE | NON-UNIQUE] DEFAULT KEY" and "WITH [UNIQUE | NON-UNIQUE] KEY comp1" 
-			if (typeEnd.isKeyword("WITH") 
+			// however, do accept the short cases of "WITH EMPTY KEY" and "WITH [UNIQUE | NON-UNIQUE] DEFAULT KEY" and "WITH [UNIQUE | NON-UNIQUE] KEY comp1 [comp2 [comp3]]" 
+			if (typeEnd.isKeyword("ASSOCIATION") 
+			 || typeEnd.isKeyword("WITH") 
 					&& !typeEnd.matchesOnSiblings(true, "WITH", "EMPTY", "KEY") 
 					&& !typeEnd.matchesOnSiblings(true, "WITH", TokenSearch.makeOptional("UNIQUE|NON-UNIQUE"), "DEFAULT", "KEY")
 					&& !typeEnd.matchesOnSiblings(true, "WITH", TokenSearch.makeOptional("UNIQUE|NON-UNIQUE"), "KEY", TokenSearch.ANY_IDENTIFIER, ",|.")) {
-				return null;
+				
+				// for more complex cases (with multiple components, multiple WITH key definitions, or ASSOCIATIONs) 
+				// only align up to (but excluding) "WITH" or "ASSOCIATION", thus leaving the WITH or ASSOCIATION section(s) unchanged 
+				// and keeping possible line breaks as well as manual alignment
+				Term typeInfo = Term.createForTokenRange(typeStart, typeEnd.getPrev());
+				line.setCell(Columns.TYPE.getValue(), new AlignCellTerm(typeInfo));
+				return typeEnd.getLastTokenOnSiblings(true, TokenSearch.ASTERISK, ".|,");
 			}
 			typeEnd = typeEnd.getNextSibling();
 		}
-		if (typeEnd == null)
-			return null;
 		Term typeInfo = Term.createForTokenRange(typeStart, typeEnd.getPrev());
 		line.setCell(Columns.TYPE.getValue(), new AlignCellTerm(typeInfo));
 		token = typeEnd;

test/com.sap.adt.abapcleaner.test/src/com/sap/adt/abapcleaner/rules/alignment/AlignDeclarationsTest.java

@@ -681,17 +681,47 @@ void testDataBeginOfNested() {
 	}
 
 	@Test
-	void testTableDeclarationWithKey() {
-		// ensure that table declarations with "WITH ... KEY ..." sections are not aligned (except for very simply cases 
-		// with just one component), because they usually should not be put on a single line
+	void testTableDeclarationWithKeyOf3Components() {
+		// ensure that in table declarations with more than one component in the "WITH" section, 
+		// the "WITH ..." part is kept unchanged, but everything else is aligned
 
 		buildSrc("    DATA:");
 		buildSrc("      lt_item     TYPE ty_tt_item,");
 		buildSrc("      lts_buffer      TYPE SORTED TABLE OF ty_s_buffer");
 		buildSrc("                            WITH NON-UNIQUE KEY comp1 comp2 comp3,");
 		buildSrc("      lv_index         TYPE i.");
 
-		copyExpFromSrc();
+		buildExp("    DATA:");
+		buildExp("      lt_item    TYPE ty_tt_item,");
+		buildExp("      lts_buffer TYPE SORTED TABLE OF ty_s_buffer");
+		buildExp("                            WITH NON-UNIQUE KEY comp1 comp2 comp3,");
+		buildExp("      lv_index   TYPE i.");
+
+		putAnyMethodAroundSrcAndExp();
+
+		testRule();
+	}
+
+	@Test
+	void testTableDeclarationWithMultiKey() {
+		// ensure that in table declarations with multiple "WITH ... KEY ..." sections, the "WITH ..." part is kept unchanged, 
+		// but everything else is aligned
+		
+		buildSrc("    DATA:");
+		buildSrc("      lt_item     TYPE ty_tt_item,");
+		buildSrc("      lts_buffer      TYPE SORTED TABLE OF ty_s_buffer");
+		buildSrc("                    WITH NON-UNIQUE KEY comp1 comp2 comp3");
+		buildSrc("                    WITH UNIQUE KEY key_name COMPONENTS comp1 comp2");
+		buildSrc("                                                        comp3 comp4,");
+		buildSrc("      lv_index         TYPE i.");
+
+		buildExp("    DATA:");
+		buildExp("      lt_item    TYPE ty_tt_item,");
+		buildExp("      lts_buffer TYPE SORTED TABLE OF ty_s_buffer");
+		buildExp("                    WITH NON-UNIQUE KEY comp1 comp2 comp3");
+		buildExp("                    WITH UNIQUE KEY key_name COMPONENTS comp1 comp2");
+		buildExp("                                                        comp3 comp4,");
+		buildExp("      lv_index   TYPE i.");
 
 		putAnyMethodAroundSrcAndExp();
 
@@ -1556,4 +1586,5 @@ void testMoveOverlengthValuesBelowNameOrTypeAlignNameOnly() {
 
 		testRule();
 	}
+
 }