Merge remote-tracking branch 'remotes/upstream/master' into 920

yegor256 · Jan 24, 2019 · 6ef7fc0 · 6ef7fc0
2 parents 4d24f32 + 359299c
commit 6ef7fc0
Show file tree

Hide file tree

Showing 215 changed files with 658 additions and 214 deletions.
diff --git a/.rultor.yml b/.rultor.yml
@@ -3,9 +3,8 @@ architect:
 - yegor256
 - davvd
 install:
-- sudo gem install --no-ri --no-rdoc pdd
-- sudo gem install --no-ri --no-rdoc est
-- sudo gem install --no-ri --no-rdoc xcop
+- sudo gem install --no-document pdd
+- sudo gem install --no-document est
 assets:
   secring.gpg: zerocracy/home#assets/secring.gpg
   settings.xml: zerocracy/home#assets/qulice/settings.xml

diff --git a/.travis.yml b/.travis.yml
@@ -11,9 +11,8 @@ env:
 install:
   - set -e
   - travis_retry sudo apt-get install -y --fix-missing libmagic1 libmagic-dev
-  - gem install --no-ri --no-rdoc pdd
-  - gem install --no-ri --no-rdoc est
-  - gem install --no-ri --no-rdoc xcop
+  - gem install --no-document pdd
+  - gem install --no-document est
   - mvn install -DskipTests -Dinvoker.skip
   - mvn clean
   - set +e

diff --git a/INSTALL.txt b/INSTALL.txt
@@ -1,4 +1,4 @@
-Copyright (c) 2011-2018, Qulice.com
+Copyright (c) 2011-2019, Qulice.com
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

diff --git a/LICENSE.txt b/LICENSE.txt
@@ -1,4 +1,4 @@
-Copyright (c) 2011-2018, Qulice.com
+Copyright (c) 2011-2019, Qulice.com
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

diff --git a/pom.xml b/pom.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <!--
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-ant/LICENSE.txt b/qulice-ant/LICENSE.txt
@@ -1,4 +1,4 @@
-Copyright (c) 2011-2018, Qulice.com
+Copyright (c) 2011-2019, Qulice.com
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

diff --git a/qulice-ant/pom.xml b/qulice-ant/pom.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <!--
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-ant/src/it/findbugs-violations/LICENSE.txt b/qulice-ant/src/it/findbugs-violations/LICENSE.txt
@@ -1,4 +1,4 @@
-Copyright (c) 2011-2018, Qulice.com
+Copyright (c) 2011-2019, Qulice.com
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

diff --git a/qulice-ant/src/it/findbugs-violations/pom.xml b/qulice-ant/src/it/findbugs-violations/pom.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <!--
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-ant/src/it/findbugs-violations/src/main/java/com/qulice/foo/Main.java b/qulice-ant/src/it/findbugs-violations/src/main/java/com/qulice/foo/Main.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-ant/src/it/findbugs-violations/src/main/java/com/qulice/foo/package-info.java b/qulice-ant/src/it/findbugs-violations/src/main/java/com/qulice/foo/package-info.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-ant/src/it/settings.xml b/qulice-ant/src/it/settings.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <!--
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-ant/src/main/java/com/qulice/ant/AntEnvironment.java b/qulice-ant/src/main/java/com/qulice/ant/AntEnvironment.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-ant/src/main/java/com/qulice/ant/QuliceTask.java b/qulice-ant/src/main/java/com/qulice/ant/QuliceTask.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-ant/src/main/java/com/qulice/ant/package-info.java b/qulice-ant/src/main/java/com/qulice/ant/package-info.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-ant/src/site/apt/index.apt.vm b/qulice-ant/src/site/apt/index.apt.vm
@@ -7,7 +7,7 @@
  ------
 
 ~~
-~~ Copyright (c) 2011-2018, Qulice.com
+~~ Copyright (c) 2011-2019, Qulice.com
 ~~ All rights reserved.
 ~~
 ~~ Redistribution and use in source and binary forms, with or without

diff --git a/qulice-ant/src/site/site.xml b/qulice-ant/src/site/site.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <!--
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-ant/src/test/java/com/qulice/ant/AntEnvironmentTest.java b/qulice-ant/src/test/java/com/qulice/ant/AntEnvironmentTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-ant/src/test/java/com/qulice/ant/package-info.java b/qulice-ant/src/test/java/com/qulice/ant/package-info.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-checkstyle/LICENSE.txt b/qulice-checkstyle/LICENSE.txt
@@ -1,4 +1,4 @@
-Copyright (c) 2011-2018, Qulice.com
+Copyright (c) 2011-2019, Qulice.com
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

diff --git a/qulice-checkstyle/pom.xml b/qulice-checkstyle/pom.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <!--
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -115,7 +115,6 @@
     <profiles>
         <profile>
             <id>qulice</id>
-            <!-- @todo #123:30min Dummy todo to test if it works -->
             <build>
                 <plugins>
                     <plugin>

