/
semver.go
202 lines (171 loc) · 5.16 KB
/
semver.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
// Copyright (c) 2018 Dean Jackson <deanishe@deanishe.net>
// MIT Licence - http://opensource.org/licenses/MIT
package update
import (
"fmt"
"sort"
"strconv"
"strings"
)
const (
numbers = "0123456789"
)
// SemVers implements sort.Interface for SemVer.
type SemVers []SemVer
// Len implements sort.Interface
func (vs SemVers) Len() int { return len(vs) }
// Less implements sort.Interface
func (vs SemVers) Less(i, j int) bool { return vs[i].Lt(vs[j]) }
// Swap implements sort.Interface
func (vs SemVers) Swap(i, j int) { vs[i], vs[j] = vs[j], vs[i] }
// SortSemVer sorts a slice of SemVer structs.
func SortSemVer(versions []SemVer) {
sort.Sort(SemVers(versions))
}
// SemVer is a (mostly) semantic version number.
//
// Unlike the semver standard:
// - Minor and patch versions are not required, e.g. "v1" and "v1.0" are valid.
// - Version string may be prefixed with "v", e.g. "v1" or "v3.0.1-beta".
// The "v" prefix is stripped, so "v1" == "1.0.0".
// - Dots and integers are ignored in pre-release identifiers: they are
// compared purely alphanumerically, e.g. "v1-beta.11" < "v1-beta.2".
// Use "v1-beta.02" instead.
type SemVer struct {
Major uint64 // Increment for breaking changes.
Minor uint64 // Increment for added/deprecated functionality.
Patch uint64 // Increment for bugfixes.
Build string // Build metadata (ignored in comparisons)
Prerelease string // Pre-release version (treated as string)
}
// NewSemVer creates a new SemVer. An error is returned if the version
// string is not valid. See the SemVer struct documentation for deviations
// from the semver standard.
func NewSemVer(s string) (SemVer, error) {
var major, minor, patch uint64
var build, pre string
s = strings.TrimSpace(s)
if len(s) == 0 {
return SemVer{}, fmt.Errorf("Empty version string: %q", s)
}
// Remove "v" prefix and extend short versions to full length.
s = strings.TrimPrefix(s, "v")
// Extract build and pre tags
if i := strings.IndexRune(s, '+'); i != -1 {
s, build = s[:i], s[i+1:]
}
if i := strings.IndexRune(s, '-'); i != -1 {
s, pre = s[:i], s[i+1:]
}
parts := strings.SplitN(s, ".", 3)
for len(parts) < 3 { // Pad version
parts = append(parts, "0")
}
if len(parts) != 3 {
return SemVer{}, fmt.Errorf("%d part(s), not 3: %q", len(parts), s)
}
// Major
if !containsOnly(parts[0], numbers) {
return SemVer{}, fmt.Errorf("Invalid char(s) in major number %q", parts[0])
}
if hasLeadingZeroes(parts[0]) {
return SemVer{}, fmt.Errorf("Major version may not contain leading zeroes: %q", parts[0])
}
major, err := strconv.ParseUint(parts[0], 10, 64)
if err != nil {
return SemVer{}, fmt.Errorf("Invalid major version %q: %s", parts[0], err)
}
// Minor
if !containsOnly(parts[1], numbers) {
return SemVer{}, fmt.Errorf("Invalid char(s) in minor number %q", parts[1])
}
minor, err = strconv.ParseUint(parts[1], 10, 64)
if err != nil {
return SemVer{}, fmt.Errorf("Invalid minor version %q: %s", parts[1], err)
}
// Patch
if !containsOnly(parts[2], numbers) {
return SemVer{}, fmt.Errorf("Invalid char(s) in minor number %q", parts[2])
}
patch, err = strconv.ParseUint(parts[2], 10, 64)
if err != nil {
return SemVer{}, fmt.Errorf("Invalid patch version %q: %s", parts[2], err)
}
return SemVer{
Major: major,
Minor: minor,
Patch: patch,
Prerelease: pre,
Build: build,
}, nil
}
// String returns a canonical semver string
func (v SemVer) String() string {
s := fmt.Sprintf("%d.%d.%d", v.Major, v.Minor, v.Patch)
if v.Prerelease != "" {
s = fmt.Sprintf("%s-%s", s, v.Prerelease)
}
if v.Build != "" {
s = fmt.Sprintf("%s+%s", s, v.Build)
}
return s
}
// Compare compares two Versions. Returns:
// -1 if v < v2
// 0 if v == v2
// 1 if v > v2
func (v SemVer) Compare(v2 SemVer) int {
if v.Major != v2.Major {
if v.Major > v2.Major {
return 1
}
return -1
}
if v.Minor != v2.Minor {
if v.Minor > v2.Minor {
return 1
}
return -1
}
if v.Patch != v2.Patch {
if v.Patch > v2.Patch {
return 1
}
return -1
}
// Check if one version is prerelease and the other isn't
if v.Prerelease == "" && v2.Prerelease != "" {
return 1
} else if v.Prerelease != "" && v2.Prerelease == "" {
return -1
}
if v.Prerelease > v2.Prerelease {
return 1
} else if v.Prerelease < v2.Prerelease {
return -1
}
// Semver ignores build info
return 0
}
// Eq checks if v == v2
func (v SemVer) Eq(v2 SemVer) bool { return v.Compare(v2) == 0 }
// Ne checks if v != v2
func (v SemVer) Ne(v2 SemVer) bool { return !v.Eq(v2) }
// Gt checks if v > v2
func (v SemVer) Gt(v2 SemVer) bool { return v.Compare(v2) == 1 }
// Gte checks if v >= v2
func (v SemVer) Gte(v2 SemVer) bool { return v.Compare(v2) >= 0 }
// Lt checks if v < v2
func (v SemVer) Lt(v2 SemVer) bool { return v.Compare(v2) == -1 }
// Lte checks if v <= v2
func (v SemVer) Lte(v2 SemVer) bool { return v.Compare(v2) <= 0 }
// IsZero returns true if SemVer has no value.
func (v SemVer) IsZero() bool { return v.Eq(SemVer{}) }
func containsOnly(s, allowed string) bool {
return strings.IndexFunc(s, func(r rune) bool {
return !strings.ContainsRune(allowed, r)
}) == -1
}
func hasLeadingZeroes(s string) bool {
return s[0] == '0' && len(s) > 1
}