Update to 7.5.0

mbtools · mbtools · commit bcb1c607db57 · 2023-04-21T10:44:57.000Z
diff --git a/src/classes/zcl_semver.clas.abap b/src/classes/zcl_semver.clas.abap
@@ -81,7 +81,7 @@ CLASS zcl_semver DEFINITION
       IMPORTING
         release         TYPE string
         identifier      TYPE string OPTIONAL
-        identifier_base TYPE i DEFAULT 0
+        identifier_base TYPE string OPTIONAL
       RETURNING
         VALUE(result)   TYPE REF TO zcl_semver
       RAISING
@@ -219,7 +219,7 @@ CLASS zcl_semver IMPLEMENTATION.
         DATA(m) = r->create_matcher( text = zcl_semver_utils=>version_trim( version ) ).
 
         IF NOT m->match( ).
-          zcx_semver_error=>raise( |Invalid version { version }| ).
+          zcx_semver_error=>raise( |Invalid version: { version }| ).
         ENDIF.
 
         raw = version.
@@ -232,19 +232,19 @@ CLASS zcl_semver IMPLEMENTATION.
         IF major_num BETWEEN 0 AND zif_semver_constants=>max_safe_integer.
           major = major_num.
         ELSE.
-          zcx_semver_error=>raise( |Invalid major version { major_num }| ).
+          zcx_semver_error=>raise( |Invalid major version: { major_num }| ).
         ENDIF.
 
         IF minor_num BETWEEN 0 AND zif_semver_constants=>max_safe_integer.
           minor = minor_num.
         ELSE.
-          zcx_semver_error=>raise( |Invalid minor version { minor_num }| ).
+          zcx_semver_error=>raise( |Invalid minor version: { minor_num }| ).
         ENDIF.
 
         IF patch_num BETWEEN 0 AND zif_semver_constants=>max_safe_integer.
           patch = patch_num.
         ELSE.
-          zcx_semver_error=>raise( |Invalid patch version { patch_num }| ).
+          zcx_semver_error=>raise( |Invalid patch version: { patch_num }| ).
         ENDIF.
 
         DATA(m4) = m->get_submatch( 4 ).
@@ -315,6 +315,10 @@ CLASS zcl_semver IMPLEMENTATION.
 
   METHOD inc.
 
+    CONSTANTS false TYPE string VALUE 'false'.
+
+    DATA prerelease_tab LIKE prerelease.
+
     CASE release.
       WHEN 'premajor'.
         CLEAR prerelease.
@@ -374,8 +378,18 @@ CLASS zcl_semver IMPLEMENTATION.
       WHEN 'pre'.
         " This probably shouldn't be used publicly.
         " 1.0.0 'pre' would become 1.0.0-0 which is the wrong direction.
+        IF identifier_base IS INITIAL OR identifier_base = `0`.
+          DATA(base) = `0`.
+        ELSE.
+          base = COND #( WHEN zcl_semver_utils=>is_numeric( identifier_base ) THEN `1` ELSE `0` ).
+        ENDIF.
+
+        IF identifier IS INITIAL AND identifier_base = false.
+          zcx_semver_error=>raise( 'Invalid increment argument: identifier is empty' ).
+        ENDIF.
+
         IF prerelease IS INITIAL.
-          prerelease = VALUE #( ( `0` ) ).
+          prerelease = VALUE #( ( base ) ).
         ELSE.
           DATA(i) = lines( prerelease ).
           WHILE i > 0.
@@ -388,19 +402,28 @@ CLASS zcl_semver IMPLEMENTATION.
           ENDWHILE.
           IF i = 0.
             " didn't increment anything
-            INSERT `0` INTO TABLE prerelease.
+            DATA(prerelease_string) = concat_lines_of( table = prerelease sep = '.' ).
+            IF identifier = prerelease_string AND identifier_base = false.
+              zcx_semver_error=>raise( 'Invalid increment argument: identifier already exists' ).
+            ENDIF.
+
+            INSERT base INTO TABLE prerelease.
           ENDIF.
         ENDIF.
         IF identifier IS NOT INITIAL.