diff --git a/qulice-checkstyle/src/main/java/com/qulice/checkstyle/BracketsStructureCheck.java b/qulice-checkstyle/src/main/java/com/qulice/checkstyle/BracketsStructureCheck.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-checkstyle/src/main/java/com/qulice/checkstyle/CascadeIndentationCheck.java b/qulice-checkstyle/src/main/java/com/qulice/checkstyle/CascadeIndentationCheck.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-checkstyle/src/main/java/com/qulice/checkstyle/CheckstyleListener.java b/qulice-checkstyle/src/main/java/com/qulice/checkstyle/CheckstyleListener.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-checkstyle/src/main/java/com/qulice/checkstyle/CheckstyleValidator.java b/qulice-checkstyle/src/main/java/com/qulice/checkstyle/CheckstyleValidator.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-checkstyle/src/main/java/com/qulice/checkstyle/ConditionalRegexpMultilineCheck.java b/qulice-checkstyle/src/main/java/com/qulice/checkstyle/ConditionalRegexpMultilineCheck.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-checkstyle/src/main/java/com/qulice/checkstyle/ConstantUsageCheck.java b/qulice-checkstyle/src/main/java/com/qulice/checkstyle/ConstantUsageCheck.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-checkstyle/src/main/java/com/qulice/checkstyle/CurlyBracketsStructureCheck.java b/qulice-checkstyle/src/main/java/com/qulice/checkstyle/CurlyBracketsStructureCheck.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-checkstyle/src/main/java/com/qulice/checkstyle/DiamondOperatorCheck.java b/qulice-checkstyle/src/main/java/com/qulice/checkstyle/DiamondOperatorCheck.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-checkstyle/src/main/java/com/qulice/checkstyle/EmptyLinesCheck.java b/qulice-checkstyle/src/main/java/com/qulice/checkstyle/EmptyLinesCheck.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/...checkstyle/src/main/java/com/qulice/checkstyle/FinalSemicolonInTryWithResourcesCheck.java b/...checkstyle/src/main/java/com/qulice/checkstyle/FinalSemicolonInTryWithResourcesCheck.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-checkstyle/src/main/java/com/qulice/checkstyle/ImportCohesionCheck.java b/qulice-checkstyle/src/main/java/com/qulice/checkstyle/ImportCohesionCheck.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-checkstyle/src/main/java/com/qulice/checkstyle/JavadocEmptyLineCheck.java b/qulice-checkstyle/src/main/java/com/qulice/checkstyle/JavadocEmptyLineCheck.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-checkstyle/src/main/java/com/qulice/checkstyle/JavadocLocationCheck.java b/qulice-checkstyle/src/main/java/com/qulice/checkstyle/JavadocLocationCheck.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-checkstyle/src/main/java/com/qulice/checkstyle/JavadocParameterOrderCheck.java b/qulice-checkstyle/src/main/java/com/qulice/checkstyle/JavadocParameterOrderCheck.java
@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) 2011-2019, Qulice.com
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met: 1) Redistributions of source code must retain the above
+ * copyright notice, this list of conditions and the following
+ * disclaimer. 2) Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided
+ * with the distribution. 3) Neither the name of the Qulice.com nor
+ * the names of its contributors may be used to endorse or promote
+ * products derived from this software without specific prior written
+ * permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
+ * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
+ * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+ * OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package com.qulice.checkstyle;
+
+import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
+
+/**
+ * Checks method parameters order to comply with what is defined in method
+ * javadoc.
+ *
+ * @since 0.18.10
+ * @todo #847:30min Enforce right parameter order in javadoc. Checkstyle must
+ *  check if parameter order in javadoc is the same as is in the method
+ *  signature. Implement this check and add its tests to checks.xml under
+ *  custom checks.
+ */
+public final class JavadocParameterOrderCheck extends AbstractCheck {
+    @Override
+    public int[] getDefaultTokens() {
+        throw new UnsupportedOperationException(
+            "getDefaultTokens() not implemented"
+        );
+    }
+
+    @Override
+    public int[] getAcceptableTokens() {
+        throw new UnsupportedOperationException(
+            "getAcceptableTokens() not implemented"
+        );
+    }
+
+    @Override
+    public int[] getRequiredTokens() {
+        throw new UnsupportedOperationException(
+            "getRequiredTokens() not implemented"
+        );
+    }
+}
diff --git a/qulice-checkstyle/src/main/java/com/qulice/checkstyle/JavadocTagsCheck.java b/qulice-checkstyle/src/main/java/com/qulice/checkstyle/JavadocTagsCheck.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -63,6 +63,10 @@
  *
  * @see <a href="http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html">Keywords substitution in Subversion</a>
  * @since 0.3
+ * @todo #743:30min Nested classes should have since tag. Implement check to
+ *  validate if nested classes javadoc have a valid since tag. After the
+ *  implementation add JavadocTagsCheck to checks.xml and ChecksTest (removed
+ *  because now the test fails).
  */
 public final class JavadocTagsCheck extends AbstractCheck {
 

diff --git a/qulice-checkstyle/src/main/java/com/qulice/checkstyle/LineRange.java b/qulice-checkstyle/src/main/java/com/qulice/checkstyle/LineRange.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-checkstyle/src/main/java/com/qulice/checkstyle/LineRanges.java b/qulice-checkstyle/src/main/java/com/qulice/checkstyle/LineRanges.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-checkstyle/src/main/java/com/qulice/checkstyle/MethodBodyCommentsCheck.java b/qulice-checkstyle/src/main/java/com/qulice/checkstyle/MethodBodyCommentsCheck.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-checkstyle/src/main/java/com/qulice/checkstyle/MethodsOrderCheck.java b/qulice-checkstyle/src/main/java/com/qulice/checkstyle/MethodsOrderCheck.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-checkstyle/src/main/java/com/qulice/checkstyle/MultilineJavadocTagsCheck.java b/qulice-checkstyle/src/main/java/com/qulice/checkstyle/MultilineJavadocTagsCheck.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/...ce-checkstyle/src/main/java/com/qulice/checkstyle/NoJavadocForOverriddenMethodsCheck.java b/...ce-checkstyle/src/main/java/com/qulice/checkstyle/NoJavadocForOverriddenMethodsCheck.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/qulice-checkstyle/src/main/java/com/qulice/checkstyle/NonStaticMethodCheck.java b/qulice-checkstyle/src/main/java/com/qulice/checkstyle/NonStaticMethodCheck.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2018, Qulice.com
+ * Copyright (c) 2011-2019, Qulice.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without