Skip to content
This repository has been archived by the owner on Oct 7, 2024. It is now read-only.

Commit

Permalink
Added checkstyle and fixed the initial batch of warnings for #10
Browse files Browse the repository at this point in the history 
I temporarily disabled the parts that validate Javadocs since we will
handle that later in #8.
  • Loading branch information
@splitfeed
splitfeed committed Dec 5, 2017
1 parent ec16a9c commit 764c6cf
Show file tree
Hide file tree
Showing 96 changed files with 4,785 additions and 4,401 deletions.
15 changes: 15 additions & 0 deletions checkstyle-suppressions.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?xml version="1.0"?>

<!DOCTYPE suppressions PUBLIC
"-//Puppy Crawl//DTD Suppressions 1.1//EN"
"http://checkstyle.sourceforge.net/dtds/suppressions_1_1.dtd">

<suppressions>
<!-- PATCH has special meaning as a REST-verb -->
<suppress checks="AbbreviationAsWordInName" files="PATCH.java"/>

<!-- UUIDDeserializer wraps around a system class called UUID -->
<suppress checks="AbbreviationAsWordInName" files="UUIDDeserializer.java"/>

<suppress checks="[a-zA-Z0-9]*" files="[\\/]test[\\/]java[\\/].*\.java" />
</suppressions>
192 changes: 192 additions & 0 deletions checkstyle.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,192 @@
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">

<!-- Based off of Google Java Style -->

<module name="Checker">
<property name="charset" value="UTF-8" />

<property name="severity" value="error" />

<property name="fileExtensions" value="java, properties, xml" />
<!-- Checks for whitespace -->
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
<module name="FileTabCharacter">
<property name="eachLine" value="true"/>
</module>

<module name="TreeWalker">
<module name="OuterTypeFilename" />
<module name="IllegalTokenText">
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL" />
<property name="format" value="\\u00(08|09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)" />
<property name="message" value="Avoid using corresponding octal or Unicode escape." />
</module>
<module name="AvoidEscapedUnicodeCharacters">
<property name="allowEscapesForControlCharacters" value="true" />
<property name="allowByTailComment" value="true" />
<property name="allowNonPrintableEscapes" value="true" />
</module>
<module name="LineLength">
<property name="max" value="160" />
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://" />
</module>
<module name="AvoidStarImport" />
<module name="OneTopLevelClass" />
<module name="NoLineWrap" />
<module name="EmptyBlock">
<property name="option" value="TEXT" />
<property name="tokens" value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH" />
</module>
<module name="NeedBraces" />
<module name="LeftCurly" />
<module name="RightCurly">
<property name="option" value="alone" />
<property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, STATIC_INIT, INSTANCE_INIT" />
</module>
<module name="WhitespaceAround">
<property name="allowEmptyConstructors" value="true" />
<message key="ws.notFollowed"
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)" />
<message key="ws.notPreceded" value="WhitespaceAround: ''{0}'' is not preceded with whitespace." />
</module>
<module name="OneStatementPerLine" />
<module name="MultipleVariableDeclarations" />
<module name="ArrayTypeStyle" />
<module name="MissingSwitchDefault" />
<module name="FallThrough" />
<module name="UpperEll" />
<module name="ModifierOrder" />
<module name="EmptyLineSeparator">
<property name="allowNoEmptyLineBetweenFields" value="true" />
</module>
<module name="SeparatorWrap">
<property name="tokens" value="DOT" />
<property name="option" value="nl" />
</module>
<module name="SeparatorWrap">
<property name="tokens" value="COMMA" />
<property name="option" value="EOL" />
</module>
<module name="PackageName">
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$" />
<message key="name.invalidPattern" value="Package name ''{0}'' must match pattern ''{1}''." />
</module>
<module name="TypeName">
<message key="name.invalidPattern" value="Type name ''{0}'' must match pattern ''{1}''." />
</module>
<module name="MemberName">
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$" />
<message key="name.invalidPattern" value="Member name ''{0}'' must match pattern ''{1}''." />
</module>
<module name="ParameterName">
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$" />
<message key="name.invalidPattern" value="Parameter name ''{0}'' must match pattern ''{1}''." />
</module>
<module name="LocalVariableName">
<property name="tokens" value="VARIABLE_DEF" />
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$" />
<property name="allowOneCharVarInForLoop" value="true" />
<message key="name.invalidPattern" value="Local variable name ''{0}'' must match pattern ''{1}''." />
</module>
<module name="ClassTypeParameterName">
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)" />
<message key="name.invalidPattern" value="Class type name ''{0}'' must match pattern ''{1}''." />
</module>
<module name="MethodTypeParameterName">
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)" />
<message key="name.invalidPattern" value="Method type name ''{0}'' must match pattern ''{1}''." />
</module>
<module name="NoFinalizer" />
<module name="GenericWhitespace">
<message key="ws.followed" value="GenericWhitespace ''{0}'' is followed by whitespace." />
<message key="ws.preceded" value="GenericWhitespace ''{0}'' is preceded with whitespace." />
<message key="ws.illegalFollow" value="GenericWhitespace ''{0}'' should followed by whitespace." />
<message key="ws.notPreceded" value="GenericWhitespace ''{0}'' is not preceded with whitespace." />
</module>
<!--
<module name="Indentation">
<property name="basicOffset" value="4"/>
<property name="braceAdjustment" value="0"/>
<property name="caseIndent" value="4"/>
<property name="throwsIndent" value="4"/>
<property name="lineWrappingIndentation" value="4"/>
<property name="arrayInitIndent" value="4"/>
</module>
-->
<module name="AbbreviationAsWordInName">
<property name="ignoreFinal" value="false" />
<property name="allowedAbbreviationLength" value="1" />
</module>
<module name="OverloadMethodsDeclarationOrder" />
<module name="VariableDeclarationUsageDistance" />

