3bf303d9-a491-4a60-a2ec-d20b4595132f

Committed 10 Feb 2024 12:27PM UTC coverage: 84.83% (-1.0%) from 85.85%

Build # 3bf303d9-a491-4a60-a2ec-d20b4595132f

Build Type

Pull #136

circleci

Committed by

marmoure

Commit Message

[test] add unit tests for visitor and xml tag

Pull Request Pull Request #136: Feature "XDita Serialization of the AST" (#2731)

Run Details

428 of 546 branches covered (0.0%)

Branch coverage included in aggregate %.

47 of 62 new or added lines in 7 files covered. (75.81%)

53 existing lines in 19 files now uncovered.

1093 of 1247 relevant lines covered (87.65%)

20.32 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/packages/lwdita-xml/example.ts

/* eslint-disable @typescript-eslint/no-unused-vars */
import { xditaToJson, xditaToJdita, serializeToXML } from "./converter";
import { BaseNode, TextNode, TopicNode } from "@jdita/lwdita-ast/nodes";
import { storeOutputXML } from "./utils";
import path from 'path';
import fs from 'fs';

const xml =
  `<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE topic PUBLIC "-//OASIS//DTD LIGHTWEIGHT DITA Topic//EN" "lw-topic.dtd"><topic id="intro-product"><title><ph keyref="product-name"/>Overview</title><shortdesc>The<ph keyref="product-name"/> kit allows you to operate network-based home lighting through a remote control</shortdesc><body><p id="cdataTest"><![CDATA[ &%<tagname/><!--comment-->]]>The<ph keyref="product-name"/> kit includes a wireless smart lighting system that helps make the lighting in your home more energy efficient and easier to manage. The kit includes the following components:</p><dl><dlentry><dt>Remote Control</dt><dd><p>Allows you to power on, power off, and dim groups of lights on your network.</p></dd></dlentry><dlentry><dt>LED Light Bulbs</dt><dd><p>Energy-efficient network light bulbs you can install into standard light fixtures.</p></dd></dlentry></dl><fig><title><ph keyref="product-name"/>ready for installation</title><image href="../images/kit.png"><alt>Remote Lighting Kit</alt></image></fig><p id="warning">Electrical hazards can cause burns, shocks and electrocution (death).</p></body></topic>`
/**
 * XML example for testing a conversion
 *
 * @remarks
 * This is the entry point given xml string.
 * The xml needs to be preprocessed to remove all of the white space
 * and new lines from outside of the tags.
 *
 * @privateRemarks
 * TODO: Implement missing handling of newlines and spaces bewtween tags in the input xml,
 * because otherwise the first whitespace or linebreak in the XML will be considered as a text node
 * and the transformation will break.
 *
 * @example
 * The whitespace needs to be elimited from the XML before processing
 * from e.g.:
 * ```xml
 * <topic>
 *   <title>valid title</title>
 *   <body>
 *     <p>text</p>
 *   </body>
 * </topic>
 * ```
 * to this:
 * ```xml
 * <topic><title>valid title</title><body><<p>text</p></body></topic>
 * ```
 */
xditaToJdita(xml)
  .then(result => {
    // Console log an object containing the AST:
    console.log(JSON.stringify(result.json, null, 2));

    /**
     * Start the serialization
     * The second parameter is the indentation option:
     * When set to true, indentation is added to the created XML tree
     */
    const res = serializeToXML(result, true).join('');

    /**
     * For development and testing the above XML example,
     * output the XML in a file
     * and store it in the filesystem...
     */

    // If the output folder doesn't exist
    const dir = path.join(__dirname, '../../out');
    if (!fs.existsSync(dir)) {
      // create one
      fs.mkdirSync(dir);
    }
    const outputFile = "/output.xml";
    storeOutputXML(res, dir + outputFile);
    // ...and log the filepath with a success notification
    console.log("Success!\nSaved input to file " + "'./out" + outputFile + "'");
  })
  .catch(e => console.log('Failed to convert:', e));



1	/* eslint-disable @typescript-eslint/no-unused-vars */
2	import { xditaToJson, xditaToJdita, serializeToXML } from "./converter";
3	import { BaseNode, TextNode, TopicNode } from "@jdita/lwdita-ast/nodes";
4	import { storeOutputXML } from "./utils";
5	import path from 'path';
6	import fs from 'fs';
7
8	const xml =
NEW 9	`<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE topic PUBLIC "-//OASIS//DTD LIGHTWEIGHT DITA Topic//EN" "lw-topic.dtd"><topic id="intro-product"><title><ph keyref="product-name"/>Overview</title><shortdesc>The<ph keyref="product-name"/> kit allows you to operate network-based home lighting through a remote control</shortdesc><body><p id="cdataTest"><![CDATA[ &%<tagname/><!--comment-->]]>The<ph keyref="product-name"/> kit includes a wireless smart lighting system that helps make the lighting in your home more energy efficient and easier to manage. The kit includes the following components:</p><dl><dlentry><dt>Remote Control</dt><dd><p>Allows you to power on, power off, and dim groups of lights on your network.</p></dd></dlentry><dlentry><dt>LED Light Bulbs</dt><dd><p>Energy-efficient network light bulbs you can install into standard light fixtures.</p></dd></dlentry></dl><fig><title><ph keyref="product-name"/>ready for installation</title><image href="../images/kit.png"><alt>Remote Lighting Kit</alt></image></fig><p id="warning">Electrical hazards can cause burns, shocks and electrocution (death).</p></body></topic>`	×
10	/**
11	* XML example for testing a conversion
12	*
13	* @remarks
14	* This is the entry point given xml string.
15	* The xml needs to be preprocessed to remove all of the white space
16	* and new lines from outside of the tags.
17	*
18	* @privateRemarks
19	* TODO: Implement missing handling of newlines and spaces bewtween tags in the input xml,
20	* because otherwise the first whitespace or linebreak in the XML will be considered as a text node
21	* and the transformation will break.
22	*
23	* @example
24	* The whitespace needs to be elimited from the XML before processing
25	* from e.g.:
26	* ```xml
27	* <topic>
28	* <title>valid title</title>
29	* <body>
30	* <p>text</p>
31	* </body>
32	* </topic>
33	* ```
34	* to this:
35	* ```xml
36	* <topic><title>valid title</title><body><<p>text</p></body></topic>
37	* ```
38	*/
39	xditaToJdita(xml)	×
40	.then(result => {
41	// Console log an object containing the AST:
42	console.log(JSON.stringify(result.json, null, 2));	×
43
44	/**
45	* Start the serialization
46	* The second parameter is the indentation option:
47	* When set to true, indentation is added to the created XML tree
48	*/
NEW 49	const res = serializeToXML(result, true).join('');	×
50
51	/**
52	* For development and testing the above XML example,
53	* output the XML in a file
54	* and store it in the filesystem...
55	*/
56
57	// If the output folder doesn't exist
NEW 58	const dir = path.join(__dirname, '../../out');	×
NEW 59	if (!fs.existsSync(dir)) {	×
60	// create one
NEW 61	fs.mkdirSync(dir);	×
62	}
NEW 63	const outputFile = "/output.xml";	×
NEW 64	storeOutputXML(res, dir + outputFile);	×
65	// ...and log the filepath with a success notification
NEW 66	console.log("Success!\nSaved input to file " + "'./out" + outputFile + "'");	×
67	})
68	.catch(e => console.log('Failed to convert:', e));	×
69
70

evolvedbinary / jdita / 3bf303d9-a491-4a60-a2ec-d20b4595132f

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous