Merge pull request #265 from SAP/1.10.0

Version 1.10.0

Author: lucasborin

changelog.txt

@@ -8,6 +8,26 @@ Legend
 + : 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)
+
+2020-12-XX v1.10.0
+------------------
++ New Check: Scope of the Variable (#276)
+* Comment position when code has pseudo comments (#282)
+* Y_CHECK_STATEMENT_POSITION: before DATA declarations (#272)
++ 'was' and 'were' as a method which returns boolean (#275)
+! DB Access in UT has distinct behavior depending on test risk level (#267)
+! Prefer Case to ElseIf is now reporting single conditions only (#262)
+! Chain Declaration check is now warning by default (#266)
++ abapLint app integration in GitHub (#264)
++ API regression reports 'maintain attributes..." message (#259)
++ API improvements (#259)
+* Missing space between string or character literal and parentheses (#253)
+* Broken UTs (#251)
+* Constants in Interface (#244) 
+
 2020-11-23 v1.09.0
 ------------------
 + deprecated classes/interfaces check

docs/check_documentation.md

@@ -17,7 +17,6 @@
 - [Cyclomatic Complexity](checks/cyclomatic-complexity.md)
 - [CX_ROOT Usage](checks/cx-root-usage.md)
 - [Database Access in Unit-Test](checks/db-access-in-ut.md)
-- [Declaration in IF](checks/declaration-in-if.md)
 - [Deprecated Classes](checks/deprecated-classes.md)
 - [Deprecated Key Word](checks/deprecated-key-word.md)
 - [Empty Catch](checks/empty_catch.md)
@@ -47,6 +46,7 @@
 - [READ TABLE with Subsequent Memory Assignment](checks/sub-assign-read-table.md)
 - [RECEIVING Statement Usage](checks/receiving-usage.md)
 - [Returning Name](checks/returning-name.md)
+- [Scope of Variable](checks/scope-of-variable.md)
 - [Self-Reference](checks/self-reference.md)
 - [TEST-SEAM Statement Usage](checks/test-seam-usage.md)
 - [Unit-Test Coverages (Statement, Branch and Procedure)](checks/unit-test-coverages.md)

docs/checks/check-statement-position.md

@@ -5,15 +5,13 @@
 ## CHECK Statement Position Check
 
 ### What is the Intent of the Check?
-The "Check Statement Position" verifies whether the `CHECK` statement is in the first position (first statement) within a method, function-module or form-routine.  
-Do not use `CHECK` outside of the initialization section of a method. The statement behaves differently in different positions and may lead to unclear, unexpected effects.
+It verifies whether the `CHECK` statement is the first statement within a method, function-module, or form-routine.  
 
-### Which attributes can be maintained?
-![Attributes](./imgs/check_statement_position.png)
+The [Clean ABAP](https://github.com/SAP/styleguides/blob/master/clean-abap/CleanABAP.md#avoid-check-in-other-positions) says:
+> Do not use `CHECK` outside of the initialization section of a method. The statement behaves differently in different positions and may lead to unclear, unexpected effects.
 
 ### How to solve the issue?
-The `CHECK` statement shall be the first statement of a method (suggested even before any DATA declaration);  
-If not, try to substitute this keyword by an IF-statement instead.
+The `CHECK` statement shall be the first statement of a method. If it is not possible, try to substitute this keyword with an IF-statement instead.
 
 ### What to do in case of exception?
 In special cases you can suppress this finding by using the pseudo comment `"#EC CHECK_POSITION`.
@@ -43,7 +41,7 @@ METHOD example.
   CHECK sy-mandt = 000.
   ...
 ENDMETHOD.
-```
+``` 
 
 ### Further Readings & Knowledge
 - [Avoid CHECK in other positions (Clean ABAP)](https://github.com/SAP/styleguides/blob/master/clean-abap/CleanABAP.md#avoid-check-in-other-positions)

docs/checks/declaration-in-if.md

@@ -22,6 +22,8 @@ The check searches for methods with a boolean returning value and then verifies
 * `ends_`
 * `must_`
 * `should_`
+* `was_`
+* `were_`
 
 or if the name contains one of the following words:
 

docs/checks/imgs/check_statement_position.png

@@ -0,0 +1,51 @@
+# code pal for ABAP
+
+[code pal for ABAP](../../README.md) > [Documentation](../check_documentation.md) > [Scope of Variable](scope-of-variable.md)
+
+## Scope of Variable
+
+### What is the Intent of the Check?
+If a variable is declared in a statement, it should be used/referred to inside this statement only (not outside).
+
+### How does the check work?
+It searches for `DATA` and `FIELD-SYMBOLS` declaration inside of `IF`, `ELSEIF`, `ELSE`, `DO`, `CASE/WHEN`, `LOOP`, and `WHILE` statements, and for its usage/reference outside this statement.
+
+### How to solve the issue?
+Relocate the declaration.
+
+### What to do in case of exception?
+You can suppress Code Inspector findings generated by this check using the pseudo comment `"#EC SCOPE_OF_VAR`.   
+The pseudo comment must be placed right after the variable usage/referece.
+
+```abap
+IF has_entries = abap_true.
+  DATA(value) = 1.
+ELSE.
+  value = 2. "#EC SCOPE_OF_VAR
+ENDIF.
+```
+
+### Example
+
+Before:
+```abap
+IF has_entries = abap_true.
+  DATA(value) = 1.
+ELSE.
+  value = 2.
+ENDIF.
+```
+
+After:
+```abap
+DATA value TYPE i.
+
+IF has_entries = abap_true.
+  value = 1.
+ELSE.
+  value = 2.
+ENDIF.
+```
+
+### Further Readings & Knowledge
+* [ABAP Styleguides on Clean Code](https://github.com/SAP/styleguides/blob/master/clean-abap/CleanABAP.md#dont-declare-inline-in-optional-branches)

docs/checks/imgs/declaration_in_if.png

@@ -19,6 +19,7 @@ CLASS Y_CHECK_CHAIN_DECL_USAGE IMPLEMENTATION.
     settings-pseudo_comment = '"#EC CHAIN_DECL_USAG' ##NO_TEXT.
     settings-disable_threshold_selection = abap_true.
     settings-threshold = 0.
+    settings-prio = c_warning.
     settings-documentation = |{ c_docs_path-checks }chain-declaration-usage.md|.
 
     set_check_message( 'Do not chain up-front declarations!' ).

docs/checks/method-return-bool.md

@@ -4,19 +4,24 @@ CLASS y_check_check_stmnt_position DEFINITION PUBLIC INHERITING FROM y_check_bas
 
   PROTECTED SECTION.
     METHODS inspect_tokens REDEFINITION.
-    METHODS execute_check REDEFINITION.
 
   PRIVATE SECTION.
-    DATA statement_index TYPE i VALUE 0 ##NO_TEXT.
+    METHODS is_not_relevant_token IMPORTING token         TYPE string
+                                  RETURNING VALUE(result) TYPE abap_bool.
 
-    METHODS is_token_excluded IMPORTING token_str    TYPE stokesx-str
-                              RETURNING VALUE(result) TYPE abap_bool.
+    METHODS has_wrong_position IMPORTING structure     TYPE sstruc
+                                         check         TYPE sstmnt
+                               RETURNING VALUE(result) TYPE abap_bool.
+
+    METHODS is_check_in_loop IMPORTING structure     TYPE sstruc
+                                       check         TYPE sstmnt
+                             RETURNING VALUE(result) TYPE abap_bool.
 
 ENDCLASS.
 
 
 
-CLASS Y_CHECK_CHECK_STMNT_POSITION IMPLEMENTATION.
+CLASS y_check_check_stmnt_position IMPLEMENTATION.
 
 
   METHOD constructor.
@@ -31,82 +36,63 @@ CLASS Y_CHECK_CHECK_STMNT_POSITION IMPLEMENTATION.
   ENDMETHOD.
 
 
-  METHOD execute_check.
-    LOOP AT ref_scan_manager->get_structures( ) ASSIGNING FIELD-SYMBOL(<structure>)
-      WHERE stmnt_type EQ scan_struc_stmnt_type-form
-         OR stmnt_type EQ scan_struc_stmnt_type-method
-         OR stmnt_type EQ scan_struc_stmnt_type-function
-         OR stmnt_type EQ scan_struc_stmnt_type-module
-         OR type EQ scan_struc_type-event.
-
-      is_testcode = test_code_detector->is_testcode( <structure> ).
+  METHOD inspect_tokens.
+    CHECK get_token_abs( statement-from ) = 'CHECK'.
 
-      TRY.
-          DATA(check_configuration) = check_configurations[ apply_on_testcode = abap_true ].
-        CATCH cx_sy_itab_line_not_found.
-          IF is_testcode EQ abap_true.
-            CONTINUE.
-          ENDIF.
-      ENDTRY.
+    CHECK has_wrong_position( structure = structure
+                              check = statement ) = abap_true.
 
-      DATA(index) = <structure>-stmnt_from.
-      statement_index = 0.
+    CHECK is_check_in_loop( structure = structure
+                            check = statement ) = abap_false.
 
-      LOOP AT ref_scan_manager->get_statements( ) ASSIGNING FIELD-SYMBOL(<statement>)
-        FROM <structure>-stmnt_from TO <structure>-stmnt_to.
+    DATA(check_configuration) = detect_check_configuration( statement ).
 
-        inspect_tokens( index = index
-                        statement = <statement> ).
+    IF check_configuration IS INITIAL.
+      RETURN.
+    ENDIF.
 
-        index = index + 1.
-      ENDLOOP.
-    ENDLOOP.
+    raise_error( statement_level     = statement-level
+                 statement_index     = index
+                 statement_from      = statement-from
+                 error_priority      = check_configuration-prio ).
   ENDMETHOD.
 
 
-  METHOD inspect_tokens.
-    LOOP AT ref_scan_manager->get_tokens( ) ASSIGNING FIELD-SYMBOL(<token>)
-      FROM statement-from TO statement-from
-      WHERE type NE scan_token_type-comment AND
-            type NE scan_token_type-pragma.
-      IF is_token_excluded( <token>-str ) EQ abap_true.
-        RETURN.
-      ENDIF.
-    ENDLOOP.
-    IF sy-subrc NE 0.
-      RETURN.
-    ENDIF.
-
-    statement_index = statement_index + 1.
+  METHOD is_not_relevant_token.
+    result = xsdbool(    token EQ 'METHOD'
+                      OR token EQ 'FORM'
+                      OR token EQ 'FUNCTION'
+                      OR token EQ 'MODULE'
+                      OR token EQ 'DATA'
+                      OR token EQ 'TYPES'
+                      OR token EQ 'CHECK'
+                      OR token EQ 'FIELD-SYMBOLS' ).
+  ENDMETHOD.
 
-    IF statement_index GT 1
-    AND get_token_abs( statement-from ) = 'CHECK'.
 
-      DATA(check_configuration) = detect_check_configuration( statement ). "#EC DECL_IN_IF
+  METHOD has_wrong_position.
+    DATA(statements) = ref_scan_manager->get_statements( ).
 
-      IF check_configuration IS INITIAL.
+    LOOP AT ref_scan_manager->get_statements( ) ASSIGNING FIELD-SYMBOL(<statement>)
+    FROM structure-stmnt_from TO structure-stmnt_to.
+      IF <statement>-number = check-number.
         RETURN.
       ENDIF.
-
-      raise_error( statement_level     = statement-level
-                   statement_index     = index
-                   statement_from      = statement-from
-                   error_priority      = check_configuration-prio ).
-    ENDIF.
+      IF is_not_relevant_token( get_token_abs( <statement>-from ) ) = abap_false.
+        result = abap_true.
+        RETURN.
+      ENDIF.
+    ENDLOOP.
   ENDMETHOD.
 
 
-  METHOD is_token_excluded.
-    result = xsdbool( token_str EQ 'METHOD' OR
-                      token_str EQ 'FORM' OR
-                      token_str EQ 'FUNCTION' OR
-                      token_str EQ 'MODULE' OR
-                      token_str EQ 'DATA' OR
-                      token_str EQ 'TYPES' OR
-                      token_str CP 'DATA(*)' OR
-                      token_str CP 'LOOP' OR
-                      ( token_str EQ 'CHECK' AND statement_index EQ 0 ) ).
+  METHOD is_check_in_loop.
+    LOOP AT ref_scan_manager->get_tokens( ) ASSIGNING FIELD-SYMBOL(<token>)
+    FROM structure-stmnt_from TO check-from
+    WHERE str = 'LOOP'
+    OR str = 'ENDLOOP'.
+      result = xsdbool( <token>-str = 'LOOP' ).
+    ENDLOOP.
   ENDMETHOD.
 
-
 ENDCLASS.