Changeset 12004

Timestamp:

20 Nov 2014, 04:11:18 (10 years ago)

Author:

Henrik Bettermann

Message:

Replace 'id' by 'document_id'.

Location:

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

Files:

• customers/batching.py (modified) (7 diffs)
• customers/tests/sample_document_data.csv (modified) (1 diff)
• customers/tests/test_batching.py (modified) (8 diffs)
• customers/tests/test_document.py (modified) (2 diffs)
• documents/catalog.py (modified) (2 diffs)
• documents/container.py (modified) (2 diffs)
• documents/document.py (modified) (2 diffs)
• documents/interfaces.py (modified) (2 diffs)
• documents/tests.py (modified) (2 diffs)

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

@@ -1 @@
-## $Id: batching.py 11891 2014-10-28 20:02:45Z henrik $
+## $Id$
 ##
 ## Copyright (C) 2014 Uli Fouquet & Henrik Bettermann
@@ -355 +355 @@
         raw_header = reader.next()
         for num, field in enumerate(headerfields):
-            if field not in ['customer_id', 'reg_number', 'id', 'code', 'level'
+            if field not in ['customer_id', 'reg_number', 'document_id', 'code', 'level'
                              ] and mode == 'remove':
                 continue
@@ -378 +378 @@
 
     location_fields = []
-    additional_fields = ['id']
+    additional_fields = ['document_id']
     additional_headers = []
 
     def checkHeaders(self, headerfields, mode='ignore'):
         super(CustomerDocumentProcessor, self).checkHeaders(headerfields)
-        if mode in ('update', 'remove') and not 'id' in headerfields:
-            raise FatalCSVError(
-                "Need id for import in update and remove modes!")
+        if mode in ('update', 'remove') and not 'document_id' in headerfields:
+            raise FatalCSVError(
+                "Need document_id for import in update and remove modes!")
         return True
 
@@ -398 +398 @@
         if documents is None:
             return None
-        id = row.get('id', None)
-        if id is None:
-            return None
-        entry = documents.get(id)
+        document_id = row.get('document_id', None)
+        if document_id is None:
+            return None
+        entry = documents.get(document_id)
         return entry
 
@@ -417 +417 @@
     def addEntry(self, obj, row, site):
         parent = self.getParent(row, site)
-        id = row['id'].strip('#')
-        parent[id] = obj
+        document_id = row['document_id'].strip('#')
+        parent[document_id] = obj
         return
 
@@ -427 +427 @@
             customer = self._getCustomer(row, site)
             customer.__parent__.logger.info('%s - Document removed: %s'
-                % (customer.customer_id, document.id))
-            del parent[document.id]
+                % (customer.customer_id, document.document_id))
+            del parent[document.document_id]
         return
 
@@ -437 +437 @@
             CustomerDocumentProcessor, self).checkConversion(row, mode=mode)
 
-        # We have to check id.
-        id = row.get('id', None)
-        if not id:
+        # We have to check document_id.
+        document_id = row.get('document_id', None)
+        if not document_id:
             timestamp = ("%d" % int(time()*10000))[1:]
-            id = "d%s" % timestamp
-            conv_dict['id'] = id
+            document_id = "d%s" % timestamp
+            conv_dict['document_id'] = document_id
             return errs, inv_errs, conv_dict
-        if not id.startswith('d') or len(id) != 14:
-            errs.append(('id','invalid format'))
+        if not document_id.startswith('d') or len(document_id) != 14:
+            errs.append(('document_id','invalid format'))
         return errs, inv_errs, conv_dict

main/waeup.ikoba/trunk/src/waeup/ikoba/customers/tests/sample_document_data.csv

@@ -1 @@
-id,reg_number,title
+document_id,reg_number,title
 d1266236341953,1,My first doc
 d1266236341954,2,My second doc

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

@@ -1 +1 @@
 # -*- coding: utf-8 -*-
-## $Id: test_batching.py 11756 2014-07-09 12:46:08Z henrik $
+## $Id$
 ##
 ## Copyright (C) 2014 Uli Fouquet & Henrik Bettermann
