|
| 1 | +# |
| 2 | +# Copyright (c) nexB Inc. and others. |
| 3 | +# SPDX-License-Identifier: Apache-2.0 |
| 4 | +# |
| 5 | +# Visit https://aboutcode.org and https://github.com/nexB/univers for support and download. |
| 6 | + |
| 7 | +import functools |
| 8 | +import re |
| 9 | + |
| 10 | +import semver |
| 11 | + |
| 12 | +_PAD_WIDTH = 8 |
| 13 | +_FAKE_PRE_WIDTH = 16 |
| 14 | + |
| 15 | + |
| 16 | +def _strip_leading_v(version): |
| 17 | + """Strip leading v from the version, if any.""" |
| 18 | + # Versions starting with "v" aren't valid SemVer, but we handle them just in |
| 19 | + # case. |
| 20 | + if version.startswith("v"): |
| 21 | + return version[1:] |
| 22 | + |
| 23 | + return version |
| 24 | + |
| 25 | + |
| 26 | +def _remove_leading_zero(component): |
| 27 | + """Remove leading zeros from a component.""" |
| 28 | + if component[0] == ".": |
| 29 | + return "." + str(int(component[1:])) |
| 30 | + |
| 31 | + return str(int(component)) |
| 32 | + |
| 33 | + |
| 34 | +def coerce(version): |
| 35 | + """Coerce a potentially invalid semver into valid semver.""" |
| 36 | + version = _strip_leading_v(version) |
| 37 | + version_pattern = re.compile(r"^(\d+)(\.\d+)?(\.\d+)?(.*)$") |
| 38 | + match = version_pattern.match(version) |
| 39 | + if not match: |
| 40 | + return version |
| 41 | + |
| 42 | + return ( |
| 43 | + _remove_leading_zero(match.group(1)) |
| 44 | + + _remove_leading_zero(match.group(2) or ".0") |
| 45 | + + _remove_leading_zero(match.group(3) or ".0") |
| 46 | + + match.group(4) |
| 47 | + ) |
| 48 | + |
| 49 | + |
| 50 | +def is_valid(version): |
| 51 | + """Returns whether or not the version is a valid semver.""" |
| 52 | + return semver.VersionInfo.isvalid(_strip_leading_v(version)) |
| 53 | + |
| 54 | + |
| 55 | +def parse(version): |
| 56 | + """Parse a SemVer.""" |
| 57 | + return semver.VersionInfo.parse(coerce(version)) |
| 58 | + |
| 59 | + |
| 60 | +def normalize(version): |
| 61 | + """Normalize semver version for indexing (to allow for lexical |
| 62 | + sorting/filtering).""" |
| 63 | + version = parse(version) |
| 64 | + |
| 65 | + # Precedence rules: https://semver.org/#spec-item-11 |
| 66 | + |
| 67 | + # 1. Precedence MUST be calculated by separating the version into major, |
| 68 | + # minor, patch and pre-release identifiers in that order (Build metadata does |
| 69 | + # not figure into precedence). |
| 70 | + # |
| 71 | + # Normalization: Per spec build metadata is ignored. |
| 72 | + |
| 73 | + # 2. Precedence is determined by the first difference when comparing each of |
| 74 | + # these identifiers from left to right as follows: Major, minor, and patch |
| 75 | + # versions are always compared numerically. |
| 76 | + # |
| 77 | + # Normalization: Pad the components with '0' to allow for lexical ordering of |
| 78 | + # numbers. |
| 79 | + core_parts = "{}.{}.{}".format( |
| 80 | + str(version.major).rjust(_PAD_WIDTH, "0"), |
| 81 | + str(version.minor).rjust(_PAD_WIDTH, "0"), |
| 82 | + str(version.patch).rjust(_PAD_WIDTH, "0"), |
| 83 | + ) |
| 84 | + |
| 85 | + # 3. When major, minor, and patch are equal, a pre-release version has lower |
| 86 | + # precedence than a normal version: |
| 87 | + # |
| 88 | + # Normalization: Attach a very long fake prerelease version that is most |
| 89 | + # likely to come after any real prelease version. |
| 90 | + if not version.prerelease: |
| 91 | + pre = "z" * _FAKE_PRE_WIDTH |
| 92 | + return f"{core_parts}-{pre}" |
| 93 | + |
| 94 | + # 4. Precedence for two pre-release versions with the same major, minor, and |
| 95 | + # patch version MUST be determined by comparing each dot separated identifier |
| 96 | + # from left to right until a difference is found as follows: |
| 97 | + # |
| 98 | + # Normalization: Pad the components. |
| 99 | + pre_components = [] |
| 100 | + for component in version.prerelease.split("."): |
| 101 | + # 3. Numeric identifiers always have lower precedence than non-numeric |
| 102 | + # identifiers. |
| 103 | + # |
| 104 | + # Normalization: Pad numeric components with '0', and prefix alphanumeric |
| 105 | + # with a single '1' (to ensure they always come after). |
| 106 | + if component.isdigit(): |
| 107 | + # 1. Identifiers consisting of only digits are compared numerically. |
| 108 | + pre_components.append(component.rjust(_PAD_WIDTH, "0")) |
| 109 | + else: |
| 110 | + # 2. Identifiers with letters or hyphens are compared lexically in ASCII |
| 111 | + # sort order. |
| 112 | + pre_components.append("1" + component) |
| 113 | + |
| 114 | + # 4. A larger set of pre-release fields has a higher precedence than a smaller |
| 115 | + # set, if all of the preceding identifiers are equal. |
| 116 | + # |
| 117 | + # Consistent with lexical sorting after normalization. |
| 118 | + |
| 119 | + pre = ".".join(pre_components) |
| 120 | + return f"{core_parts}-{pre}" |
| 121 | + |
| 122 | + |
| 123 | +def _extract_revision(str_version): |
| 124 | + """Extract revision (4th component) from version number (if any).""" |
| 125 | + # e.g. '1.0.0.0-prerelease' |
| 126 | + pattern = re.compile(r"^(\d+)(\.\d+)(\.\d+)(\.\d+)(.*)") |
| 127 | + match = pattern.match(str_version) |
| 128 | + if not match: |
| 129 | + return str_version, 0 |
| 130 | + |
| 131 | + return ( |
| 132 | + "".join((match.group(1), match.group(2), match.group(3), match.group(5))), |
| 133 | + int(match.group(4)[1:]), |
| 134 | + ) |
| 135 | + |
| 136 | + |
| 137 | +@functools.total_ordering |
| 138 | +class Version: |
| 139 | + """NuGet version.""" |
| 140 | + |
| 141 | + def __init__(self, base_semver, revision): |
| 142 | + self._base_semver = base_semver |
| 143 | + if self._base_semver.prerelease: |
| 144 | + self._base_semver = self._base_semver.replace(prerelease=base_semver.prerelease.lower()) |
| 145 | + self._revision = revision |
| 146 | + |
| 147 | + def __eq__(self, other): |
| 148 | + return self._base_semver == other._base_semver and self._revision == other._revision |
| 149 | + |
| 150 | + def __lt__(self, other): |
| 151 | + if self._base_semver.replace(prerelease="") == other._base_semver.replace(prerelease=""): |
| 152 | + # If the first three components are the same, compare the revision. |
| 153 | + if self._revision != other._revision: |
| 154 | + return self._revision < other._revision |
| 155 | + |
| 156 | + # Revision is the same, so ignore it for comparison purposes. |
| 157 | + return self._base_semver < other._base_semver |
| 158 | + |
| 159 | + @classmethod |
| 160 | + def from_string(cls, str_version): |
| 161 | + str_version = coerce(str_version) |
| 162 | + str_version, revision = _extract_revision(str_version) |
| 163 | + return Version(parse(str_version), revision) |
0 commit comments