Added 'compatible-with' (caret ^) operator

README.md

@@ -27,6 +27,9 @@ This library allows the use of an even more relaxed semver specification using t
 - If the parsed string is a valid semver (following the rules above), then the `RelaxedVersion` will behave exactly as a normal `Version` object
 - if the parsed string is **not** a valid semver, then the string is kept as-is inside the `RelaxedVersion` object as a custom version string
 - when comparing two `RelaxedVersion` the rule is simple: if both are valid semver, the semver rules applies; if both are custom version string they are compared as alphanumeric strings; if one is valid semver and the other is a custom version string the valid semver is always greater
+- two `RelaxedVersion` are compatible (by the `CompatibleWith` operation) only if
+  - they are equal
+  - they are both valid semver and they are compatible as per semver specification
 
 The `RelaxedVersion` object is basically made to allow systems that do not use semver to soft transition to semantic versioning, because it allows an intermediate period where the invalid version is still tolerated.
 
@@ -45,6 +48,7 @@ The following operators are supported:
 | `>=`     | greater than or equal to |
 | `<`      | less than                |
 | `<=`     | less than or equal to    |
+| `^`      | compatible-with          |
 | `!`      | NOT                      |
 | `&&`     | AND                      |
 | `\|\|`   | OR                       |
@@ -55,23 +59,30 @@ The following operators are supported:
 Given the following releases of a dependency:
 
 - `0.1.0`
+- `0.1.1`
+- `0.2.0`
 - `1.0.0`
 - `2.0.0`
+- `2.0.5`
+- `2.0.6`
 - `2.1.0`
-
-constraints would resolve as follows:
-
-| Constraint                       | Resolution |
-| -------------------------------- | ---------- |
-| `=1.0.0`                         | `1.0.0`    |
-| `>1.0.0`                         | `2.1.0`    |
-| `>=1.0.0`                        | `2.1.0`    |
-| `<2.0.0`                         | `1.0.0`    |
-| `<=2.0.0`                        | `2.0.0`    |
-| `!=1.0.0`                        | `2.1.0`    |
-| `>1.0.0 && <2.1.0`               | `2.0.0`    |
-| `<1.0.0 \|\| >2.0.0`             | `2.1.0`    |
-| `(>0.1.0 && <2.0.0) \|\| >2.1.0` | `1.0.0`    |
+- `3.0.0`
+
+constraints conditions would match as follows:
+
+| The following condition...       | will match with versions...                          |
+| -------------------------------- | ---------------------------------------------------- |
+| `=1.0.0`                         | `1.0.0`                                              |
+| `>1.0.0`                         | `2.0.0`, `2.0.5`, `2.0.6`, `2.1.0`, `3.0.0`          |
+| `>=1.0.0`                        | `1.0.0`, `2.0.0`, `2.0.5`, `2.0.6`, `2.1.0`, `3.0.0` |
+| `<2.0.0`                         | `0.1.0`, `0.1.1`, `0.2.0`, `1.0.0`                   |
+| `<=2.0.0`                        | `0.1.0`, `0.1.1`, `0.2.0`, `1.0.0`, `2.0.0`          |
+| `!=1.0.0`                        | `0.1.0`, `2.0.0`, `2.0.5`, `2.0.6`, `2.1.0`, `3.0.0` |
+| `>1.0.0 && <2.1.0`               | `2.0.0`, `2.0.5`, `2.0.6`                            |
+| `<1.0.0 \|\| >2.0.0`             | `0.1.0`, `2.0.5`, `2.0.6`, `2.1.0`, `3.0.0`          |
+| `(>0.1.0 && <2.0.0) \|\| >2.0.5` | `1.0.0`, `2.0.6`, `2.1.0`, `3.0.0`                   |
+| `^2.0.5`                         | `2.0.5`, `2.0.6`, `2.1.0`                            |
+| `^0.1.0`                         | `0.1.0`, `0.1.1`                                     |
 
 ## Json parsable
 

constraints.go

@@ -88,6 +88,12 @@ func ParseConstraint(in string) (Constraint, error) {
 				return nil, err
 			}
 			return &Equals{v}, nil
