Rename index and column blog to blog_uid

news/48.bugfix

@@ -0,0 +1 @@
+Rename blog index and metadata to blog_uid [@ericof]

src/collective/blog/content/author.py

@@ -1,3 +1,4 @@
+from collective.blog import utils
 from plone.dexterity.content import Container
 from zope.interface import implementer
 from zope.interface import Interface
@@ -10,3 +11,7 @@ class IAuthor(Interface):
 @implementer(IAuthor)
 class Author(Container):
     """An Author."""
+
+    def blog_uid(self):
+        """Return the uid of the nearest blog object."""
+        return utils.find_blog_container_uid(self)

src/collective/blog/content/post.py

@@ -1,4 +1,5 @@
 from collective.blog import _
+from collective.blog import utils
 from plone.app.z3cform.widget import AjaxSelectFieldWidget
 from plone.autoform import directives
 from plone.dexterity.content import Container
@@ -70,3 +71,7 @@ class IPost(Interface):
 @implementer(IPost)
 class Post(Container):
     """A Blog Post."""
+
+    def blog_uid(self):
+        """Return the uid of the nearest blog object."""
+        return utils.find_blog_container_uid(self)

src/collective/blog/indexers/__init__.py

@@ -1,14 +0,0 @@
-from Acquisition import aq_parent
-from collective.blog.behaviors.blog import IBlogInfo
-from plone import api
-from plone.dexterity.content import DexterityContent
-from Products.CMFPlone.Portal import IPloneSiteRoot
-
-
-def _find_blog_uid(obj: DexterityContent) -> str:
-    """Find a blog."""
-    if IBlogInfo.providedBy(obj):
-        return api.content.get_uuid(obj)
-    else:
-        # Up one level (get parent) if not reached the root of the site
-        return "" if IPloneSiteRoot.providedBy(obj) else _find_blog_uid(aq_parent(obj))

src/collective/blog/indexers/author.py

@@ -1,12 +1,9 @@
-from Acquisition import aq_parent
 from collective.blog.content.author import Author
 from collective.blog.content.author import IAuthor
-from collective.blog.indexers import _find_blog_uid
 from plone.indexer import indexer
 
 
 @indexer(IAuthor)
 def blog_author_indexer(obj: Author):
     """Return blog uuid."""
-    parent = aq_parent(obj)
-    return _find_blog_uid(parent)
+    return obj.blog_uid()

src/collective/blog/indexers/configure.zcml

@@ -3,12 +3,12 @@
   <!-- Indexers/Metadata -->
   <adapter
       factory=".author.blog_author_indexer"
-      name="blog"
+      name="blog_uid"
       />
 
   <adapter
       factory=".post.blog_post_indexer"
-      name="blog"
+      name="blog_uid"
       />
 
 </configure>

src/collective/blog/indexers/post.py

@@ -1,12 +1,9 @@
-from Acquisition import aq_parent
 from collective.blog.content.post import IPost
 from collective.blog.content.post import Post
-from collective.blog.indexers import _find_blog_uid
 from plone.indexer import indexer
 
 
 @indexer(IPost)
 def blog_post_indexer(obj: Post):
     """Return blog uuid."""
-    parent = aq_parent(obj)
-    return _find_blog_uid(parent)
+    return obj.blog_uid()

src/collective/blog/profiles/default/catalog.xml

@@ -1,12 +1,25 @@
 <?xml version="1.0" encoding="utf-8"?>
 <object name="portal_catalog">
 
+  <!-- Remove old blog index and column-->
   <index meta_type="FieldIndex"
          name="blog"
+         remove="true"
   >
     <indexed_attr value="blog" />
   </index>
 
-  <column value="blog" />
+  <column remove="true"
+          value="blog"
+  />
+
+  <!-- Add new index and column-->
+  <index meta_type="FieldIndex"
+         name="blog_uid"
+  >
+    <indexed_attr value="blog_uid" />
+  </index>
+
+  <column value="blog_uid" />
 
 </object>

src/collective/blog/profiles/default/registry/Products.CMFPlone.interfaces.controlpanel.INavigationSchema.xml

@@ -12,7 +12,7 @@
   >
     <value purge="false">
       <element>Author</element>
-      <element>Blog</element>
+      <element>BlogFolder</element>
     </value>
   </record>
 

src/collective/blog/profiles/default/types/BlogFolder.xml

@@ -1,14 +1,14 @@
 <?xml version="1.0" encoding="utf-8"?>
 <object xmlns:i18n="http://xml.zope.org/namespaces/i18n"
         meta_type="Dexterity FTI"
-        name="BlogFolder"
+        name="Blog"
         i18n:domain="collective.blog"
 >
 
   <!-- Basic properties -->
   <property name="title"
             i18n:translate=""
-  >BlogFolder</property>
+  >Blog</property>
   <property name="description"
             i18n:translate=""
   >A folderish content item representing a Blog</property>

src/collective/blog/upgrades/configure.zcml

@@ -23,10 +23,18 @@
         title="Rename Blog fti as BlogFolder"
         import_steps="typeinfo"
         />
+    <genericsetup:upgradeDepends
+        title="Catalog: Add blog_uid column and index"
+        import_steps="catalog"
+        />
     <genericsetup:upgradeStep
         title="Update old Blog objects with new portal_type"
         handler=".v1002.recatalog_portal_type"
         />
