Add very basic object serialization to json.

Author: tisto

src/plone/app/angularjs/api/api.py

@@ -6,6 +6,9 @@
 from zope.component.hooks import getSite
 from Products.CMFCore.utils import getToolByName
 from plone.app.angularjs.interfaces import IAPIMethod
+from plone.app.angularjs.utils import serialize_to_json
+
+
 import json
 
 
@@ -60,20 +63,9 @@ def __call__(self):
                 'message': "No object found for path '%s'." % path,
             }
 
-        # process rich text
-        text = getattr(obj, 'text', None)
-        if text is not None:
-            text = text.output
-        else:
-            text = ''
-
-        return {
-            'route': path,
-            'id': obj.id,
-            'title': obj.title,
-            'description': obj.Description(),
-            'text': text
-        }
+        result = serialize_to_json(obj)
+        result['route'] = path
+        return result
 
 
 class TopNavigation(BrowserView):

src/plone/app/angularjs/tests/test_api_traversal.py

@@ -24,14 +24,14 @@ def setUp(self):
         setRoles(self.portal, TEST_USER_ID, ['Manager'])
         directlyProvides(self.portal, IAPIRequest)
 
-    def test_traversal_view_is_registered(self):
+    def test_api_traversal_view_is_registered(self):
         view = getMultiAdapter(
             (self.portal, self.request),
             name="traversal"
         )
         self.assertTrue(view())
 
-    def test_traversal_without_param(self):
+    def test_api_traversal_without_param(self):
         view = getMultiAdapter(
             (self.portal, self.request),
             name="traversal"
@@ -41,7 +41,7 @@ def test_traversal_without_param(self):
             {u'message': u'No path has been provided.', u'code': u'404'}
         )
 
-    def test_traversal_empty_param(self):
+    def test_api_traversal_empty_param(self):
         self.request.set('path', '')
         view = getMultiAdapter(
             (self.portal, self.request),
@@ -52,7 +52,7 @@ def test_traversal_empty_param(self):
             {u'message': u'No path has been provided.', u'code': u'404'}
         )
 
-    def test_traversal_not_found(self):
+    def test_api_traversal_not_found(self):
         self.request.set('path', 'nonexisting')
 
         view = getMultiAdapter(
@@ -68,13 +68,8 @@ def test_traversal_not_found(self):
             }
         )
 
-    def test_traversal_document(self):
-        self.portal.invokeFactory('Document', 'doc1')
-        self.portal.doc1.text = RichTextValue(
-            u"Lorem ipsum.",
-            'text/plain',
-            'text/html'
-        )
+    def test_api_traversal_document_returns_title(self):
+        self.portal.invokeFactory('Document', 'doc1', title=u'Document 1')
         self.request.set('path', 'doc1')
 
         view = getMultiAdapter(
@@ -83,18 +78,13 @@ def test_traversal_document(self):
         )
 
         self.assertEqual(
-            json.loads(view()),
-            {
-                u'route': u'/plone/doc1',
-                u'title': u'',
-                u'description': u'',
-                u'text': u'<p>Lorem ipsum.</p>',
-                u'id': u'doc1'
-            }
+            json.loads(view())['title'],
+            u'Document 1'
         )
 
-    def test_traversal_document_sets_title(self):
+    def test_api_traversal_document_returns_description(self):
         self.portal.invokeFactory('Document', 'doc1', title=u'Document 1')
+        self.portal.doc1.setDescription(u'I am the first document!')
         self.request.set('path', 'doc1')
 
         view = getMultiAdapter(
@@ -103,19 +93,17 @@ def test_traversal_document_sets_title(self):
         )
 
         self.assertEqual(
-            json.loads(view()),
-            {
-                u'route': u'/plone/doc1',
-                u'title': u'Document 1',
-                u'description': u'',
-                u'text': u'',
-                u'id': u'doc1'
-            }
+            json.loads(view())['description'],
+            u'I am the first document!'
         )
 
