You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by vs...@apache.org on 2008/07/10 14:32:42 UTC

svn commit: r675547 - in /maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo: ./ dependencies/ dependencies/renderer/

Author: vsiveton
Date: Thu Jul 10 05:32:41 2008
New Revision: 675547

URL: http://svn.apache.org/viewvc?rev=675547&view=rev
Log:
MPIR-118: Equalize links to project web site for artifactId 

o used the link pattern {text, url} for all artifactId in the generated tables

Added:
    maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/ArtifactUtils.java   (with props)
Modified:
    maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/DependenciesReport.java
    maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/DependencyManagementReport.java
    maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/renderer/DependenciesRenderer.java
    maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/renderer/DependencyManagementRenderer.java
    maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/renderer/PluginManagementRenderer.java

Modified: maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/DependenciesReport.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/DependenciesReport.java?rev=675547&r1=675546&r2=675547&view=diff
==============================================================================
--- maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/DependenciesReport.java (original)
+++ maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/DependenciesReport.java Thu Jul 10 05:32:41 2008
@@ -43,6 +43,7 @@
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.io.LineNumberReader;
+import java.util.List;
 import java.util.Locale;
 
 /**
@@ -141,6 +142,14 @@
      */
     private boolean dependencyLocationsEnabled;
 
+    /**
+     * Remote repositories used for the project.
+     *
+     * @since 2.1
+     * @parameter expression="${project.remoteArtifactRepositories}"
+     */
+    private List remoteRepositories;
+
     // ----------------------------------------------------------------------
     // Public methods
     // ----------------------------------------------------------------------
@@ -180,8 +189,9 @@
         DependenciesReportConfiguration config =
             new DependenciesReportConfiguration( dependencyDetailsEnabled, dependencyLocationsEnabled );
 
-        DependenciesRenderer r =
-            new DependenciesRenderer( getSink(), locale, i18n, dependencies, dependencyTreeNode, config, repoUtils );
+        DependenciesRenderer r = new DependenciesRenderer( getSink(), locale, i18n, dependencies, dependencyTreeNode,
+                                                           config, repoUtils, mavenProjectBuilder, remoteRepositories,
+                                                           localRepository );
 
         repoUtils.setLog( getLog() );
         r.setLog( getLog() );

Modified: maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/DependencyManagementReport.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/DependencyManagementReport.java?rev=675547&r1=675546&r2=675547&view=diff
==============================================================================
--- maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/DependencyManagementReport.java (original)
+++ maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/DependencyManagementReport.java Thu Jul 10 05:32:41 2008
@@ -19,8 +19,11 @@
  * under the License.
  */
 
+import java.util.List;
 import java.util.Locale;
 
+import org.apache.maven.artifact.factory.ArtifactFactory;
+import org.apache.maven.project.MavenProjectBuilder;
 import org.apache.maven.report.projectinfo.dependencies.ManagementDependencies;
 import org.apache.maven.report.projectinfo.dependencies.renderer.DependencyManagementRenderer;
 
