You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by sl...@apache.org on 2021/06/07 20:27:37 UTC
[maven-dependency-plugin] branch MDEP-435 updated (6edba0f ->
c518d6f)
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a change to branch MDEP-435
in repository https://gitbox.apache.org/repos/asf/maven-dependency-plugin.git.
discard 6edba0f [MDEP-435] Added xml option to outputType
new c518d6f [MDEP-435] Added xml option to outputType
This update added new revisions after undoing existing revisions.
That is to say, some revisions that were in the old version of the
branch are not in the new version. This situation occurs
when a user --force pushes a change and generates a repository
containing something like this:
* -- * -- B -- O -- O -- O (6edba0f)
\
N -- N -- N refs/heads/MDEP-435 (c518d6f)
You should already have received notification emails for all of the O
revisions, and so the following emails describe only the N revisions
from the common base, B.
Any revisions marked "omit" are not gone; other references still
refer to them. Any revisions marked "discard" are gone forever.
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../dependency/tree/XMLDependencyNodeVisitor.java | 37 ++++++++--------------
1 file changed, 13 insertions(+), 24 deletions(-)
[maven-dependency-plugin] 01/01: [MDEP-435] Added xml option to
outputType
Posted by sl...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch MDEP-435
in repository https://gitbox.apache.org/repos/asf/maven-dependency-plugin.git
commit c518d6f9c43bfa8292e52e93c44e2f8b568474af
Author: Bogdan Sikora <si...@protonmail.com>
AuthorDate: Fri Nov 8 14:13:07 2019 +0100
[MDEP-435] Added xml option to outputType
---
.../maven/plugins/dependency/tree/TreeMojo.java | 14 +-
.../dependency/tree/XMLDependencyNodeVisitor.java | 176 +++++++++++++++++++++
2 files changed, 188 insertions(+), 2 deletions(-)
diff --git a/src/main/java/org/apache/maven/plugins/dependency/tree/TreeMojo.java b/src/main/java/org/apache/maven/plugins/dependency/tree/TreeMojo.java
index e2073c1..515d118 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/tree/TreeMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/tree/TreeMojo.java
@@ -137,8 +137,14 @@ public class TreeMojo
/**
* If specified, this parameter will cause the dependency tree to be written using the specified format. Currently
- * supported format are: <code>text</code> (default), <code>dot</code>, <code>graphml</code> and <code>tgf</code>.
- * These additional formats can be plotted to image files.
+ * supported format are:
+ * <ul>
+ * <li>text (default)</li>
+ * <li>dot</li>
+ * <li>graphml</li>
+ * <li>tgf</li>
+ * <li>xml</li>
+ * </ul>
*
* @since 2.2
*/
@@ -502,6 +508,10 @@ public class TreeMojo
{
return new DOTDependencyNodeVisitor( writer );
}
+ else if ( "xml".equals( outputType ) )
+ {
+ return new XMLDependencyNodeVisitor( writer );
+ }
else
{
return new SerializingDependencyNodeVisitor( writer, toGraphTokens( tokens ) );
diff --git a/src/main/java/org/apache/maven/plugins/dependency/tree/XMLDependencyNodeVisitor.java b/src/main/java/org/apache/maven/plugins/dependency/tree/XMLDependencyNodeVisitor.java
new file mode 100644
index 0000000..93bcd93
--- /dev/null
+++ b/src/main/java/org/apache/maven/plugins/dependency/tree/XMLDependencyNodeVisitor.java
@@ -0,0 +1,176 @@
+package org.apache.maven.plugins.dependency.tree;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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.
+ */
+
+import javax.xml.parsers.DocumentBuilder;
+import javax.xml.parsers.DocumentBuilderFactory;
+import javax.xml.parsers.ParserConfigurationException;
+import javax.xml.transform.OutputKeys;
+import javax.xml.transform.Transformer;
+import javax.xml.transform.TransformerException;
+import javax.xml.transform.TransformerFactory;
+import javax.xml.transform.dom.DOMSource;
+import javax.xml.transform.stream.StreamResult;
+
+import org.apache.maven.artifact.Artifact;
+import org.apache.maven.shared.dependency.graph.DependencyNode;
+import org.apache.maven.shared.dependency.graph.traversal.DependencyNodeVisitor;
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+import org.w3c.dom.Node;
+import java.io.Writer;
+import java.util.List;
+import org.slf4j.LoggerFactory;
+
+/**
+ * A dependency node visitor that serializes visited nodes to
+ * <a href="https://en.wikipedia.org/wiki/XML">XML format</a>
+ *
+ * @author <a href="mailto:sikora.bogdan@webscope.io">Bogdan Sikora</a>
+ * @since 3.2.1
+ */
+public class XMLDependencyNodeVisitor
+ extends AbstractSerializingVisitor
+ implements DependencyNodeVisitor
+{
+ /**
+ * Constructor.
+ *
+ * @param writer the writer to write to.
+ */
+ public XMLDependencyNodeVisitor( Writer writer )
+ {
+ super( writer );
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public boolean visit( DependencyNode node )
+ {
+ try
+ {
+ if ( node.getParent() == null || node.getParent() == node )
+ {
+ DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance();
+ DocumentBuilder dBuilder = dbFactory.newDocumentBuilder();
+ Document doc = dBuilder.newDocument();
+ Element rootElement = getNode( doc, node, true );
+ doc.appendChild( rootElement );
+
+ List<DependencyNode> children = node.getChildren();
+ for ( DependencyNode child : children )
+ {
+ handleChild( doc, child, rootElement );
+ }
+
+ TransformerFactory transformerFactory = TransformerFactory.newInstance();
+ Transformer transformer = transformerFactory.newTransformer();
+ transformer.setOutputProperty( OutputKeys.INDENT, "yes" );
+ transformer.setOutputProperty( "{http://xml.apache.org/xslt}indent-amount", "2" );
+ DOMSource source = new DOMSource( doc );
+
+ StreamResult console = new StreamResult( writer );
+
+ transformer.transform( source, console );
+ }
+ }
+ catch ( ParserConfigurationException | TransformerException e )
+ {
+ LoggerFactory.getLogger( XMLDependencyNodeVisitor.class ).error( e.getMessage() );
+ }
+
+ return true;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public boolean endVisit( DependencyNode node )
+ {
+ return true;
+ }
+
+ /**
+ * Render child with its children recursively
+ *
+ * @param doc Docuemnt to use
+ * @param node child node to handle
+ * @param parent parent of the child
+ */
+ private void handleChild( Document doc, DependencyNode node, Element parent )
+ {
+ Element element = getNode( doc, node, false );
+ Node dependencies = parent.getElementsByTagName( "dependencies" ).item( 0 );
+ dependencies.appendChild( element );
+
+ for ( DependencyNode child : node.getChildren() )
+ {
+ handleChild( doc, child, element );
+ }
+ }
+
+ /**
+ * Get element from node
+ *
+ * @param doc Docuemnt to use
+ * @param node Node to get data from
+ */
+ private Element getNode( Document doc, DependencyNode node, boolean root )
+ {
+ Artifact artifact = node.getArtifact();
+ Element element = doc.createElement( root ? "project" : "dependency" );
+
+ Element groupId = doc.createElement( "groupId" );
+ groupId.setTextContent( artifact.getGroupId() );
+ element.appendChild( groupId );
+
+ Element artifactId = doc.createElement( "artifactId" );
+ artifactId.setTextContent( artifact.getArtifactId() );
+ element.appendChild( artifactId );
+
+ Element version = doc.createElement( "version" );
+ version.setTextContent( artifact.getVersion() );
+ element.appendChild( version );
+
+ if ( root )
+ {
+ Element packaging = doc.createElement( "packaging" );
+ packaging.setTextContent( artifact.getType() );
+ element.appendChild( packaging );
+ }
+ else
+ {
+ Element scope = doc.createElement( "scope" );
+ scope.setTextContent( artifact.getScope() );
+ element.appendChild( scope );
+
+ Element type = doc.createElement( "type" );
+ type.setTextContent( artifact.getType() );
+ element.appendChild( type );
+ }
+
+ element.appendChild( doc.createElement( "dependencies" ) );
+
+ return element;
+ }
+}