@@ -259 +259 @@
         self.customer = self.app['customers'][customer.customer_id]
         document = createObject(u'waeup.CustomerDocument')
-        document.id = 'd120'
-        self.customer['documents'][document.id] = document
+        document.document_id = 'd120'
+        self.customer['documents'][document.document_id] = document
 
         # Import customers with subobjects
@@ -282 +282 @@
     def test_getEntry(self):
         assert self.processor.getEntry(
-            dict(customer_id='ID_NONE', id='nonsense'), self.app) is None
-        assert self.processor.getEntry(
-            dict(customer_id=self.customer.customer_id, id='d120'),
+            dict(customer_id='ID_NONE', document_id='nonsense'), self.app) is None
+        assert self.processor.getEntry(
+            dict(customer_id=self.customer.customer_id, document_id='d120'),
             self.app) is self.customer['documents']['d120']
 
     def test_delEntry(self):
         assert self.processor.getEntry(
-            dict(customer_id=self.customer.customer_id, id='d120'),
+            dict(customer_id=self.customer.customer_id, document_id='d120'),
             self.app) is self.customer['documents']['d120']
         self.assertEqual(len(self.customer['documents'].keys()),1)
         self.processor.delEntry(
-            dict(customer_id=self.customer.customer_id, id='d120'),
+            dict(customer_id=self.customer.customer_id, document_id='d120'),
             self.app)
         assert self.processor.getEntry(
-            dict(customer_id=self.customer.customer_id, id='d120'),
+            dict(customer_id=self.customer.customer_id, document_id='d120'),
             self.app) is None
         self.assertEqual(len(self.customer['documents'].keys()),0)
@@ -303 +303 @@
         self.assertEqual(len(self.customer['documents'].keys()),1)
         document1 = createObject(u'waeup.CustomerDocument')
-        document1.id = 'p234'
+        document1.document_id = 'p234'
         self.processor.addEntry(
-            document1, dict(customer_id=self.customer.customer_id, id='p234'),
+            document1, dict(customer_id=self.customer.customer_id, document_id='p234'),
             self.app)
         self.assertEqual(len(self.customer['documents'].keys()),2)
-        self.assertEqual(self.customer['documents']['p234'].id, 'p234')
+        self.assertEqual(self.customer['documents']['p234'].document_id, 'p234')
         document2 = createObject(u'waeup.CustomerDocument')
-        document1.id = 'nonsense'
+        document1.document_id = 'nonsense'
 
     def test_checkConversion(self):
         errs, inv_errs, conv_dict = self.processor.checkConversion(
-            dict(id='d1266236341955'))
+            dict(document_id='d1266236341955'))
         self.assertEqual(len(errs),0)
         errs, inv_errs, conv_dict = self.processor.checkConversion(
-            dict(id='nonsense'))
+            dict(document_id='nonsense'))
         self.assertEqual(len(errs),1)
         timestamp = ("%d" % int(time()*10000))[1:]
-        id = "d%s" % timestamp
-        errs, inv_errs, conv_dict = self.processor.checkConversion(
-            dict(id=id))
+        document_id = "d%s" % timestamp
+        errs, inv_errs, conv_dict = self.processor.checkConversion(
+            dict(document_id=document_id))
         self.assertEqual(len(errs),0)
 
@@ -330 +330 @@
         self.assertEqual(num_warns,0)
         document = self.processor.getEntry(dict(reg_number='1',
-            id='d1266236341953'), self.app)
+            document_id='d1266236341953'), self.app)
         self.assertEqual(
             self.app['customers']['X666666']['documents']['d1266236341953'],
             document)
-        self.assertEqual(document.id, 'd1266236341953')
+        self.assertEqual(document.document_id, 'd1266236341953')
         document = self.processor.getEntry(dict(reg_number='3',
-            id='d1266236341955'), self.app)
+            document_id='d1266236341955'), self.app)
         shutil.rmtree(os.path.dirname(fin_file))
         logcontent = open(self.logfile).read()
