icdsystems/ICD.Common.Utils
1
0
Fork 0
mirror of https://github.com/ICDSystems/ICD.Common.Utils.git synced 2026-04-12 12:07:05 +00:00
Code Issues Projects Releases Packages Wiki Activity

Renaming xml utils method

Browse source
This commit is contained in:
Chris Cameron 2018-01-22 15:17:42 -05:00
parent 3c3d6fa52e
commit 5724cb3c8c
5 changed files with 45 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

8
ICD.Common.Utils.Tests/Extensions/XmlReaderExtensionsTest.cs
View file

@ -32,7 +32,7 @@ namespace ICD.Common.Utils.Tests.Extensions
Assert.IsFalse(reader.HasAttribute("attr1")); Assert.IsFalse(reader.HasAttribute("attr1"));
reader.SkipToNextElement(); reader.ReadToNextElement();
Assert.IsTrue(reader.HasAttribute("attr1")); Assert.IsTrue(reader.HasAttribute("attr1"));
Assert.IsTrue(reader.HasAttribute("attr2")); Assert.IsTrue(reader.HasAttribute("attr2"));
@ -47,7 +47,7 @@ namespace ICD.Common.Utils.Tests.Extensions
Assert.IsEmpty(reader.GetAttributes()); Assert.IsEmpty(reader.GetAttributes());
reader.SkipToNextElement(); reader.ReadToNextElement();
IcdXmlAttribute[] attributes = reader.GetAttributes().ToArray(); IcdXmlAttribute[] attributes = reader.GetAttributes().ToArray();
Assert.AreEqual(2, attributes.Length); Assert.AreEqual(2, attributes.Length);
@ -62,7 +62,7 @@ namespace ICD.Common.Utils.Tests.Extensions
Assert.Throws<FormatException>(() => reader.GetAttributeAsString("attr1")); Assert.Throws<FormatException>(() => reader.GetAttributeAsString("attr1"));
reader.SkipToNextElement(); reader.ReadToNextElement();
Assert.AreEqual("1", reader.GetAttributeAsString("attr1")); Assert.AreEqual("1", reader.GetAttributeAsString("attr1"));
Assert.AreEqual("2", reader.GetAttributeAsString("attr2")); Assert.AreEqual("2", reader.GetAttributeAsString("attr2"));
@ -77,7 +77,7 @@ namespace ICD.Common.Utils.Tests.Extensions
Assert.Throws<FormatException>(() => reader.GetAttributeAsInt("attr1")); Assert.Throws<FormatException>(() => reader.GetAttributeAsInt("attr1"));
reader.SkipToNextElement(); reader.ReadToNextElement();
Assert.AreEqual(1, reader.GetAttributeAsInt("attr1")); Assert.AreEqual(1, reader.GetAttributeAsInt("attr1"));
Assert.AreEqual(2, reader.GetAttributeAsInt("attr2")); Assert.AreEqual(2, reader.GetAttributeAsInt("attr2"));

16
ICD.Common.Utils.Tests/Xml/IcdXmlReaderTest.cs
View file

