SAP/abap2xlsx
1
0
Fork 0
mirror of https://github.com/abap2xlsx/abap2xlsx.git synced 2025-05-05 16:56:11 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

New ip_exact parameter of excel_string_to_date

Browse Source 
- I'm not comfortable about changing the logic in `excel_string_to_date`, in case other people have implemented a "-1 day" fix after the call, so I added a parameter `ip_exact` to keep an ascending compatibility.
- I reused the old structure of unit tests to simplify the diff
- fix #1205 (I added this time issue that you fixed, the original issue mentioned only the date issue)
This commit is contained in:
sandraros 2024-04-13 18:00:59 +00:00
parent 197c1c4de2
commit 47bac2e78d
4 changed files with 85 additions and 120 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
src/zcl_excel_common.clas.abap
View File

@ -102,9 +102,22 @@ CLASS zcl_excel_common DEFINITION
VALUE(ev_unescaped_string) TYPE string
RAISING
zcx_excel .
"! <p class="shorttext synchronized" lang="en">Convert date from Excel format to SAP</p>
"! @parameter ip_value | String being an Excel number representing a date (e.g. 45141 means 2023/08/03,
"! 45141.58832 means 2023/08/03 14:07:11). Important: if the input is date +
"! time, use the additional parameter IP_EXACT = 'X'.
"! @parameter ip_exact | If the input value also contains the time i.e. a fractional part exists
"! (e.g. 45141.58832 means 2023/08/03 14:07:11), ip_exact = 'X' will
"! return the exact date (e.g. 2023/08/03), while ip_exact = ' ' (default) will
"! return the rounded-up date (e.g. 2023/08/04). NB: this rounding-up doesn't
"! happen if the time is before 12:00:00.
"! @parameter ep_value | Date corresponding to the input Excel number. It returns a null date if
"! the input value contains non-numeric characters.
"! @raising zcx_excel | The numeric input corresponds to a date before 1900/1/1 or after 9999/12/31.
CLASS-METHODS excel_string_to_date
IMPORTING
!ip_value TYPE zexcel_cell_value
!ip_exact TYPE abap_bool DEFAULT abap_false
RETURNING
VALUE(ep_value) TYPE d
RAISING
@ -860,11 +873,16 @@ CLASS zcl_excel_common IMPLEMENTATION.
METHOD excel_string_to_date.
DATA: lv_date_int TYPE i.
DATA lv_error_text TYPE string.
CHECK ip_value IS NOT INITIAL AND ip_value CN ' 0'.
TRY.
lv_date_int = floor( ip_value ).
IF ip_exact = abap_false.
lv_date_int = ip_value.
ELSE.
lv_date_int = trunc( ip_value ).
ENDIF.
IF lv_date_int NOT BETWEEN 1 AND 2958465.
zcx_excel=>raise_text( 'Unable to interpret date' ).
ENDIF.
@ -876,7 +894,8 @@ CLASS zcl_excel_common IMPLEMENTATION.
ep_value = ep_value + 1.
ENDIF.
CATCH cx_sy_conversion_error.
zcx_excel=>raise_text( 'Index out of bounds' ).
lv_error_text = |String "{ ip_value }" is not a valid Excel date|.
zcx_excel=>raise_text( lv_error_text ).
ENDTRY.
ENDMETHOD.
@ -898,7 +917,7 @@ CLASS zcl_excel_common IMPLEMENTATION.
TRY.
lv_day_fraction = ip_value - floor( ip_value ).
lv_day_fraction = frac( ip_value ).
lv_seconds_in_day = lv_day_fraction * lc_seconds_in_day.
ep_value = lv_seconds_in_day.

172
src/zcl_excel_common.clas.testclasses.abap
View File

