0.8.4 (2023-01-26)

+ [fj-doc-base - Enable charset selection for
DocTypeHandlerXML](#17)

Signed-off-by: Matteo Franci a.k.a. Fugerit <m@fugerit.org>

Author: fugerit79

docgen/parameters.json

@@ -1,8 +1,8 @@
 {
 	"title" : "Venus (Fugerit Document Generation Framework)",
 	"name": "Venus",
-	"version" : "0.8.3",
-	"date" : "24/01/2023",
+	"version" : "0.8.4",
+	"date" : "26/01/2023",
 	"organization" : {
 		"name" : "Fugerit Org",
 		"url" : "https://www.fugerit.org"

docgen/release-notes.txt

@@ -1,6 +1,10 @@
-0.8.3 (2023-01-24)
+0.8.4 (2023-01-26)
 ------------------
-+ [fj-doc-mod-fop - need to create FopConfigClassLoaderWrapper with default ResourceResolver]([0.5.2](https://github.com/fugerit-org/fj-doc/issues/15))
++ [fj-doc-base - Enable charset selection for DocTypeHandlerXML](https://github.com/fugerit-org/fj-doc/issues/17)
+
+0.8.3 (2023-01-24)
+------------------
++ [fj-doc-mod-fop - need to create FopConfigClassLoaderWrapper with default ResourceResolver](https://github.com/fugerit-org/fj-doc/issues/15)
 
 0.8.2 (2023-01-22)
 ------------------

fj-doc-base/src/main/java/org/fugerit/java/doc/base/config/DocCharsetProvider.java

@@ -0,0 +1,28 @@
+package org.fugerit.java.doc.base.config;
+
+import java.nio.charset.Charset;
+
+import org.fugerit.java.core.util.ObjectUtils;
+
+public abstract class DocCharsetProvider {
+
+	public abstract Charset resolveCharset( Charset charset );
+	
+	public static final DocCharsetProvider DEFAULT = new DocCharsetProvider() {
+		@Override
+		public Charset resolveCharset(Charset charset) {
+			return ObjectUtils.objectWithDefault( charset , Charset.defaultCharset() );
+		}
+	}; 
+	
+	private static DocCharsetProvider defaultProvider = DEFAULT;
+
+	public static DocCharsetProvider getDefaultProvider() {
+		return defaultProvider;
+	}
+
+	public static void setDefaultProvider(DocCharsetProvider defaultProvider) {
+		DocCharsetProvider.defaultProvider = defaultProvider;
+	}
+	
+}

fj-doc-base/src/main/java/org/fugerit/java/doc/base/config/DocTypeHandler.java

@@ -1,5 +1,7 @@
 package org.fugerit.java.doc.base.config;
 
+import java.nio.charset.Charset;
+
 import org.fugerit.java.core.util.collection.KeyString;
 
 public interface DocTypeHandler extends KeyString {
@@ -10,6 +12,8 @@ public interface DocTypeHandler extends KeyString {
 
 	String getMime();
 
+	Charset getCharset();
+	
 	void handle( DocInput docInput, DocOutput docOutput ) throws Exception;
 
 }

fj-doc-base/src/main/java/org/fugerit/java/doc/base/config/DocTypeHandlerDecorator.java

@@ -0,0 +1,33 @@
+package org.fugerit.java.doc.base.config;
+
+import org.fugerit.java.core.cfg.ConfigException;
+import org.w3c.dom.Element;
+
+public class DocTypeHandlerDecorator extends DocTypeHandlerDefault {
+
+	private static final long serialVersionUID = 5531355008187717238L;
+	
+	private DocTypeHandler handler;
+	
+	public DocTypeHandlerDecorator( DocTypeHandler handler ) {
+		super( handler.getType(), handler.getModule(), handler.getMime(), handler.getCharset() );
+		this.handler = handler;
+	}
+
+	public DocTypeHandler unwrap() {
+		return handler;
+	}
+
+	@Override
+	public void handle(DocInput docInput, DocOutput docOutput) throws Exception {
+		this.handler.handle(docInput, docOutput);
+	}
+
+	@Override
+	public void configure(Element tag) throws ConfigException {
+		if ( this.handler instanceof DocTypeHandlerDefault ) {
+			((DocTypeHandlerDefault)this.handler).configure(tag);
+		}
+	}
+
+}

fj-doc-base/src/main/java/org/fugerit/java/doc/base/config/DocTypeHandlerDefault.java

@@ -1,11 +1,14 @@
 package org.fugerit.java.doc.base.config;
 
 import java.io.Serializable;
+import java.nio.charset.Charset;
 
 import org.fugerit.java.core.cfg.ConfigException;
 import org.fugerit.java.core.cfg.helpers.XMLConfigurableObject;
+import org.fugerit.java.core.lang.helpers.StringUtils;
 import org.fugerit.java.doc.base.helper.DefaultMimeHelper;
 import org.w3c.dom.Element;
+import org.w3c.dom.NodeList;
 
 public class DocTypeHandlerDefault extends XMLConfigurableObject implements DocTypeHandler, Serializable {
 
@@ -14,12 +17,18 @@ public class DocTypeHandlerDefault extends XMLConfigurableObject implements DocT
 	 */
 	private static final long serialVersionUID = -5024985828785381015L;
 
+	public static final String TAG_NAME_CONFIG = "config";
+	
+	public static final String ATT_NAME_CHARSET = "charset";
+	
 	private String type;
 
 	private String module;
 
 	private String mime;
 
+	private Charset charset;
+	
 	@Override
 	public String getMime() {
 		String res = this.mime;
@@ -44,16 +53,26 @@ public String getModule() {
 		return module;
 	}
 
+	@Override
+	public Charset getCharset() {
+		return charset;
+	}
+
 	@Override
 	public void handle(DocInput docInput, DocOutput docOutput) throws Exception {
 
 	}
-
-	public DocTypeHandlerDefault(String type, String module, String mime) {
+	
+	public DocTypeHandlerDefault(String type, String module, String mime, Charset charset) {
 		super();
 		this.type = type;
 		this.module = module;
 		this.mime = mime;
+		this.charset = DocCharsetProvider.getDefaultProvider().resolveCharset(charset);
+	}
+	
+	public DocTypeHandlerDefault(String type, String module, String mime) {
+		this( type, module, mime, null );
 	}
 
 	public DocTypeHandlerDefault(String type, String module ) {
@@ -64,8 +83,21 @@ public static final String createKey( String type, String mod ) {
 		return type+"-"+mod;
 	}
 
+	protected void handleConfigTag( Element config ) throws ConfigException {
+		
+	}
+	
 	@Override
 	public void configure(Element tag) throws ConfigException {
+		NodeList nl = tag.getElementsByTagName( TAG_NAME_CONFIG );
+		if ( nl.getLength() > 0 ) {
+			Element config = (Element)nl.item( 0 );
+			String charsetAtt = config.getAttribute( ATT_NAME_CHARSET );
+			if ( StringUtils.isNotEmpty( charsetAtt ) ) {
+				this.charset = Charset.forName( charsetAtt );
+			}
+			this.handleConfigTag(config);
+		}
 	}
 
 }

fj-doc-base/src/main/java/org/fugerit/java/doc/base/config/DocTypeHandlerXML.java

@@ -1,6 +1,8 @@
 package org.fugerit.java.doc.base.config;
 
 import java.io.OutputStreamWriter;
+import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
 
 import org.fugerit.java.core.io.StreamIO;
 
@@ -13,17 +15,23 @@ public class DocTypeHandlerXML extends DocTypeHandlerDefault {
 
 	public static final DocTypeHandler HANDLER = new DocTypeHandlerXML();
 
+	public static final DocTypeHandler HANDLER_UTF8 = new DocTypeHandlerXML( StandardCharsets.UTF_8 );
+	
 	public static final String TYPE = DocConfig.TYPE_XML;
 
 	public static final String MODULE = "doc";
 
+	public DocTypeHandlerXML( Charset charset ) {
+		super( TYPE, MODULE, null, charset );
+	}
+	
 	public DocTypeHandlerXML() {
 		super( TYPE, MODULE );
 	}
 
 	@Override
 	public void handle(DocInput docInput, DocOutput docOutput) throws Exception {
-		StreamIO.pipeCharCloseBoth( docInput.getReader() , new OutputStreamWriter( docOutput.getOs() ) );
+		StreamIO.pipeCharCloseBoth( docInput.getReader() , new OutputStreamWriter( docOutput.getOs(), this.getCharset() ) );
 	}
 
 }

fj-doc-base/src/main/java/org/fugerit/java/doc/base/config/DocTypeHandlerXMLUTF8.java

@@ -0,0 +1,13 @@
+package org.fugerit.java.doc.base.config;
+
+public class DocTypeHandlerXMLUTF8 extends DocTypeHandlerDecorator {
+
+	private static final long serialVersionUID = -8512962187951518109L;
+
+	public static final DocTypeHandler HANDLER = new DocTypeHandlerXMLUTF8();
+	
+	public DocTypeHandlerXMLUTF8() {
+		super( DocTypeHandlerXML.HANDLER_UTF8 );
+	}
+	
+}

fj-doc-base/src/main/java/org/fugerit/java/doc/base/typehandler/markdown/AbstractCustomMarkdownTypeHandler.java

@@ -1,5 +1,7 @@
 package org.fugerit.java.doc.base.typehandler.markdown;
 
+import java.nio.charset.Charset;
+
 import org.fugerit.java.doc.base.config.DocConfig;
 import org.fugerit.java.doc.base.config.DocTypeHandlerDefault;
 
@@ -11,11 +13,19 @@ public abstract class AbstractCustomMarkdownTypeHandler extends DocTypeHandlerDe
 
 	public static final String MIME = "text/x-markdown";
 
-	public AbstractCustomMarkdownTypeHandler( boolean printComments ) {
-		super(TYPE, MODULE, MIME);
+	public AbstractCustomMarkdownTypeHandler( Charset charset, boolean printComments ) {
+		super(TYPE, MODULE, MIME, charset);
 		this.printComments = printComments;
 	}
 
+	public AbstractCustomMarkdownTypeHandler( Charset charset ) {
+		this( charset, MarkdownBasicDocFacade.DEFAULT_PRINT_COMMENTS );
+	}
+	
+	public AbstractCustomMarkdownTypeHandler( boolean printComments ) {
+		this( null, printComments );
+	}
+	
 	public AbstractCustomMarkdownTypeHandler() {
 		this( MarkdownBasicDocFacade.DEFAULT_PRINT_COMMENTS );
 	}

fj-doc-base/src/main/java/org/fugerit/java/doc/base/typehandler/markdown/SimpleMarkdownBasicTypeHandler.java

@@ -2,6 +2,8 @@
 
 import java.io.OutputStreamWriter;
 import java.io.PrintWriter;
+import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
 
 import org.fugerit.java.doc.base.config.DocInput;
 import org.fugerit.java.doc.base.config.DocOutput;
@@ -24,6 +26,10 @@ public class SimpleMarkdownBasicTypeHandler extends AbstractCustomMarkdownTypeHa
 
 	public static final DocTypeHandler HANDLER_NOCOMMENTS = new SimpleMarkdownBasicTypeHandler( false );
 
+	public static final DocTypeHandler HANDLER_UTF8 = new SimpleMarkdownBasicTypeHandler( StandardCharsets.UTF_8 );
+	
+	public static final DocTypeHandler HANDLER_NOCOMMENTS_UTF8 = new SimpleMarkdownBasicTypeHandler( StandardCharsets.UTF_8, false );
+	
 	/**
 	 * 
 	 */
@@ -35,15 +41,21 @@ public SimpleMarkdownBasicTypeHandler() {
 		super();
 	}
 
-
-
 	public SimpleMarkdownBasicTypeHandler(boolean printComments) {
 		super(printComments);
 	}
 
+	public SimpleMarkdownBasicTypeHandler(Charset charset, boolean printComments) {
+		super(charset, printComments);
+	}
+
+	public SimpleMarkdownBasicTypeHandler(Charset charset) {
+		super(charset);
+	}
+
 	@Override
 	public void handle(DocInput docInput, DocOutput docOutput) throws Exception {
-		PrintWriter writer = new PrintWriter( new OutputStreamWriter( docOutput.getOs() ) );
+		PrintWriter writer = new PrintWriter( new OutputStreamWriter( docOutput.getOs(), this.getCharset() ) );
 		DocBase docBase = docInput.getDoc();
 		/*
 		 * The key for building a DocTypeHandler is to correctly renders