-          DATA(base) = COND #( WHEN identifier_base <> 0 THEN `1` ELSE `0` ).
           " 1.2.0-beta.1 bumps to 1.2.0-beta.2,
           " 1.2.0-beta.fooblz or 1.2.0-beta bumps to 1.2.0-beta.0
+          prerelease_tab = VALUE #( ( identifier ) ( base ) ).
+          IF identifier_base = false.
+            prerelease_tab =  VALUE #( ( identifier ) ).
+          ENDIF.
+
           IF zcl_semver_identifiers=>compare_identifiers( a = prerelease[ 1 ] b = identifier ) = 0.
             IF NOT zcl_semver_utils=>is_numeric( VALUE #( prerelease[ 2 ] DEFAULT `-` ) ).
-              prerelease = VALUE #( ( identifier ) ( base ) ).
+              prerelease = prerelease_tab.
             ENDIF.
           ELSE.
-            prerelease = VALUE #( ( identifier ) ( base ) ).
+            prerelease = prerelease_tab.
           ENDIF.
         ENDIF.
 
diff --git a/src/cli/zcl_semver_cli.clas.abap b/src/cli/zcl_semver_cli.clas.abap
@@ -39,7 +39,7 @@ CLASS zcl_semver_cli DEFINITION
       ranges          TYPE string_table,
       inc             TYPE string,
       identifier      TYPE string,
-      identifier_base TYPE i,
+      identifier_base TYPE string,
       loose           TYPE abap_bool,
       incpre          TYPE abap_bool,
       coerce          TYPE abap_bool,
@@ -84,8 +84,10 @@ CLASS zcl_semver_cli IMPLEMENTATION.
       ( `-l --loose` )
       ( `        Interpret versions and ranges loosely` )
       ( `` )
-      ( `-n <0|1>` )
-      ( `        This is the base to be used for the prerelease identifier.` )
+      ( `-n <base>` )
+      ( `        Base number to be used for the prerelease identifier.` )
+      ( `        Can be either 0 or 1, or false to omit the number altogether.` )
+      ( `        Defaults to 0.` )
       ( `` )
       ( `-p --include-prerelease` )
       ( `        Always include prerelease versions in range matching` )
diff --git a/src/cli/zcl_semver_cli.clas.testclasses.abap b/src/cli/zcl_semver_cli.clas.testclasses.abap
@@ -90,6 +90,10 @@ CLASS ltcl_semver_cli IMPLEMENTATION.
       args = '-i premajor 1.0.0 --preid=beta -n 1'
       out  = |2.0.0-beta.1\n| ).
 
+    test(
+      args = '-i premajor 1.0.0 --preid=beta -n false'
+      out  = |2.0.0-beta\n| ).
+
     test(
       args = '-i 1.2.3'
       out  = |1.2.4\n| ).
diff --git a/src/functions/zcl_semver_functions.clas.abap b/src/functions/zcl_semver_functions.clas.abap
@@ -123,7 +123,7 @@ CLASS zcl_semver_functions DEFINITION
         version         TYPE any
         release         TYPE string
         identifier      TYPE string OPTIONAL
-        identifier_base TYPE i DEFAULT 0
+        identifier_base TYPE string OPTIONAL
         loose           TYPE abap_bool DEFAULT abap_false
         incpre          TYPE abap_bool DEFAULT abap_false
       RETURNING
@@ -185,6 +185,7 @@ CLASS zcl_semver_functions DEFINITION
         version       TYPE any
         loose         TYPE abap_bool DEFAULT abap_false
         incpre        TYPE abap_bool DEFAULT abap_false
+        throw_errors  TYPE abap_bool DEFAULT abap_false
       RETURNING
         VALUE(result) TYPE REF TO zcl_semver
       RAISING
@@ -426,40 +427,62 @@ CLASS zcl_semver_functions IMPLEMENTATION.
 
   METHOD diff.
 