@ -1,8 +1,5 @@
CLASS lcl_excel_common_test DEFINITION DEFERRED.
CLASS lcl_string_to_date_and_time DEFINITION DEFERRED.
CLASS zcl_excel_common DEFINITION
LOCAL FRIENDS lcl_excel_common_test
lcl_string_to_date_and_time.
CLASS zcl_excel_common DEFINITION LOCAL FRIENDS lcl_excel_common_test.
*----------------------------------------------------------------------*
* CLASS lcl_Excel_Common_Test DEFINITION
@ -58,6 +55,7 @@ CLASS lcl_excel_common_test DEFINITION FOR TESTING
METHODS excel_string_to_time3 FOR TESTING RAISING cx_static_check.
METHODS excel_string_to_time4 FOR TESTING RAISING cx_static_check.
METHODS excel_string_to_time5 FOR TESTING RAISING cx_static_check.
METHODS excel_string_to_time6 FOR TESTING RAISING cx_static_check.
METHODS time_to_excel_string1 FOR TESTING RAISING cx_static_check.
METHODS time_to_excel_string2 FOR TESTING RAISING cx_static_check.
METHODS time_to_excel_string3 FOR TESTING RAISING cx_static_check.
@ -691,6 +689,45 @@ CLASS lcl_excel_common_test IMPLEMENTATION.
level = if_aunit_constants=>fatal
).
ENDTRY.
* 45141.58832 (2023/08/03 14:07:11) ip_exact = abap_false -> 2023/08/04
TRY.
ep_value = zcl_excel_common=>excel_string_to_date( ip_value = '45141.58832'
ip_exact = abap_false ).
cl_abap_unit_assert=>assert_equals(
act = ep_value
exp = '20230804' ).
CATCH zcx_excel INTO lx_excel.
cl_abap_unit_assert=>fail(
msg = 'unexpected exception'
level = if_aunit_constants=>critical ).
ENDTRY.
* 45141.58832 (2023/08/03 14:07:11) ip_exact = abap_true -> 2023/08/03
TRY.
ep_value = zcl_excel_common=>excel_string_to_date( ip_value = '45141.58832'
ip_exact = abap_true ).
cl_abap_unit_assert=>assert_equals(
act = ep_value
exp = '20230803' ).
CATCH zcx_excel INTO lx_excel.
cl_abap_unit_assert=>fail(
msg = 'unexpected exception'
level = if_aunit_constants=>critical ).
ENDTRY.
* 45141.48832 (2023/08/03 11:43:11) ip_exact = abap_false -> 2023/08/03
TRY.
ep_value = zcl_excel_common=>excel_string_to_date( ip_value = '45141.48832'
ip_exact = abap_false ).
cl_abap_unit_assert=>assert_equals(
act = ep_value
exp = '20230803' ).
CATCH zcx_excel INTO lx_excel.
cl_abap_unit_assert=>fail(
msg = 'unexpected exception'
level = if_aunit_constants=>critical ).
ENDTRY.
ENDMETHOD. "excel_String_To_Date
@ -770,6 +807,21 @@ CLASS lcl_excel_common_test IMPLEMENTATION.
ENDTRY.
ENDMETHOD.
METHOD excel_string_to_time6.
DATA ep_value TYPE t.
* 45141.58832 (2023/08/03 14:07:11) -> 14:07:11
TRY.
ep_value = zcl_excel_common=>excel_string_to_time( ip_value = '45141.58832' ).
cl_abap_unit_assert=>assert_equals(
act = ep_value
exp = '140711' ).
CATCH zcx_excel INTO lx_excel.
cl_abap_unit_assert=>fail( lx_excel->get_text( ) ).
ENDTRY.
ENDMETHOD.
METHOD time_to_excel_string1.
DATA ep_value TYPE zexcel_cell_value.
@ -1760,115 +1812,3 @@ CLASS lcl_excel_common_test IMPLEMENTATION.
ENDMETHOD.
ENDCLASS.
CLASS lcl_string_to_date_and_time DEFINITION FINAL FOR TESTING
DURATION SHORT
RISK LEVEL HARMLESS.
PRIVATE SECTION.
CONSTANTS date_20230803 TYPE d VALUE '20230803'.
CONSTANTS dbs1900_initial TYPE d VALUE '18991230'. "Serial date 0 in (default) 1900 date base system
CONSTANTS dbs1900bc_initial TYPE d VALUE '18991231'. "Serial date 0 in 1900 backwards compatibility date base system
CONSTANTS dbs1904bc_initial TYPE d VALUE '19040101'. "Serial date 0 in 1904 backwards compatibility date base system
CONSTANTS time_140711 TYPE t VALUE '140711'.
CONSTANTS time_initial TYPE t VALUE '000000'.
CONSTANTS dbs1900_20230803_000000 TYPE string VALUE `45141.000000000000`. "Serial date 2023-08-03 time zero
CONSTANTS dbs1900_00000000_140711 TYPE string VALUE `0.588321759256`. "Serial date zero time 14:07:11
CONSTANTS dbs1900_20230803_140711 TYPE string VALUE `45141.588321759256`. "Serial date 2023-08-03 time 14:07:11
DATA cut TYPE REF TO zcl_excel_common.
DATA excel_error TYPE REF TO zcx_excel.
METHODS:
setup,
teardown.
METHODS:
date_to_date FOR TESTING RAISING cx_static_check,
time_to_time FOR TESTING RAISING cx_static_check,
datetime_to_date FOR TESTING RAISING cx_static_check,
datetime_to_time FOR TESTING RAISING cx_static_check,
date_to_time FOR TESTING RAISING cx_static_check,
time_to_date FOR TESTING RAISING cx_static_check.
ENDCLASS.
CLASS lcl_string_to_date_and_time IMPLEMENTATION.
METHOD setup.
CREATE OBJECT cut.
ENDMETHOD.
METHOD teardown.
CLEAR cut.
CLEAR excel_error.
ENDMETHOD.
METHOD date_to_date.
TRY.
cl_abap_unit_assert=>assert_equals(
act = cut->excel_string_to_date( dbs1900_20230803_000000 )
exp = date_20230803 ).
CATCH zcx_excel INTO excel_error.
cl_abap_unit_assert=>fail( excel_error->get_text( ) ).
ENDTRY.
ENDMETHOD.
METHOD time_to_time.
TRY.
cl_abap_unit_assert=>assert_equals(
act = cut->excel_string_to_time( dbs1900_00000000_140711 )
exp = time_140711 ).
CATCH zcx_excel INTO excel_error.
cl_abap_unit_assert=>fail( excel_error->get_text( ) ).
ENDTRY.
ENDMETHOD.
METHOD datetime_to_date.
TRY.
cl_abap_unit_assert=>assert_equals(
act = cut->excel_string_to_date( dbs1900_20230803_140711 )
exp = date_20230803 ).
CATCH zcx_excel INTO excel_error.
cl_abap_unit_assert=>fail( excel_error->get_text( ) ).
ENDTRY.
ENDMETHOD.
METHOD datetime_to_time.
TRY.
cl_abap_unit_assert=>assert_equals(
act = cut->excel_string_to_time( dbs1900_20230803_140711 )
exp = time_140711 ).
CATCH zcx_excel INTO excel_error.
cl_abap_unit_assert=>fail( excel_error->get_text( ) ).
ENDTRY.
ENDMETHOD.
METHOD date_to_time.
TRY.
cl_abap_unit_assert=>assert_equals(
act = cut->excel_string_to_time( dbs1900_20230803_000000 )
exp = time_initial ).
CATCH zcx_excel INTO excel_error.
cl_abap_unit_assert=>fail( excel_error->get_text( ) ).
ENDTRY.
ENDMETHOD.
METHOD time_to_date.
TRY.
cl_abap_unit_assert=>assert_equals(
act = cut->excel_string_to_date( dbs1900_00000000_140711 )
exp = dbs1900_initial ).
cl_abap_unit_assert=>fail( 'Until dates before 1900-01-01 are supported, an exception is expected' ).
CATCH zcx_excel INTO excel_error.
* cl_abap_unit_assert=>fail( excel_error->get_text( ) ).
cl_abap_unit_assert=>assert_equals(
act = excel_error->get_text( )
exp = 'Unable to interpret date' ).
ENDTRY.
ENDMETHOD.
ENDCLASS.