@@ -343 +343 @@
             'INFO - system - CustomerDocument Processor - '
             'sample_document_data - X666666 - updated: '
-            'id=d1266236341953, title=My first doc'
+            'document_id=d1266236341953, title=My first doc'
             in logcontent)
 
@@ -355 +355 @@
         num, num_warns, fin_file, fail_file = self.processor.doImport(
             self.csv_file, DOCUMENT_HEADER_FIELDS,'update')
-        self.assertEqual(num_warns,1)  # There is one record without id
+        self.assertEqual(num_warns,1)  # There is one record without document_id
         shutil.rmtree(os.path.dirname(fin_file))
 
@@ -367 +367 @@
         num, num_warns, fin_file, fail_file = self.processor.doImport(
             self.csv_file, DOCUMENT_HEADER_FIELDS,'remove')
-        self.assertEqual(num_warns,1)  # There is one record without id
+        self.assertEqual(num_warns,1)  # There is one record without document_id
         shutil.rmtree(os.path.dirname(fin_file))
         logcontent = open(self.logfile).read()

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

@@ -1 @@
-## $Id: tests.py 9469 2012-10-30 17:49:17Z henrik $
+## $Id$
 ##
 ## Copyright (C) 2014 Uli Fouquet & Henrik Bettermann
@@ -57 +57 @@
         container = CustomerDocumentsContainer()
         document = createObject(u'waeup.CustomerDocument')
-        document.id = 'my_document'
+        id = document.document_id
         container.addDocument(document)
-        self.assertEqual(container['my_document'], document)
+        self.assertEqual(container[id], document)
         self.assertRaises(TypeError, container.addDocument, object())
         return

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

@@ -1 @@
-## $Id: catalog.py 8700 2012-06-12 21:01:17Z henrik $
+## $Id$
 ##
 ## Copyright (C) 2011 Uli Fouquet & Henrik Bettermann
@@ -29 +29 @@
     grok.context(IDocument)
 
-    id = grok.index.Field(attribute='id')
+    document_id = grok.index.Field(attribute='document_id')

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

@@ -1 @@
-## $Id: container.py 7811 2012-03-08 19:00:51Z uli $
+## $Id$
 ##
 ## Copyright (C) 2014 Uli Fouquet & Henrik Bettermann
@@ -38 +38 @@
             raise TypeError(
                 'DocumentsContainers contain only IDocument instances')
-        self[document.id] = document
+        self[document.document_id] = document
         return
 

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

@@ -1 @@
-## $Id: document.py 10842 2013-12-11 13:21:37Z henrik $
+## $Id$
 ##
 ## Copyright (C) 2014 Uli Fouquet & Henrik Bettermann
@@ -54 +54 @@
         super(Document, self).__init__()
         timestamp = ("%d" % int(time()*10000))[1:]
-        self.id = "d%s" % timestamp
+        self.document_id = "d%s" % timestamp
         return
 

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

@@ -1 @@
-## $Id: interfaces.py 11450 2014-02-27 06:25:18Z henrik $
+## $Id$
 ##
 ## Copyright (C) 2014 Uli Fouquet & Henrik Bettermann
@@ -39 +39 @@
 
     """
-    id = Attribute('Document Identifier')
+    document_id = Attribute('Document Identifier')
     history = Attribute('Object history, a list of messages')
 

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

@@ -1 @@
-## $Id: tests.py 9469 2012-10-30 17:49:17Z henrik $
+## $Id$
 ##
 ## Copyright (C) 2014 Uli Fouquet & Henrik Bettermann
@@ -57 +57 @@
         container = DocumentsContainer()
         document = createObject(u'waeup.Document')
-        id = document.id
+        document_id = document.document_id
         container.addDocument(document)
-        self.assertEqual(container[id], document)
+        self.assertEqual(container[document_id], document)
         self.assertRaises(TypeError, container.addDocument, object())
         return