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 2007/10/16 14:17:34 UTC

svn commit: r585130 - in /maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java: ./ src/main/java/org/apache/maven/jxr/java/src/ src/main/resources/org/ src/main/resources/org/apache/ src/main/resources/org/apache/maven/ src/main/resources/org/apache/maven/...

Author: vsiveton
Date: Tue Oct 16 05:17:22 2007
New Revision: 585130

URL: http://svn.apache.org/viewvc?rev=585130&view=rev
Log:
o using a styles sheet instead of generating it
o added plexus-utils as dependency
o updated test case and doc

Added:
    maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/main/resources/org/
    maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/main/resources/org/apache/
    maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/main/resources/org/apache/maven/
    maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/main/resources/org/apache/maven/jxr/
    maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/main/resources/org/apache/maven/jxr/java/
    maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/main/resources/org/apache/maven/jxr/java/src/
    maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/main/resources/org/apache/maven/jxr/java/src/css/
    maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/main/resources/org/apache/maven/jxr/java/src/css/styles.css   (with props)
Modified:
    maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/pom.xml
    maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/main/java/org/apache/maven/jxr/java/src/JavaSrcTask.java
    maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/ant.apt
    maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/test/java/org/apache/maven/jxr/java/src/JavaSrcTaskTest.java

Modified: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/pom.xml
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/pom.xml?rev=585130&r1=585129&r2=585130&view=diff
==============================================================================
--- maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/pom.xml (original)
+++ maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/pom.xml Tue Oct 16 05:17:22 2007
@@ -55,6 +55,11 @@
       <artifactId>log4j</artifactId>
       <version>1.2.13</version>
     </dependency>
+    <dependency>
+      <groupId>org.codehaus.plexus</groupId>
+      <artifactId>plexus-utils</artifactId>
+      <version>1.4.6</version>
+    </dependency>
 
     <dependency>
       <groupId>com.sun</groupId>
@@ -62,13 +67,6 @@
       <version>1.5.0_11</version>
       <scope>system</scope>
       <systemPath>${java.home}/../lib/tools.jar</systemPath>
-    </dependency>
-
-    <dependency>
-      <groupId>org.codehaus.plexus</groupId>
-      <artifactId>plexus-utils</artifactId>
-      <version>1.4.6</version>
-      <scope>test</scope>
     </dependency>
   </dependencies>
 

Modified: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/main/java/org/apache/maven/jxr/java/src/JavaSrcTask.java
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/main/java/org/apache/maven/jxr/java/src/JavaSrcTask.java?rev=585130&r1=585129&r2=585130&view=diff
==============================================================================
--- maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/main/java/org/apache/maven/jxr/java/src/JavaSrcTask.java (original)
+++ maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/main/java/org/apache/maven/jxr/java/src/JavaSrcTask.java Tue Oct 16 05:17:22 2007
@@ -19,6 +19,11 @@
  * under the License.
  */
 
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+
 import org.apache.tools.ant.BuildException;
 import org.apache.tools.ant.DirectoryScanner;
 import org.apache.tools.ant.Project;
@@ -26,11 +31,7 @@
 import org.apache.tools.ant.util.FileNameMapper;
 import org.apache.tools.ant.util.GlobPatternMapper;
 import org.apache.tools.ant.util.SourceFileScanner;
-
-import java.io.File;
-import java.io.FileOutputStream;
-import java.io.IOException;
-import java.io.PrintWriter;
+import org.codehaus.plexus.util.IOUtil;
 
 /**
  * Runs the javasrc converter as a task inside
@@ -42,6 +43,12 @@
 public class JavaSrcTask
     extends MatchingTask
 {
+    /**
+     * Default location for css
+     */
+    private static final String DEFAULT_CSS_NAME = "styles.css";
+
+    private static final String RESOURCE_CSS_DIR = "org/apache/maven/jxr/java/src/css";
 
     /** Field srcDir */
     private File srcDir;
@@ -178,7 +185,7 @@
         try
         {
             p2.run( new String[] {} );
-            printCSSFile();
+            copyDefaultStylesheet( getDestDir() );
         }
         catch ( IOException ioe )
         {
@@ -246,78 +253,55 @@
         this.verbose = verbose;
     }
 