<!-- TODO We want javax to go before java, to match IntelliJ default for less migration friction -->
<!-- See https://github.com/checkstyle/checkstyle/issues/525 -->
<!--
<module name="CustomImportOrder">
<property name="severity" value="info" />
<property name="specialImportsRegExp" value="^[se|com]\.fortnox" />
<property name="sortImportsInGroupAlphabetically" value="true" />
<property name="customImportOrderRules" value="THIRD_PARTY_PACKAGE###SPECIAL_IMPORTS###STANDARD_JAVA_PACKAGE###STATIC" />
</module>
-->
<module name="MethodParamPad" />
<!--
TODO We'll get to this later
<module name="OperatorWrap">
<property name="option" value="NL"/>
<property name="tokens" value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR "/>
</module>
-->
<module name="AnnotationLocation">
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF" />
</module>
<module name="AnnotationLocation">
<property name="tokens" value="VARIABLE_DEF" />
<property name="allowSamelineMultipleAnnotations" value="true" />
</module>
<!-- TODO Javadocs will be resolved separately
<module name="NonEmptyAtclauseDescription" />
-->
<module name="JavadocTagContinuationIndentation" />
<!--
<module name="SummaryJavadocCheck">
<property name="forbiddenSummaryFragments"
value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
</module>
-->
<module name="AtclauseOrder">
<property name="tagOrder" value="@param, @return, @throws, @deprecated" />
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF" />
</module>
<!--<module name="JavadocParagraph"/>-->
<!-- TODO Javadocs will be resolved separately
<module name="JavadocType" />
<module name="JavadocMethod">
<property name="ignoreMethodNamesRegex" value="set.*" />
<property name="tokens" value="METHOD_DEF, ANNOTATION_FIELD_DEF" />
<property name="scope" value="public" />
<property name="allowMissingParamTags" value="true" />
<property name="allowMissingThrowsTags" value="true" />
<property name="allowMissingReturnTag" value="true" />
<property name="minLineCount" value="2" />
<property name="allowedAnnotations" value="Override, Test" />
<property name="allowThrowsTagsForSubclasses" value="true" />
</module>
-->
<module name="MethodName">
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$" />
<message key="name.invalidPattern" value="Method name ''{0}'' must match pattern ''{1}''." />
</module>
<module name="SingleLineJavadoc">
<property name="ignoreInlineTags" value="false" />
</module>
<module name="EmptyCatchBlock">
<property name="exceptionVariableName" value="ignored|expected" />
</module>
<module name="CommentsIndentation" />
</module>
</module>
8 changes: 4 additions & 4 deletions ...es/hello-world/src/main/java/se/fortnox/reactivewizard/helloworld/HelloWorldResource.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
@Path("/helloworld")
public class HelloWorldResource {

@GET
public Observable<String> greeting() {
return just("Hello world!");
}
@GET
public Observable<String> greeting() {
return just("Hello world!");
}
}
10 changes: 5 additions & 5 deletions examples/hello-world/src/main/java/se/fortnox/reactivewizard/helloworld/Main.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@

