manage xdoc anchor name conflicts (2 classes with same anchor)

codehaus-plexus · Feb 10, 2022 · 2590c0f · 2590c0f
1 parent 676c4ab
commit 2590c0f
Show file tree

Hide file tree

Showing 7 changed files with 69 additions and 22 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,4 +5,5 @@ target/
 bin
 .idea/
 *.iml
+.factorypath
 pom.xml.releaseBackup
diff --git a/...ins/modello-plugin-xdoc/src/main/java/org/codehaus/modello/plugin/xdoc/XdocGenerator.java b/...ins/modello-plugin-xdoc/src/main/java/org/codehaus/modello/plugin/xdoc/XdocGenerator.java
@@ -25,8 +25,10 @@
 import java.io.File;
 import java.io.IOException;
 import java.io.Writer;
+import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
+import java.util.Map;
 import java.util.Properties;
 import java.util.Set;
 import java.util.Stack;
@@ -42,6 +44,7 @@
 import org.codehaus.modello.model.ModelField;
 import org.codehaus.modello.model.Version;
 import org.codehaus.modello.model.VersionRange;
+import org.codehaus.modello.plugin.xdoc.metadata.XdocClassMetadata;
 import org.codehaus.modello.plugin.xdoc.metadata.XdocFieldMetadata;
 import org.codehaus.modello.plugin.xsd.XsdModelHelper;
 import org.codehaus.modello.plugins.xml.AbstractXmlGenerator;
@@ -171,11 +174,16 @@ private void generateXdoc( Properties parameters )
      * Get the anchor name by which model classes can be accessed in the generated xdoc/html file.
      *
      * @param tagName the name of the XML tag of the model class
+     * @param modelClass the model class, that eventually can have customized anchor name
      * @return the corresponding anchor name
      */
-    private String getAnchorName( String tagName )
+    private String getAnchorName( String tagName, ModelClass modelClass )
     {
-        return "class_" + tagName ;
+        XdocClassMetadata xdocClassMetadata = (XdocClassMetadata) modelClass.getMetadata( XdocClassMetadata.ID );
+
+        String anchorName = xdocClassMetadata.getAnchorName();
+
+        return "class_" + ( anchorName == null ? tagName : anchorName );
     }
 
     /**
@@ -186,7 +194,7 @@ private String getAnchorName( String tagName )
      */
     private void writeModelDescriptor( XMLWriter w, ModelClass rootModelClass )
     {
-        writeElementDescriptor( w, rootModelClass, null, new HashSet<String>() );
+        writeElementDescriptor( w, rootModelClass, null, new HashSet<>(), new HashMap<>() );
     }
 
     /**
@@ -195,26 +203,37 @@ private void writeModelDescriptor( XMLWriter w, ModelClass rootModelClass )
      * @param w the output writer
      * @param modelClass the mode class to describe
      * @param association the association we are coming from (can be <code>null</code>)
-     * @param written set of data already written
+     * @param writtenIds set of data already written ids
+     * @param writtenAnchors map of already written anchors with corresponding ids
      */
     private void writeElementDescriptor( XMLWriter w, ModelClass modelClass, ModelAssociation association,
-                                         Set<String> written )
+                                         Set<String> writtenIds, Map<String, String> writtenAnchors )
     {
         String tagName = resolveTagName( modelClass, association );
 
         String id = getId( tagName, modelClass );
-        if ( written.contains( id ) )
+        if ( writtenIds.contains( id ) )
         {
             // tag already written for this model class accessed as this tag name
             return;
         }
-        written.add( id );
+        writtenIds.add( id );
 
-        written.add( tagName );
+        String anchorName = getAnchorName( tagName, modelClass );
+        if ( writtenAnchors.containsKey( anchorName ) )
+        {
+            // TODO use logging API?
+            System.out.println( "[warn] model class " + id + " with tagName " + tagName + " gets duplicate anchorName "
+                + anchorName + ", conflicting with model class " + writtenAnchors.get( anchorName ) );
+        }
+        else
+        {
+            writtenAnchors.put( anchorName, id );
+        }
 
         w.startElement( "a" );
 
-        w.addAttribute( "name", getAnchorName( tagName ) );
+        w.addAttribute( "name", anchorName );
 
         w.endElement();
 
@@ -257,9 +276,9 @@ private void writeElementDescriptor( XMLWriter w, ModelClass modelClass, ModelAs
                 ModelAssociation assoc = (ModelAssociation) f;
                 ModelClass fieldModelClass = getModel().getClass( assoc.getTo(), getGeneratedVersion() );
 
-                if ( !written.contains( getId( resolveTagName( fieldModelClass, assoc ), fieldModelClass ) ) )
+                if ( !writtenIds.contains( getId( resolveTagName( fieldModelClass, assoc ), fieldModelClass ) ) )
                 {
-                    writeElementDescriptor( w, fieldModelClass, assoc, written );
+                    writeElementDescriptor( w, fieldModelClass, assoc, writtenIds, writtenAnchors );
                 }
             }
         }