-    String cssText = "/* Javadoc style sheet */\n"
-        + "/* Define colors, fonts and other style attributes here to override the defaults  */\n" + "body { \n"
-        + "\tbackground-color: #fff;\n" + "\tfont-family: Arial, Helvetica, sans-serif;\n" + "}\n" + "\n"
-        + "a:link {\n" + " color: #00f;\n" + "}\n" + "a:visited {\n" + " color: #00a;\n" + "}\n" + "\n"
-        + "a:active, a:hover {\n" + " color: #f30 !important;\n" + "}\n" + "\n" + "ul, li\t{\n"
-        + "\tlist-style-type:none ;\n" + "\tmargin:0;\n" + "\tpadding:0;\n" + "}\n" + "\n" + "table td{\n"
-        + "\tpadding: 3px;\n" + "\tborder: 1px solid #000;\n" + "}\n" + "table{\n" + "\twidth:100%;\n"
-        + "\tborder: 1px solid #000;\n" + "\tborder-collapse: collapse;\n" + "}\n" + "\n" + "div.overview {\n"
-        + "\tbackground-color:#ddd;\n" + "\tpadding: 4px 4px 4px 0;\n" + "}\n"
-        + "div.overview li, div.framenoframe li {\n" + "\tdisplay: inline;\n" + "}\n" + "div.framenoframe {\n"
-        + "\ttext-align: center;\n" + "\tfont-size: x-small;\n" + "}\n" + "div.framenoframe li {\n"
-        + "\tmargin: 0 3px 0 3px;\n" + "}\n" + "div.overview li {\n" + "\tmargin:3px 3px 0 3px;\n"
-        + "\tpadding: 4px;\n" + "}\n" + "li.selected {\n" + "\tbackground-color:#888;\n" + "\tcolor: #fff;\n"
-        + "\tfont-weight: bold;\n" + "}\n" + "\n" + "table.summary {\n" + "\tmargin-bottom: 20px;\n" + "}\n"
-        + "table.summary td, table.summary th {\n" + "\tfont-weight: bold;\n" + "\ttext-align: left;\n"
-        + "\tpadding: 3px;\n" + "}\n" + "table.summary th{\n" + "\tbackground-color:#036;\n" + "\tcolor: #fff;\n"
-        + "}\n" + "table.summary td{\n" + "\tbackground-color:#eee;\n" + "\tborder: 1px solid black;\n" + "}\n" + "\n"
-        + "em {\n" + "\tcolor: #A00;\n" + "}\n" + "em.comment {\n" + "\tcolor: #390;\n" + "}\n" + ".string {\n"
-        + "\tcolor: #009;\n" + "}\n" + "div#footer {\n" + "\ttext-align:center;\n" + "}\n" + "#overview {\n"
-        + "\tpadding:2px;\n" + "}\n" + "            \n" + "            \n" + "hr {\n" + "\theight: 1px;\n"
-        + "\tcolor: #000;\n" + "}";
-
     /**
-     * Method printCSSFile
+     * Method that copy the <code>DEFAULT_STYLESHEET_NAME</code> file from the current class
+     * loader to the <code>outputDirectory</code>.
      *
-     * @throws IOException
+     * @param outputDirectory the output directory
+     * @throws java.io.IOException if any
+     * @see #DEFAULT_CSS_NAME
      */
