From a9aca6f75c83b5a7dfd2bceb8bf5bdab698bac15 Mon Sep 17 00:00:00 2001
From: Herve Boutemy <hboutemy@apache.org>
Date: Sun, 13 May 2012 11:09:17 +0000
Subject: [PATCH] refactoring: split generators part of maven-plugin-tools-api
 to its own maven-plugin-tools-generators module

git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@1337845 13f79535-47bb-0310-9956-ffa450edef68
---
 maven-plugin-plugin/pom.xml                   |  10 +-
 maven-plugin-tools-api/pom.xml                |  48 +-------
 maven-plugin-tools-generators/pom.xml         | 112 ++++++++++++++++++
 .../tools/plugin/generator/Generator.java     |   0
 .../plugin/generator/GeneratorException.java  |   0
 .../generator/PluginDescriptorGenerator.java  |   0
 .../plugin/generator/PluginHelpGenerator.java |   0
 .../plugin/generator/PluginXdocGenerator.java |   0
 .../src/main/resources/help-class-source.vm   |   0
 .../src/main/resources/pluginxdoc.properties  |   0
 .../main/resources/pluginxdoc_de.properties   |   0
 .../main/resources/pluginxdoc_en.properties   |   0
 .../main/resources/pluginxdoc_fr.properties   |   0
 .../src/site/site.xml                         |  31 +++++
 .../generator/AbstractGeneratorTestCase.java  |   0
 .../PluginDescriptorGeneratorTest.java        |   0
 .../generator/PluginHelpGeneratorTest.java    |   0
 .../generator/PluginXdocGeneratorTest.java    |   0
 maven-plugin-tools-java/pom.xml               |   6 +
 pom.xml                                       |  16 ++-
 src/site/apt/index.apt                        |   2 +
 21 files changed, 172 insertions(+), 53 deletions(-)
 create mode 100644 maven-plugin-tools-generators/pom.xml
 rename {maven-plugin-tools-api => maven-plugin-tools-generators}/src/main/java/org/apache/maven/tools/plugin/generator/Generator.java (100%)
 rename {maven-plugin-tools-api => maven-plugin-tools-generators}/src/main/java/org/apache/maven/tools/plugin/generator/GeneratorException.java (100%)
 rename {maven-plugin-tools-api => maven-plugin-tools-generators}/src/main/java/org/apache/maven/tools/plugin/generator/PluginDescriptorGenerator.java (100%)
 rename {maven-plugin-tools-api => maven-plugin-tools-generators}/src/main/java/org/apache/maven/tools/plugin/generator/PluginHelpGenerator.java (100%)
 rename {maven-plugin-tools-api => maven-plugin-tools-generators}/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java (100%)
 rename {maven-plugin-tools-api => maven-plugin-tools-generators}/src/main/resources/help-class-source.vm (100%)
 rename {maven-plugin-tools-api => maven-plugin-tools-generators}/src/main/resources/pluginxdoc.properties (100%)
 rename {maven-plugin-tools-api => maven-plugin-tools-generators}/src/main/resources/pluginxdoc_de.properties (100%)
 rename {maven-plugin-tools-api => maven-plugin-tools-generators}/src/main/resources/pluginxdoc_en.properties (100%)
 rename {maven-plugin-tools-api => maven-plugin-tools-generators}/src/main/resources/pluginxdoc_fr.properties (100%)
 create mode 100644 maven-plugin-tools-generators/src/site/site.xml
 rename {maven-plugin-tools-api => maven-plugin-tools-generators}/src/test/java/org/apache/maven/tools/plugin/generator/AbstractGeneratorTestCase.java (100%)
 rename {maven-plugin-tools-api => maven-plugin-tools-generators}/src/test/java/org/apache/maven/tools/plugin/generator/PluginDescriptorGeneratorTest.java (100%)
 rename {maven-plugin-tools-api => maven-plugin-tools-generators}/src/test/java/org/apache/maven/tools/plugin/generator/PluginHelpGeneratorTest.java (100%)
 rename {maven-plugin-tools-api => maven-plugin-tools-generators}/src/test/java/org/apache/maven/tools/plugin/generator/PluginXdocGeneratorTest.java (100%)

