Changeset 12200 for main/waeup.ikoba/trunk/src/waeup/ikoba/documents

Timestamp:

12 Dec 2014, 15:34:50 (10 years ago)

Author:

Henrik Bettermann

Message:

We need documents which can be accessed or downloaded from product pages. These documents can provide general information of registration processes or pdf forms to be filled offline and later uploaded by customers.

Location:

main/waeup.ikoba/trunk/src/waeup/ikoba/documents

Files:

• document.py (modified) (3 diffs)
• interfaces.py (modified) (3 diffs)
• tests.py (modified) (4 diffs)
• workflow.py (modified) (2 diffs)

main/waeup.ikoba/trunk/src/waeup/ikoba/documents/document.py

@@ -32 +32 @@
 from waeup.ikoba.utils.helpers import attrs_to_fields, get_current_principal
 from waeup.ikoba.documents.interfaces import (
-    IDocument, IDocument, IDocumentsUtils)
+    IDocument, IDocument, IDocumentsUtils,
+    IPDFDocument, IHTMLDocument)
 from waeup.ikoba.documents.utils import generate_document_id
 
@@ -100 +101 @@
 
 
+class PDFDocument(Document):
+    """This is a  document for a single pdf upload file.
+    """
+    grok.implements(IPDFDocument)
+    grok.provides(IPDFDocument)
+
+PDFDocument = attrs_to_fields(PDFDocument)
+
+
+class HTMLDocument(Document):
+    """This is a  document to render html-coded text.
+    """
+    grok.implements(IHTMLDocument)
+    grok.provides(IHTMLDocument)
+
+HTMLDocument = attrs_to_fields(HTMLDocument)
+
+
 class DocumentFactory(grok.GlobalUtility):
     """A factory for documents.
@@ -114 +133 @@
         return implementedBy(Document)
 
+
+class PDFDocumentFactory(grok.GlobalUtility):
+    """A factory for documents.
+    """
+    grok.implements(IFactory)
+    grok.name(u'waeup.PDFDocument')
+    title = u"Create a new PDF document.",
+    description = u"This factory instantiates new PDF documents."
+
+    def __call__(self, *args, **kw):
+        return PDFDocument(*args, **kw)
+
+    def getInterfaces(self):
+        return implementedBy(PDFDocument)
+
+
+class HTMLDocumentFactory(grok.GlobalUtility):
+    """A factory for HTML documents.
+    """
+    grok.implements(IFactory)
+    grok.name(u'waeup.HTMLDocument')
+    title = u"Create a new HTML document.",
+    description = u"This factory instantiates new HTML documents."
+
+    def __call__(self, *args, **kw):
+        return HTMLDocument(*args, **kw)
+
+    def getInterfaces(self):
+        return implementedBy(HTMLDocument)
+
+
 @grok.subscribe(IDocument, grok.IObjectAddedEvent)
 def handle_document_added(document, event):

main/waeup.ikoba/trunk/src/waeup/ikoba/documents/interfaces.py

@@ -24 +24 @@
 
 
-class DocumentTypeSource(ContextualDictSourceFactoryBase):
-    """A document type source delivers all types of documents.
-
-    """
-    #: name of dict to deliver from ikoba utils.
-    DICT_NAME = 'DOCUMENT_TYPES'
-
 class IDocumentsContainer(IIkobaObject):
     """A container for all kind of document objects.
@@ -39 +32 @@
         """Add a document.
         """
+
 
 class IDocument(IIkobaObject):
@@ -71 +65 @@
         """
 
+class IPDFDocument(IDocument):
+    """A base representation of PDF documents.
+
+    """
+
+
+class IHTMLDocument(IDocument):
+    """A base representation of HTML documents.
+
+    """
+
 
 class IDocumentsUtils(Interface):

main/waeup.ikoba/trunk/src/waeup/ikoba/documents/tests.py

@@ -24 +24 @@
     IWorkflowInfo, IWorkflowState, InvalidTransitionError)
 from waeup.ikoba.documents.interfaces import (
-    IDocumentsContainer, IDocument)
+    IDocumentsContainer, IDocument, IPDFDocument, IHTMLDocument)
 from waeup.ikoba.interfaces import IObjectHistory
 from waeup.ikoba.documents.container import DocumentsContainer
-from waeup.ikoba.documents.document import Document
+from waeup.ikoba.documents.document import (
+    Document, PDFDocument, HTMLDocument)
 from waeup.ikoba.testing import (FunctionalLayer, FunctionalTestCase)
 
@@ -52 +53 @@
                 IDocument, Document())
             )
+
+        self.assertTrue(
+            verifyClass(
+                IPDFDocument, PDFDocument)
+            )
+        self.assertTrue(
+            verifyObject(
+                IPDFDocument, PDFDocument())
+            )
+
+        self.assertTrue(
+            verifyClass(
+                IHTMLDocument, HTMLDocument)
+            )
+        self.assertTrue(
+            verifyObject(
+                IHTMLDocument, HTMLDocument())
+            )
         return
 
     def test_addDocument(self):
         container = DocumentsContainer()
-        document = createObject(u'waeup.Document')
+        document = createObject(u'waeup.HTMLDocument')
         document_id = document.document_id
         container.addDocument(document)
@@ -65 +84 @@
 
     def test_document_workflow(self):
-        document = createObject(u'waeup.Document')
+        document = createObject(u'waeup.HTMLDocument')
         IWorkflowInfo(document).fireTransition('create')
         self.assertEqual(IWorkflowState(document).getState(), 'created')
@@ -79 +98 @@
         IWorkflowInfo(document).fireTransition('reset3')
         self.assertEqual(IWorkflowState(document).getState(), 'created')
+        IWorkflowInfo(document).fireTransition('publish')
+        self.assertEqual(IWorkflowState(document).getState(), 'published')
         return
 
     def test_document_history(self):
-        doc = createObject(u'waeup.Document')
+        doc = createObject(u'waeup.HTMLDocument')
         IWorkflowInfo(doc).fireTransition('create')
         messages = ' '.join(doc.history.messages)

main/waeup.ikoba/trunk/src/waeup/ikoba/documents/workflow.py

@@ -27 +27 @@
     IObjectHistory, IIkobaWorkflowInfo,
     SimpleIkobaVocabulary,
-    CREATED, SUBMITTED, VERIFIED, REJECTED, EXPIRED)
+    CREATED, SUBMITTED, VERIFIED, REJECTED, EXPIRED, PUBLISHED)
 from waeup.ikoba.interfaces import MessageFactory as _
 from waeup.ikoba.workflow import IkobaWorkflow, IkobaWorkflowInfo
@@ -99 +99 @@
         source = EXPIRED,
         destination = CREATED),
+
+    Transition(
+        transition_id = 'publish',
+        title = _('Publish'),
+        msg = _('Published'),
+        source = CREATED,
+        destination = PUBLISHED),
     )