Changeset 12053

Timestamp:

25 Nov 2014, 08:19:54 (10 years ago)

Author:

Henrik Bettermann

Message:

Add second customer document class.
Select document factory when adding documents.
Add last_transition_date attribute and further property attributes to documents.

Location:

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

Files:

• customers/browser.py (modified) (6 diffs)
• customers/browser_templates/documentsmanagepage.pt (modified) (2 diffs)
• customers/documents.py (modified) (5 diffs)
• customers/export.py (modified) (1 diff)
• customers/interfaces.py (modified) (1 diff)
• customers/tests/test_browser.py (modified) (3 diffs)
• customers/tests/test_document.py (modified) (1 diff)
• customers/tests/test_export.py (modified) (4 diffs)
• customers/utils.py (modified) (1 diff)
• documents/document.py (modified) (1 diff)
• documents/interfaces.py (modified) (2 diffs)
• documents/workflow.py (modified) (1 diff)
• utils/utils.py (modified) (1 diff)

main/waeup.ikoba/trunk/src/waeup/ikoba/customers/browser.py

@@ -39 +39 @@
     IkobaPage, IkobaEditFormPage, IkobaAddFormPage, IkobaDisplayFormPage,
     IkobaForm, NullValidator, jsaction, action, UtilityView)
+from waeup.ikoba.widgets.datewidget import (
+    FriendlyDateWidget, FriendlyDateDisplayWidget,
+    FriendlyDatetimeDisplayWidget)
 from waeup.ikoba.browser.pages import ContactAdminForm
 from waeup.ikoba.browser.breadcrumbs import Breadcrumb
@@ -796 +799 @@
     @property
     def selectable_doctypes(self):
-        doctypes = getUtility(IIkobaUtils).DOCUMENT_TYPES
+        doctypes = getUtility(ICustomersUtils).SELECTABLE_DOCTYPES_DICT
         return sorted(doctypes.items())
 
@@ -806 +809 @@
         # Here we can create various instances of CustomerDocument derived 
         # classes depending on the doctype parameter given in form.
-        # So far we only have one CustomerDocument class and no derived
-        # classes.
-        document = createObject(u'waeup.CustomerDocument')
+        document = createObject('waeup.%s' % doctype)
         self.context.addDocument(document)
-        doctype = getUtility(IIkobaUtils).DOCUMENT_TYPES[doctype]
+        doctype = getUtility(ICustomersUtils).SELECTABLE_DOCTYPES_DICT[doctype]
         self.flash(_('${a} created.',
             mapping = {'a': doctype}))
@@ -831 +832 @@
     grok.template('documentpage')
     form_fields = grok.AutoFields(ICustomerDocument)
+    form_fields[
+        'last_transition_date'].custom_widget = FriendlyDatetimeDisplayWidget('le')
     pnav = 4
 
@@ -851 +854 @@
     grok.require('waeup.manageCustomer')
     grok.template('documenteditpage')
-    form_fields = grok.AutoFields(ICustomerDocument)
+    form_fields = grok.AutoFields(ICustomerDocument).omit('last_transition_date')
     pnav = 4
     deletion_warning = _('Are you sure?')
@@ -960 +963 @@
     def render(self):
         portal_language = getUtility(IIkobaUtils).PORTAL_LANGUAGE
-        Id = translate(_('Document Id'), 'waeup.ikoba', target_language=portal_language)
+        Id = translate(_('Id'), 'waeup.ikoba', target_language=portal_language)
         Title = translate(_('Title'), 'waeup.ikoba', target_language=portal_language)
+        Type = translate(_('Type'), 'waeup.ikoba', target_language=portal_language)
         State = translate(_('State'), 'waeup.ikoba', target_language=portal_language)
+        LT = translate(_('Last Transition'), 'waeup.ikoba', target_language=portal_language)
+        tableheader = []
         tabledata = []
-        tableheader = []
         contenttitle = []
         for i in range(1,3):
             tabledata.append(sorted(
                 [value for value in self.context['documents'].values()]))