diff --git a/maven-plugin-plugin/pom.xml b/maven-plugin-plugin/pom.xml
index 969c07e..9ca859a 100644
--- a/maven-plugin-plugin/pom.xml
+++ b/maven-plugin-plugin/pom.xml
@@ -74,6 +74,11 @@
         <artifactId>maven-plugin-tools-api</artifactId>
         <version>${project.version}</version>
       </dependency>
+      <dependency>
+        <groupId>org.apache.maven.plugin-tools</groupId>
+        <artifactId>maven-plugin-tools-generators</artifactId>
+        <version>${project.version}</version>
+      </dependency>
       <dependency>
         <groupId>org.apache.maven.plugin-tools</groupId>
         <artifactId>maven-plugin-tools-model</artifactId>
@@ -189,6 +194,10 @@
       <groupId>org.apache.maven.plugin-tools</groupId>
       <artifactId>maven-plugin-tools-api</artifactId>
     </dependency>
+    <dependency>
+      <groupId>org.apache.maven.plugin-tools</groupId>
+      <artifactId>maven-plugin-tools-generators</artifactId>
+    </dependency>
 
     <dependency>
       <groupId>org.apache.maven</groupId>
@@ -224,7 +233,6 @@
       <artifactId>maven-plugin-tools-beanshell</artifactId>
       <scope>runtime</scope>
     </dependency>
-
     <dependency>
       <groupId>org.apache.maven.plugin-tools</groupId>
       <artifactId>maven-plugin-tools-annotations</artifactId>
diff --git a/maven-plugin-tools-api/pom.xml b/maven-plugin-tools-api/pom.xml
index 6de6aa0..1e56f75 100644
--- a/maven-plugin-tools-api/pom.xml
+++ b/maven-plugin-tools-api/pom.xml
@@ -31,7 +31,7 @@
   <artifactId>maven-plugin-tools-api</artifactId>
 
   <name>Maven Plugin Tools APIs</name>
-  <description>The Maven Plugin Tools API provides an API to extract information from and generate documentation for Maven Plugins.</description>
+  <description>The Maven Plugin Tools API provides an API to extract descriptor information from Maven Plugins.</description>
 
   <dependencies>
     <!-- maven -->
@@ -71,31 +71,6 @@
       <groupId>org.codehaus.plexus</groupId>
       <artifactId>plexus-container-default</artifactId>
     </dependency>
-    <dependency>
-      <groupId>org.codehaus.plexus</groupId>
-      <artifactId>plexus-velocity</artifactId>
-      <exclusions>
-        <exclusion>
-          <groupId>velocity</groupId>
-          <artifactId>velocity</artifactId>
-        </exclusion>
-      </exclusions>
-    </dependency>
-
-    <!-- other -->
-    <dependency>
-      <groupId>org.apache.velocity</groupId>
-      <artifactId>velocity</artifactId>
-    </dependency>
-
-    <dependency>
-      <groupId>asm</groupId>
-      <artifactId>asm</artifactId>
-    </dependency>
-    <dependency>
-      <groupId>asm</groupId>
-      <artifactId>asm-commons</artifactId>
-    </dependency>
 
     <!-- misc -->
     <dependency>
@@ -131,25 +106,4 @@
       </plugin>
     </plugins>
   </build>
-
-  <profiles>
-    <profile>
-      <id>reporting</id>
-      <reporting>
-        <plugins>
-          <plugin>
-            <groupId>org.codehaus.mojo</groupId>
-            <artifactId>l10n-maven-plugin</artifactId>
-            <version>1.0-alpha-2</version>
-            <configuration>
-              <locales>
-                <locale>de</locale>
-                <locale>fr</locale>
-              </locales>
-            </configuration>
-          </plugin>
-        </plugins>
-      </reporting>
-    </profile>
-  </profiles>
 </project>
