split off core module

Author: nidi3

code-assert/images/packages.png renamed to code-assert-core/images/packages.png

@@ -0,0 +1,140 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>guru.nidi</groupId>
+        <artifactId>code-assert-parent</artifactId>
+        <version>0.9.12-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>code-assert-core</artifactId>
+    <name>${project.artifactId}</name>
+
+    <properties>
+        <maven-jar.version>3.2.0</maven-jar.version>
+    </properties>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>guru.nidi</groupId>
+                <artifactId>code-assert-maven-plugin</artifactId>
+                <version>0.9.6</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>prepare</goal>
+                            <goal>assert</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+
+            <plugin>
+                <groupId>guru.nidi.maven.plugins</groupId>
+                <artifactId>snippets-maven-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <phase>generate-resources</phase>
+                        <goals>
+                            <goal>snippets</goal>
+                        </goals>
+                        <configuration>
+                            <inputs>
+                                <input>
+                                    src/test/java/guru/nidi/codeassert/snippets
+                                </input>
+                            </inputs>
+                            <outputs>
+                                <output>../README.md</output>
+                            </outputs>
+                            <prefix>\n```java</prefix>
+                            <postfix>```\n</postfix>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.jetbrains.kotlin</groupId>
+                <artifactId>kotlin-maven-plugin</artifactId>
+                <version>${kotlin.version}</version>
+                <executions>
+                    <execution>
+                        <id>test-compile</id>
+                        <goals>
+                            <goal>test-compile</goal>
+                        </goals>
+                        <configuration>
+                            <sourceDirs>
+                                <sourceDir>src/test/kotlin</sourceDir>
+                            </sourceDirs>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-jar-plugin</artifactId>
+                <version>${maven-jar.version}</version>
+                <configuration>
+                    <archive>
+                        <manifestEntries>
+                            <Automatic-Module-Name>guru.nidi.codeassert</Automatic-Module-Name>
+                        </manifestEntries>
+                    </archive>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
+    <dependencies>
+        <dependency>
+            <groupId>guru.nidi</groupId>
+            <artifactId>graphviz-java</artifactId>
+            <version>0.17.0</version>
+            <optional>true</optional>
+        </dependency>
+        <dependency>
+            <groupId>org.hamcrest</groupId>
+            <artifactId>hamcrest-core</artifactId>
+            <version>1.3</version>
+        </dependency>
+        <dependency>
+            <groupId>commons-io</groupId>
+            <artifactId>commons-io</artifactId>
+            <version>2.7</version>
+        </dependency>
+
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <version>4.12</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-api</artifactId>
+            <scope>provided</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>jcl-over-slf4j</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>jul-to-slf4j</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-simple</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+</project>

code-assert-core/pom.xml

@@ -0,0 +1,49 @@
+/*
+ * Copyright © 2015 Stefan Niederhauser ([email protected])
+ *
+ * Licensed 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.
+ */
+package guru.nidi.codeassert.junit;
+
+import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.Test;
+
+import static guru.nidi.codeassert.junit.CodeAssertCoreMatchers.*;
+import static guru.nidi.codeassert.junit.CodeAssertTestType.*;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.junit.jupiter.api.Assumptions.assumeFalse;
+import static org.junit.jupiter.api.Assumptions.assumeTrue;
+
+@Disabled("This is made to be subclassed")
+public class CodeAssertCoreJunit5Test extends CodeAssertCoreTestBase {
+    @Test
+    void dependencies() {
+        assumeTrue(defaultTests().contains(DEPENDENCIES), "Dependencies test excluded.");
+        assumeFalse(dependencyResult() == null, "analyzeDependencies() not implemented.");
+        assertThat(dependencyResult(), matchesRulesExactly());
+    }
+
+    @Test
+    void circularDependencies() {
+        assumeTrue(defaultTests().contains(CIRCULAR_DEPENDENCIES), "Circular dependencies test excluded.");
+        assumeFalse(dependencyResult() == null, "analyzeDependencies() not implemented.");
+        assertThat(dependencyResult(), hasNoCycles());
+    }
+
+    @Test
+    void codeStructure() {
+        assumeTrue(defaultTests().contains(STRUCTURE), "Structure tests excluded.");
+        assumeFalse(createModel() == null, "createModel() not implemented.");
+        assertThat(createModel(), exposesNoInternalTypes());
+    }
+}

code-assert/src/main/java/guru/nidi/codeassert/Analyzer.java renamed to code-assert-core/src/main/java/guru/nidi/codeassert/Analyzer.java