+    <genericsetup:upgradeStep
+        title="Recatalog Author and Post items"
+        handler=".v1002.recatalog_blog_uid"
+        />
   </genericsetup:upgradeSteps>
 
 

src/collective/blog/upgrades/v1002.py

@@ -16,12 +16,7 @@ def _migrate_existing_content(old_pt: str, new_pt: str) -> int:
         for brain in brains:
             obj = brain.getObject()
             obj.portal_type = new_pt
-            obj.reindexObject(
-                idxs=[
-                    "portal_type",
-                    "Type",
-                ],
-            )
+            obj.reindexObject()
         return total
 
 
@@ -30,4 +25,16 @@ def recatalog_portal_type(setup_tool: SetupTool):
     for old_pt, new_pt in TYPES_MAPPING:
         items = _migrate_existing_content(old_pt, new_pt)
         logger.info(f"Converted {items} {old_pt} instances")
-    logger.info("Upgrade complete")
+    logger.info("Converted old Blog instances")
+
+
+def recatalog_blog_uid(setup_tool: SetupTool):
+    """Recatalog Post and Author blog_uid."""
+    with api.env.adopt_roles(["Manager"]):
+        brains = api.content.find(portal_type=["Author", "Post"])
+        total = len(brains)
+        logger.info(f"Recatalog {total} items")
+        for brain in brains:
+            obj = brain.getObject()
+            obj.reindexObject(idxs=["blog_uid"])
+    logger.info("Reindexed blog_uid")

src/collective/blog/utils.py

@@ -0,0 +1,21 @@
+from Acquisition import aq_parent
+from collective.blog.behaviors.blog import IBlogInfo
+from plone import api
+from plone.dexterity.content import DexterityContent
+from Products.CMFPlone.Portal import IPloneSiteRoot
+
+
+_BLOG_TYPES = "BlogFolder"
+
+
+def find_blog_container_uid(obj: DexterityContent) -> str:
+    """Find a blog."""
+    if IBlogInfo.providedBy(obj) or obj.portal_type in _BLOG_TYPES:
+        return api.content.get_uuid(obj)
+    else:
+        # Up one level (get parent) if not reached the root of the site
+        return (
+            ""
+            if IPloneSiteRoot.providedBy(obj)
+            else find_blog_container_uid(aq_parent(obj))
+        )

tests/content/test_author.py

@@ -68,12 +68,13 @@ def test_indexer_blog(self, portal, authors_payload):
         blog_uid = api.content.get_uuid(blog)
         payload = authors_payload[0]
         # Check there is no Author connected to this blog
-        brains = api.content.find(portal_type=CONTENT_TYPE, blog=blog_uid)
+        brains = api.content.find(portal_type=CONTENT_TYPE, blog_uid=blog_uid)
         assert len(brains) == 0
         # Create an Author inside the blog
         with api.env.adopt_roles(["Manager"]):
             content = api.content.create(container=authors_folder, **payload)
 
-        brains = api.content.find(portal_type=CONTENT_TYPE, blog=blog_uid)
+        brains = api.content.find(portal_type=CONTENT_TYPE, blog_uid=blog_uid)
         assert len(brains) == 1
         assert brains[0].Title == content.title
+        assert brains[0].blog_uid == blog_uid

tests/content/test_blog.py

@@ -90,6 +90,7 @@ def test_create(self, blogs_payload):
     def test_create_valid_ids(self, blogs_payload, content_id, expected):
         payload = deepcopy(blogs_payload[0])
         payload["id"] = content_id
+        payload["safe_id"] = True
         with api.env.adopt_roles(["Manager"]):
             content = api.content.create(container=self.portal, **payload)
         assert content.id == expected

tests/setup/test_setup_navigation.py

@@ -12,7 +12,7 @@ def _init(self, portal):
         "portal_type",
         [
             "Author",
-            "Blog",
+            "BlogFolder",
             "Collection",
             "Document",
             "Event",

tests/setup/upgrades/test_upgrades_to_v1002.py

@@ -66,4 +66,31 @@ def test_old_blogs_migrated(self, do_upgrade):
             brains = api.content.find(portal_type="BlogFolder")
         assert len(brains) == 1
         assert self.old_blog.portal_type == "BlogFolder"
-        assert self.old_blog.Type() == "BlogFolder"
+        assert self.old_blog.Type() == "Blog"
+
+    def test_catalog_removed_indexes_columns(self, do_upgrade):
+        do_upgrade(self.dest)
+        catalog = api.portal.get_tool("portal_catalog")
+        indexes = list(catalog.indexes())
+        columns = list(catalog.schema())
+        assert "blog" not in indexes
+        assert "blog" not in columns
+
+    def test_catalog_added_indexes_columns(self, do_upgrade):
+        do_upgrade(self.dest)
+        catalog = api.portal.get_tool("portal_catalog")
+        indexes = list(catalog.indexes())
+        columns = list(catalog.schema())
+        assert "blog_uid" in indexes
+        assert "blog_uid" in columns
+
+    def test_reindex_blog_uid(self, authors_payload, do_upgrade):
+        author_payload = authors_payload[0]
+        with api.env.adopt_roles(["Manager"]):
+            container = self.old_blog["authors"]
+            author = api.content.create(container=container, **author_payload)
+        author_blog_uid = author.blog_uid()
+        do_upgrade(self.dest)
+        with api.env.adopt_roles(["Manager"]):
+            brains = api.content.find(portal_type="Author")
+        assert brains[0].blog_uid == author_blog_uid