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

Timestamp:

18 Dec 2014, 12:58:12 (10 years ago)

Author:

Henrik Bettermann

Message:

Change document_id generation algorithm. Use Universally Unique IDentifiers instead of consecutive numbers.

Location:

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

Files:

• batching.py (modified) (4 diffs)
• document.py (modified) (2 diffs)
• interfaces.py (modified) (2 diffs)
• tests/test_browser.py (modified) (10 diffs)
• tests/test_document.py (modified) (2 diffs)
• utils.py (modified) (1 diff)

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

@@ -56 +56 @@
     factory_name = 'waeup.PDFDocument'
 
-    location_fields = []
     additional_fields = ['class_name']
     additional_headers = ['class_name']
@@ -66 +65 @@
 
     def entryExists(self, row, site):
-        return row['document_id'] in site['documents'].keys()
+        document_id = row.get('document_id', None)
+        cat = queryUtility(ICatalog, name='documents_catalog')
+        results = list(cat.searchResults(document_id=(document_id, document_id)))
+        if results:
+            return True
+        return False
 
     def getParent(self, row, site):
@@ -94 +98 @@
         """Update obj to the values given in row.
         """
-        items_changed = super(DocumentProcessor, self).updateEntry(
+        items_changed = super(PDFDocumentProcessor, self).updateEntry(
             obj, row, site, filename)
         # Log actions...
@@ -110 +114 @@
         # We need to check if the class_name corresponds with the
         # processor chosen. This is to avoid accidentally wrong imports.
-        if mode != 'remove':
+        if mode == 'create':
             class_name = row.get('class_name', None)
             if class_name != self.factory_name.strip('waeup.'):
                 errs.append(('class_name','wrong processor'))
-        # We have to check document_id.
         document_id = row.get('document_id', None)
-        if mode == 'create':
-            if not document_id:
-                document_id = generate_document_id()
-                conv_dict['document_id'] = document_id
-                return errs, inv_errs, conv_dict
-            cat = queryUtility(ICatalog, name='documents_catalog')
-            results = list(
-                cat.searchResults(document_id=(document_id, document_id)))
-            if results:
-                # document_id must not exist.
-                errs.append(('document_id','id exists'))
-        else:
-            if not document_id.startswith('d'):
-                errs.append(('document_id','invalid format'))
+        if ' ' in document_id:
+            errs.append(('document_id','must not contain spaces'))
         return errs, inv_errs, conv_dict
 

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

@@ -39 +39 @@
     IDocument, IPublicDocument, IDocumentsUtils,
     IPDFDocument, IHTMLDocument)
-from waeup.ikoba.documents.utils import generate_document_id
 
 class Document(grok.Container):
@@ -58 +57 @@
     translated_state = None
     translated_class_name = None
-
-    def __init__(self):
-        super(Document, self).__init__()
-        # The site doesn't exist in unit tests
-        try:
-            self.document_id = generate_document_id()
-        except AttributeError:
-            self.document_id = u'd123'
-        return
 
     @property

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