@@ -0,0 +1,64 @@
+/*
+ * Copyright © 2015 Stefan Niederhauser ([email protected])
+ *
+ * Licensed 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.
+ */
+package guru.nidi.codeassert.junit;
+
+import guru.nidi.codeassert.AnalyzerResult;
+import guru.nidi.codeassert.dependency.*;
+import guru.nidi.codeassert.jacoco.CoverageMatcher;
+import guru.nidi.codeassert.jacoco.JacocoResult;
+import guru.nidi.codeassert.model.*;
+import org.hamcrest.Matcher;
+
+public final class CodeAssertCoreMatchers {
+    private CodeAssertCoreMatchers() {
+    }
+
+    public static Matcher<DependencyResult> matchesRules() {
+        return new DependencyResultMatcher(false, false);
+    }
+
+    public static Matcher<DependencyResult> matchesRulesExactly() {
+        return new DependencyResultMatcher(true, true);
+    }
+
+    public static Matcher<DependencyResult> matchesRulesIgnoringNonExisting() {
+        return new DependencyResultMatcher(false, true);
+    }
+
+    public static Matcher<DependencyResult> matchesRulesIgnoringUndefined() {
+        return new DependencyResultMatcher(true, false);
+    }
+
+    public static Matcher<Model> exposesNoInternalTypes() {
+        return new InternalTypeInPublicApiMatcher();
+    }
+
+    public static Matcher<Model> hasNoPublicMembersInInternalTypes() {
+        return new PublicMemberInInternalTypeMatcher();
+    }
+
+    public static Matcher<DependencyResult> hasNoCycles() {
+        return new DependencyCycleMatcher();
+    }
+
+    public static <T extends AnalyzerResult<?>> Matcher<T> hasNoUnusedActions() {
+        return new UnusedActionsMatcher<>();
+    }
+
+    public static Matcher<JacocoResult> hasEnoughCoverage() {
+        return new CoverageMatcher();
+    }
+}

code-assert/src/main/java/guru/nidi/codeassert/AnalyzerException.java renamed to code-assert-core/src/main/java/guru/nidi/codeassert/AnalyzerException.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright © 2015 Stefan Niederhauser ([email protected])
+ *
+ * Licensed 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.
+ */
+package guru.nidi.codeassert.junit;
+
+import org.junit.Ignore;
+import org.junit.Test;
+
+import static guru.nidi.codeassert.junit.CodeAssertCoreMatchers.*;
+import static guru.nidi.codeassert.junit.CodeAssertTestType.*;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.junit.Assume.assumeFalse;
+import static org.junit.Assume.assumeTrue;
+
+@Ignore("This is made to be subclassed")
+public class CodeAssertCoreTest extends CodeAssertCoreTestBase {
+    @Test
+    public void dependencies() {
+        assumeTrue("Dependencies test excluded.", defaultTests().contains(DEPENDENCIES));
+        assumeFalse("analyzeDependencies() not implemented.", dependencyResult() == null);
+        assertThat(dependencyResult(), matchesRulesExactly());
+    }
+
+    @Test
+    public void circularDependencies() {
+        assumeTrue("Circular dependencies test excluded.", defaultTests().contains(CIRCULAR_DEPENDENCIES));
+        assumeFalse("analyzeDependencies() not implemented.", dependencyResult() == null);
+        assertThat(dependencyResult(), hasNoCycles());
+    }
+
+    @Test
+    public void codeStructure() {
+        assumeTrue("Structure tests excluded.", defaultTests().contains(STRUCTURE));
+        assumeFalse("createModel() not implemented.", createModel() == null);
+        assertThat(createModel(), exposesNoInternalTypes());
+    }
+}

code-assert/src/main/java/guru/nidi/codeassert/AnalyzerResult.java renamed to code-assert-core/src/main/java/guru/nidi/codeassert/AnalyzerResult.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright © 2015 Stefan Niederhauser ([email protected])
+ *
+ * Licensed 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.
+ */
+package guru.nidi.codeassert.junit;
+
+import guru.nidi.codeassert.dependency.DependencyResult;
+import guru.nidi.codeassert.model.Model;
+
+import java.util.EnumSet;
+
+public class CodeAssertCoreTestBase {
+    private Model model;
+    private DependencyResult dependencyResult;
+
+    protected EnumSet<CodeAssertTestType> defaultTests() {
+        return EnumSet.allOf(CodeAssertTestType.class);
+    }
+
+    protected Model createModel() {
+        return null;
+    }
+
+    protected DependencyResult analyzeDependencies() {
+        return null;
+    }
+
+    protected synchronized Model model() {
+        if (model == null) {
+            model = createModel();
+        }
+        return model;
+    }
+
+    protected synchronized DependencyResult dependencyResult() {
+        if (dependencyResult == null) {
+            dependencyResult = analyzeDependencies();
+        }
+        return dependencyResult;
+    }
+}

code-assert/src/main/java/guru/nidi/codeassert/config/Action.java renamed to code-assert-core/src/main/java/guru/nidi/codeassert/config/Action.java

@@ -0,0 +1,20 @@
+import guru.nidi.codeassert.config.For;
+import guru.nidi.codeassert.jacoco.CoverageCollector;
+import guru.nidi.codeassert.jacoco.JacocoAnalyzer;
+import org.junit.jupiter.api.Test;
+
+import static guru.nidi.codeassert.jacoco.CoverageType.*;
+import static guru.nidi.codeassert.junit.CodeAssertCoreMatchers.hasEnoughCoverage;
+import static org.hamcrest.MatcherAssert.assertThat;
+
+public class CodeCoverage {
+    @Test
+    void coverage() {
+        JacocoAnalyzer analyzer = new JacocoAnalyzer(new CoverageCollector(BRANCH, LINE, METHOD)
+                .just(For.global().setMinima(80, 80, 80))
+                .just(For.allPackages().setMinima(75, 80, 80))
+                .just(For.thePackage("*junit").setMinima(70, 70, 60))
+        );
+        assertThat(analyzer.analyze(), hasEnoughCoverage());
+    }
+}