solving remaining syntax errors

lucasborin · lucasborin · commit eb3baac010ee · 2021-01-05T16:15:53.000+01:00
diff --git a/src/checks/y_check_prefer_case_to_elseif.clas.abap b/src/checks/y_check_prefer_case_to_elseif.clas.abap
@@ -7,21 +7,21 @@ CLASS y_check_prefer_case_to_elseif DEFINITION PUBLIC INHERITING FROM y_check_ba
     METHODS inspect_tokens REDEFINITION.
 
   PRIVATE SECTION.
-    TYPES: BEGIN OF counter,
+    TYPES: BEGIN OF ty_counter,
              if_structure TYPE sstruc,
              if_statement TYPE sstmnt,
              condition    TYPE string,
              count        TYPE i,
-           END OF counter.
-    TYPES counters TYPE TABLE OF counter.
+           END OF ty_counter.
+
+    TYPES ty_counters TYPE TABLE OF ty_counter.
+
+    DATA counters TYPE ty_counters.
 
     METHODS has_multiple_conditions IMPORTING statement     TYPE sstmnt
                                     RETURNING VALUE(result) TYPE abap_bool.
 
-    METHODS should_skip_test_code IMPORTING structure     TYPE sstruc
-                                  RETURNING VALUE(result) TYPE abap_bool.
-
-    METHODS handle_result IMPORTING counters TYPE counters.
+    METHODS handle_result.
 
 ENDCLASS.
 
@@ -37,69 +37,54 @@ CLASS y_check_prefer_case_to_elseif IMPLEMENTATION.
     settings-threshold = 5.
     settings-documentation = |{ c_docs_path-checks }prefer-case-to-elseif.md|.
 
+    relevant_statement_types = VALUE #( ).
+
+    relevant_structure_types = VALUE #( ( scan_struc_type-condition )
+                                        ( scan_struc_type-alternation ) ).
+
     set_check_message( 'Prefer CASE to ELSE IF for multiple alternative conditions!' ).
   ENDMETHOD.
 
 
   METHOD execute_check.
-    DATA counters TYPE counters.
-
-    DATA(structures) = ref_scan_manager->get_structures( ).
-    DATA(statements) = ref_scan_manager->get_statements( ).
-
-    LOOP AT structures ASSIGNING FIELD-SYMBOL(<structure>)
-    WHERE type = scan_struc_type-condition
-    OR type = scan_struc_type-alternation.
-
-      IF should_skip_test_code( <structure> ) = abap_true.
-        CONTINUE.
-      ENDIF.
-
-      DATA(statement) = statements[ <structure>-stmnt_from ].
-
-      IF has_multiple_conditions( statement ) = abap_true.
-        CONTINUE.
-      ENDIF.
-
-      DATA(token) = get_token_abs( statement-from ).
-
-      DATA(if_structure) = COND #( WHEN token = 'IF' THEN <structure>
-                                   WHEN token = 'ELSEIF' THEN structures[ <structure>-back ] ).
-
-      IF if_structure IS INITIAL.
-        CONTINUE.
-      ENDIF.
+    super->execute_check( ).
+    handle_result( ).
+  ENDMETHOD.
 
-      DATA(condition) = get_token_abs( statement-from + 1 ).
 
-      TRY.
-          counters[ if_structure = if_structure
-                    condition = condition ]-count = counters[ if_structure = if_structure
-                                                              condition = condition ]-count + 1.
-        CATCH cx_sy_itab_line_not_found.
-          counters = VALUE #( BASE counters
-                            ( if_structure = if_structure
-                              if_statement = statements[ if_structure-stmnt_from ]
-                              condition = condition
-                              count = 1 ) ).
-      ENDTRY.
+  METHOD inspect_tokens.
 
-    ENDLOOP.
+    " Only the first statement is relevant
+    CHECK structure-stmnt_from = index.
 
-    handle_result( counters ).
-
-  ENDMETHOD.
+    DATA(if_statement) = ref_scan_manager->statements[ structure-stmnt_from ].
 
+    IF has_multiple_conditions( if_statement ) = abap_true.
+      RETURN.
+    ENDIF.
 
-  METHOD inspect_tokens.
-    RETURN.
-  ENDMETHOD.
+    DATA(if_token) = get_token_abs( if_statement-from ).
 