-    private void printCSSFile()
+    private void copyDefaultStylesheet( File outputDirectory )
         throws IOException
     {
+        if ( outputDirectory == null || !outputDirectory.exists() )
+        {
+            throw new IOException( "The outputDirectory " + outputDirectory + " doesn't exists." );
+        }
+
+        InputStream is = getStream( RESOURCE_CSS_DIR + "/" + DEFAULT_CSS_NAME );
 
-        FileOutputStream css = new FileOutputStream( new File( destDir, "styles.css" ) );
-        PrintWriter pw = new PrintWriter( css );
+        if ( is == null )
+        {
+            throw new IOException( "The resource " + DEFAULT_CSS_NAME + " doesn't exists." );
+        }
+
+        File outputFile = new File( outputDirectory, DEFAULT_CSS_NAME );
+
+        if ( !outputFile.getParentFile().exists() )
+        {
+            outputFile.getParentFile().mkdirs();
+        }
+
+        FileOutputStream w = new FileOutputStream( outputFile );
+
+        IOUtil.copy( is, w );
 
-        //pw.println(
-        //        "body { font-family: lucida, verdana, arial, sans-serif; font-size:10pt } ");
-        //pw.println("pre { font-size:10pt } ");
-        pw.println( cssText );
-        pw.println( ".comment   { color:#007d00; font-style:italic } " );
-        pw.println( ".linenum   { color:#888 font-weight:normal; } " );
-        pw.println( ".textDiv   { font-weight:bold } " );
-        pw.println( "" );
-        pw.println( ".packageListItem { margin:0; padding:0; border:0 } " );
-        pw.println( ".packageName {  font-weight:bold } " );
-        pw.println( "" );
-        pw.println( ".classDef  { color:#875b37;font-weight:bold } " );
-        pw.println( ".classRef  { color:#875b37;font-weight:normal; } " );
-        pw.println( ".classListItem  {  margin:0; padding:0; border:0 } " );
-        pw.println( ".classReflist         { border-bottom:solid } " );
-        pw.println( ".classReflistHeader   { font-weight:bold; border:0; margin:0; padding:0 } " );
-        pw.println( ".classRefItem         { margin:0; padding:0; border:0 } " );
-        pw.println( "p.classRefItem a        { color:#875b37 } " );
-        pw.println( "p.classReflistHeader a  { color:#875b37 } " );
-        pw.println( "" );
-        pw.println( "" );
-        pw.println( ".methodDef { color:#377587;font-weight:bold } " );
-        pw.println( ".methodRef { color:#377587;font-weight:normal } " );
-        pw.println( ".methodReflist         { } " );
-        pw.println( ".methodReflistHeader   { font-weight:bold; border:0; margin:0; padding:0} " );
-        pw.println( ".methodRefItem         { margin:0; padding:0; border:0; color:#009 } " );
-        pw.println( "p.methodRefItem a        { color:#377587 } " );
-        pw.println( "p.methodReflistHeader a  { color:#377587 } " );
-        pw.println( "" );
-        pw.println( "" );
-        pw.println( ".varDef    { color:#232187;font-weight:bold } " );
-        pw.println( ".varRef    { color:#232187;font-weight:normal } " );
-        pw.println( ".variableReflist         { } " );
-        pw.println( ".variableReflistHeader   { color:#000000;font-weight:bold;  border:0; margin:0; padding:0} " );
-        pw.println( ".variableRefItem         { margin:0; padding:0; border:0; color:#660 } " );
-        pw.println( "p.variableRefItem a        { color:#232187; } " );
-        pw.println( "p.variableRefListheader a  { color:#232187; } " );
-        pw.println( "" );
-        pw.close();
+        IOUtil.close( is );
+
+        IOUtil.close( w );
+    }
+
+    /**
+     * Returns an input stream for reading the specified resource from the
+     * current class loader.
+     *
+     * @param resource the resource
+     * @return InputStream An input stream for reading the resource, or <tt>null</tt>
+     *         if the resource could not be found
+     */
+    private InputStream getStream( String resource )
+    {
+        return getClass().getClassLoader().getResourceAsStream( resource );
     }
 }

