accept: add add_paragraph.feature

Steve Canny · Steve Canny · commit c254f8efa871 · 2013-12-20T20:10:43.000-08:00
diff --git a/docx/__init__.py b/docx/__init__.py
@@ -7,4 +7,6 @@
 # This module is part of python-docx and is released under the MIT License:
 # http://www.opensource.org/licenses/mit-license.php
 
+from docx.api import Document  # noqa
+
 __version__ = '0.3.0d1'
diff --git a/docx/api.py b/docx/api.py
@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+#
+# api.py
+#
+# Copyright (C) 2012, 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
+
+"""
+Directly exposed API functions and classes, :func:`Document` for now.
+Provides a syntactically more convenient API for interacting with the
+opc.OpcPackage graph.
+"""
+
+
+def Document(docx=None):
+    """
+    Return a |_Document| instance loaded from *docx*, where *docx* can be
+    either a path to a ``.docx`` file (a string) or a file-like object. If
+    *docx* is missing or ``None``, the built-in default document "template"
+    is loaded.
+    """
diff --git a/features/add_paragraph.feature b/features/add_paragraph.feature
@@ -0,0 +1,13 @@
+Feature: Add a paragraph of text
+  In order to add text to a document
+  As an python-docx developer
+  I need to add a paragraph
+
+  @wip
+  Scenario: Add a paragraph to a document created from the default template
+     Given a new document created from the default template
+      When I add a new paragraph to the body
+       And I add a new run to the paragraph
+       And I add new text to the run
+       And I save the document
+      Then the document contains the text I added
diff --git a/features/dummy.feature b/features/dummy.feature
diff --git a/features/steps/docx_steps.py b/features/steps/docx_steps.py
@@ -8,3 +8,63 @@
 # http://www.opensource.org/licenses/mit-license.php
 
 """Step implementations for python-docx acceptance tests"""
+
+import os
+
+from behave import given, then, when
+
+from docx import Document
+
+
+def absjoin(*paths):
+    return os.path.abspath(os.path.join(*paths))
+
+thisdir = os.path.split(__file__)[0]
+scratch_dir = absjoin(thisdir, '../_scratch')
+saved_docx_path = absjoin(scratch_dir, 'test_out.docx')
+
+test_text = 'python-docx was here!'
+
+
+# given ===================================================
+
+@given('a new document created from the default template')
+def step_given_new_doc_from_def_template(context):
+    context.doc = Document()
+
+
+# when ====================================================
+
+@when('I add a new paragraph to the body')
+def step_when_add_new_paragraph_to_body(context):
+    body = context.doc.body
+    context.p = body.add_paragraph()
+
+
+@when('I add a new run to the paragraph')
+def step_when_add_new_run_to_paragraph(context):
+    context.r = context.p.add_run()
+
+
+@when('I add new text to the run')
+def step_when_add_new_text_to_run(context):
+    context.r.add_text(test_text)
+
+
+@when('I save the document')
+def step_when_save_document(context):
+    if os.path.isfile(saved_docx_path):
+        os.remove(saved_docx_path)
+    context.doc.save(saved_docx_path)
+
+
+# then =====================================================
+
+@then('the document contains the text I added')
+def step_then_document_contains_text_I_added(context):
+    doc = Document(saved_docx_path)
+    body = doc.body
+    paragraphs = body.paragraphs
+    p = paragraphs[-1]
+    r = p.runs[0]
+    assert r.text == test_text
