#33 "source code style rule definition"

- code was already cycle-free on package level
- fixed 'layering' (no dependencies between a package and any of its (sub-)sub-packages)
-- all test gap analysis related classes are now in analysis package (or a sub-package)
-- created a new top-level package for DebugCoverageResolution

README.md

@@ -210,5 +210,8 @@ Unresolvable methods (no coverage information available):
     1. exception: completely stateless `*Utils` classes with static methods only
         1. utility classes must be `abstract` and have a private default constructor
     1. exception: real constants with names in upper case delimited by underscores
-1. `logger` has to be protected final but not static: `protected final Logger logger = LoggerFactory.getLogger(getClass());`
+1. `logger` has to be protected final but not static: `protected final Logger logger = LoggerFactory.getLogger(getClass());` (see https://www.slf4j.org/faq.html#declared_static)
 1. restrict file, method and lambda lengths to reasonable values
+1. code dependency
+    1. no code cycles on package level
+    1. no dependencies between a package and any of its (sub-)sub-packages (only the other way around)

test-gap-analysis-maven-plugin/src/main/java/com/scheible/testgapanalysis/maven/DebugCoverageResolutionMojo.java

@@ -1,7 +1,7 @@
 package com.scheible.testgapanalysis.maven;
 
-import com.scheible.testgapanalysis.DebugCoverageResolution;
-import com.scheible.testgapanalysis.DebugCoverageResolutionReport;
+import com.scheible.testgapanalysis.debug.DebugCoverageResolution;
+import com.scheible.testgapanalysis.debug.DebugCoverageResolutionReport;
 import com.scheible.testgapanalysis.jacoco.JaCoCoReportParser;
 import com.scheible.testgapanalysis.parser.JavaParser;
 

test-gap-analysis-maven-plugin/src/main/java/com/scheible/testgapanalysis/maven/TestGapAnalysisMojo.java

@@ -2,8 +2,8 @@
 
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
-import com.scheible.testgapanalysis.TestGapAnalysis;
-import com.scheible.testgapanalysis.TestGapReport;
+import com.scheible.testgapanalysis.analysis.testgap.TestGapAnalysis;
+import com.scheible.testgapanalysis.analysis.testgap.TestGapReport;
 import com.scheible.testgapanalysis.analysis.Analysis;
 import com.scheible.testgapanalysis.git.GitDiffer;
 import com.scheible.testgapanalysis.jacoco.JaCoCoReportParser;

test-gap-analysis/pom.xml

@@ -104,6 +104,11 @@
 				<artifactId>archunit</artifactId>
 				<version>${archunit.version}</version>
 			</dependency>
+			<dependency>
+				<groupId>com.tngtech.archunit</groupId>
+				<artifactId>archunit-junit4</artifactId>
+				<version>${archunit.version}</version>
+			</dependency>
 
 			<dependency>
 				<groupId>org.eclipse.jgit</groupId>
@@ -163,6 +168,11 @@
 			<artifactId>archunit</artifactId>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+			<groupId>com.tngtech.archunit</groupId>
+			<artifactId>archunit-junit4</artifactId>
+			<scope>test</scope>
+		</dependency>
 
 		<dependency>
 			<groupId>com.scheible.pocketsaw.impl</groupId>

test-gap-analysis/src/main/java/com/scheible/testgapanalysis/TestGapAnalysis.java → test-gap-analysis/src/main/java/com/scheible/testgapanalysis/analysis/testgap/TestGapAnalysis.java

@@ -1,4 +1,4 @@
-package com.scheible.testgapanalysis;
+package com.scheible.testgapanalysis.analysis.testgap;
 
 import static java.util.Collections.emptySet;
 
@@ -12,12 +12,12 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
-import com.scheible.testgapanalysis.TestGapReport.CoverageReportMethod;
-import com.scheible.testgapanalysis.TestGapReport.NewOrChangedFile;
-import com.scheible.testgapanalysis.TestGapReport.NewOrChangedFile.State;
-import com.scheible.testgapanalysis.TestGapReport.TestGapMethod;
 import com.scheible.testgapanalysis.analysis.Analysis;
 import com.scheible.testgapanalysis.analysis.AnalysisResult;
+import com.scheible.testgapanalysis.analysis.testgap.TestGapReport.CoverageReportMethod;
+import com.scheible.testgapanalysis.analysis.testgap.TestGapReport.NewOrChangedFile;
+import com.scheible.testgapanalysis.analysis.testgap.TestGapReport.NewOrChangedFile.State;
+import com.scheible.testgapanalysis.analysis.testgap.TestGapReport.TestGapMethod;
 import com.scheible.testgapanalysis.common.FilesUtils;
 import com.scheible.testgapanalysis.git.GitDiffer;
 import com.scheible.testgapanalysis.git.RepositoryStatus;

test-gap-analysis/src/main/java/com/scheible/testgapanalysis/TestGapReport.java → test-gap-analysis/src/main/java/com/scheible/testgapanalysis/analysis/testgap/TestGapReport.java

@@ -1,4 +1,4 @@
-package com.scheible.testgapanalysis;
+package com.scheible.testgapanalysis.analysis.testgap;
 
 import static java.util.Collections.unmodifiableMap;
 import static java.util.Collections.unmodifiableSet;

test-gap-analysis/src/main/java/com/scheible/testgapanalysis/DebugCoverageResolution.java → test-gap-analysis/src/main/java/com/scheible/testgapanalysis/debug/DebugCoverageResolution.java

@@ -1,4 +1,4 @@
-package com.scheible.testgapanalysis;
+package com.scheible.testgapanalysis.debug;
 
 import java.io.File;
 import java.io.IOException;

test-gap-analysis/src/main/java/com/scheible/testgapanalysis/DebugCoverageResolutionReport.java → test-gap-analysis/src/main/java/com/scheible/testgapanalysis/debug/DebugCoverageResolutionReport.java

@@ -1,4 +1,4 @@
-package com.scheible.testgapanalysis;
+package com.scheible.testgapanalysis.debug;
 
 import static java.util.Collections.unmodifiableMap;
 import static java.util.Collections.unmodifiableSet;

test-gap-analysis/src/test/java/com/scheible/testgapanalysis/CodeDependenciesTest.java

@@ -0,0 +1,71 @@
+package com.scheible.testgapanalysis;
+
+import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.noClasses;
+import static com.tngtech.archunit.library.dependencies.SlicesRuleDefinition.slices;
+
+import org.junit.runner.RunWith;
+
+import com.tngtech.archunit.core.domain.Dependency;
+import com.tngtech.archunit.core.domain.JavaClass;
+import com.tngtech.archunit.core.importer.ImportOption.DoNotIncludeTests;
+import com.tngtech.archunit.junit.AnalyzeClasses;
+import com.tngtech.archunit.junit.ArchTest;
+import com.tngtech.archunit.junit.ArchUnitRunner;
+import com.tngtech.archunit.lang.ArchCondition;
+import com.tngtech.archunit.lang.ArchRule;
+import com.tngtech.archunit.lang.ConditionEvents;
+import com.tngtech.archunit.lang.SimpleConditionEvent;
+import com.tngtech.archunit.library.dependencies.SliceAssignment;
+import com.tngtech.archunit.library.dependencies.SliceIdentifier;
+
+/**
+ *
+ * @author sj
+ */
+@RunWith(ArchUnitRunner.class)
+@AnalyzeClasses(packagesOf = CodeDependenciesTest.class, importOptions = DoNotIncludeTests.class)
+public class CodeDependenciesTest {
+
+	private static class SlicePerPackage implements SliceAssignment {
+
+		@Override
+		public SliceIdentifier getIdentifierOf(final JavaClass javaClass) {
+			return SliceIdentifier.of(javaClass.getPackageName());
+		}
+
+		@Override
+		public String getDescription() {
+			return "Every package is treated as a slice.";
+		}
+	}
+
+	@ArchTest
+	static final ArchRule noPackageCyclesRule = slices().assignedFrom(new SlicePerPackage()).should().beFreeOfCycles();
+
+	private static class DependOnDescendantPackagesCondition extends ArchCondition<JavaClass> {
+
+		DependOnDescendantPackagesCondition() {
+			super("depend on descendant packages");
+		}
+
+		@Override
+		public void check(JavaClass clazz, ConditionEvents events) {
+			for (Dependency dependency : clazz.getDirectDependenciesFromSelf()) {
+				boolean dependencyOnDescendantPackage = isDependencyOnDescendantPackage(dependency.getOriginClass(),
+						dependency.getTargetClass());
+				events.add(new SimpleConditionEvent(dependency, dependencyOnDescendantPackage,
+						dependency.getDescription()));
+			}
+		}
+
+		private boolean isDependencyOnDescendantPackage(JavaClass origin, JavaClass target) {
+			String originPackageName = origin.getPackageName();
+			String targetSubPackagePrefix = target.getPackageName();
+			return targetSubPackagePrefix.contains(originPackageName + ".");
+		}
+	}
+
+	@ArchTest
+	static final ArchRule packageLayeringRule = noClasses().should(new DependOnDescendantPackagesCondition())
+			.because("lower packages shouldn't build on higher packages");
+}

test-gap-analysis/src/test/java/com/scheible/testgapanalysis/TestGapAnalysisSubModule.java

@@ -1,20 +1,12 @@
 package com.scheible.testgapanalysis;
 
 import com.scheible.pocketsaw.api.SubModule;
-import com.scheible.testgapanalysis.ExternalFunctionalities.Slf4j;
-import com.scheible.testgapanalysis.analysis.AnalysisSubModule;
-import com.scheible.testgapanalysis.common.CommonSubModule;
-import com.scheible.testgapanalysis.git.GitSubModule;
-import com.scheible.testgapanalysis.jacoco.JaCoCoSubModule;
-import com.scheible.testgapanalysis.jacoco.resolver.JaCoCoResolverSubModule;
-import com.scheible.testgapanalysis.parser.ParserSubModule;
 
 /**
  *
  * @author sj
  */
-@SubModule(includeSubPackages = false, uses = {AnalysisSubModule.class, JaCoCoSubModule.class, ParserSubModule.class,
-		JaCoCoResolverSubModule.class, Slf4j.class, GitSubModule.class, CommonSubModule.class})
+@SubModule(includeSubPackages = false)
 public class TestGapAnalysisSubModule {
 
 }

test-gap-analysis/src/test/java/com/scheible/testgapanalysis/analysis/AnalysisSubModule.java

@@ -2,6 +2,7 @@
 
 import com.scheible.pocketsaw.api.SubModule;
 import com.scheible.testgapanalysis.ExternalFunctionalities.Slf4j;
+import com.scheible.testgapanalysis.common.CommonSubModule;
 import com.scheible.testgapanalysis.git.GitSubModule;
 import com.scheible.testgapanalysis.jacoco.JaCoCoSubModule;
 import com.scheible.testgapanalysis.jacoco.resolver.JaCoCoResolverSubModule;
@@ -12,7 +13,7 @@
  * @author sj
  */
 @SubModule(uses = {JaCoCoSubModule.class, JaCoCoResolverSubModule.class, GitSubModule.class, ParserSubModule.class,
-		Slf4j.class})
+		Slf4j.class, CommonSubModule.class})
 public class AnalysisSubModule {
 
 }

