Merge pull request #253 from Trivadis/bugfix/issue-249-format-globals-in-package-spec

Align contants and variables in package spec

Author: PhilippSalvisberg

settings/sql_developer/trivadis_custom_format.arbori

@@ -3666,6 +3666,16 @@ o8_declarations:
     var datatypes = new HashMap();
 }
 
+o8_package_variables:
+      [scope) pkg_spec
+    & [name) decl_id
+    & [parent) basic_d
+    & name = node-1
+    & scope < name^
+    & parent = name^
+    & [parent = [name
+;
+
 o8_variables:
       [scope) decl_list
     & [name) decl_id
@@ -3702,7 +3712,8 @@ o8_external_params:
 ;
 
 o8_find_type_declarations:
-      o8_variables
+      o8_package_variables
+    | o8_variables
     | o8_records
     | o8_attributes
     | o8_external_params
@@ -3746,6 +3757,20 @@ o4_declarations:
     var assignmentsWithValue = new HashMap();
 }
 
+o4_package_spec:
+      [scope) pkg_spec
+    & [node) default_expr_opt
+    & scope < node
+;
+
+o4_function_in_package_spec:
+      [scope) pkg_spec
+    & [func) fml_part
+    & [node) default_expr_opt
+    & func < node
+    & scope < func
+;
+
 o4_declare_section:
       [scope) decl_list
     & [node) default_expr_opt
@@ -3767,7 +3792,8 @@ o4_function:
 ;
 
 o4_find_assignments:
-      (o4_declare_section - o4_function_in_declare_section)
+      (o4_package_spec - o4_function_in_package_spec)
+    | (o4_declare_section - o4_function_in_declare_section)
     | o4_function
 -> {
     if (alignAssignments) {

standalone/src/test/java/com/trivadis/plsql/formatter/settings/tests/issues/Issue_249_globals_in_package_spec.java

@@ -0,0 +1,125 @@
+package com.trivadis.plsql.formatter.settings.tests.issues;
+
+import com.trivadis.plsql.formatter.settings.ConfiguredTestFormatter;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.TestInstance;
+
+import java.io.IOException;
+
+@TestInstance(TestInstance.Lifecycle.PER_CLASS)
+public class Issue_249_globals_in_package_spec extends ConfiguredTestFormatter {
+    @Test
+    public void constants_only() throws IOException {
+        var input = """
+                create or replace package x as
+                   co_aaaa constant char := 'a';
+                   co_b constant char := 'b';
+                   co_cccccccccc constant char := 'c';
+                end;
+                /
+                create or replace package body x as
+                   co_aaaa constant char := 'a';
+                   co_b constant char := 'b';
+                   co_cccccccccc constant char := 'c';
+                end;
+                /
+                """;
+        var expected = """
+                create or replace package x as
+                   co_aaaa       constant char := 'a';
+                   co_b          constant char := 'b';
+                   co_cccccccccc constant char := 'c';
+                end;
+                /
+                create or replace package body x as
+                   co_aaaa       constant char := 'a';
+                   co_b          constant char := 'b';
+                   co_cccccccccc constant char := 'c';
+                end;
+                /
+                """;
+        var actual = getFormatter().format(input);
+        assertEquals(expected, actual);
+    }
+
+    @Test
+    public void variables_only() throws IOException {
+        var input = """
+                create or replace package x as
+                   l_aaaa char := 'a';
+                   l_b char := 'b';
+                   l_cccccccccc char := 'c';
+                end;
+                /
+                create or replace package body x as
+                   l_aaaa char := 'a';
+                   l_b char := 'b';
+                   l_cccccccccc char := 'c';
+                end;
+                /
+                """;
+        var expected = """
+                create or replace package x as
+                   l_aaaa       char := 'a';
+                   l_b          char := 'b';
+                   l_cccccccccc char := 'c';
+                end;
+                /
+                create or replace package body x as
+                   l_aaaa       char := 'a';
+                   l_b          char := 'b';
+                   l_cccccccccc char := 'c';
+                end;
+                /
+
+                """;
+        var actual = getFormatter().format(input);
+        assertEquals(expected, actual);
+    }
+
+    @Test
+    public void constants_and_variables() throws IOException {
+        var input = """
+                create or replace package x as
+                   co_aaaa constant char := 'a';
+                   co_b constant char := 'b';
+                   co_cccccccccc constant char := 'c';
+                   l_aaaa char := 'a';
+                   l_b char := 'b';
+                   l_cccccccccc char := 'c';
+                end;
+                /
+                create or replace package body x as
+                   co_aaaa constant char := 'a';
+                   co_b constant char := 'b';
+                   co_cccccccccc constant char := 'c';
+                   l_aaaa char := 'a';
+                   l_b char := 'b';
+                   l_cccccccccc char := 'c';
+                end;
+                /
+                """;
+        var expected = """
+                create or replace package x as
+                   co_aaaa       constant char := 'a';
+                   co_b          constant char := 'b';
+                   co_cccccccccc constant char := 'c';
+                   l_aaaa        char          := 'a';
+                   l_b           char          := 'b';
+                   l_cccccccccc  char          := 'c';
+                end;
+                /
+                create or replace package body x as
+                   co_aaaa       constant char := 'a';
+                   co_b          constant char := 'b';
+                   co_cccccccccc constant char := 'c';
+                   l_aaaa        char          := 'a';
+                   l_b           char          := 'b';
+                   l_cccccccccc  char          := 'c';
+                end;
+                /
+                """;
+        var actual = getFormatter().format(input);
+        assertEquals(expected, actual);
+    }
+}