Skip to content

Commit

Permalink
port Gradle's VersionNumber to avoid deprecations
Browse files Browse the repository at this point in the history
  • Loading branch information
rpalcolea committed Oct 29, 2022
1 parent 290b2f4 commit 54a11cd
Show file tree
Hide file tree
Showing 4 changed files with 446 additions and 2 deletions.
271 changes: 271 additions & 0 deletions src/main/groovy/com/netflix/nebula/lint/VersionNumber.groovy
Original file line number Diff line number Diff line change
@@ -0,0 +1,271 @@
package com.netflix.nebula.lint


import com.google.common.base.Objects
import com.google.common.collect.Ordering

import javax.annotation.Nullable

/**
* Represents, parses, and compares version numbers. Supports a couple of different schemes: <ul> <li>MAJOR.MINOR.MICRO-QUALIFIER (the default).</li> <li>MAJOR.MINOR.MICRO.PATCH-QUALIFIER.</li> </ul>
*
* <p>The {@link #parse} method handles missing parts and allows "." to be used instead of "-", and "_" to be used instead of "." for the patch number.
*
* <p>This class considers missing parts to be 0, so that "1.0" == "1.0.0" == "1.0.0_0".</p>
*
* <p>Note that this class considers "1.2.3-something" less than "1.2.3". Qualifiers are compared lexicographically ("1.2.3-alpha" < "1.2.3-beta") and case-insensitive ("1.2.3-alpha" <
* "1.2.3.RELEASE").
*
* <p>To check if a version number is at least "1.2.3", disregarding a potential qualifier like "beta", use {@code version.getBaseVersion().compareTo(VersionNumber.parse("1.2.3")) >= 0}.
*/
class VersionNumber implements Comparable<VersionNumber> {
private static final DefaultScheme DEFAULT_SCHEME = new VersionNumber.DefaultScheme()
private static final VersionNumber.SchemeWithPatchVersion PATCH_SCHEME = new VersionNumber.SchemeWithPatchVersion()
static final VersionNumber UNKNOWN = version(0)

private final int major
private final int minor
private final int micro
private final int patch
private final String qualifier
private final AbstractScheme scheme

VersionNumber(int major, int minor, int micro, @Nullable String qualifier) {
this(major, minor, micro, 0, qualifier, DEFAULT_SCHEME)
}

VersionNumber(int major, int minor, int micro, int patch, @Nullable String qualifier) {
this(major, minor, micro, patch, qualifier, PATCH_SCHEME)
}

private VersionNumber(int major, int minor, int micro, int patch, @Nullable String qualifier, AbstractScheme scheme) {
this.major = major
this.minor = minor
this.micro = micro
this.patch = patch
this.qualifier = qualifier
this.scheme = scheme
}

int getMajor() {
return major;
}

int getMinor() {
return minor;
}

int getMicro() {
return micro
}

int getPatch() {
return patch
}

@Nullable
String getQualifier() {
return qualifier
}

VersionNumber getBaseVersion() {
return new VersionNumber(major, minor, micro, patch, null, scheme)
}

@Override
int compareTo(VersionNumber other) {
if (major != other.major) {
return major - other.major
}
if (minor != other.minor) {
return minor - other.minor
}
if (micro != other.micro) {
return micro - other.micro
}
if (patch != other.patch) {
return patch - other.patch
}
return Ordering.natural().nullsLast().compare(toLowerCase(qualifier), toLowerCase(other.qualifier))
}

boolean equals(@Nullable Object other) {
return other instanceof VersionNumber && compareTo((VersionNumber) other) == 0
}

int hashCode() {
int result = major
result = 31 * result + minor
result = 31 * result + micro
result = 31 * result + patch
result = 31 * result + Objects.hashCode(qualifier)
return result
}

String toString() {
return scheme.format(this)
}

static VersionNumber version(int major) {
return new VersionNumber(major, 0, 0, 0, null, DEFAULT_SCHEME)
}

/**
* Returns the default MAJOR.MINOR.MICRO-QUALIFIER scheme.
*/
static VersionNumber.Scheme scheme() {
return DEFAULT_SCHEME
}

/**
* Returns the MAJOR.MINOR.MICRO.PATCH-QUALIFIER scheme.
*/
static VersionNumber.Scheme withPatchNumber() {
return PATCH_SCHEME
}

static VersionNumber parse(String versionString) {
return DEFAULT_SCHEME.parse(versionString)
}

@Nullable
private String toLowerCase(@Nullable String string) {
return string == null ? null : string.toLowerCase()
}

interface Scheme {
VersionNumber parse(String value)

String format(VersionNumber versionNumber)
}

private abstract static class AbstractScheme implements VersionNumber.Scheme {
final int depth

protected AbstractScheme(int depth) {
this.depth = depth
}

@Override
VersionNumber parse(@Nullable String versionString) {
if (versionString == null || versionString.length() == 0) {
return UNKNOWN
}
VersionNumber.AbstractScheme.Scanner scanner = new VersionNumber.AbstractScheme.Scanner(versionString)

int major = 0
int minor = 0
int micro = 0
int patch = 0

if (!scanner.hasDigit()) {
return UNKNOWN
}
major = scanner.scanDigit()
if (scanner.isSeparatorAndDigit('.')) {
scanner.skipSeparator()
minor = scanner.scanDigit()
if (scanner.isSeparatorAndDigit('.')) {
scanner.skipSeparator()
micro = scanner.scanDigit()
if (depth > 3 && scanner.isSeparatorAndDigit('.', '_')) {
scanner.skipSeparator()
patch = scanner.scanDigit()
}
}
}

if (scanner.isEnd()) {
return new VersionNumber(major, minor, micro, patch, null, this)
}

if (scanner.isQualifier()) {
scanner.skipSeparator()
return new VersionNumber(major, minor, micro, patch, scanner.remainder(), this)
}

return UNKNOWN
}

private static class Scanner {
int pos
final String str

private Scanner(String string) {
this.str = string
}

boolean hasDigit() {
return pos < str.length() && Character.isDigit(str.charAt(pos))
}

boolean isSeparatorAndDigit(char... separators) {
return pos < str.length() - 1 && oneOf(separators) && Character.isDigit(str.charAt(pos + 1))
}

private boolean oneOf(char... separators) {
char current = str.charAt(pos);
for (int i = 0; i < separators.length; i++) {
char separator = separators[i]
if (current == separator) {
return true
}
}
return false
}

boolean isQualifier() {
return pos < str.length() - 1 && oneOf('.', '-')
}

int scanDigit() {
int start = pos
while (hasDigit()) {
pos++
}
return Integer.parseInt(str.substring(start, pos))
}

boolean isEnd() {
return pos == str.length()
}

void skipSeparator() {
pos++
}

@Nullable
String remainder() {
return pos == str.length() ? null : str.substring(pos)
}
}
}

private static class DefaultScheme extends AbstractScheme {
private static final String VERSION_TEMPLATE = "%d.%d.%d%s"

DefaultScheme() {
super(3)
}

@Override
String format(VersionNumber versionNumber) {
return String.format(VERSION_TEMPLATE, versionNumber.major, versionNumber.minor, versionNumber.micro, versionNumber.qualifier == null ? "" : "-" + versionNumber.qualifier)
}
}

private static class SchemeWithPatchVersion extends AbstractScheme {
private static final String VERSION_TEMPLATE = "%d.%d.%d.%d%s"

private SchemeWithPatchVersion() {
super(4)
}

@Override
String format(VersionNumber versionNumber) {
return String.format(VERSION_TEMPLATE, versionNumber.major, versionNumber.minor, versionNumber.micro, versionNumber.patch, versionNumber.qualifier == null ? "" : "-" + versionNumber.qualifier)
}
}

}

Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package com.netflix.nebula.lint.rule.dependency

