implements #286

Author: lucasborin

src/checks/y_check_prefer_line_exists.clas.abap

@@ -0,0 +1,61 @@
+CLASS y_check_prefer_line_exists DEFINITION PUBLIC INHERITING FROM y_check_base CREATE PUBLIC.
+  PUBLIC SECTION.
+    METHODS constructor.
+
+  PROTECTED SECTION.
+    METHODS inspect_tokens REDEFINITION.
+
+    METHODS get_statement_inline IMPORTING statement TYPE sstmnt
+                                 RETURNING VALUE(result) TYPE string.
+
+ENDCLASS.
+
+
+
+CLASS y_check_prefer_line_exists IMPLEMENTATION.
+
+
+  METHOD constructor.
+    super->constructor( ).
+
+    settings-pseudo_comment = '"#EC PREF_LINE_EX' ##NO_TEXT.
+    settings-disable_threshold_selection = abap_true.
+    settings-threshold = 0.
+    settings-prio = c_warning.
+    settings-documentation = |{ c_docs_path-checks }prefer-line-exists.md|.
+
+    set_check_message( 'Prefer LINE_EXISTS to READ TABLE or LOOP AT!' ).
+  ENDMETHOD.
+
+
+  METHOD inspect_tokens.
+    CHECK get_token_abs( statement-from ) = 'READ'
+    OR get_token_abs( statement-from ) = 'LOOP'.
+
+    DATA(inline) = get_statement_inline( statement ).
+
+    IF inline NP '*TRANSPORTING NO FIELDS*'.
+      RETURN.
+    ENDIF.
+
+    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 ).
+  ENDMETHOD.
+
+
+  METHOD get_statement_inline.
+    LOOP AT ref_scan_manager->tokens ASSIGNING FIELD-SYMBOL(<token>)
+    FROM statement-from TO statement-to.
+      result = |{ result } { <token>-str }|.
+    ENDLOOP.
+  ENDMETHOD.
+
+ENDCLASS.

src/checks/y_check_prefer_line_exists.clas.testclasses.abap

@@ -0,0 +1,99 @@
+*"* use this source file for your ABAP unit test classes
+CLASS ltc_read_table DEFINITION INHERITING FROM y_unit_test_base FOR TESTING RISK LEVEL HARMLESS DURATION SHORT.
+  PROTECTED SECTION.
+    METHODS get_cut REDEFINITION.
+    METHODS get_code_with_issue REDEFINITION.
+    METHODS get_code_without_issue REDEFINITION.
+    METHODS get_code_with_exemption REDEFINITION.
+ENDCLASS.
+
+CLASS ltc_read_table IMPLEMENTATION.
+
+  METHOD get_cut.
+    result ?= NEW y_check_prefer_line_exists( ).
+  ENDMETHOD.
+
+  METHOD get_code_with_issue.
+    result = VALUE #(
+      ( 'REPORT y_example. ' )
+
+      ( ' START-OF-SELECTION.      ' )
+      ( '   DATA tadir TYPE TABLE OF tadir. ' )
+      ( '   DATA exists TYPE abap_bool. ' )
+
+      ( |   READ TABLE tadir TRANSPORTING NO FIELDS WITH KEY object = 'y_check_prefer_line_exists'. | )
+
+      ( '   IF sy-subrc = 0. ' )
+      ( '     exists = abap_true. ' )
+      ( '   ENDIF. ' )
+    ).
+  ENDMETHOD.
+
+  METHOD get_code_without_issue.
+    result = VALUE #(
+      ( 'REPORT y_example. ' )
+
+      ( ' START-OF-SELECTION.      ' )
+      ( '   DATA tadir TYPE TABLE OF tadir. ' )
+      ( |   DATA(exists) = xsdbool( line_exists( tadir[ object = 'y_check_prefer_line_exists' ] ) ). | )
+      ( |   DATA(index) = line_index( tadir[ object = 'y_check_prefer_line_exists' ] ). | )
+    ).
+  ENDMETHOD.
+
+  METHOD get_code_with_exemption.
+    result = VALUE #(
+      ( 'REPORT y_example. ' )
+
+      ( ' START-OF-SELECTION.      ' )
+      ( '   DATA tadir TYPE TABLE OF tadir. ' )
+      ( '   DATA exists TYPE abap_bool. ' )
+
+      ( |   READ TABLE tadir TRANSPORTING NO FIELDS WITH KEY object = 'y_check_prefer_line_exists'. "#EC PREF_LINE_EX | )
+
+      ( '   IF sy-subrc = 0. ' )
+      ( '     exists = abap_true. ' )
+      ( '   ENDIF. ' )
+    ).
+  ENDMETHOD.
+
+ENDCLASS.
+
+
+
+CLASS ltc_loop_at DEFINITION INHERITING FROM ltc_read_table FOR TESTING RISK LEVEL HARMLESS DURATION SHORT.
+  PROTECTED SECTION.
+    METHODS get_code_with_issue REDEFINITION.
+    METHODS get_code_with_exemption REDEFINITION.
+ENDCLASS.
+
+CLASS ltc_loop_at IMPLEMENTATION.
+
+  METHOD get_code_with_issue.
+    result = VALUE #(
+      ( 'REPORT y_example. ' )
+
+      ( ' START-OF-SELECTION.      ' )
+      ( '   DATA tadir TYPE TABLE OF tadir. ' )
+      ( '   DATA exists TYPE abap_bool. ' )
+
+      ( |   LOOP AT tadir TRANSPORTING NO FIELDS WHERE object = 'y_check_prefer_line_exists'. | )
+      ( '     exists = abap_true. ' )
+      ( '   ENDLOOP. ' )
+    ).
+  ENDMETHOD.
+
+  METHOD get_code_with_exemption.
+    result = VALUE #(
+      ( 'REPORT y_example. ' )
+
+      ( ' START-OF-SELECTION.      ' )
+      ( '   DATA tadir TYPE TABLE OF tadir. ' )
+      ( '   DATA exists TYPE abap_bool. ' )
+
+      ( |   LOOP AT tadir TRANSPORTING NO FIELDS WHERE object = 'y_check_prefer_line_exists'. "#EC PREF_LINE_EX | )
+      ( '     exists = abap_true. ' )
+      ( '   ENDLOOP. ' )
+    ).
+  ENDMETHOD.
+
+ENDCLASS.

src/checks/y_check_prefer_line_exists.clas.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="utf-8"?>
+<abapGit version="v1.0.0" serializer="LCL_OBJECT_CLAS" serializer_version="v1.0.0">
+ <asx:abap xmlns:asx="http://www.sap.com/abapxml" version="1.0">
+  <asx:values>
+   <VSEOCLASS>
+    <CLSNAME>Y_CHECK_PREFER_LINE_EXISTS</CLSNAME>
+    <LANGU>E</LANGU>
+    <DESCRIPT>Prefer LINE_EXISTS to READ TABLE or LOOP AT</DESCRIPT>
+    <STATE>1</STATE>
+    <CLSCCINCL>X</CLSCCINCL>
+    <FIXPT>X</FIXPT>
+    <UNICODE>X</UNICODE>
+    <WITH_UNIT_TESTS>X</WITH_UNIT_TESTS>
+   </VSEOCLASS>
+  </asx:values>
+ </asx:abap>
+</abapGit>