|
| 1 | +"""Semver matcher classes.""" |
| 2 | +import logging |
| 3 | +import pytest |
| 4 | + |
| 5 | +_LOGGER = logging.getLogger(__name__) |
| 6 | + |
| 7 | +class Semver(object): |
| 8 | + """Semver class.""" |
| 9 | + |
| 10 | + _METADATA_DELIMITER = "+" |
| 11 | + _PRE_RELEASE_DELIMITER = "-" |
| 12 | + _VALUE_DELIMITER = "." |
| 13 | + |
| 14 | + def __init__(self, version): |
| 15 | + """ |
| 16 | + Class Initializer |
| 17 | +
|
| 18 | + :param version: raw version as read from splitChanges response. |
| 19 | + :type version: str |
| 20 | + """ |
| 21 | + self._major = 0 |
| 22 | + self._minor = 0 |
| 23 | + self._patch = 0 |
| 24 | + self._pre_release = [] |
| 25 | + self._is_stable = False |
| 26 | + self.version = "" |
| 27 | + self._metadata = "" |
| 28 | + self._parse(version) |
| 29 | + |
| 30 | + @classmethod |
| 31 | + def build(cls, version): |
| 32 | + try: |
| 33 | + self = cls(version) |
| 34 | + except RuntimeError as e: |
| 35 | + _LOGGER.error("Failed to parse Semver data, incorrect data type: %s", e) |
| 36 | + return None |
| 37 | + |
| 38 | + return self |
| 39 | + |
| 40 | + def _parse(self, version): |
| 41 | + """ |
| 42 | + Parse the string in self.version to update the other internal variables |
| 43 | + """ |
| 44 | + without_metadata = self.remove_metadata_if_exists(version) |
| 45 | + |
| 46 | + index = without_metadata.find(self._PRE_RELEASE_DELIMITER) |
| 47 | + if index == -1: |
| 48 | + self._is_stable = True |
| 49 | + else: |
| 50 | + pre_release_data = without_metadata[index+1:] |
| 51 | + if pre_release_data == "": |
| 52 | + raise RuntimeError("Pre-release is empty despite delimeter exists: " + version) |
| 53 | + |
| 54 | + without_metadata = without_metadata[:index] |
| 55 | + self._pre_release = pre_release_data.split(self._VALUE_DELIMITER) |
| 56 | + |
| 57 | + self.set_major_minor_and_patch(without_metadata) |
| 58 | + |
| 59 | + def remove_metadata_if_exists(self, version): |
| 60 | + """ |
| 61 | + Check if there is any metadata characters in self.version. |
| 62 | +
|
| 63 | + :returns: The semver string without the metadata |
| 64 | + :rtype: str |
| 65 | + """ |
| 66 | + index = version.find(self._METADATA_DELIMITER) |
| 67 | + if index == -1: |
| 68 | + return version |
| 69 | + |
| 70 | + self._metadata = version[index+1:] |
| 71 | + if self._metadata == "": |
| 72 | + raise RuntimeError("Metadata is empty despite delimeter exists: " + version) |
| 73 | + |
| 74 | + return version[:index] |
| 75 | + |
| 76 | + def set_major_minor_and_patch(self, version): |
| 77 | + """ |
| 78 | + Set the major, minor and patch internal variables based on string passed. |
| 79 | +
|
| 80 | + :param version: raw version containing major.minor.patch numbers. |
| 81 | + :type version: str |
| 82 | + """ |
| 83 | + |
| 84 | + parts = version.split(self._VALUE_DELIMITER) |
| 85 | + if len(parts) != 3 or not (parts[0].isnumeric() and parts[1].isnumeric() and parts[2].isnumeric()): |
| 86 | + raise RuntimeError("Unable to convert to Semver, incorrect format: " + version) |
| 87 | + |
| 88 | + self._major = int(parts[0]) |
| 89 | + self._minor = int(parts[1]) |
| 90 | + self._patch = int(parts[2]) |
| 91 | + |
| 92 | + self.version = "{major}{DELIMITER}{minor}{DELIMITER}{patch}".format(major = self._major, DELIMITER = self._VALUE_DELIMITER, |
| 93 | + minor = self._minor, patch = self._patch) |
| 94 | + self.version += "{DELIMITER}{pre_release}".format(DELIMITER=self._PRE_RELEASE_DELIMITER, |
| 95 | + pre_release = '.'.join(self._pre_release)) if len(self._pre_release) > 0 else "" |
| 96 | + self.version += "{DELIMITER}{metadata}".format(DELIMITER=self._METADATA_DELIMITER, metadata = self._metadata) if self._metadata != "" else "" |
| 97 | + |
| 98 | + def compare(self, to_compare): |
| 99 | + """ |
| 100 | + Compare the current Semver object to a given Semver object, return: |
| 101 | + 0: if self == passed |
| 102 | + 1: if self > passed |
| 103 | + -1: if self < passed |
| 104 | +
|
| 105 | + :param to_compare: a Semver object |
| 106 | + :type to_compare: splitio.models.grammar.matchers.semver.Semver |
| 107 | +
|
| 108 | + :returns: integer based on comparison |
| 109 | + :rtype: int |
| 110 | + """ |
| 111 | + if self.version == to_compare.version: |
| 112 | + return 0 |
| 113 | + |
| 114 | + # Compare major, minor, and patch versions numerically |
| 115 | + result = self._compare_vars(self._major, to_compare._major) |
| 116 | + if result != 0: |
| 117 | + return result |
| 118 | + |
| 119 | + result = self._compare_vars(self._minor, to_compare._minor) |
| 120 | + if result != 0: |
| 121 | + return result |
| 122 | + |
| 123 | + result = self._compare_vars(self._patch, to_compare._patch) |
| 124 | + if result != 0: |
| 125 | + return result |
| 126 | + |
| 127 | + if not self._is_stable and to_compare._is_stable: |
| 128 | + return -1 |
| 129 | + elif self._is_stable and not to_compare._is_stable: |
| 130 | + return 1 |
| 131 | + |
| 132 | + # Compare pre-release versions lexically |
| 133 | + min_length = min(len(self._pre_release), len(to_compare._pre_release)) |
| 134 | + for i in range(min_length): |
| 135 | + if self._pre_release[i] == to_compare._pre_release[i]: |
| 136 | + continue |
| 137 | + |
| 138 | + if self._pre_release[i].isnumeric() and to_compare._pre_release[i].isnumeric(): |
| 139 | + return self._compare_vars(int(self._pre_release[i]), int(to_compare._pre_release[i])) |
| 140 | + |
| 141 | + return self._compare_vars(self._pre_release[i], to_compare._pre_release[i]) |
| 142 | + |
| 143 | + # Compare lengths of pre-release versions |
| 144 | + return self._compare_vars(len(self._pre_release), len(to_compare._pre_release)) |
| 145 | + |
| 146 | + def _compare_vars(self, var1, var2): |
| 147 | + """ |
| 148 | + Compare 2 variables and return int as follows: |
| 149 | + 0: if var1 == var2 |
| 150 | + 1: if var1 > var2 |
| 151 | + -1: if var1 < var2 |
| 152 | +
|
| 153 | + :param var1: any object accept ==, < or > operators |
| 154 | + :type var1: str/int |
| 155 | + :param var2: any object accept ==, < or > operators |
| 156 | + :type var2: str/int |
| 157 | +
|
| 158 | + :returns: integer based on comparison |
| 159 | + :rtype: int |
| 160 | + """ |
| 161 | + if var1 == var2: |
| 162 | + return 0 |
| 163 | + if var1 > var2: |
| 164 | + return 1 |
| 165 | + return -1 |
0 commit comments