com.github.ferstl.depgraph.dependency.dot.style.StyleConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of depgraph-maven-plugin Show documentation
This Maven plugin generates dependency graphs on single modules or in an aggregated form on multimodule projects. The graphs are represented by .dot files. In case that Graphviz is installed on the machine where this plugin is run, the .dot file can be directly converted into all supported image files.
The newest version!
/*
 * Copyright (c) 2014 - 2024 the original author or authors.
 *
 * 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 com.github.ferstl.depgraph.dependency.dot.style;

import java.io.IOException;
import java.io.InputStream;
import java.io.StringWriter;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Map.Entry;
import org.apache.maven.artifact.Artifact;
import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.ObjectReader;
import com.fasterxml.jackson.databind.PropertyNamingStrategy;
import com.fasterxml.jackson.databind.module.SimpleModule;
import com.github.ferstl.depgraph.dependency.NodeResolution;
import com.github.ferstl.depgraph.dependency.dot.style.resource.StyleResource;
import com.github.ferstl.depgraph.graph.dot.DotAttributeBuilder;
import static com.github.ferstl.depgraph.dependency.NodeResolution.INCLUDED;
import static com.github.ferstl.depgraph.dependency.NodeResolution.PARENT;

public class StyleConfiguration {

  private final Graph graph = new Graph();
  private AbstractNode defaultNode = new Box();
  private final Edge defaultEdge = new Edge();
  private final Map nodeStyles = new LinkedHashMap<>();
  private final Map edgeScopeStyles = new LinkedHashMap<>();
  private final Map edgeNodeStylesFrom = new LinkedHashMap<>();
  private final Map edgeNodeStylesTo = new LinkedHashMap<>();
  private final Map edgeResolutionStyles = new LinkedHashMap<>();


  public static StyleConfiguration load(StyleResource mainConfig, StyleResource... overrides) {
    ObjectMapper mapper = createObjectMapper();

    ObjectReader reader = mapper.readerFor(StyleConfiguration.class);
    StyleConfiguration styleConfiguration = readConfig(reader, mainConfig);
    for (StyleResource override : overrides) {
      StyleConfiguration overrideConfig = readConfig(reader, override);
      styleConfiguration.merge(overrideConfig);
    }

    return styleConfiguration;
  }

  private static ObjectMapper createObjectMapper() {
    SimpleModule module = new SimpleModule()
        .addKeySerializer(NodeResolution.class, new NodeResolutionSerializer())
        .addDeserializer(NodeResolution.class, new NodeResolutionDeserializer());

    return new ObjectMapper()
        .registerModule(module)
        .setPropertyNamingStrategy(PropertyNamingStrategy.KEBAB_CASE)
        .setSerializationInclusion(Include.NON_EMPTY)
        .setVisibility(PropertyAccessor.FIELD, Visibility.ANY);
  }

  private static StyleConfiguration readConfig(ObjectReader reader, StyleResource config) {
    try (InputStream is = config.openStream()) {
      return reader.readValue(is);
    } catch (JsonProcessingException e) {
      String message = String.format("Unable to read style configuration %s.\nLocation: line %s, column %s\nDetails: %s",
          config, e.getLocation().getLineNr(), e.getLocation().getColumnNr(), e.getOriginalMessage());

      throw new RuntimeException(message);
    } catch (IOException e) {
      throw new RuntimeException(e);
    }
  }

  public DotAttributeBuilder graphAttributes() {
    return this.graph.createAttributes();
  }

  public DotAttributeBuilder defaultNodeAttributes() {
    return this.defaultNode.createAttributes();
  }

  public DotAttributeBuilder defaultEdgeAttributes() {
    return this.defaultEdge.createAttributes();
  }

  public DotAttributeBuilder edgeAttributes(NodeResolution fromResolution, NodeResolution toResolution, String targetScope, Artifact from, Artifact to) {
    Edge edge;
    if (fromResolution == PARENT) {
      edge = this.edgeResolutionStyles.get(fromResolution);
    } else {
      edge = this.edgeResolutionStyles.get(toResolution);
    }

    // Scope style win over INCLUDED node resolution
    if (toResolution == INCLUDED && this.edgeScopeStyles.containsKey(targetScope)) {
      edge = this.edgeScopeStyles.get(targetScope);
    }

    // Specific edge style-from win over node resolution
    if (from != null) {
      StyleKey artifactKeyFrom = StyleKey.create(from.getGroupId(), from.getArtifactId(), from.getScope(), from.getType(), from.getVersion(), from.getClassifier(), from.isOptional());
      for (Entry entry : this.edgeNodeStylesFrom.entrySet()) {
        StyleKey styleKey = entry.getKey();
        if (styleKey.matches(artifactKeyFrom)) {
          edge = entry.getValue();
          break;
        }
      }
    }
    // Specific edge style-from to over node resolution
    if (to != null) {
      StyleKey artifactKeyTo = StyleKey.create(to.getGroupId(), to.getArtifactId(), to.getScope(), to.getType(), to.getVersion(), to.getClassifier(), to.isOptional());
      for (Entry entry : this.edgeNodeStylesTo.entrySet()) {
        StyleKey styleKey = entry.getKey();
        if (styleKey.matches(artifactKeyTo)) {
          edge = entry.getValue();
          break;
        }
      }
    }

    return edge != null ? edge.createAttributes() : new DotAttributeBuilder();
  }

  public DotAttributeBuilder nodeAttributes(StyleKey artifactKey, String groupId, String artifactId, String version, boolean isOptional, String types, String classifiers, String scopes) {
    AbstractNode node = this.defaultNode;

    for (Entry entry : this.nodeStyles.entrySet()) {
      StyleKey styleKey = entry.getKey();
      if (styleKey.matches(artifactKey)) {
        node = entry.getValue();
        break;
      }
    }

    return node.createAttributes(groupId, artifactId, version, isOptional, types, scopes, classifiers, node != this.defaultNode);
  }

  public String toJson() {
    ObjectMapper mapper = createObjectMapper();
    try {
      StringWriter w = new StringWriter();
      mapper.writerWithDefaultPrettyPrinter().writeValue(w, this);
      return w.toString();
    } catch (IOException e) {
      throw new RuntimeException(e.getMessage(), e);
    }
  }

  private void merge(StyleConfiguration other) {
    this.graph.merge(other.graph);
    // We have to deal with subclasses here. Hence the double merge.
    this.defaultNode.merge(other.defaultNode);
    other.defaultNode.merge(this.defaultNode);
    this.defaultNode = other.defaultNode;

    this.defaultEdge.merge(other.defaultEdge);

    for (Entry entry : other.nodeStyles.entrySet()) {
      StyleKey styleKey = entry.getKey();
      AbstractNode node = entry.getValue();

      if (this.nodeStyles.containsKey(styleKey)) {
        AbstractNode originalNode = this.nodeStyles.get(styleKey);
        // Double merge again
        originalNode.merge(node);
        node.merge(originalNode);
        this.nodeStyles.put(styleKey, node);
      } else {
        this.nodeStyles.put(styleKey, node);
      }
    }

    for (Entry entry : other.edgeResolutionStyles.entrySet()) {
      NodeResolution resolution = entry.getKey();
      Edge edge = entry.getValue();

      if (this.edgeResolutionStyles.containsKey(resolution)) {
        this.edgeResolutionStyles.get(resolution).merge(edge);
      } else {
        this.edgeResolutionStyles.put(resolution, edge);
      }
    }

    for (Entry entry : other.edgeScopeStyles.entrySet()) {
      String scope = entry.getKey();
      Edge edge = entry.getValue();

      if (this.edgeScopeStyles.containsKey(scope)) {
        this.edgeScopeStyles.get(scope).merge(edge);
      } else {
        this.edgeScopeStyles.put(scope, edge);
      }
    }

    for (Entry entry : other.edgeNodeStylesFrom.entrySet()) {
      StyleKey styleKey = entry.getKey();
      Edge edge = entry.getValue();

      if (this.edgeNodeStylesFrom.containsKey(styleKey)) {
        this.edgeNodeStylesFrom.get(styleKey).merge(edge);
      } else {
        this.edgeNodeStylesFrom.put(styleKey, edge);
      }
    }

    for (Entry entry : other.edgeNodeStylesTo.entrySet()) {
      StyleKey styleKey = entry.getKey();
      Edge edge = entry.getValue();

      if (this.edgeNodeStylesTo.containsKey(styleKey)) {
        this.edgeNodeStylesTo.get(styleKey).merge(edge);
      } else {
        this.edgeNodeStylesTo.put(styleKey, edge);
      }
    }
  }

}