-    CHECK NOT eq( a = version_1 b = version_2 ).
+    DATA(v1) = parse( version = version_1 throw_errors = abap_true ).
+    DATA(v2) = parse( version = version_2 throw_errors = abap_true ).
 
-    DATA(semver_1) = parse( version_1 ).
-    DATA(semver_2) = parse( version_2 ).
+    DATA(comparison) = v1->compare( v2 ).
 
-    CHECK semver_1 IS BOUND AND semver_2 IS BOUND.
+    IF comparison = 0.
+      RETURN.
+    ENDIF.
 
-    DATA(has_pre) = xsdbool( semver_1->prerelease IS NOT INITIAL OR semver_2->prerelease IS NOT INITIAL ).
+    DATA(v1_higher)    = xsdbool( comparison > 0 ).
+    DATA(high_version) = COND #( WHEN v1_higher = abap_true THEN v1 ELSE v2 ).
+    DATA(low_version)  = COND #( WHEN v1_higher = abap_true THEN v2 ELSE v1 ).
+    DATA(high_has_pre) = xsdbool( high_version->prerelease IS NOT INITIAL ).
 
-    IF has_pre = abap_true.
-      DATA(prefix) = 'pre'.
-      DATA(default_result) = 'prerelease'.
-    ENDIF.
+    " add the `pre` prefix if we are going to a prerelease version
+    DATA(prefix) = COND #( WHEN high_has_pre = abap_true THEN 'pre' ELSE '' ).
 
-    IF semver_1->major <> semver_2->major.
+    IF v1->major <> v2->major.
       result = prefix && 'major'.
-    ELSEIF semver_1->minor <> semver_2->minor.
+      RETURN.
+    ENDIF.
+
+    IF v1->minor <> v2->minor.
       result = prefix && 'minor'.
-    ELSEIF semver_1->patch <> semver_2->patch.
+      RETURN.
+    ENDIF.
+
+    IF v1->patch <> v2->patch.
       result = prefix && 'patch'.
-    ELSEIF semver_1->prerelease IS INITIAL OR semver_2->prerelease IS INITIAL.
-      IF semver_1->patch IS NOT INITIAL.
-        result = 'patch'.
-      ELSEIF semver_1->minor IS NOT INITIAL.
-        result = 'minor'.
-      ELSEIF semver_1->major IS NOT INITIAL.
-        result = 'major'.
-      ELSE.
-        result = default_result. " may be undefined
-      ENDIF.
-    ELSE.
-      result = default_result. " may be undefined
+      RETURN.
+    ENDIF.
+
+    " at this point we know stable versions match but overall versions are not equal,
+    " so either they are both prereleases, or the lower version is a prerelease
+
+    IF high_has_pre = abap_true.
+      " high and low are preleases
+      result = 'prerelease'.
+      RETURN.
+    ENDIF.
+
+    IF low_version->patch IS NOT INITIAL.
+      " anything higher than a patch bump would result in the wrong version
+      result = 'patch'.
+      RETURN.
+    ENDIF.
+
+    IF low_version->minor IS NOT INITIAL.
+      " anything higher than a minor bump would result in the wrong version
+      result = 'minor'.
+      RETURN.
     ENDIF.
 
+    " bumping major/minor/patch all have same result
+    result = 'major'.
+
   ENDMETHOD.
 
 
@@ -565,13 +588,14 @@ CLASS zcl_semver_functions IMPLEMENTATION.
       RETURN.
     ENDIF.
 
-    CHECK kind = cl_abap_typedescr=>typekind_char OR kind = cl_abap_typedescr=>typekind_string.
-
-    CHECK strlen( version ) <= zif_semver_constants=>max_length.
-
     TRY.
         result = zcl_semver=>create( version = version loose = loose incpre = incpre ).
-      CATCH zcx_semver_error ##NO_HANDLER.
+      CATCH zcx_semver_error INTO DATA(error).
+        IF throw_errors = abap_false.
+          RETURN.
+        ENDIF.
+
+        RAISE EXCEPTION error.
     ENDTRY.
 
   ENDMETHOD.
