Fully rename scijava-packages-plugin

gselzer · ctrueden · commit 9db68f3967bb · 2021-11-12T17:50:38.000-06:00
Since this library is a set of maven-enforcer-plugin rules, not a plugin
in and of itself, the name was bad. Thus we change the name to make it
clearer
diff --git a/README.md b/README.md
@@ -1,11 +1,11 @@
-[![](https://github.com/scijava/scijava-packages-plugin/actions/workflows/build-main.yml/badge.svg)](https://github.com/scijava/scijava-packages-plugin/actions/workflows/build-main.yml)
+[![](https://github.com/scijava/scijava-packages-rules/actions/workflows/build-main.yml/badge.svg)](https://github.com/scijava/scijava-packages-rules/actions/workflows/build-main.yml)
 
-[![](https://img.shields.io/maven-central/v/org.scijava/scijava-packages-plugin.svg)](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.scijava%22%20AND%20a%3A%22scijava-packages-plugin%22)
+[![](https://img.shields.io/maven-central/v/org.scijava/scijava-packages-rules.svg)](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.scijava%22%20AND%20a%3A%22scijava-packages-rules%22)
 
-SciJava Packages Plugin
+SciJava Packages Rules
 ====================
 
-scijava-packages-plugin provides a set of [Maven Enforcer Plugin](https://maven.apache.org/enforcer/maven-enforcer-plugin/) rules for policing the package hierarchy at build time.
+scijava-packages-rules provides a set of [Maven Enforcer Plugin](https://maven.apache.org/enforcer/maven-enforcer-plugin/) rules for policing the package hierarchy at build time.
 
 ## Usage
 
@@ -17,7 +17,7 @@ Currently, the only way to utilize these rules is by explicitly declaring it in
 	<dependencies>
 		<dependency>
 			<groupId>org.scijava</groupId>
-			<artifactId>scijava-packages-plugin</artifactId>
+			<artifactId>scijava-packages-rules</artifactId>
 			<version>0-SNAPSHOT</version>
 		</dependency>
 	</dependencies>
@@ -43,7 +43,7 @@ Rules
 	<configuration>
 		<rules>
 			<NoPackageCyclesRule
-				implementation="org.scijava.packages.plugin.NoPackageCyclesRule" />
+				implementation="org.scijava.packages.rules.NoPackageCyclesRule" />
 		</rules>
 	</configuration>
 </execution>
@@ -56,7 +56,7 @@ If you want to exclude tests from cycle checking, you can use the parameter `inc
 ```xml
         ...
         <rules>
-            <NoPackageCyclesRule implementation="org.scijava.packages.plugin.NoPackageCyclesRule">
+            <NoPackageCyclesRule implementation="org.scijava.packages.rules.NoPackageCyclesRule">
                 <includeTests>false</includeTests>
             </NoPackageCyclesRule>
         </rules>
@@ -73,7 +73,7 @@ If you want to exclude packages or restrict check to certain packages only, you
 ```xml
         ...
         <rules>
-            <NoPackageCyclesRule implementation="org.scijava.packages.plugin.NoPackageCyclesRule">
+            <NoPackageCyclesRule implementation="org.scijava.packages.rules.NoPackageCyclesRule">
                 <includedPackages>
                     <includedPackage>myapp.code.good</includedPackage>
                 </includedPackages>
@@ -108,7 +108,7 @@ Subpackage Dependence can throw a wrench into libraries wishing to follow the [D
 	<configuration>
 		<rules>
 			<NoSubpackageDependenceRule
-				implementation="org.scijava.packages.plugin.NoSubpackageDependenceRule" />
+				implementation="org.scijava.packages.rules.NoSubpackageDependenceRule" />
 		</rules>
 	</configuration>
 </execution>
diff --git a/src/main/java/org/scijava/packages/rules/AbstractPackageEnforcementRule.java b/src/main/java/org/scijava/packages/rules/AbstractPackageEnforcementRule.java
@@ -1,5 +1,5 @@
 
-package org.scijava.packages.plugin;
+package org.scijava.packages.rules;
 
 import java.io.File;
 import java.io.IOException;
diff --git a/src/main/java/org/scijava/packages/rules/CollectionOutput.java b/src/main/java/org/scijava/packages/rules/CollectionOutput.java
@@ -1,4 +1,4 @@
-package org.scijava.packages.plugin;
+package org.scijava.packages.rules;
 
 import java.util.Arrays;
 import java.util.Collection;
diff --git a/src/main/java/org/scijava/packages/rules/DirectoriesWithClasses.java b/src/main/java/org/scijava/packages/rules/DirectoriesWithClasses.java
@@ -1,4 +1,4 @@
-package org.scijava.packages.plugin;
+package org.scijava.packages.rules;
 
 import static java.util.Collections.unmodifiableList;
 
diff --git a/src/main/java/org/scijava/packages/rules/NoPackageCyclesRule.java b/src/main/java/org/scijava/packages/rules/NoPackageCyclesRule.java
@@ -1,5 +1,5 @@
 
-package org.scijava.packages.plugin;
+package org.scijava.packages.rules;
 
 import java.util.ArrayList;
 import java.util.Collection;
diff --git a/src/main/java/org/scijava/packages/rules/NoSubpackageDependenceRule.java b/src/main/java/org/scijava/packages/rules/NoSubpackageDependenceRule.java
@@ -1,5 +1,5 @@
 
-package org.scijava.packages.plugin;
+package org.scijava.packages.rules;
 
 import java.util.ArrayList;
 import java.util.Collection;
diff --git a/src/main/java/org/scijava/packages/rules/PackageCycleCollector.java b/src/main/java/org/scijava/packages/rules/PackageCycleCollector.java
@@ -1,4 +1,4 @@
-package org.scijava.packages.plugin;
+package org.scijava.packages.rules;
 
 import java.util.Iterator;
 import java.util.List;
diff --git a/src/main/java/org/scijava/packages/rules/PackageCycleOutput.java b/src/main/java/org/scijava/packages/rules/PackageCycleOutput.java
@@ -1,18 +1,18 @@
-package org.scijava.packages.plugin;
+package org.scijava.packages.rules;
 
-import static org.scijava.packages.plugin.CollectionOutput.joinCollection;
+import static org.scijava.packages.rules.CollectionOutput.joinCollection;
 
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.List;
 import java.util.Set;
 
-import org.scijava.packages.plugin.CollectionOutput.Appender;
-import org.scijava.packages.plugin.CollectionOutput.StringProvider;
-import org.scijava.packages.plugin.comparator.JavaClassNameComparator;
-import org.scijava.packages.plugin.comparator.JavaPackageListComparator;
-import org.scijava.packages.plugin.comparator.JavaPackageNameComparator;
+import org.scijava.packages.rules.CollectionOutput.Appender;
+import org.scijava.packages.rules.CollectionOutput.StringProvider;
+import org.scijava.packages.rules.comparator.JavaClassNameComparator;
+import org.scijava.packages.rules.comparator.JavaPackageListComparator;
+import org.scijava.packages.rules.comparator.JavaPackageNameComparator;
 
 import jdepend.framework.JavaClass;
 import jdepend.framework.JavaPackage;
diff --git a/src/main/java/org/scijava/packages/rules/SubpackageDependenceOutput.java b/src/main/java/org/scijava/packages/rules/SubpackageDependenceOutput.java
@@ -1,16 +1,16 @@
-package org.scijava.packages.plugin;
+package org.scijava.packages.rules;
 
-import static org.scijava.packages.plugin.CollectionOutput.joinCollection;
+import static org.scijava.packages.rules.CollectionOutput.joinCollection;
 
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 
-import org.scijava.packages.plugin.CollectionOutput.Appender;
-import org.scijava.packages.plugin.comparator.JavaClassNameComparator;
-import org.scijava.packages.plugin.comparator.JavaPackageNameComparator;
+import org.scijava.packages.rules.CollectionOutput.Appender;
+import org.scijava.packages.rules.comparator.JavaClassNameComparator;
+import org.scijava.packages.rules.comparator.JavaPackageNameComparator;
 
 import jdepend.framework.JavaClass;
 import jdepend.framework.JavaPackage;
diff --git a/src/main/java/org/scijava/packages/rules/comparator/JavaClassNameComparator.java b/src/main/java/org/scijava/packages/rules/comparator/JavaClassNameComparator.java
@@ -1,4 +1,4 @@
-package org.scijava.packages.plugin.comparator;
+package org.scijava.packages.rules.comparator;
 
 import java.util.Comparator;
 
diff --git a/src/main/java/org/scijava/packages/rules/comparator/JavaPackageListComparator.java b/src/main/java/org/scijava/packages/rules/comparator/JavaPackageListComparator.java
@@ -1,4 +1,4 @@
-package org.scijava.packages.plugin.comparator;
+package org.scijava.packages.rules.comparator;
 
 import java.util.Comparator;
 import java.util.List;
diff --git a/src/main/java/org/scijava/packages/rules/comparator/JavaPackageNameComparator.java b/src/main/java/org/scijava/packages/rules/comparator/JavaPackageNameComparator.java
@@ -1,4 +1,4 @@
-package org.scijava.packages.plugin.comparator;
+package org.scijava.packages.rules.comparator;
 
 import java.util.Comparator;
 
diff --git a/src/test/java/org/scijava/packages/rules/CollectionOutputTest.java b/src/test/java/org/scijava/packages/rules/CollectionOutputTest.java
@@ -1,18 +1,18 @@
-package org.scijava.packages.plugin;
+package org.scijava.packages.rules;
 
 import static java.util.Arrays.asList;
 import static java.util.Collections.singletonList;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.is;
-import static org.scijava.packages.plugin.CollectionOutput.joinArray;
-import static org.scijava.packages.plugin.CollectionOutput.joinCollection;
+import static org.scijava.packages.rules.CollectionOutput.joinArray;
+import static org.scijava.packages.rules.CollectionOutput.joinCollection;
 
 import java.util.Collections;
 
 import org.junit.Before;
 import org.junit.Test;
-import org.scijava.packages.plugin.CollectionOutput.Appender;
-import org.scijava.packages.plugin.CollectionOutput.StringProvider;
+import org.scijava.packages.rules.CollectionOutput.Appender;
+import org.scijava.packages.rules.CollectionOutput.StringProvider;
 
 public class CollectionOutputTest {
 	private final DummyAppender appender = new DummyAppender();
diff --git a/src/test/java/org/scijava/packages/rules/NoPackageCyclesRuleIntegrationTest.java b/src/test/java/org/scijava/packages/rules/NoPackageCyclesRuleIntegrationTest.java
@@ -1,4 +1,4 @@
-package org.scijava.packages.plugin;
+package org.scijava.packages.rules;
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.fail;
@@ -12,8 +12,8 @@
 import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
 import org.junit.Before;
 import org.junit.Test;
-import org.scijava.packages.plugin.NoPackageCyclesRule;
-import org.scijava.packages.plugin.mock.EnforcerRuleHelperMock;
+import org.scijava.packages.rules.NoPackageCyclesRule;
+import org.scijava.packages.rules.mock.EnforcerRuleHelperMock;
 
 public class NoPackageCyclesRuleIntegrationTest {
 	private static final URL FITNESSE_TARGET_FOLDER = getResource("fitnesse-target");
diff --git a/src/test/java/org/scijava/packages/rules/NoPackageCyclesRuleTest.java b/src/test/java/org/scijava/packages/rules/NoPackageCyclesRuleTest.java
@@ -1,4 +1,4 @@
-package org.scijava.packages.plugin;
+package org.scijava.packages.rules;
 
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.containsString;
@@ -17,9 +17,9 @@
 import org.junit.Test;
 import org.junit.rules.ExpectedException;
 import org.junit.rules.TemporaryFolder;
-import org.scijava.packages.plugin.NoPackageCyclesRule;
-import org.scijava.packages.plugin.mock.EnforcerRuleHelperMock;
-import org.scijava.packages.plugin.mock.JDependMock;
+import org.scijava.packages.rules.NoPackageCyclesRule;
+import org.scijava.packages.rules.mock.EnforcerRuleHelperMock;
+import org.scijava.packages.rules.mock.JDependMock;
 
 public class NoPackageCyclesRuleTest {
 
diff --git a/src/test/java/org/scijava/packages/rules/NoSubpackageDependenceRuleIntegrationTest.java b/src/test/java/org/scijava/packages/rules/NoSubpackageDependenceRuleIntegrationTest.java
@@ -1,4 +1,4 @@
-package org.scijava.packages.plugin;
+package org.scijava.packages.rules;
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.fail;
@@ -12,8 +12,9 @@
 import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
 import org.junit.Before;
 import org.junit.Test;
-import org.scijava.packages.plugin.NoPackageCyclesRule;
-import org.scijava.packages.plugin.mock.EnforcerRuleHelperMock;
+import org.scijava.packages.rules.NoPackageCyclesRule;
+import org.scijava.packages.rules.NoSubpackageDependenceRule;
+import org.scijava.packages.rules.mock.EnforcerRuleHelperMock;
 
 public class NoSubpackageDependenceRuleIntegrationTest {
 	private static final URL FITNESSE_TARGET_FOLDER = getResource("fitnesse-target");
diff --git a/src/test/java/org/scijava/packages/rules/PackageCycleCollectorPerformanceTest.java b/src/test/java/org/scijava/packages/rules/PackageCycleCollectorPerformanceTest.java
@@ -1,4 +1,4 @@
-package org.scijava.packages.plugin;
+package org.scijava.packages.rules;
 
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.empty;
@@ -14,7 +14,7 @@
 
 import org.junit.Before;
 import org.junit.Test;
-import org.scijava.packages.plugin.PackageCycleCollector;
+import org.scijava.packages.rules.PackageCycleCollector;
 
 public class PackageCycleCollectorPerformanceTest {
 	private static final int PACKAGE_MATRIX_SIZE = 20;
diff --git a/src/test/java/org/scijava/packages/rules/PackageCycleCollectorTest.java b/src/test/java/org/scijava/packages/rules/PackageCycleCollectorTest.java
@@ -1,4 +1,4 @@
-package org.scijava.packages.plugin;
+package org.scijava.packages.rules;
 
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.containsInAnyOrder;
@@ -13,7 +13,7 @@
 
 import org.junit.Before;
 import org.junit.Test;
-import org.scijava.packages.plugin.PackageCycleCollector;
+import org.scijava.packages.rules.PackageCycleCollector;
 
 public class PackageCycleCollectorTest {
 
diff --git a/src/test/java/org/scijava/packages/rules/PackageCycleOutputTest.java b/src/test/java/org/scijava/packages/rules/PackageCycleOutputTest.java
@@ -1,8 +1,8 @@
-package org.scijava.packages.plugin;
+package org.scijava.packages.rules;
 
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.is;
-import static org.scijava.packages.plugin.CollectionOutput.joinArray;
+import static org.scijava.packages.rules.CollectionOutput.joinArray;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -12,9 +12,9 @@
 
 import org.junit.Before;
 import org.junit.Test;
-import org.scijava.packages.plugin.CollectionOutput;
-import org.scijava.packages.plugin.PackageCycleOutput;
-import org.scijava.packages.plugin.CollectionOutput.StringProvider;
+import org.scijava.packages.rules.CollectionOutput;
+import org.scijava.packages.rules.PackageCycleOutput;
+import org.scijava.packages.rules.CollectionOutput.StringProvider;
 
 public class PackageCycleOutputTest {
 
diff --git a/src/test/java/org/scijava/packages/rules/mock/EnforcerRuleHelperMock.java b/src/test/java/org/scijava/packages/rules/mock/EnforcerRuleHelperMock.java
@@ -1,4 +1,4 @@
-package org.scijava.packages.plugin.mock;
+package org.scijava.packages.rules.mock;
 
 import java.io.File;
 import java.util.List;
@@ -9,7 +9,7 @@
 import org.codehaus.plexus.PlexusContainer;
 import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException;
 import org.codehaus.plexus.component.repository.exception.ComponentLookupException;
-import org.scijava.packages.plugin.DirectoriesWithClasses;
+import org.scijava.packages.rules.DirectoriesWithClasses;
 
 public class EnforcerRuleHelperMock implements EnforcerRuleHelper {
 
diff --git a/src/test/java/org/scijava/packages/rules/mock/JDependMock.java b/src/test/java/org/scijava/packages/rules/mock/JDependMock.java
@@ -1,4 +1,4 @@
-package org.scijava.packages.plugin.mock;
+package org.scijava.packages.rules.mock;
 
 import java.io.IOException;
 
diff --git a/src/test/java/org/scijava/packages/rules/mock/LogMock.java b/src/test/java/org/scijava/packages/rules/mock/LogMock.java
@@ -1,4 +1,4 @@
-package org.scijava.packages.plugin.mock;
+package org.scijava.packages.rules.mock;
 
 import java.util.ArrayList;
 import java.util.List;

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package org.scijava.packages.plugin;`
	`1`	`+package org.scijava.packages.rules;`
`2`	`2`
`3`	`3`	`import java.util.Arrays;`
`4`	`4`	`import java.util.Collection;`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package org.scijava.packages.plugin.comparator;`
	`1`	`+package org.scijava.packages.rules.comparator;`
`2`	`2`
`3`	`3`	`import java.util.Comparator;`
`4`	`4`