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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
/**
* Copyright 2012-2014 Julien Eluard and contributors
* This project includes software developed by Julien Eluard: https://github.com/jeluard/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.semver;
import java.util.Collections;
import java.util.Set;
import javax.annotation.Nonnull;
import javax.annotation.concurrent.Immutable;
import org.osjava.jardiff.AbstractInfo;
/**
*
* Encapsulates differences between two sets of classes.
* <br />
* Provides convenient methods to validate that chosen {@link Version} are correct.
*
*/
@Immutable
public final class Delta {
/**
* Library compatibility type. From most compatible to less compatible.
*/
public enum CompatibilityType {
BACKWARD_COMPATIBLE_IMPLEMENTER,
BACKWARD_COMPATIBLE_USER,
NON_BACKWARD_COMPATIBLE
}
@Immutable
public static class Difference implements Comparable<Difference> {
private final String className;
private final AbstractInfo info;
public Difference(@Nonnull final String className, @Nonnull final AbstractInfo info) {
if (className == null) {
throw new IllegalArgumentException("null className");
}
if (info == null) {
throw new IllegalArgumentException("null info");
}
this.className = className;
this.info = info;
}
@Nonnull
public String getClassName() {
return this.className;
}
@Nonnull
public AbstractInfo getInfo() {
return info;
}
@Override
public int compareTo(final Difference other) {
return getClassName().compareTo(other.getClassName());
}
}
@Immutable
public static class Add extends Difference {
public Add(@Nonnull final String className, @Nonnull final AbstractInfo info) {
super(className, info);
}
}
@Immutable
public static class Change extends Difference {
private final AbstractInfo modifiedInfo;
public Change(@Nonnull final String className, @Nonnull final AbstractInfo info, @Nonnull final AbstractInfo modifiedInfo) {
super(className, info);
this.modifiedInfo = modifiedInfo;
}
public AbstractInfo getModifiedInfo() {
return this.modifiedInfo;
}
}
@Immutable
public static class Deprecate extends Difference {
private final AbstractInfo modifiedInfo;
public Deprecate(@Nonnull final String className,
@Nonnull final AbstractInfo info,
@Nonnull final AbstractInfo modifiedInfo) {
super(className, info);
this.modifiedInfo = modifiedInfo;
}
public AbstractInfo getModifiedInfo() {
return this.modifiedInfo;
}
}
@Immutable
public static class Remove extends Difference {
public Remove(@Nonnull final String className, @Nonnull final AbstractInfo info) {
super(className, info);
}
}
private final Set<Difference> differences;
public Delta(@Nonnull final Set<? extends Difference> differences) {
this.differences = Collections.unmodifiableSet(differences);
}
@Nonnull
public final Set<Difference> getDifferences() {
return this.differences;
}
/**
* @param differences
* @return {@link CompatibilityType} based on specified {@link Difference}
*/
@Nonnull
public final CompatibilityType computeCompatibilityType() {
if (contains(this.differences, Change.class) ||
contains(this.differences, Remove.class)) {
return CompatibilityType.NON_BACKWARD_COMPATIBLE;
} else if (contains(this.differences, Add.class) ||
contains(this.differences, Deprecate.class)) {
return CompatibilityType.BACKWARD_COMPATIBLE_USER;
} else {
return CompatibilityType.BACKWARD_COMPATIBLE_IMPLEMENTER;
}
}
protected final boolean contains(final Set<Difference> differences, final Class<? extends Difference> type) {
for (final Difference difference : differences) {
if (type.isInstance(difference)) {
return true;
}
}
return false;
}
/**
*
* Infers next {@link Version} depending on provided {@link CompatibilityType}.
*
* @param version
* @param compatibilityType
* @return
*/
@Nonnull
public static Version inferNextVersion(@Nonnull final Version version, @Nonnull final CompatibilityType compatibilityType) {
if (version == null) {
throw new IllegalArgumentException("null version");
}
if (compatibilityType == null) {
throw new IllegalArgumentException("null compatibilityType");
}
switch (compatibilityType) {
case BACKWARD_COMPATIBLE_IMPLEMENTER:
return version.next(Version.Element.PATCH);
case BACKWARD_COMPATIBLE_USER:
return version.next(Version.Element.MINOR);
case NON_BACKWARD_COMPATIBLE:
return version.next(Version.Element.MAJOR);
default:
throw new IllegalArgumentException("Unknown type <"+compatibilityType+">");
}
}
/**
* @param previous
* @return an inferred {@link Version} for current JAR based on previous JAR content/version.
* @throws IOException
*/
@Nonnull
public final Version infer(@Nonnull final Version previous) {
if (previous == null) {
throw new IllegalArgumentException("null previous");
}
if (previous.isInDevelopment()) {
throw new IllegalArgumentException("Cannot infer for in development version <"+previous+">");
}
final CompatibilityType compatibilityType = computeCompatibilityType();
return inferNextVersion(previous, compatibilityType);
}
/**
* @param previous
* @param current
* @return true if {@link Version} provided for current JAR is compatible with previous JAR content/version.
* @throws IOException
*/
public final boolean validate(@Nonnull final Version previous, @Nonnull final Version current) {
if (previous == null) {
throw new IllegalArgumentException("null previous");
}
if (current == null) {
throw new IllegalArgumentException("null current");
}
if (current.compareTo(previous) <= 0) {
throw new IllegalArgumentException("Current version <"+previous+"> must be more recent than previous version <"+current+">.");
}
//When in development public API is not considered stable
if (current.isInDevelopment()) {
return true;
}
//Current version must be superior or equals to inferred version
final Version inferredVersion = infer(previous);
// if the current version is a pre-release then the corresponding release need to be superior or equal
return current.toReleaseVersion().compareTo(inferredVersion) >= 0;
}
}
|