@@ -350,7 +369,7 @@ private void writeFieldsTable( XMLWriter w, List<ModelField> fields, boolean ele
                 if ( isInnerAssociation( f ) )
                 {
                     w.startElement( "a" );
-                    w.addAttribute( "href", "#" + getAnchorName( itemTagName ) );
+                    w.addAttribute( "href", "#" + getAnchorName( itemTagName, assoc.getToClass() ) );
                     w.writeText( itemTagName );
                     w.endElement();
                 }
@@ -497,7 +516,7 @@ private String getElementXmlDescriptor( ModelClass modelClass, ModelAssociation
         String tagName = resolveTagName( modelClass, association );
 
         // <tagName
-        sb.append( "&lt;<a href=\"#" ).append( getAnchorName( tagName ) ).append( "\">" );
+        sb.append( "&lt;<a href=\"#" ).append( getAnchorName( tagName, modelClass ) ).append( "\">" );
         sb.append( tagName ).append( "</a>" );
 
         boolean addNewline = false;
@@ -672,7 +691,7 @@ else if ( ModelDefault.PROPERTIES.equals( f.getType() ) )
      * @param modelClass the class we are looking for the tag name
      * @param association the association where this class is used
      * @return the tag name to use
-     * @todo refactor to use resolveTagName helpers instead
+     * @todo refactor to use XmlModelHelpers.resolveTagName helpers instead
      */
     private String resolveTagName( ModelClass modelClass, ModelAssociation association )
     {

diff --git a/...lugin-xdoc/src/main/java/org/codehaus/modello/plugin/xdoc/metadata/XdocClassMetadata.java b/...lugin-xdoc/src/main/java/org/codehaus/modello/plugin/xdoc/metadata/XdocClassMetadata.java
@@ -31,4 +31,16 @@ public class XdocClassMetadata
     implements ClassMetadata
 {
     public static final String ID = XdocClassMetadata.class.getName();
+
+    private String anchorName;
+
+    public String getAnchorName()
+    {
+        return anchorName;
+    }
+
+    public void setAnchorName( String anchorName )
+    {
+        this.anchorName = anchorName;
+    }
 }
diff --git a/...ugin-xdoc/src/main/java/org/codehaus/modello/plugin/xdoc/metadata/XdocMetadataPlugin.java b/...ugin-xdoc/src/main/java/org/codehaus/modello/plugin/xdoc/metadata/XdocMetadataPlugin.java
@@ -46,10 +46,15 @@ public class XdocMetadataPlugin
     implements MetadataPlugin
 {
     public static final String XDOC_SEPARATOR = "xdoc.separator";
+    public static final String XDOC_ANCHORNAME = "xdoc.anchorName";
 
     public ClassMetadata getClassMetadata( ModelClass clazz, Map<String, String> data )
     {
-        return new XdocClassMetadata();
+        XdocClassMetadata metadata = new XdocClassMetadata();
+
+        metadata.setAnchorName( getString( data, XDOC_ANCHORNAME ) );
+
+        return metadata;
     }
 
     public InterfaceMetadata getInterfaceMetadata( ModelInterface iface, Map<String, String> data )

diff --git a/...modello-plugin-xdoc/src/test/java/org/codehaus/modello/plugin/xdoc/XdocGeneratorTest.java b/...modello-plugin-xdoc/src/test/java/org/codehaus/modello/plugin/xdoc/XdocGeneratorTest.java
@@ -69,8 +69,9 @@ public void testXdocGenerator()
         checkFeaturesXdocGenerator();
         checkSettingsXdocGenerator();
     }
-
-    public void testHtmlToXml() throws Exception
+
+    public void testHtmlToXml()
+        throws Exception
     {
         ModelloCore modello = (ModelloCore) lookup( ModelloCore.ROLE );
 
@@ -79,11 +80,11 @@ public void testHtmlToXml() throws Exception
         Properties parameters = getModelloParameters( "1.0.0" );
 
         modello.generate( model, "xdoc", parameters );
-        
+
         Diff diff = DiffBuilder.compare( Input.fromStream( XdocGeneratorTest.class.getResourceAsStream( "/html4.expected.xml" ) ) )
                    .withTest( Input.fromFile( new File( getOutputDirectory(), "html4.xml" ) ) ).build();
-        
-        assertFalse(diff.toString(), diff.hasDifferences());
+
+        assertFalse( diff.toString(), diff.hasDifferences() );
     }
 
     private void checkMavenXdocGenerator()
@@ -166,7 +167,7 @@ public void checkSettingsXdocGenerator()
 
         String content = FileUtils.fileRead( new File( getOutputDirectory(), "settings.xml" ), "UTF-8" );
 
-        assertTrue( "Properties field was erroneously documented", !content.contains("&lt;properties/&gt;"));
+        assertTrue( "Properties field was erroneously documented", !content.contains("&lt;properties/&gt;") );
     }
 
     /**

diff --git a/pom.xml b/pom.xml
@@ -616,7 +616,7 @@
               <models>
                 <model>src/main/mdo/modello.mdo</model>
               </models>
-              <version>1.8.0</version>
+              <version>2.0.0</version>
             </configuration>
             <executions>
               <execution>

diff --git a/src/main/mdo/modello.mdo b/src/main/mdo/modello.mdo
@@ -441,6 +441,15 @@
           </description>
           <comment>see org.codehaus.modello.plugin.model.ModelMetadataPlugin</comment>
         </field>
+        <field xml.attribute="true" xml.tagName="xdoc.anchorName">
+          <name>anchorName</name>
+          <version>2.0.0+</version>
+          <type>String</type>
+          <description>
+            Define a anchor base name to be used in XML content, which can be different from the XML tag name name.
+          </description>
+          <comment>see org.codehaus.modello.plugin.model.ModelMetadataPlugin</comment>
+        </field>
         <field xml.attribute="true" xml.tagName="java.enabled">
           <name>enabled</name>
           <version>1.0.0+</version>