Added: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/main/resources/org/apache/maven/jxr/java/src/css/styles.css
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/main/resources/org/apache/maven/jxr/java/src/css/styles.css?rev=585130&view=auto
==============================================================================
--- maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/main/resources/org/apache/maven/jxr/java/src/css/styles.css (added)
+++ maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/main/resources/org/apache/maven/jxr/java/src/css/styles.css Tue Oct 16 05:17:22 2007
@@ -0,0 +1,130 @@
+/* Javadoc style sheet */
+/* Define colors, fonts and other style attributes here to override the defaults  */
+body { 
+	background-color: #fff;
+	font-family: Arial, Helvetica, sans-serif;
+}
+
+a:link {
+ color: #00f;
+}
+a:visited {
+ color: #00a;
+}
+
+a:active, a:hover {
+ color: #f30 !important;
+}
+
+ul, li	{
+	list-style-type:none ;
+	margin:0;
+	padding:0;
+}
+
+table td{
+	padding: 3px;
+	border: 1px solid #000;
+}
+table{
+	width:100%;
+	border: 1px solid #000;
+	border-collapse: collapse;
+}
+
+div.overview {
+	background-color:#ddd;
+	padding: 4px 4px 4px 0;
+}
+div.overview li, div.framenoframe li {
+	display: inline;
+}
+div.framenoframe {
+	text-align: center;
+	font-size: x-small;
+}
+div.framenoframe li {
+	margin: 0 3px 0 3px;
+}
+div.overview li {
+	margin:3px 3px 0 3px;
+	padding: 4px;
+}
+li.selected {
+	background-color:#888;
+	color: #fff;
+	font-weight: bold;
+}
+
+table.summary {
+	margin-bottom: 20px;
+}
+table.summary td, table.summary th {
+	font-weight: bold;
+	text-align: left;
+	padding: 3px;
+}
+table.summary th{
+	background-color:#036;
+	color: #fff;
+}
+table.summary td{
+	background-color:#eee;
+	border: 1px solid black;
+}
+
+em {
+	color: #A00;
+}
+em.comment {
+	color: #390;
+}
+.string {
+	color: #009;
+}
+div#footer {
+	text-align:center;
+}
+#overview {
+	padding:2px;
+}
+            
+            
+hr {
+	height: 1px;
+	color: #000;
+}
+.comment   { color:#007d00; font-style:italic } 
+.linenum   { color:#888 font-weight:normal; } 
+.textDiv   { font-weight:bold } 
+
+.packageListItem { margin:0; padding:0; border:0 } 
+.packageName {  font-weight:bold } 
+
+.classDef  { color:#875b37;font-weight:bold } 
+.classRef  { color:#875b37;font-weight:normal; } 
+.classListItem  {  margin:0; padding:0; border:0 } 
+.classReflist         { border-bottom:solid } 
+.classReflistHeader   { font-weight:bold; border:0; margin:0; padding:0 } 
+.classRefItem         { margin:0; padding:0; border:0 } 
+p.classRefItem a        { color:#875b37 } 
+p.classReflistHeader a  { color:#875b37 } 
+
+
+.methodDef { color:#377587;font-weight:bold } 
+.methodRef { color:#377587;font-weight:normal } 
+.methodReflist         { } 
+.methodReflistHeader   { font-weight:bold; border:0; margin:0; padding:0} 
+.methodRefItem         { margin:0; padding:0; border:0; color:#009 } 
+p.methodRefItem a        { color:#377587 } 
+p.methodReflistHeader a  { color:#377587 } 
+
+
+.varDef    { color:#232187;font-weight:bold } 
+.varRef    { color:#232187;font-weight:normal } 
+.variableReflist         { } 
+.variableReflistHeader   { color:#000000;font-weight:bold;  border:0; margin:0; padding:0} 
+.variableRefItem         { margin:0; padding:0; border:0; color:#660 } 
+p.variableRefItem a        { color:#232187; } 
+p.variableRefListheader a  { color:#232187; } 
+

Propchange: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/main/resources/org/apache/maven/jxr/java/src/css/styles.css
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/main/resources/org/apache/maven/jxr/java/src/css/styles.css
------------------------------------------------------------------------------
    svn:keywords = "Author Date Id Revision"

Modified: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/ant.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/ant.apt?rev=585130&r1=585129&r2=585130&view=diff
==============================================================================
--- maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/ant.apt (original)
+++ maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/site/apt/examples/ant.apt Tue Oct 16 05:17:22 2007
@@ -35,6 +35,9 @@
 
   <path id="task.classpath">
     <fileset dir="${basedir}/lib">
+      <include name="plexus-utils-1.4.6.jar" />
+    </fileset>
+    <fileset dir="${basedir}/lib">
       <include name="maven-jxr-java-3.0-SNAPSHOT.jar" />
     </fileset>
   </path>

Modified: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/test/java/org/apache/maven/jxr/java/src/JavaSrcTaskTest.java
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/test/java/org/apache/maven/jxr/java/src/JavaSrcTaskTest.java?rev=585130&r1=585129&r2=585130&view=diff
==============================================================================
--- maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/test/java/org/apache/maven/jxr/java/src/JavaSrcTaskTest.java (original)
+++ maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-java/src/test/java/org/apache/maven/jxr/java/src/JavaSrcTaskTest.java Tue Oct 16 05:17:22 2007
@@ -110,10 +110,6 @@
         generated = new File( destDir, "org/apache/maven/jxr/java/src/JavaSrcTask_java_ref.html" );
         assertTrue( generated.exists() );
         assertTrue( generated.length() > 0 );
-
-        // MSANDBOX-38: compare results before and after Antlr generation
-        assertEquals( FileUtils.getDirectoryNames( destDir, "**/*", "", false ).size(), 32 );
-        assertEquals( FileUtils.getFileNames( destDir, "**/*", "", false ).size(), 170 );
     }
 
     /**