Refactoring Code Pal

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
 

abaplint.json

@@ -114,7 +114,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,

changelog.txt

@@ -1,19 +1,24 @@
 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-08-XX v.1.16.0
 ------------------
+* Refactoring (#436,#452,#458)
 * Cannot run unit tests on 752 (#461)
 * Profiles: Allow Exemptions (#447)
 * BAdI example class vs Percentage Comment (#443)

src/checks/y_check_boolean_input_param.clas.abap

@@ -56,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'.

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,18 +41,23 @@ CLASS y_check_branch_coverage IMPLEMENTATION.
         RETURN.
     ENDTRY.
 
+    TRY.
+        DATA(first_statement) = ref_scan->statements[ 1 ].
+      CATCH cx_sy_itab_line_not_found.
+        RETURN.
+    ENDTRY.
+
     DATA(check_configuration) = detect_check_configuration( error_count = CONV #( branch )
-                                                            statement = VALUE #( level = 1 ) ).
+                                                            statement = first_statement ).
 
-    raise_error( statement_level = 1
-                 statement_index = 1
-                 statement_from = 1
+    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.
 
 

src/checks/y_check_chain_decl_usage.clas.abap

@@ -6,9 +6,12 @@ CLASS y_check_chain_decl_usage DEFINITION PUBLIC INHERITING FROM y_check_base CR
     METHODS inspect_tokens REDEFINITION.
 
   PRIVATE SECTION.
-    DATA rows_with_colon TYPE STANDARD TABLE OF stmnt_crow.
+    TYPES: BEGIN OF ty_raised_issues,
+             include TYPE slevel-name,
+             line_number_colon TYPE sstmnt-colonrow,
+           END OF ty_raised_issues.
 
-    METHODS has_error_not_raised_yet IMPORTING statement TYPE sstmnt RETURNING VALUE(result) TYPE abap_bool.
+    DATA raised_issues TYPE TABLE OF ty_raised_issues.
 
 ENDCLASS.
 
@@ -30,26 +33,28 @@ CLASS Y_CHECK_CHAIN_DECL_USAGE IMPLEMENTATION.
 
 
   METHOD inspect_tokens.
-
     CHECK statement-colonrow IS NOT INITIAL.
     CHECK statement-terminator = ','.
     CHECK get_token_abs( statement-from ) = 'DATA'.
-    CHECK has_error_not_raised_yet( statement ).
 
-    APPEND statement-colonrow TO rows_with_colon.
+    DATA(include) = get_include( p_level = statement-level ).
+
+    DATA(raised_issue) = VALUE ty_raised_issues( include = include
+                                                 line_number_colon = statement-colonrow ).
+
+    IF line_exists( raised_issues[ include           = raised_issue-include
+                                   line_number_colon = raised_issue-line_number_colon ] ).
+      RETURN.
+    ENDIF.
+
+    APPEND raised_issue TO raised_issues.
 
     DATA(configuration) = detect_check_configuration( statement ).
 
     raise_error( statement_level = statement-level
                  statement_index = index
                  statement_from = statement-from
                  check_configuration = configuration ).
-
-  ENDMETHOD.
-
-
-  METHOD has_error_not_raised_yet.
-    result = xsdbool( NOT line_exists( rows_with_colon[ table_line = statement-colonrow ] ) ).
   ENDMETHOD.
 
 

src/checks/y_check_check_in_loop.clas.abap

@@ -46,8 +46,8 @@ CLASS y_check_check_in_loop IMPLEMENTATION.
 
   METHOD get_back_statement.
     TRY.
-        DATA(back_structure) = ref_scan_manager->structures[ structure-back ].
-        result = ref_scan_manager->statements[ back_structure-stmnt_from ].
+        DATA(back_structure) = ref_scan->structures[ structure-back ].
+        result = ref_scan->statements[ back_structure-stmnt_from ].
       CATCH cx_sy_itab_line_not_found.
         CLEAR result.
     ENDTRY.

src/checks/y_check_check_stmnt_position.clas.abap

@@ -68,7 +68,7 @@ CLASS y_check_check_stmnt_position IMPLEMENTATION.
 
 
   METHOD has_wrong_position.
-    LOOP AT ref_scan_manager->statements ASSIGNING FIELD-SYMBOL(<statement>)
+    LOOP AT ref_scan->statements ASSIGNING FIELD-SYMBOL(<statement>)
     FROM structure-stmnt_from TO structure-stmnt_to.
       IF <statement>-type = scan_stmnt_type-empty
       OR <statement>-type = scan_stmnt_type-comment
@@ -89,8 +89,10 @@ CLASS y_check_check_stmnt_position IMPLEMENTATION.
 
 
   METHOD is_check_in_loop.
-    LOOP AT ref_scan_manager->tokens ASSIGNING FIELD-SYMBOL(<token>)
-    FROM structure-stmnt_from TO check-from
+    DATA(scope) = ref_scan->statements[ structure-stmnt_from ].
+
+    LOOP AT ref_scan->tokens ASSIGNING FIELD-SYMBOL(<token>)
+    FROM scope-from TO check-from
     WHERE str = 'LOOP'
     OR str = 'ENDLOOP'.
       result = xsdbool( <token>-str = 'LOOP' ).

src/checks/y_check_collect.clas.abap

@@ -23,7 +23,7 @@ ENDCLASS.
 
 
 
-CLASS y_check_collect IMPLEMENTATION.
+CLASS Y_CHECK_COLLECT IMPLEMENTATION.
 
 
   METHOD constructor.
@@ -92,7 +92,7 @@ CLASS y_check_collect IMPLEMENTATION.
 
 
   METHOD extract_itab_name.
-    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 = 'INTO'.
         result = get_token_abs( sy-tabix + 1 ).
@@ -107,8 +107,16 @@ CLASS y_check_collect IMPLEMENTATION.
 
 
   METHOD find_itab_declaration.
-    LOOP AT ref_scan_manager->statements ASSIGNING FIELD-SYMBOL(<statement>)
+    LOOP AT ref_scan->statements ASSIGNING FIELD-SYMBOL(<statement>)
     FROM structure-stmnt_from TO structure-stmnt_to.
+      DATA(first_token) = get_token_abs( <statement>-from ).
+
+      IF first_token <> 'DATA'
+      AND first_token <> 'TYPES'
+      AND first_token <> 'CLASS-DATA'.
+        CONTINUE.
+      ENDIF.
+
       DATA(tokens) = condense_tokens( <statement> ).
 
       IF  tokens NP |DATA { name } TYPE *|
@@ -135,14 +143,14 @@ CLASS y_check_collect IMPLEMENTATION.
     ENDLOOP.
 
     IF structure-back > 0.
-      result = find_itab_declaration( structure = ref_scan_manager->structures[ structure-back ]
+      result = find_itab_declaration( structure = ref_scan->structures[ structure-back ]
                                       name = name ).
     ENDIF.
   ENDMETHOD.
 
 
   METHOD extract_itab_type.
-    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
     WHERE str = 'OF'.
       IF get_token_abs( sy-tabix - 1 ) = 'TABLE'.
@@ -151,7 +159,7 @@ CLASS y_check_collect IMPLEMENTATION.
       ENDIF.
     ENDLOOP.
 
-    LOOP AT ref_scan_manager->tokens ASSIGNING <token>
+    LOOP AT ref_scan->tokens ASSIGNING <token>
     FROM statement-from TO statement-to
     WHERE str = 'TYPE'
     OR str = 'LIKE'.
@@ -176,8 +184,11 @@ CLASS y_check_collect IMPLEMENTATION.
       RETURN.
     ENDIF.
 
-    result ?= rtti_type.
+    TRY.
+        result ?= rtti_type.
+      CATCH cx_sy_move_cast_error.
+        " Not a TableDescr type
+        RETURN.
+    ENDTRY.
   ENDMETHOD.
-
-
 ENDCLASS.

src/checks/y_check_comment_position.clas.abap

@@ -56,8 +56,8 @@ CLASS y_check_comment_position IMPLEMENTATION.
 
   METHOD has_wrong_position.
     TRY.
-        DATA(previous_token) = ref_scan_manager->tokens[ statement-to - 1 ].
-        DATA(current_token) = ref_scan_manager->tokens[ statement-to ].
+        DATA(previous_token) = ref_scan->tokens[ statement-to - 1 ].
+        DATA(current_token) = ref_scan->tokens[ statement-to ].
       CATCH cx_sy_itab_line_not_found.
         RETURN.
     ENDTRY.
@@ -114,7 +114,7 @@ CLASS y_check_comment_position IMPLEMENTATION.
 
   METHOD get_next_token.
     DATA(next_position) = current_position + 1.
-    result = ref_scan_manager->tokens[ next_position ].
+    result = ref_scan->tokens[ next_position ].
     IF is_pragma( result ) = abap_true.
       result = get_next_token( next_position ).
     ENDIF.

src/checks/y_check_comment_type.clas.abap

@@ -40,7 +40,7 @@ CLASS y_check_comment_type IMPLEMENTATION.
 
 
   METHOD has_wrong_comment_type.
-    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 get_first_character( <token> ) = '*'
       AND get_second_character( <token> ) <> '&'.

src/checks/y_check_comment_usage.clas.abap

@@ -83,10 +83,10 @@ CLASS y_check_comment_usage IMPLEMENTATION.
       abs_statement_number = abs_statement_number + ( statement-to - statement-from ).
     ENDIF.
 
-    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
     WHERE type = scan_token_type-comment.
-      IF NOT is_comment_excluded( <token>-str ).
+      IF is_comment_excluded( <token>-str ) = abap_false.
         comment_number = comment_number + 1.
       ENDIF.
     ENDLOOP.
@@ -110,8 +110,8 @@ CLASS y_check_comment_usage IMPLEMENTATION.
                                    start_with = |"#EC| )
         OR has_token_started_with( token = token
                                    start_with = |* INCLUDE| )
-        OR token CP '"' && object_name && '*.'
-        OR token CO '*'.
+        OR token CP |"{ object_name }*.|
+        OR token CO |*|.
 
       result = abap_true.
 
@@ -133,7 +133,7 @@ CLASS y_check_comment_usage IMPLEMENTATION.
   METHOD check_result.
     DATA(percentage_of_comments) = get_percentage_of_comments( ).
 
-    DATA(statement_for_message) = ref_scan_manager->statements[ structure-stmnt_from ].
+    DATA(statement_for_message) = ref_scan->statements[ structure-stmnt_from ].
 
     DATA(check_configuration) = detect_check_configuration( error_count = percentage_of_comments
                                                             statement = statement_for_message ).
@@ -149,9 +149,7 @@ CLASS y_check_comment_usage IMPLEMENTATION.
 
 
   METHOD get_percentage_of_comments.
-    DATA percentage TYPE decfloat16.
-
-    percentage = ( comment_number / abs_statement_number ) * 100.
+    DATA(percentage) = CONV decfloat16( comment_number / abs_statement_number ) * 100.
 
     result = round( val = percentage
                     dec = 0

src/checks/y_check_constants_interface.clas.abap

@@ -68,7 +68,7 @@ CLASS Y_CHECK_CONSTANTS_INTERFACE IMPLEMENTATION.
   METHOD check_result.
     CHECK has_something_else = abap_false.
 
-    DATA(statement_for_message) = ref_scan_manager->statements[ structure-stmnt_from ].
+    DATA(statement_for_message) = ref_scan->statements[ structure-stmnt_from ].
 
     DATA(check_configuration) = detect_check_configuration( statement_for_message ).
 

src/checks/y_check_cx_root_usage.clas.abap

@@ -42,7 +42,7 @@ CLASS y_check_cx_root_usage IMPLEMENTATION.
 
 
   METHOD has_cx_root.
-    LOOP AT ref_scan_manager->tokens TRANSPORTING NO FIELDS
+    LOOP AT ref_scan->tokens TRANSPORTING NO FIELDS
     FROM statement-from TO statement-to
     WHERE str = 'CX_ROOT'.
       result = abap_true.

src/checks/y_check_cyclomatic_complexity.clas.abap

@@ -43,7 +43,7 @@ CLASS Y_CHECK_CYCLOMATIC_COMPLEXITY IMPLEMENTATION.
           c_cyclo_comp = c_cyclo_comp + 1.
         ENDIF.
       WHEN 'DO'.
-        READ TABLE ref_scan_manager->tokens INDEX statement_wa-to INTO DATA(token).
+        READ TABLE ref_scan->tokens INDEX statement_wa-to INTO DATA(token).
         IF token-str = 'TIMES'.
           c_cyclo_comp = c_cyclo_comp + 1.
         ENDIF.