diff --git a/src/functions/zcl_semver_functions.clas.testclasses.abap b/src/functions/zcl_semver_functions.clas.testclasses.abap
@@ -499,10 +499,19 @@ CLASS ltcl_semver_functions IMPLEMENTATION.
       ( v1 = '1.1.0' v2 = '1.1.0-pre' res = 'minor' )
       ( v1 = '1.1.0-pre-1' v2 = '1.1.0-pre-2' res = 'prerelease' )
       ( v1 = '1.0.0' v2 = '1.0.0' res = '' )
+      ( v1 = '1.0.0-1' v2 = '1.0.0-1' res = '' )
       ( v1 = '0.0.2-1' v2 = '0.0.2' res = 'patch' )
+      ( v1 = '0.0.2-1' v2 = '0.0.3' res = 'patch' )
+      ( v1 = '0.0.2-1' v2 = '0.1.0' res = 'minor' )
+      ( v1 = '0.0.2-1' v2 = '1.0.0' res = 'major' )
       ( v1 = '0.1.0-1' v2 = '0.1.0' res = 'minor' )
       ( v1 = '1.0.0-1' v2 = '1.0.0' res = 'major' )
-      ( v1 = '0.0.0-1' v2 = '0.0.0' res = 'prerelease' ) ).
+      ( v1 = '1.0.1-1' v2 = '1.0.1' res = 'patch' )
+      ( v1 = '0.0.0-1' v2 = '0.0.0' res = 'major' )
+      ( v1 = '1.0.0-1' v2 = '2.0.0' res = 'major' )
+      ( v1 = '1.0.0-1' v2 = '2.0.0-1' res = 'premajor' )
+      ( v1 = '1.0.0-1' v2 = '1.1.0-1' res = 'preminor' )
+      ( v1 = '1.0.0-1' v2 = '1.0.1-1' res = 'prepatch' ) ).
 
     LOOP AT tests INTO DATA(test).
       DATA(msg) = |{ test-v1 } { test-v2 } { test-res } |.
@@ -513,6 +522,18 @@ CLASS ltcl_semver_functions IMPLEMENTATION.
         msg = msg ).
     ENDLOOP.
 
+    " throws on bad version
+    TRY.
+        zcl_semver_functions=>diff(
+          version_1 = 'bad'
+          version_2 = '1.2.3' ).
+        cl_abap_unit_assert=>fail( ).
+      CATCH zcx_semver_error INTO DATA(error).
+        cl_abap_unit_assert=>assert_equals(
+          act = error->get_text( )
+          exp = 'Invalid version: bad' ).
+    ENDTRY.
+
   ENDMETHOD.
 
   METHOD eq.
@@ -903,6 +924,18 @@ CLASS ltcl_semver_functions IMPLEMENTATION.
         msg = msg ).
     ENDLOOP.
 
