Some refactoring.

Author: manoelcampos

lua-sample-app/converter.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 echo "Converts the XML files into the current directory to Lua files, so that they can be used by the app.lua application."
 echo ""
-JAR="../target/xml2lua-1.0.jar"
+JAR="../target/xml2lua-1.0.0.jar"
 if [ ! -f "$JAR" ];
 then
    echo "$JAR package not found. Considering you have maven installed, execute the following command at the upper dir: mvn package" >&2

pom.xml

@@ -7,7 +7,7 @@
     <name>Xml2Lua</name>
     <description>Converts XML files to Lua format.</description>
     <url>http://manoelcampos.github.io/JavaXml2Lua</url>
-    <version>1.0</version>
+    <version>1.0.0</version>
     <packaging>jar</packaging>
 
     <organization>
@@ -220,6 +220,24 @@
                     </dependency>
                 </dependencies>
             </plugin>
+
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>2.10.4</version>
+                <executions>
+                    <execution>
+                        <id>attach-javadocs</id>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+
+                <configuration>
+                    <failOnError>false</failOnError>
+                </configuration>
+            </plugin>
         </plugins>
     </build>
 </project>

src/main/java/com/manoelcampos/xml2lua/Xml2Lua.java

@@ -19,53 +19,55 @@
  */
 package com.manoelcampos.xml2lua;
 
-import java.io.BufferedWriter;
-import java.io.File;
-import java.io.FileWriter;
-import java.io.IOException;
+import org.w3c.dom.*;
+import org.xml.sax.SAXException;
+import org.xml.sax.SAXParseException;
 
 import javax.xml.parsers.DocumentBuilder;
 import javax.xml.parsers.DocumentBuilderFactory;
 import javax.xml.parsers.ParserConfigurationException;
