model can merge and ignore packages

Author: nidi3

code-assert-gui/src/main/java/guru/nidi/codeassert/gui/AppController.java

@@ -25,6 +25,6 @@ public class AppController {
 
     @GetMapping("model")
     public Model model(@RequestParam String jarfile) {
-        return Model.from(new File(jarfile));
+        return Model.from(new File(jarfile)).read();
     }
 }

code-assert/src/main/java/guru/nidi/codeassert/dependency/DependencyAnalyzer.java

@@ -33,7 +33,7 @@ public class DependencyAnalyzer implements Analyzer<Dependencies> {
     private final DependencyCollector collector;
 
     public DependencyAnalyzer(AnalyzerConfig config) {
-        this(Model.from(config.getClasses()), DependencyRules.denyAll(), Scope.PACKAGES, new DependencyCollector());
+        this(Model.from(config.getClasses()).read(), DependencyRules.denyAll(), Scope.PACKAGES, new DependencyCollector());
     }
 
     public DependencyAnalyzer(Model model) {

code-assert/src/main/java/guru/nidi/codeassert/model/ClassFileParser.java

@@ -54,6 +54,9 @@ CodeClass parse(InputStream is, Model model) throws IOException {
         final int flags = parseAccessFlags();
 
         final String className = parseClassName();
+        if (model.isIgnoreClass(className)) {
+            return null;
+        }
         final String superClassName = parseSuperClassName();
         final List<String> interfaceNames = parseInterfaces();
         final List<MemberInfo> fields = parseMembers();

code-assert/src/main/java/guru/nidi/codeassert/model/CodeClass.java

@@ -41,6 +41,7 @@ public class CodeClass extends UsingElement<CodeClass> {
     int codeSize;
     int totalSize;
     boolean concrete;
+    int sourceSize;
     int codeLines;
     int commentLines;
     int emptyLines;
@@ -91,6 +92,10 @@ public boolean isConcrete() {
         return concrete;
     }
 
+    public int getSourceSize() {
+        return sourceSize;
+    }
+
     public int getCodeLines() {
         return codeLines;
     }
@@ -160,17 +165,23 @@ public boolean isMatchedBy(LocationMatcher matcher) {
 
     void addImport(String type, Model model) {
         if (!name.equals(type)) {
-            final String packName = Model.packageOf(type);
-            final CodePackage p = model.getOrCreatePackage(packName);
-            usedPackages.add(p);
-            pack.addEfferent(p);
-            usedClasses.add(model.getOrCreateClass(type));
+            final CodeClass clazz = model.getOrCreateClass(type);
+            if (clazz != null) {
+                final String packName = model.packageOf(type);
+                final CodePackage p = model.getOrCreatePackage(packName);
+                usedPackages.add(p);
+                pack.addEfferent(p);
+                usedClasses.add(clazz);
+            }
         }
     }
 
     void addAnnotation(String type, Model model) {
-        addImport(type, model);
-        annotations.add(model.getOrCreateClass(type));
+        final CodeClass clazz = model.getOrCreateClass(type);
+        if (clazz != null) {
+            addImport(type, model);
+            annotations.add(clazz);
+        }
     }
 
     public boolean equals(Object other) {

code-assert/src/main/java/guru/nidi/codeassert/model/CodeClassBuilder.java

@@ -97,7 +97,7 @@ public CodeClassBuilder addAttributeRefs(List<AttributeInfo> attributes) throws
 
     public CodeClassBuilder addPackageInfo(Model model, String className) {
         if (className.endsWith(".package-info")) {
-            final CodePackage pack = model.getOrCreatePackage(Model.packageOf(className));
+            final CodePackage pack = model.getOrCreatePackage(model.packageOf(className));
             for (final CodeClass ann : clazz.getAnnotations()) {
                 pack.addAnnotation(ann);
             }
@@ -115,7 +115,8 @@ public CodeClassBuilder addCodeSizes(int totalSize, List<MemberInfo> methods) {
         return this;
     }
 
-    public CodeClassBuilder addSourceSizes(int codeLines, int commentLines, int emptyLines, int totalLines) {
+    public CodeClassBuilder addSourceSizes(int sourceSize, int codeLines, int commentLines, int emptyLines, int totalLines) {
+        clazz.sourceSize = sourceSize;
         clazz.codeLines = codeLines;
         clazz.commentLines = commentLines;
         clazz.emptyLines = emptyLines;

code-assert/src/main/java/guru/nidi/codeassert/model/Model.java

@@ -23,26 +23,35 @@
 import java.util.zip.ZipEntry;
 
 import static java.util.Arrays.asList;
+import static java.util.Collections.emptyList;
 
 public class Model {
     public static final String UNNAMED_PACKAGE = "<Unnamed Package>";
 
     final Map<String, CodePackage> packages = new HashMap<>();
     final Map<String, CodeClass> classes = new HashMap<>();
+    private final Set<String> ownPackages = new HashSet<>();
+    private final List<String> ignorePackages;
+    private final List<String> mergePackages;
 
-    public static Model from(File... files) {
-        return from(asList(files));
+    Model() {
+        this(emptyList(), emptyList());
     }
 
-    public static Model from(List<File> files) {
-        return new Model().and(files);
+    Model(List<String> ignorePackages, List<String> mergePackages) {
+        this.ignorePackages = ignorePackages;
+        this.mergePackages = mergePackages;
     }
 
-    public Model and(File... files) {
-        return and(asList(files));
+    public static ModelBuilder from(File... files) {
+        return from(asList(files));
     }
 
-    public Model and(List<File> files) {
+    public static ModelBuilder from(List<File> files) {
+        return new ModelBuilder().and(files);
+    }
+
+    public Model read(List<File> files) {
         try {
             final ClassFileParser classParser = new ClassFileParser();
             for (final File file : files) {
@@ -70,7 +79,10 @@ private void add(ClassFileParser parser, String name, InputStream in) throws IOE
                 }
             }
         } else if (name.endsWith(".class")) {
-            parser.parse(in, this);
+            final CodeClass clazz = parser.parse(in, this);
+            if (clazz != null) {
+                ownPackages.add(clazz.getPackageName());
+            }
         }
     }
 
@@ -84,6 +96,9 @@ CodePackage getOrCreatePackage(String name) {
     }
 
     CodeClass getOrCreateClass(String name) {
+        if (isIgnoreClass(name)) {
+            return null;
+        }
         CodeClass clazz = classes.get(name);
         if (clazz == null) {
             final CodePackage pack = getOrCreatePackage(packageOf(name));
@@ -94,9 +109,18 @@ CodeClass getOrCreateClass(String name) {
         return clazz;
     }
 
-    static String packageOf(String type) {
+    String packageOf(String type) {
         final int pos = type.lastIndexOf('.');
-        return pos < 0 ? UNNAMED_PACKAGE : type.substring(0, pos);
+        final String pack = pos < 0 ? UNNAMED_PACKAGE : type.substring(0, pos);
+        return mergePackages.stream().filter(pack::startsWith).findFirst().orElse(pack);
+    }
+
+    boolean isIgnoreClass(String name) {
+        return ignorePackages.stream().anyMatch(name::startsWith);
+    }
+
+    public boolean isOwnPackage(CodePackage pack) {
+        return ownPackages.contains(pack.getName());
     }
 
     public Collection<CodePackage> getPackages() {

code-assert/src/main/java/guru/nidi/codeassert/model/ModelBuilder.java

@@ -0,0 +1,67 @@
+/*
+ * 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.model;
+
+import java.io.File;
+import java.util.ArrayList;
+import java.util.List;
+
+import static java.util.Arrays.asList;
+
+public class ModelBuilder {
+    private final List<File> files = new ArrayList<>();
+    private final List<String> ignorePackages = new ArrayList<>();
+    private final List<String> mergePackages = new ArrayList<>();
+
+    public static ModelBuilder from(File... files) {
+        return from(asList(files));
+    }
+
+    public static ModelBuilder from(List<File> files) {
+        return new ModelBuilder().and(files);
+    }
+
+    public ModelBuilder and(File... files) {
+        return and(asList(files));
+    }
+
+    public ModelBuilder and(List<File> files) {
+        this.files.addAll(files);
+        return this;
+    }
+
+    public ModelBuilder ignoringPackages(String... packages) {
+        return ignoringPackages(asList(packages));
+    }
+
+    public ModelBuilder ignoringPackages(List<String> packages) {
+        ignorePackages.addAll(packages);
+        return this;
+    }
+
+    public ModelBuilder mergingPackages(String... packages) {
+        return mergingPackages(asList(packages));
+    }
+
+    public ModelBuilder mergingPackages(List<String> packages) {
+        mergePackages.addAll(packages);
+        return this;
+    }
+
+    public Model read() {
+        return new Model(ignorePackages,mergePackages).read(files);
+    }
+}

code-assert/src/main/java/guru/nidi/codeassert/model/SourceFileParser.java

@@ -44,6 +44,7 @@ enum State {
     int commentLines;
     int emptyLines;
     int totalLines;
+    int sourceSize;
 
     static CodeClass parse(CodeClass clazz, File file, Charset charset) throws IOException {
         try (InputStream in = new FileInputStream(file)) {
@@ -71,7 +72,7 @@ static CodeClass parse(CodeClass clazz, Language language, Reader reader) throws
             } else {
                 parser.parse(in);
                 new CodeClassBuilder(clazz)
-                        .addSourceSizes(parser.codeLines, parser.commentLines, parser.emptyLines, parser.totalLines);
+                        .addSourceSizes(parser.sourceSize, parser.codeLines, parser.commentLines, parser.emptyLines, parser.totalLines);
             }
             return clazz;
         }
@@ -92,6 +93,7 @@ void parse(BufferedReader in) throws IOException {
         state = CODE;
         while ((line = in.readLine()) != null) {
             pos = 0;
+            sourceSize += line.length() + 1; //TODO newline could also be 2 len, can we support this?
             totalLines++;
             if (line.trim().length() == 0) {
                 emptyLines++;

code-assert/src/test/java/guru/nidi/codeassert/dependency/DependencyRulesTest.java

@@ -54,7 +54,7 @@ public class DependencyRulesTest {
 
     @BeforeEach
     void analyze() {
-        model = Model.from(AnalyzerConfig.maven().mainAndTest("guru/nidi/codeassert/dependency").getClasses());
+        model = Model.from(AnalyzerConfig.maven().mainAndTest("guru/nidi/codeassert/dependency").getClasses()).read();
     }
 
     @Test

code-assert/src/test/java/guru/nidi/codeassert/model/AnalyzerTest.java

@@ -21,7 +21,7 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
 class AnalyzerTest {
-    final Model model = Model.from(AnalyzerConfig.maven().mainAndTest("guru/nidi/codeassert/model").getClasses());
+    final Model model = Model.from(AnalyzerConfig.maven().mainAndTest("guru/nidi/codeassert/model").getClasses()).read();
 
     @Test
     void packages() {