test-gap-analysis/src/test/java/com/scheible/testgapanalysis/analysis/testgap/AnalysisTestGapSubModule.java

@@ -0,0 +1,20 @@
+package com.scheible.testgapanalysis.analysis.testgap;
+
+import com.scheible.pocketsaw.api.SubModule;
+import com.scheible.testgapanalysis.ExternalFunctionalities.Slf4j;
+import com.scheible.testgapanalysis.analysis.*;
+import com.scheible.testgapanalysis.common.CommonSubModule;
+import com.scheible.testgapanalysis.git.GitSubModule;
+import com.scheible.testgapanalysis.jacoco.JaCoCoSubModule;
+import com.scheible.testgapanalysis.jacoco.resolver.JaCoCoResolverSubModule;
+import com.scheible.testgapanalysis.parser.ParserSubModule;
+
+/**
+ *
+ * @author sj
+ */
+@SubModule(uses = {JaCoCoSubModule.class, JaCoCoResolverSubModule.class, GitSubModule.class, ParserSubModule.class,
+		Slf4j.class, CommonSubModule.class})
+public class AnalysisTestGapSubModule {
+
+}

test-gap-analysis/src/test/java/com/scheible/testgapanalysis/TestGapAnalysisTest.java → test-gap-analysis/src/test/java/com/scheible/testgapanalysis/analysis/testgap/TestGapAnalysisTest.java