+		case '^':
+			v, err := version()
+			if err != nil {
+				return nil, err
+			}
+			return &CompatibleWith{v}, nil
 		case '>':
 			if peek() == '=' {
 				next()
@@ -273,6 +279,20 @@ func (gte *GreaterThanOrEqual) String() string {
 	return ">=" + gte.Version.String()
 }
 
+// CompatibleWith is the "compatible with" (^) constraint
+type CompatibleWith struct {
+	Version *Version
+}
+
+// Match returns true if v satisfies the condition
+func (cw *CompatibleWith) Match(v *Version) bool {
+	return cw.Version.CompatibleWith(v)
+}
+
+func (cw *CompatibleWith) String() string {
+	return "^" + cw.Version.String()
+}
+
 // Or will match if ANY of the Operands Constraint will match
 type Or struct {
 	Operands []Constraint

constraints_test.go

@@ -76,6 +76,19 @@ func TestConstraints(t *testing.T) {
 	require.True(t, notOr.Match(v("2.0.0")))
 	require.False(t, notOr.Match(v("2.1.0")))
 	require.Equal(t, "!(>2.0.0 || <=1.0.0)", notOr.String())
+
+	comp := &CompatibleWith{v("1.3.4-rc.3")}
+	require.False(t, comp.Match(v("1.2.3")))
+	require.False(t, comp.Match(v("1.3.2")))
+	require.False(t, comp.Match(v("1.2.3")))
+	require.False(t, comp.Match(v("1.3.4-rc.1")))
+	require.True(t, comp.Match(v("1.3.4-rc.5")))
+	require.True(t, comp.Match(v("1.3.4")))
+	require.True(t, comp.Match(v("1.3.6")))
+	require.True(t, comp.Match(v("1.4.0")))
+	require.True(t, comp.Match(v("1.4.5")))
+	require.True(t, comp.Match(v("1.4.5-rc.2")))
+	require.False(t, comp.Match(v("2.0.0")))
 }
 
 func TestConstraintsParser(t *testing.T) {
@@ -92,10 +105,15 @@ func TestConstraintsParser(t *testing.T) {
 		{">1.3.0", ">1.3.0"},
 		{"<=1.3.0", "<=1.3.0"},
 		{"<1.3.0", "<1.3.0"},
+		{"^1.3.0", "^1.3.0"},
+		{" ^1.3.0", "^1.3.0"},
+		{"^1.3.0 ", "^1.3.0"},
+		{" ^1.3.0 ", "^1.3.0"},
 		{"(=1.4.0)", "=1.4.0"},
 		{"!(=1.4.0)", "!(=1.4.0)"},
 		{"!(((=1.4.0)))", "!(=1.4.0)"},
 		{"=1.2.4 && =1.3.0", "(=1.2.4 && =1.3.0)"},
+		{"=1.2.4 && ^1.3.0", "(=1.2.4 && ^1.3.0)"},
 		{"=1.2.4 && =1.3.0 && =1.2.0", "(=1.2.4 && =1.3.0 && =1.2.0)"},
 		{"=1.2.4 && =1.3.0 || =1.2.0", "((=1.2.4 && =1.3.0) || =1.2.0)"},
 		{"=1.2.4 || =1.3.0 && =1.2.0", "(=1.2.4 || (=1.3.0 && =1.2.0))"},
@@ -124,6 +142,7 @@ func TestConstraintsParser(t *testing.T) {
 		">>1.0.0",
 		">1.0.0 =2.0.0",
 		">1.0.0 &",
+		"^1.1.1.1",
 		"!1.0.0",
 		">1.0.0 && 2.0.0",
 		">1.0.0 | =2.0.0",

relaxed_version.go

@@ -81,3 +81,11 @@ func (v *RelaxedVersion) GreaterThan(u *RelaxedVersion) bool {
 func (v *RelaxedVersion) GreaterThanOrEqual(u *RelaxedVersion) bool {
 	return v.CompareTo(u) >= 0
 }
+
+// CompatibleWith returns true if the RelaxedVersion is compatible with the RelaxedVersion passed as paramater
+func (v *RelaxedVersion) CompatibleWith(u *RelaxedVersion) bool {
+	if v.version != nil && u.version != nil {
+		return v.version.CompatibleWith(u.version)
+	}
+	return v.Equal(u)
+}

relaxed_version_test.go

@@ -91,6 +91,39 @@ func TestRelaxedVersionComparator(t *testing.T) {
 	)
 }
 
+func TestRelaxedCompatibleWith(t *testing.T) {
+	inv := ParseRelaxed("invalid-semver")
+	inv2 := ParseRelaxed("invalid-semver-2")
+	v145 := ParseRelaxed("1.4.5")
+	v152 := ParseRelaxed("1.5.2")
+	v213 := ParseRelaxed("2.1.3")
+	require.True(t, inv.CompatibleWith(inv))
+	require.False(t, inv.CompatibleWith(inv2))
+	require.False(t, inv.CompatibleWith(v145))
+	require.False(t, inv.CompatibleWith(v152))
+	require.False(t, inv.CompatibleWith(v213))
+	require.False(t, inv2.CompatibleWith(inv))
+	require.True(t, inv2.CompatibleWith(inv2))
+	require.False(t, inv2.CompatibleWith(v145))
+	require.False(t, inv2.CompatibleWith(v152))
+	require.False(t, inv2.CompatibleWith(v213))
+	require.False(t, v145.CompatibleWith(inv))
+	require.False(t, v145.CompatibleWith(inv2))
+	require.True(t, v145.CompatibleWith(v145))
+	require.True(t, v145.CompatibleWith(v152))
+	require.False(t, v145.CompatibleWith(v213))
+	require.False(t, v152.CompatibleWith(inv))
+	require.False(t, v152.CompatibleWith(inv2))
+	require.False(t, v152.CompatibleWith(v145))
+	require.True(t, v152.CompatibleWith(v152))
+	require.False(t, v152.CompatibleWith(v213))
+	require.False(t, v213.CompatibleWith(inv))
+	require.False(t, v213.CompatibleWith(inv2))
+	require.False(t, v213.CompatibleWith(v145))
+	require.False(t, v213.CompatibleWith(v152))
+	require.True(t, v213.CompatibleWith(v213))
+}
+
 func TestNilRelaxedVersionString(t *testing.T) {
 	var nilVersion *RelaxedVersion
 	require.Equal(t, "", nilVersion.String())

version.go

@@ -205,3 +205,17 @@ func (v *Version) GreaterThan(u *Version) bool {
 func (v *Version) GreaterThanOrEqual(u *Version) bool {
 	return v.CompareTo(u) >= 0
 }
+
+// CompatibleWith returns true if the Version is compatible with the version passed as paramater
+func (v *Version) CompatibleWith(u *Version) bool {
+	if !u.GreaterThanOrEqual(v) {
+		return false
+	}
+	if v.major[0] != '0' {
+		return compareNumber(u.major, v.major) == 0
+	} else if v.minor[0] != '0' {
+		return compareNumber(u.major, v.major) == 0 && compareNumber(u.minor, v.minor) == 0
+	} else {
+		return compareNumber(u.major, v.major) == 0 && compareNumber(u.minor, v.minor) == 0 && compareNumber(u.patch, v.patch) == 0
+	}
+}