de.spricom.dessert.assertions.DefaultCycleRenderer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dessert-core Show documentation
A library for unit-tests to check the dependencies between classes.
The newest version!
package de.spricom.dessert.assertions;

/*-
 * #%L
 * Dessert Dependency Assertion Library for Java
 * %%
 * Copyright (C) 2017 - 2023 Hans Jörg Heßmann
 * %%
 * 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.
 * #L%
 */

import de.spricom.dessert.slicing.Clazz;
import de.spricom.dessert.slicing.PackageSlice;
import de.spricom.dessert.slicing.Slice;
import de.spricom.dessert.util.Dag;

import java.util.*;

/**
 * The default implementation used by dessert-core.
 */
public class DefaultCycleRenderer implements CycleRenderer {

    @Override
    public String renderCycle(Dag dag) {
        StringBuilder sb = new StringBuilder("Cycle detected:\n");
        List cycle = dag.cycle();
        Slice repeated = cycle.get(cycle.size() - 1);
        Slice m = null;
        boolean withinCycle = false;
        for (Slice n : cycle) {
            if (m == repeated) {
                withinCycle = true;
            }
            if (m != null && withinCycle) {
                renderDependencies(sb, m, n);
            }
            m = n;
        }
        return sb.toString();
    }

    private void renderDependencies(StringBuilder sb, Slice m, Slice n) {
        if (m instanceof Clazz && n instanceof Clazz) {
            sb.append(((Clazz)m).getName()).append(" -> ")
                    .append(((Clazz)n).getName()).append("\n");
            return;
        }
        if (m instanceof PackageSlice && n instanceof PackageSlice) {
            sb.append(((PackageSlice)m).getPackageName()).append(" -> ")
                    .append(((PackageSlice)n).getPackageName()).append(":\n");
        } else {
            sb.append(m).append(" -> ").append(n).append(":\n");
        }

        for (Map.Entry> entry : determineDependencies(m, n).entrySet()) {
            sb.append("\t").append(shortName(entry.getKey())).append(" -> ");
            boolean first = true;
            for (Clazz dep : entry.getValue()) {
                if (first) {
                    first = false;
                } else {
                    sb.append(", ");
                }
                sb.append(shortName(dep));
            }
            sb.append("\n");
        }
    }

    private String shortName(Clazz clazz) {
        if (clazz.getPackageName().isEmpty()) {
            return clazz.getName();
        }
        return clazz.getName().substring(clazz.getPackageName().length() + 1);
    }

    private Map> determineDependencies(Slice m, Slice n) {
        TreeMap> dependencies = new TreeMap>();
        for (Clazz clazz : m.getClazzes()) {
            for (Clazz dep : clazz.getDependencies().getClazzes()) {
                if (n.contains(dep)) {
                    Collection deps = dependencies.get(clazz);
                    if (deps == null) {
                        deps = new TreeSet();
                        dependencies.put(clazz, deps);
                    }
                    deps.add(dep);
                }
            }
        }
        return dependencies;
    }
}