An_ExtendedXmlAnalyzer.java

package de.is24.deadcode4j.analyzer;

import com.google.common.base.Optional;
import org.junit.Test;

import javax.annotation.Nonnull;
import java.util.Map;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.contains;
import static org.hamcrest.Matchers.is;

public final class An_ExtendedXmlAnalyzer extends AnAnalyzer<ExtendedXmlAnalyzer> {

    @Override
    protected ExtendedXmlAnalyzer createAnalyzer() {
        return new ExtendedXmlAnalyzer("junit", ".xml") {
        };
    }

    @Test
    public void usesTheSpecifiedDependerIdToReportDependencies() {
        objectUnderTest.anyElementNamed("elementWithClass").registerTextAsClass();

        analyzeFile("de/is24/deadcode4j/analyzer/some.xml");

        Map<String, ? extends Iterable<String>> codeDependencies = analysisContext.getAnalyzedCode().getCodeDependencies();
        assertThat("Should have analyzed the XML file!", codeDependencies.size(), is(1));
        assertThat(codeDependencies.keySet(), contains("junit"));
    }

    @Test
    public void reportsTheClassFoundForTheRegisteredElement() {
        objectUnderTest.anyElementNamed("elementWithClass").registerTextAsClass();

        analyzeFile("de/is24/deadcode4j/analyzer/some.xml");

        assertThatDependenciesAreReported("de.is24.deadcode4j.ClassInElement");
    }

    @Test
    public void ignoresFilesWithNonMatchingRootElement() {
        objectUnderTest = new ExtendedXmlAnalyzer("junit", ".xml", "acme") {
        };
        objectUnderTest.anyElementNamed("elementWithClass").registerTextAsClass();

        analyzeFile("de/is24/deadcode4j/analyzer/some.xml");

        assertThatNoDependenciesAreReported();
    }

    @Test
    public void reportsTheClassFoundForElementsInVariousPaths() {
        objectUnderTest.anyElementNamed("nestedElementWithClass").registerTextAsClass();

        analyzeFile("de/is24/deadcode4j/analyzer/some.xml");

        assertThatDependenciesAreReported("de.is24.deadcode4j.ClassInElement",
                "de.is24.deadcode4j.ClassInNestedElement");
    }

    @Test
    public void reportsNothingIfElementHasNoText() {
        objectUnderTest.anyElementNamed("emptyElement").registerTextAsClass();

        analyzeFile("de/is24/deadcode4j/analyzer/some.xml");

        assertThatNoDependenciesAreReported();
    }

    @Test
    public void reportsTheClassFoundForTheRegisteredAttribute() {
        objectUnderTest.anyElementNamed("element").registerAttributeAsClass("attributeWithClass");

        analyzeFile("de/is24/deadcode4j/analyzer/some.xml");

        assertThatDependenciesAreReported("de.is24.deadcode4j.ClassInAttribute");
    }

    @Test
    public void reportsAllClassesFoundForTheRegisteredAttribute() {
        objectUnderTest.anyElement().registerAttributeAsClass("attributeWithClass");

        analyzeFile("de/is24/deadcode4j/analyzer/some.xml");

        assertThatDependenciesAreReported(
                "de.is24.deadcode4j.ClassInAttribute",
                "de.is24.deadcode4j.ClassInAttributeOfOtherElement",
                "de.is24.deadcode4j.LockedClassInAttribute",
                "de.is24.deadcode4j.OtherUnlockedClassInAttribute",
                "de.is24.deadcode4j.UnlockedClassInAttribute");
    }

    @Test
    public void reportsAllTextAsFoundClasses() {
        objectUnderTest.anyElement().registerTextAsClass();

        analyzeFile("de/is24/deadcode4j/analyzer/some.xml");

        assertThatDependenciesAreReported(
                "de.is24.deadcode4j.ClassInElement",
                "de.is24.deadcode4j.ClassInNestedElement",
                "de.is24.deadcode4j.FirstClassInAnotherElement",
                "de.is24.deadcode4j.LockedClassInElement",
                "de.is24.deadcode4j.LockedClassInNestedElement",
                "de.is24.deadcode4j.SecondClassInAnotherElement",
                "de.is24.deadcode4j.UnlockedClassInElement",
                "de.is24.deadcode4j.UnlockedClassInLockedNestedElement",
                "de.is24.deadcode4j.UnlockedClassInUnlockedNestedElement");
    }

    @Test
    public void reportsClassesForDifferentRegistrations() {
        objectUnderTest.anyElementNamed("elementWithClass").registerTextAsClass();
        objectUnderTest.anyElementNamed("anotherElementWithClass").registerTextAsClass();
        objectUnderTest.anyElementNamed("element").registerAttributeAsClass("attributeWithClass");

        analyzeFile("de/is24/deadcode4j/analyzer/some.xml");

        assertThatDependenciesAreReported(
                "de.is24.deadcode4j.ClassInElement",
                "de.is24.deadcode4j.FirstClassInAnotherElement",
                "de.is24.deadcode4j.SecondClassInAnotherElement",
                "de.is24.deadcode4j.ClassInAttribute");
    }

