Merge pull request #46 from robert-bor/feature/badges-and-quality

Dev tooling enabled

.travis.yml

@@ -0,0 +1,6 @@
+language: java
+install: mvn install -DskipTests=true -Dgpg.skip=true
+jdk:
+  - oraclejdk8
+after_success:
+  - bash <(curl -s https://codecov.io/bash)

README.md

@@ -1,6 +1,12 @@
 Aho-Corasick
 ============
 
+[![Build Status](https://travis-ci.org/robert-bor/aho-corasick.svg?branch=master)](https://travis-ci.org/robert-bor/aho-corasick)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/0f65bfb641f745a4b301b85d028a4a8d)](https://www.codacy.com/app/bor-robert/aho-corasick)
+[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.ahocorasick/ahocorasick/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.ahocorasick/ahocorasick)
+[![Javadoc](https://javadoc-emblem.rhcloud.com/doc/org.ahocorasick/ahocorasick/badge.svg)](http://www.javadoc.io/doc/org.ahocorasick/ahocorasick)
+[![Apache 2](http://img.shields.io/badge/license-Apache%202-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)
+
 Dependency
 ----------
 Include this dependency in your POM. Be sure to check for the latest version in Maven Central.

pom.xml

@@ -10,11 +10,16 @@
     <inceptionYear>2014</inceptionYear>
     <url>http://ahocorasick.org</url>
 
-    <parent>
+    <distributionManagement>
-        <groupId>org.sonatype.oss</groupId>
+        <snapshotRepository>
-        <artifactId>oss-parent</artifactId>
+            <id>ossrh</id>
-        <version>7</version>
+            <url>https://oss.sonatype.org/content/repositories/snapshots</url>
-    </parent>
+        </snapshotRepository>
+        <repository>
+            <id>ossrh</id>
+            <url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
+        </repository>
+    </distributionManagement>
 
     <organization>
         <name>42 BV</name>
@@ -39,9 +44,15 @@
             <name>Robert Bor</name>
             <organization>42</organization>
         </developer>
+        <developer>
+            <name></name>
+        </developer>
     </developers>
 
     <properties>
+        <java.version>1.7</java.version>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+
         <junit.version>4.10</junit.version>
         <!-- Reporting -->
         <maven.cobertura.version>2.5.2</maven.cobertura.version>
@@ -63,15 +74,19 @@
     </dependencies>
 
     <build>
-
         <defaultGoal>install</defaultGoal>
-
         <plugins>
 
             <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
+                <groupId>org.sonatype.plugins</groupId>
-                <artifactId>maven-jar-plugin</artifactId>
+                <artifactId>nexus-staging-maven-plugin</artifactId>
-                <version>2.4</version>
+                <version>1.6.7</version>
+                <extensions>true</extensions>
+                <configuration>
+                    <serverId>ossrh</serverId>
+                    <nexusUrl>https://oss.sonatype.org/</nexusUrl>
+                    <autoReleaseAfterClose>false</autoReleaseAfterClose>
+                </configuration>
             </plugin>
 
             <plugin>
@@ -79,30 +94,76 @@
                 <artifactId>maven-compiler-plugin</artifactId>
                 <version>3.6.0</version>
                 <configuration>
-                    <source>1.7</source>
+                    <source>${java.version}</source>
-                    <target>1.7</target>
+                    <target>${java.version}</target>
+                    <encoding>${project.build.sourceEncoding}</encoding>
                 </configuration>
             </plugin>
 
-        </plugins>
-    </build>
-
-    <reporting>
-        <plugins>
-
-            <plugin>
-                <groupId>org.codehaus.mojo</groupId>
-                <artifactId>cobertura-maven-plugin</artifactId>
-                <version>${maven.cobertura.version}</version>
-            </plugin>
-
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
-                <version>${maven.javadoc.version}</version>
+                <version>2.9.1</version>
+                <executions>
+                    <execution>
+                        <id>attach-javadocs</id>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-source-plugin</artifactId>
+                <version>2.2.1</version>
+                <executions>
+                    <execution>
+                        <id>attach-sources</id>
+                        <goals>
+                            <goal>jar-no-fork</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-gpg-plugin</artifactId>
+                <version>1.5</version>
+                <executions>
+                    <execution>
+                        <id>sign-artifacts</id>
+                        <phase>verify</phase>
+                        <goals>
+                            <goal>sign</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+
+            <plugin>
+                <groupId>org.jacoco</groupId>
+                <artifactId>jacoco-maven-plugin</artifactId>
+                <version>0.7.7.201606060606</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>prepare-agent</goal>
+                        </goals>
+                    </execution>
+                    <execution>
+                        <id>report</id>
+                        <phase>test</phase>
+                        <goals>
+                            <goal>report</goal>
+                        </goals>
+                    </execution>
+                </executions>
             </plugin>
 
         </plugins>
-    </reporting>
+    </build>
 
 </project>

src/main/java/org/ahocorasick/interval/Intervalable.java

@@ -3,7 +3,9 @@ package org.ahocorasick.interval;
 public interface Intervalable extends Comparable {
 
     public int getStart();
+
     public int getEnd();
+
     public int size();
 
 }

src/main/java/org/ahocorasick/trie/State.java

@@ -6,7 +6,7 @@ import java.util.*;
  * <p>
  * A state has various important tasks it must attend to:
  * </p>
- *
+ * <p>
  * <ul>
  * <li>success; when a character points to another state, it must return that state</li>
  * <li>failure; when a character has no matching state, the algorithm must be able to fall back on a
@@ -14,7 +14,7 @@ import java.util.*;
  * <li>emits; when this state is passed and keywords have been matched, the matches must be
  * 'emitted' so that they can be used later on.</li>
  * </ul>
- *
+ * <p>
  * <p>
  * The root state is special in the sense that it has no failure state; it cannot fail. If it 'fails'
  * it will still parse the next character and start from the root node. This ensures that the algorithm
@@ -25,10 +25,14 @@ import java.util.*;
  */
 public class State {
 
-    /** effective the size of the keyword */
+    /**
+     * effective the size of the keyword
+     */
     private final int depth;
 
-    /** only used for the root state to refer to itself in case no matches have been found */
+    /**
+     * only used for the root state to refer to itself in case no matches have been found
+     */
     private final State rootState;
 
     /**
@@ -37,10 +41,14 @@ public class State {
      */
     private final Map<Character, State> success = new HashMap<>();
 
-    /** if no matching states are found, the failure state will be returned */
+    /**
+     * if no matching states are found, the failure state will be returned
+     */
     private State failure;
 
-    /** whenever this state is reached, it will emit the matches keywords for future reference */
+    /**
+     * whenever this state is reached, it will emit the matches keywords for future reference
+     */
     private Set<String> emits;
 
     public State() {

src/main/java/org/ahocorasick/trie/Trie.java

@@ -1,11 +1,13 @@
 package org.ahocorasick.trie;
 
 import static java.lang.Character.isWhitespace;
+
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
 import java.util.Queue;
 import java.util.concurrent.LinkedBlockingDeque;
+
 import org.ahocorasick.interval.IntervalTree;
 import org.ahocorasick.interval.Intervalable;
 import org.ahocorasick.trie.handler.DefaultEmitHandler;
@@ -32,7 +34,6 @@ public class Trie {
      * Used by the builder to add a text search keyword.
      *
      * @param keyword The search term to add to the list of search terms.
-     * 
      * @throws NullPointerException if the keyword is null.
      */
     private void addKeyword(String keyword) {
@@ -307,13 +308,13 @@ public class Trie {
         /**
          * Default (empty) constructor.
          */
-        private TrieBuilder() {}
+        private TrieBuilder() {
+        }
 
         /**
          * Adds a keyword to the Trie's list of text search keywords.
          *
          * @param keyword The keyword to add to the list.
-         * 
          * @return This builder.
          * @throws NullPointerException if the keyword is null.
          */
@@ -326,7 +327,6 @@ public class Trie {
          * Adds a list of keywords to the Trie's list of text search keywords.
          *
          * @param keywords The keywords to add to the list.
-         * 
          * @return This builder.
          */
         public TrieBuilder addKeywords(final String... keywords) {
@@ -338,7 +338,6 @@ public class Trie {
          * Adds a list of keywords to the Trie's list of text search keywords.
          *
          * @param keywords The keywords to add to the list.
-         * 
          * @return This builder.
          */
         public TrieBuilder addKeywords(final Collection<String> keywords) {
@@ -411,18 +410,16 @@ public class Trie {
         }
 
         /**
-         * @deprecated Use ignoreCase()
-         * 
          * @return This builder.
+         * @deprecated Use ignoreCase()
          */
         public TrieBuilder caseInsensitive() {
             return ignoreCase();
         }
 
         /**
-         * @deprecated Use ignoreOverlaps()
-         * 
          * @return This builder.
+         * @deprecated Use ignoreOverlaps()
          */
         public TrieBuilder removeOverlaps() {
             return ignoreOverlaps();

src/main/java/org/ahocorasick/trie/TrieConfig.java

@@ -12,9 +12,13 @@ public class TrieConfig {
 
     private boolean stopOnHit = false;
 
-    public boolean isStopOnHit() { return stopOnHit; }
+    public boolean isStopOnHit() {
+        return stopOnHit;
+    }
 
-    public void setStopOnHit(boolean stopOnHit) { this.stopOnHit = stopOnHit; }
+    public void setStopOnHit(boolean stopOnHit) {
+        this.stopOnHit = stopOnHit;
+    }
 
     public boolean isAllowOverlaps() {
         return allowOverlaps;
@@ -32,7 +36,9 @@ public class TrieConfig {
         this.onlyWholeWords = onlyWholeWords;
     }
 
-    public boolean isOnlyWholeWordsWhiteSpaceSeparated() { return onlyWholeWordsWhiteSpaceSeparated; }
+    public boolean isOnlyWholeWordsWhiteSpaceSeparated() {
+        return onlyWholeWordsWhiteSpaceSeparated;
+    }
 
     public void setOnlyWholeWordsWhiteSpaceSeparated(boolean onlyWholeWordsWhiteSpaceSeparated) {
         this.onlyWholeWordsWhiteSpaceSeparated = onlyWholeWordsWhiteSpaceSeparated;

src/test/java/org/ahocorasick/trie/TrieTest.java

@@ -5,9 +5,13 @@ import java.util.Collection;
 import java.util.Iterator;
 import java.util.List;
 import java.util.concurrent.ThreadLocalRandom;
+
 import static junit.framework.Assert.assertEquals;
+
 import org.ahocorasick.trie.handler.EmitHandler;
+
 import static org.junit.Assert.assertTrue;
+
 import org.junit.Test;
 
 public class TrieTest {