Improve is_folderish property to include Plone site and AT content types

plone · Nov 7, 2017 · f2a7128 · f2a7128
1 parent 64ea75a
commit f2a7128
Show file tree

Hide file tree

Showing 20 changed files with 35 additions and 14 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -4,7 +4,8 @@ Changelog
 1.0b1 (unreleased)
 ------------------
 
-- Nothing changed yet.
+- Improve is_folderish property to include Plone site and AT content types
+  [sneridagh]
 
 
 1.0a23 (2017-11-07)

diff --git a/docs/source/_json/collection.resp b/docs/source/_json/collection.resp
@@ -29,7 +29,7 @@ Content-Type: application/json
   "exclude_from_nav": false, 
   "expires": null, 
   "id": "collection", 
-  "is_folderish": false,
+  "is_folderish": false, 
   "item_count": 30, 
   "items": [
     {

diff --git a/docs/source/_json/content_get.resp b/docs/source/_json/content_get.resp
@@ -28,7 +28,7 @@ Content-Type: application/json
   "exclude_from_nav": false, 
   "expires": null, 
   "id": "my-document", 
-  "is_folderish": false,
+  "is_folderish": false, 
   "language": "", 
   "layout": "document_view", 
   "modified": "2016-10-21T19:00:00+00:00", 

diff --git a/docs/source/_json/content_post.resp b/docs/source/_json/content_post.resp
@@ -29,7 +29,7 @@ Location: http://localhost:55001/plone/folder/my-document
   "exclude_from_nav": false, 
   "expires": null, 
   "id": "my-document", 
-  "is_folderish": false,
+  "is_folderish": false, 
   "language": "", 
   "layout": "document_view", 
   "modified": "2016-10-21T19:00:00+00:00", 

diff --git a/docs/source/_json/document.resp b/docs/source/_json/document.resp
@@ -29,7 +29,7 @@ Content-Type: application/json
   "exclude_from_nav": false, 
   "expires": null, 
   "id": "front-page", 
-  "is_folderish": false,
+  "is_folderish": false, 
   "language": "", 
   "layout": "document_view", 
   "modified": "2016-01-21T01:24:11+00:00", 

diff --git a/docs/source/_json/event.resp b/docs/source/_json/event.resp
@@ -35,7 +35,7 @@ Content-Type: application/json
   "exclude_from_nav": false, 
   "expires": null, 
   "id": "event", 
-  "is_folderish": false,
+  "is_folderish": false, 
   "language": "", 
   "layout": "event_view", 
   "location": null, 

diff --git a/docs/source/_json/expansion.resp b/docs/source/_json/expansion.resp
@@ -29,7 +29,7 @@ Content-Type: application/json
   "exclude_from_nav": false, 
   "expires": null, 
   "id": "front-page", 
-  "is_folderish": false,
+  "is_folderish": false, 
   "language": "", 
   "layout": "document_view", 
   "modified": "2016-01-21T01:24:11+00:00", 

diff --git a/docs/source/_json/expansion_expanded.resp b/docs/source/_json/expansion_expanded.resp
@@ -35,7 +35,7 @@ Content-Type: application/json
   "exclude_from_nav": false, 
   "expires": null, 
   "id": "front-page", 
-  "is_folderish": false,
+  "is_folderish": false, 
   "language": "", 
   "layout": "document_view", 
   "modified": "2016-01-21T01:24:11+00:00", 

diff --git a/docs/source/_json/expansion_expanded_full.resp b/docs/source/_json/expansion_expanded_full.resp
@@ -65,7 +65,7 @@ Content-Type: application/json
   "exclude_from_nav": false, 
   "expires": null, 
   "id": "front-page", 
-  "is_folderish": false,
+  "is_folderish": false, 
   "language": "", 
   "layout": "document_view", 
   "modified": "2016-01-21T01:24:11+00:00", 

diff --git a/docs/source/_json/file.resp b/docs/source/_json/file.resp
@@ -34,7 +34,7 @@ Content-Type: application/json
     "size": 74429
   }, 
   "id": "file", 
-  "is_folderish": false,
+  "is_folderish": false, 
   "language": "", 
   "layout": "file_view", 
   "modified": "2016-01-21T05:24:11+00:00", 

diff --git a/docs/source/_json/folder.resp b/docs/source/_json/folder.resp
@@ -28,7 +28,7 @@ Content-Type: application/json
   "exclude_from_nav": false, 
   "expires": null, 
   "id": "folder", 
-  "is_folderish": true,
+  "is_folderish": true, 
   "items": [
     {
       "@id": "http://localhost:55001/plone/folder/doc1", 

diff --git a/docs/source/_json/image.resp b/docs/source/_json/image.resp
@@ -73,7 +73,7 @@ Content-Type: application/json
     "size": 1185, 
     "width": 215
   }, 
-  "is_folderish": false,
+  "is_folderish": false, 
   "language": "", 
   "layout": "image_view", 
   "modified": "2016-01-21T06:24:11+00:00", 

diff --git a/docs/source/_json/jwt_logged_in.resp b/docs/source/_json/jwt_logged_in.resp
@@ -13,6 +13,7 @@ Content-Type: application/json
   "@id": "http://localhost:55001/plone/", 
   "@type": "Plone Site", 
   "id": "plone", 
+  "is_folderish": true, 
   "items": [
     {
       "@id": "http://localhost:55001/plone/front-page", 

diff --git a/docs/source/_json/link.resp b/docs/source/_json/link.resp
@@ -29,7 +29,7 @@ Content-Type: application/json
   "exclude_from_nav": false, 
   "expires": null, 
   "id": "link", 
-  "is_folderish": false,
+  "is_folderish": false, 
   "language": "", 
   "layout": "link_redirect_view", 
   "modified": "2016-01-21T04:24:11+00:00", 

diff --git a/docs/source/_json/newsitem.resp b/docs/source/_json/newsitem.resp
@@ -75,7 +75,7 @@ Content-Type: application/json
     "width": 215
   }, 
   "image_caption": "This is an image caption.", 
-  "is_folderish": false,
+  "is_folderish": false, 
   "language": "", 
   "layout": "newsitem_view", 
   "modified": "2016-01-21T02:24:11+00:00", 

diff --git a/docs/source/_json/siteroot.resp b/docs/source/_json/siteroot.resp
@@ -13,6 +13,7 @@ Content-Type: application/json
   "@id": "http://localhost:55001/plone", 
   "@type": "Plone Site", 
   "id": "plone", 
+  "is_folderish": true, 
   "items": [
     {
       "@id": "http://localhost:55001/plone/front-page", 

diff --git a/src/plone/restapi/serializer/atcontent.py b/src/plone/restapi/serializer/atcontent.py
@@ -47,6 +47,7 @@ def __call__(self, version=None):
             'review_state': self._get_workflow_state(obj),
             'UID': obj.UID(),
             'layout': self.context.getLayout(),
+            'is_folderish': False
         }
 
         # Insert expandable elements
@@ -88,6 +89,9 @@ def __call__(self, version=None):
         folder_metadata = super(SerializeFolderToJson, self).__call__(
             version=version
         )
+
+        folder_metadata.update({'is_folderish': True})
+
         query = self._build_query()
 
         catalog = getToolByName(self.context, 'portal_catalog')

diff --git a/src/plone/restapi/serializer/site.py b/src/plone/restapi/serializer/site.py
@@ -44,6 +44,7 @@ def __call__(self, version=None):
             '@type': 'Plone Site',
             'title': self.context.Title(),
             'parent': {},
+            'is_folderish': True
         }
 
         # Insert expandable elements

diff --git a/src/plone/restapi/tests/test_atcontent_serializer.py b/src/plone/restapi/tests/test_atcontent_serializer.py
@@ -165,3 +165,11 @@ def test_serializer_includes_expansion(self):
         obj = self.serialize(self.doc1)
         self.assertIn('foo', obj['@components'])
         self.assertEqual('collapsed', obj['@components']['foo'])
+
+    def test_get_is_folderish_in_folder(self):
+        self.portal.invokeFactory('Folder', id=u'folder')
+        serializer = getMultiAdapter((self.portal.folder, self.request),
+                                     ISerializeToJson)
+        obj = serializer()
+        self.assertIn('is_folderish', obj)
+        self.assertEquals(True, obj['is_folderish'])
diff --git a/src/plone/restapi/tests/test_site_serializer.py b/src/plone/restapi/tests/test_site_serializer.py
@@ -30,3 +30,8 @@ def test_serializer_includes_title(self):
         obj = self.serialize()
         self.assertIn(u'title', obj)
         self.assertEqual(u'Plone site', obj[u'title'])
+
+    def test_get_is_folderish(self):
+        obj = self.serialize()
+        self.assertIn('is_folderish', obj)
+        self.assertEquals(True, obj['is_folderish'])