Skip to content

Add lexicographic versioning scheme #160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/univers/version_range.py
Original file line number Diff line number Diff line change
Expand Up @@ -1196,6 +1196,11 @@ class NoneVersionRange(VersionRange):
version_class = versions.NoneVersion


class LexicographicVersionRange(VersionRange):
scheme = "lexicographic"
version_class = versions.LexicographicVersion


def from_gitlab_native(gitlab_scheme, string):
purl_scheme = gitlab_scheme
if gitlab_scheme not in PURL_TYPE_BY_GITLAB_SCHEME.values():
Expand Down Expand Up @@ -1440,6 +1445,7 @@ def build_range_from_snyk_advisory_string(scheme: str, string: Union[str, List])
"conan": ConanVersionRange,
"all": AllVersionRange,
"none": NoneVersionRange,
"lexicographic": LexicographicVersionRange,
}

PURL_TYPE_BY_GITLAB_SCHEME = {
Expand Down
24 changes: 24 additions & 0 deletions src/univers/versions.py
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,29 @@ def is_valid(cls, string):
return string == "vers:none/*"


class LexicographicVersion(Version):
@classmethod
def build_value(cls, string):
return str(string)

"""
Create a string, even if, e.g., an integer is given
"""

@classmethod
def normalize(cls, string):
return remove_spaces(str(string))

def __lt__(self, other):
return self.value.encode("utf-8") < other.value.encode("utf-8")

def __gt__(self, other):
return self.value.encode("utf-8") > other.value.encode("utf-8")

def __eq__(self, other):
return self.value.encode("utf-8") == other.value.encode("utf-8")


class GenericVersion(Version):
@classmethod
def is_valid(cls, string):
Expand Down Expand Up @@ -714,4 +737,5 @@ def bump(self, index):
OpensslVersion,
LegacyOpensslVersion,
AlpineLinuxVersion,
LexicographicVersion,
]
10 changes: 10 additions & 0 deletions tests/test_version_range.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
from univers.version_range import build_range_from_snyk_advisory_string
from univers.version_range import from_gitlab_native
from univers.versions import InvalidVersion
from univers.versions import LexicographicVersion
from univers.versions import NugetVersion
from univers.versions import OpensslVersion
from univers.versions import PypiVersion
Expand Down Expand Up @@ -569,3 +570,12 @@ def test_version_range_none():
VersionRange.from_string("vers:none/!1.2.3")
with pytest.raises(Exception):
VersionRange.from_string("vers:none/*|>1.2.3")


def test_version_range_lexicographic():
assert LexicographicVersion("1.2.3") in VersionRange.from_string(
"vers:lexicographic/<1.2.4|>0.9"
)
assert LexicographicVersion(-123) in VersionRange.from_string("vers:lexicographic/<~")
assert LexicographicVersion(None) in VersionRange.from_string("vers:lexicographic/*")
assert LexicographicVersion("ABC") in VersionRange.from_string("vers:lexicographic/>abc|<=None")
11 changes: 11 additions & 0 deletions tests/test_versions.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
from univers.versions import EnhancedSemanticVersion
from univers.versions import GentooVersion
from univers.versions import GolangVersion
from univers.versions import LexicographicVersion
from univers.versions import MavenVersion
from univers.versions import NginxVersion
from univers.versions import NugetVersion
Expand Down Expand Up @@ -218,3 +219,13 @@ def test_golang_version():
assert GolangVersion("v0.1.1") >= GolangVersion("v0.1.1")
assert GolangVersion("v0.1.1") <= GolangVersion("v0.1.1")
assert GolangVersion("v0.1.1") <= GolangVersion("v0.1.2")


def test_lexicographic_version():
assert LexicographicVersion("abc") == LexicographicVersion("abc")
assert LexicographicVersion(" abc") == LexicographicVersion("abc")
assert LexicographicVersion("123") == LexicographicVersion(123)
assert LexicographicVersion("abc") > LexicographicVersion(None)
assert LexicographicVersion("Abc") < LexicographicVersion(None)
assert LexicographicVersion("123") < LexicographicVersion("bbc")
assert LexicographicVersion("2.3.4") > LexicographicVersion("1.2.3")