eea.volto.policy 3.4__zip → 4.0__zip

{eea.volto.policy-3.4/eea.volto.policy.egg-info → eea.volto.policy-4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: eea.volto.policy
-Version: 3.4
+Version: 4.0
 Summary: An add-on for Plone
 Home-page: https://github.com/eea/eea.volto.policy
 Author: European Environment Agency: IDM2 A-Team
@@ -128,6 +128,16 @@ EEA_ - European Environment Agency (EU)
 Changelog
 =========
 
+4.0 - (2024-05-20)
+---------------------------
+* Feature: Migrate teaserGrid to gridBlock structure from Volto 17 core
+  [avoinea - refs #265726]
+
+3.5 - (2024-05-14)
+---------------------------
+* Change: feat(serializer): added effective to the default_metadata_fields
+  [ichim-david]
+
 3.4 - (2024-03-28)
 ---------------------------
 * Change: Develop typo

{eea.volto.policy-3.4 → eea.volto.policy-4.0}/docs/HISTORY.txt

@@ -1,6 +1,16 @@
 Changelog
 =========
 
+4.0 - (2024-05-20)
+---------------------------
+* Feature: Migrate teaserGrid to gridBlock structure from Volto 17 core
+  [avoinea - refs #265726]
+
+3.5 - (2024-05-14)
+---------------------------
+* Change: feat(serializer): added effective to the default_metadata_fields
+  [ichim-david]
+
 3.4 - (2024-03-28)
 ---------------------------
 * Change: Develop typo

eea.volto.policy-4.0/eea/volto/policy/browser/configure.zcml

@@ -0,0 +1,30 @@
+<configure
+  xmlns="http://namespaces.zope.org/zope"
+  xmlns:browser="http://namespaces.zope.org/browser"
+  i18n_domain="eea">
+
+  <browser:page
+    name="teaser-layout-migrate"
+    for="Products.CMFPlone.interfaces.IPloneSiteRoot"
+    layer="eea.volto.policy.interfaces.IEeaVoltoPolicyLayer"
+    class=".teaser.TeaserMigrateLayout"
+    permission="cmf.ManagePortal"
+    />
+
+  <browser:page
+    name="teaser-migrate"
+    for="Products.CMFPlone.interfaces.IPloneSiteRoot"
+    layer="eea.volto.policy.interfaces.IEeaVoltoPolicyLayer"
+    class=".teaser.TeaserMigrateSite"
+    permission="cmf.ManagePortal"
+    />
+
+  <browser:page
+    name="teaser-migrate"
+    for="Products.CMFCore.interfaces.IContentish"
+    layer="eea.volto.policy.interfaces.IEeaVoltoPolicyLayer"
+    class=".teaser.TeaserMigrateContent"
+    permission="cmf.ManagePortal"
+    />
+
+</configure>

eea.volto.policy-4.0/eea/volto/policy/browser/teaser.py

@@ -0,0 +1,172 @@
+""" Migrate teaser block from teaserGrid to Volto 17 gridBlock
+"""
+# pylint: disable=line-too-long
+import copy
+import logging
+import transaction
+from Products.Five.browser import BrowserView
+from Products.statusmessages.interfaces import IStatusMessage
+from Products.CMFPlone.interfaces import IPloneSiteRoot
+from plone import api
+from plone.protect.interfaces import IDisableCSRFProtection
+from plone.restapi.blocks import visit_blocks
+from plone.restapi.types.utils import update_field, get_info_for_field
+from plone.restapi.types.utils import serializeSchema
+from zope.component import queryMultiAdapter
+from zope.component import queryUtility
+from zope.interface import alsoProvides
+from zope.schema.interfaces import IVocabularyFactory
+from zope.lifecycleevent import modified
+from zExceptions import Forbidden
+logger = logging.getLogger("eea.volto.policy")
+
+
+class TeaserMigrateContent(BrowserView):
+    """Migration of teaserGrid to gridBlock"""
+
+    def convert(self, block_data):
+        """Convert block_data to gridBlock"""
+        grid_block = copy.deepcopy(block_data)
+
+        grid_block["@type"] = "gridBlock"
+        columns = block_data.get("columns", [])
+        grid_block["blocks_layout"] = {
+            "items": [column["id"] for column in columns]
+        }
+        grid_block["blocks"] = {x["id"]: x for x in columns}
+        try:
+            del grid_block["columns"]
+        except KeyError:
+            logger.exception("No columns found in %s",
+                             self.context.absolute_url())
+        return grid_block
+
+    def migrate(self):
+        """Migrate teaserGrid to gridBlock"""
+        count = 0
+        blocks = getattr(self.context, "blocks", {})
+        for block in visit_blocks(self.context, blocks):
+            # we have found a teaserGrid
+            if block.get("@type", False) and block["@type"] == "teaserGrid":
+                new_block = self.convert(block)
+                block.clear()
+                block.update(new_block)
+                count += 1
+        if count:
+            logger.info(
+                "Migrated %s teaserBlock to gridBlock for %s",
+                count,
+                self.context.absolute_url(),
+            )
+            modified(self.context)
+        return count
+
+    def __call__(self):
+        # Disable CSRF protection
+        alsoProvides(self.request, IDisableCSRFProtection)
+        count = self.migrate()
+        IStatusMessage(self.request).addStatusMessage(
+            f"Migrated {count} Teaser Blocks")
+        return self.request.response.redirect(self.context.absolute_url())
+
+
+class TeaserMigrateSite(TeaserMigrateContent):
+    """Migrate Teaser Blocks to Volto 17"""
+
+    def migrate(self):
+        """Migrate Teaser Blocks to Volto 17"""
+        brains = api.content.find(
+            context=self.context,
+            object_provides="plone.restapi.behaviors.IBlocks"
+        )
+
+        count = 0
+        total = len(brains)
+        for idx, brain in enumerate(brains):
+            obj = brain.getObject()
+            if IPloneSiteRoot.providedBy(obj):
+                if super().migrate():
+                    count += 1
+                continue
+            view = queryMultiAdapter(
+                (obj, self.request), name="teaser-migrate")
+            if view.migrate():
+                count += 1
+            if idx % 100 == 0:
+                transaction.savepoint(optimistic=True)
+                logger.info("Progress %s of %s. Migrated %s",
+                            idx, total, count)
+        return count
+
+    def __call__(self):
+        alsoProvides(self.request, IDisableCSRFProtection)
+        count = self.migrate()
+        IStatusMessage(self.request).addStatusMessage(
+            f"Migrated {count} Teaser Blocks"
+        )
+        return self.request.response.redirect(self.context.absolute_url())
+
+
+class TeaserMigrateLayout(TeaserMigrateSite):
+    """ Migrate Teaser Blocks in DX Layout """
+
+    def migrate_type(self, context):
+        """Migrate teaserGrid to gridBlock"""
+        count = 0
+        try:
+            blocks = get_info_for_field(context, self.request, "blocks")
+        except (AttributeError, Forbidden):
+            # no blocks field
+            return count
+        else:
+            blocks = blocks.get("default", {})
+
+        for block in visit_blocks(context, blocks):
+            # we have found a teaserGrid
+            if block.get("@type", False) and block["@type"] == "teaserGrid":
+                new_block = self.convert(block)
+                block.clear()
+                block.update(new_block)
+                count += 1
+        if count:
+            update_field(context, self.request, {
+                "id": "blocks",
+                "default": blocks,
+            })
+            serializeSchema(context.schema)
+        return count
+
+    def migrate(self):
+        """ Migrate Teaser Blocks in DX Layout """
+        count = 0
+        ctypes = queryUtility(
+            IVocabularyFactory,
+            name="plone.app.vocabularies.ReallyUserFriendlyTypes"
+        )
+        dtool = queryMultiAdapter(
+            (self.context, self.request), name="dexterity-types")
+        brains = ctypes(self.context)
+        total = len(brains)
+        for idx, ctype in enumerate(brains):
+            cid = ctype.value
+            try:
+                dtype = dtool.publishTraverse(self.request, cid)
+            except KeyError as err:
+                # KeyError: 'Discussion Item'
+                logger.exception(err)
+                continue
+            try:
+                if self.migrate_type(dtype):
+                    count += 1
+            except AttributeError as err:
+                logger.exception("Could not migrate %s: %s", cid, err)
+            logger.info("Progress %s of %s. Migrated %s", idx, total, count)
+        return count
+
+    def __call__(self):
+        alsoProvides(self.request, IDisableCSRFProtection)
+        count = self.migrate()
+        IStatusMessage(self.request).addStatusMessage(
+            f"Migrated content-types layout {count} teaserGrid to gridBlock"
+        )
+        return self.request.response.redirect(self.context.absolute_url())

{eea.volto.policy-3.4 → eea.volto.policy-4.0}/eea/volto/policy/configure.zcml

@@ -10,6 +10,7 @@
   <include package="plone.volto" />
   <include file="profiles.zcml" />
 
+  <include package=".browser" />
   <include package=".behaviors" />
   <include package=".contentrules" />
   <include package=".restapi" />

{eea.volto.policy-3.4 → eea.volto.policy-4.0}/eea/volto/policy/contentrules/actions.py

@@ -34,7 +34,7 @@ class SetPublicationDateToNullAction(SimpleItem):
 
 @implementer(IExecutable)
 @adapter(Interface, ISetPublicationDateToNullAction, Interface)
-class SetPublicationDateToNullExecutor(object):
+class SetPublicationDateToNullExecutor:
     """Set Publication Date to null executor"""
 
     def __init__(self, context, element, event):

{eea.volto.policy-3.4 → eea.volto.policy-4.0}/eea/volto/policy/image_scales/adapters.py

@@ -26,7 +26,7 @@ from eea.volto.policy.image_scales.interfaces import (
 
 @implementer(IImageScalesAdapter)
 @adapter(IDexterityContent, Interface)
-class ImageScales(object):
+class ImageScales:
     """
     Adapter for getting image scales
     """
@@ -74,7 +74,7 @@ def _get_scale_infos():
 
 @implementer(IImageScalesFieldAdapter)
 @adapter(INamedImageField, IDexterityContent, Interface)
-class ImageFieldScales(object):
+class ImageFieldScales:
     """
     Image scale serializer
     """

{eea.volto.policy-3.4 → eea.volto.policy-4.0}/eea/volto/policy/restapi/serializer/configure.zcml

@@ -4,5 +4,9 @@
     >
 
   <adapter factory=".dxfields.DateTimeFieldSerializer" />
+    <utility
+      factory=".summary.EEAJSONSummarySerializerMetadata"
+      name="plone.restapi.eea_summary_serializer_metadata"
+      />
 
 </configure>

eea.volto.policy-4.0/eea/volto/policy/restapi/serializer/summary.py

@@ -0,0 +1,30 @@
+"""Summary serializer metadata for EEA Volto Policy."""
+from plone.restapi.interfaces import IJSONSummarySerializerMetadata
+from plone.restapi.serializer.summary import JSONSummarySerializerMetadata
+from zope.interface import implementer
+
+
+@implementer(IJSONSummarySerializerMetadata)
+class EEAJSONSummarySerializerMetadata(JSONSummarySerializerMetadata):
+    """
+    Summary Metadata serializer inherited within EEA Volto Policy.
+
+    Implements IJSONSummarySerializerMetadata interface.
+    """
+
+    def default_metadata_fields(self):
+        """
+        Returns a set of default metadata fields to be included in the summary.
+        We add effective date to the list of default fields.
+        Returns:
+            set: A set of metadata field names.
+        """
+        return {
+            "@id",
+            "@type",
+            "description",
+            "review_state",
+            "title",
+            "type_title",
+            "effective",
+        }

{eea.volto.policy-3.4 → eea.volto.policy-4.0}/eea/volto/policy/setuphandlers.py

@@ -11,7 +11,7 @@ logger = logging.getLogger("eea.volto.policy")
 
 
 @implementer(INonInstallable)
-class HiddenProfiles(object):
+class HiddenProfiles:
     """ Hidden profiles
     """
 

{eea.volto.policy-3.4 → eea.volto.policy-4.0}/eea/volto/policy/tests/base.py

@@ -7,6 +7,7 @@ from plone.app.testing import PloneSandboxLayer
 from plone.app.testing import applyProfile
 from plone.app.testing import FunctionalTesting
 from plone.app.testing import setRoles
+import eea.volto.policy
 
 
 class EEAFixture(PloneSandboxLayer):
@@ -15,7 +16,6 @@ class EEAFixture(PloneSandboxLayer):
     def setUpZope(self, app, configurationContext):
         """ Setup Zope
         """
-        import eea.volto.policy
         self.loadZCML(package=eea.volto.policy)
         z2.installProduct(app, 'eea.volto.policy')
 

eea.volto.policy-4.0/eea/volto/policy/version.txt

@@ -0,0 +1 @@
+4.0

{eea.volto.policy-3.4 → eea.volto.policy-4.0/eea.volto.policy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: eea.volto.policy
-Version: 3.4
+Version: 4.0
 Summary: An add-on for Plone
 Home-page: https://github.com/eea/eea.volto.policy
 Author: European Environment Agency: IDM2 A-Team
@@ -128,6 +128,16 @@ EEA_ - European Environment Agency (EU)
 Changelog
 =========
 
+4.0 - (2024-05-20)
+---------------------------
+* Feature: Migrate teaserGrid to gridBlock structure from Volto 17 core
+  [avoinea - refs #265726]
+
+3.5 - (2024-05-14)
+---------------------------
+* Change: feat(serializer): added effective to the default_metadata_fields
+  [ichim-david]
+
 3.4 - (2024-03-28)
 ---------------------------
 * Change: Develop typo

{eea.volto.policy-3.4 → eea.volto.policy-4.0}/eea.volto.policy.egg-info/SOURCES.txt

@@ -25,6 +25,9 @@ eea/volto/policy/setuphandlers.py
 eea/volto/policy/version.txt
 eea/volto/policy/behaviors/__init__.py
 eea/volto/policy/behaviors/configure.zcml
+eea/volto/policy/browser/__init__.py
+eea/volto/policy/browser/configure.zcml
+eea/volto/policy/browser/teaser.py
 eea/volto/policy/contentrules/__init__.py
 eea/volto/policy/contentrules/actions.py
 eea/volto/policy/contentrules/configure.zcml
@@ -177,6 +180,7 @@ eea/volto/policy/restapi/navigation/navigation.py
 eea/volto/policy/restapi/serializer/__init__.py
 eea/volto/policy/restapi/serializer/configure.zcml
 eea/volto/policy/restapi/serializer/dxfields.py
+eea/volto/policy/restapi/serializer/summary.py
 eea/volto/policy/tests/__init__.py
 eea/volto/policy/tests/base.py
 eea/volto/policy/tests/test_doctests.py

{eea.volto.policy-3.4 → eea.volto.policy-4.0}/setup.py

@@ -6,17 +6,25 @@ from setuptools import setup, find_packages
 
 NAME = 'eea.volto.policy'
 PATH = NAME.split('.') + ['version.txt']
-VERSION = open(join(*PATH)).read().strip()
+VERSION = ""
+with open(join(*PATH), "r", encoding="utf-8") as version_file:
+    VERSION = version_file.read().strip()
+
+LONG_DESCRIPTION = ""
+with open("README.rst", "r", encoding="utf-8") as readme_file:
+    LONG_DESCRIPTION = readme_file.read()
+
+with open(os.path.join("docs", "HISTORY.txt"),
+          "r", encoding="utf-8") as hfile:
+    LONG_DESCRIPTION += "\n" + hfile.read()
+
 
 setup(
     name=NAME,
     version=VERSION,
     description="An add-on for Plone",
     long_description_content_type="text/x-rst",
-    long_description=(
-        open("README.rst").read() + "\n" +
-        open(os.path.join("docs", "HISTORY.txt")).read()
-    ),
+    long_description=LONG_DESCRIPTION,
     classifiers=[
         "Environment :: Web Environment",
         "Framework :: Plone",

eea.volto.policy-3.4/eea/volto/policy/version.txt

@@ -1 +0,0 @@
-3.4