+    DATA(if_structure) = COND #( WHEN if_token = 'IF' THEN structure
+                                 WHEN if_token = 'ELSEIF' THEN ref_scan_manager->structures[ structure-back ] ).
 
-  METHOD should_skip_test_code.
-    CHECK test_code_detector->is_testcode( structure ) = abap_true.
-    CHECK line_exists( check_configurations[ apply_on_testcode = abap_false ] ).
-    result = abap_true.
+    IF if_structure IS INITIAL.
+      RETURN.
+    ENDIF.
+
+    DATA(condition) = get_token_abs( if_statement-from + 1 ).
+
+    TRY.
+        counters[ if_structure = if_structure
+                  condition = condition ]-count = counters[ if_structure = if_structure
+                                                            condition = condition ]-count + 1.
+      CATCH cx_sy_itab_line_not_found.
+        counters = VALUE #( BASE counters
+                          ( if_structure = if_structure
+                            if_statement = if_statement
+                            condition = condition
+                            count = 1 ) ).
+    ENDTRY.
   ENDMETHOD.
 
 
@@ -120,13 +105,15 @@ CLASS y_check_prefer_case_to_elseif IMPLEMENTATION.
     ENDLOOP.
   ENDMETHOD.
 
+
   METHOD has_multiple_conditions.
-    LOOP AT ref_scan_manager->get_tokens( ) ASSIGNING FIELD-SYMBOL(<token>)
+    LOOP AT ref_scan_manager->tokens ASSIGNING FIELD-SYMBOL(<token>)
     FROM statement-from TO statement-to
     WHERE str = 'AND' OR str = 'OR'.
       result = abap_true.
       RETURN.
     ENDLOOP.
   ENDMETHOD.
 
+
 ENDCLASS.
diff --git a/src/checks/y_check_pseudo_comment_usage.clas.abap b/src/checks/y_check_pseudo_comment_usage.clas.abap
@@ -1,41 +1,34 @@
-CLASS y_check_pseudo_comment_usage DEFINITION
-  PUBLIC
-  INHERITING FROM y_check_base
-  CREATE PUBLIC .
-
+CLASS y_check_pseudo_comment_usage DEFINITION PUBLIC INHERITING FROM y_check_base CREATE PUBLIC.
   PUBLIC SECTION.
+    METHODS constructor.
 
-    METHODS constructor .
   PROTECTED SECTION.
-    CONSTANTS check_base_name TYPE tadir-obj_name VALUE 'Y_CHECK_BASE'.
-    DATA name_tab TYPE STANDARD TABLE OF tadir-obj_name.
-
-    METHODS select_object_list
-      RETURNING VALUE(result) LIKE name_tab
-      RAISING   cx_failed.
-
-    METHODS call_get_pseudo_comment
-      IMPORTING obj_name      TYPE stokesx-str
-      RETURNING VALUE(result) TYPE stokesx-str
-      RAISING   cx_sy_create_object_error.
-
     METHODS execute_check REDEFINITION.
     METHODS inspect_tokens REDEFINITION.
 
   PRIVATE SECTION.
+    CONSTANTS check_base_name TYPE tadir-obj_name VALUE 'Y_CHECK_BASE'.
+
+    DATA name_tab TYPE STANDARD TABLE OF tadir-obj_name.
     DATA pseudo_comment_counter TYPE i VALUE 0 ##NO_TEXT.
     DATA class_names TYPE string_table.
 
-    METHODS count_cc_pseudo_comments
-      IMPORTING token       TYPE stokesx
-                class_names TYPE string_table.
+    METHODS count_cc_pseudo_comments IMPORTING token       TYPE stokesx.
 
     METHODS raise_error_wrapper.
+
+    METHODS select_object_list RETURNING VALUE(result) LIKE name_tab
+                               RAISING   cx_failed.
+
+    METHODS call_get_pseudo_comment IMPORTING obj_name      TYPE stokesx-str
+                                    RETURNING VALUE(result) TYPE stokesx-str
+                                    RAISING   cx_sy_create_object_error.
+
 ENDCLASS.
 
 
 
-CLASS Y_CHECK_PSEUDO_COMMENT_USAGE IMPLEMENTATION.
+CLASS y_check_pseudo_comment_usage IMPLEMENTATION.
 
 
   METHOD call_get_pseudo_comment.
