Split xmlreader into nodes and reader modules

11 files changed, 90 insertions, 82 deletions

diff --git a/lib/docx/office-xml-reader.js b/lib/docx/office-xml-reader.js
index 71f5b57..b5231eb 100644
--- a/lib/docx/office-xml-reader.js
+++ b/lib/docx/office-xml-reader.js
@@ -1,5 +1,5 @@
 var promises = require("../promises");
-var xmlreader = require("../xmlreader");
+var xml = require("../xml");
 
 
 exports.readXmlFromZipFile = readXmlFromZipFile;
@@ -17,7 +17,7 @@ var xmlNamespaceMap = {
 
 
 function read(xmlString) {
-    return xmlreader.read(xmlString, xmlNamespaceMap);
+    return xml.readString(xmlString, xmlNamespaceMap);
 }
 
 
diff --git a/lib/xml/index.js b/lib/xml/index.js
new file mode 100644
index 0000000..6c35998
--- /dev/null
+++ b/lib/xml/index.js
@@ -0,0 +1,2 @@
+exports.Element = require("./nodes").Element;
+exports.readString = require("./reader").readString;
diff --git a/lib/xml/nodes.js b/lib/xml/nodes.js
new file mode 100644
index 0000000..ed273cf
--- /dev/null
+++ b/lib/xml/nodes.js
@@ -0,0 +1,60 @@
+var _ = require("underscore");
+
+
+exports.Element = Element;
+
+
+var emptyElement = {
+    first: function() {
+        return null;
+    },
+    firstOrEmpty: function() {
+        return emptyElement;
+    },
+    attributes: {}
+};
+
+function Element(name, attributes, children) {
+    this.type = "element";
+    this.name = name;
+    this.attributes = attributes || {};
+    this.children = children || [];
+}
+
+Element.prototype.first = function(name) {
+    return _.find(this.children, function(child) {
+        return child.name == name;
+    });
+};
+
+Element.prototype.firstOrEmpty = function(name) {
+    return this.first(name) || emptyElement;
+};
+
+Element.prototype.getElementsByTagName = function(name) {
+    var elements = _.filter(this.children, function(child) {
+        return child.name == name;
+    });
+    return toElementList(elements);
+};
+
+Element.prototype.text = function() {
+    if (this.children.length === 0) {
+        return "";
+    } else if (this.children.length !== 1 || this.children[0].type !== "text") {
+        throw new Error("Not implemented");
+    }
+    return this.children[0].value;
+};
+
+var elementListPrototype = {
+    getElementsByTagName: function(name) {
+        return toElementList(_.flatten(this.map(function(element) {
+            return element.getElementsByTagName(name);
+        }, true)));
+    }
+};
+
+function toElementList(array) {
+    return _.extend(array, elementListPrototype);
+}
diff --git a/lib/xmlreader.js b/lib/xml/reader.js
index 551366f..ab175f2 100644
--- a/lib/xmlreader.js
+++ b/lib/xml/reader.js
@@ -1,11 +1,12 @@
-var promises = require("./promises");
+var promises = require("../promises");
 var sax = require("sax");
 var _ = require("underscore");
 
-exports.read = read;
-exports.Element = Element;
+var Element = require("./nodes").Element;
 
-function read(xmlString, namespaceMap) {
+exports.readString = readString;
+
+function readString(xmlString, namespaceMap) {
     namespaceMap = namespaceMap || {};
     
     var finished = false;
@@ -84,58 +85,3 @@ function mapObject(input, valueFunc, keyFunc) {
         return result;
     }, {});
 }
-
-var emptyElement = {
-    first: function() {
-        return null;
-    },
-    firstOrEmpty: function() {
-        return emptyElement;
-    },
-    attributes: {}
-};
-
-function Element(name, attributes, children) {
-    this.type = "element";
-    this.name = name;
-    this.attributes = attributes || {};
-    this.children = children || [];
-}
-
-Element.prototype.first = function(name) {
-    return _.find(this.children, function(child) {
-        return child.name == name;
-    });
-};
-
-Element.prototype.firstOrEmpty = function(name) {
-    return this.first(name) || emptyElement;
-};
-
-Element.prototype.getElementsByTagName = function(name) {
-    var elements = _.filter(this.children, function(child) {
-        return child.name == name;
-    });
-    return toElementList(elements);
-};
-
-Element.prototype.text = function() {
-    if (this.children.length === 0) {
-        return "";
-    } else if (this.children.length !== 1 || this.children[0].type !== "text") {
-        throw new Error("Not implemented");
-    }
-    return this.children[0].value;
-};
-
-var elementListPrototype = {
-    getElementsByTagName: function(name) {
-        return toElementList(_.flatten(this.map(function(element) {
-            return element.getElementsByTagName(name);
-        }, true)));
-    }
-};
-
-function toElementList(array) {
-    return _.extend(array, elementListPrototype);
-}
diff --git a/tests/document-to-html.tests.js b/tests/document-to-html.tests.js
index aef6dfb..323efb6 100644
--- a/tests/document-to-html.tests.js
+++ b/tests/document-to-html.tests.js
@@ -6,7 +6,7 @@ var documents = require("../lib/documents");
 var DocumentConverter = require("../lib/document-to-html").DocumentConverter;
 var test = require("./testing").test;
 var htmlPaths = require("../lib/html-paths");
-var xmlreader = require("../lib/xmlreader");
+var xml = require("../lib/xml");
 var results = require("../lib/results");
 var documentMatchers = require("../lib/document-matchers");
 
@@ -459,7 +459,7 @@ describe('DocumentConverter', function() {
         var converter = new DocumentConverter();
         return converter.convertToHtml(image)
             .then(function(result) {
-                return xmlreader.read(result.value);
+                return xml.readString(result.value);
             })
             .then(function(htmlImageElementDocument) {
                 var htmlImageElement = htmlImageElementDocument.root;
diff --git a/tests/docx/body-reader.tests.js b/tests/docx/body-reader.tests.js
index 172da76..ad2caa2 100644
--- a/tests/docx/body-reader.tests.js
+++ b/tests/docx/body-reader.tests.js
@@ -3,7 +3,7 @@ var path = require("path");
 
 var BodyReader = require("../../lib/docx/body-reader").BodyReader;
 var documents = require("../../lib/documents");
-var XmlElement = require("../../lib/xmlreader").Element;
+var XmlElement = require("../../lib/xml").Element;
 var Numbering = require("../../lib/docx/numbering-xml").Numbering;
 var Styles = require("../../lib/docx/styles-reader").Styles;
 var warning = require("../../lib/results").warning;
diff --git a/tests/docx/content-types-reader.tests.js b/tests/docx/content-types-reader.tests.js
index b0f135e..3b8c1d3 100644
--- a/tests/docx/content-types-reader.tests.js
+++ b/tests/docx/content-types-reader.tests.js
@@ -1,7 +1,7 @@
 var assert = require("assert");
 
 var readContentTypesFromXml = require("../../lib/docx/content-types-reader").readContentTypesFromXml;
-var XmlElement = require("../../lib/xmlreader").Element;
+var XmlElement = require("../../lib/xml").Element;
 var test = require("../testing").test;
 
 
diff --git a/tests/docx/notes-reader.tests.js b/tests/docx/notes-reader.tests.js
index 0cfb626..79ffed3 100644
--- a/tests/docx/notes-reader.tests.js
+++ b/tests/docx/notes-reader.tests.js
@@ -3,7 +3,7 @@ var assert = require("assert");
 var createFootnotesReader = require("../../lib/docx/notes-reader").createFootnotesReader;
 var BodyReader = require("../../lib/docx/body-reader").BodyReader;
 var documents = require("../../lib/documents");
-var XmlElement = require("../../lib/xmlreader").Element;
+var XmlElement = require("../../lib/xml").Element;
 var test = require("../testing").test;
 
 
diff --git a/tests/docx/numbering-xml.tests.js b/tests/docx/numbering-xml.tests.js
index 55c94e5..2fea5fb 100644
--- a/tests/docx/numbering-xml.tests.js
+++ b/tests/docx/numbering-xml.tests.js
@@ -1,7 +1,7 @@
 var duck = require("duck");
 
 var readNumberingXml = require("../../lib/docx/numbering-xml").readNumberingXml;
-var XmlElement = require("../../lib/xmlreader").Element;
+var XmlElement = require("../../lib/xml").Element;
 var test = require("../testing").test;
 
 
diff --git a/tests/docx/styles-reader.tests.js b/tests/docx/styles-reader.tests.js
index 73a9050..2bdda33 100644
--- a/tests/docx/styles-reader.tests.js
+++ b/tests/docx/styles-reader.tests.js
@@ -1,7 +1,7 @@
 var assert = require("assert");
 
 var readStylesXml = require("../../lib/docx/styles-reader").readStylesXml;
-var XmlElement = require("../../lib/xmlreader").Element;
+var XmlElement = require("../../lib/xml").Element;
 var test = require("../testing").test;
 
 
diff --git a/tests/xmlreader.tests.js b/tests/xml/reader.tests.js
index 842e300..49bcab5 100644
--- a/tests/xmlreader.tests.js
+++ b/tests/xml/reader.tests.js
@@ -1,36 +1,36 @@
 var assert = require("assert");
 
-var xmlreader = require("../lib/xmlreader");
-var test = require("./testing").test;
+var xmlreader = require("../../lib/xml/reader");
+var test = require("../testing").test;
 
 
-describe('xmlreader.read', function() {
+describe('xmlreader.readString', function() {
     test('should read self-closing element', function() {
-        return xmlreader.read("<body/>").then(function(result) {
+        return xmlreader.readString("<body/>").then(function(result) {
             assert.deepEqual({type: "element", name: "body", attributes: {}, children: []}, result.root);
         });
     });
     
     test('should read empty element with separate closing tag', function() {
-        return xmlreader.read("<body></body>").then(function(result) {
+        return xmlreader.readString("<body></body>").then(function(result) {
             assert.deepEqual({type: "element", name: "body", attributes: {}, children: []}, result.root);
         });
     });
     
     test('should read attributes of tags', function() {
-        return xmlreader.read('<body name="bob"/>').then(function(result) {
+        return xmlreader.readString('<body name="bob"/>').then(function(result) {
             assert.deepEqual({name: "bob"}, result.root.attributes);
         });
     });
     
     test('can read text element', function() {
-        return xmlreader.read('<body>Hello!</body>').then(function(result) {
+        return xmlreader.readString('<body>Hello!</body>').then(function(result) {
             assert.deepEqual({type: "text", value: "Hello!"}, result.root.children[0]);
         });
     });
     
     test('should read element with children', function() {
-        return xmlreader.read("<body><a/><b/></body>").then(function(result) {
+        return xmlreader.readString("<body><a/><b/></body>").then(function(result) {
             var root = result.root;
             assert.equal(2, root.children.length);
             assert.equal("a", root.children[0].name);
@@ -39,7 +39,7 @@ describe('xmlreader.read', function() {
     });
 
     test('unmapped namespaces URIs are included in braces as prefix', function() {
-        return xmlreader.read('<w:body xmlns:w="word"/>').then(function(result) {
+        return xmlreader.readString('<w:body xmlns:w="word"/>').then(function(result) {
             assert.deepEqual(result.root.name, "{word}:body");
         });
     });
@@ -49,7 +49,7 @@ describe('xmlreader.read', function() {
             "word": "x"
         };
         
-        return xmlreader.read('<w:body xmlns:w="word"/>', namespaceMap).then(function(result) {
+        return xmlreader.readString('<w:body xmlns:w="word"/>', namespaceMap).then(function(result) {
             assert.deepEqual(result.root.name, "x:body");
         });
     });
@@ -59,26 +59,26 @@ describe('xmlreader.read', function() {
             "word": "x"
         };
         var xmlString = '<w:body xmlns:w="word" w:val="Hello!"/>';
-        return xmlreader.read(xmlString, namespaceMap).then(function(result) {
+        return xmlreader.readString(xmlString, namespaceMap).then(function(result) {
             assert.deepEqual(result.root.attributes["x:val"], "Hello!");
         });
     });
     
     test('can find first element with name', function() {
-        return xmlreader.read('<body><a/><b index="1"/><b index="2"/></body>').then(function(result) {
+        return xmlreader.readString('<body><a/><b index="1"/><b index="2"/></body>').then(function(result) {
             var first = result.root.first("b");
             assert.equal("1", first.attributes.index);
         });
     });
     
     test('whitespace between xml declaration and root tag is ignored', function() {
-        return xmlreader.read('<?xml version="1.0" ?>\n<body/>').then(function(result) {
+        return xmlreader.readString('<?xml version="1.0" ?>\n<body/>').then(function(result) {
             assert.deepEqual("body", result.root.name);
         });
     });
     
     test('error if XML is badly formed', function() {
-        return xmlreader.read("<bo").then(function(result) {
+        return xmlreader.readString("<bo").then(function(result) {
             throw new Error("Expected failure");
         }, function(error) {
             assert.ok(error);