@@ -38 +38 @@
 
     """
-    document_id = Attribute('Document Identifier')
     history = Attribute('Object history, a list of messages')
     state = Attribute('Returns the verification state of a document')
@@ -49 +48 @@
     connected_files = Attribute('Names of files connected to a document')
     is_verifiable = Attribute('Contract verifiable by officer')
+
+    document_id = schema.TextLine(
+        title = _(u'Document Id'),
+        required = False,
+        )
 
     title = schema.TextLine(

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

@@ -111 +111 @@
         self.browser.getControl(name="doctype").value = ['PDFDocument']
         self.browser.getControl(name="form.title").value = 'My PDF Document'
+        self.browser.getControl(name="form.document_id").value = 'DOC1'
         self.browser.getControl("Add document").click()
         self.assertTrue('PDF Document added.' in self.browser.contents)
-        document = self.app['documents']['d101']
+        document = self.app['documents']['DOC1']
 
         # Document can be edited
-        self.browser.getLink("d101").click()
+        self.browser.getLink("DOC1").click()
         self.browser.getLink("Manage").click()
         self.browser.getControl(name="form.title").value = 'My first doc'
@@ -122 +123 @@
         self.assertTrue('Form has been saved.' in self.browser.contents)
         self.browser.getLink("View").click()
-        self.assertEqual(self.browser.url, self.container_path + '/d101/index')
+        self.assertEqual(self.browser.url, self.container_path + '/DOC1/index')
 
         # File can be uploaded
@@ -149 +150 @@
             name='upload_pdfscanmanageupload').click()
         self.assertTrue(
-            'href="http://localhost/app/documents/d101/sample.pdf">PDF File</a>'
+            'href="http://localhost/app/documents/DOC1/sample.pdf">PDF File</a>'
             in self.browser.contents)
         # Browsing the link shows a real pdf only if the document
@@ -158 +159 @@
             in self.browser.contents)
         IWorkflowState(document).setState(PUBLISHED)
-        self.browser.open(self.container_path + '/d101/sample.pdf')
+        self.browser.open(self.container_path + '/DOC1/sample.pdf')
         self.assertEqual(
             self.browser.headers['content-type'], 'application/pdf')
@@ -164 +165 @@
         # Transitions can be performed
         self.assertEqual(document.state, 'published')
-        self.browser.open(self.container_path + '/d101')
+        self.browser.open(self.container_path + '/DOC1')
         self.browser.getLink("Transition").click()
         self.browser.getControl(name="transition").value = ['retract']
@@ -213 +214 @@
         self.browser.getControl("Add document").click()
         self.browser.getControl(name="doctype").value = ['HTMLDocument']
+        self.browser.getControl(name="form.document_id").value = 'DOC2'
         self.browser.getControl(name="form.title").value = 'My HTML Document'
         self.browser.getControl("Add document").click()
         self.assertTrue('HTML Document added.' in self.browser.contents)
-        document = self.app['documents']['d101']
+        document = self.app['documents']['DOC2']
 
         # Document can be edited
-        self.browser.getLink("d101").click()
+        self.browser.getLink("DOC2").click()
         self.browser.getLink("Manage").click()
         self.browser.getControl(name="form.title").value = 'My second doc'
@@ -230 +232 @@
         self.assertTrue('Form has been saved.' in self.browser.contents)
         self.browser.getLink("View").click()
-        self.assertEqual(self.browser.url, self.container_path + '/d101/index')
+        self.assertEqual(self.browser.url, self.container_path + '/DOC2/index')
         self.assertTrue(
             '<h1>Hello World</h1>' in self.browser.contents)
@@ -241 +243 @@
             '<h1>Hallo Welt</h1>' in self.browser.contents)
         # The content can't be rendered yet
-        self.browser.open(self.container_path + '/d101/display')
+        self.browser.open(self.container_path + '/DOC2/display')
         self.assertTrue(
             'The document requested has not yet been published'
@@ -249 +251 @@
 
         # Transitions can be performed
-        self.browser.open(self.container_path + '/d101')
+        self.browser.open(self.container_path + '/DOC2')
         self.browser.getLink("Transition").click()
         self.browser.getControl(name="transition").value = ['publish']
@@ -256 +258 @@
 
         # The content can be rendered
-        self.browser.open(self.container_path + '/d101/display')
+        self.browser.open(self.container_path + '/DOC2/display')
         self.assertTrue(
             '<h1>Hallo Welt</h1>' in self.browser.contents)

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

@@ -72 +72 @@
         container = DocumentsContainer()
         document = createObject(u'waeup.HTMLDocument')
-        document_id = document.document_id
+        document.document_id = u'DOC'
         container.addDocument(document)
-        self.assertEqual(container[document_id], document)
+        self.assertEqual(container[document.document_id], document)
         self.assertRaises(TypeError, container.addDocument, object())
-        self.assertEqual(document_id, 'd123')
+        self.assertEqual(document.document_id, 'DOC')
         return
 
@@ -151 +151 @@
         # we can get an image filename for documents not in a container
         doc = PDFDocument()
+        doc.document_id = u'DOC'
         chooser = IFileStoreNameChooser(doc)
         result = chooser.chooseName('sample.jpg')
         # the file would be stored in a ``_default`` directory.
         self.assertEqual(
-            result, '__file-document__documents/sample_d123.jpg')
+            result, '__file-document__documents/sample_DOC.jpg')
         return

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

@@ -26 +26 @@
 
 
-def generate_document_id():
-    new_id = grok.getSite().unique_document_id
-    return new_id
-
-
 class DocumentsUtils(grok.GlobalUtility):
     """A collection of methods subject to customization.