@@ -38,6 +41,36 @@
     extends AbstractProjectInfoReport
 {
     // ----------------------------------------------------------------------
+    // Mojo components
+    // ----------------------------------------------------------------------
+
+    /**
+     * Maven Project Builder component.
+     *
+     * @component
+     */
+    private MavenProjectBuilder mavenProjectBuilder;
+
+    /**
+     * Maven Artifact Factory component.
+     *
+     * @component
+     */
+    private ArtifactFactory artifactFactory;
+
+    // ----------------------------------------------------------------------
+    // Mojo parameters
+    // ----------------------------------------------------------------------
+
+    /**
+     * Remote repositories used for the project.
+     *
+     * @since 2.1
+     * @parameter expression="${project.remoteArtifactRepositories}"
+     */
+    private List remoteRepositories;
+
+    // ----------------------------------------------------------------------
     // Public methods
     // ----------------------------------------------------------------------
 
@@ -60,7 +93,9 @@
         ManagementDependencies dependencies =
             new ManagementDependencies( project.getDependencyManagement().getDependencies() );
 
-        DependencyManagementRenderer r = new DependencyManagementRenderer( getSink(), locale, i18n, dependencies );
+        DependencyManagementRenderer r = new DependencyManagementRenderer( getSink(), locale, i18n, dependencies,
+                                                                           artifactFactory, mavenProjectBuilder,
+                                                                           remoteRepositories, localRepository );
 
         r.setLog( getLog() );
         r.render();

Added: maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/ArtifactUtils.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/ArtifactUtils.java?rev=675547&view=auto
==============================================================================
--- maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/ArtifactUtils.java (added)
+++ maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/ArtifactUtils.java Thu Jul 10 05:32:41 2008
@@ -0,0 +1,86 @@
+package org.apache.maven.report.projectinfo.dependencies;
+
+/*
+ * 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 java.util.List;
+
+import org.apache.commons.validator.UrlValidator;
+import org.apache.maven.artifact.Artifact;
+import org.apache.maven.artifact.repository.ArtifactRepository;
+import org.apache.maven.project.MavenProject;
+import org.apache.maven.project.MavenProjectBuilder;
+import org.apache.maven.project.ProjectBuildingException;
+import org.apache.maven.reporting.AbstractMavenReportRenderer;
+import org.codehaus.plexus.util.StringUtils;
+
+/**
+ * Utility methods around the <code>Artifact</code>.
+ *
+ * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
+ * @version $Id$
+ */
+public class ArtifactUtils
+{
+    private static final UrlValidator URL_VALIDATOR = new UrlValidator( new String[] { "http", "https" } );
+
+    /**
+     * @param artifact not null
+     * @param mavenProjectBuilder not null
+     * @param remoteRepositories not null
+     * @param localRepository not null
+     * @return the artifact url or null if an error occurred.
+     */
+    public static String getArtifactUrl( Artifact artifact, MavenProjectBuilder mavenProjectBuilder,
+                                         List remoteRepositories, ArtifactRepository localRepository )
+    {
+        try
+        {
+            MavenProject pluginProject = mavenProjectBuilder.buildFromRepository( artifact, remoteRepositories,
+                                                                                  localRepository );
+
+            if ( URL_VALIDATOR.isValid( pluginProject.getUrl() ) )
+            {
+                return pluginProject.getUrl();
+            }
+
+            return null;
+        }
+        catch ( ProjectBuildingException e )
+        {
+            return null;
+        }
+    }
+
+    /**
+     * @param artifactId not null
+     * @param link could be null
+     * @return the artifactId cell with or without a link pattern
+     * @see {@link AbstractMavenReportRenderer#linkPatternedText(String)}
+     */
+    public static String getArtifactIdCell( String artifactId, String link )
+    {
+        if ( StringUtils.isEmpty( link ) )
+        {
+            return artifactId;
+        }
+
+        return "{" + artifactId + "," + link + "}";
+    }
+}

Propchange: maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/ArtifactUtils.java
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/ArtifactUtils.java
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision

Modified: maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/renderer/DependenciesRenderer.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/renderer/DependenciesRenderer.java?rev=675547&r1=675546&r2=675547&view=diff
==============================================================================
--- maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/renderer/DependenciesRenderer.java (original)
+++ maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/renderer/DependenciesRenderer.java Thu Jul 10 05:32:41 2008
@@ -44,9 +44,11 @@
 import org.apache.maven.model.License;
 import org.apache.maven.plugin.logging.Log;
 import org.apache.maven.project.MavenProject;
+import org.apache.maven.project.MavenProjectBuilder;
 import org.apache.maven.project.ProjectBuildingException;
 import org.apache.maven.report.projectinfo.dependencies.Dependencies;
 import org.apache.maven.report.projectinfo.dependencies.DependenciesReportConfiguration;
+import org.apache.maven.report.projectinfo.dependencies.ArtifactUtils;
 import org.apache.maven.report.projectinfo.dependencies.RepositoryUtils;
 import org.apache.maven.reporting.AbstractMavenReportRenderer;
 import org.apache.maven.shared.dependency.tree.DependencyNode;
@@ -106,6 +108,12 @@
         }
     };
 