diff --git a/maven-plugin-tools-generators/pom.xml b/maven-plugin-tools-generators/pom.xml
new file mode 100644
index 0000000..f107a42
--- /dev/null
+++ b/maven-plugin-tools-generators/pom.xml
@@ -0,0 +1,112 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+  ~ 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.
+  -->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <parent>
+    <groupId>org.apache.maven.plugin-tools</groupId>
+    <artifactId>maven-plugin-tools</artifactId>
+    <version>3.0-SNAPSHOT</version>
+  </parent>
+
+  <artifactId>maven-plugin-tools-generators</artifactId>
+
+  <name>Maven Plugin Tools Generators</name>
+  <description>The Maven Plugin Tools Generators provides content generation (documentation, help) from plugin descriptor.</description>
+
+  <dependencies>
+    <dependency>
+      <groupId>org.apache.maven.plugin-tools</groupId>
+      <artifactId>maven-plugin-tools-api</artifactId>
+    </dependency>
+
+    <!-- maven -->
+    <dependency>
+      <groupId>org.apache.maven</groupId>
+      <artifactId>maven-project</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.apache.maven</groupId>
+      <artifactId>maven-model</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.apache.maven</groupId>
+      <artifactId>maven-plugin-descriptor</artifactId>
+    </dependency>
+
+    <!-- plexus -->
+    <dependency>
+      <groupId>org.codehaus.plexus</groupId>
+      <artifactId>plexus-utils</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.codehaus.plexus</groupId>
+      <artifactId>plexus-container-default</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.codehaus.plexus</groupId>
+      <artifactId>plexus-velocity</artifactId>
+      <exclusions>
+        <exclusion>
+          <groupId>velocity</groupId>
+          <artifactId>velocity</artifactId>
+        </exclusion>
+      </exclusions>
+    </dependency>
+
+    <!-- other -->
+    <dependency>
+      <groupId>org.apache.velocity</groupId>
+      <artifactId>velocity</artifactId>
+    </dependency>
+
+    <dependency>
+      <groupId>asm</groupId>
+      <artifactId>asm</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>asm</groupId>
+      <artifactId>asm-commons</artifactId>
+    </dependency>
+  </dependencies>
+
+  <profiles>
+    <profile>
+      <id>reporting</id>
+      <reporting>
+        <plugins>
+          <plugin>
+            <groupId>org.codehaus.mojo</groupId>
+            <artifactId>l10n-maven-plugin</artifactId>
+            <version>1.0-alpha-2</version>
+            <configuration>
+              <locales>
+                <locale>de</locale>
+                <locale>fr</locale>
+              </locales>
+            </configuration>
+          </plugin>
+        </plugins>
+      </reporting>
+    </profile>
+  </profiles>
+</project>
diff --git a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/Generator.java b/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/Generator.java
similarity index 100%
rename from maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/Generator.java
rename to maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/Generator.java
diff --git a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/GeneratorException.java b/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/GeneratorException.java
similarity index 100%
rename from maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/GeneratorException.java
rename to maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/GeneratorException.java
diff --git a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginDescriptorGenerator.java b/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginDescriptorGenerator.java
similarity index 100%
rename from maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginDescriptorGenerator.java
rename to maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginDescriptorGenerator.java
diff --git a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginHelpGenerator.java b/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginHelpGenerator.java
similarity index 100%
rename from maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginHelpGenerator.java
rename to maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginHelpGenerator.java
diff --git a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java b/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java
similarity index 100%
rename from maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java
rename to maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java
diff --git a/maven-plugin-tools-api/src/main/resources/help-class-source.vm b/maven-plugin-tools-generators/src/main/resources/help-class-source.vm
similarity index 100%
rename from maven-plugin-tools-api/src/main/resources/help-class-source.vm
rename to maven-plugin-tools-generators/src/main/resources/help-class-source.vm
diff --git a/maven-plugin-tools-api/src/main/resources/pluginxdoc.properties b/maven-plugin-tools-generators/src/main/resources/pluginxdoc.properties
similarity index 100%
rename from maven-plugin-tools-api/src/main/resources/pluginxdoc.properties
rename to maven-plugin-tools-generators/src/main/resources/pluginxdoc.properties
diff --git a/maven-plugin-tools-api/src/main/resources/pluginxdoc_de.properties b/maven-plugin-tools-generators/src/main/resources/pluginxdoc_de.properties
similarity index 100%
rename from maven-plugin-tools-api/src/main/resources/pluginxdoc_de.properties
rename to maven-plugin-tools-generators/src/main/resources/pluginxdoc_de.properties
diff --git a/maven-plugin-tools-api/src/main/resources/pluginxdoc_en.properties b/maven-plugin-tools-generators/src/main/resources/pluginxdoc_en.properties
similarity index 100%
rename from maven-plugin-tools-api/src/main/resources/pluginxdoc_en.properties
rename to maven-plugin-tools-generators/src/main/resources/pluginxdoc_en.properties
diff --git a/maven-plugin-tools-api/src/main/resources/pluginxdoc_fr.properties b/maven-plugin-tools-generators/src/main/resources/pluginxdoc_fr.properties
similarity index 100%
rename from maven-plugin-tools-api/src/main/resources/pluginxdoc_fr.properties
rename to maven-plugin-tools-generators/src/main/resources/pluginxdoc_fr.properties
diff --git a/maven-plugin-tools-generators/src/site/site.xml b/maven-plugin-tools-generators/src/site/site.xml
new file mode 100644
index 0000000..aa167ff
--- /dev/null
+++ b/maven-plugin-tools-generators/src/site/site.xml
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+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.
+-->
+
+<project xmlns="http://maven.apache.org/DECORATION/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
+  <body>
+    <menu name="Overview">
+      <item name="Introduction" href="index.html"/>
+      <item name="JavaDocs" href="apidocs/index.html"/>
+      <item name="Source Xref" href="xref/index.html"/>
+      <!--item name="FAQ" href="faq.html"/-->
+    </menu>
+  </body>
+</project>
diff --git a/maven-plugin-tools-api/src/test/java/org/apache/maven/tools/plugin/generator/AbstractGeneratorTestCase.java b/maven-plugin-tools-generators/src/test/java/org/apache/maven/tools/plugin/generator/AbstractGeneratorTestCase.java
similarity index 100%
rename from maven-plugin-tools-api/src/test/java/org/apache/maven/tools/plugin/generator/AbstractGeneratorTestCase.java
rename to maven-plugin-tools-generators/src/test/java/org/apache/maven/tools/plugin/generator/AbstractGeneratorTestCase.java
diff --git a/maven-plugin-tools-api/src/test/java/org/apache/maven/tools/plugin/generator/PluginDescriptorGeneratorTest.java b/maven-plugin-tools-generators/src/test/java/org/apache/maven/tools/plugin/generator/PluginDescriptorGeneratorTest.java
similarity index 100%
rename from maven-plugin-tools-api/src/test/java/org/apache/maven/tools/plugin/generator/PluginDescriptorGeneratorTest.java
rename to maven-plugin-tools-generators/src/test/java/org/apache/maven/tools/plugin/generator/PluginDescriptorGeneratorTest.java
diff --git a/maven-plugin-tools-api/src/test/java/org/apache/maven/tools/plugin/generator/PluginHelpGeneratorTest.java b/maven-plugin-tools-generators/src/test/java/org/apache/maven/tools/plugin/generator/PluginHelpGeneratorTest.java
similarity index 100%
rename from maven-plugin-tools-api/src/test/java/org/apache/maven/tools/plugin/generator/PluginHelpGeneratorTest.java
rename to maven-plugin-tools-generators/src/test/java/org/apache/maven/tools/plugin/generator/PluginHelpGeneratorTest.java
diff --git a/maven-plugin-tools-api/src/test/java/org/apache/maven/tools/plugin/generator/PluginXdocGeneratorTest.java b/maven-plugin-tools-generators/src/test/java/org/apache/maven/tools/plugin/generator/PluginXdocGeneratorTest.java
similarity index 100%
rename from maven-plugin-tools-api/src/test/java/org/apache/maven/tools/plugin/generator/PluginXdocGeneratorTest.java
rename to maven-plugin-tools-generators/src/test/java/org/apache/maven/tools/plugin/generator/PluginXdocGeneratorTest.java
diff --git a/maven-plugin-tools-java/pom.xml b/maven-plugin-tools-java/pom.xml
index e6e5037..d54faa2 100644
--- a/maven-plugin-tools-java/pom.xml
+++ b/maven-plugin-tools-java/pom.xml
@@ -34,6 +34,12 @@
   <description>Descriptor extractor for plugins written in Java annotated with Mojo Javadoc Tags.</description>
 
   <dependencies>
