Skip to content

Commit fe90327

Browse files
ppkarwaszSpotless
ppkarwasz
and
Spotless
authored
style: add Spotless formatter configuration (package-url#189)
* build: add Spotless configuration * style: formatting using Spotless --------- Co-authored-by: Spotless <spotless@invalid>
1 parent 9f8b88e commit fe90327

File tree

10 files changed

+845
-646
lines changed

10 files changed

+845
-646
lines changed

‎pom.xml

+541-487
Large diffs are not rendered by default.

‎src/headers/java.txt

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
/*
2+
* MIT License
3+
*
4+
* Permission is hereby granted, free of charge, to any person obtaining a copy
5+
* of this software and associated documentation files (the "Software"), to deal
6+
* in the Software without restriction, including without limitation the rights
7+
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8+
* copies of the Software, and to permit persons to whom the Software is
9+
* furnished to do so, subject to the following conditions:
10+
*
11+
* The above copyright notice and this permission notice shall be included in all
12+
* copies or substantial portions of the Software.
13+
*
14+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16+
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17+
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18+
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19+
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20+
* SOFTWARE.
21+
*/

‎src/headers/xml.txt

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
~ MIT License
4+
~
5+
~ Permission is hereby granted, free of charge, to any person obtaining a copy
6+
~ of this software and associated documentation files (the "Software"), to deal
7+
~ in the Software without restriction, including without limitation the rights
8+
~ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
~ copies of the Software, and to permit persons to whom the Software is
10+
~ furnished to do so, subject to the following conditions:
11+
~
12+
~ The above copyright notice and this permission notice shall be included in all
13+
~ copies or substantial portions of the Software.
14+
~
15+
~ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
~ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
~ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
~ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
~ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
~ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
~ SOFTWARE.
22+
-->

‎src/main/java/com/github/packageurl/MalformedPackageURLException.java

+1-2
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,7 @@ public class MalformedPackageURLException extends Exception {
3737
*
3838
* @since 1.0.0
3939
*/
40-
public MalformedPackageURLException() {
41-
}
40+
public MalformedPackageURLException() {}
4241

4342
/**
4443
* Constructs a {@code MalformedPackageURLException} with the

‎src/main/java/com/github/packageurl/PackageURL.java

+91-49
Large diffs are not rendered by default.

‎src/main/java/com/github/packageurl/PackageURLBuilder.java

-1
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,6 @@ public PackageURLBuilder withoutQualifiers(final Set<String> keys) {
216216
return this;
217217
}
218218

219-
220219
/**
221220
* Removes all qualifiers, if any.
222221
* @return a reference to this builder.

‎src/main/java/com/github/packageurl/validator/PackageURL.java

+5-4
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,15 @@
3333
* the JSR-303 compliant validator to validate the field to ensure it meets the Package URL specification.
3434
* @since 1.3.0
3535
*/
36-
@Target({ ElementType.FIELD})
36+
@Target({ElementType.FIELD})
3737
@Retention(RetentionPolicy.RUNTIME)
3838
@Constraint(validatedBy = PackageURLConstraintValidator.class)
3939
public @interface PackageURL {
4040

41-
String message() default "The Package URL (purl) must be a valid URI and conform to https://github.com/package-url/purl-spec";
41+
String message() default
42+
"The Package URL (purl) must be a valid URI and conform to https://github.com/package-url/purl-spec";
4243

43-
Class<?>[] groups() default { };
44+
Class<?>[] groups() default {};
4445

45-
Class<? extends Payload>[] payload() default { };
46+
Class<? extends Payload>[] payload() default {};
4647
}

‎src/test/java/com/github/packageurl/PackageURLBuilderTest.java

+61-45
Original file line numberDiff line numberDiff line change
@@ -45,16 +45,19 @@ static Stream<Arguments> packageURLBuilder() throws IOException {
4545

4646
@ParameterizedTest(name = "{0}: {1}")
4747
@MethodSource
48-
void packageURLBuilder(String description,
49-
@Nullable String ignoredPurl,
50-
PurlParameters parameters,
51-
String canonicalPurl,
52-
boolean invalid) throws MalformedPackageURLException {
48+
void packageURLBuilder(
49+
String description,
50+
@Nullable String ignoredPurl,
51+
PurlParameters parameters,
52+
String canonicalPurl,
53+
boolean invalid)
54+
throws MalformedPackageURLException {
5355
if (parameters.getType() == null || parameters.getName() == null) {
5456
assertTrue(invalid, "valid test case with type or name `null`");
5557
return;
5658
}
57-
PackageURLBuilder builder = PackageURLBuilder.aPackageURL().withType(parameters.getType()).withName(parameters.getName());
59+
PackageURLBuilder builder =
60+
PackageURLBuilder.aPackageURL().withType(parameters.getType()).withName(parameters.getName());
5861
String namespace = parameters.getNamespace();
5962
if (namespace != null) {
6063
builder.withNamespace(namespace);
@@ -87,7 +90,7 @@ void packageURLBuilderException1() throws MalformedPackageURLException {
8790
PackageURL purl = PackageURLBuilder.aPackageURL()
8891
.withType("type")
8992
.withName("name")
90-
.withQualifier("key","")
93+
.withQualifier("key", "")
9194
.build();
9295
assertEquals(0, purl.getQualifiers().size(), "qualifier count");
9396
}
@@ -97,63 +100,78 @@ void packageURLBuilderException1Null() throws MalformedPackageURLException {
97100
PackageURL purl = PackageURLBuilder.aPackageURL()
98101
.withType("type")
99102
.withName("name")
100-
.withQualifier("key",null)
103+
.withQualifier("key", null)
101104
.build();
102105
assertEquals(0, purl.getQualifiers().size(), "qualifier count");
103106
}
104107

105108
@Test
106109
void packageURLBuilderException2() {
107-
assertThrowsExactly(MalformedPackageURLException.class, () -> {
108-
PackageURLBuilder.aPackageURL()
109-
.withType("type")
110-
.withNamespace("invalid//namespace")
111-
.withName("name")
112-
.build();
113-
}, "Build should fail due to invalid namespace");
110+
assertThrowsExactly(
111+
MalformedPackageURLException.class,
112+
() -> {
113+
PackageURLBuilder.aPackageURL()
114+
.withType("type")
115+
.withNamespace("invalid//namespace")
116+
.withName("name")
117+
.build();
118+
},
119+
"Build should fail due to invalid namespace");
114120
}
115121

116122
@Test
117123
void packageURLBuilderException3() {
118-
assertThrowsExactly(MalformedPackageURLException.class, () -> {
119-
PackageURLBuilder.aPackageURL()
120-
.withType("typ^e")
121-
.withSubpath("invalid/name%2Fspace")
122-
.withName("name")
123-
.build();
124-
}, "Build should fail due to invalid subpath");
124+
assertThrowsExactly(
125+
MalformedPackageURLException.class,
126+
() -> {
127+
PackageURLBuilder.aPackageURL()
128+
.withType("typ^e")
129+
.withSubpath("invalid/name%2Fspace")
130+
.withName("name")
131+
.build();
132+
},
133+
"Build should fail due to invalid subpath");
125134
}
126135

127136
@Test
128137
void packageURLBuilderException4() {
129-
assertThrowsExactly(MalformedPackageURLException.class, () -> {
130-
PackageURLBuilder.aPackageURL()
131-
.withType("0_type")
132-
.withName("name")
133-
.build();
134-
}, "Build should fail due to invalid type");
138+
assertThrowsExactly(
139+
MalformedPackageURLException.class,
140+
() -> {
141+
PackageURLBuilder.aPackageURL()
142+
.withType("0_type")
143+
.withName("name")
144+
.build();
145+
},
146+
"Build should fail due to invalid type");
135147
}
136148

137149
@Test
138150
void packageURLBuilderException5() {
139-
assertThrowsExactly(MalformedPackageURLException.class, () -> {
140-
PackageURLBuilder.aPackageURL()
141-
.withType("ype")
142-
.withName("name")
143-
.withQualifier("0_key", "value")
144-
.build();
145-
}, "Build should fail due to invalid qualifier key");
151+
assertThrowsExactly(
152+
MalformedPackageURLException.class,
153+
() -> {
154+
PackageURLBuilder.aPackageURL()
155+
.withType("ype")
156+
.withName("name")
157+
.withQualifier("0_key", "value")
158+
.build();
159+
},
160+
"Build should fail due to invalid qualifier key");
146161
}
147162

148163
@Test
149164
void packageURLBuilderException6() {
150-
assertThrowsExactly(MalformedPackageURLException.class, () -> {
151-
PackageURLBuilder.aPackageURL()
152-
.withType("ype")
153-
.withName("name")
154-
.withQualifier("", "value")
155-
.build();
156-
}, "Build should fail due to invalid qualifier key");
165+
assertThrowsExactly(
166+
MalformedPackageURLException.class,
167+
() -> {
168+
PackageURLBuilder.aPackageURL()
169+
.withType("ype")
170+
.withName("name")
171+
.withQualifier("", "value")
172+
.build();
173+
},
174+
"Build should fail due to invalid qualifier key");
157175
}
158176

159177
@Test
@@ -224,8 +242,6 @@ private void assertBuilderMatch(PackageURL expected, PackageURLBuilder actual) t
224242

225243
assertEquals(eQualifiers, aQualifiers);
226244

227-
eQualifiers.forEach((k, v) ->
228-
assertEquals(v, actual.getQualifier(k)));
245+
eQualifiers.forEach((k, v) -> assertEquals(v, actual.getQualifier(k)));
229246
}
230-
231247
}

‎src/test/java/com/github/packageurl/PackageURLTest.java

+53-36
Original file line numberDiff line numberDiff line change
@@ -64,16 +64,22 @@ static void resetLocale() {
6464
void validPercentEncoding() throws MalformedPackageURLException {
6565
PackageURL purl = new PackageURL("maven", "com.google.summit", "summit-ast", "2.2.0\n", null, null);
6666
assertEquals("pkg:maven/com.google.summit/[email protected]%0A", purl.toString());
67-
PackageURL purl2 = new PackageURL("pkg:nuget/%D0%9Cicros%D0%BEft.%D0%95ntit%D1%83Fram%D0%B5work%D0%A1%D0%BEr%D0%B5");
67+
PackageURL purl2 =
68+
new PackageURL("pkg:nuget/%D0%9Cicros%D0%BEft.%D0%95ntit%D1%83Fram%D0%B5work%D0%A1%D0%BEr%D0%B5");
6869
assertEquals("Мicrosоft.ЕntitуFramеworkСоrе", purl2.getName());
69-
assertEquals("pkg:nuget/%D0%9Cicros%D0%BEft.%D0%95ntit%D1%83Fram%D0%B5work%D0%A1%D0%BEr%D0%B5", purl2.toString());
70+
assertEquals(
71+
"pkg:nuget/%D0%9Cicros%D0%BEft.%D0%95ntit%D1%83Fram%D0%B5work%D0%A1%D0%BEr%D0%B5", purl2.toString());
7072
}
7173

7274
@SuppressWarnings("deprecation")
7375
@Test
7476
void invalidPercentEncoding() throws MalformedPackageURLException {
75-
assertThrowsExactly(MalformedPackageURLException.class, () -> new PackageURL("pkg:maven/com.google.summit/[email protected]%"));
76-
assertThrowsExactly(MalformedPackageURLException.class, () -> new PackageURL("pkg:maven/com.google.summit/[email protected]%0"));
77+
assertThrowsExactly(
78+
MalformedPackageURLException.class,
79+
() -> new PackageURL("pkg:maven/com.google.summit/[email protected]%"));
80+
assertThrowsExactly(
81+
MalformedPackageURLException.class,
82+
() -> new PackageURL("pkg:maven/com.google.summit/[email protected]%0"));
7783
PackageURL purl = new PackageURL("pkg:maven/com.google.summit/[email protected]");
7884
Throwable t1 = assertThrowsExactly(ValidationException.class, () -> purl.uriDecode("%"));
7985
assertEquals("Incomplete percent encoding at offset 0 with value '%'", t1.getMessage());
@@ -86,19 +92,20 @@ void invalidPercentEncoding() throws MalformedPackageURLException {
8692
}
8793

8894
static Stream<Arguments> constructorParsing() throws IOException {
89-
return PurlParameters.getTestDataFromFiles("test-suite-data.json",
90-
"custom-suite.json",
91-
"string-constructor-only.json");
95+
return PurlParameters.getTestDataFromFiles(
96+
"test-suite-data.json", "custom-suite.json", "string-constructor-only.json");
9297
}
9398

9499
@DisplayName("Test constructor parsing")
95100
@ParameterizedTest(name = "{0}: ''{1}''")
96101
@MethodSource
97-
void constructorParsing(String description,
98-
@Nullable String purlString,
99-
PurlParameters parameters,
100-
@Nullable String canonicalPurl,
101-
boolean invalid) throws Exception {
102+
void constructorParsing(
103+
String description,
104+
@Nullable String purlString,
105+
PurlParameters parameters,
106+
@Nullable String canonicalPurl,
107+
boolean invalid)
108+
throws Exception {
102109
if (invalid) {
103110
assertThrows(getExpectedException(purlString), () -> new PackageURL(purlString));
104111
} else {
@@ -109,32 +116,38 @@ void constructorParsing(String description,
109116
}
110117

111118
static Stream<Arguments> constructorParameters() throws IOException {
112-
return PurlParameters.getTestDataFromFiles("test-suite-data.json", "custom-suite.json", "components-constructor-only.json");
119+
return PurlParameters.getTestDataFromFiles(
120+
"test-suite-data.json", "custom-suite.json", "components-constructor-only.json");
113121
}
114122

115123
@DisplayName("Test constructor parameters")
116124
@ParameterizedTest(name = "{0}: {2}")
117125
@MethodSource
118-
void constructorParameters(String description,
119-
@Nullable String purlString,
120-
PurlParameters parameters,
121-
@Nullable String canonicalPurl,
122-
boolean invalid) throws Exception {
126+
void constructorParameters(
127+
String description,
128+
@Nullable String purlString,
129+
PurlParameters parameters,
130+
@Nullable String canonicalPurl,
131+
boolean invalid)
132+
throws Exception {
123133
if (invalid) {
124-
assertThrows(getExpectedException(parameters),
125-
() -> new PackageURL(parameters.getType(),
134+
assertThrows(
135+
getExpectedException(parameters),
136+
() -> new PackageURL(
137+
parameters.getType(),
138+
parameters.getNamespace(),
139+
parameters.getName(),
140+
parameters.getVersion(),
141+
parameters.getQualifiers(),
142+
parameters.getSubpath()));
143+
} else {
144+
PackageURL purl = new PackageURL(
145+
parameters.getType(),
126146
parameters.getNamespace(),
127147
parameters.getName(),
128148
parameters.getVersion(),
129149
parameters.getQualifiers(),
130-
parameters.getSubpath()));
131-
} else {
132-
PackageURL purl = new PackageURL(parameters.getType(),
133-
parameters.getNamespace(),
134-
parameters.getName(),
135-
parameters.getVersion(),
136-
parameters.getQualifiers(),
137-
parameters.getSubpath());
150+
parameters.getSubpath());
138151
assertPurlEquals(parameters, purl);
139152
assertEquals(canonicalPurl, purl.canonicalize(), "canonical PURL");
140153
}
@@ -146,14 +159,16 @@ static Stream<Arguments> constructorTypeNameSpace() throws IOException {
146159

147160
@ParameterizedTest
148161
@MethodSource
149-
void constructorTypeNameSpace(String description,
150-
@Nullable String purlString,
151-
PurlParameters parameters,
152-
@Nullable String canonicalPurl,
153-
boolean invalid) throws Exception {
162+
void constructorTypeNameSpace(
163+
String description,
164+
@Nullable String purlString,
165+
PurlParameters parameters,
166+
@Nullable String canonicalPurl,
167+
boolean invalid)
168+
throws Exception {
154169
if (invalid) {
155-
assertThrows(getExpectedException(parameters),
156-
() -> new PackageURL(parameters.getType(), parameters.getName()));
170+
assertThrows(
171+
getExpectedException(parameters), () -> new PackageURL(parameters.getType(), parameters.getName()));
157172
} else {
158173
PackageURL purl = new PackageURL(parameters.getType(), parameters.getName());
159174
assertPurlEquals(parameters, purl);
@@ -173,7 +188,9 @@ private static void assertPurlEquals(PurlParameters expected, PackageURL actual)
173188
}
174189

175190
private static Class<? extends Exception> getExpectedException(PurlParameters json) {
176-
return json.getType() == null || json.getName() == null ? NullPointerException.class : MalformedPackageURLException.class;
191+
return json.getType() == null || json.getName() == null
192+
? NullPointerException.class
193+
: MalformedPackageURLException.class;
177194
}
178195

179196
private static Class<? extends Exception> getExpectedException(@Nullable String purl) {

0 commit comments

Comments
 (0)