+    " throw errors if asked to
+    TRY.
+        zcl_semver_functions=>parse(
+          version      = 'bad'
+          throw_errors = abap_true ).
+        cl_abap_unit_assert=>fail( ).
+      CATCH zcx_semver_error INTO DATA(error).
+        cl_abap_unit_assert=>assert_equals(
+          act = error->get_text( )
+          exp = 'Invalid version: bad' ).
+    ENDTRY.
+
     " parse a version into a SemVer object
     cl_abap_unit_assert=>assert_equals(
       act = zcl_semver_functions=>parse( '1.2.3' )->version
diff --git a/src/internal/zcl_semver_fixtures.clas.abap b/src/internal/zcl_semver_fixtures.clas.abap
@@ -56,7 +56,7 @@ CLASS zcl_semver_fixtures DEFINITION
         loose           TYPE abap_bool,
         incpre          TYPE abap_bool,
         identifier      TYPE string,
-        identifier_base TYPE i,
+        identifier_base TYPE string,
       END OF ty_increment,
       ty_increments TYPE STANDARD TABLE OF ty_increment WITH DEFAULT KEY.
 
@@ -368,6 +368,7 @@ CLASS zcl_semver_fixtures IMPLEMENTATION.
       ( version = '1.2.3-1' release = 'preminor' res = '1.3.0-dev.0' identifier = 'dev' )
       ( version = '1.2.0' release = 'premajor' res = '2.0.0-dev.0' identifier = 'dev' )
       ( version = '1.2.3-1' release = 'premajor' res = '2.0.0-dev.0' identifier = 'dev' )
+      ( version = '1.2.3-1' release = 'premajor' res = '2.0.0-dev.1' identifier = 'dev' identifier_base = '1' )
       ( version = '1.2.0-1' release = 'minor' res = '1.2.0' identifier = 'dev' )
       ( version = '1.0.0-1' release = 'major' res = '1.0.0' identifier = 'dev' )
       ( version = '1.2.3-dev.bar' release = 'prerelease' res = '1.2.3-dev.0' identifier = 'dev' )
@@ -377,19 +378,40 @@ CLASS zcl_semver_fixtures IMPLEMENTATION.
       ( version = '1.2.3-1.1' release = 'prerelease' res = '1.2.3-1.2' identifier = '1' )
       ( version = '1.2.3-1.1' release = 'prerelease' res = '1.2.3-2.0' identifier = '2' )
 
-      ( version = '1.2.0-1' release = 'prerelease' res = '1.2.0-alpha.0' identifier = 'alpha' identifier_base = 0 )
-      ( version = '1.2.1' release = 'prerelease' res = '1.2.2-alpha.0' identifier = 'alpha' identifier_base = 0 )
-      ( version = '0.2.0' release = 'prerelease' res = '0.2.1-alpha.0' identifier = 'alpha' identifier_base = 0 )
-      ( version = '1.2.2' release = 'prerelease' res = '1.2.3-alpha.1' identifier = 'alpha' identifier_base = 1 )
-      ( version = '1.2.3' release = 'prerelease' res = '1.2.4-alpha.1' identifier = 'alpha' identifier_base = 1 )
-      ( version = '1.2.4' release = 'prerelease' res = '1.2.5-alpha.1' identifier = 'alpha' identifier_base = 1 )
-      ( version = '1.2.0' release = 'prepatch' res = '1.2.1-dev.1' identifier = 'dev' identifier_base = 1 )
-      ( version = '1.2.0-1' release = 'prepatch' res = '1.2.1-dev.1' identifier = 'dev' identifier_base = 1 )
-      ( version = '1.2.0' release = 'premajor' res = '2.0.0-dev.0' identifier = 'dev' identifier_base = 0 )
-      ( version = '1.2.3-1' release = 'premajor' res = '2.0.0-dev.0' identifier = 'dev' identifier_base = 0 )
-      ( version = '1.2.3-dev.bar' release = 'prerelease' res = '1.2.3-dev.0' identifier = 'dev' identifier_base = 0 )
-      ( version = '1.2.0' release = 'preminor' res = '1.3.0-dev.1' identifier = 'dev' identifier_base = 1 )
-      ( version = '1.2.3-1' release = 'preminor' res = '1.3.0-dev.0' identifier = 'dev' ) ).
+      ( version = '1.2.0-1' release = 'prerelease' res = '1.2.0-alpha.0' identifier = 'alpha' identifier_base = '0' )
+      ( version = '1.2.1' release = 'prerelease' res = '1.2.2-alpha.0' identifier = 'alpha' identifier_base = '0' )
+      ( version = '0.2.0' release = 'prerelease' res = '0.2.1-alpha.0' identifier = 'alpha' identifier_base = '0' )
+      ( version = '1.2.2' release = 'prerelease' res = '1.2.3-alpha.1' identifier = 'alpha' identifier_base = '1' )
+      ( version = '1.2.3' release = 'prerelease' res = '1.2.4-alpha.1' identifier = 'alpha' identifier_base = '1' )
+      ( version = '1.2.4' release = 'prerelease' res = '1.2.5-alpha.1' identifier = 'alpha' identifier_base = '1' )
+      ( version = '1.2.0' release = 'prepatch' res = '1.2.1-dev.1' identifier = 'dev' identifier_base = '1' )
+      ( version = '1.2.0-1' release = 'prepatch' res = '1.2.1-dev.1' identifier = 'dev' identifier_base = '1' )
+      ( version = '1.2.0' release = 'premajor' res = '2.0.0-dev.0' identifier = 'dev' identifier_base = '0' )
+      ( version = '1.2.3-1' release = 'premajor' res = '2.0.0-dev.0' identifier = 'dev' identifier_base = '0' )
+      ( version = '1.2.3-dev.bar' release = 'prerelease' res = '1.2.3-dev.0' identifier = 'dev' identifier_base = '0' )
+      ( version = '1.2.3-dev.bar' release = 'prerelease' res = '1.2.3-dev.1' identifier = 'dev' identifier_base = '1' )
+      ( version = '1.2.3-dev.bar' release = 'prerelease' res = '1.2.3-dev.bar.0' identifier = '' identifier_base = '0' )
+      ( version = '1.2.3-dev.bar' release = 'prerelease' res = '1.2.3-dev.bar.1' identifier = '' identifier_base = '1' )
+      ( version = '1.2.0' release = 'preminor' res = '1.3.0-dev.1' identifier = 'dev' identifier_base = '1' )
+      ( version = '1.2.3-1' release = 'preminor' res = '1.3.0-dev.0' identifier = 'dev' )
+      ( version = '1.2.0' release = 'prerelease' res = '1.2.1-1' identifier = '' identifier_base = '1' )
+
+      ( version = '1.2.0-1' release = 'prerelease' res = '1.2.0-alpha' identifier = 'alpha' identifier_base = 'false' )
+      ( version = '1.2.1' release = 'prerelease' res = '1.2.2-alpha' identifier = 'alpha' identifier_base = 'false' )
+      ( version = '1.2.2' release = 'prerelease' res = '1.2.3-alpha' identifier = 'alpha' identifier_base = 'false' )
+      ( version = '1.2.0' release = 'prepatch' res = '1.2.1-dev' identifier = 'dev' identifier_base = 'false' )
+      ( version = '1.2.0-1' release = 'prepatch' res = '1.2.1-dev' identifier = 'dev' identifier_base = 'false' )
+      ( version = '1.2.0' release = 'premajor' res = '2.0.0-dev' identifier = 'dev' identifier_base = 'false' )
+      ( version = '1.2.3-1' release = 'premajor' res = '2.0.0-dev' identifier = 'dev' identifier_base = 'false' )
+      ( version = '1.2.3-dev.bar' release = 'prerelease' res = '1.2.3-dev' identifier = 'dev' identifier_base = 'false' )
+      ( version = '1.2.3-dev.bar' release = 'prerelease' res = '1.2.3-dev.baz' identifier = 'dev.baz' identifier_base = 'false' )
+      ( version = '1.2.0' release = 'preminor' res = '1.3.0-dev' identifier = 'dev' identifier_base = 'false' )
+      ( version = '1.2.3-1' release = 'preminor' res = '1.3.0-dev' identifier = 'dev' identifier_base = 'false' )
+      ( version = '1.2.3-dev' release = 'prerelease' res = '' identifier = 'dev' identifier_base = 'false' )
+      ( version = '1.2.0-dev' release = 'premajor' res = '2.0.0-dev' identifier = 'dev' identifier_base = 'false' )
+      ( version = '1.2.0-dev' release = 'preminor' res = '1.3.0-beta' identifier = 'beta' identifier_base = 'false' )
+      ( version = '1.2.0-dev' release = 'prepatch' res = '1.2.1-dev' identifier = 'dev' identifier_base = 'false' )
+      ( version = '1.2.0' release = 'prerelease' res = '' identifier = '' identifier_base = 'false' ) ).
 
   ENDMETHOD.
 
diff --git a/src/internal/zif_semver_constants.intf.abap b/src/internal/zif_semver_constants.intf.abap
