1.16.0 (#440)

2021-11-01 v.1.16.0
------------------
* Prefer New: Dynamic Call with Parameters (#502)
* DB Access in UT: Global Inheritance (#500)
* DB Access in UT: Local Inheritance (#498)
* Skip 'Prefer RETURNING to EXPORTING' when both exist (#490)
* Pseudo Comment Usage: Multiple Inline Entries (#494)
* Prefer Pragmas to Pseudo Comments: Multiple Pseudo Comments (#489)
* Y_CHECK_MESSAGE_EASY_TO_FIND dump (#492)
* Chain Declaration for Complex Structures (#488)
* Empty Catch Alternative Pseudo Comment (#337)
+ Alternative Pseudo Comment (#486)
* line_exists does not support the operator IN (#484)
* Empty Catch: Test Double Framework (#483)
* Y_CHECK_FORM: Screen Events (#454)
* Magic Number: CASE SY-TABIX and CO NUMBERS (#480)
* Magic Number: Leading Zeros (#479)
* Prefer New to Create Object: Dynamic Type (#469)
* Magic Number: Table Index (#468)
* Use native *_wa variables (#474)
* Refactoring (#436,#452,#458)
* Cannot run unit tests on 752 (#461)
* Profiles: Allow Exemptions (#447)
* BAdI example class vs Percentage Comment (#443)
* Unit-Test Assert Validator (#450)
+ Prefer Pragmas to Pseudo Comments (#421)
+ COLLECT restriction (#441)
* RAP needs CREATE OBJECT ... FOR TESTING (#444)
* Filter functional operands in "Unit Test Assert" check (#460)

Author: lucasborin

Diff for: .cspell.json

@@ -51,7 +51,8 @@
     "msgid",
     "msgty",
     "msgno",
-    "UNDETEC"
+    "UNDETEC",
+    "SLIN"
   ],
   // flagWords - list of words to be always considered incorrect
   // This is useful for offensive words and common spelling errors.

Diff for: README.md

@@ -35,6 +35,7 @@ Together, we both support you in writing a clean ABAP code.
 
 - SAP NetWeaver **7.40 SP8** or higher
 - [abapGit](https://docs.abapgit.org/)
+- :new: [SAP Note 2527903 - Remote analysis (for check system)](https://launchpad.support.sap.com/#/notes/2527903)
 
 ## How-to Guides
 

Diff for: abaplint.json

@@ -37,7 +37,7 @@
     "check_include": true,
     "check_no_handler_pragma": true,
     "check_subrc": false,
-    "check_syntax": true,
+    "check_syntax": false,
     "check_text_elements": false,
     "check_transformation_exists": false,
     "class_attribute_names": false,
@@ -125,7 +125,7 @@
     "parser_702_chaining": false,
     "parser_error": true,
     "parser_missing_space": true,
-    "prefer_inline": false,
+    "prefer_inline": true,
     "prefer_is_not": true,
     "prefer_raise_exception_new": true,
     "prefer_returning_to_exporting": true,

Diff for: changelog.txt

@@ -1,16 +1,50 @@
 code-pal-for-abap changelog
 =================
 
+Dependencies
+------------------
+1. SAP Note 2527903 - Remote analysis (for check system)
+
+Upgrade Note
+------------------
+Whenever you upgrade code pal for ABAP, it is highly recommended to execute the Y_CI_CHECK_REGISTRATION report to activate/reactivate the Checks (SE38 transaction) and regenerate the respective Code Inspector Variant (SCI transaction)
+
 Legend
-------
+------------------
 * : fixed
 ! : changed
 + : added
 - : removed
 
-Upgrade Note
-------------------
-Whenever you upgrade code pal for ABAP, it is highly recommended to execute the Y_CI_CHECK_REGISTRATION report to activate/reactivate the Checks (SE38 transaction) and regenerate the respective Code Inspector Variant (SCI transaction)
+2021-11-01 v.1.16.0
+------------------
+* Prefer New: Dynamic Call with Parameters (#502)
+* DB Access in UT: Global Inheritance (#500)
+* DB Access in UT: Local Inheritance (#498)
+* Skip 'Prefer RETURNING to EXPORTING' when both exist (#490)
+* Pseudo Comment Usage: Multiple Inline Entries (#494)
+* Prefer Pragmas to Pseudo Comments: Multiple Pseudo Comments (#489)
+* Y_CHECK_MESSAGE_EASY_TO_FIND dump (#492)
+* Chain Declaration for Complex Structures (#488)
+* Empty Catch Alternative Pseudo Comment (#337)
++ Alternative Pseudo Comment (#486)
+* line_exists does not support the operator IN (#484)
+* Empty Catch: Test Double Framework (#483)
+* Y_CHECK_FORM: Screen Events (#454)
+* Magic Number: CASE SY-TABIX and CO NUMBERS (#480)
+* Magic Number: Leading Zeros (#479)
+* Prefer New to Create Object: Dynamic Type (#469)
+* Magic Number: Table Index (#468)
+* Use native *_wa variables (#474)
+* Refactoring (#436,#452,#458)
+* Cannot run unit tests on 752 (#461)
+* Profiles: Allow Exemptions (#447)
+* BAdI example class vs Percentage Comment (#443)
+* Unit-Test Assert Validator (#450)
++ Prefer Pragmas to Pseudo Comments (#421)
++ COLLECT restriction (#441)
+* RAP needs CREATE OBJECT ... FOR TESTING (#444)
+* Filter functional operands in "Unit Test Assert" check (#460)
 
 2021-08-12 v.1.15.0
 ------------------

Diff for: docs/check_documentation.md

@@ -10,6 +10,7 @@
 - [Chain Declaration Usage](checks/chain-declaration-usage.md)
 - [CHECK Statement Position](checks/check-statement-position.md)
 - [CHECK in LOOP](checks/check-in-loop.md)
+- [COLLECT restriction](checks/collect.md)
 - [Combination of Output Parameters](checks/method-output-parameter.md)
 - [Comment Position](checks/comment-position.md)
 - [Comment Type](checks/comment-type.md)
@@ -46,6 +47,7 @@
 - [Prefer IS NOT to NOT IS](checks/prefer-is-not-to-not-is.md)
 - [Prefer LINE_EXISTS or LINE_INDEX to READ TABLE or LOOP AT](checks/prefer-line-exists.md)
 - [Prefer NEW to CREATE OBJECT](checks/prefer-new-to-create-object.md)
+- [Prefer Pragma to Pseudo Comment](checks/prefer-pragmas-to-pseudo-comments.md)
 - [Pseudo Comment Usage](checks/pseudo-comment-usage.md)
 - [Omit Optional EXPORTING](checks/omit-optional-exporting.md)
 - [Optional Parameters](checks/optional-parameters.md)

Diff for: docs/checks/chain-declaration-usage.md

@@ -12,7 +12,7 @@ Change the chain up-front declarations to inline declarations.
 
 ### What to do in case of exception?
 
-In exceptional cases, you can suppress this finding by using the pseudo comment `"#EC CHAIN_DECL_USAG` which should be placed after the `DATA:` statement:
+In exceptional cases, you can suppress this finding by using the pseudo comment `"#EC CHAIN_DECL_USAG` which should be placed after the declaration statement:
 
 ```abap
   DATA: "#EC CHAIN_DECL_USAG
@@ -21,6 +21,18 @@ In exceptional cases, you can suppress this finding by using the pseudo comment
     client LIKE sy-mandt.
 ```
 
+```abap
+  TYPES: "#EC CHAIN_DECL_USAG
+    name TYPE string,
+    json TYPE REF TO cl_abap_json.
+```
+
+```abap
+  CONSTANTS: "#EC CHAIN_DECL_USAG
+    min_age TYPE i VALUE 18,
+    min_name_size TYPE i VALUE 3.
+```
+
 ### Example
 
 Before the check:

Diff for: docs/checks/collect.md

@@ -0,0 +1,41 @@
+[code pal for ABAP](../../README.md) > [Documentation](../check_documentation.md) > [COLLECT restriction](collect.md)
+
+## COLLECT restriction
+
+### What is the Intent of the Check?
+
+The [ABAP - Keyword Documentation](https://help.sap.com/doc/abapdocu_755_index_htm/7.55/en-US/abencollect_guidl.htm?file=abencollect_guidl.htm) says:
+> **Rule**
+>
+> Do not fill standard tables with collections of lines
+> 
+> Only use the statement COLLECT for hashed tables or sorted tables with a unique key. Do not use it any more for standard tables.
+> 
+> **Details**
+>
+> The statement COLLECT is based on unique entries with respect to the primary key and stable key administration. This means that not all categories of internal tables are suitable for COLLECT:
+>
+> * If the statement COLLECT is applied to a standard table, this table first needs its own internal hash administration. Change operations on the table can invalidate this temporary hash administration. After a change operation of this type, the following COLLECT statements must resort to a linear search, which can affect performance considerably. The primary key of a standard table is also never unique.
+> * COLLECT can be used for sorted tables and hashed tables without any problems since these, unlike standard tables, always have a separate, stable key administration that can be utilized by COLLECT. COLLECT can work properly for sorted tables only if the primary key is unique. If a sorted table has a non-unique key, only COLLECT can be used to fill the table, which is difficult to guarantee. In hashed tables, the key values are always unique.
+
+### How does the check work?
+
+It searches for `COLLECT` in:
+* Internal tables typed as `SORTED TABLE` with `NON-UNIQUE KEY`;
+* Internal tables typed as `STANDARD TABLE`;
+
+### How to solve the issue?
+
+Change the internal table to `SORTED` or `HASHED` as recommended, or perform the collection manually.   
+
+### What to do in case of exception?
+
+In exceptional cases, you can suppress this finding by using the pseudo comment `“#EC COLLECT` which should be placed after the `COLLECT` statement: 
+
+```abap
+  COLLECT entry INTO table. "#EC COLLECT
+```
+
+### Further Readings & Knowledge
+
+* [ABAP - Keyword Documentation](https://help.sap.com/doc/abapdocu_755_index_htm/7.55/en-US/abencollect_guidl.htm?file=abencollect_guidl.htm)

Diff for: docs/checks/empty-catch.md

@@ -12,14 +12,28 @@ Fill the `CATCH` block with an exception handling.
 
 ### What to do in case of exception?
 
-In exceptional cases, you can suppress this finding by using the pseudo comment `"#EC EMPTY_CATCH` which should to be placed after the opening statement of the empty `CATCH`:
+In exceptional cases, you can suppress this finding by using the pseudo comment `"#EC EMPTY_CATCH` or `"#EC NO_HANDLER` which should to be placed after the opening statement of the empty `CATCH`:
 
 ```abap
 TRY.
 "some code
 CATCH cx_error. "#EC EMPTY_CATCH
 ENDTRY.
+```
 
+```abap
 CATCH SYSTEM-EXCEPTIONS. "#EC EMPTY_CATCH
 ENDCATCH.
 ```
+
+```abap
+TRY.
+"some code
+CATCH cx_error. "#EC NO_HANDLER
+ENDTRY.
+```
+
+```abap
+CATCH SYSTEM-EXCEPTIONS. "#EC NO_HANDLER
+ENDCATCH.
+```

Diff for: docs/checks/prefer-pragmas-to-pseudo-comments.md

@@ -0,0 +1,39 @@
+[code pal for ABAP](../../README.md) > [Documentation](../check_documentation.md) > [Prefer Pragmas to Pseudo Comments](prefer-pragmas-to-pseudo-comments.md)
+
+## Prefer Pragmas to Pseudo Comments
+
+### What is the Intent of the Check?
+
+Based on the [Clean ABAP](https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-pragmas-to-pseudo-comments):
+> Prefer pragmas to pseudo comments to suppress irrelevant warnings and errors identified by the ATC. Pseudo comments have mostly become obsolete and have been replaced by pragmas
+
+:bulb: Only the Pseudo Comments and Pragmas available in the `SLIN_DESC` table are in scope.
+
+:wan: Code Pal does not support Pragmas.
+
+### How to solve the issue?
+
+Change the `"#EC ` (Pseudo Comment) to `##` (Pragma).
+
+### What to do in case of exception?
+
+This Check cannot be exempt.
+
+### Example
+
+Before the check:
+
+```abap
+  DATA a TYPE string.   "#EC NEEDED
+```
+
+After the check:
+
+```abap
+  DATA a TYPE string.   ##NEEDED
+```
+
+### Further Readings & Knowledge
+
+* [Clean ABAP: Prefer pragmas to pseudo comments](https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-pragmas-to-pseudo-comments)
+* [ABAP - Keyword Documentation: Pseudo Comments for the Extended Program Check](https://help.sap.com/doc/abapdocu_752_index_htm/7.52/en-US/abenpseudo_comment_slin.htm)

Diff for: src/checks/y_check_boolean_input_param.clas.abap

@@ -40,14 +40,10 @@ CLASS y_check_boolean_input_param IMPLEMENTATION.
 
     DATA(configuration) = detect_check_configuration( statement ).
 
-    IF configuration IS INITIAL.
-      RETURN.
-    ENDIF.
-
     raise_error( statement_level = statement-level
                  statement_index = index
-                 statement_from  = statement-from
-                 error_priority  = configuration-prio ).
+                 statement_from = statement-from
+                 check_configuration = configuration ).
 
   ENDMETHOD.
 
@@ -60,7 +56,7 @@ CLASS y_check_boolean_input_param IMPLEMENTATION.
 
   METHOD has_boolean_input_param.
     DATA(skip) = abap_true.
-    LOOP AT ref_scan_manager->tokens ASSIGNING FIELD-SYMBOL(<token>)
+    LOOP AT ref_scan->tokens ASSIGNING FIELD-SYMBOL(<token>)
     FROM statement-from TO statement-to.
 
       IF <token>-str = 'IMPORTING'.

Diff for: src/checks/y_check_branch_coverage.clas.abap

@@ -30,7 +30,6 @@ CLASS y_check_branch_coverage IMPLEMENTATION.
 
 
   METHOD execute_check.
-
     TRY.
         DATA(coverage) = y_unit_test_coverage=>get( program_name = program_name
                                                     object = VALUE #( object = object_type obj_name = object_name )
@@ -42,22 +41,23 @@ CLASS y_check_branch_coverage IMPLEMENTATION.
         RETURN.
     ENDTRY.
 
-    DATA(check_configuration) = detect_check_configuration( error_count = CONV #( branch )
-                                                            statement = VALUE #( level = 1 ) ).
+    TRY.
+        DATA(first_statement) = ref_scan->statements[ 1 ].
+      CATCH cx_sy_itab_line_not_found.
+        RETURN.
+    ENDTRY.
 
-    IF check_configuration IS INITIAL.
-      RETURN.
-    ENDIF.
+    DATA(check_configuration) = detect_check_configuration( error_count = CONV #( branch )
+                                                            statement = first_statement ).
 
-    raise_error( statement_level = 1
-                 statement_index = 1
-                 statement_from = 1
-                 error_priority = check_configuration-prio
+    raise_error( statement_level = first_statement-level
+                 statement_index = first_statement-from
+                 statement_from = first_statement-from
+                 check_configuration = check_configuration
                  parameter_01 = |{ branch }|
                  parameter_02 = |{ check_configuration-threshold }|
                  parameter_03 = |{ coverage->get_total( ) }|
                  parameter_04 = |{ coverage->get_executed( ) }| ).
-
   ENDMETHOD.
 
 

Diff for: src/checks/y_check_call_method_usage.clas.abap

@@ -35,16 +35,14 @@ CLASS y_check_call_method_usage IMPLEMENTATION.
                              OR token CP '*)=>*'
                              OR token CP '(*)' ).
 
-    DATA(check_configuration) = detect_check_configuration( statement ).
-
-    IF check_configuration IS NOT INITIAL
-      AND has_keyword = abap_true
-      AND is_dynamic = abap_false.
-
-      raise_error( statement_level     = statement-level
-                   statement_index     = index
-                   statement_from      = statement-from
-                   error_priority      = check_configuration-prio ).
+    IF has_keyword = abap_true
+    AND is_dynamic = abap_false.
+      DATA(check_configuration) = detect_check_configuration( statement ).
+
+      raise_error( statement_level  = statement-level
+                   statement_index = index
+                   statement_from = statement-from
+                   check_configuration = check_configuration ).
     ENDIF.
   ENDMETHOD.