Repository: commons-rng Updated Branches: refs/heads/master 775b3d553 -> 77bc452db
Removal of "commons-rng-build-tools" module. Purpose was to avoid duplicate configuration files. The same effect is now achieved by having them in the top-level directory, and defining a property in each module's directory. Project: http://git-wip-us.apache.org/repos/asf/commons-rng/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-rng/commit/77bc452d Tree: http://git-wip-us.apache.org/repos/asf/commons-rng/tree/77bc452d Diff: http://git-wip-us.apache.org/repos/asf/commons-rng/diff/77bc452d Branch: refs/heads/master Commit: 77bc452dbf5731092833ba1141b82cc16b19230e Parents: 775b3d5 Author: Gilles <er...@apache.org> Authored: Tue Nov 22 02:29:59 2016 +0100 Committer: Gilles <er...@apache.org> Committed: Tue Nov 22 02:29:59 2016 +0100 ---------------------------------------------------------------------- commons-rng-build-tools/pom.xml | 61 ------ .../main/resources/checkstyle/checkstyle.xml | 202 ------------------- .../resources/checkstyle/license-header.txt | 16 -- .../src/main/resources/clirr/clirr-ignored.xml | 21 -- .../findbugs/findbugs-exclude-filter.xml | 27 --- .../src/main/resources/pmd/pmd-ruleset.xml | 57 ------ commons-rng-client-api/pom.xml | 2 + commons-rng-core/pom.xml | 2 + commons-rng-examples/pom.xml | 2 + commons-rng-jmh/pom.xml | 2 + commons-rng-sampling/pom.xml | 2 + commons-rng-simple/pom.xml | 2 + pom.xml | 52 +---- src/main/resources/checkstyle/checkstyle.xml | 202 +++++++++++++++++++ .../resources/checkstyle/license-header.txt | 16 ++ src/main/resources/checkstyle/suppressions.xml | 9 + src/main/resources/clirr/clirr-ignored.xml | 21 ++ .../findbugs/findbugs-exclude-filter.xml | 27 +++ src/main/resources/pmd/pmd-ruleset.xml | 57 ++++++ 19 files changed, 353 insertions(+), 427 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-rng/blob/77bc452d/commons-rng-build-tools/pom.xml ---------------------------------------------------------------------- diff --git a/commons-rng-build-tools/pom.xml b/commons-rng-build-tools/pom.xml deleted file mode 100644 index 8681f6a..0000000 --- a/commons-rng-build-tools/pom.xml +++ /dev/null @@ -1,61 +0,0 @@ -<?xml version="1.0"?> -<!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"; - xmlns="http://maven.apache.org/POM/4.0.0"; - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";> - <modelVersion>4.0.0</modelVersion> - <groupId>org.apache.commons</groupId> - <artifactId>commons-rng-build-tools</artifactId> - <version>1.0-SNAPSHOT</version> - <name>Build Tools</name> - <url>http://maven.apache.org</url> - - <inceptionYear>2016</inceptionYear> - <description>The Apache Commons RNG maven building scripts configuration resources.</description> - - <scm> - <connection>scm:git:http://git-wip-us.apache.org/repos/asf/commons-rng.git</connection> - <developerConnection>scm:git:https://git-wip-us.apache.org/repos/asf/commons-rng.git</developerConnection> - <url>https://git-wip-us.apache.org/repos/asf?p=commons-rng.git</url> - </scm> - - <distributionManagement> - <site> - <id>apache.website</id> - <name>Apache Commons Site</name> - <url>scm:svn:https://svn.apache.org/repos/infra/websites/production/commons/content/proper/commons-rng/</url> - </site> - </distributionManagement> - - <build> - <plugins> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-deploy-plugin</artifactId> - <configuration> - <!-- - This module is not part of the library (used only for building). - Hence it must not be deployed. - --> - <skip>true</skip> - </configuration> - </plugin> - </plugins> - </build> - -</project> http://git-wip-us.apache.org/repos/asf/commons-rng/blob/77bc452d/commons-rng-build-tools/src/main/resources/checkstyle/checkstyle.xml ---------------------------------------------------------------------- diff --git a/commons-rng-build-tools/src/main/resources/checkstyle/checkstyle.xml b/commons-rng-build-tools/src/main/resources/checkstyle/checkstyle.xml deleted file mode 100644 index a138af6..0000000 --- a/commons-rng-build-tools/src/main/resources/checkstyle/checkstyle.xml +++ /dev/null @@ -1,202 +0,0 @@ -<?xml version="1.0"?> - -<!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - --> - -<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.1//EN" "http://www.puppycrawl.com/dtds/configuration_1_1.dtd";> - -<!-- Commons RNG customization of default Checkstyle behavior --> -<module name="Checker"> - <property name="localeLanguage" value="en"/> - - <module name="TreeWalker"> - - <!-- Operator must be at end of wrapped line --> - <module name="OperatorWrap"> - <property name="option" value="eol"/> - </module> - - <!-- No if/else/do/for/while without braces --> - <module name="NeedBraces"/> - - <!-- Interfaces must be types (not just constants) --> - <module name="InterfaceIsType"/> - - <!-- Must have class / interface header comments --> - <module name="JavadocType"/> - - <!-- Require method javadocs, allow undeclared RTE --> - <module name="JavadocMethod"> - <property name="allowUndeclaredRTE" value="true"/> - <property name="allowThrowsTagsForSubclasses" value="true"/> - <property name="validateThrows" value="false"/> - </module> - - <!-- Require field javadoc --> - <module name="JavadocVariable"/> - - <!-- No public fields --> - <module name="VisibilityModifier"> - <property name="protectedAllowed" value="true"/> - </module> - - <!-- Require hash code override when equals is --> - <module name="EqualsHashCode"/> - - <!-- Disallow unnecessary instantiation of Boolean, String --> - <module name="IllegalInstantiation"> - <property name="classes" value="java.lang.Boolean, java.lang.String"/> - </module> - - <!-- Required for SuppressionCommentFilter below --> - <module name="FileContentsHolder"/> - - <!-- Import should be explicit, really needed and only from pure java packages --> - <module name="AvoidStarImport" /> - <module name="UnusedImports" /> - <module name="IllegalImport" /> - - <!-- Utility class should not be instantiated, they must have a private constructor --> - <module name="HideUtilityClassConstructor" /> - - <!-- Switch statements should be complete and with independent cases --> - <module name="FallThrough" /> - <module name="MissingSwitchDefault" /> - - <!-- Constant names should obey the traditional all uppercase naming convention --> - <module name="ConstantName" /> - - <!-- Method parameters and local variables should not hide fields, except in constructors and setters --> - <module name="HiddenField"> - <property name="ignoreConstructorParameter" value="true" /> - <property name="ignoreSetter" value="true" /> - </module> - - <!-- No trailing whitespace --> - <module name="Regexp"> - <property name="format" value="[ \t]+$"/> - <property name="illegalPattern" value="true"/> - <property name="message" value="Trailing whitespace"/> - </module> - - <!-- No System.out.println() statements --> - <module name="Regexp"> - <!-- no sysouts --> - <property name="format" value="System\.out\.println"/> - <property name="illegalPattern" value="true"/> - </module> - - <!-- Authors should be in pom.xml file --> - <module name="Regexp"> - <property name="format" value="@author"/> - <property name="illegalPattern" value="true"/> - <property name="message" value="developers names should be in pom file"/> - </module> - - <!-- Use a consistent way to put modifiers --> - <module name="RedundantModifier" /> - <module name="ModifierOrder" /> - - <!-- Use a consistent way to put declarations --> - <module name="DeclarationOrder" /> - - <!-- Don't add up parentheses when they are not required --> - <module name="UnnecessaryParentheses" /> - - <!-- Don't use too widespread catch (Exception, Throwable, RuntimeException) --> - <module name="IllegalCatch" /> - - <!-- Don't use = or != for string comparisons --> - <module name="StringLiteralEquality" /> - - <!-- Don't declare multiple variables in the same statement --> - <module name="MultipleVariableDeclarations" /> - - <!-- String literals more than one character long should not be repeated several times --> - <!-- the "unchecked" string is also accepted to allow @SuppressWarnings("unchecked") --> - <module name="MultipleStringLiterals" > - <property name="ignoreStringsRegexp" value='^(("")|(".")|("unchecked"))$'/> - </module> - - <!-- Check if @Override tags are present --> - <module name="MissingOverride" /> - - <!-- <module name="TodoComment" /> --> - - </module> - - <!-- Verify that EVERY source file has the appropriate license --> - <module name="Header"> - <property name="headerFile" value="${checkstyle.header.file}"/> - </module> - - <!-- No tabs allowed! --> - <module name="FileTabCharacter"/> - - <!-- Require files to end with newline characters --> - <module name="NewlineAtEndOfFile"/> - - <!-- Require package javadoc --> - <module name="JavadocPackage"/> - - <!-- Setup special comments to suppress specific checks from source files --> - <module name="SuppressionCommentFilter"> - <property name="offCommentFormat" value="CHECKSTYLE\: stop JavadocVariable"/> - <property name="onCommentFormat" value="CHECKSTYLE\: resume JavadocVariable"/> - <property name="checkFormat" value="JavadocVariable"/> - </module> - <module name="SuppressionCommentFilter"> - <property name="offCommentFormat" value="CHECKSTYLE\: stop JavadocMethodCheck"/> - <property name="onCommentFormat" value="CHECKSTYLE\: resume JavadocMethodCheck"/> - <property name="checkFormat" value="JavadocMethodCheck"/> - </module> - <module name="SuppressionCommentFilter"> - <property name="offCommentFormat" value="CHECKSTYLE\: stop ConstantName"/> - <property name="onCommentFormat" value="CHECKSTYLE\: resume ConstantName"/> - <property name="checkFormat" value="ConstantName"/> - </module> - <module name="SuppressionCommentFilter"> - <property name="offCommentFormat" value="CHECKSTYLE\: stop HideUtilityClassConstructor"/> - <property name="onCommentFormat" value="CHECKSTYLE\: resume HideUtilityClassConstructor"/> - <property name="checkFormat" value="HideUtilityClassConstructor"/> - </module> - <module name="SuppressionCommentFilter"> - <property name="offCommentFormat" value="CHECKSTYLE\: stop MultipleVariableDeclarations"/> - <property name="onCommentFormat" value="CHECKSTYLE\: resume MultipleVariableDeclarations"/> - <property name="checkFormat" value="MultipleVariableDeclarations"/> - </module> - <module name="SuppressionCommentFilter"> - <property name="offCommentFormat" value="CHECKSTYLE\: stop IllegalCatch"/> - <property name="onCommentFormat" value="CHECKSTYLE\: resume IllegalCatch"/> - <property name="checkFormat" value="IllegalCatch"/> - </module> - <module name="SuppressionCommentFilter"> - <property name="offCommentFormat" value="CHECKSTYLE\: stop DeclarationOrder"/> - <property name="onCommentFormat" value="CHECKSTYLE\: resume DeclarationOrder"/> - <property name="checkFormat" value="DeclarationOrder"/> - </module> - <module name="SuppressionCommentFilter"> - <property name="offCommentFormat" value="CHECKSTYLE\: stop RedundantModifier"/> - <property name="onCommentFormat" value="CHECKSTYLE\: resume RedundantModifier"/> - <property name="checkFormat" value="RedundantModifier"/> - </module> - <module name="SuppressionCommentFilter"> - <property name="offCommentFormat" value="CHECKSTYLE\: stop all"/> - <property name="onCommentFormat" value="CHECKSTYLE\: resume all"/> - </module> -</module> - http://git-wip-us.apache.org/repos/asf/commons-rng/blob/77bc452d/commons-rng-build-tools/src/main/resources/checkstyle/license-header.txt ---------------------------------------------------------------------- diff --git a/commons-rng-build-tools/src/main/resources/checkstyle/license-header.txt b/commons-rng-build-tools/src/main/resources/checkstyle/license-header.txt deleted file mode 100644 index ae6f28c..0000000 --- a/commons-rng-build-tools/src/main/resources/checkstyle/license-header.txt +++ /dev/null @@ -1,16 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ http://git-wip-us.apache.org/repos/asf/commons-rng/blob/77bc452d/commons-rng-build-tools/src/main/resources/clirr/clirr-ignored.xml ---------------------------------------------------------------------- diff --git a/commons-rng-build-tools/src/main/resources/clirr/clirr-ignored.xml b/commons-rng-build-tools/src/main/resources/clirr/clirr-ignored.xml deleted file mode 100644 index ed97259..0000000 --- a/commons-rng-build-tools/src/main/resources/clirr/clirr-ignored.xml +++ /dev/null @@ -1,21 +0,0 @@ -<?xml version="1.0"?> -<!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> - -<differences> - -</differences> http://git-wip-us.apache.org/repos/asf/commons-rng/blob/77bc452d/commons-rng-build-tools/src/main/resources/findbugs/findbugs-exclude-filter.xml ---------------------------------------------------------------------- diff --git a/commons-rng-build-tools/src/main/resources/findbugs/findbugs-exclude-filter.xml b/commons-rng-build-tools/src/main/resources/findbugs/findbugs-exclude-filter.xml deleted file mode 100644 index 99b2e8a..0000000 --- a/commons-rng-build-tools/src/main/resources/findbugs/findbugs-exclude-filter.xml +++ /dev/null @@ -1,27 +0,0 @@ -<?xml version="1.0"?> -<!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> - -<!-- - This file contains some false positive bugs detected by findbugs. Their - false positive nature has been analyzed individually and they have been - put here to instruct findbugs it must ignore them. ---> -<FindBugsFilter> - - -</FindBugsFilter> http://git-wip-us.apache.org/repos/asf/commons-rng/blob/77bc452d/commons-rng-build-tools/src/main/resources/pmd/pmd-ruleset.xml ---------------------------------------------------------------------- diff --git a/commons-rng-build-tools/src/main/resources/pmd/pmd-ruleset.xml b/commons-rng-build-tools/src/main/resources/pmd/pmd-ruleset.xml deleted file mode 100644 index c637ef7..0000000 --- a/commons-rng-build-tools/src/main/resources/pmd/pmd-ruleset.xml +++ /dev/null @@ -1,57 +0,0 @@ -<?xml version="1.0"?> -<!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<ruleset name="commons-rng-customized" - xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"; - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; - xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd";> - <description> - This ruleset checks the code for discouraged programming constructs. - </description> - - <rule ref="rulesets/java/basic.xml"/> - - <rule ref="rulesets/java/braces.xml"/> - - <rule ref="rulesets/java/comments.xml"> - <exclude name="CommentSize"/> - </rule> - <rule ref="rulesets/java/comments.xml/CommentSize"> - <properties> - <property name="maxLines" value="200"/> - <property name="maxLineLength" value="256"/> - </properties> - </rule> - - <rule ref="rulesets/java/empty.xml"/> - - <rule ref="rulesets/java/finalizers.xml"/> - - <rule ref="rulesets/java/imports.xml"/> - - <rule ref="rulesets/java/typeresolution.xml"/> - - <rule ref="rulesets/java/clone.xml"/> - - <rule ref="rulesets/java/unnecessary.xml"> - <!-- We do use extra parentheses there as most people do not recall operator precedence, - this means even if the parentheses are useless for the compiler, we don't consider - them useless for the developer. This is the reason why we disable this rule. --> - <exclude name="UselessParentheses"/> - </rule> - -</ruleset> http://git-wip-us.apache.org/repos/asf/commons-rng/blob/77bc452d/commons-rng-client-api/pom.xml ---------------------------------------------------------------------- diff --git a/commons-rng-client-api/pom.xml b/commons-rng-client-api/pom.xml index ace4617..36bec23 100644 --- a/commons-rng-client-api/pom.xml +++ b/commons-rng-client-api/pom.xml @@ -39,6 +39,8 @@ <commons.osgi.symbolicName>org.apache.commons.rng</commons.osgi.symbolicName> <!-- OSGi --> <commons.osgi.export>org.apache.commons.rng</commons.osgi.export> + <!-- Workaround to avoid duplicating config files. --> + <rng.parent.dir>${basedir}/..</rng.parent.dir> </properties> </project> http://git-wip-us.apache.org/repos/asf/commons-rng/blob/77bc452d/commons-rng-core/pom.xml ---------------------------------------------------------------------- diff --git a/commons-rng-core/pom.xml b/commons-rng-core/pom.xml index ee83d11..af384ea 100644 --- a/commons-rng-core/pom.xml +++ b/commons-rng-core/pom.xml @@ -39,6 +39,8 @@ <commons.osgi.symbolicName>org.apache.commons.rng.core</commons.osgi.symbolicName> <!-- OSGi --> <commons.osgi.export>org.apache.commons.rng.core</commons.osgi.export> + <!-- Workaround to avoid duplicating config files. --> + <rng.parent.dir>${basedir}/..</rng.parent.dir> </properties> <dependencies> http://git-wip-us.apache.org/repos/asf/commons-rng/blob/77bc452d/commons-rng-examples/pom.xml ---------------------------------------------------------------------- diff --git a/commons-rng-examples/pom.xml b/commons-rng-examples/pom.xml index e7d40c4..cb8b29f 100644 --- a/commons-rng-examples/pom.xml +++ b/commons-rng-examples/pom.xml @@ -43,6 +43,8 @@ <commons.osgi.symbolicName>org.apache.commons.rng.examples</commons.osgi.symbolicName> <!-- OSGi --> <commons.osgi.export>org.apache.commons.rng.examples</commons.osgi.export> + <!-- Workaround to avoid duplicating config files. --> + <rng.parent.dir>${basedir}/..</rng.parent.dir> </properties> <dependencies> http://git-wip-us.apache.org/repos/asf/commons-rng/blob/77bc452d/commons-rng-jmh/pom.xml ---------------------------------------------------------------------- diff --git a/commons-rng-jmh/pom.xml b/commons-rng-jmh/pom.xml index 89c40eb..7a2727d 100644 --- a/commons-rng-jmh/pom.xml +++ b/commons-rng-jmh/pom.xml @@ -59,6 +59,8 @@ <commons.osgi.symbolicName>org.apache.commons.rng.jmh</commons.osgi.symbolicName> <!-- OSGi --> <commons.osgi.export>org.apache.commons.rng.jmh</commons.osgi.export> + <!-- Workaround to avoid duplicating config files. --> + <rng.parent.dir>${basedir}/..</rng.parent.dir> <!-- JMH Benchmark related properties, version, target compiler and name of the benchmarking uber jar. --> <jmh.version>1.13</jmh.version> http://git-wip-us.apache.org/repos/asf/commons-rng/blob/77bc452d/commons-rng-sampling/pom.xml ---------------------------------------------------------------------- diff --git a/commons-rng-sampling/pom.xml b/commons-rng-sampling/pom.xml index 5b55f7a..fa747cb 100644 --- a/commons-rng-sampling/pom.xml +++ b/commons-rng-sampling/pom.xml @@ -39,6 +39,8 @@ <commons.osgi.symbolicName>org.apache.commons.rng.sampling</commons.osgi.symbolicName> <!-- OSGi --> <commons.osgi.export>org.apache.commons.rng.sampling</commons.osgi.export> + <!-- Workaround to avoid duplicating config files. --> + <rng.parent.dir>${basedir}/..</rng.parent.dir> </properties> <dependencies> http://git-wip-us.apache.org/repos/asf/commons-rng/blob/77bc452d/commons-rng-simple/pom.xml ---------------------------------------------------------------------- diff --git a/commons-rng-simple/pom.xml b/commons-rng-simple/pom.xml index db952e6..5fd8175 100644 --- a/commons-rng-simple/pom.xml +++ b/commons-rng-simple/pom.xml @@ -40,6 +40,8 @@ <!-- OSGi --> <commons.osgi.export>org.apache.commons.rng.simple</commons.osgi.export> <commons.osgi.private>org.apache.commons.rng.simple.internal</commons.osgi.private> + <!-- Workaround to avoid duplicating config files. --> + <rng.parent.dir>${basedir}/..</rng.parent.dir> </properties> <dependencies> http://git-wip-us.apache.org/repos/asf/commons-rng/blob/77bc452d/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index 0c93d8d..b9d8ce9 100644 --- a/pom.xml +++ b/pom.xml @@ -101,6 +101,8 @@ <rng.findbugs.version>3.0.2</rng.findbugs.version> <rng.checkstyle.version>2.17</rng.checkstyle.version> <rng.clirr.version>2.7</rng.clirr.version> + <!-- Workaround to avoid duplicating config files. --> + <rng.parent.dir>${basedir}</rng.parent.dir> <!-- Temporary fix to support Java 8 --> <commons.jacoco.version>0.7.5.201505241946</commons.jacoco.version> @@ -176,13 +178,6 @@ </goals> </execution> </executions> - <dependencies> - <dependency> - <groupId>org.apache.commons</groupId> - <artifactId>commons-rng-build-tools</artifactId> - <version>1.0-SNAPSHOT</version> - </dependency> - </dependencies> </plugin> <plugin> <artifactId>maven-pmd-plugin</artifactId> @@ -194,13 +189,6 @@ <ruleset>pmd/pmd-ruleset.xml</ruleset> </rulesets> </configuration> - <dependencies> - <dependency> - <groupId>org.apache.commons</groupId> - <artifactId>commons-rng-build-tools</artifactId> - <version>1.0-SNAPSHOT</version> - </dependency> - </dependencies> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> @@ -238,25 +226,11 @@ <groupId>org.codehaus.mojo</groupId> <artifactId>clirr-maven-plugin</artifactId> <version>${rng.clirr.version}</version> - <dependencies> - <dependency> - <groupId>org.apache.commons</groupId> - <artifactId>commons-rng-build-tools</artifactId> - <version>1.0-SNAPSHOT</version> - </dependency> - </dependencies> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>findbugs-maven-plugin</artifactId> <version>${rng.findbugs.version}</version> - <dependencies> - <dependency> - <groupId>org.apache.commons</groupId> - <artifactId>commons-rng-build-tools</artifactId> - <version>1.0-SNAPSHOT</version> - </dependency> - </dependencies> </plugin> </plugins> @@ -268,19 +242,12 @@ <version>${rng.checkstyle.version}</version> <configuration> <includeTestSourceDirectory>false</includeTestSourceDirectory> - <configLocation>checkstyle/checkstyle.xml</configLocation> - <headerLocation>checkstyle/license-header.txt</headerLocation> + <configLocation>${rng.parent.dir}/src/main/resources/checkstyle/checkstyle.xml</configLocation> + <headerLocation>${rng.parent.dir}/src/main/resources/checkstyle/license-header.txt</headerLocation> <logViolationsToConsole>false</logViolationsToConsole> <failOnViolation>false</failOnViolation> <resourceExcludes>NOTICE.txt,LICENSE.txt</resourceExcludes> </configuration> - <dependencies> - <dependency> - <groupId>org.apache.commons</groupId> - <artifactId>commons-rng-build-tools</artifactId> - <version>1.0-SNAPSHOT</version> - </dependency> - </dependencies> </plugin> </plugins> </pluginManagement> @@ -344,7 +311,7 @@ <configuration> <threshold>Normal</threshold> <effort>Default</effort> - <excludeFilterFile>findbugs/findbugs-exclude-filter.xml</excludeFilterFile> + <excludeFilterFile>${rng.parent.dir}/src/main/resources/findbugs/findbugs-exclude-filter.xml</excludeFilterFile> </configuration> </plugin> <plugin> @@ -352,10 +319,10 @@ <artifactId>maven-checkstyle-plugin</artifactId> <version>${rng.checkstyle.version}</version> <configuration> - <configLocation>checkstyle/checkstyle.xml</configLocation> + <configLocation>${rng.parent.dir}/src/main/resources/checkstyle/checkstyle.xml</configLocation> + <headerLocation>${rng.parent.dir}/src/main/resources/checkstyle/license-header.txt</headerLocation> <enableRulesSummary>false</enableRulesSummary> <includeResources>false</includeResources> - <headerLocation>checkstyle/license-header.txt</headerLocation> </configuration> <reportSets> <reportSet> @@ -371,7 +338,7 @@ <version>${rng.clirr.version}</version> <configuration> <minSeverity>${minSeverity}</minSeverity> - <ignoredDifferencesFile>clirr/clirr-ignored.xml</ignoredDifferencesFile> + <ignoredDifferencesFile>${rng.parent.dir}/src/main/resources/clirr/clirr-ignored.xml</ignoredDifferencesFile> </configuration> </plugin> <plugin> @@ -381,7 +348,7 @@ <targetJdk>${maven.compiler.target}</targetJdk> <skipEmptyReport>false</skipEmptyReport> <rulesets> - <ruleset>pmd/pmd-ruleset.xml</ruleset> + <ruleset>${rng.parent.dir}/src/main/resources/pmd/pmd-ruleset.xml</ruleset> </rulesets> </configuration> <reportSets> @@ -590,7 +557,6 @@ </profiles> <modules> - <module>commons-rng-build-tools</module> <module>commons-rng-client-api</module> <module>commons-rng-core</module> <module>commons-rng-simple</module> http://git-wip-us.apache.org/repos/asf/commons-rng/blob/77bc452d/src/main/resources/checkstyle/checkstyle.xml ---------------------------------------------------------------------- diff --git a/src/main/resources/checkstyle/checkstyle.xml b/src/main/resources/checkstyle/checkstyle.xml new file mode 100644 index 0000000..a138af6 --- /dev/null +++ b/src/main/resources/checkstyle/checkstyle.xml @@ -0,0 +1,202 @@ +<?xml version="1.0"?> + +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + --> + +<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.1//EN" "http://www.puppycrawl.com/dtds/configuration_1_1.dtd";> + +<!-- Commons RNG customization of default Checkstyle behavior --> +<module name="Checker"> + <property name="localeLanguage" value="en"/> + + <module name="TreeWalker"> + + <!-- Operator must be at end of wrapped line --> + <module name="OperatorWrap"> + <property name="option" value="eol"/> + </module> + + <!-- No if/else/do/for/while without braces --> + <module name="NeedBraces"/> + + <!-- Interfaces must be types (not just constants) --> + <module name="InterfaceIsType"/> + + <!-- Must have class / interface header comments --> + <module name="JavadocType"/> + + <!-- Require method javadocs, allow undeclared RTE --> + <module name="JavadocMethod"> + <property name="allowUndeclaredRTE" value="true"/> + <property name="allowThrowsTagsForSubclasses" value="true"/> + <property name="validateThrows" value="false"/> + </module> + + <!-- Require field javadoc --> + <module name="JavadocVariable"/> + + <!-- No public fields --> + <module name="VisibilityModifier"> + <property name="protectedAllowed" value="true"/> + </module> + + <!-- Require hash code override when equals is --> + <module name="EqualsHashCode"/> + + <!-- Disallow unnecessary instantiation of Boolean, String --> + <module name="IllegalInstantiation"> + <property name="classes" value="java.lang.Boolean, java.lang.String"/> + </module> + + <!-- Required for SuppressionCommentFilter below --> + <module name="FileContentsHolder"/> + + <!-- Import should be explicit, really needed and only from pure java packages --> + <module name="AvoidStarImport" /> + <module name="UnusedImports" /> + <module name="IllegalImport" /> + + <!-- Utility class should not be instantiated, they must have a private constructor --> + <module name="HideUtilityClassConstructor" /> + + <!-- Switch statements should be complete and with independent cases --> + <module name="FallThrough" /> + <module name="MissingSwitchDefault" /> + + <!-- Constant names should obey the traditional all uppercase naming convention --> + <module name="ConstantName" /> + + <!-- Method parameters and local variables should not hide fields, except in constructors and setters --> + <module name="HiddenField"> + <property name="ignoreConstructorParameter" value="true" /> + <property name="ignoreSetter" value="true" /> + </module> + + <!-- No trailing whitespace --> + <module name="Regexp"> + <property name="format" value="[ \t]+$"/> + <property name="illegalPattern" value="true"/> + <property name="message" value="Trailing whitespace"/> + </module> + + <!-- No System.out.println() statements --> + <module name="Regexp"> + <!-- no sysouts --> + <property name="format" value="System\.out\.println"/> + <property name="illegalPattern" value="true"/> + </module> + + <!-- Authors should be in pom.xml file --> + <module name="Regexp"> + <property name="format" value="@author"/> + <property name="illegalPattern" value="true"/> + <property name="message" value="developers names should be in pom file"/> + </module> + + <!-- Use a consistent way to put modifiers --> + <module name="RedundantModifier" /> + <module name="ModifierOrder" /> + + <!-- Use a consistent way to put declarations --> + <module name="DeclarationOrder" /> + + <!-- Don't add up parentheses when they are not required --> + <module name="UnnecessaryParentheses" /> + + <!-- Don't use too widespread catch (Exception, Throwable, RuntimeException) --> + <module name="IllegalCatch" /> + + <!-- Don't use = or != for string comparisons --> + <module name="StringLiteralEquality" /> + + <!-- Don't declare multiple variables in the same statement --> + <module name="MultipleVariableDeclarations" /> + + <!-- String literals more than one character long should not be repeated several times --> + <!-- the "unchecked" string is also accepted to allow @SuppressWarnings("unchecked") --> + <module name="MultipleStringLiterals" > + <property name="ignoreStringsRegexp" value='^(("")|(".")|("unchecked"))$'/> + </module> + + <!-- Check if @Override tags are present --> + <module name="MissingOverride" /> + + <!-- <module name="TodoComment" /> --> + + </module> + + <!-- Verify that EVERY source file has the appropriate license --> + <module name="Header"> + <property name="headerFile" value="${checkstyle.header.file}"/> + </module> + + <!-- No tabs allowed! --> + <module name="FileTabCharacter"/> + + <!-- Require files to end with newline characters --> + <module name="NewlineAtEndOfFile"/> + + <!-- Require package javadoc --> + <module name="JavadocPackage"/> + + <!-- Setup special comments to suppress specific checks from source files --> + <module name="SuppressionCommentFilter"> + <property name="offCommentFormat" value="CHECKSTYLE\: stop JavadocVariable"/> + <property name="onCommentFormat" value="CHECKSTYLE\: resume JavadocVariable"/> + <property name="checkFormat" value="JavadocVariable"/> + </module> + <module name="SuppressionCommentFilter"> + <property name="offCommentFormat" value="CHECKSTYLE\: stop JavadocMethodCheck"/> + <property name="onCommentFormat" value="CHECKSTYLE\: resume JavadocMethodCheck"/> + <property name="checkFormat" value="JavadocMethodCheck"/> + </module> + <module name="SuppressionCommentFilter"> + <property name="offCommentFormat" value="CHECKSTYLE\: stop ConstantName"/> + <property name="onCommentFormat" value="CHECKSTYLE\: resume ConstantName"/> + <property name="checkFormat" value="ConstantName"/> + </module> + <module name="SuppressionCommentFilter"> + <property name="offCommentFormat" value="CHECKSTYLE\: stop HideUtilityClassConstructor"/> + <property name="onCommentFormat" value="CHECKSTYLE\: resume HideUtilityClassConstructor"/> + <property name="checkFormat" value="HideUtilityClassConstructor"/> + </module> + <module name="SuppressionCommentFilter"> + <property name="offCommentFormat" value="CHECKSTYLE\: stop MultipleVariableDeclarations"/> + <property name="onCommentFormat" value="CHECKSTYLE\: resume MultipleVariableDeclarations"/> + <property name="checkFormat" value="MultipleVariableDeclarations"/> + </module> + <module name="SuppressionCommentFilter"> + <property name="offCommentFormat" value="CHECKSTYLE\: stop IllegalCatch"/> + <property name="onCommentFormat" value="CHECKSTYLE\: resume IllegalCatch"/> + <property name="checkFormat" value="IllegalCatch"/> + </module> + <module name="SuppressionCommentFilter"> + <property name="offCommentFormat" value="CHECKSTYLE\: stop DeclarationOrder"/> + <property name="onCommentFormat" value="CHECKSTYLE\: resume DeclarationOrder"/> + <property name="checkFormat" value="DeclarationOrder"/> + </module> + <module name="SuppressionCommentFilter"> + <property name="offCommentFormat" value="CHECKSTYLE\: stop RedundantModifier"/> + <property name="onCommentFormat" value="CHECKSTYLE\: resume RedundantModifier"/> + <property name="checkFormat" value="RedundantModifier"/> + </module> + <module name="SuppressionCommentFilter"> + <property name="offCommentFormat" value="CHECKSTYLE\: stop all"/> + <property name="onCommentFormat" value="CHECKSTYLE\: resume all"/> + </module> +</module> + http://git-wip-us.apache.org/repos/asf/commons-rng/blob/77bc452d/src/main/resources/checkstyle/license-header.txt ---------------------------------------------------------------------- diff --git a/src/main/resources/checkstyle/license-header.txt b/src/main/resources/checkstyle/license-header.txt new file mode 100644 index 0000000..ae6f28c --- /dev/null +++ b/src/main/resources/checkstyle/license-header.txt @@ -0,0 +1,16 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ http://git-wip-us.apache.org/repos/asf/commons-rng/blob/77bc452d/src/main/resources/checkstyle/suppressions.xml ---------------------------------------------------------------------- diff --git a/src/main/resources/checkstyle/suppressions.xml b/src/main/resources/checkstyle/suppressions.xml new file mode 100644 index 0000000..5aedcef --- /dev/null +++ b/src/main/resources/checkstyle/suppressions.xml @@ -0,0 +1,9 @@ +<?xml version="1.0"?> + +<!DOCTYPE suppressions PUBLIC +"-//Puppy Crawl//DTD Suppressions 1.1//EN" +"http://www.puppycrawl.com/dtds/suppressions_1_1.dtd";> + +<suppressions> + <suppress files="[/\\]target[/\\]" checks=".*"/> +</suppressions> http://git-wip-us.apache.org/repos/asf/commons-rng/blob/77bc452d/src/main/resources/clirr/clirr-ignored.xml ---------------------------------------------------------------------- diff --git a/src/main/resources/clirr/clirr-ignored.xml b/src/main/resources/clirr/clirr-ignored.xml new file mode 100644 index 0000000..ed97259 --- /dev/null +++ b/src/main/resources/clirr/clirr-ignored.xml @@ -0,0 +1,21 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<differences> + +</differences> http://git-wip-us.apache.org/repos/asf/commons-rng/blob/77bc452d/src/main/resources/findbugs/findbugs-exclude-filter.xml ---------------------------------------------------------------------- diff --git a/src/main/resources/findbugs/findbugs-exclude-filter.xml b/src/main/resources/findbugs/findbugs-exclude-filter.xml new file mode 100644 index 0000000..99b2e8a --- /dev/null +++ b/src/main/resources/findbugs/findbugs-exclude-filter.xml @@ -0,0 +1,27 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<!-- + This file contains some false positive bugs detected by findbugs. Their + false positive nature has been analyzed individually and they have been + put here to instruct findbugs it must ignore them. +--> +<FindBugsFilter> + + +</FindBugsFilter> http://git-wip-us.apache.org/repos/asf/commons-rng/blob/77bc452d/src/main/resources/pmd/pmd-ruleset.xml ---------------------------------------------------------------------- diff --git a/src/main/resources/pmd/pmd-ruleset.xml b/src/main/resources/pmd/pmd-ruleset.xml new file mode 100644 index 0000000..c637ef7 --- /dev/null +++ b/src/main/resources/pmd/pmd-ruleset.xml @@ -0,0 +1,57 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<ruleset name="commons-rng-customized" + xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd";> + <description> + This ruleset checks the code for discouraged programming constructs. + </description> + + <rule ref="rulesets/java/basic.xml"/> + + <rule ref="rulesets/java/braces.xml"/> + + <rule ref="rulesets/java/comments.xml"> + <exclude name="CommentSize"/> + </rule> + <rule ref="rulesets/java/comments.xml/CommentSize"> + <properties> + <property name="maxLines" value="200"/> + <property name="maxLineLength" value="256"/> + </properties> + </rule> + + <rule ref="rulesets/java/empty.xml"/> + + <rule ref="rulesets/java/finalizers.xml"/> + + <rule ref="rulesets/java/imports.xml"/> + + <rule ref="rulesets/java/typeresolution.xml"/> + + <rule ref="rulesets/java/clone.xml"/> + + <rule ref="rulesets/java/unnecessary.xml"> + <!-- We do use extra parentheses there as most people do not recall operator precedence, + this means even if the parentheses are useless for the compiler, we don't consider + them useless for the developer. This is the reason why we disable this rule. --> + <exclude name="UselessParentheses"/> + </rule> + +</ruleset>
