Skip to content

Commit

Permalink
Add checkstyle, fix imports (#35)
Browse files Browse the repository at this point in the history 
* Add checkstyle support

* Fix imports

* Fix tests

* Fix newlines

* Force nix newlines

* Newline at end
  • Loading branch information
@yanokwa @lognaturel
yanokwa authored and lognaturel committed Apr 13, 2017
1 parent e442568 commit 781a8c2
Show file tree
Hide file tree
Showing 40 changed files with 778 additions and 504 deletions.
1 change: 1 addition & 0 deletions .gitattributes
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* text=lf
8 changes: 7 additions & 1 deletion build.gradle
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
plugins {
id 'java'
id 'checkstyle'
}

repositories {
Expand All @@ -14,7 +15,7 @@ sourceSets {
}
test {
java {
srcDirs = ['src']
srcDirs = ['test']
}
resources {
srcDirs = ['resources']
Expand All @@ -32,6 +33,11 @@ dependencies {
testCompile group: 'net.sf.kxml', name: 'kxml2', version: '2.3.0'
}

// Required to use fileExtensions property in checkstyle file
checkstyle {
toolVersion = '7.6.1'
}

jar {
baseName = 'opendatakit-javarosa'
// Be sure to update version in pom.xml to match
Expand Down
5 changes: 3 additions & 2 deletions circle.yml
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
test:
override:
- ./gradlew test javadoc jar
- ./gradlew check test javadoc jar
post:
- cp -r build/libs $CIRCLE_ARTIFACTS
- cp -r build/reports/tests/test $CIRCLE_TEST_REPORTS/junit
- cp -r build/docs/javadoc $CIRCLE_TEST_REPORTS
- cp -r build/docs/javadoc $CIRCLE_TEST_REPORTS
- cp -r build/reports/checkstyle $CIRCLE_TEST_REPORTS
222 changes: 222 additions & 0 deletions config/checkstyle/checkstyle.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,222 @@
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">

<!--
Checkstyle configuration that checks the Google coding conventions from Google Java Style
that can be found at https://google.github.io/styleguide/javaguide.html.
Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
Source: https://github.com/checkstyle/checkstyle/blob/master/src/main/resources/google_checks.xml
-->

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

<property name="fileExtensions" value="java, properties, xml"/>

<!-- <module name="FileTabCharacter">
<property name="eachLine" value="true"/>
</module> -->

<!-- ODK-specific additions -->
<module name="RegexpMultiline">
<property name="format" value="\r\n"/>
<property name="message" value="Do not use Windows line endings"/>
</module>

<module name="TreeWalker">
<!-- ODK-specific additions -->
<module name="IllegalImport" />
<module name="RedundantImport" />
<module name="UnusedImports" />

<!-- <module name="OuterTypeFilename"/> -->
<!-- <module name="IllegalTokenText">
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
<property name="format" value="\\u00(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="Consider using special escape sequence instead of octal value or Unicode escaped value."/>
</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="100"/>
<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">
<property name="maxLineLength" value="100"/>
</module> -->
<!-- <module name="RightCurly">
<property name="id" value="RightCurlySame"/>
<property name="tokens" value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_DO"/>
</module> -->
<!-- <module name="RightCurly">
<property name="id" value="RightCurlyAlone"/>
<property name="option" value="alone"/>
<property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT, INSTANCE_INIT"/>
</module> -->
<!-- <module name="WhitespaceAround">
<property name="allowEmptyConstructors" value="true"/>
<property name="allowEmptyMethods" value="true"/>
<property name="allowEmptyTypes" value="true"/>
<property name="allowEmptyLoops" 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="id" value="SeparatorWrapDot"/>
<property name="tokens" value="DOT"/>
<property name="option" value="nl"/>
</module> -->
<!-- <module name="SeparatorWrap">
<property name="id" value="SeparatorWrapComma"/>
<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="CatchParameterName">
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
<message key="name.invalidPattern"
value="Catch 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]*)?$"/>
<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="InterfaceTypeParameterName">
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
<message key="name.invalidPattern"
value="Interface 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="2"/>
<property name="braceAdjustment" value="0"/>
<property name="caseIndent" value="2"/>
<property name="throwsIndent" value="4"/>
<property name="lineWrappingIndentation" value="4"/>
<property name="arrayInitIndent" value="2"/>
</module> -->
<!-- <module name="AbbreviationAsWordInName">
<property name="ignoreFinal" value="false"/>
<property name="allowedAbbreviationLength" value="1"/>
</module> -->
<!-- <module name="OverloadMethodsDeclarationOrder"/> -->
<!-- <module name="VariableDeclarationUsageDistance"/> -->
<!-- <module name="CustomImportOrder">
<property name="sortImportsInGroupAlphabetically" value="true"/>
<property name="separateLineBetweenGroups" value="true"/>
<property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>
</module> -->
<!-- <module name="MethodParamPad"/> -->
<!-- <module name="ParenPad"/> -->
<!-- <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, METHOD_REF "/>
</module> -->
<!-- <module name="AnnotationLocation">
<property name="id" value="AnnotationLocationMostCases"/>
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
</module> -->
<!-- <module name="AnnotationLocation">
<property name="id" value="AnnotationLocationVariables"/>
<property name="tokens" value="VARIABLE_DEF"/>
<property name="allowSamelineMultipleAnnotations" value="true"/>
</module> -->
<!-- <module name="NonEmptyAtclauseDescription"/> -->
<!-- <module name="JavadocTagContinuationIndentation"/> -->
<!-- <module name="SummaryJavadoc">
<property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
</module> -->
<!-- <module name="JavadocParagraph"/> -->
<!-- <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="JavadocMethod">
<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="expected"/>
</module> -->
<!-- <module name="CommentsIndentation"/> -->
</module>
</module>
48 changes: 24 additions & 24 deletions src/org/javarosa/core/api/ILogger.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,31 +14,31 @@
* the License.
*/

/**
*
*/
package org.javarosa.core.api;

import java.io.IOException;
import java.util.Date;
/**
*
*/
package org.javarosa.core.api;

import org.javarosa.core.log.IFullLogSerializer;
import org.javarosa.core.log.StreamLogSerializer;

/**
* IIncidentLogger's are used for instrumenting applications to identify usage
* patterns, usability errors, and general trajectories through applications.
*
* @author Clayton Sims
* @date Apr 10, 2009
*
*/
public interface ILogger {

public void log(String type, String message, Date logDate);

public void clearLogs();


import java.io.IOException;
import java.util.Date;

/**
* IIncidentLogger's are used for instrumenting applications to identify usage
* patterns, usability errors, and general trajectories through applications.
*
* @author Clayton Sims
* @date Apr 10, 2009
*
*/
public interface ILogger {

public void log(String type, String message, Date logDate);

public void clearLogs();

public <T> T serializeLogs(IFullLogSerializer<T> serializer);

public void serializeLogs(StreamLogSerializer serializer) throws IOException;
Expand All @@ -48,5 +48,5 @@ public interface ILogger {

public int logSize();

public void halt();
}
public void halt();
}
26 changes: 13 additions & 13 deletions src/org/javarosa/core/log/IFullLogSerializer.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,16 @@
* the License.
*/

/**
*
*/
package org.javarosa.core.log;

/**
* @author Clayton Sims
* @date Apr 10, 2009
*
*/
public interface IFullLogSerializer<T> {
public T serializeLogs(LogEntry[] logs);
}
/**
*
*/
package org.javarosa.core.log;

/**
* @author Clayton Sims
* @date Apr 10, 2009
*
*/
public interface IFullLogSerializer<T> {
public T serializeLogs(LogEntry[] logs);
}
Loading

0 comments on commit 781a8c2

Please sign in to comment.