add CT_Relationship.new()

Steve Canny · Steve Canny · commit b3a4b5fd7f4e · 2013-08-05T15:08:42.000-07:00
diff --git a/opc/oxml.py b/opc/oxml.py
@@ -141,6 +141,21 @@ class CT_Relationship(OxmlBaseElement):
     ``<Relationship>`` element, representing a single relationship from a
     source to a target part.
     """
+    @staticmethod
+    def new(rId, reltype, target, target_mode=RTM.INTERNAL):
+        """
+        Return a new ``<Relationship>`` element.
+        """
+        xml = '<Relationship xmlns="%s"/>' % nsmap['pr']
+        relationship = oxml_fromstring(xml)
+        relationship.set('Id', rId)
+        relationship.set('Type', reltype)
+        relationship.set('Target', target)
+        if target_mode == RTM.EXTERNAL:
+            relationship.set('TargetMode', RTM.EXTERNAL)
+        objectify.deannotate(relationship, cleanup_namespaces=True)
+        return relationship
+
     @property
     def rId(self):
         """
diff --git a/tests/test_oxml.py b/tests/test_oxml.py
@@ -10,7 +10,7 @@
 """Test suite for opc.oxml module."""
 
 from opc.constants import RELATIONSHIP_TARGET_MODE as RTM
-from opc.oxml import CT_Default, CT_Override, CT_Types
+from opc.oxml import CT_Default, CT_Override, CT_Relationship, CT_Types
 
 from .unitdata import a_Default, an_Override, a_Relationship, a_Types
 
@@ -50,6 +50,23 @@ def it_provides_read_access_to_xml_values(self):
         assert rel.target_ref == 'docProps/core.xml'
         assert rel.target_mode == RTM.INTERNAL
 
+    def it_can_construct_from_attribute_values(self):
+        cases = (
+            ('rId9', 'ReLtYpE', 'foo/bar.xml',      None),
+            ('rId9', 'ReLtYpE', 'bar/foo.xml',      RTM.INTERNAL),
+            ('rId9', 'ReLtYpE', 'http://some/link', RTM.EXTERNAL),
+        )
+        for rId, reltype, target, target_mode in cases:
+            if target_mode is None:
+                rel = CT_Relationship.new(rId, reltype, target)
+            else:
+                rel = CT_Relationship.new(rId, reltype, target, target_mode)
+            builder = a_Relationship().with_target(target)
+            if target_mode == RTM.EXTERNAL:
+                builder = builder.with_target_mode(RTM.EXTERNAL)
+            expected_rel_xml = builder.xml
+            assert rel.xml == expected_rel_xml
+
 
 class DescribeCT_Types(object):
 
diff --git a/tests/unitdata.py b/tests/unitdata.py
@@ -111,8 +111,34 @@ def __init__(self):
         self._reltype = 'ReLtYpE'
         self._target = 'docProps/core.xml'
         self._target_mode = None
+        self._indent = 0
         self._namespace = ' xmlns="%s"' % NS.OPC_RELATIONSHIPS
 
+    def with_rId(self, rId):
+        """Set Id attribute to *rId*"""
+        self._rId = rId
+        return self
+
+    def with_reltype(self, reltype):
+        """Set Type attribute to *reltype*"""
+        self._reltype = reltype
+        return self
+
+    def with_target(self, target):
+        """Set XXX attribute to *target*"""
+        self._target = target
+        return self
+
+    def with_target_mode(self, target_mode):
+        """Set TargetMode attribute to *target_mode*"""
+        self._target_mode = None if target_mode == 'Internal' else target_mode
+        return self
+
+    def without_namespace(self):
+        """Don't include an 'xmlns=' attribute"""
+        self._namespace = ''
+        return self
+
     @property
     def target_mode(self):
         if self._target_mode is None:
@@ -122,8 +148,9 @@ def target_mode(self):
     @property
     def xml(self):
         """Return Relationship element"""
-        tmpl = '<Relationship%s Id="%s" Type="%s" Target="%s"%s/>\n'
-        return tmpl % (self._namespace, self._rId, self._reltype,
+        tmpl = '%s<Relationship%s Id="%s" Type="%s" Target="%s"%s/>\n'
+        indent = ' ' * self._indent
+        return tmpl % (indent, self._namespace, self._rId, self._reltype,
                        self._target, self.target_mode)
 
 
