From a9a505faf440952268c881473bba0e0d4aedec38 Mon Sep 17 00:00:00 2001 From: Mauricio Lauffer <443888+mauriciolauffer@users.noreply.github.com> Date: Tue, 11 Feb 2020 20:20:45 +1100 Subject: [PATCH] Prefer RETURNING to EXPORTING (#3204) * refactor: Prefer RETURNING to EXPORTING * refactor: Prefer RETURNING to EXPORTING --- src/objects/zcl_abapgit_object_iatu.clas.abap | 31 ++++---- src/objects/zcl_abapgit_object_iaxu.clas.abap | 23 +++--- src/ui/zcl_abapgit_log_viewer.clas.abap | 12 +-- src/utils/zcl_abapgit_log.clas.abap | 8 +- src/utils/zif_abapgit_log.intf.abap | 3 +- src/zcl_abapgit_message_helper.clas.abap | 78 ++++++------------- 6 files changed, 56 insertions(+), 99 deletions(-) diff --git a/src/objects/zcl_abapgit_object_iatu.clas.abap b/src/objects/zcl_abapgit_object_iatu.clas.abap index b33ff6645..1aaffa72a 100644 --- a/src/objects/zcl_abapgit_object_iatu.clas.abap +++ b/src/objects/zcl_abapgit_object_iatu.clas.abap @@ -16,7 +16,7 @@ CLASS zcl_abapgit_object_iatu DEFINITION PUBLIC INHERITING FROM zcl_abapgit_obje RAISING zcx_abapgit_exception, w3_api_load IMPORTING is_name TYPE iacikeyt - EXPORTING eo_template TYPE REF TO if_w3_api_template + RETURNING VALUE(ro_template) TYPE REF TO if_w3_api_template RAISING zcx_abapgit_exception, w3_api_set_changeable IMPORTING iv_changeable TYPE abap_bool @@ -30,15 +30,15 @@ CLASS zcl_abapgit_object_iatu DEFINITION PUBLIC INHERITING FROM zcl_abapgit_obje RAISING zcx_abapgit_exception, w3_api_get_attributes IMPORTING io_template TYPE REF TO if_w3_api_template - EXPORTING es_attributes TYPE w3tempattr + RETURNING VALUE(rs_attributes) TYPE w3tempattr RAISING zcx_abapgit_exception, w3_api_get_source IMPORTING io_template TYPE REF TO if_w3_api_template - EXPORTING et_source TYPE w3htmltabtype + RETURNING VALUE(rt_source) TYPE w3htmltabtype RAISING zcx_abapgit_exception, w3_api_create_new IMPORTING is_template_data TYPE w3tempattr - EXPORTING eo_template TYPE REF TO if_w3_api_template + RETURNING VALUE(ro_template) TYPE REF TO if_w3_api_template RAISING zcx_abapgit_exception, w3_api_set_attributes IMPORTING io_template TYPE REF TO if_w3_api_template @@ -65,19 +65,16 @@ CLASS zcl_abapgit_object_iatu IMPLEMENTATION. ls_name = ms_item-obj_name. - w3_api_load( EXPORTING is_name = ls_name - IMPORTING eo_template = lo_template ). + lo_template = w3_api_load( is_name = ls_name ). - w3_api_get_attributes( EXPORTING io_template = lo_template - IMPORTING es_attributes = es_attr ). + es_attr = w3_api_get_attributes( io_template = lo_template ). CLEAR: es_attr-chname, es_attr-tdate, es_attr-ttime, es_attr-devclass. - w3_api_get_source( EXPORTING io_template = lo_template - IMPORTING et_source = lt_source ). + lt_source = w3_api_get_source( io_template = lo_template ). CONCATENATE LINES OF lt_source INTO ev_source RESPECTING BLANKS. @@ -91,8 +88,7 @@ CLASS zcl_abapgit_object_iatu IMPLEMENTATION. lo_template TYPE REF TO if_w3_api_template. - w3_api_create_new( EXPORTING is_template_data = is_attr - IMPORTING eo_template = lo_template ). + lo_template = w3_api_create_new( is_template_data = is_attr ). w3_api_set_attributes( io_template = lo_template is_attr = is_attr ). @@ -127,8 +123,7 @@ CLASS zcl_abapgit_object_iatu IMPLEMENTATION. ls_name = ms_item-obj_name. - w3_api_load( EXPORTING is_name = ls_name - IMPORTING eo_template = lo_template ). + lo_template = w3_api_load( is_name = ls_name ). w3_api_set_changeable( io_template = lo_template iv_changeable = abap_true ). @@ -235,7 +230,7 @@ CLASS zcl_abapgit_object_iatu IMPLEMENTATION. EXPORTING p_template_name = is_name IMPORTING - p_template = eo_template + p_template = ro_template EXCEPTIONS object_not_existing = 1 permission_failure = 2 @@ -315,7 +310,7 @@ CLASS zcl_abapgit_object_iatu IMPLEMENTATION. io_template->get_attributes( IMPORTING - p_attributes = es_attributes + p_attributes = rs_attributes EXCEPTIONS object_invalid = 1 template_deleted = 2 @@ -333,7 +328,7 @@ CLASS zcl_abapgit_object_iatu IMPLEMENTATION. io_template->get_source( IMPORTING - p_source = et_source + p_source = rt_source EXCEPTIONS object_invalid = 1 template_deleted = 2 @@ -354,7 +349,7 @@ CLASS zcl_abapgit_object_iatu IMPLEMENTATION. p_template_data = is_template_data p_program_name = is_template_data-programm IMPORTING - p_template = eo_template + p_template = ro_template EXCEPTIONS object_already_existing = 1 object_just_created = 2 diff --git a/src/objects/zcl_abapgit_object_iaxu.clas.abap b/src/objects/zcl_abapgit_object_iaxu.clas.abap index 1876e4e44..8b4864233 100644 --- a/src/objects/zcl_abapgit_object_iaxu.clas.abap +++ b/src/objects/zcl_abapgit_object_iaxu.clas.abap @@ -10,7 +10,7 @@ CLASS zcl_abapgit_object_iaxu DEFINITION PUBLIC INHERITING FROM zcl_abapgit_obje METHODS: read - EXPORTING es_attr TYPE w3tempattr + RETURNING VALUE(rs_attr) TYPE w3tempattr RAISING zcx_abapgit_exception, save IMPORTING is_attr TYPE w3tempattr @@ -31,8 +31,8 @@ CLASS zcl_abapgit_object_iaxu DEFINITION PUBLIC INHERITING FROM zcl_abapgit_obje IMPORTING io_xml_api TYPE REF TO object RAISING zcx_abapgit_exception, w3_api_create_new - IMPORTING is_attr TYPE w3tempattr - EXPORTING eo_xml_api TYPE REF TO object + IMPORTING is_attr TYPE w3tempattr + RETURNING VALUE(ro_xml_api) TYPE REF TO object RAISING zcx_abapgit_exception. ENDCLASS. @@ -50,12 +50,12 @@ CLASS zcl_abapgit_object_iaxu IMPLEMENTATION. ls_name = ms_item-obj_name. w3_api_load( EXPORTING is_name = ls_name - IMPORTING es_attr = es_attr ). + IMPORTING es_attr = rs_attr ). - CLEAR: es_attr-chname, - es_attr-tdate, - es_attr-ttime, - es_attr-devclass. + CLEAR: rs_attr-chname, + rs_attr-tdate, + rs_attr-ttime, + rs_attr-devclass. ENDMETHOD. @@ -64,8 +64,7 @@ CLASS zcl_abapgit_object_iaxu IMPLEMENTATION. DATA: lo_xml_api TYPE REF TO object. - w3_api_create_new( EXPORTING is_attr = is_attr - IMPORTING eo_xml_api = lo_xml_api ). + lo_xml_api = w3_api_create_new( is_attr = is_attr ). w3_api_save( io_xml_api = lo_xml_api ). @@ -105,7 +104,7 @@ CLASS zcl_abapgit_object_iaxu IMPLEMENTATION. zcx_abapgit_exception=>raise( |Error from w3_api_xml3~create_new subrc={ sy-subrc }| ). ENDIF. - eo_xml_api ?= . + ro_xml_api ?= . ENDMETHOD. @@ -310,7 +309,7 @@ CLASS zcl_abapgit_object_iaxu IMPLEMENTATION. RETURN. ENDIF. - read( IMPORTING es_attr = ls_attr ). + ls_attr = read( ). io_xml->add( iv_name = 'ATTR' ig_data = ls_attr ). diff --git a/src/ui/zcl_abapgit_log_viewer.clas.abap b/src/ui/zcl_abapgit_log_viewer.clas.abap index 61ca77eb1..2bd431442 100644 --- a/src/ui/zcl_abapgit_log_viewer.clas.abap +++ b/src/ui/zcl_abapgit_log_viewer.clas.abap @@ -42,8 +42,8 @@ CLASS zcl_abapgit_log_viewer DEFINITION prepare_log_for_display IMPORTING ii_log TYPE REF TO zif_abapgit_log - EXPORTING - et_log_out TYPE tty_log_out, + RETURNING + VALUE(rt_log_out) TYPE tty_log_out, show_longtext IMPORTING @@ -276,7 +276,7 @@ CLASS ZCL_ABAPGIT_LOG_VIEWER IMPLEMENTATION. ls_log-obj_type = lr_message->obj_type. ls_log-obj_name = lr_message->obj_name. - INSERT ls_log INTO TABLE et_log_out. + INSERT ls_log INTO TABLE rt_log_out. ENDLOOP. @@ -295,11 +295,7 @@ CLASS ZCL_ABAPGIT_LOG_VIEWER IMPLEMENTATION. lv_add_obj_col TYPE abap_bool, lo_event TYPE REF TO cl_salv_events_table. - prepare_log_for_display( - EXPORTING - ii_log = ii_log - IMPORTING - et_log_out = gt_log ). + gt_log = prepare_log_for_display( ii_log = ii_log ). "check if log contains any object info LOOP AT gt_log REFERENCE INTO lr_log. diff --git a/src/utils/zcl_abapgit_log.clas.abap b/src/utils/zcl_abapgit_log.clas.abap index 813b762fa..68e56e6b2 100644 --- a/src/utils/zcl_abapgit_log.clas.abap +++ b/src/utils/zcl_abapgit_log.clas.abap @@ -155,17 +155,15 @@ CLASS zcl_abapgit_log IMPLEMENTATION. DATA ls_item_status TYPE zif_abapgit_log=>ty_item_status_out. DATA lr_item_status TYPE REF TO zif_abapgit_log=>ty_item_status_out. - CLEAR et_item_status. - "collect all message for all objects LOOP AT mt_log REFERENCE INTO lr_log. CLEAR ls_item_status. ls_item_status-item = lr_log->item. - READ TABLE et_item_status REFERENCE INTO lr_item_status + READ TABLE rt_item_status REFERENCE INTO lr_item_status WITH KEY item-obj_type = ls_item_status-item-obj_type item-obj_name = ls_item_status-item-obj_name. IF sy-subrc <> 0. - INSERT ls_item_status INTO TABLE et_item_status. + INSERT ls_item_status INTO TABLE rt_item_status. GET REFERENCE OF ls_item_status INTO lr_item_status. ENDIF. CLEAR ls_msg. @@ -175,7 +173,7 @@ CLASS zcl_abapgit_log IMPLEMENTATION. ENDLOOP. "determine object status from object messages - LOOP AT et_item_status REFERENCE INTO lr_item_status. + LOOP AT rt_item_status REFERENCE INTO lr_item_status. lr_item_status->status = get_messages_status( lr_item_status->messages ). IF lr_item_status->messages IS INITIAL. CLEAR ls_msg. diff --git a/src/utils/zif_abapgit_log.intf.abap b/src/utils/zif_abapgit_log.intf.abap index 01f2a272c..a1d7c364d 100644 --- a/src/utils/zif_abapgit_log.intf.abap +++ b/src/utils/zif_abapgit_log.intf.abap @@ -71,8 +71,7 @@ INTERFACE zif_abapgit_log RETURNING VALUE(rt_msg) TYPE tty_log_out . METHODS get_item_status - EXPORTING - !et_item_status TYPE tty_item_status_out . + RETURNING VALUE(rt_item_status) TYPE tty_item_status_out . METHODS get_status RETURNING VALUE(rv_status) TYPE symsgty . diff --git a/src/zcl_abapgit_message_helper.clas.abap b/src/zcl_abapgit_message_helper.clas.abap index b73ca33fb..0438bfaef 100644 --- a/src/zcl_abapgit_message_helper.clas.abap +++ b/src/zcl_abapgit_message_helper.clas.abap @@ -76,27 +76,27 @@ CLASS zcl_abapgit_message_helper DEFINITION set_single_msg_var IMPORTING - iv_arg TYPE clike - EXPORTING - ev_target TYPE c, + iv_arg TYPE clike + RETURNING + VALUE(rv_target) TYPE char01, set_single_msg_var_clike IMPORTING - iv_arg TYPE clike - EXPORTING - ev_target TYPE c, + iv_arg TYPE clike + RETURNING + VALUE(rv_target) TYPE char01, set_single_msg_var_numeric IMPORTING - iv_arg TYPE numeric - EXPORTING - ev_target TYPE c, + iv_arg TYPE numeric + RETURNING + VALUE(rv_target) TYPE char01, set_single_msg_var_xseq IMPORTING - iv_arg TYPE xsequence - EXPORTING - ev_target TYPE c. + iv_arg TYPE xsequence + RETURNING + VALUE(rv_target) TYPE char01. ENDCLASS. @@ -137,38 +137,22 @@ CLASS ZCL_ABAPGIT_MESSAGE_HELPER IMPLEMENTATION. OTHERS = 1. IF sy-subrc = 0. - set_single_msg_var( - EXPORTING - iv_arg = mi_t100_message->t100key-attr1 - IMPORTING - ev_target = sy-msgv1 ). + sy-msgv1 = set_single_msg_var( iv_arg = mi_t100_message->t100key-attr1 ). REPLACE '&V1&' IN TABLE rt_itf WITH sy-msgv1. - set_single_msg_var( - EXPORTING - iv_arg = mi_t100_message->t100key-attr2 - IMPORTING - ev_target = sy-msgv2 ). + sy-msgv2 = set_single_msg_var( iv_arg = mi_t100_message->t100key-attr2 ). REPLACE '&V2&' IN TABLE rt_itf WITH sy-msgv2. - set_single_msg_var( - EXPORTING - iv_arg = mi_t100_message->t100key-attr3 - IMPORTING - ev_target = sy-msgv3 ). + sy-msgv3 = set_single_msg_var( iv_arg = mi_t100_message->t100key-attr3 ). REPLACE '&V3&' IN TABLE rt_itf WITH sy-msgv3. - set_single_msg_var( - EXPORTING - iv_arg = mi_t100_message->t100key-attr4 - IMPORTING - ev_target = sy-msgv4 ). + sy-msgv4 = set_single_msg_var( iv_arg = mi_t100_message->t100key-attr4 ). REPLACE '&V4&' IN TABLE rt_itf WITH sy-msgv4. @@ -293,24 +277,18 @@ CLASS ZCL_ABAPGIT_MESSAGE_HELPER IMPLEMENTATION. FIELD-SYMBOLS TYPE any. - CLEAR ev_target. - IF iv_arg IS INITIAL. RETURN. ENDIF. ASSIGN me->(iv_arg) TO . IF sy-subrc <> 0. - CONCATENATE '&' iv_arg '&' INTO ev_target. + CONCATENATE '&' iv_arg '&' INTO rv_target. RETURN. ENDIF. TRY. - set_single_msg_var_clike( - EXPORTING - iv_arg = - IMPORTING - ev_target = ev_target ). + rv_target = set_single_msg_var_clike( iv_arg = ). RETURN. @@ -318,11 +296,7 @@ CLASS ZCL_ABAPGIT_MESSAGE_HELPER IMPLEMENTATION. ENDTRY. TRY. - set_single_msg_var_numeric( - EXPORTING - iv_arg = - IMPORTING - ev_target = ev_target ). + rv_target = set_single_msg_var_numeric( iv_arg = ). RETURN. @@ -330,37 +304,33 @@ CLASS ZCL_ABAPGIT_MESSAGE_HELPER IMPLEMENTATION. ENDTRY. TRY. - set_single_msg_var_xseq( - EXPORTING - iv_arg = - IMPORTING - ev_target = ev_target ). + rv_target = set_single_msg_var_xseq( iv_arg = ). RETURN. CATCH cx_sy_dyn_call_illegal_type ##no_handler. ENDTRY. - CONCATENATE '&' iv_arg '&' INTO ev_target. + CONCATENATE '&' iv_arg '&' INTO rv_target. ENDMETHOD. METHOD set_single_msg_var_clike. " a kind of MOVE where all conversion errors are signalled by exceptions - WRITE iv_arg LEFT-JUSTIFIED TO ev_target. + WRITE iv_arg LEFT-JUSTIFIED TO rv_target. ENDMETHOD. METHOD set_single_msg_var_numeric. " a kind of MOVE where all conversion errors are signalled by exceptions - WRITE iv_arg LEFT-JUSTIFIED TO ev_target. + WRITE iv_arg LEFT-JUSTIFIED TO rv_target. ENDMETHOD. METHOD set_single_msg_var_xseq. " a kind of MOVE where all conversion errors are signalled by exceptions - WRITE iv_arg LEFT-JUSTIFIED TO ev_target. + WRITE iv_arg LEFT-JUSTIFIED TO rv_target. ENDMETHOD.