+    private final MavenProjectBuilder mavenProjectBuilder;
+
+    private final List remoteRepositories;
+
+    private final ArtifactRepository localRepository;
+
     static
     {
         JAR_SUBTYPE.add( "jar" );
@@ -136,10 +144,14 @@
      * @param dependencyTreeNode
      * @param config
      * @param repoUtils
+     * @param mavenProjectBuilder
+     * @param remoteRepositories
+     * @param localRepository
      */
     public DependenciesRenderer( Sink sink, Locale locale, I18N i18n, Dependencies dependencies,
                                  DependencyNode dependencyTreeNode, DependenciesReportConfiguration config,
-                                 RepositoryUtils repoUtils )
+                                 RepositoryUtils repoUtils, MavenProjectBuilder mavenProjectBuilder,
+                                 List remoteRepositories, ArtifactRepository localRepository )
     {
         super( sink );
 
@@ -154,6 +166,12 @@
         this.i18n = i18n;
 
         this.configuration = config;
+
+        this.mavenProjectBuilder = mavenProjectBuilder;
+
+        this.remoteRepositories = remoteRepositories;
+
+        this.localRepository = localRepository;
     }
 
     // ----------------------------------------------------------------------
@@ -830,13 +848,16 @@
         String isOptional = artifact.isOptional() ? getReportString( "report.dependencies.column.isOptional" )
             : getReportString( "report.dependencies.column.isNotOptional" );
 
