Skip to content

Commit 1589393

Browse files
authored
Merge pull request #48 from peterbencze/development
Serritor 2.1.1
2 parents 6ec3358 + 40ae6ae commit 1589393

File tree

9 files changed

+369
-196
lines changed

9 files changed

+369
-196
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ Add the following dependency to your pom.xml:
1919
<dependency>
2020
<groupId>com.github.peterbencze</groupId>
2121
<artifactId>serritor</artifactId>
22-
<version>2.1.0</version>
22+
<version>2.1.1</version>
2323
</dependency>
2424
```
2525

2626
### Gradle
2727

2828
Add the following dependency to your build.gradle:
2929
```groovy
30-
compile group: 'com.github.peterbencze', name: 'serritor', version: '2.1.0'
30+
compile group: 'com.github.peterbencze', name: 'serritor', version: '2.1.1'
3131
```
3232

3333
### Manual dependencies

checkstyle.xml

+106-25
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,53 @@
11
<?xml version="1.0"?>
22
<!DOCTYPE module PUBLIC
3-
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
4-
"http://checkstyle.sourceforge.net/dtds/configuration_1_3.dtd">
3+
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
4+
"https://checkstyle.org/dtds/configuration_1_3.dtd">
55

66
<!--
77
Checkstyle configuration that checks the Google coding conventions from Google Java Style
8-
that can be found at https://google.github.io/styleguide/javaguide.html.
8+
that can be found at https://google.github.io/styleguide/javaguide.html
99
1010
Checkstyle is very configurable. Be sure to read the documentation at
11-
http://checkstyle.sf.net (or in your downloaded distribution).
11+
http://checkstyle.org (or in your downloaded distribution).
1212
1313
To completely disable a check, just comment it out or delete it from the file.
14+
To suppress certain violations please review suppression filters.
1415
15-
Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
16-
-->
16+
Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
17+
-->
1718

18-
<module name = "Checker">
19+
<module name="Checker">
1920
<property name="charset" value="UTF-8"/>
2021

2122
<property name="severity" value="warning"/>
2223

2324
<property name="fileExtensions" value="java, properties, xml"/>
25+
<!-- Excludes all 'module-info.java' files -->
26+
<!-- See https://checkstyle.org/config_filefilters.html -->
27+
<module name="BeforeExecutionExclusionFileFilter">
28+
<property name="fileNamePattern" value="module\-info\.java$"/>
29+
</module>
30+
<!-- https://checkstyle.org/config_filters.html#SuppressionFilter -->
31+
<module name="SuppressionFilter">
32+
<property name="file" value="${org.checkstyle.google.suppressionfilter.config}"
33+
default="checkstyle-suppressions.xml"/>
34+
<property name="optional" value="true"/>
35+
</module>
36+
2437
<!-- Checks for whitespace -->
25-
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
38+
<!-- See http://checkstyle.org/config_whitespace.html -->
2639
<module name="FileTabCharacter">
2740
<property name="eachLine" value="true"/>
2841
</module>
2942

30-
<module name="SuppressWarningsFilter" />
43+
<module name="LineLength">
44+
<property name="fileExtensions" value="java"/>
45+
<property name="max" value="100"/>
46+
<property name="ignorePattern"
47+
value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
48+
</module>
3149

3250
<module name="TreeWalker">
33-
<module name="SuppressWarningsHolder" />
3451
<module name="OuterTypeFilename"/>
3552
<module name="IllegalTokenText">
3653
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
@@ -44,20 +61,28 @@
4461
<property name="allowByTailComment" value="true"/>
4562
<property name="allowNonPrintableEscapes" value="true"/>
4663
</module>
47-
<module name="LineLength">
48-
<property name="max" value="100"/>
49-
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
50-
</module>
5164
<module name="AvoidStarImport"/>
5265
<module name="OneTopLevelClass"/>
53-
<module name="NoLineWrap"/>
66+
<module name="NoLineWrap">
67+
<property name="tokens" value="PACKAGE_DEF, IMPORT, STATIC_IMPORT"/>
68+
</module>
5469
<module name="EmptyBlock">
5570
<property name="option" value="TEXT"/>
5671
<property name="tokens"
5772
value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
5873
</module>
59-
<module name="NeedBraces"/>
60-
<module name="LeftCurly"/>
74+
<module name="NeedBraces">
75+
<property name="tokens"
76+
value="LITERAL_DO, LITERAL_ELSE, LITERAL_FOR, LITERAL_IF, LITERAL_WHILE"/>
77+
</module>
78+
<module name="LeftCurly">
79+
<property name="tokens"
80+
value="ANNOTATION_DEF, CLASS_DEF, CTOR_DEF, ENUM_CONSTANT_DEF, ENUM_DEF,
81+
INTERFACE_DEF, LAMBDA, LITERAL_CASE, LITERAL_CATCH, LITERAL_DEFAULT,
82+
LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF,
83+
LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, METHOD_DEF,
84+
OBJBLOCK, STATIC_INIT"/>
85+
</module>
6186
<module name="RightCurly">
6287
<property name="id" value="RightCurlySame"/>
6388
<property name="tokens"
@@ -69,13 +94,33 @@
6994
<property name="option" value="alone"/>
7095
<property name="tokens"
7196
value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT,
72-
INSTANCE_INIT"/>
97+
INSTANCE_INIT, ANNOTATION_DEF, ENUM_DEF"/>
98+
</module>
99+
<module name="SuppressionXpathSingleFilter">
100+
<!-- suppresion is required till https://github.com/checkstyle/checkstyle/issues/7541 -->
101+
<property name="id" value="RightCurlyAlone"/>
102+
<property name="query" value="//RCURLY[parent::SLIST[count(./*)=1]
103+
or preceding-sibling::*[last()][self::LCURLY]]"/>
104+
</module>
105+
<module name="WhitespaceAfter">
106+
<property name="tokens"
107+
value="COMMA, SEMI, TYPECAST, LITERAL_IF, LITERAL_ELSE,
108+
LITERAL_WHILE, LITERAL_DO, LITERAL_FOR, DO_WHILE"/>
73109
</module>
74110
<module name="WhitespaceAround">
75111
<property name="allowEmptyConstructors" value="true"/>
112+
<property name="allowEmptyLambdas" value="true"/>
76113
<property name="allowEmptyMethods" value="true"/>
77114
<property name="allowEmptyTypes" value="true"/>
78115
<property name="allowEmptyLoops" value="true"/>
116+
<property name="tokens"
117+
value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR,
118+
BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, DO_WHILE, EQUAL, GE, GT, LAMBDA, LAND,
119+
LCURLY, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY,
120+
LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SWITCH, LITERAL_SYNCHRONIZED,
121+
LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN,
122+
NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR,
123+
SR_ASSIGN, STAR, STAR_ASSIGN, LITERAL_ASSERT, TYPE_EXTENSION_AND"/>
79124
<message key="ws.notFollowed"
80125
value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/>
81126
<message key="ws.notPreceded"
@@ -89,6 +134,9 @@
89134
<module name="UpperEll"/>
90135
<module name="ModifierOrder"/>
91136
<module name="EmptyLineSeparator">
137+
<property name="tokens"
138+
value="PACKAGE_DEF, IMPORT, STATIC_IMPORT, CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
139+
STATIC_INIT, INSTANCE_INIT, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
92140
<property name="allowNoEmptyLineBetweenFields" value="true"/>
93141
</module>
94142
<module name="SeparatorWrap">
@@ -124,6 +172,7 @@
124172
value="Package name ''{0}'' must match pattern ''{1}''."/>
125173
</module>
126174
<module name="TypeName">
175+
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF"/>
127176
<message key="name.invalidPattern"
128177
value="Type name ''{0}'' must match pattern ''{1}''."/>
129178
</module>
@@ -137,13 +186,17 @@
137186
<message key="name.invalidPattern"
138187
value="Parameter name ''{0}'' must match pattern ''{1}''."/>
139188
</module>
189+
<module name="LambdaParameterName">
190+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
191+
<message key="name.invalidPattern"
192+
value="Lambda parameter name ''{0}'' must match pattern ''{1}''."/>
193+
</module>
140194
<module name="CatchParameterName">
141195
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
142196
<message key="name.invalidPattern"
143197
value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
144198
</module>
145199
<module name="LocalVariableName">
146-
<property name="tokens" value="VARIABLE_DEF"/>
147200
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
148201
<message key="name.invalidPattern"
149202
value="Local variable name ''{0}'' must match pattern ''{1}''."/>
@@ -187,21 +240,36 @@
187240
<module name="AbbreviationAsWordInName">
188241
<property name="ignoreFinal" value="false"/>
189242
<property name="allowedAbbreviationLength" value="1"/>
243+
<property name="tokens"
244+
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF,
245+
PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF"/>
190246
</module>
191247
<module name="OverloadMethodsDeclarationOrder"/>
192248
<module name="VariableDeclarationUsageDistance"/>
193249
<module name="CustomImportOrder">
194250
<property name="sortImportsInGroupAlphabetically" value="true"/>
195251
<property name="separateLineBetweenGroups" value="true"/>
196252
<property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>
253+
<property name="tokens" value="IMPORT, STATIC_IMPORT, PACKAGE_DEF"/>
254+
</module>
255+
<module name="MethodParamPad">
256+
<property name="tokens"
257+
value="CTOR_DEF, LITERAL_NEW, METHOD_CALL, METHOD_DEF,
258+
SUPER_CTOR_CALL, ENUM_CONSTANT_DEF"/>
197259
</module>
198-
<module name="MethodParamPad"/>
199260
<module name="NoWhitespaceBefore">
200261
<property name="tokens"
201-
value="COMMA, SEMI, POST_INC, POST_DEC, DOT, ELLIPSIS, METHOD_REF"/>
262+
value="COMMA, SEMI, POST_INC, POST_DEC, DOT,
263+
LABELED_STAT, METHOD_REF"/>
202264
<property name="allowLineBreaks" value="true"/>
203265
</module>
204-
<module name="ParenPad"/>
266+
<module name="ParenPad">
267+
<property name="tokens"
268+
value="ANNOTATION, ANNOTATION_FIELD_DEF, CTOR_CALL, CTOR_DEF, DOT, ENUM_CONSTANT_DEF,
269+
EXPR, LITERAL_CATCH, LITERAL_DO, LITERAL_FOR, LITERAL_IF, LITERAL_NEW,
270+
LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_WHILE, METHOD_CALL,
271+
METHOD_DEF, QUESTION, RESOURCE_SPECIFICATION, SUPER_CTOR_CALL, LAMBDA"/>
272+
</module>
205273
<module name="OperatorWrap">
206274
<property name="option" value="NL"/>
207275
<property name="tokens"
@@ -219,6 +287,7 @@
219287
<property name="allowSamelineMultipleAnnotations" value="true"/>
220288
</module>
221289
<module name="NonEmptyAtclauseDescription"/>
290+
<module name="InvalidJavadocPosition"/>
222291
<module name="JavadocTagContinuationIndentation"/>
223292
<module name="SummaryJavadoc">
224293
<property name="forbiddenSummaryFragments"
@@ -233,11 +302,15 @@
233302
<module name="JavadocMethod">
234303
<property name="scope" value="public"/>
235304
<property name="allowMissingParamTags" value="true"/>
236-
<property name="allowMissingThrowsTags" value="true"/>
237305
<property name="allowMissingReturnTag" value="true"/>
306+
<property name="allowedAnnotations" value="Override, Test"/>
307+
<property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF"/>
308+
</module>
309+
<module name="MissingJavadocMethod">
310+
<property name="scope" value="public"/>
238311
<property name="minLineCount" value="2"/>
239312
<property name="allowedAnnotations" value="Override, Test"/>
240-
<property name="allowThrowsTagsForSubclasses" value="true"/>
313+
<property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF"/>
241314
</module>
242315
<module name="MethodName">
243316
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
@@ -250,6 +323,14 @@
250323
<module name="EmptyCatchBlock">
251324
<property name="exceptionVariableName" value="expected"/>
252325
</module>
253-
<module name="CommentsIndentation"/>
326+
<module name="CommentsIndentation">
327+
<property name="tokens" value="SINGLE_LINE_COMMENT, BLOCK_COMMENT_BEGIN"/>
328+
</module>
329+
<!-- https://checkstyle.org/config_filters.html#SuppressionXpathFilter -->
330+
<module name="SuppressionXpathFilter">
331+
<property name="file" value="${org.checkstyle.google.suppressionxpathfilter.config}"
332+
default="checkstyle-xpath-suppressions.xml"/>
333+
<property name="optional" value="true"/>
334+
</module>
254335
</module>
255336
</module>

pom.xml

+13-13
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<modelVersion>4.0.0</modelVersion>
44
<groupId>com.github.peterbencze</groupId>
55
<artifactId>serritor</artifactId>
6-
<version>2.1.0</version>
6+
<version>2.1.1</version>
77
<packaging>jar</packaging>
88

99
<name>Serritor</name>
@@ -59,7 +59,7 @@
5959
<dependency>
6060
<groupId>org.seleniumhq.selenium</groupId>
6161
<artifactId>htmlunit-driver</artifactId>
62-
<version>2.35.1</version>
62+
<version>2.41.0</version>
6363
</dependency>
6464
<dependency>
6565
<groupId>net.lightbody.bmp</groupId>
@@ -69,7 +69,7 @@
6969
<dependency>
7070
<groupId>com.google.guava</groupId>
7171
<artifactId>guava</artifactId>
72-
<version>28.0-jre</version>
72+
<version>29.0-jre</version>
7373
</dependency>
7474
<dependency>
7575
<groupId>org.eclipse.jetty</groupId>
@@ -100,12 +100,12 @@
100100
<dependency>
101101
<groupId>org.slf4j</groupId>
102102
<artifactId>slf4j-api</artifactId>
103-
<version>1.7.26</version>
103+
<version>1.7.30</version>
104104
</dependency>
105105
<dependency>
106106
<groupId>com.auth0</groupId>
107107
<artifactId>java-jwt</artifactId>
108-
<version>3.8.1</version>
108+
<version>3.10.3</version>
109109
</dependency>
110110
<dependency>
111111
<groupId>org.mindrot</groupId>
@@ -127,19 +127,19 @@
127127
<dependency>
128128
<groupId>com.github.tomakehurst</groupId>
129129
<artifactId>wiremock-jre8-standalone</artifactId>
130-
<version>2.23.2</version>
130+
<version>2.26.3</version>
131131
<scope>test</scope>
132132
</dependency>
133133
<dependency>
134134
<groupId>org.awaitility</groupId>
135135
<artifactId>awaitility</artifactId>
136-
<version>3.1.6</version>
136+
<version>4.0.3</version>
137137
<scope>test</scope>
138138
</dependency>
139139
<dependency>
140140
<groupId>net.jodah</groupId>
141141
<artifactId>failsafe</artifactId>
142-
<version>2.0.1</version>
142+
<version>2.4.0</version>
143143
<scope>test</scope>
144144
</dependency>
145145
</dependencies>
@@ -149,7 +149,7 @@
149149
<plugin>
150150
<groupId>org.apache.maven.plugins</groupId>
151151
<artifactId>maven-source-plugin</artifactId>
152-
<version>3.1.0</version>
152+
<version>3.2.1</version>
153153
<executions>
154154
<execution>
155155
<id>attach-source</id>
@@ -162,7 +162,7 @@
162162
<plugin>
163163
<groupId>org.apache.maven.plugins</groupId>
164164
<artifactId>maven-javadoc-plugin</artifactId>
165-
<version>3.1.0</version>
165+
<version>3.2.0</version>
166166
<executions>
167167
<execution>
168168
<id>attach-javadoc</id>
@@ -181,12 +181,12 @@
181181
<plugin>
182182
<groupId>org.apache.maven.plugins</groupId>
183183
<artifactId>maven-checkstyle-plugin</artifactId>
184-
<version>3.0.0</version>
184+
<version>3.1.1</version>
185185
<dependencies>
186186
<dependency>
187187
<groupId>com.puppycrawl.tools</groupId>
188188
<artifactId>checkstyle</artifactId>
189-
<version>8.20</version>
189+
<version>8.33</version>
190190
</dependency>
191191
</dependencies>
192192
<configuration>
@@ -245,7 +245,7 @@
245245
<plugin>
246246
<groupId>org.apache.maven.plugins</groupId>
247247
<artifactId>maven-site-plugin</artifactId>
248-
<version>3.7.1</version>
248+
<version>3.9.0</version>
249249
<configuration>
250250
<skip>true</skip>
251251
<skipDeploy>true</skipDeploy>

0 commit comments

Comments
 (0)