guru.nidi.codeassert.dependency.DependencyCycleMatcher Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of code-assert-core Show documentation
There is a newer version: 0.9.15
/*
 * 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.dependency;

import org.hamcrest.Description;
import org.hamcrest.TypeSafeMatcher;

import java.util.*;

import static guru.nidi.codeassert.dependency.DependencyCollector.CYCLE;
import static guru.nidi.codeassert.dependency.MatcherUtils.deps;
import static guru.nidi.codeassert.dependency.MatcherUtils.sorted;
import static java.lang.System.lineSeparator;

public class DependencyCycleMatcher extends TypeSafeMatcher {
    private static final Comparator DEP_MAP_COMPARATOR = new DependencyMapComparator();

    @Override
    protected boolean matchesSafely(DependencyResult item) {
        return item.findings().getCycles().isEmpty();
    }

    public void describeTo(Description description) {
        description.appendText("Does not have cycles");
    }

    @Override
    protected void describeMismatchSafely(DependencyResult item, Description description) {
        description.appendText(lineSeparator());
        final Set result = item.findings().getCycles();
        for (final DependencyMap cycle : sortedDepMaps(result)) {
            description.appendText(String.format("%-12s %s%n", CYCLE,
                    "This group of elements has mutual dependencies:"));
            for (final String elem : sorted(cycle.getElements())) {
                description.appendText(String.format("  %s ->%n", elem));
                description.appendText(deps("    ", cycle.getDependencies(elem)));
            }
        }
    }

    private static List sortedDepMaps(Collection maps) {
        final List sorted = new ArrayList<>(maps);
        sorted.sort(DEP_MAP_COMPARATOR);
        return sorted;
    }

    private static class DependencyMapComparator implements Comparator {
        @Override
        public int compare(DependencyMap d1, DependencyMap d2) {
            final Iterator i1 = sorted(d1.getElements()).iterator();
            final Iterator i2 = sorted(d2.getElements()).iterator();
            while (i1.hasNext() && i2.hasNext()) {
                final String s1 = i1.next();
                final String s2 = i2.next();
                final int c = s1.compareTo(s2);
                if (c != 0) {
                    return c;
                }
            }
            if (i1.hasNext()) {
                return 1;
            }
            if (i2.hasNext()) {
                return -1;
            }
            return 0;
        }
    }
}