-    def test_traversal_document_sets_description(self):
-        self.portal.invokeFactory('Document', 'doc1', title=u'Document 1')
-        self.portal.doc1.setDescription(u'I am the first document!')
+    def test_api_traversal_document_returns_text(self):
+        self.portal.invokeFactory('Document', 'doc1')
+        self.portal.doc1.text = RichTextValue(
+            u"Lorem ipsum.",
+            'text/plain',
+            'text/html'
+        )
         self.request.set('path', 'doc1')
 
         view = getMultiAdapter(
@@ -124,17 +112,11 @@ def test_traversal_document_sets_description(self):
         )
 
         self.assertEqual(
-            json.loads(view()),
-            {
-                u'route': u'/plone/doc1',
-                u'title': u'Document 1',
-                u'description': u'I am the first document!',
-                u'text': u'',
-                u'id': u'doc1'
-            }
+            json.loads(view())['text'],
+            u'<p>Lorem ipsum.</p>'
         )
 
-    def test_traversal_folder(self):
+    def test_api_traversal_folder(self):
         self.portal.invokeFactory('Folder', 'folder1')
         self.request.set('path', 'folder1')
 
@@ -144,17 +126,11 @@ def test_traversal_folder(self):
         )
 
         self.assertEqual(
-            json.loads(view()),
-            {
-                u'route': u'/plone/folder1',
-                u'title': u'',
-                u'description': u'',
-                u'text': u'',
-                u'id': u'folder1'
-            }
+            json.loads(view())['route'],
+            u'/plone/folder1'
         )
 
-    def test_traversal_nested_document(self):
+    def test_api_traversal_nested_document(self):
         self.portal.invokeFactory('Folder', 'folder1')
         self.portal.folder1.invokeFactory('Document', 'doc1')
         self.request.set('path', 'folder1/doc1')
@@ -165,12 +141,6 @@ def test_traversal_nested_document(self):
         )
 
         self.assertEqual(
-            json.loads(view()),
-            {
-                u'route': u'/plone/folder1/doc1',
-                u'title': u'',
-                u'description': u'',
-                u'text': u'',
-                u'id': u'doc1'
-            }
+            json.loads(view())['route'],
+            u'/plone/folder1/doc1'
         )

src/plone/app/angularjs/tests/test_utils.py

@@ -1,6 +1,135 @@
 # -*- coding: utf-8 -*-
 import unittest2 as unittest
 from plone.app.angularjs.utils import underscore_to_camelcase
