[jsword-svn] jsword-support/tools/jdepend s

jswordcvs at crosswire.org jswordcvs at crosswire.org
Tue Aug 16 11:03:05 MST 2005


Update of /cvs/jsword/jsword-support/tools/jdepend
In directory www.crosswire.org:/tmp/cvs-serv29457/tools/jdepend

Added Files:
	jdepend.xsl HOWTO-UPGRADE.txt build.xml 
Log Message:
Upgrading jsword-support/tools

--- NEW FILE: jdepend.xsl ---
<xsl:stylesheet	xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">

<!--
 The Apache Software License, Version 1.1

 Copyright (c) 2002 The Apache Software Foundation.  All rights
 reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:

 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.

 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in
    the documentation and/or other materials provided with the
    distribution.

 3. The end-user documentation included with the redistribution, if
    any, must include the following acknowlegement:
       "This product includes software developed by the
        Apache Software Foundation (http://www.apache.org/)."
    Alternately, this acknowlegement may appear in the software itself,
    if and wherever such third-party acknowlegements normally appear.

 4. The names "The Jakarta Project", "Ant", and "Apache Software
    Foundation" must not be used to endorse or promote products derived
    from this software without prior written permission. For written
    permission, please contact apache at apache.org.

 5. Products derived from this software may not be called "Apache"
    nor may "Apache" appear in their names without prior written
    permission of the Apache Group.

 THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 SUCH DAMAGE.
 ====================================================================

 This software consists of voluntary contributions made by many
 individuals on behalf of the Apache Software Foundation.  For more
 information on the Apache Software Foundation, please see
 <http://www.apache.org/>.
 -->

<xsl:output method="html" indent="yes"  encoding="US-ASCII"/>

<xsl:template match="JDepend">
	<html>
	<head>
		<title>JDepend Analysis</title>
		
	<style type="text/css">
	  body {
		font:normal 68% verdana,arial,helvetica;
		color:#000000;
	  }
	  table tr td, tr th {
		  font-size: 68%;
	  }
	  table.details tr th{
		font-weight: bold;
		text-align:left;
		background:#a6caf0;
	  }
	  table.details tr td{
		background:#eeeee0;
	  }
	  
	  p {
		line-height:1.5em;
		margin-top:0.5em; margin-bottom:1.0em;
		margin-left:2em;
		margin-right:2em;
	  }
	  h1 {
		margin: 0px 0px 5px; font: 165% verdana,arial,helvetica
	  }
	  h2 {
		margin-top: 1em; margin-bottom: 0.5em; font: bold 125% verdana,arial,helvetica
	  }
	  h3 {
		margin-bottom: 0.5em; font: bold 115% verdana,arial,helvetica
	  }
	  h4 {
		margin-bottom: 0.5em; font: bold 100% verdana,arial,helvetica
	  }
	  h5 {
		margin-bottom: 0.5em; font: bold 100% verdana,arial,helvetica
	  }
	  h6 {
		margin-bottom: 0.5em; font: bold 100% verdana,arial,helvetica
	  }
	  .Error {
		font-weight:bold; color:red;
	  }
	  .Failure {
		font-weight:bold; color:purple;
	  }
	  .Properties {
		text-align:right;
	  }
	  </style>
		
		
	</head>
	<body>
	<!--h1>JDepend Report</h1>
	<ul>
	<xsl:for-each select="./Packages/Package">
				<xsl:sort select="@name"/>
		<li><xsl:value-of select="@name"/></li>
	</xsl:for-each>
	</ul-->
	
	<h1><a name="top">JDepend Analysis</a></h1>
	<p align="right">Designed for use with <a href="http://www.clarkware.com/software/JDepend.html">JDepend</a> and <a href="http://jakarta.apache.org">Ant</a>.</p>
	<hr size="2" />
	
	<table width="100%"><tr><td>
	<a name="NVsummary"><h2>Summary</h2></a>
	</td><td align="right">
	[<a href="#NVsummary">summary</a>]
	[<a href="#NVpackages">packages</a>]
	[<a href="#NVcycles">cycles</a>]
	[<a href="#NVexplanations">explanations</a>]
	</td></tr></table>
	
	<table width="100%" class="details">
		<tr>
			<th>Package</th>
			<th>Total Classes</th>
			<th><a href="#EXnumber">Abstract Classes</a></th>
			<th><a href="#EXnumber">Concrete Classes</a></th>
			<th><a href="#EXafferent">Afferent Couplings</a></th>
			<th><a href="#EXefferent">Efferent Couplings</a></th>
			<th><a href="#EXabstractness">Abstractness</a></th>
			<th><a href="#EXinstability">Instability</a></th>
			<th><a href="#EXdistance">Distance</a></th>
			
		</tr>
	<xsl:for-each select="./Packages/Package">
		<xsl:if test="count(error) = 0">
			<tr>
				<td align="left">
					<a>
					<xsl:attribute name="href">#PK<xsl:value-of select="@name"/>
					</xsl:attribute>
					<xsl:value-of select="@name"/>
					</a>
				</td>
				<td align="right"><xsl:value-of select="Stats/TotalClasses"/></td>
				<td align="right"><xsl:value-of select="Stats/AbstractClasses"/></td>
				<td align="right"><xsl:value-of select="Stats/ConcreteClasses"/></td>
				<td align="right"><xsl:value-of select="Stats/Ca"/></td>
				<td align="right"><xsl:value-of select="Stats/Ce"/></td>
				<td align="right"><xsl:value-of select="Stats/A"/></td>
				<td align="right"><xsl:value-of select="Stats/I"/></td>
				<td align="right"><xsl:value-of select="Stats/D"/></td>
				

			</tr>
		</xsl:if>
	</xsl:for-each>
	<xsl:for-each select="./Packages/Package">
		<xsl:if test="count(error) &gt; 0">
			<tr>
				<td align="left">
					<xsl:value-of select="@name"/>
				</td>
				<td align="left" colspan="8"><xsl:value-of select="error"/></td>
			</tr>
		</xsl:if>
	</xsl:for-each>
	</table>
	
	<table width="100%"><tr><td>
	<a name="NVpackages"><h2>Packages</h2></a>
	</td><td align="right">
	[<a href="#NVsummary">summary</a>]
	[<a href="#NVpackages">packages</a>]
	[<a href="#NVcycles">cycles</a>]
	[<a href="#NVexplanations">explanations</a>]
	</td></tr></table>
	
	<xsl:for-each select="./Packages/Package">
		<xsl:if test="count(error) = 0">
			<h3><a><xsl:attribute name="name">PK<xsl:value-of select="@name"/></xsl:attribute>
			<xsl:value-of select="@name"/></a></h3>
			
			<table width="100%"><tr>
				<td><a href="#EXafferent">Afferent Couplings</a>: <xsl:value-of select="Stats/Ca"/></td>
				<td><a href="#EXefferent">Efferent Couplings</a>: <xsl:value-of select="Stats/Ce"/></td>
				<td><a href="#EXabstractness">Abstractness</a>: <xsl:value-of select="Stats/A"/></td>
				<td><a href="#EXinstability">Instability</a>: <xsl:value-of select="Stats/I"/></td>
				<td><a href="#EXdistance">Distance</a>: <xsl:value-of select="Stats/D"/></td>
			</tr></table>
			
			<table width="100%" class="details">
				<tr>
					<th>Abstract Classes</th>
					<th>Concrete Classes</th>
					<th>Used by Packages</th>
					<th>Uses Packages</th>
				</tr>
				<tr>
					<td valign="top" width="25%">
					<xsl:if test="count(AbstractClasses/Class)=0">
							<i>None</i>
						</xsl:if>
						<xsl:for-each select="AbstractClasses/Class">
							<xsl:value-of select="node()"/><br/>
						</xsl:for-each>
					</td>
					<td valign="top" width="25%">
						<xsl:if test="count(ConcreteClasses/Class)=0">
							<i>None</i>
						</xsl:if>
						<xsl:for-each select="ConcreteClasses/Class">
							<xsl:value-of select="node()"/><br/>
						</xsl:for-each>
					</td>
					<td valign="top" width="25%">
						<xsl:if test="count(UsedBy/Package)=0">
							<i>None</i>
						</xsl:if>
						<xsl:for-each select="UsedBy/Package">
							<a>
								<xsl:attribute name="href">#PK<xsl:value-of select="node()"/></xsl:attribute>
								<xsl:value-of select="node()"/>
							</a><br/>
						</xsl:for-each>
					</td>
					<td valign="top" width="25%">
						<xsl:if test="count(DependsUpon/Package)=0">
							<i>None</i>
						</xsl:if>
						<xsl:for-each select="DependsUpon/Package">
							<a>
								<xsl:attribute name="href">#PK<xsl:value-of select="node()"/></xsl:attribute>
								<xsl:value-of select="node()"/>
							</a><br/>
						</xsl:for-each>
					</td>
				</tr>
			</table>
		</xsl:if>
	</xsl:for-each>
	
	<table width="100%"><tr><td>
	<a name="NVcycles"><h2>Cycles</h2></a>
	</td><td align="right">
	[<a href="#NVsummary">summary</a>]
	[<a href="#NVpackages">packages</a>]
	[<a href="#NVcycles">cycles</a>]
	[<a href="#NVexplanations">explanations</a>]
	</td></tr></table>
	
	<xsl:if test="count(Cycles/Package) = 0">
		<p>There are no cyclic dependancies.</p>
	</xsl:if>
	<xsl:for-each select="Cycles/Package">
		<h3><xsl:value-of select="@Name"/></h3><p>
		<xsl:for-each select="Package">
			<xsl:value-of select="."/><br/>
		</xsl:for-each></p>
	</xsl:for-each>
	
	<table width="100%"><tr><td>
	<a name="NVexplanations"><h2>Explanations</h2></a>
	</td><td align="right">
	[<a href="#NVsummary">summary</a>]
	[<a href="#NVpackages">packages</a>]
	[<a href="#NVcycles">cycles</a>]
	[<a href="#NVexplanations">explanations</a>]
	</td></tr></table>
	
	<p>The following explanations are for quick reference and are lifted directly from the original <a href="http://www.clarkware.com/software/JDepend.html">JDepend documentation</a>.</p>
	
	<h3><a name="EXnumber">Number of Classes</a></h3>
		<p>The number of concrete and abstract classes (and interfaces) in the package is an indicator of the extensibility of the package.</p>
	<h3><a name="EXafferent">Afferent Couplings</a></h3>
		<p>The number of other packages that depend upon classes within the package is an indicator of the package's responsibility. </p>
	<h3><a name="EXefferent">Efferent Couplings</a></h3>
		<p>The number of other packages that the classes in the package depend upon is an indicator of the package's independence. </p>
	<h3><a name="EXabstractness">Abstractness</a></h3> 
		<p>The ratio of the number of abstract classes (and interfaces) in the analyzed package to the total number of classes in the analyzed package. </p>
		<p>The range for this metric is 0 to 1, with A=0 indicating a completely concrete package and A=1 indicating a completely abstract package. </p>
	<h3><a name="EXinstability">Instability</a></h3>
		<p>The ratio of efferent coupling (Ce) to total coupling (Ce / (Ce + Ca)). This metric is an indicator of the package's resilience to change. </p>
		<p>The range for this metric is 0 to 1, with I=0 indicating a completely stable package and I=1 indicating a completely instable package. </p>
	<h3><a name="EXdistance">Distance</a></h3>
		<p>The perpendicular distance of a package from the idealized line A + I = 1. This metric is an indicator of the package's balance between abstractness and stability. </p>
		<p>A package squarely on the main sequence is optimally balanced with respect to its abstractness and stability. Ideal packages are either completely abstract and stable (x=0, y=1) or completely concrete and instable (x=1, y=0). </p>
		<p>The range for this metric is 0 to 1, with D=0 indicating a package that is coincident with the main sequence and D=1 indicating a package that is as far from the main sequence as possible. </p>
	
	</body>
	</html>
</xsl:template>

</xsl:stylesheet>

--- NEW FILE: build.xml ---
<project name="jdepend" default="jdepend">

  <property name="support.depend" value="${support.tools}/jdepend"/>
  <property name="version.depend" value="2.9.1"/>

  <!-- this should be overridden by the parent file -->
  <property name="support.tools" value=".."/>

  <target name="jdepend">
    <echo>JDepend may fail if jdepend.jar is not visible to Ant.
To make it visible you need to do one of two things depending
on whether you are running ant in Eclipse or not.
In Eclipse, add jdepend-*.jar to Preferences -> Ant -> Runtime -> Global Entries
Otherwise, run the jdepend.antlibs task to copy jars to ANT_HOME/lib</echo>
    <mkdir dir="${target.web}/jdepend"/>
    <jdepend format="xml" outputfile="${target.web}/jdepend/jdepend-report.xml" fork="yes">
      <classespath>
        <path refid="path.allclasses"/>
      </classespath>
      <classpath>
        <fileset dir="${target.jar}" includes="**/*.jar"/>
        <fileset dir="${support.depend}" includes="**/*.jar"/>
      </classpath>
    </jdepend>
    <style
        in="${target.web}/jdepend/jdepend-report.xml"
        out="${target.web}/jdepend/jdepend-report.html"
        style="${support.depend}/jdepend.xsl"/>
  </target>

  <!-- This does not need to be done in Eclipse. Add it to Ant preferences instead -->
  <target name="jdepend.antlibs" description="Copy required jars to ant/lib">
    <echo message="copy ${basedir}/${support.depend}/jdepend-${version.depend}/jdepend-${version.depend}.jar"/>
    <copy file="${support.tools}/${support.depend}/jdepend-${version.depend}/jdepend-${version.depend}.jar" todir="${ant.home}/lib"/>
  </target>

</project>

--- NEW FILE: HOWTO-UPGRADE.txt ---
Instructions on how to upgrade jdepend.
Obtain the most recent version of jdepend from
   http://www.clarkware.com/software/JDepend.html

Unzip the file into this directory.
In the new directory, remove the following:
   contrib
   docs
   sample
   src
   test

Change the references to the old directory to the new directory in the following files:
   build.xml

In CVS remove the old jdepend directory.

You may need to tell ant where to find the jdepend jar.
This varies by ide or whether ant is run standalone.
See build.xml for further info.

If you have copied the jdepend jar to ANT_HOME/lib,
you will want to delete the older one.



More information about the jsword-svn mailing list