net.kemitix.pdg.maven.DotFileFormatNested Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pdg-maven-plugin Show documentation
Generates a DOT Digraph of dependencies between packages within a project
The newest version!
/**
 * The MIT License (MIT)
 *
 * Copyright (c) 2018 Paul Campbell
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
 * and associated documentation files (the "Software"), to deal in the Software without restriction,
 * including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies
 * or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
 * AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package net.kemitix.pdg.maven;

import net.kemitix.pdg.maven.digraph.EdgeElement;
import net.kemitix.pdg.maven.digraph.NodeElement;
import net.kemitix.pdg.maven.digraph.Subgraph;
import net.kemitix.node.Node;

import javax.annotation.concurrent.Immutable;
import java.util.ArrayList;
import java.util.List;

/**
 * Generates a dot file dependency report as nested clusters.
 *
 * @author Paul Campbell ([email protected])
 */
@Immutable
class DotFileFormatNested extends AbstractDotFileFormat {

    private static final String LINE = System.lineSeparator();

    /**
     * Constructor.
     *
     * @param base              The root node
     * @param nodePathGenerator The Node Path Generator
     * @param graphFilter       The Graph Filter
     */
    DotFileFormatNested(
            final Node base, final NodePathGenerator nodePathGenerator, final GraphFilter graphFilter
                       ) {
        super(base, nodePathGenerator, graphFilter);
    }

    private void addAnyLHead(
            final Node headNode,
            final Node tailNode,
            final List attributes
                            ) {
        // if head node has children, then add lhead attribute
        if (hasChildren(headNode) && isNotDescendant(headNode, tailNode)) {
            attributes.add(String.format("lhead=\"cluster%s\"", getClusterId(headNode)));
        }
    }

    private void addAnyLTail(
            final Node tailNode,
            final Node headNode,
            final List attributes
                            ) {
        // if tail node has children, then add ltail attribute
        if (hasChildren(tailNode) && isNotDescendant(tailNode, headNode)) {
            attributes.add(String.format("ltail=\"cluster%s\"", getClusterId(tailNode)));
        }
    }

    private boolean isNotDescendant(
            final Node childNode,
            final Node parentNode
    ) {
        return !parentNode.isDescendantOf(childNode);
    }

    private boolean hasChildren(final Node packageDataNode) {
        return !packageDataNode.getChildren().isEmpty();
    }

    private String buildAttributeTag(final List attributes) {
        String attributeTag = "";
        if (attributes.size() > 0) {
            attributeTag = String.format(
                    "[%s]", String.join(",", attributes));
        }
        return attributeTag;
    }

    @Override
    public String render(final Subgraph subgraph) {
        final String label = quoted(subgraph.getLabel());
        final String id = quoted(subgraph.getId());
        return String.format(
                "subgraph %s{" + LINE + "label=%s" + LINE + "%s[label=\"\",style=\"invis\",width=0]" + LINE + "%s"
                + LINE + "}", quoted("cluster" + subgraph.getId()), label, id, renderElements(subgraph.getElements()));
    }

    @Override
    public String render(
            final EdgeElement edgeElement
                        ) {
        List attributes = new ArrayList<>();
        final Node tailNode = edgeElement.getTail()
                                                      .getPackageDataNode();
        final Node headNode = edgeElement.getHead()
                                                      .getPackageDataNode();
        addAnyLTail(tailNode, headNode, attributes);
        addAnyLHead(headNode, tailNode, attributes);
        String attributeTag = buildAttributeTag(attributes);
        return String.format("%s->%s%s", quoted(getNodeId(tailNode)), quoted(getNodeId(headNode)), attributeTag);
    }

    @Override
    public final String render(final NodeElement nodeElement) {
        final String id = nodeElement.getId();
        final String label = nodeElement.getLabel();
        if (id.equals(label)) {
            return quoted(id);
        } else {
            return quoted(id) + "[label=" + quoted(label) + CLOSE_BRACE;
        }
    }

}