api: add Document() factory function

Steve Canny · Steve Canny · commit ba0e2e1cc2f9 · 2013-12-20T20:10:43.000-08:00
diff --git a/docx/api.py b/docx/api.py
@@ -13,6 +13,8 @@
 opc.OpcPackage graph.
 """
 
+from opc import OpcPackage
+
 
 def Document(docx=None):
     """
@@ -21,3 +23,14 @@ def Document(docx=None):
     *docx* is missing or ``None``, the built-in default document "template"
     is loaded.
     """
+    pkg = OpcPackage.open(docx)
+    document_part = pkg.main_document
+    return _Document(pkg, document_part)
+
+
+class _Document(object):
+    """
+    API class representing a Word document.
+    """
+    def __init__(self, pkg, document_part):
+        super(_Document, self).__init__()
diff --git a/tests/test_api.py b/tests/test_api.py
@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+#
+# test_api.py
+#
+# Copyright (C) 2013 Steve Canny scanny@cisco.com
+#
+# This module is part of python-docx and is released under the MIT License:
+# http://www.opensource.org/licenses/mit-license.php
+
+"""Test suite for the docx.api module."""
+
+import pytest
+
+from mock import Mock, PropertyMock
+
+from docx.api import Document, _Document
+
+from .unitutil import class_mock
+
+
+class DescribeDocument(object):
+
+    @pytest.fixture
+    def _Document_(self, request):
+        return class_mock('docx.api._Document', request)
+
+    @pytest.fixture
+    def OpcPackage_mockery(self, request):
+        OpcPackage_ = class_mock('docx.api.OpcPackage', request)
+        pkg = OpcPackage_.open.return_value
+        main_document = PropertyMock(name='main_document')
+        type(pkg).main_document = main_document
+        document_part = main_document.return_value
+        return (OpcPackage_, pkg, main_document, document_part)
+
+    def it_opens_a_docx_file_on_construction(self, OpcPackage_mockery,
+                                             _Document_):
+        # mockery ----------------------
+        docx = Mock(name='docx')
+        OpcPackage_, pkg, main_document, document_part = OpcPackage_mockery
+        # exercise ---------------------
+        doc = Document(docx)
+        # verify -----------------------
+        OpcPackage_.open.assert_called_once_with(docx)
+        main_document.assert_called_once_with()
+        _Document_.assert_called_once_with(pkg, document_part)
+        assert isinstance(doc, _Document)