    @Test
    public void parsesXmlFilesUsingNamespacePrefixes() {
        objectUnderTest.anyElementNamed("elementWithClass").registerTextAsClass();
        objectUnderTest.anyElementNamed("anotherElementWithClass").registerTextAsClass();
        objectUnderTest.anyElementNamed("element").registerAttributeAsClass("attributeWithClass");

        analyzeFile("de/is24/deadcode4j/analyzer/prefixed.xml");

        assertThatDependenciesAreReported(
                "de.is24.deadcode4j.ClassInElement",
                "de.is24.deadcode4j.FirstClassInAnotherElement",
                "de.is24.deadcode4j.SecondClassInAnotherElement",
                "de.is24.deadcode4j.ClassInAttribute");
    }

    @Test
    public void reportsTheClassFound_ForTheRegisteredElement_HavingASpecificAttributeValue() {
        objectUnderTest.anyElementNamed("restrictedElement").withAttributeValue("locked", "false").registerTextAsClass();

        analyzeFile("de/is24/deadcode4j/analyzer/some.xml");

        assertThatDependenciesAreReported("de.is24.deadcode4j.UnlockedClassInElement");
    }

    @Test
    public void reportsAllClassesFound_HavingASpecificAttributeValue() {
        objectUnderTest.anyElement().withAttributeValue("locked", "false").registerTextAsClass();

        analyzeFile("de/is24/deadcode4j/analyzer/some.xml");

        assertThatDependenciesAreReported(
                "de.is24.deadcode4j.UnlockedClassInElement",
                "de.is24.deadcode4j.UnlockedClassInUnlockedNestedElement");
    }

    @Test
    public void reportsTheClassFound_ForTheRegisteredAttribute_HavingASpecificAttributeValue() {
        objectUnderTest.anyElementNamed("restrictedElement").withAttributeValue("locked", "false").registerAttributeAsClass("attributeWithClass");

        analyzeFile("de/is24/deadcode4j/analyzer/some.xml");

        assertThatDependenciesAreReported("de.is24.deadcode4j.UnlockedClassInAttribute");
    }

    @Test
    public void reportsAllClassesFound_ForTheRegisteredAttribute_HavingASpecificAttributeValue() {
        objectUnderTest.anyElement().withAttributeValue("locked", "false").registerAttributeAsClass("attributeWithClass");

        analyzeFile("de/is24/deadcode4j/analyzer/some.xml");

        assertThatDependenciesAreReported(
                "de.is24.deadcode4j.OtherUnlockedClassInAttribute",
                "de.is24.deadcode4j.UnlockedClassInAttribute");
    }

    @Test
    public void reportsTheClassesFound_ForTheRegisteredElementAndForTheRegisteredAttribute_BothHavingASpecificAttributeValue() {
        objectUnderTest.anyElementNamed("restrictedElement").withAttributeValue("locked", "false").registerTextAsClass();
        objectUnderTest.anyElementNamed("restrictedElement").withAttributeValue("locked", "false").registerAttributeAsClass("attributeWithClass");

        analyzeFile("de/is24/deadcode4j/analyzer/some.xml");

        assertThatDependenciesAreReported(
                "de.is24.deadcode4j.UnlockedClassInAttribute",
                "de.is24.deadcode4j.UnlockedClassInElement");
    }

    @Test
    public void reportsTheClassFoundForANestedElement() {
        objectUnderTest.anyElementNamed("parentElement").anyElementNamed("nestedElementWithClass").registerTextAsClass();

        analyzeFile("de/is24/deadcode4j/analyzer/some.xml");

        assertThatDependenciesAreReported("de.is24.deadcode4j.ClassInNestedElement");
    }

    @Test
    public void reportsTheClassFoundForANestedElement_WithPathHavingASpecificAttributeValue() {
        objectUnderTest.anyElementNamed("restrictedElement").withAttributeValue("locked", "false").anyElementNamed("nestedElementInRestriction").registerTextAsClass();

        analyzeFile("de/is24/deadcode4j/analyzer/some.xml");

        assertThatDependenciesAreReported("de.is24.deadcode4j.UnlockedClassInUnlockedNestedElement",
                "de.is24.deadcode4j.UnlockedClassInLockedNestedElement");
    }

    @Test
    public void reportsTheClassFoundForANestedElement_WithPathHavingSpecificAttributes() {
        objectUnderTest.anyElementNamed("restrictedElement").withAttributeValue("locked", "false").
                anyElementNamed("nestedElementInRestriction").withAttributeValue("locked", "false").registerTextAsClass();

        analyzeFile("de/is24/deadcode4j/analyzer/some.xml");

        assertThatDependenciesAreReported("de.is24.deadcode4j.UnlockedClassInUnlockedNestedElement");
    }

    @Test
    public void reportsNothingIfPathDoesNotMatchAttributeValue() {
        objectUnderTest.anyElementNamed("parentElement").withAttributeValue("foo", "bar").anyElementNamed("nestedElementWithClass").registerTextAsClass();

        analyzeFile("de/is24/deadcode4j/analyzer/some.xml");

        assertThatNoDependenciesAreReported();
    }

    @Test
    public void reportsResultOfRegisteredDependeeExtractor() {
        objectUnderTest.anyElementNamed("restrictedElement").withAttributeValue("locked", "false").registerDependeeExtractor(new ExtendedXmlAnalyzer.DependeeExtractor() {
            @Nonnull
            @Override
            public Optional<String> extractDependee(@Nonnull Iterable<ExtendedXmlAnalyzer.XmlElement> xmlElements, @Nonnull Optional<String> containedText) {
                return Optional.of("foo");
            }
        });

        analyzeFile("de/is24/deadcode4j/analyzer/some.xml");

        assertThatDependenciesAreReported("foo");
    }

}