public class Main {

public static void main(String[] args) {
HttpServer.newServer(8080)
.start(new JaxRsRequestHandler(new HelloWorldResource()))
.awaitShutdown();
}
public static void main(String[] args) {
HttpServer.newServer(8080)
.start(new JaxRsRequestHandler(new HelloWorldResource()))
.awaitShutdown();
}
}
76 changes: 38 additions & 38 deletions jaxrs-api/src/main/java/se/fortnox/reactivewizard/jaxrs/FieldError.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,43 +7,43 @@

public class FieldError {

protected static final String VALIDATION = "validation.";
private final String field;
private final String error;
private final Map<String, Object> errorParams;

public FieldError(String field, String validationErrorCode) {
this(field, validationErrorCode, null);
}

public FieldError(String field, String validationErrorCode, Map<String, Object> errorParams) {
this.field = field;
this.errorParams = errorParams;
this.error = addPrefix(validationErrorCode);
}

private String addPrefix(String error) {
if (!error.startsWith(VALIDATION)) {
return VALIDATION + error.toLowerCase();
}
return error.toLowerCase();
}

public String getField() {
return field;
}

public String getError() {
return error;
}

@JsonInclude(Include.NON_NULL)
public Map<String, Object> getErrorParams() {
return errorParams;
}

public static FieldError notNull(String field) {
return new FieldError(field, "notnull");
}
protected static final String VALIDATION = "validation.";
private final String field;
private final String error;
private final Map<String, Object> errorParams;

public FieldError(String field, String validationErrorCode) {
this(field, validationErrorCode, null);
}

public FieldError(String field, String validationErrorCode, Map<String, Object> errorParams) {
this.field = field;
this.errorParams = errorParams;
this.error = addPrefix(validationErrorCode);
}

public static FieldError notNull(String field) {
return new FieldError(field, "notnull");
}

private String addPrefix(String error) {
if (!error.startsWith(VALIDATION)) {
return VALIDATION + error.toLowerCase();
}
return error.toLowerCase();
}

public String getField() {
return field;
}

public String getError() {
return error;
}

@JsonInclude(Include.NON_NULL)
public Map<String, Object> getErrorParams() {
return errorParams;
}

}
6 changes: 3 additions & 3 deletions jaxrs-api/src/main/java/se/fortnox/reactivewizard/jaxrs/Headers.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@

/**
* Annotate a resource method with this to make it set the header of your choice
*
* <p>
* e.g.
*
* <p>
* {@literal @}Headers("Content-Disposition: attachment; filename=export.csv")
*/
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Headers {
String[] value();
String[] value();
}
1 change: 1 addition & 0 deletions jaxrs-api/src/main/java/se/fortnox/reactivewizard/jaxrs/PATCH.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

/**
* Indicates that the annotated method responds to HTTP PATCH requests
*
* @see HttpMethod
*/
@Target({ElementType.METHOD})
Expand Down
2 changes: 1 addition & 1 deletion jaxrs-api/src/main/java/se/fortnox/reactivewizard/jaxrs/Stream.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
/**
* Means that the resource returns a stream of data, rather than a single data item.
*/
@Target({ ElementType.METHOD })
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Stream {

Expand Down
Loading

0 comments on commit 764c6cf

Please sign in to comment.