jenkins-bot has submitted this change and it was merged. ( 
https://gerrit.wikimedia.org/r/328695 )

Change subject: Checkstyle - add the WhitespaceAround rule
......................................................................


Checkstyle - add the WhitespaceAround rule

see http://checkstyle.sourceforge.net/config_whitespace.html#WhitespaceAround

This follows a discussion with dcausse. I'm not sure it really make sense to
enforce strict coding style. Feel free to -2 this change, I won't mind.

Change-Id: I8122738c49c2dfae3d5e6b22a448610a8cf7c91e
---
A experimental-highlighter-build-tools/pom.xml
A 
experimental-highlighter-build-tools/src/main/resources/org/wikimedia/search/highlighter/checkstyle.xml
M experimental-highlighter-core/pom.xml
M 
experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/hit/ConcatHitEnum.java
M 
experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/hit/MergingHitEnum.java
M 
experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/hit/OverlapMergingHitEnumWrapper.java
M 
experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/snippet/CharScanningSegmenter.java
M 
experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/source/NonMergingMultiSourceExtracter.java
M 
experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/source/StringMergingMultiSourceExtracter.java
M 
experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/tools/GraphvizHitEnumGenerator.java
M 
experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/tools/GraphvizSnippetFormatter.java
M experimental-highlighter-elasticsearch-plugin/pom.xml
M 
experimental-highlighter-elasticsearch-plugin/src/main/java/org/wikimedia/highlighter/experimental/elasticsearch/OffsetSnippetFormatter.java
M experimental-highlighter-lucene/pom.xml
M 
experimental-highlighter-lucene/src/main/java/org/wikimedia/highlighter/experimental/lucene/QueryFlattener.java
M 
experimental-highlighter-lucene/src/main/java/org/wikimedia/highlighter/experimental/lucene/hit/PostingsHitEnum.java
M pom.xml
17 files changed, 92 insertions(+), 15 deletions(-)

Approvals:
  jenkins-bot: Verified
  DCausse: Looks good to me, approved



diff --git a/experimental-highlighter-build-tools/pom.xml 
b/experimental-highlighter-build-tools/pom.xml
new file mode 100644
index 0000000..72e8894
--- /dev/null
+++ b/experimental-highlighter-build-tools/pom.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0";
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 
http://maven.apache.org/xsd/maven-4.0.0.xsd";>
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>org.wikimedia.search.highlighter</groupId>
+        <artifactId>experimental</artifactId>
+        <version>2.4.2-SNAPSHOT</version>
+    </parent>
+
+    <groupId>org.wikimedia.search.highlighter</groupId>
+    <artifactId>experimental-highlighter-build-tools</artifactId>
+    <version>2.4.2-SNAPSHOT</version>
+    <packaging>jar</packaging>
+
+    <name>Common tools used to build this project</name>
+    
+</project>
\ No newline at end of file
diff --git 
a/experimental-highlighter-build-tools/src/main/resources/org/wikimedia/search/highlighter/checkstyle.xml
 
b/experimental-highlighter-build-tools/src/main/resources/org/wikimedia/search/highlighter/checkstyle.xml
new file mode 100644
index 0000000..6e97cc5
--- /dev/null
+++ 
b/experimental-highlighter-build-tools/src/main/resources/org/wikimedia/search/highlighter/checkstyle.xml
@@ -0,0 +1,15 @@
+<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
+        "http://www.puppycrawl.com/dtds/configuration_1_3.dtd";>
+<module name="Checker">
+    <module name="TreeWalker">
+        <module name="WhitespaceAround">
+            <property name="allowEmptyConstructors" value="true"/>
+            <property name="allowEmptyMethods" value="true"/>
+            <property name="allowEmptyTypes" value="true"/>
+            <property name="allowEmptyLoops" value="true"/>
+            <property name="allowEmptyLambdas" value="true"/>
+            <property name="tokens" value="ASSIGN, BAND, BAND_ASSIGN, BOR, 
BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, 
DO_WHILE, EQUAL, GE, GT, LAMBDA, LAND, LCURLY, LE, LITERAL_CATCH, LITERAL_DO, 
LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, 
LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, LOR, LT, 
MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, 
RCURLY, SL, SLIST, SL_ASSIGN, SR, SR_ASSIGN, STAR_ASSIGN, LITERAL_ASSERT, 
TYPE_EXTENSION_AND"/>
+        </module>
+
+    </module>
+</module>
\ No newline at end of file
diff --git a/experimental-highlighter-core/pom.xml 
b/experimental-highlighter-core/pom.xml
index edfb9fa..beb108c 100644
--- a/experimental-highlighter-core/pom.xml
+++ b/experimental-highlighter-core/pom.xml
@@ -35,6 +35,10 @@
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-javadoc-plugin</artifactId>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-checkstyle-plugin</artifactId>
+      </plugin>
     </plugins>
   </build>
 </project>
diff --git 
a/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/hit/ConcatHitEnum.java
 
b/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/hit/ConcatHitEnum.java
index 7e0fbfd..9160122 100644
--- 
a/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/hit/ConcatHitEnum.java
+++ 
b/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/hit/ConcatHitEnum.java
@@ -86,7 +86,7 @@
     @Override
     public void toGraph(GraphvizHitEnumGenerator generator) {
         super.toGraph(generator);
-        if(current != null) {
+        if (current != null) {
             generator.addChild(this, current.delegate());
         }
     }
diff --git 
a/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/hit/MergingHitEnum.java
 
b/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/hit/MergingHitEnum.java
index 91c3685..f29ce65 100644
--- 
a/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/hit/MergingHitEnum.java
+++ 
b/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/hit/MergingHitEnum.java
@@ -81,7 +81,7 @@
         generator.addNode(this, params);
         Iterator<HitEnum> ite = queue.iterator();
         // Prints only 5 children
-        for(int i =0; i < 5 && ite.hasNext(); i++) {
+        for (int i = 0; i < 5 && ite.hasNext(); i++) {
             generator.addChild(this, ite.next());
         }
     }
diff --git 
a/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/hit/OverlapMergingHitEnumWrapper.java
 
b/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/hit/OverlapMergingHitEnumWrapper.java
index c2c92bf..40dddbc 100644
--- 
a/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/hit/OverlapMergingHitEnumWrapper.java
+++ 
b/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/hit/OverlapMergingHitEnumWrapper.java
@@ -107,7 +107,7 @@
     @Override
     public void toGraph(GraphvizHitEnumGenerator generator) {
         super.toGraph(generator);
-        if(delegate != null) {
+        if (delegate != null) {
             generator.addChild(this, delegate);
         }
     }
diff --git 
a/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/snippet/CharScanningSegmenter.java
 
b/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/snippet/CharScanningSegmenter.java
index 3f0e543..f38c2d3 100644
--- 
a/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/snippet/CharScanningSegmenter.java
+++ 
b/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/snippet/CharScanningSegmenter.java
@@ -129,7 +129,7 @@
             // is on a boundary, we really can't accept that boundary because
             // shifting forward past it (which we do below) would put us past
             // maxStartOffset. So we make sure we start before 
maxStartOffset-1.
-            int scanStart = Math.min(maxStartOffset -1, expandedStartOffset);
+            int scanStart = Math.min(maxStartOffset - 1, expandedStartOffset);
             int found = findBreakBefore(scanStart, scanEnd);
             if (found >= 0) {
                 // +1 shifts us after the break
diff --git 
a/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/source/NonMergingMultiSourceExtracter.java
 
b/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/source/NonMergingMultiSourceExtracter.java
index fe5ecc6..0ffa121 100644
--- 
a/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/source/NonMergingMultiSourceExtracter.java
+++ 
b/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/source/NonMergingMultiSourceExtracter.java
@@ -34,7 +34,7 @@
     /**
      * Builder for {@linkplain StringMergingMultiSourceExtracter}s.
      */
-    public static class Builder<T> implements 
AbstractMultiSourceExtracter.Builder<T, Builder<T>>{
+    public static class Builder<T> implements 
AbstractMultiSourceExtracter.Builder<T, Builder<T>> {
         private final List<ConstituentExtracter<T>> extracters = new 
ArrayList<ConstituentExtracter<T>>();
         private final int offsetGap;
 
diff --git 
a/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/source/StringMergingMultiSourceExtracter.java
 
b/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/source/StringMergingMultiSourceExtracter.java
index cfebe49..2453f09 100644
--- 
a/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/source/StringMergingMultiSourceExtracter.java
+++ 
b/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/source/StringMergingMultiSourceExtracter.java
@@ -29,7 +29,7 @@
     /**
      * Builder for {@linkplain StringMergingMultiSourceExtracter}s.
      */
-    public static class Builder implements 
AbstractMultiSourceExtracter.Builder<String, Builder>{
+    public static class Builder implements 
AbstractMultiSourceExtracter.Builder<String, Builder> {
         private final List<ConstituentExtracter<String>> extracters = new 
ArrayList<ConstituentExtracter<String>>();
         private final String separator;
 
diff --git 
a/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/tools/GraphvizHitEnumGenerator.java
 
b/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/tools/GraphvizHitEnumGenerator.java
index d641721..e97c523 100644
--- 
a/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/tools/GraphvizHitEnumGenerator.java
+++ 
b/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/tools/GraphvizHitEnumGenerator.java
@@ -71,8 +71,8 @@
 
         appendKeyValue("source", hitEnum.source());
 
-        if(!params.isEmpty()) {
-            for(Map.Entry<String, Object> en : params.entrySet()) {
+        if (!params.isEmpty()) {
+            for (Map.Entry<String, Object> en : params.entrySet()) {
                 appendKeyValue(en.getKey(), en.getValue());
             }
         }
@@ -82,7 +82,7 @@
 
     private int getHitEnumId(HitEnum hitEnum) {
         Integer id = hitEnumIds.get(hitEnum);
-        if(id == null) {
+        if (id == null) {
             id = hitEnumIdSequence++;
             hitEnumIds.put(hitEnum, id);
         }
@@ -90,7 +90,7 @@
     }
 
     private void writeLinks() {
-        for(Link link : links) {
+        for (Link link : links) {
             graph.append(" ").append(link.from).append(" -> 
").append(link.to).append("\n");
         }
     }
diff --git 
a/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/tools/GraphvizSnippetFormatter.java
 
b/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/tools/GraphvizSnippetFormatter.java
index b108ab6..88d7af1 100644
--- 
a/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/tools/GraphvizSnippetFormatter.java
+++ 
b/experimental-highlighter-core/src/main/java/org/wikimedia/search/highlighter/experimental/tools/GraphvizSnippetFormatter.java
@@ -25,8 +25,8 @@
     public String format(Snippet snippet) {
         StringBuilder b = new StringBuilder();
         for (Hit hit : snippet.hits()) {
-            if(!(hit instanceof GraphvizHit)) {
-                throw new IllegalArgumentException("GraphvizSnippetFormatter 
accepts only "+GraphvizHit.class+" but " + hit.getClass() + " was provided");
+            if (!(hit instanceof GraphvizHit)) {
+                throw new IllegalArgumentException("GraphvizSnippetFormatter 
accepts only " + GraphvizHit.class + " but " + hit.getClass() + " was 
provided");
             }
             GraphvizHit hitGraph = (GraphvizHit) hit;
 
diff --git a/experimental-highlighter-elasticsearch-plugin/pom.xml 
b/experimental-highlighter-elasticsearch-plugin/pom.xml
index 82ef6ed..c6f4a33 100644
--- a/experimental-highlighter-elasticsearch-plugin/pom.xml
+++ b/experimental-highlighter-elasticsearch-plugin/pom.xml
@@ -125,6 +125,10 @@
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-javadoc-plugin</artifactId>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-checkstyle-plugin</artifactId>
+      </plugin>
     </plugins>
   </build>
 </project>
diff --git 
a/experimental-highlighter-elasticsearch-plugin/src/main/java/org/wikimedia/highlighter/experimental/elasticsearch/OffsetSnippetFormatter.java
 
b/experimental-highlighter-elasticsearch-plugin/src/main/java/org/wikimedia/highlighter/experimental/elasticsearch/OffsetSnippetFormatter.java
index e4251e0..7a2b486 100644
--- 
a/experimental-highlighter-elasticsearch-plugin/src/main/java/org/wikimedia/highlighter/experimental/elasticsearch/OffsetSnippetFormatter.java
+++ 
b/experimental-highlighter-elasticsearch-plugin/src/main/java/org/wikimedia/highlighter/experimental/elasticsearch/OffsetSnippetFormatter.java
@@ -15,7 +15,7 @@
         if (itr.hasNext()) {
             Hit hit = itr.next();
             b.append(hit.startOffset()).append('-').append(hit.endOffset());
-            while(itr.hasNext()){
+            while (itr.hasNext()) {
                 hit = itr.next();
                 
b.append(',').append(hit.startOffset()).append('-').append(hit.endOffset());
             }
diff --git a/experimental-highlighter-lucene/pom.xml 
b/experimental-highlighter-lucene/pom.xml
index d2d409a..7b70021 100644
--- a/experimental-highlighter-lucene/pom.xml
+++ b/experimental-highlighter-lucene/pom.xml
@@ -89,6 +89,10 @@
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-javadoc-plugin</artifactId>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-checkstyle-plugin</artifactId>
+      </plugin>
     </plugins>
   </build>
 </project>
diff --git 
a/experimental-highlighter-lucene/src/main/java/org/wikimedia/highlighter/experimental/lucene/QueryFlattener.java
 
b/experimental-highlighter-lucene/src/main/java/org/wikimedia/highlighter/experimental/lucene/QueryFlattener.java
index 8d28b97..ce7608c 100644
--- 
a/experimental-highlighter-lucene/src/main/java/org/wikimedia/highlighter/experimental/lucene/QueryFlattener.java
+++ 
b/experimental-highlighter-lucene/src/main/java/org/wikimedia/highlighter/experimental/lucene/QueryFlattener.java
@@ -444,7 +444,7 @@
         }
 
         final Query lowFrequency;
-        if(first.getOccur() == Occur.MUST) {
+        if (first.getOccur() == Occur.MUST) {
             lowFrequency = first.getQuery();
         } else {
             lowFrequency = second.getQuery();
diff --git 
a/experimental-highlighter-lucene/src/main/java/org/wikimedia/highlighter/experimental/lucene/hit/PostingsHitEnum.java
 
b/experimental-highlighter-lucene/src/main/java/org/wikimedia/highlighter/experimental/lucene/hit/PostingsHitEnum.java
index d304724..94ce8a3 100644
--- 
a/experimental-highlighter-lucene/src/main/java/org/wikimedia/highlighter/experimental/lucene/hit/PostingsHitEnum.java
+++ 
b/experimental-highlighter-lucene/src/main/java/org/wikimedia/highlighter/experimental/lucene/hit/PostingsHitEnum.java
@@ -87,7 +87,7 @@
             enums.add(e);
             dp = null;
         }
-        switch (enums.size()){
+        switch (enums.size()) {
         case 0:
             return EmptyHitEnum.INSTANCE;
         case 1:
diff --git a/pom.xml b/pom.xml
index 3c56d49..95862c7 100644
--- a/pom.xml
+++ b/pom.xml
@@ -14,6 +14,7 @@
   <packaging>pom</packaging>
 
   <modules>
+    <module>experimental-highlighter-build-tools</module>
     <module>experimental-highlighter-core</module>
     <module>experimental-highlighter-lucene</module>
     <module>experimental-highlighter-elasticsearch-plugin</module>
@@ -79,6 +80,35 @@
       <plugins>
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-checkstyle-plugin</artifactId>
+          <version>2.17</version>
+          <configuration>
+            
<configLocation>org/wikimedia/search/highlighter/checkstyle.xml</configLocation>
+          </configuration>
+          <dependencies>
+            <dependency>
+              <groupId>org.wikimedia.search.highlighter</groupId>
+              <artifactId>experimental-highlighter-build-tools</artifactId>
+              <version>${project.version}</version>
+            </dependency>
+            <dependency>
+              <groupId>com.puppycrawl.tools</groupId>
+              <artifactId>checkstyle</artifactId>
+              <version>7.3</version>
+            </dependency>
+          </dependencies>
+          <executions>
+            <execution>
+              <id>checkstyle-check</id>
+              <goals>
+                <goal>check</goal>
+              </goals>
+              <phase>verify</phase>
+            </execution>
+          </executions>
+        </plugin>
+        <plugin>
+          <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-compiler-plugin</artifactId>
           <version>3.3</version>
         </plugin>

-- 
To view, visit https://gerrit.wikimedia.org/r/328695
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: I8122738c49c2dfae3d5e6b22a448610a8cf7c91e
Gerrit-PatchSet: 1
Gerrit-Project: search/highlighter
Gerrit-Branch: master
Gerrit-Owner: Gehel <[email protected]>
Gerrit-Reviewer: DCausse <[email protected]>
Gerrit-Reviewer: jenkins-bot <>

_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

Reply via email to