@@ -1,4 +1,4 @@
-package com.scheible.testgapanalysis;
+package com.scheible.testgapanalysis.analysis.testgap;
 
 import static org.assertj.core.api.Assertions.assertThat;
 

test-gap-analysis/src/test/java/com/scheible/testgapanalysis/TestGapReportTest.java → test-gap-analysis/src/test/java/com/scheible/testgapanalysis/analysis/testgap/TestGapReportTest.java

@@ -1,4 +1,4 @@
-package com.scheible.testgapanalysis;
+package com.scheible.testgapanalysis.analysis.testgap;
 
 import static java.util.Collections.emptyMap;
 import static java.util.Collections.emptySet;

test-gap-analysis/src/test/java/com/scheible/testgapanalysis/DebugCoverageResolutionTest.java → test-gap-analysis/src/test/java/com/scheible/testgapanalysis/debug/DebugCoverageResolutionTest.java

@@ -1,4 +1,4 @@
-package com.scheible.testgapanalysis;
+package com.scheible.testgapanalysis.debug;
 
 import static org.assertj.core.api.Assertions.assertThat;
 

test-gap-analysis/src/test/java/com/scheible/testgapanalysis/debug/DebugSubModule.java

@@ -0,0 +1,16 @@
+package com.scheible.testgapanalysis.debug;
+
+import com.scheible.pocketsaw.api.SubModule;
+import com.scheible.testgapanalysis.common.CommonSubModule;
+import com.scheible.testgapanalysis.jacoco.JaCoCoSubModule;
+import com.scheible.testgapanalysis.jacoco.resolver.JaCoCoResolverSubModule;
+import com.scheible.testgapanalysis.parser.ParserSubModule;
+
+/**
+ *
+ * @author sj
+ */
+@SubModule(uses = {JaCoCoSubModule.class, ParserSubModule.class, JaCoCoResolverSubModule.class, CommonSubModule.class})
+public class DebugSubModule {
+
+}