+from plone.app.angularjs.utils import get_object_schema
+from plone.app.angularjs.utils import serialize_to_json
+from plone.app.angularjs.testing import\
+    PLONE_APP_ANGULARJS_INTEGRATION_TESTING
+from plone.app.textfield.value import RichTextValue
+
+from DateTime import DateTime
+
+
+class SerializeToJsonIntegrationTest(unittest.TestCase):
+
+    layer = PLONE_APP_ANGULARJS_INTEGRATION_TESTING
+
+    def setUp(self):
+        self.app = self.layer['app']
+        self.portal = self.layer['portal']
+
+    def test_serialize_title(self):
+        self.portal.invokeFactory('Document', id='doc1', title='Doc 1')
+
+        self.assertEqual(
+            serialize_to_json(self.portal.doc1).get('title'),
+            'Doc 1'
+        )
+
+    def test_serialize_description(self):
+        self.portal.invokeFactory('Document', id='doc1', title='Doc 1')
+        self.portal.doc1.description = u'Lorem Ipsum'
+
+        self.assertEqual(
+            serialize_to_json(self.portal.doc1).get('description'),
+            'Lorem Ipsum'
+        )
+
+    def test_serialize_rich_text(self):
+        self.portal.invokeFactory('Document', id='doc1', title='Doc 1')
+        self.portal.doc1.text = RichTextValue(
+            u"Lorem ipsum.",
+            'text/plain',
+            'text/html'
+        )
+
+        self.assertEqual(
+            serialize_to_json(self.portal.doc1).get('text'),
+            u'<p>Lorem ipsum.</p>'
+        )
+
+    def test_serialize_datetime(self):
+        self.portal.invokeFactory('Document', id='doc1', title='Doc 1')
+        self.portal.doc1.setEffectiveDate(DateTime('2014/04/04'))
+        self.assertEqual(
+            serialize_to_json(self.portal.doc1).get('effective'),
+            '2014/04/04 00:00:00 GMT+2'
+        )
+
+    def test_ignore_underscore_values(self):
+        self.portal.invokeFactory('Document', id='doc1', title='Doc 1')
+
+        self.assertFalse(
+            '__name__' in serialize_to_json(self.portal.doc1)
+        )
+        self.assertFalse(
+            'manage_options' in serialize_to_json(self.portal.doc1)
+        )
+
+
+class GetObjectSchemaUnitTest(unittest.TestCase):
+
+    layer = PLONE_APP_ANGULARJS_INTEGRATION_TESTING
+
+    def setUp(self):
+        self.app = self.layer['app']
+        self.portal = self.layer['portal']
+
+    def test_empty(self):
+        self.portal.invokeFactory('Document', id='doc1', title='Doc 1')
+        schema = [x[0] for x in get_object_schema(self.portal.doc1)]
+        self.assertEqual(
+            schema,
+            [
+                'title',
+                'allow_discussion',
+                'exclude_from_nav',
+                'text',
+                'relatedItems',
+                'table_of_contents',
+                '__dav_resource__',
+                'title',
+                'manage_options',
+                'meta_type',
+                '__name__',
+                '__http_methods__',
+                'isPrincipiaFolderish',
+                'icon',
+                '__dav_resource__',
+                'title',
+                'manage_options',
+                'meta_type',
+                '__name__',
+                '__http_methods__',
+                'isPrincipiaFolderish',
+                'icon',
+                'meta_type',
+                'isPrincipiaFolderish',
+                'manage_options',
+                '__dav_resource__',
+                '__http_methods__',
+                '_properties',
+                'title',
+                '__name__',
+                '__name__',
+                'title',
+                'allow_discussion',
+                'exclude_from_nav',
+                'rights',
+                'contributors',
+                'effective',
+                'title',
+                'expires',
+                'language',
+                'subjects',
+                'creators',
+                'description',
+                'text',
+                'relatedItems',
+                'changeNote',
+                'table_of_contents'
+            ]
+        )
 
 
 class UnderscoreToCamelcaseUnitTest(unittest.TestCase):

src/plone/app/angularjs/utils.py

@@ -1,4 +1,52 @@
 # -*- coding: utf-8 -*-
+from zope.schema import getFields
+from zope.interface import providedBy
+from plone.behavior.interfaces import IBehaviorAssignable
+from plone.app.textfield import RichText
+from zope.schema import Datetime
+
+
+def serialize_to_json(obj):
+    result = {}
+    for title, schema_object in get_object_schema(obj):
+        value = getattr(obj, title, None)
+        no_underscore_method = not title.startswith('_')
+        no_manage_method = not title.startswith('manage')
+        if value and no_underscore_method and no_manage_method:
+            # RichText
+            if isinstance(schema_object, RichText):
+                result[title] = value.output
+            # DateTime
+            elif isinstance(schema_object, Datetime):
+                # XXX: Time string needs to be localized!
+                result[title] = str(value())
+            # Callables
+            elif callable(schema_object):
+                result[title] = value()
+            # Tuple
+            elif isinstance(value, tuple):
+                result[title] = list(value)
+            # String
+            elif isinstance(value, str):
+                result[title] = value
+            # Unicode
+            elif isinstance(value, unicode):
+                result[title] = value
+            else:
+                result[title] = str(value)
+    return result
+
+
+def get_object_schema(obj):
+    for iface in providedBy(obj).flattened():
+        for name, field in getFields(iface).items():
+            yield name, field
+
+    assignable = IBehaviorAssignable(obj, None)
+    if assignable:
+        for behavior in assignable.enumerateBehaviors():
+            for name, field in getFields(behavior.interface).items():
+                yield name, field
 
 
 def underscore_to_camelcase(underscore_string):