@ -26,22 +26,22 @@ namespace ICD.Common.Utils.Tests.Xml
public void HasAttributesTest() public void HasAttributesTest()
{ {
IcdXmlReader reader = new IcdXmlReader(EXAMPLE_XML); IcdXmlReader reader = new IcdXmlReader(EXAMPLE_XML);
reader.SkipToNextElement(); reader.ReadToNextElement();
Assert.IsTrue(reader.HasAttributes); Assert.IsTrue(reader.HasAttributes);
reader = new IcdXmlReader(EXAMPLE_XML_2); reader = new IcdXmlReader(EXAMPLE_XML_2);
reader.SkipToNextElement(); reader.ReadToNextElement();
Assert.IsFalse(reader.HasAttributes); Assert.IsFalse(reader.HasAttributes);
} }
public void NameTest() public void NameTest()
{ {
IcdXmlReader reader = new IcdXmlReader(EXAMPLE_XML); IcdXmlReader reader = new IcdXmlReader(EXAMPLE_XML);
reader.SkipToNextElement(); reader.ReadToNextElement();
Assert.AreEqual("Level1", reader.Name); Assert.AreEqual("Level1", reader.Name);
reader.SkipToNextElement(); reader.ReadToNextElement();
Assert.AreEqual("Level2", reader.Name); Assert.AreEqual("Level2", reader.Name);
} }
@ -49,17 +49,17 @@ namespace ICD.Common.Utils.Tests.Xml
public void ValueTest() public void ValueTest()
{ {
IcdXmlReader reader = new IcdXmlReader("<Test>test</Test>"); IcdXmlReader reader = new IcdXmlReader("<Test>test</Test>");
reader.SkipToNextElement(); reader.ReadToNextElement();
Assert.AreEqual("test", reader.Value); Assert.AreEqual("test", reader.Value);
reader = new IcdXmlReader("<Test></Test>"); reader = new IcdXmlReader("<Test></Test>");
reader.SkipToNextElement(); reader.ReadToNextElement();
Assert.AreEqual("", reader.Value); Assert.AreEqual("", reader.Value);
reader = new IcdXmlReader("<Test />"); reader = new IcdXmlReader("<Test />");
reader.SkipToNextElement(); reader.ReadToNextElement();
Assert.AreEqual(null, reader.Value); Assert.AreEqual(null, reader.Value);
} }
@ -86,7 +86,7 @@ namespace ICD.Common.Utils.Tests.Xml
public void GetAttributeTest() public void GetAttributeTest()
{ {
IcdXmlReader reader = new IcdXmlReader(EXAMPLE_XML); IcdXmlReader reader = new IcdXmlReader(EXAMPLE_XML);
reader.SkipToNextElement(); reader.ReadToNextElement();
Assert.AreEqual("1", reader.GetAttribute("attr1")); Assert.AreEqual("1", reader.GetAttribute("attr1"));
Assert.AreEqual("2", reader.GetAttribute("attr2")); Assert.AreEqual("2", reader.GetAttribute("attr2"));

12
ICD.Common.Utils.Tests/Xml/XmlUtilsTest.cs
View file

@ -54,7 +54,7 @@ namespace ICD.Common.Utils.Tests.Xml
{ {
using (IcdXmlReader reader = new IcdXmlReader(EXAMPLE_XML)) using (IcdXmlReader reader = new IcdXmlReader(EXAMPLE_XML))
{ {
reader.SkipToNextElement(); reader.ReadToNextElement();
IcdXmlAttribute[] attributes = reader.GetAttributes().ToArray(); IcdXmlAttribute[] attributes = reader.GetAttributes().ToArray();
@ -71,7 +71,7 @@ namespace ICD.Common.Utils.Tests.Xml
{ {
using (IcdXmlReader reader = new IcdXmlReader(EXAMPLE_XML)) using (IcdXmlReader reader = new IcdXmlReader(EXAMPLE_XML))
{ {
reader.SkipToNextElement(); reader.ReadToNextElement();
int value = reader.GetAttributeAsInt("attr1"); int value = reader.GetAttributeAsInt("attr1");
Assert.AreEqual(1, value); Assert.AreEqual(1, value);
@ -102,7 +102,7 @@ namespace ICD.Common.Utils.Tests.Xml
using (IcdXmlReader reader = new IcdXmlReader(nodes[3])) using (IcdXmlReader reader = new IcdXmlReader(nodes[3]))
{ {
reader.SkipToNextElement(); reader.ReadToNextElement();
Assert.AreEqual("Some text", reader.ReadInnerXml()); Assert.AreEqual("Some text", reader.ReadInnerXml());
} }
} }
@ -125,10 +125,10 @@ namespace ICD.Common.Utils.Tests.Xml
{ {
using (IcdXmlReader reader = new IcdXmlReader(EXAMPLE_XML)) using (IcdXmlReader reader = new IcdXmlReader(EXAMPLE_XML))
{ {
reader.SkipToNextElement(); reader.ReadToNextElement();
Assert.AreEqual("Level1", reader.Name); Assert.AreEqual("Level1", reader.Name);
reader.SkipToNextElement(); reader.ReadToNextElement();
Assert.AreEqual("Level2", reader.Name); Assert.AreEqual("Level2", reader.Name);
} }
} }
@ -162,7 +162,7 @@ namespace ICD.Common.Utils.Tests.Xml
{ {
using (IcdXmlReader reader = new IcdXmlReader(EXAMPLE_XML)) using (IcdXmlReader reader = new IcdXmlReader(EXAMPLE_XML))
{ {
reader.SkipToNextElement(); reader.ReadToNextElement();
IEnumerable<IcdXmlReader> results = reader.GetChildElements(); IEnumerable<IcdXmlReader> results = reader.GetChildElements();
IcdXmlReader[] children = results.ToArray(); IcdXmlReader[] children = results.ToArray();

12
ICD.Common.Utils/Xml/XmlReaderExtensions.cs
View file

@ -143,11 +143,11 @@ namespace ICD.Common.Utils.Xml
} }
/// <summary> /// <summary>
/// Skips the current node to the next element. /// Continues reading until an element is reached.
/// </summary> /// </summary>
/// <param name="extends"></param> /// <param name="extends"></param>
[PublicAPI] [PublicAPI]
public static bool SkipToNextElement(this IcdXmlReader extends) public static bool ReadToNextElement(this IcdXmlReader extends)
{ {
if (extends == null) if (extends == null)
throw new ArgumentNullException("extends"); throw new ArgumentNullException("extends");
@ -215,7 +215,7 @@ namespace ICD.Common.Utils.Xml
foreach (IcdXmlReader output in extends.GetChildElementsAsString().Select(child => new IcdXmlReader(child))) foreach (IcdXmlReader output in extends.GetChildElementsAsString().Select(child => new IcdXmlReader(child)))
{ {
output.SkipToNextElement(); output.ReadToNextElement();
yield return output; yield return output;
} }
} }
@ -233,7 +233,7 @@ namespace ICD.Common.Utils.Xml
foreach (IcdXmlReader output in extends.GetChildElementsAsString(element).Select(child => new IcdXmlReader(child))) foreach (IcdXmlReader output in extends.GetChildElementsAsString(element).Select(child => new IcdXmlReader(child)))
{ {
output.SkipToNextElement(); output.ReadToNextElement();
yield return output; yield return output;
} }
} }
@ -250,7 +250,7 @@ namespace ICD.Common.Utils.Xml
throw new ArgumentNullException("extends"); throw new ArgumentNullException("extends");
// Step into the first child. // Step into the first child.
extends.SkipToNextElement(); extends.ReadToNextElement();
while (extends.NodeType == XmlNodeType.Element || extends.NodeType == XmlNodeType.Comment) while (extends.NodeType == XmlNodeType.Element || extends.NodeType == XmlNodeType.Comment)
{ {
@ -282,7 +282,7 @@ namespace ICD.Common.Utils.Xml
throw new ArgumentNullException("extends"); throw new ArgumentNullException("extends");
// Step into the first child. // Step into the first child.
extends.SkipToNextElement(); extends.ReadToNextElement();
while (extends.NodeType == XmlNodeType.Element || extends.NodeType == XmlNodeType.Comment) while (extends.NodeType == XmlNodeType.Element || extends.NodeType == XmlNodeType.Comment)
{ {

42
ICD.Common.Utils/Xml/XmlUtils.cs
View file

@ -24,7 +24,7 @@ namespace ICD.Common.Utils.Xml
{ {
using (IcdXmlReader reader = new IcdXmlReader(xml)) using (IcdXmlReader reader = new IcdXmlReader(xml))
{ {
if (!reader.SkipToNextElement()) if (!reader.ReadToNextElement())
throw new FormatException("Unable to find element in given xml"); throw new FormatException("Unable to find element in given xml");
return reader.ReadInnerXml(); return reader.ReadInnerXml();
@ -44,7 +44,7 @@ namespace ICD.Common.Utils.Xml
{ {
using (IcdXmlReader reader = new IcdXmlReader(xml)) using (IcdXmlReader reader = new IcdXmlReader(xml))
{ {
reader.SkipToNextElement(); reader.ReadToNextElement();
return reader.HasAttribute(name); return reader.HasAttribute(name);
} }
} }
@ -59,7 +59,7 @@ namespace ICD.Common.Utils.Xml
{ {
using (IcdXmlReader reader = new IcdXmlReader(xml)) using (IcdXmlReader reader = new IcdXmlReader(xml))
{ {
reader.SkipToNextElement(); reader.ReadToNextElement();
return reader.GetAttributes(); return reader.GetAttributes();
} }
} }
@ -91,7 +91,7 @@ namespace ICD.Common.Utils.Xml
{ {
using (IcdXmlReader reader = new IcdXmlReader(xml)) using (IcdXmlReader reader = new IcdXmlReader(xml))
{ {
reader.SkipToNextElement(); reader.ReadToNextElement();
return reader.GetAttributeAsString(name); return reader.GetAttributeAsString(name);
} }
} }
@ -107,7 +107,7 @@ namespace ICD.Common.Utils.Xml
{ {
using (IcdXmlReader reader = new IcdXmlReader(xml)) using (IcdXmlReader reader = new IcdXmlReader(xml))
{ {
reader.SkipToNextElement(); reader.ReadToNextElement();
return reader.GetAttributeAsInt(name); return reader.GetAttributeAsInt(name);
} }
} }
@ -123,7 +123,7 @@ namespace ICD.Common.Utils.Xml
{ {
using (IcdXmlReader reader = new IcdXmlReader(xml)) using (IcdXmlReader reader = new IcdXmlReader(xml))
{ {
reader.SkipToNextElement(); reader.ReadToNextElement();
return reader.GetAttributeAsBool(name); return reader.GetAttributeAsBool(name);
} }
} }
@ -162,7 +162,7 @@ namespace ICD.Common.Utils.Xml
using (IcdXmlReader childReader = new IcdXmlReader(xml)) using (IcdXmlReader childReader = new IcdXmlReader(xml))
{ {
if (!childReader.SkipToNextElement()) if (!childReader.ReadToNextElement())
return; return;
path.Push(childReader.Name); path.Push(childReader.Name);
@ -190,7 +190,7 @@ namespace ICD.Common.Utils.Xml
{ {
using (IcdXmlReader reader = new IcdXmlReader(xml)) using (IcdXmlReader reader = new IcdXmlReader(xml))
{ {
if (!reader.SkipToNextElement()) if (!reader.ReadToNextElement())
throw new FormatException("Unable to find element in given xml"); throw new FormatException("Unable to find element in given xml");
return reader.HasChildElements(); return reader.HasChildElements();
@ -208,7 +208,7 @@ namespace ICD.Common.Utils.Xml
{ {
using (IcdXmlReader reader = new IcdXmlReader(xml)) using (IcdXmlReader reader = new IcdXmlReader(xml))
{ {
if (!reader.SkipToNextElement()) if (!reader.ReadToNextElement())
throw new FormatException("Unable to find element in given xml"); throw new FormatException("Unable to find element in given xml");
return reader.GetChildElement(element); return reader.GetChildElement(element);
@ -225,7 +225,7 @@ namespace ICD.Common.Utils.Xml
{ {
using (IcdXmlReader reader = new IcdXmlReader(xml)) using (IcdXmlReader reader = new IcdXmlReader(xml))
{ {
if (!reader.SkipToNextElement()) if (!reader.ReadToNextElement())
throw new FormatException("Unable to find element in given xml"); throw new FormatException("Unable to find element in given xml");
foreach (IcdXmlReader child in reader.GetChildElements()) foreach (IcdXmlReader child in reader.GetChildElements())
@ -243,7 +243,7 @@ namespace ICD.Common.Utils.Xml
{ {
using (IcdXmlReader reader = new IcdXmlReader(xml)) using (IcdXmlReader reader = new IcdXmlReader(xml))
{ {
if (!reader.SkipToNextElement()) if (!reader.ReadToNextElement())
throw new FormatException("Unable to find element in given xml"); throw new FormatException("Unable to find element in given xml");
foreach (string item in reader.GetChildElementsAsString(element)) foreach (string item in reader.GetChildElementsAsString(element))
@ -261,7 +261,7 @@ namespace ICD.Common.Utils.Xml
{ {
using (IcdXmlReader reader = new IcdXmlReader(xml)) using (IcdXmlReader reader = new IcdXmlReader(xml))
{ {
if (!reader.SkipToNextElement()) if (!reader.ReadToNextElement())
throw new FormatException("Unable to find element in given xml"); throw new FormatException("Unable to find element in given xml");
foreach (string item in reader.GetChildElementsAsString()) foreach (string item in reader.GetChildElementsAsString())
@ -297,7 +297,7 @@ namespace ICD.Common.Utils.Xml
{ {
using (IcdXmlReader reader = new IcdXmlReader(xml)) using (IcdXmlReader reader = new IcdXmlReader(xml))
{ {
if (!reader.SkipToNextElement()) if (!reader.ReadToNextElement())
throw new FormatException("Unable to find element in given xml"); throw new FormatException("Unable to find element in given xml");
return reader.TryGetChildElementAsString(element, out output); return reader.TryGetChildElementAsString(element, out output);
@ -645,7 +645,7 @@ namespace ICD.Common.Utils.Xml
{ {
using (IcdXmlReader reader = new IcdXmlReader(xml)) using (IcdXmlReader reader = new IcdXmlReader(xml))
{ {
if (!reader.SkipToNextElement()) if (!reader.ReadToNextElement())
throw new FormatException("Unable to find element in given xml"); throw new FormatException("Unable to find element in given xml");
return reader.ReadElementContentAsString(); return reader.ReadElementContentAsString();
@ -662,7 +662,7 @@ namespace ICD.Common.Utils.Xml
{ {
using (IcdXmlReader reader = new IcdXmlReader(xml)) using (IcdXmlReader reader = new IcdXmlReader(xml))
{ {
if (!reader.SkipToNextElement()) if (!reader.ReadToNextElement())
throw new FormatException("Unable to find element in given xml"); throw new FormatException("Unable to find element in given xml");
return reader.ReadElementContentAsUint(); return reader.ReadElementContentAsUint();
@ -679,7 +679,7 @@ namespace ICD.Common.Utils.Xml
{ {
using (IcdXmlReader reader = new IcdXmlReader(xml)) using (IcdXmlReader reader = new IcdXmlReader(xml))
{ {
if (!reader.SkipToNextElement()) if (!reader.ReadToNextElement())
throw new FormatException("Unable to find element in given xml"); throw new FormatException("Unable to find element in given xml");
return reader.ReadElementContentAsInt(); return reader.ReadElementContentAsInt();
@ -696,7 +696,7 @@ namespace ICD.Common.Utils.Xml
{ {
using (IcdXmlReader reader = new IcdXmlReader(xml)) using (IcdXmlReader reader = new IcdXmlReader(xml))
{ {
if (!reader.SkipToNextElement()) if (!reader.ReadToNextElement())
throw new FormatException("Unable to find element in given xml"); throw new FormatException("Unable to find element in given xml");
return reader.ReadElementContentAsUShort(); return reader.ReadElementContentAsUShort();
@ -718,7 +718,7 @@ namespace ICD.Common.Utils.Xml
using (IcdXmlReader reader = new IcdXmlReader(xml)) using (IcdXmlReader reader = new IcdXmlReader(xml))
{ {
if (!reader.SkipToNextElement()) if (!reader.ReadToNextElement())
throw new FormatException("Unable to find element in given xml"); throw new FormatException("Unable to find element in given xml");
return reader.ReadElementContentAsEnum<T>(ignoreCase); return reader.ReadElementContentAsEnum<T>(ignoreCase);
@ -739,7 +739,7 @@ namespace ICD.Common.Utils.Xml
{ {
using (IcdXmlReader reader = new IcdXmlReader(xml)) using (IcdXmlReader reader = new IcdXmlReader(xml))
{ {
if (!reader.SkipToNextElement()) if (!reader.ReadToNextElement())
throw new FormatException("Unable to find element in given xml"); throw new FormatException("Unable to find element in given xml");
try try
@ -763,7 +763,7 @@ namespace ICD.Common.Utils.Xml
{ {
using (IcdXmlReader reader = new IcdXmlReader(xml)) using (IcdXmlReader reader = new IcdXmlReader(xml))
{ {
if (!reader.SkipToNextElement()) if (!reader.ReadToNextElement())
throw new FormatException("Unable to find element in given xml"); throw new FormatException("Unable to find element in given xml");
try try
@ -790,7 +790,7 @@ namespace ICD.Common.Utils.Xml
{ {
using (IcdXmlReader reader = new IcdXmlReader(xml)) using (IcdXmlReader reader = new IcdXmlReader(xml))
{ {
if (!reader.SkipToNextElement()) if (!reader.ReadToNextElement())
throw new FormatException("Unable to read element name, no element in given xml"); throw new FormatException("Unable to read element name, no element in given xml");
return reader.Name; return reader.Name;