diff -r 42188c7ea2d9 -r 82f11024044a Orb/python/doxygen/lib.py --- a/Orb/python/doxygen/lib.py Thu Jan 21 17:29:01 2010 +0000 +++ b/Orb/python/doxygen/lib.py Thu Mar 18 18:26:18 2010 +0000 @@ -12,8 +12,14 @@ # import os import unittest +import xml +import re +import sys from optparse import OptionParser +from cStringIO import StringIO +from xml.etree import ElementTree as etree +nmtoken_regex = re.compile("[^a-zA-Z0-9_\.]") def scan(dir): for root, _, files in os.walk(dir): @@ -45,20 +51,44 @@ return """""" # cxxapiref DITA specialisation Doctype Identifiers elif doctype == "cxxUnion": - return """""" + return """""" elif doctype == "cxxStruct": - return """""" + return """""" elif doctype == "cxxPackage": - return """""" + return """""" elif doctype == "cxxFile": - return """""" + return """""" elif doctype == "cxxClass": - return """""" + return """""" elif doctype == "cxxAPIMap": - return """""" + return """""" else: raise Exception('Unknown Doctype \"%s\"' % doctype) +def get_valid_nmtoken(attribute_value): + new_value = attribute_value + matches = nmtoken_regex.findall(new_value) + for char in set(matches): + new_value = new_value.replace(char,"") + return new_value + +class XmlParser(object): + """ + Simple class that reads an XML and returns its id + + >>> xp = XmlParser() + >>> xp.parse(StringIO("some content")) + 'rootid' + """ + def parse(self, xmlfile): + try: + root = etree.parse(xmlfile).getroot() + except xml.parsers.expat.ExpatError, e: + sys.stderr.write("ERROR: %s could not be parse: %s\n" % (xmlfile, str(e))) + return "" + if 'id' not in root.attrib: + return "" + return root.attrib['id'] def main(func, version): usage = "usage: %prog " @@ -77,6 +107,7 @@ def testi_can_return_anxml_declaration(self): self.assertEquals(xml_decl(), """""") + class Testdoctype_identifier(unittest.TestCase): def test_i_raise_an_exception_for_an_unknown_doctype(self): @@ -104,22 +135,71 @@ self.assertEquals(doctype_identifier("bookmap"), """""") def test_i_can_return_a_cxxUnion_doctype_identifier(self): - self.assertEquals(doctype_identifier("cxxUnion"), """""") + self.assertEquals(doctype_identifier("cxxUnion"), """""") def test_i_can_return_a_cxxStruct_doctype_identifier(self): - self.assertEquals(doctype_identifier("cxxStruct"), """""") + self.assertEquals(doctype_identifier("cxxStruct"), """""") def test_i_can_return_a_cxxPackage_doctype_identifier(self): - self.assertEquals(doctype_identifier("cxxPackage"), """""") + self.assertEquals(doctype_identifier("cxxPackage"), """""") - def test_i_can_return_a_cxxFile_doctype_identifier(self): - self.assertEquals(doctype_identifier("cxxFile"), """""") + self.assertEquals(doctype_identifier("cxxFile"), """""") def test_i_can_return_a_cxxClass_doctype_identifier(self): - self.assertEquals(doctype_identifier("cxxClass"), """""") + self.assertEquals(doctype_identifier("cxxClass"), """""") def test_i_can_return_a_cxxAPIMap_doctype_identifier(self): - self.assertEquals(doctype_identifier("cxxAPIMap"), """""") + self.assertEquals(doctype_identifier("cxxAPIMap"), """""") + - \ No newline at end of file +class Testget_valid_nmtoken(unittest.TestCase): + + def test_i_remove_non_alpha_numeric_characters(self): + input = "this is an alphanumeric string with non alpha numeric characters inside.()_+=-string0123456789" + expout = "thisisanalphanumericstringwithnonalphanumericcharactersinside._string0123456789" + output = get_valid_nmtoken(input) + self.assertEquals(output, expout) + + +class StubXmlParser(object): + def parse(self, path): + return "GUID-BED8A733-2ED7-31AD-A911-C1F4707C67F" + + +class TestXmlParser(unittest.TestCase): + def test_i_issue_a_warning_and_continue_if_a_file_is_invalid(self): + xml = XmlParser() + try: + xml.parse(StringIO("")) + except Exception, e: + self.fail("I shouldn't have raised an exception. Exception was %s" % e) + + def test_i_issue_a_warning_and_continue_if_a_file_does_not_have_an_id(self): + xml = XmlParser() + try: + id = xml.parse(StringIO(brokencxxclass)) + except Exception: + self.fail("I shouldn't have raised an exception") + self.assertTrue(id == "") + + def test_i_return_a_files_id(self): + xml = XmlParser() + id = xml.parse(StringIO(cxxclass)) + self.assertTrue(id == "class_c_active_scheduler") + +brokencxxclass = """ + + + CActiveScheduler + + +""" + +cxxclass = """ + + + CActiveScheduler + + +""" \ No newline at end of file