Prefer Pragmas to Pseudo Comments (#495)

* fixes #489

* changelog

Co-authored-by: Lucas Borin <5233413+lucasborin@users.noreply.github.co>

Author: lucasborin

changelog.txt

@@ -18,6 +18,7 @@ Legend
 
 2021-08-XX v.1.16.0
 ------------------
+* 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)

src/checks/y_check_prefer_pragmas.clas.abap

@@ -11,13 +11,15 @@ CLASS y_check_prefer_pragmas DEFINITION PUBLIC INHERITING FROM y_check_base CREA
              pseudo_com TYPE slin_desc-pseudo_com,
            END OF mapping.
 
+    TYPES: pseudo_comments TYPE SORTED TABLE OF mapping-pseudo_com WITH UNIQUE KEY table_line.
+
     CLASS-DATA mappings TYPE TABLE OF mapping.
 
-    METHODS extract_pseudo_comment IMPORTING statement TYPE sstmnt
-                                   RETURNING value(result)  TYPE string.
+    METHODS get_pseudo_comments IMPORTING statement TYPE sstmnt
+                                RETURNING VALUE(result) TYPE pseudo_comments.
 
-    METHODS to_pragma IMPORTING pseudo_comment TYPE string
-                      RETURNING value(result)  TYPE string.
+    METHODS get_mapping IMPORTING pseudo_comments TYPE pseudo_comments
+                        RETURNING VALUE(result) LIKE mappings.
 
 ENDCLASS.
 
@@ -35,60 +37,60 @@ CLASS y_check_prefer_pragmas IMPLEMENTATION.
     settings-documentation = |{ c_docs_path-checks }prefer-pragmas-to-pseudo-comments.md|.
 
     IF mappings IS INITIAL.
-      SELECT pragma, pseudo_com FROM slin_desc INTO CORRESPONDING FIELDS OF TABLE @mappings.
+      SELECT DISTINCT pragma, pseudo_com FROM slin_desc INTO CORRESPONDING FIELDS OF TABLE @mappings.
     ENDIF.
 
     set_check_message( 'Change the &1 to &2' ).
   ENDMETHOD.
 
 
   METHOD inspect_tokens.
-    DATA(pseudo_comment) = extract_pseudo_comment( statement ).
+    DATA(pseudo_comments) = get_pseudo_comments( statement ).
 
-    IF pseudo_comment IS INITIAL.
+    IF lines( pseudo_comments ) = 0.
       RETURN.
     ENDIF.
 
-    DATA(pragma) = to_pragma( pseudo_comment ).
+    DATA(mapping_to_pragmas) = get_mapping( pseudo_comments ).
 
-    IF pragma IS INITIAL.
+    IF lines( mapping_to_pragmas ) = 0.
       RETURN.
     ENDIF.
 
     DATA(check_configuration) = detect_check_configuration( statement ).
 
-    pragma = |##{ pragma }|.
-
-    raise_error( statement_level = statement-level
-                 statement_index = index
-                 statement_from = statement-from
-                 check_configuration = check_configuration
-                 parameter_01 = pseudo_comment
-                 parameter_02 = pragma ).
+    LOOP AT mapping_to_pragmas ASSIGNING FIELD-SYMBOL(<mapping>).
+      raise_error( statement_level = statement-level
+                   statement_index = index
+                   statement_from = statement-from
+                   check_configuration = check_configuration
+                   parameter_01 = |#EC { <mapping>-pseudo_com }|
+                   parameter_02 = |##{ <mapping>-pragma }| ).
+    ENDLOOP.
   ENDMETHOD.
 
 
-  METHOD extract_pseudo_comment.
-    LOOP AT ref_scan->tokens ASSIGNING FIELD-SYMBOL(<token>)
+  METHOD get_pseudo_comments.
+    LOOP AT ref_scan->tokens INTO token_wa
     FROM statement-from TO statement-to
-    WHERE type = scan_token_type-comment.
-      IF <token>-str CS '"#EC'.
-        result = <token>-str.
-        RETURN.
-      ENDIF.
+    WHERE type = scan_token_type-comment
+    AND str CS '#EC '.
+      REPLACE ALL OCCURRENCES OF `"#EC ` IN token_wa-str WITH `#EC `.
+      REPLACE ALL OCCURRENCES OF ` #EC` IN token_wa-str WITH '#EC'.
+      REPLACE ALL OCCURRENCES OF `#EC ` IN token_wa-str WITH '#EC'.
+      SPLIT token_wa-str AT space INTO TABLE DATA(pseudo_comments).
+      LOOP AT pseudo_comments ASSIGNING FIELD-SYMBOL(<pseudo_comment>)
+      WHERE table_line CS '#EC'.
+        REPLACE ALL OCCURRENCES OF '#EC' IN <pseudo_comment> WITH ''.
+        APPEND <pseudo_comment> TO result.
+      ENDLOOP.
     ENDLOOP.
   ENDMETHOD.
 
 
-  METHOD to_pragma.
-    TRY.
-        DATA(text) = pseudo_comment.
-        REPLACE '"#EC' IN text WITH ''.
-        CONDENSE text.
-        result = mappings[ pseudo_com = text ]-pragma.
-      CATCH cx_sy_itab_line_not_found.
-        RETURN.
-    ENDTRY.
+  METHOD get_mapping.
+    result = FILTER #( mappings IN pseudo_comments WHERE pseudo_com = table_line ).
   ENDMETHOD.
 
+
 ENDCLASS.

src/checks/y_check_prefer_pragmas.clas.testclasses.abap

@@ -37,3 +37,52 @@ CLASS ltc_pseudo_comment IMPLEMENTATION.
   ENDMETHOD.
 
 ENDCLASS.
+
+
+
+CLASS ltc_multiple_pseudo_comments DEFINITION INHERITING FROM y_unit_test_base FOR TESTING RISK LEVEL HARMLESS DURATION SHORT.
+  PROTECTED SECTION.
+    METHODS get_cut REDEFINITION.
+    METHODS get_expected_count REDEFINITION.
+    METHODS get_code_with_issue REDEFINITION.
+    METHODS get_code_without_issue REDEFINITION.
+    METHODS get_code_with_exemption REDEFINITION.
+ENDCLASS.
+
+CLASS ltc_multiple_pseudo_comments IMPLEMENTATION.
+
+  METHOD get_cut.
+    result ?= NEW y_check_prefer_pragmas( ).
+  ENDMETHOD.
+
+  METHOD get_expected_count.
+    result = 2.
+  ENDMETHOD.
+
+  METHOD get_code_with_issue.
+    result = VALUE #(
+      ( ' REPORT y_example. ' )
+      ( '   START-OF-SELECTION.      ' )
+      ( '     TRY. ' )
+      ( '         DATA(div_by_zero) = 1 / 0. ' )
+      ( '       CATCH cx_root.               "#EC NEEDED  "#EC NO_HANDLER' )
+      ( '     ENDTRY. ' )
+    ).
+  ENDMETHOD.
+
+  METHOD get_code_without_issue.
+    result = VALUE #(
+      ( ' REPORT y_example. ' )
+      ( '   START-OF-SELECTION.      ' )
+      ( '     TRY. ' )
+      ( '         DATA(div_by_zero) = 1 / 0. ' )
+      ( '       CATCH cx_root.               ##NEEDED ##NO_HANDLER' )
+      ( '     ENDTRY. ' )
+    ).
+  ENDMETHOD.
+
+  METHOD get_code_with_exemption.
+    result = VALUE #( ).
+  ENDMETHOD.
+
+ENDCLASS.