add CT_Relationships.add_rel()

Steve Canny · Steve Canny · commit 9db3241a66e7 · 2013-08-06T01:34:45.000-07:00
diff --git a/opc/oxml.py b/opc/oxml.py
@@ -194,6 +194,15 @@ class CT_Relationships(OxmlBaseElement):
     """
     ``<Relationships>`` element, the root element in a .rels file.
     """
+    def add_rel(self, rId, reltype, target, is_external=False):
+        """
+        Add a child ``<Relationship>`` element with attributes set according
+        to parameter values.
+        """
+        target_mode = RTM.EXTERNAL if is_external else RTM.INTERNAL
+        relationship = CT_Relationship.new(rId, reltype, target, target_mode)
+        self.append(relationship)
+
     @staticmethod
     def new():
         """
@@ -258,3 +267,4 @@ def overrides(self):
 
 pr_namespace = element_class_lookup.get_namespace(nsmap['pr'])
 pr_namespace['Relationship'] = CT_Relationship
+pr_namespace['Relationships'] = CT_Relationships
diff --git a/tests/test_oxml.py b/tests/test_oxml.py
@@ -15,7 +15,9 @@
     oxml_tostring
 )
 
-from .unitdata import a_Default, an_Override, a_Relationship, a_Types
+from .unitdata import (
+    a_Default, an_Override, a_Relationship, a_Relationships, a_Types
+)
 
 
 class DescribeCT_Default(object):
@@ -83,6 +85,19 @@ def it_can_construct_a_new_relationships_element(self):
         )
         assert actual_xml == expected_xml
 
+    def it_can_build_rels_element_incrementally(self):
+        # setup ------------------------
+        rels = CT_Relationships.new()
+        # exercise ---------------------
+        rels.add_rel('rId1', 'http://reltype1', 'docProps/core.xml')
+        rels.add_rel('rId2', 'http://linktype', 'http://some/link', True)
+        rels.add_rel('rId3', 'http://reltype2', '../slides/slide1.xml')
+        # verify -----------------------
+        expected_rels_xml = a_Relationships().xml
+        actual_xml = oxml_tostring(rels, encoding='unicode',
+                                   pretty_print=True)
+        assert actual_xml == expected_rels_xml
+
 
 class DescribeCT_Types(object):
 
diff --git a/tests/unitdata.py b/tests/unitdata.py
@@ -154,6 +154,37 @@ def xml(self):
                        self._target, self.target_mode)
 
 
+class CT_RelationshipsBuilder(BaseBuilder):
+    """
+    Test data builder for CT_Relationships (Relationships) XML element, the
+    root element in .rels files.
+    """
+    def __init__(self):
+        """Establish instance variables with default values"""
+        self._rels = (
+            ('rId1', 'http://reltype1', 'docProps/core.xml',    'Internal'),
+            ('rId2', 'http://linktype', 'http://some/link',     'External'),
+            ('rId3', 'http://reltype2', '../slides/slide1.xml', 'Internal'),
+        )
+
+    @property
+    def xml(self):
+        """
+        Return XML string based on settings accumulated via method calls.
+        """
+        xml = '<Relationships xmlns="%s">\n' % NS.OPC_RELATIONSHIPS
+        for rId, reltype, target, target_mode in self._rels:
+            xml += (a_Relationship().with_rId(rId)
+                                    .with_reltype(reltype)
+                                    .with_target(target)
+                                    .with_target_mode(target_mode)
+                                    .with_indent(2)
+                                    .without_namespace()
+                                    .xml)
+        xml += '</Relationships>\n'
+        return xml
+
+
 class CT_TypesBuilder(BaseBuilder):
     """
     Test data builder for CT_Types (<Types>) XML element, the root element in
@@ -216,6 +247,11 @@ def a_Relationship():
     return CT_RelationshipBuilder()
 
 
+def a_Relationships():
+    """Return a CT_RelationshipsBuilder instance"""
+    return CT_RelationshipsBuilder()
+
+
 def a_Types():
     """Return a CT_TypesBuilder instance"""
     return CT_TypesBuilder()