import com.netflix.nebula.interop.GradleKt
import com.netflix.nebula.lint.SourceSetUtils
import com.netflix.nebula.lint.VersionNumber
import groovy.transform.Memoized
import groovyx.gpars.GParsPool
import org.gradle.api.Project
Expand All @@ -15,7 +16,6 @@ import org.gradle.api.file.FileCollection
import org.gradle.api.internal.artifacts.DefaultModuleIdentifier
import org.gradle.api.tasks.SourceSet
import org.gradle.api.tasks.SourceSetContainer
import org.gradle.util.VersionNumber
import org.objectweb.asm.ClassReader
import org.slf4j.Logger
import org.slf4j.LoggerFactory
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package com.netflix.nebula.lint.rule.dependency

import com.netflix.nebula.lint.VersionNumber
import com.netflix.nebula.lint.rule.GradleDependency
import com.netflix.nebula.lint.rule.GradleLintRule
import com.netflix.nebula.lint.rule.GradleModelAware
Expand All @@ -10,7 +11,6 @@ import org.codehaus.groovy.ast.expr.Expression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.gradle.api.Incubating
import org.gradle.api.artifacts.Configuration
import org.gradle.util.VersionNumber

/**
* This is like a declarative form of the use of a Substitute Nebula Resolution Rule:
Expand Down
Loading

0 comments on commit 54a11cd

Please sign in to comment.