preserve pre-release and build parts of a version

mbtools · mbtools · commit 99c619af29ac · 2024-02-07T17:51:51.000Z
preserve pre-release and build parts of a version on coerce
diff --git a/.abapgit.xml b/.abapgit.xml
@@ -2,9 +2,17 @@
 <asx:abap xmlns:asx="http://www.sap.com/abapxml" version="1.0">
  <asx:values>
   <DATA>
+   <NAME>semver</NAME>
    <MASTER_LANGUAGE>E</MASTER_LANGUAGE>
    <STARTING_FOLDER>/src/</STARTING_FOLDER>
    <FOLDER_LOGIC>PREFIX</FOLDER_LOGIC>
+   <REQUIREMENTS>
+    <item>
+     <COMPONENT>SAP_BASIS</COMPONENT>
+     <MIN_RELEASE>740</MIN_RELEASE>
+    </item>
+   </REQUIREMENTS>
+   <VERSION_CONSTANT>ZIF_SEMVER_CONSTANTS=&gt;VERSION</VERSION_CONSTANT>
   </DATA>
  </asx:values>
 </asx:abap>
diff --git a/src/classes/zcl_semver.clas.abap b/src/classes/zcl_semver.clas.abap
@@ -110,9 +110,9 @@ CLASS zcl_semver IMPLEMENTATION.
     IF semver->version = version.
       result = 0.
     ELSE.
-      result = compare_main( other ).
+      result = compare_main( semver ).
       IF result = 0.
-        result = compare_pre( other ).
+        result = compare_pre( semver ).
       ENDIF.
     ENDIF.
 
diff --git a/src/functions/zcl_semver_functions.clas.abap b/src/functions/zcl_semver_functions.clas.abap
@@ -325,44 +325,60 @@ CLASS zcl_semver_functions IMPLEMENTATION.
 
     TYPES:
       BEGIN OF ty_match,
-        major  TYPE string,
-        minor  TYPE string,
-        patch  TYPE string,
-        offset TYPE i,
-        length TYPE i,
-        endpos TYPE i,
+        major      TYPE string,
+        minor      TYPE string,
+        patch      TYPE string,
+        prerelease TYPE string,
+        build      TYPE string,
+        offset     TYPE i,
+        length     TYPE i,
+        endpos     TYPE i,
       END OF ty_match.
 
     DATA matches TYPE STANDARD TABLE OF ty_match.
 
     " cl_abap_matcher has a problem with '1.2.3.4.5.6' so we use FIND REGEX
 
-    DATA(r) = COND #(
-      WHEN rtl = abap_true
-      THEN zcl_semver_re=>token-coercertl-safe_src
-      ELSE zcl_semver_re=>token-coerce-safe_src ).
-
     IF rtl = abap_false.
-      FIND REGEX r IN version SUBMATCHES DATA(rest) DATA(major) DATA(minor) DATA(patch).
+      DATA(r) = COND #(
+        WHEN incpre = abap_true
+        THEN zcl_semver_re=>token-coercefull-safe_src
+        ELSE zcl_semver_re=>token-coerce-safe_src ).
+
+      FIND REGEX r IN version SUBMATCHES DATA(rest) DATA(major) DATA(minor) DATA(patch) DATA(prerelease) DATA(build).
       IF sy-subrc <> 0.
         RETURN.
       ENDIF.
     ELSE.
       " Find the right-most coercible string that does not share
       " a terminus with a more left-ward coercible string.
       " Eg, '1.2.3.4' wants to coerce '2.3.4', not '3.4' or '4'
+      r = COND #(
+        WHEN incpre = abap_true
+        THEN zcl_semver_re=>token-coercertlfull-safe_src
+        ELSE zcl_semver_re=>token-coercertl-safe_src ).
+
       DATA(offset) = 0.
       DO.
-        FIND REGEX r IN version+offset(*) SUBMATCHES rest major minor patch.
+        FIND REGEX r IN version+offset(*) SUBMATCHES rest major minor patch prerelease build.
         IF sy-subrc <> 0.
           EXIT.
         ENDIF.
         INSERT INITIAL LINE INTO TABLE matches ASSIGNING FIELD-SYMBOL(<match>).