-
-import org.w3c.dom.Document;
-import org.w3c.dom.Element;
-import org.w3c.dom.NamedNodeMap;
-import org.w3c.dom.Node;
-import org.w3c.dom.NodeList;
-import org.xml.sax.SAXException;
-import org.xml.sax.SAXParseException;
+import java.io.BufferedWriter;
+import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
 
 /**
  * Converts XML files to <a href="http://lua.org">Lua</a> files.
  *
  * @author Manoel Campos da Silva Filho
  */
 public class Xml2Lua {
+    /** @see #getXmlFilePath() */
+    private final String xmlFilePath;
+    /** @see #isPrintLuaCode()  */
+    private boolean printLuaCode;
+    /** @see #isUseFirstXmlTagAsLuaTableName()  */
+    private boolean useFirstXmlTagAsLuaTableName;
 
     /**
-     * Instantiates the class to parse an XML file, generating a Lua file
-     * with the same name.
+     * Instantiates the parser to convert a XML file to a Lua file.
      *
-     * @param xmlFilePath Path to the XML file to be parsed
-     * @param printLuaCode if the generated Lua code must be printed or not
-     * @param useFirstXmlTagAsLuaTableName if true, indicates the name of the first
-     *                                     tag into the XML file will be used as the name of the
-     *                                     Lua table to be generated.
-     *                                     If false, the name of this first tag will be ignored
-     *                                     and a lua "return" command will be used instead.
-     *                                     This way, the Lua developer who will use the generated Lua file
-     *                                     can define the name he/she wants to use for the generated Lua table.
+     * @param xmlFilePath path to the XML file to be parsed
+     */
+    public Xml2Lua(final String xmlFilePath) {
+        this.xmlFilePath = xmlFilePath;
+        this.printLuaCode = true;
+        this.useFirstXmlTagAsLuaTableName = false;
+    }
+
+    /**
+     * Convert the XML file to Lua.
+     * @return true if the conversion was successful, false otherwise.
      */
-    public Xml2Lua(final String xmlFilePath, final boolean printLuaCode, final boolean useFirstXmlTagAsLuaTableName) {
+    public boolean convert() {
         try {
             final DocumentBuilderFactory docBuilderFactory = DocumentBuilderFactory.newInstance();
             final DocumentBuilder docBuilder = docBuilderFactory.newDocumentBuilder();
             final Document doc = docBuilder.parse(new File(xmlFilePath));
 
             //Normalizes text representation
             doc.getDocumentElement().normalize();
-            final String luaTableName = getLuaTableName(useFirstXmlTagAsLuaTableName, doc);
+            final String luaTableName = getLuaTableName(doc);
             final StringBuilder luaCode = new StringBuilder(luaTableName + " {\n");
 
             //Gets the attributes of the XML root node.
@@ -76,46 +78,32 @@ public Xml2Lua(final String xmlFilePath, final boolean printLuaCode, final boole
             luaCode.append(convertXmlChildNodesToLua(nodes, ""));
             luaCode.append("}");
 
-            final String luaFileName = xmlFilePath.replaceFirst("\\.xml", ".lua");
-            final FileWriter file = new FileWriter(luaFileName);
+            final FileWriter file = new FileWriter(getLuaFileName());
             try (BufferedWriter out = new BufferedWriter(file)) {
                 out.write(luaCode.toString());
             }
 
             if (printLuaCode) {
                 System.out.println(luaCode.toString());
             }
-            System.out.printf("\nLua file %s generated successfully from the %s.\n\n", luaFileName, xmlFilePath);
-        } catch (SAXParseException err) {
-            System.out.println("** Parsing error" + ", line "
-                    + err.getLineNumber() + ", uri " + err.getSystemId());
-            System.out.println(" " + err.getMessage());
+
+            return true;
         } catch (SAXException | ParserConfigurationException | IOException e) {
             throw new RuntimeException(e);
         }
     }
 
-    private String getLuaTableName(boolean useFirstXmlNodeAsLuaTableName, Document doc) {
-        if (useFirstXmlNodeAsLuaTableName) {
-            return doc.getDocumentElement().getNodeName() + " = ";
-        }
-
-        return "return ";
-    }
-
     /**
      * Converts the child elements from a given XML node to the corresponding Lua code.
      *
      * @param nodes nodes child nodes from a given XML node
      * @param space a string containing the amount of spaces to be used to indent the generated Lua code
      * @return a StringBuilder containing the Lua code generated for the child elements of the given XML node
      */
-    private static StringBuilder convertXmlChildNodesToLua(final NodeList nodes, String space) {
+    private static StringBuilder convertXmlChildNodesToLua(final NodeList nodes, final String space) {
         final StringBuilder sb = new StringBuilder();
-        space += " ";
         for (int i = 0; i < nodes.getLength(); i++) {
-            final Node node = nodes.item(i);
-            sb.append(convertXmlNodeToLua(space, node));
+            sb.append(convertXmlNodeToLua(space + " ", nodes.item(i)));
         }
 
         return sb;
@@ -124,7 +112,7 @@ private static StringBuilder convertXmlChildNodesToLua(final NodeList nodes, Str
     /**
      * Converts a XML node to the corresponding Lua code.
      *
-     * @param node the XML node to convert to Lua code
+     * @param node  the XML node to convert to Lua code
      * @param space a string containing the amount of spaces to be used to indent the generated Lua code
      * @return a StringBuilder containing the Lua code generated for the given XML node
      */
@@ -143,7 +131,7 @@ private static StringBuilder convertXmlNodeToLua(final String space, final Node
     /**
      * Converts a XML node with doesn't have any child element to the corresponding Lua code.
      *
-     * @param node the XML node to convert to Lua code
+     * @param node  the XML node to convert to Lua code
      * @param space a string containing the amount of spaces to be used to indent the generated Lua code
      * @return a StringBuilder containing the Lua code generated for the given XML node
      */
@@ -155,7 +143,7 @@ private static StringBuilder convertXmlNodeWithNoChildToLua(final Element node,
         final NamedNodeMap attrs = node.getAttributes();
         if (attrs.getLength() == 0) {
             sb.append(node.getNodeName())
-              .append(" = \"").append(value).append("\", ");
+                    .append(" = \"").append(value).append("\", ");
             return sb;
         }
 
@@ -186,7 +174,7 @@ private static String getValueOfFirstXmlChildNode(final Element node) {
     /**
      * Converts a XML node with has children elements to the corresponding Lua code.
      *
-     * @param node the XML node to convert to Lua code
+     * @param node  the XML node to convert to Lua code
      * @param space a string containing the amount of spaces to be used to indent the generated Lua code
      * @return a StringBuilder containing the Lua code generated for the given XML node
      */
@@ -210,13 +198,13 @@ private static Node getFirstAttributeFromXmlNode(final Element node) {
      * Generates the Lua code to start a Lua sub-table (a tabela which belongs to another table),
      * from a given XML node.
      *
-     * @param node the XML node to generate the code to start a Lua sub-table
+     * @param node                         the XML node to generate the code to start a Lua sub-table
      * @param xmlNodeIdAttrAsLuaTableIndex if true and the XML node has an attribute
-     *                                    named "id", such an attribute is used as the indexes
-     *                                    of the elements of the Lua sub-table to generate.
-     *                                    If it's false and there is an attribute named "id",
-     *                                    it will be included as an attribute inside the Lua sub-table.
-     * @param space a string containing the amount of spaces to be used to indent the generated Lua code
+     *                                     named "id", such an attribute is used as the indexes
+     *                                     of the elements of the Lua sub-table to generate.
+     *                                     If it's false and there is an attribute named "id",
+     *                                     it will be included as an attribute inside the Lua sub-table.
+     * @param space                        a string containing the amount of spaces to be used to indent the generated Lua code
      * @return a String containing the Lua code for the beginning of a lua sub-table generated from the XML node
      */
     private static String generateLuaSubTableFromXmlNode(final Element node, final boolean xmlNodeIdAttrAsLuaTableIndex, final String space) {
@@ -228,7 +216,7 @@ private static String generateLuaSubTableFromXmlNode(final Element node, final b
             }
 
             return space + "{\n" + space + space +
-                   firstAttr.getNodeName() + "=" + firstAttr.getNodeValue();
+                    firstAttr.getNodeName() + "=" + firstAttr.getNodeValue();
         }
 
         return space + " {\n" + space;
@@ -256,7 +244,78 @@ as the index of the Lua (sub)table.
                         .append(attrs.item(i).getNodeValue()).append("', ");
             }
         }
-        
+
         return sb.toString();
     }
+
+    /**
+     * Gets the name of the Lua file to generate, based on the XML file name.
+     *
+     * @return the name of Lua file to generate
+     */
+    public String getLuaFileName() {
+        return xmlFilePath.replaceFirst("\\.xml", ".lua");
+    }
+
+    /**
+     * Gets the name to assign for the Lua table to be generated from the XML file.
+     * @param doc the loaded XML document
+     * @return
+     */
+    private String getLuaTableName(final Document doc) {
+        if (useFirstXmlTagAsLuaTableName) {
+            return doc.getDocumentElement().getNodeName() + " = ";
+        }
+
+        return "return ";
+    }
+
+    /**
+     * Checks if the generated Lua code must be printed or not.
+     */
+    public boolean isPrintLuaCode() {
+        return printLuaCode;
+    }
+
+    /**
+     * Defines if the generated Lua code must be printed or not.
+     */
+    public Xml2Lua setPrintLuaCode(final boolean enable) {
+        this.printLuaCode = enable;
+        return this;
+    }
+
+    /**
+     * Checks if the name of the first tag into the XML file will be used as the name of the
+     * Lua table to be generated.
+     * @return if it returns true, the name of the first tag into the XML file will be used as the name of the
+     * Lua table to be generated. If it returns false, the name of this first tag will be ignored
+     * and a lua "return" command will be used instead.
+     * This way, the Lua developer who will use the generated Lua file
+     * can define the name he/she wants to use for the generated Lua table.
+     */
+    public boolean isUseFirstXmlTagAsLuaTableName() {
+        return useFirstXmlTagAsLuaTableName;
+    }
+
+    /**
+     * Defines if the name of the first tag into the XML file will be used as the name of the
+     * Lua table to be generated.
+     * @param enable if true, the name of the first tag into the XML file will be used as the name of the
+     * Lua table to be generated. If false, the name of this first tag will be ignored
+     * and a lua "return" command will be used instead.
+     * This way, the Lua developer who will use the generated Lua file
+     * can define the name he/she wants to use for the generated Lua table.
+     */
+    public Xml2Lua setUseFirstXmlTagAsLuaTableName(final boolean enable) {
+        this.useFirstXmlTagAsLuaTableName = enable;
+        return this;
+    }
+
+    /**
+     * Gets the path to the XML file to be parsed.
+     */
+    public String getXmlFilePath() {
+        return xmlFilePath;
+    }
 }

src/main/java/com/manoelcampos/xml2lua/Xml2LuaApp.java

@@ -37,7 +37,8 @@ public static void main(String[] args) {
             System.exit(-1);
         }
 
-        final String xmlFileName = args[0];
-        new Xml2Lua(xmlFileName, true, false);
+        final Xml2Lua parser = new Xml2Lua(args[0]);
+        parser.convert();
+        System.out.printf("\nLua file %s generated successfully from the %s.\n\n", parser.getLuaFileName(), parser.getXmlFilePath());
     }
 }