+    <dependency>
+      <groupId>org.apache.maven.plugin-tools</groupId>
+      <artifactId>maven-plugin-tools-generators</artifactId>
+      <scope>test</scope>
+    </dependency>
+
     <!-- maven -->
     <dependency>
       <groupId>org.apache.maven</groupId>
diff --git a/pom.xml b/pom.xml
index 9d891c4..6bd3607 100644
--- a/pom.xml
+++ b/pom.xml
@@ -124,14 +124,15 @@
 
   <modules>
     <module>maven-plugin-tools-api</module>
-    <module>maven-plugin-tools-ant</module>
-    <module>maven-plugin-tools-java</module>
-    <module>maven-plugin-tools-beanshell</module>
+    <module>maven-plugin-tools-generators</module>
     <module>maven-plugin-plugin</module>
-    <module>maven-plugin-tools-model</module>
+    <module>maven-plugin-tools-java</module>
     <module>maven-plugin-tools-javadoc</module>
-    <module>maven-plugin-tools-annotations</module>
     <module>maven-plugin-annotations</module>
+    <module>maven-plugin-tools-annotations</module>
+    <module>maven-plugin-tools-ant</module>
+    <module>maven-plugin-tools-beanshell</module>
+    <module>maven-plugin-tools-model</module>
   </modules>
 
   <scm>