-        <match>-major  = major.
-        <match>-minor  = minor.
-        <match>-patch  = patch.
+        <match>-major      = major.
+        <match>-minor      = minor.
+        <match>-patch      = patch.
+        <match>-prerelease = prerelease.
+        <match>-build      = build.
+
+        DATA(match) = |{ major }|
+             && |{ COND #( WHEN minor IS NOT INITIAL THEN '.' && minor ) }|
+             && |{ COND #( WHEN patch IS NOT INITIAL THEN '.' && patch ) }|
+             && |{ COND #( WHEN prerelease IS NOT INITIAL THEN '-' && prerelease ) }|
+             && |{ COND #( WHEN build IS NOT INITIAL THEN '+' && build ) }|.
+
         <match>-offset = offset.
-        <match>-length = strlen( |{ major }{ COND #( WHEN minor IS NOT INITIAL THEN '.' && minor ) }{ COND #( WHEN patch IS NOT INITIAL THEN '.' && patch ) }| ).
+        <match>-length = strlen( match ).
         <match>-endpos = <match>-offset + <match>-length.
         FIND REGEX '^\d' IN version+offset(*) MATCH OFFSET DATA(next_offset).
         offset += next_offset + 1.
@@ -375,9 +391,11 @@ CLASS zcl_semver_functions IMPLEMENTATION.
       IF sy-subrc <> 0.
         EXIT.
       ENDIF.
-      major = <match>-major.
-      minor = <match>-minor.
-      patch = <match>-patch.
+      major      = <match>-major.
+      minor      = <match>-minor.
+      patch      = <match>-patch.
+      prerelease = <match>-prerelease.
+      build      = <match>-build.
     ENDIF.
 
     IF minor IS INITIAL.
@@ -388,7 +406,19 @@ CLASS zcl_semver_functions IMPLEMENTATION.
       patch = '0'.
     ENDIF.
 
-    result = parse( version = |{ major }.{ minor }.{ patch }| loose = loose incpre = incpre ).
+    IF incpre = abap_true AND prerelease IS NOT INITIAL.
+      prerelease = |-{ prerelease }|.
+    ELSE.
+      prerelease = ''.
+    ENDIF.
+
+    IF incpre = abap_true AND build IS NOT INITIAL.
+      build = |+{ build }|.
+    ELSE.
+      build = ''.
+    ENDIF.
+
+    result = parse( version = |{ major }.{ minor }.{ patch }{ prerelease }{ build }| loose = loose incpre = incpre ).
 
   ENDMETHOD.
 
diff --git a/src/functions/zcl_semver_functions.clas.testclasses.abap b/src/functions/zcl_semver_functions.clas.testclasses.abap
@@ -18,7 +18,9 @@ CLASS ltcl_semver_functions DEFINITION FOR TESTING RISK LEVEL HARMLESS
       cmp_equality FOR TESTING RAISING zcx_semver_error,
       coerce_to_null FOR TESTING RAISING zcx_semver_error,
       coerce_to_valid FOR TESTING RAISING zcx_semver_error,
+      coerce_to_valid_incpre FOR TESTING RAISING zcx_semver_error,
       coerce_rtl FOR TESTING RAISING zcx_semver_error,
+      coerce_rtl_incpre FOR TESTING RAISING zcx_semver_error,
       compare FOR TESTING RAISING zcx_semver_error,
       compare_build FOR TESTING RAISING zcx_semver_error,
       compare_loose FOR TESTING RAISING zcx_semver_error,
@@ -60,8 +62,7 @@ CLASS ltcl_semver_functions IMPLEMENTATION.
       ( range = '>1.2.3' version = '' )
       ( range = '~1.2.3' version = '' )
       ( range = '<=1.2.3' version = '' )
-      ( range = '1.2.x' version = '' )
-      ( range = '0.12.0-dev.1150+3c22cecee' version = '0.12.0-dev.1150' ) ).
+      ( range = '1.2.x' version = '' ) ).
 
     LOOP AT tests INTO DATA(test).
       cl_abap_unit_assert=>assert_equals(
@@ -278,15 +279,70 @@ CLASS ltcl_semver_functions IMPLEMENTATION.
 
     LOOP AT tests INTO DATA(test).
       DATA(semver) = zcl_semver_functions=>coerce( test-version ).
+      DATA(expected) = zcl_semver_functions=>parse( test-res ).
 
       cl_abap_unit_assert=>assert_bound(
         act = semver
         msg = |{ test-version } { test-res }| ).
 
       cl_abap_unit_assert=>assert_equals(
-        act = semver->version
-        exp = test-res
+        act = expected->compare( semver )
+        exp = 0
+        msg = |{ test-version } should be equal to { test-res }| ).
+
+      cl_abap_unit_assert=>assert_equals(
+        act = expected->compare_build( semver )
+        exp = 0
+        msg = |{ test-version } build should be equal to { test-res }| ).
+    ENDLOOP.
+
+  ENDMETHOD.
+
+  METHOD coerce_to_valid_incpre.
+
+    TYPES:
+      BEGIN OF ty_test,
+        version TYPE string,
+        res     TYPE string,
+      END OF ty_test.
+
+    DATA tests TYPE TABLE OF ty_test.
+
+    tests = VALUE #(
+      ( version = '1-rc.5' res = '1.0.0-rc.5' )
+      ( version = '1.2-rc.5' res = '1.2.0-rc.5' )
+      ( version = '1.2.3-rc.5' res = '1.2.3-rc.5' )
+      ( version = '1.2.3-rc.5/a' res = '1.2.3-rc.5' )
+      ( version = '1.2.3.4-rc.5' res = '1.2.3' )
+      ( version = '1.2.3.4+rev.6' res = '1.2.3' )
+      ( version = '1+rev.6' res = '1.0.0+rev.6' )
+      ( version = '1.2+rev.6' res = '1.2.0+rev.6' )
+      ( version = '1.2.3+rev.6' res = '1.2.3+rev.6' )
+      ( version = '1.2.3+rev.6/a' res = '1.2.3+rev.6' )
+      ( version = '1.2.3.4-rc.5' res = '1.2.3' )
+      ( version = '1.2.3.4+rev.6' res = '1.2.3' )
+      ( version = '1-rc.5+rev.6' res = '1.0.0-rc.5+rev.6' )
+      ( version = '1.2-rc.5+rev.6' res = '1.2.0-rc.5+rev.6' )
+      ( version = '1.2.3-rc.5+rev.6' res = '1.2.3-rc.5+rev.6' )
+      ( version = '1.2.3-rc.5+rev.6/a' res = '1.2.3-rc.5+rev.6' ) ).
+
+    LOOP AT tests INTO DATA(test).
+      DATA(semver) = zcl_semver_functions=>coerce( version = test-version incpre = abap_true ).
+      DATA(expected) = zcl_semver_functions=>parse( version = test-res incpre = abap_true ).
+
+      cl_abap_unit_assert=>assert_bound(
+        act = semver
         msg = |{ test-version } { test-res }| ).
+
+      cl_abap_unit_assert=>assert_equals(
+        act = expected->compare( semver )
+        exp = 0
+        msg = |{ test-version } should be equal to { test-res }| ).
+
+      cl_abap_unit_assert=>assert_equals(
+        act = expected->compare_build( semver )
+        exp = 0
+        msg = |{ test-version } build should be equal to { test-res }| ).
     ENDLOOP.
 
   ENDMETHOD.
@@ -314,15 +370,62 @@ CLASS ltcl_semver_functions IMPLEMENTATION.
 
     LOOP AT tests INTO DATA(test).
       DATA(semver) = zcl_semver_functions=>coerce( version = test-version rtl = abap_true ).
+      DATA(expected) = zcl_semver_functions=>parse( version = test-res ).
 
       cl_abap_unit_assert=>assert_bound(
         act = semver
         msg = |{ test-version } { test-res }| ).
 
       cl_abap_unit_assert=>assert_equals(
-        act = semver->version
-        exp = test-res
+        act = expected->compare( semver )
+        exp = 0
+        msg = |{ test-version } should be equal to { test-res }| ).
+
+      cl_abap_unit_assert=>assert_equals(
+        act = expected->compare_build( semver )
+        exp = 0
+        msg = |{ test-version } build should be equal to { test-res }| ).
+    ENDLOOP.
+
+  ENDMETHOD.
+
+  METHOD coerce_rtl_incpre.
+
+    TYPES:
+      BEGIN OF ty_test,
+        version TYPE string,
+        res     TYPE string,
+      END OF ty_test.
+
+    DATA tests TYPE TABLE OF ty_test.
+
+    tests = VALUE #(
+      ( version = '1.2-rc.5+rev.6' res = '1.2.0-rc.5+rev.6' )
+      ( version = '1.2.3-rc.5+rev.6' res = '1.2.3-rc.5+rev.6' )
+      ( version = '1.2.3.4-rc.5+rev.6' res = '2.3.4-rc.5+rev.6' )
+      ( version = '1.2.3.4-rc.5' res = '2.3.4-rc.5' )
+      ( version = '1.2.3.4+rev.6' res = '2.3.4+rev.6' )
+      ( version = '1.2.3.4-rc.5+rev.6/7' res = '7.0.0' )
+      ( version = '1.2.3.4-rc/7.5+rev.6' res = '7.5.0+rev.6' )
+      ( version = '1.2.3.4/7-rc.5+rev.6' res = '7.0.0-rc.5+rev.6' ) ).
+
+    LOOP AT tests INTO DATA(test).
+      DATA(semver) = zcl_semver_functions=>coerce( version = test-version rtl = abap_true incpre = abap_true ).
+      DATA(expected) = zcl_semver_functions=>parse( version = test-res incpre = abap_true ).
+
+      cl_abap_unit_assert=>assert_bound(
+        act = semver
         msg = |{ test-version } { test-res }| ).
+
+      cl_abap_unit_assert=>assert_equals(
+        act = expected->compare( semver )
+        exp = 0
+        msg = |{ test-version } should be equal to { test-res }| ).
+
+      cl_abap_unit_assert=>assert_equals(
+        act = expected->compare_build( semver )
+        exp = 0
+        msg = |{ test-version } build should be equal to { test-res }| ).
     ENDLOOP.
 
   ENDMETHOD.
diff --git a/src/internal/zcl_semver_re.clas.abap b/src/internal/zcl_semver_re.clas.abap
@@ -42,7 +42,10 @@ CLASS zcl_semver_re DEFINITION
         caretloose                TYPE ty_token,
         carettrim                 TYPE ty_token,
         coerce                    TYPE ty_token,
+        coercefull                TYPE ty_token,
+        coerceplain               TYPE ty_token,
         coercertl                 TYPE ty_token,
+        coercertlfull             TYPE ty_token,
         comparator                TYPE ty_token,
         comparatorloose           TYPE ty_token,
         comparatortrim            TYPE ty_token,
@@ -266,15 +269,27 @@ CLASS zcl_semver_re IMPLEMENTATION.
     " Extract anything that could conceivably be a part of a valid semver
 
     create_token(
-      name  = 'COERCE'
+      name  = 'COERCEPLAIN'
       value = |(^\|[^\\d])(\\d\{1,{ zif_semver_constants=>max_safe_component_length }\})| &&
               |(?:\\.(\\d\{1,{ zif_semver_constants=>max_safe_component_length }\}))?| &&
-              |(?:\\.(\\d\{1,{ zif_semver_constants=>max_safe_component_length }\}))?| &&
+              |(?:\\.(\\d\{1,{ zif_semver_constants=>max_safe_component_length }\}))?| ).
+    create_token(
+      name  = 'COERCE'
+      value = |{ token-coerceplain-src }(?:$\|[^\\d])| ).
+    create_token(
+      name  = 'COERCEFULL'
+      value = |{ token-coerceplain-src }| &&
+              |(?:{ token-prerelease-src })?| &&
+              |(?:{ token-build-src })?| &&
               |(?:$\|[^\\d])| ).
     create_token(
       name  = 'COERCERTL'
       value = token-coerce-src
       is_global = abap_true ).
+    create_token(
+      name  = 'COERCERTLFULL'
+      value = token-coercefull-src
+      is_global = abap_true ).
 
     " Tilde ranges.
     " Meaning is "reasonably at or greater than"
diff --git a/src/internal/zif_semver_constants.intf.abap b/src/internal/zif_semver_constants.intf.abap
@@ -7,12 +7,12 @@ INTERFACE zif_semver_constants PUBLIC.
 * ABAP Port by Marc Bernard <https://marcbernardtools.com/>
 * SPDX-License-Identifier: ISC
 ************************************************************************
-* Based on node semver package v7.5.4 (July 2023)
-* https://github.com/npm/node-semver/releases/tag/v7.5.4
+* Based on node semver package v7.6.0 (January 2024)
+* https://github.com/npm/node-semver/releases/tag/v7.6.0
 ************************************************************************
 
   " Package version
-  CONSTANTS version TYPE string VALUE '7.5.4' ##NEEDED.
+  CONSTANTS version TYPE string VALUE '7.6.0' ##NEEDED.
 
   " Note: this is the semver.org version of the spec that it implements
   " Not necessarily the package version of this code.