+        String url = ArtifactUtils.getArtifactUrl( artifact, mavenProjectBuilder, remoteRepositories, localRepository );
+        String artifactIdCell = ArtifactUtils.getArtifactIdCell( artifact.getArtifactId(), url );
+
         if ( withClassifier )
         {
             if ( withOptional )
             {
                 return new String[] {
                     artifact.getGroupId(),
-                    artifact.getArtifactId(),
+                    artifactIdCell,
                     artifact.getVersion(),
                     artifact.getClassifier(),
                     artifact.getType(),
@@ -845,7 +866,7 @@
 
             return new String[] {
                 artifact.getGroupId(),
-                artifact.getArtifactId(),
+                artifactIdCell,
                 artifact.getVersion(),
                 artifact.getClassifier(),
                 artifact.getType() };
@@ -855,7 +876,7 @@
         {
             return new String[] {
                 artifact.getGroupId(),
-                artifact.getArtifactId(),
+                artifactIdCell,
                 artifact.getVersion(),
                 artifact.getType(),
                 isOptional };
@@ -863,7 +884,7 @@
 
         return new String[] {
             artifact.getGroupId(),
-            artifact.getArtifactId(),
+            artifactIdCell,
             artifact.getVersion(),
             artifact.getType()};
     }

Modified: maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/renderer/DependencyManagementRenderer.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/renderer/DependencyManagementRenderer.java?rev=675547&r1=675546&r2=675547&view=diff
==============================================================================
--- maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/renderer/DependencyManagementRenderer.java (original)
+++ maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/renderer/DependencyManagementRenderer.java Thu Jul 10 05:32:41 2008
@@ -27,9 +27,13 @@
 import java.util.Map;
 
 import org.apache.maven.artifact.Artifact;
+import org.apache.maven.artifact.factory.ArtifactFactory;
+import org.apache.maven.artifact.repository.ArtifactRepository;
 import org.apache.maven.doxia.sink.Sink;
 import org.apache.maven.model.Dependency;
 import org.apache.maven.plugin.logging.Log;
+import org.apache.maven.project.MavenProjectBuilder;
+import org.apache.maven.report.projectinfo.dependencies.ArtifactUtils;
 import org.apache.maven.report.projectinfo.dependencies.ManagementDependencies;
 import org.apache.maven.reporting.AbstractMavenReportRenderer;
 import org.codehaus.plexus.i18n.I18N;
@@ -51,7 +55,28 @@
 
     private Log log;
 
-    public DependencyManagementRenderer( Sink sink, Locale locale, I18N i18n, ManagementDependencies dependencies )
+    private final ArtifactFactory artifactFactory;
+
+    private final MavenProjectBuilder mavenProjectBuilder;
+
+    private final List remoteRepositories;
+
+    private final ArtifactRepository localRepository;
+
+    /**
+     * Default constructor
+     *
+     * @param sink
+     * @param locale
+     * @param i18n
+     * @param artifactFactory
+     * @param dependencies
+     * @param mavenProjectBuilder
+     * @param remoteRepositories
+     * @param localRepository
+     */
+    public DependencyManagementRenderer( Sink sink, Locale locale, I18N i18n, ManagementDependencies dependencies, ArtifactFactory artifactFactory, MavenProjectBuilder mavenProjectBuilder,
+                                         List remoteRepositories, ArtifactRepository localRepository )
     {
         super( sink );
 
@@ -61,6 +86,13 @@
 
         this.i18n = i18n;
 
+        this.artifactFactory = artifactFactory;
+
+        this.mavenProjectBuilder = mavenProjectBuilder;
+
+        this.remoteRepositories = remoteRepositories;
+
+        this.localRepository = localRepository;
     }
 
     // ----------------------------------------------------------------------
@@ -179,13 +211,18 @@
 
     private String[] getDependencyRow( Dependency dependency, boolean hasClassifier )
     {
+        Artifact artifact = artifactFactory.createParentArtifact( dependency.getGroupId(), dependency.getArtifactId(),
+                                                                  dependency.getVersion() );
+        String url = ArtifactUtils.getArtifactUrl( artifact, mavenProjectBuilder, remoteRepositories, localRepository );
+        String artifactIdCell = ArtifactUtils.getArtifactIdCell( artifact.getArtifactId(), url );
+
         if ( hasClassifier )
         {
-            return new String[] { dependency.getGroupId(), dependency.getArtifactId(), dependency.getVersion(),
+            return new String[] { dependency.getGroupId(), artifactIdCell, dependency.getVersion(),
                 dependency.getClassifier(), dependency.getType() };
         }
 
-        return new String[] { dependency.getGroupId(), dependency.getArtifactId(), dependency.getVersion(),
+        return new String[] { dependency.getGroupId(), artifactIdCell, dependency.getVersion(),
             dependency.getType() };
     }
 

Modified: maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/renderer/PluginManagementRenderer.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/renderer/PluginManagementRenderer.java?rev=675547&r1=675546&r2=675547&view=diff
==============================================================================
--- maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/renderer/PluginManagementRenderer.java (original)
+++ maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/dependencies/renderer/PluginManagementRenderer.java Thu Jul 10 05:32:41 2008
@@ -36,6 +36,7 @@
 import org.apache.maven.project.MavenProject;
 import org.apache.maven.project.MavenProjectBuilder;
 import org.apache.maven.project.ProjectBuildingException;
+import org.apache.maven.report.projectinfo.dependencies.ArtifactUtils;
 import org.apache.maven.reporting.AbstractMavenReportRenderer;
 import org.codehaus.plexus.i18n.I18N;
 
@@ -63,6 +64,16 @@
 
     private Log log;
 
+    /**
+     * @param sink
+     * @param locale
+     * @param i18n
+     * @param plugins
+     * @param project
+     * @param mavenProjectBuilder
+     * @param artifactFactory
+     * @param localRepository
+     */
     public PluginManagementRenderer( Sink sink, Locale locale, I18N i18n, List plugins, MavenProject project,
                                      MavenProjectBuilder mavenProjectBuilder, ArtifactFactory artifactFactory,
                                      ArtifactRepository localRepository )
@@ -190,19 +201,10 @@
 
     private String[] getPluginRow( Plugin plugin, String link )
     {
-        String artifactId = getPluginCell( plugin.getArtifactId(), link );
+        String artifactId = ArtifactUtils.getArtifactIdCell( plugin.getArtifactId(), link );
         return new String[] { plugin.getGroupId(), artifactId, plugin.getVersion() };
     }
 
-    private String getPluginCell( String text, String link )
-    {
-        if ( link == null || "".equals( link ) )
-        {
-            return text;
-        }
-        return "{" + text + "," + link + "}";
-    }
-
     private Comparator getPluginComparator()
     {
         return new Comparator()