@@ -166,6 +167,11 @@
         <artifactId>maven-plugin-tools-api</artifactId>
         <version>${project.version}</version>
       </dependency>
+      <dependency>
+        <groupId>org.apache.maven.plugin-tools</groupId>
+        <artifactId>maven-plugin-tools-generators</artifactId>
+        <version>${project.version}</version>
+      </dependency>
       <dependency>
         <groupId>org.apache.maven.plugin-tools</groupId>
         <artifactId>maven-plugin-tools-model</artifactId>
diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt
index abd80ef..67a59b6 100644
--- a/src/site/apt/index.apt
+++ b/src/site/apt/index.apt
@@ -39,6 +39,8 @@ Maven Plugin Tools
 *-----------------------------------------------------------------------------+---------------------------------------------------------+
 | {{{./maven-plugin-tools-api/index.html}maven-plugin-tools-api}}             | Descriptor extractor API, used by maven-plugin-plugin to extract Plugin information.
 *-----------------------------------------------------------------------------+---------------------------------------------------------+
+| {{{./maven-plugin-tools-generators/index.html}maven-plugin-tools-generators}} | Generators (help, documentation), used by maven-plugin-plugin to generate content from descriptor.
+*-----------------------------------------------------------------------------+---------------------------------------------------------+
 | \ \ {{{./maven-plugin-tools-java/index.html}maven-plugin-tools-java}}               | Descriptor extractor for plugins written in Java annotated with Mojo Javadoc Tags.
 *-----------------------------------------------------------------------------+---------------------------------------------------------+
 | \ \ \ \ {{{./maven-plugin-tools-javadoc/index.html}maven-plugin-tools-javadoc}}     | Provides the support of Mojo Javadoc Tags in the Javadoc Tool.