5
src/zcl_excel_common.clas.xml
View File

@ -120,6 +120,11 @@
<LANGU>I</LANGU>
<DESCRIPT>Excel baseline date</DESCRIPT>
</SEOCOMPOTX>
<SEOCOMPOTX>
<CMPNAME>C_EXCEL_BASELINE_DATE</CMPNAME>
<LANGU>E</LANGU>
<DESCRIPT>Excel baseline date</DESCRIPT>
</SEOCOMPOTX>
<SEOCOMPOTX>
<CMPNAME>C_EXCEL_BASELINE_DATE</CMPNAME>
<LANGU>I</LANGU>

3
src/zcl_excel_worksheet.clas.abap
View File

@ -2328,7 +2328,8 @@ CLASS zcl_excel_worksheet IMPLEMENTATION.
IF sy-subrc EQ 0.
CASE ls_style_conv-abap_type.
WHEN cl_abap_typedescr=>typekind_date.
<lv_data> = zcl_excel_common=>excel_string_to_date( <ls_sheet_content>-cell_value ).
<lv_data> = zcl_excel_common=>excel_string_to_date( ip_value = <ls_sheet_content>-cell_value
ip_exact = abap_true ).
WHEN cl_abap_typedescr=>typekind_time.
<lv_data> = zcl_excel_common=>excel_string_to_time( <ls_sheet_content>-cell_value ).
ENDCASE.