-            tableheader.append([(Id, 'document_id', 3),
-                             (Title, 'title', 8),
-                             (State, 'translated_state', 3),
+            tableheader.append([(Id, 'document_id', 2),
+                             (Title, 'title', 6),
+                             (Type, 'translated_classname', 6),
+                             (State, 'translated_state', 2),
+                             (LT, 'formatted_transition_date', 3),
                              ])
         customerview = CustomerBasePDFFormPage(self.context,

main/waeup.ikoba/trunk/src/waeup/ikoba/customers/browser_templates/documentsmanagepage.pt

@@ -8 +8 @@
       <th i18n:translate="">Document Id</th>
       <th i18n:translate="">Title</th>
+      <th i18n:translate="">Type</th>
+      <th i18n:translate="">State</th>
+      <th i18n:translate="">Last Transition</th>
     </tr>
     </thead>
@@ -25 +28 @@
           <span tal:content="cl/title">TITLE</span>
         </td>
+        <td>
+          <span tal:content="cl/translated_classname">CLASSNAME</span>
+        </td>
+        <td>
+          <span tal:content="cl/translated_state">STATE</span>
+        </td>
+        <td>
+          <span tal:content="cl/formatted_transition_date">
+              LASTTRANSITIONDATE
+          </span>
+        </td>
       </tr>
     </tbody>

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

@@ -33 +33 @@
 from waeup.ikoba.customers.interfaces import (
     ICustomerDocumentsContainer, ICustomerNavigation, ICustomerDocument,
-    ICustomersUtils)
+    ICustomersUtils, ICustomerPDFDocument)
 from waeup.ikoba.documents import DocumentsContainer, Document
 from waeup.ikoba.documents.interfaces import IDocumentsUtils
@@ -60 +60 @@
 
 class CustomerDocument(Document):
-    """This is an document.
+    """This is a customer document.
     """
     grok.implements(ICustomerDocument, ICustomerNavigation)
@@ -94 +94 @@
         return True
 
+    @property
+    def translated_classname(self):
+        try:
+            DOCTYPES_DICT = getUtility(ICustomersUtils).DOCTYPES_DICT
+            return DOCTYPES_DICT[self.classname]
+        except KeyError:
+            return
+
 CustomerDocument = attrs_to_fields(CustomerDocument)
+
+class CustomerPDFDocument(CustomerDocument):
+    """This is a customer document for a single pdf upload file only.
+    """
+    grok.implements(ICustomerPDFDocument, ICustomerNavigation)
+    grok.provides(ICustomerPDFDocument)
+
+CustomerPDFDocument = attrs_to_fields(CustomerPDFDocument)
 
 
@@ -104 +120 @@
     grok.name(u'waeup.CustomerDocument')
     title = u"Create a new document.",
-    description = u"This factory instantiates new document instances."
+    description = u"This factory instantiates new sample document instances."
 
     def __call__(self, *args, **kw):
@@ -111 +127 @@
     def getInterfaces(self):
         return implementedBy(CustomerDocument)
+
+# Customer documents must be importable. So we might need a factory.
+class CustomerPDFDocumentFactory(grok.GlobalUtility):
+    """A factory for customer pdf documents.
+    """
+    grok.implements(IFactory)
+    grok.name(u'waeup.CustomerPDFDocument')
+    title = u"Create a new document.",
+    description = u"This factory instantiates new pdf document instances."
+
+    def __call__(self, *args, **kw):
+        return CustomerPDFDocument(*args, **kw)
+
+    def getInterfaces(self):
+        return implementedBy(CustomerPDFDocument)
 
 #: The file id marker for customer files

main/waeup.ikoba/trunk/src/waeup/ikoba/customers/export.py

@@ -147 +147 @@
             ICustomerDocument,
             exclude_attribs=False,
-            omit=['is_editable', 'translated_state']))) + (
+            omit=['is_editable',
+                  'translated_state',
+                  'formatted_transition_date',
+                  'translated_classname']))) + (
             'customer_id',)
 

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

@@ -270 +270 @@
 
     is_editable = Attribute('Document editable by customer')
+    translated_classname = Attribute('Translatable classname')
+
+
+class ICustomerPDFDocument(IDocument):
+    """A customer document.
+
+    """

main/waeup.ikoba/trunk/src/waeup/ikoba/customers/tests/test_browser.py

@@ -812 +812 @@
         self.browser.getLink("Documents").click()
         self.browser.getLink("Add document").click()
-        self.browser.getControl(name="doctype").value = ['sample']
+        self.browser.getControl(name="doctype").value = ['CustomerPDFDocument']
         self.browser.getControl("Create document").click()
-        self.assertTrue('Sample Document created.' in self.browser.contents)
+        self.assertTrue('PDF Document created.' in self.browser.contents)
         document = self.customer['documents']['d102']
 
@@ -853 +853 @@
         self.assertTrue(
             'INFO - zope.mgr - customers.browser.DocumentAddFormPage '
-            '- K1000000 - added: Sample Document %s'
+            '- K1000000 - added: PDF Document %s'
             % document.document_id in logcontent)
 
@@ -871 +871 @@
         self.browser.getLink("Documents").click()
         self.browser.getLink("Add document").click()
-        self.browser.getControl(name="doctype").value = ['sample']
+        self.browser.getControl(name="doctype").value = ['CustomerDocument']
         self.browser.getControl("Create document").click()
         self.assertTrue('Sample Document created.' in self.browser.contents)

main/waeup.ikoba/trunk/src/waeup/ikoba/customers/tests/test_document.py

@@ -61 +61 @@
         self.assertEqual(container[id], document)
         self.assertRaises(TypeError, container.addDocument, object())
+        self.assertEqual(document.classname, 'CustomerDocument')
         return
 

main/waeup.ikoba/trunk/src/waeup/ikoba/customers/tests/test_export.py

@@ -138 +138 @@
         self.assertEqual(
             result,
-            'document_id,history,state,title,customer_id\r\n'
-            'd101,[],,,\r\n'
+            'classname,document_id,history,last_transition_date,state,title,customer_id\r\n'
+            'CustomerDocument,d101,[],,,,\r\n'
             )
         return
@@ -152 +152 @@
         result = open(self.outfile, 'rb').read()
         self.assertTrue(
-            'document_id,history,state,title,customer_id\r\n'
+            'classname,document_id,history,last_transition_date,state,title,customer_id\r\n'
             in result
             )
-        self.assertTrue(
-            'Document created by system\'],created,My Document,A111111\r\n'
-            in result
+        self.assertMatches(
+            '...CustomerDocument,d101,[u\'2014-11-25 06:57:24 UTC - '
+            'Document created by system\'],2014-11-25 06:57:24.990308#,'
+            'created,My Document,A111111...',
+            result
             )
         return
@@ -169 +171 @@
         result = open(self.outfile, 'rb').read()
         self.assertTrue(
-            'document_id,history,state,title,customer_id\r\n'
+            'classname,document_id,history,last_transition_date,state,title,customer_id\r\n'
             in result)
-        self.assertTrue(
-            ' Document created by system\'],created,My Document,A111111\r\n'
-            in result)
+        self.assertMatches(
+            '...CustomerDocument,d101,[u\'2014-11-25 06:57:24 UTC - '
+            'Document created by system\'],2014-11-25 06:57:24.990308#,'
+            'created,My Document,A111111...',
+            result
+            )
         return
 
@@ -184 +189 @@
         result = open(self.outfile, 'rb').read()
         self.assertTrue(
-            'document_id,history,state,title,customer_id\r\n'
+            'classname,document_id,history,last_transition_date,state,title,customer_id\r\n'
             in result)
-        self.assertTrue(
-            ' Document created by system\'],created,My Document,A111111\r\n'
-            in result)
+        self.assertMatches(
+            '...CustomerDocument,d101,[u\'2014-11-25 06:57:24 UTC - '
+            'Document created by system\'],2014-11-25 06:57:24.990308#,'
+            'created,My Document,A111111...',
+            result
+            )
         return

main/waeup.ikoba/trunk/src/waeup/ikoba/customers/utils.py

@@ -288 +288 @@
         }
 
+    DOCTYPES_DICT = {
+        'CustomerDocument': 'Sample Document',
+        'CustomerPDFDocument': 'PDF Document',
+        }
+
+    SELECTABLE_DOCTYPES_DICT = DOCTYPES_DICT
+
     def getPDFCreator(self, context=None):
         """Get a pdf creator suitable for `context`.

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

@@ -76 +76 @@
         try:
             TRANSLATED_STATES = getUtility(IDocumentsUtils).TRANSLATED_STATES
-            ts = TRANSLATED_STATES[self.state]
-            return ts
+            return TRANSLATED_STATES[self.state]
         except KeyError:
             return
+
+    @property
+    def classname(self):
+        return self.__class__.__name__
+
+    @property
+    def formatted_transition_date(self):
+        try:
+            return self.last_transition_date.strftime('%Y-%m-%d %H:%M:%S')
+        except AttributeError:
+            return
+        
 
 Document = attrs_to_fields(Document)

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

@@ -49 +49 @@
     translated_state = Attribute(
         'Returns a translated, more verbose verification state of a document')
+    classname = Attribute('Name of the document class')
+    formatted_transition_date = Attribute('Last transition formatted date string')
 
     title = schema.TextLine(
@@ -55 +57 @@
         )
 
+    last_transition_date = schema.Datetime(
+        title = _(u'Last Transition Date'),
+        required = False,
+        readonly = False,
+        )
+
+
 class IDocumentsUtils(Interface):
     """A collection of methods which are subject to customization.

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

@@ -124 +124 @@
 @grok.subscribe(IDocument, IWorkflowTransitionEvent)
 def handle_document_transition_event(obj, event):
-    """Append message to document history and log file when transition happened.
+    """Append message to document history and log file and update
+    last_transition_date when transition happened.
     """
     msg = event.transition.user_data['msg']
     history = IObjectHistory(obj)
     history.addMessage(msg)
+    obj.last_transition_date = datetime.utcnow()
     try:
         customers_container = grok.getSite()['customers']

main/waeup.ikoba/trunk/src/waeup/ikoba/utils/utils.py

@@ -114 +114 @@
         ('C', 'Good'),
         )
-
-    # Should be overridden in custom packages
-    DOCUMENT_TYPES = {
-        'sample': 'Sample Document',
-        }
 
     PAYMENT_CATEGORIES = {