Merge branch 'develop'

Author: fugerit79

README.md

@@ -42,7 +42,7 @@ There are five kinds of components (each components README.md contains module st
 * [Doc type validation (fj-doc-val)](fj-doc-val/README.md) - simple utilities for validating file type.
 
 ### 5. Tutorial :
-* [Playgroundt (fj-doc-playground-quarkus)](fj-doc-playground-quarkus/README.md) [since 0.7.0]
+* [Playground (fj-doc-playground-quarkus)](fj-doc-playground-quarkus/README.md) [since 0.7.0]
 * [Samples and Quickstart (fj-doc-sample)](fj-doc-sample/README.md)
 
 ### 6. Extension Type Handlers (Extension renders) :

docgen/parameters.json

@@ -1,8 +1,8 @@
 {
 	"title" : "Venus (Fugerit Document Generation Framework)",
 	"name": "Venus",
-	"version" : "0.7.0",
-	"date" : "29/12/2022",
+	"version" : "0.7.1",
+	"date" : "02/01/2023",
 	"organization" : {
 		"name" : "Fugerit Org",
 		"url" : "https://www.fugerit.org"

docgen/release-notes.txt

@@ -1,4 +1,11 @@
-0.7.0 (2022-12-29)
+0.7.1 (2023-01-02)
+------------------
++ Added conversion utility from json/yaml to xml
++ Added xml to [json/yaml conversion conventions](https://github.com/fugerit-org/fj-doc/tree/main/fj-doc-base-json/xml_conversion.md)
++ More functionalities in playground
++ Upgrade playground to quarkus 3.0.0.Alpha2
+
+0.7.0 (2022-12-29)
 ------------------
 + Added module for using json a document generator [fj-doc-base-json](https://github.com/fugerit-org/fj-doc/tree/main/fj-doc-base-json) (based on jackson)
 + Added module for using yaml a document generator [fj-doc-base-yaml](https://github.com/fugerit-org/fj-doc/tree/main/fj-doc-base-yaml) (based on jackson)

fj-doc-base-json/README.md

@@ -9,3 +9,10 @@ Add the option to use a json as document generator instead of standard xml sourc
 
 *Status* :  
 All basic features are implemented (json parsing, conversion from and to xml)
+
+*Doc Json format*  
+The xml and json format have inherent differences. this is why is important to read the [conversion conventions used](xml_conversion.md)
+
+Examples : 
+* [sample json doc](src/test/resources/sample/doc_test_01.json)
+* [sample xml doc](src/test/resources/sample/doc_test_01.xml)

fj-doc-base-json/pom.xml

@@ -7,7 +7,7 @@
 	<parent>
 		<groupId>org.fugerit.java</groupId>
 		<artifactId>fj-doc</artifactId>
-		<version>0.7.0</version>
+		<version>0.7-SNAPSHOT</version>
 	</parent>
 
 	<name>fj-doc-base-json</name>

fj-doc-base-json/src/main/java/org/fugerit/java/doc/json/parse/DocJsonToXml.java

@@ -1,13 +1,16 @@
 package org.fugerit.java.doc.json.parse;
 
 import java.io.Reader;
+import java.io.Writer;
 import java.util.Iterator;
 
 import javax.xml.parsers.DocumentBuilder;
 import javax.xml.parsers.DocumentBuilderFactory;
 
 import org.fugerit.java.core.cfg.ConfigException;
+import org.fugerit.java.core.xml.dom.DOMIO;
 import org.fugerit.java.doc.base.facade.DocFacade;
+import org.fugerit.java.doc.base.parser.DocParserContext;
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
 
@@ -65,6 +68,15 @@ private Element create( Document doc, Element parent, JsonNode current ) throws
 		return tag;
 	}
 
+	public void writerAsXml( Reader jsonReader, Writer writer ) throws ConfigException {
+		try {
+			Element root = this.convertToElement(jsonReader);
+			DOMIO.writeDOMIndent( root , writer );
+		} catch (Exception e) {
+			throw new ConfigException( "Errore converting json to xml : "+e, e );
+		}
+	}
+	
 	public Element convertToElement( Reader jsonReader ) throws ConfigException {
 		Element root = null;
 		try {
@@ -87,8 +99,8 @@ public Element convert( JsonNode json ) throws ConfigException {
 			root = this.create(doc, null, json);
 			root.setAttribute( "xmlns" , DocFacade.SYSTEM_ID );
 			root.setAttribute( "xmlns:xsi" , "http://www.w3.org/2001/XMLSchema-instance" );
-			String xsdVwersion = DocObjectMapperHelper.findVersion(json, DocFacade.CURRENT_VERSION) ;
-			root.setAttribute( "xsi:schemaLocation" , "http://javacoredoc.fugerit.org https://www.fugerit.org/data/java/doc/xsd/doc-"+xsdVwersion+".xsd" );
+			String xsdVersion = DocObjectMapperHelper.findVersion(json, DocFacade.CURRENT_VERSION) ;
+			root.setAttribute( "xsi:schemaLocation" , DocParserContext.createXsdVersionXmlns(xsdVersion) );
 		} catch (Exception e) {
 			throw  new ConfigException( "Conversion error : "+e, e );
 		}

fj-doc-base-json/src/main/java/org/fugerit/java/doc/json/parse/DocObjectMapperHelper.java

@@ -40,6 +40,7 @@ public DocObjectMapperHelper(ObjectMapper mapper) {
 		SPECIAL_PROPERTY_NAMES.add( PROPERTY_TAG );
 		SPECIAL_PROPERTY_NAMES.add( PROPERTY_TEXT );
 		SPECIAL_PROPERTY_NAMES.add( PROPERTY_ELEMENTS );
+		SPECIAL_PROPERTY_NAMES.add( PROPERTY_XSD_VERSION );
 	}
 
 	public static boolean isSpecialProperty( String propertyName ) {

fj-doc-base-json/src/main/java/org/fugerit/java/doc/json/parse/DocXmlToJson.java

@@ -0,0 +1,95 @@
+package org.fugerit.java.doc.json.parse;
+
+import java.io.Reader;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Properties;
+
+import org.fugerit.java.core.cfg.ConfigException;
+import org.fugerit.java.core.lang.helpers.StringUtils;
+import org.fugerit.java.core.xml.dom.DOMIO;
+import org.fugerit.java.core.xml.dom.DOMUtils;
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
+import org.w3c.dom.Text;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.ArrayNode;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+
+public class DocXmlToJson {
+	
+	public DocXmlToJson() {
+		this( new ObjectMapper() );
+	}
+	
+	public DocXmlToJson(ObjectMapper mapper) {
+		super();
+		this.mapper = mapper;
+	}
+
+	private ObjectMapper mapper;
+
+	private ObjectNode create( Element currentTag, ObjectNode currentNode ) throws Exception {
+		// mapping normal properties
+		Properties props = DOMUtils.attributesToProperties( currentTag );
+		for ( Object k : props.keySet() ) {
+			String key = String.valueOf( k );;
+			currentNode.put( key , props.getProperty( key ));
+		}
+		// adding special properties
+		currentNode.put( DocObjectMapperHelper.PROPERTY_TAG , currentTag.getTagName() );
+		if ( currentTag.hasChildNodes() ) {
+			NodeList list = currentTag.getChildNodes();
+			List<ObjectNode> kids = new ArrayList<>();
+			StringBuilder textBuffer = new StringBuilder();
+			for ( int k=0; k<list.getLength(); k++ ) {
+				Node currentTagChild = list.item( k );
+				if ( currentTagChild instanceof Element ) {
+					kids.add( this.create((Element)currentTagChild, this.mapper.createObjectNode()) );
+				} else if ( currentTagChild instanceof Text ) {
+					textBuffer.append( ((Text)currentTagChild).getTextContent() );
+				}
+			}
+			if ( !kids.isEmpty() ) {
+				ArrayNode kidsNode = this.mapper.createArrayNode();
+				for ( ObjectNode currentKid : kids ) {
+					kidsNode.add( currentKid );
+				}
+				currentNode.set( DocObjectMapperHelper.PROPERTY_ELEMENTS, kidsNode );
+			}
+			String text = textBuffer.toString();
+			if ( StringUtils.isNotEmpty( text ) ) {
+				currentNode.put( DocObjectMapperHelper.PROPERTY_TEXT, text );
+			}
+		}
+		return currentNode;
+	}
+	
+	public JsonNode convertToJsonNode( Reader xml ) throws ConfigException {
+		JsonNode tree;
+		try {
+			Document doc = DOMIO.loadDOMDoc( xml );
+			Element root = doc.getDocumentElement();
+			tree = this.convert( root );
+		} catch (Exception e) {
+			throw new ConfigException( "Errore converting xml to json node : "+e, e );
+		}
+		return tree;
+	}
+	
+	public JsonNode convert( Element root ) throws ConfigException {
+		JsonNode tree = null;
+		try {
+			tree = this.create( root, this.mapper.createObjectNode() );
+		} catch (Exception e) {
+			throw  new ConfigException( "Conversion error : "+e, e );
+		}
+		return tree;
+		
+	}
+	
+}

fj-doc-base-json/src/test/java/test/org/fugerit/java/doc/json/parse/TestDocXmlToJson.java

@@ -0,0 +1,40 @@
+package test.org.fugerit.java.doc.json.parse;
+
+import static org.junit.Assert.fail;
+
+import java.io.FileOutputStream;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+
+import org.fugerit.java.core.lang.helpers.ClassHelper;
+import org.fugerit.java.doc.json.parse.DocXmlToJson;
+import org.junit.Test;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.fasterxml.jackson.databind.JsonNode;
+
+public class TestDocXmlToJson {
+
+	private static final Logger logger = LoggerFactory.getLogger( TestDocXmlToJson.class );
+	
+	private void worker( String path ) {
+		try ( InputStream is = ClassHelper.loadFromDefaultClassLoader( "sample/"+path+".xml" );
+				FileOutputStream fos = new FileOutputStream( "target/"+path+".json" )) {
+			DocXmlToJson converter = new DocXmlToJson();
+			JsonNode tree = converter.convertToJsonNode( new InputStreamReader( is ) );
+			logger.info( "xml -> {}", tree);
+			fos.write( tree.toPrettyString().getBytes() );
+		} catch (Exception e) {
+			String message = "Error : "+e;
+			logger.error( message, e );
+			fail( message ) ;
+		}
+	}
+	
+	@Test
+	public void test01() {
+		this.worker( "doc_test_01" );
+	}
+	
+}