[DOXIA-614] Support obtaining the source reference in a Doxia Parser

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.9.1
• Fix Version/s: 1.10
• Component/s: Core, Modules, Site Renderer (moved to DOXIASITETOOLS)
• Assignee: Sylwester Lachiewicz
• Reporter: Abel Salgado Romero
• Created: 27/Jun/20 12:05
• Updated: 23/Dec/21 10:21
• Resolved: 30/May/21 16:18

Description

Currently, the 'org.apache.maven.doxia.parser.Parser' interface provides 2 methods that parsers can implement, one with and the other without the source reference. However, in reality the one with the reference added in DOXIA-224 is never invoked, thus making it unusable from maven-site-plugin.

Methods are:

• void parse( Reader source, Sink sink )
• void parse( Reader source, Sink sink, String reference )

 

1. Base implementation 'org.apache.maven.doxia.parser.AbstractParser' ('doxia-core') of the reference method calls the other, removing the reference if it is provided.

 public void parse( Reader source, Sink sink, String reference )
 throws ParseException
 {
 parse( source, sink );
 }

2. In 'org.apache.maven.doxia.DefaultDoxia#parse' ('doxia-core') the parser method 'parser (reader, sink)' is called at the end, which means 'parser(reader, sink, reference)' is never used.

 

public void parse( Reader source, String parserId, Sink sink )
 throws ParserNotFoundException, ParseException
 {
  Parser parser = parserManager.getParser( parserId );
  parser.enableLogging( new PlexusLoggerWrapper( getLogger() ) );
  parser.parse( source, sink );
 }

 

3. 'org.apache.maven.doxia.Doxia#parse(Reader source, String parserId, Sink sink )' and it's implementation 'DefaultDoxia' ('doxia-core') does not receive the source reference, so it cannot pass it in any way.

 

For these 3 reasons, 'org.apache.maven.doxia.siterenderer.DefaultSiteRenderer#renderDocument' ('doxia-sitetools') who has the source reference is not able to pass it to the above components.

To sum up, the chaing of calls is: DefaultSiteRenderer -> Doxia/DefaultDoxia -> Parser implementation (e.g. AbstractParser)

 

After discussion with hboutemy the proposal is to fix it in several steps to avoid using SNAPSHOTS and ensure no breaking points:

1. Change doxia-core components to support new method with "reference", still having both methods. This means, changing AbstractParser and it's implementations to recieve the "reference". This does not break anything since no one is using this param now.
2. Change doxia-sitetools's 'DefaultSiteRenderer' component to pass the reference to Doxia/DefautDoxia DOXIASITETOOLS-225.
3. Release new doxia-sitetools version.
4. Once released, modifty doxia-core components to pass the reference and remove the (Reader, Sink)  method completely. Also, in advance that Parsers may need more information about the source, instead of passing "String reference", we will pass a new class "SourceMetadata" that encapsulates the "String reference. That way we can add more information in the future if needed.

 

 

Issue Links

• is required by: DOXIASITETOOLS-225 Support providing the source reference to Doxia Parsers
• supercedes: DOXIA-224 Add source name in parser
• links to: GitHub Pull Request #19
• links to: GitHub Pull Request #35