@@ -61,7 +54,17 @@ CLASS Y_CHECK_PSEUDO_COMMENT_USAGE IMPLEMENTATION.
     settings-apply_on_productive_code = abap_true.
     settings-prio = c_note.
 
+    relevant_statement_types = VALUE #( ).
+    relevant_structure_types = VALUE #( ).
+
     set_check_message( '&1 pseudo comments!' ).
+
+    TRY.
+        class_names = select_object_list( ).
+      CATCH cx_failed.
+        APPEND INITIAL LINE TO class_names.
+    ENDTRY.
+
   ENDMETHOD.
 
 
@@ -79,26 +82,18 @@ CLASS Y_CHECK_PSEUDO_COMMENT_USAGE IMPLEMENTATION.
 
 
   METHOD execute_check.
-    TRY.
-        class_names = select_object_list( ).
-      CATCH cx_failed.
-        APPEND INITIAL LINE TO class_names.
-    ENDTRY.
-
-    pseudo_comment_counter = 0.
-    is_testcode = abap_false.
-
-    LOOP AT ref_scan_manager->get_tokens( ) ASSIGNING FIELD-SYMBOL(<token>)
-      WHERE type EQ 'C' OR type EQ 'P'.
-      count_cc_pseudo_comments( token = <token> class_names = class_names ).
-    ENDLOOP.
-
+    super->execute_check( ).
     raise_error_wrapper( ).
   ENDMETHOD.
 
 
   METHOD inspect_tokens.
-    RETURN.
+    LOOP AT ref_scan_manager->tokens ASSIGNING FIELD-SYMBOL(<token>)
+    FROM statement-from TO statement-to
+    WHERE type EQ 'C'
+    OR type EQ 'P'.
+      count_cc_pseudo_comments( <token> ).
+    ENDLOOP.
   ENDMETHOD.
 
 
@@ -134,4 +129,6 @@ CLASS Y_CHECK_PSEUDO_COMMENT_USAGE IMPLEMENTATION.
       RAISE EXCEPTION TYPE cx_failed.
     ENDIF.
   ENDMETHOD.
+
+
 ENDCLASS.
diff --git a/src/foundation/y_check_base.clas.abap b/src/foundation/y_check_base.clas.abap
@@ -133,11 +133,13 @@ CLASS y_check_base DEFINITION PUBLIC ABSTRACT
                                        RETURNING VALUE(result) TYPE abap_bool.
 
     METHODS is_in_scope IMPORTING statement     TYPE sstmnt
-                        RETURNING value(result) TYPE abap_bool.
+                        RETURNING VALUE(result) TYPE abap_bool.
 
     METHODS get_application_component IMPORTING level         TYPE slevel
                                       RETURNING VALUE(result) TYPE df14l-ps_posid.
 
+    METHODS are_relevant_types_set RETURNING VALUE(result) TYPE abap_bool.
+
 ENDCLASS.
 
 
@@ -224,9 +226,11 @@ CLASS y_check_base IMPLEMENTATION.
 
   METHOD execute_check.
     LOOP AT ref_scan_manager->structures ASSIGNING FIELD-SYMBOL(<structure>).
-      IF is_statement_type_relevant( <structure> ) = abap_false
-      AND is_structure_type_relevant( <structure> ) = abap_false.
-        CONTINUE.
+      IF are_relevant_types_set( ) = abap_true.
+        IF is_statement_type_relevant( <structure> ) = abap_false
+        AND is_structure_type_relevant( <structure> ) = abap_false.
+          CONTINUE.
+        ENDIF.
       ENDIF.
 
       IF should_skip_test_code( <structure> ) = abap_true.
@@ -247,7 +251,6 @@ CLASS y_check_base IMPLEMENTATION.
                         statement = <statement> ).
 
         index = index + 1.
-
       ENDLOOP.
     ENDLOOP.
   ENDMETHOD.
@@ -787,4 +790,10 @@ CLASS y_check_base IMPLEMENTATION.
   ENDMETHOD.
 
 
+  METHOD are_relevant_types_set.
+    result = xsdbool(    relevant_statement_types IS NOT INITIAL
+                      OR relevant_structure_types IS NOT INITIAL ).
+  ENDMETHOD.
+
+
 ENDCLASS.
