Add migration for button block width (#32)

* Add migration for button block width

* Fix the transaction commit problem

* Fix vscode

.gitignore

@@ -17,7 +17,6 @@ dist/
 docs/_build
 __pycache__/
 .tox
-.vscode/
 node_modules/
 
 # venv / buildout related

pyproject.toml

@@ -48,7 +48,11 @@ showcontent = true
 ##
 
 [tool.isort]
-profile = "plone"
+profile = "black"
+force_alphabetical_sort = true
+force_single_line = true
+lines_after_imports = 2
+line_length = 88
 
 ##
 # Add extra configuration options in .meta.toml:
@@ -59,7 +63,25 @@ profile = "plone"
 ##
 
 [tool.black]
-target-version = ["py38"]
+line-length = 88
+target-version = ['py311']
+include = '\.pyi?$'
+exclude = '''
+(
+  /(
+      \.eggs         # exclude a few common directories in the
+    | \.git          # root of the project
+    | \.hg
+    | \.mypy_cache
+    | \.tox
+    | \.venv
+    | _build
+    | buck-out
+    | build
+    | dist
+  )/
+)
+'''
 
 ##
 # Add extra configuration options in .meta.toml:

scripts/migrate.py

@@ -0,0 +1,105 @@
+from plone import api
+from plone.restapi.blocks import visit_blocks
+from zope.component.hooks import setSite
+from zope.lifecycleevent import modified
+
+import logging
+import transaction
+
+
+logger = logging.getLogger("migrate_to_4")
+logger.setLevel(logging.INFO)
+
+# If you updated or extended the colors mappings, you should update this with the new values
+COLOR_MAP = {
+    "grey": {
+        "--background-color": "#ecebeb",
+    },
+    "transparent": {
+        "--background-color": "transparent",
+    },
+}
+
+WIDTH_MAP = {
+    "narrow": {
+        "--block-width": "var(--narrow-container-width)",
+    },
+    "wide": {
+        "--block-width": "var(--default-container-width)",
+    },
+}
+
+
+def migrate_backgroundColor(portal):
+    i = 0
+    output = ""
+    for brain in portal.portal_catalog(
+        object_provides="plone.restapi.behaviors.IBlocks"
+    ):
+        obj = brain.getObject()
+        blocks = obj.blocks
+        logger.info(f"Processing {obj.absolute_url()}")
+        for block in visit_blocks(obj, blocks):
+            if block.get("styles", False) and block["styles"].get(
+                "backgroundColor", False
+            ):
+                new_block = block.copy()
+                color = block["styles"]["backgroundColor"]
+                new_block["styles"]["backgroundColor:noprefix"] = COLOR_MAP[color]
+                del new_block["styles"]["backgroundColor"]
+                block.clear()
+                block.update(new_block)
+                logger.info(
+                    f'{obj.absolute_url()} - Updated "backgroundColor" to "backgroundColor:noprefix"'
+                )
+
+        obj.blocks = blocks
+        modified(obj)
+        i += 1
+        if not i % 100:
+            logger.info(i)
+            transaction.commit()
+    transaction.commit()
+    return output
+
+
+def migrate_button_block_width(portal):
+    i = 0
+    output = ""
+    for brain in portal.portal_catalog(
+        object_provides="plone.restapi.behaviors.IBlocks"
+    ):
+        obj = brain.getObject()
+        blocks = obj.blocks
+        logger.info(f"Processing {obj.absolute_url()}")
+        for block in visit_blocks(obj, blocks):
+            if (
+                block.get("@type", False)
+                and block["@type"] == "__button"
+                and block.get("styles", False)
+                and block["styles"].get("buttonAlign", False)
+                and block["styles"]["buttonAlign"] in ["narrow", "wide"]
+            ):
+                new_block = block.copy()
+                new_block["styles"]["blockWidth:noprefix"] = WIDTH_MAP.get(
+                    new_block["styles"]["buttonAlign"], ""
+                )
+                del new_block["styles"]["buttonAlign"]
+                block.clear()
+                block.update(new_block)
+                logger.info(f'{obj.absolute_url()} - Updated "width"')
+
+        obj.blocks = blocks
+        modified(obj)
+        i += 1
+        if not i % 100:
+            logger.info(i)
+            transaction.commit()
+    transaction.commit()
+    return output
+
+
+setSite(app.Plone)  # noQA
+with api.env.adopt_user("admin"):
+    migrate_button_block_width(app.Plone)  # noQA
+    migrate_backgroundColor(app.Plone)  # noQA

src/kitconcept/voltolighttheme/browser/__init__.py

@@ -2,6 +2,7 @@
 from plone.restapi.blocks import visit_blocks
 from Products.Five.browser import BrowserView
 from zope.interface import alsoProvides
+from zope.lifecycleevent import modified
 
 import logging
 import transaction
@@ -20,6 +21,15 @@
     },
 }
 
+WIDTH_MAP = {
+    "narrow": {
+        "--block-width": "var(--narrow-container-width)",
+    },
+    "wide": {
+        "--block-width": "var(--default-container-width)",
+    },
+}
+
 
 def migrate_backgroundColor(portal):
     i = 0
@@ -29,7 +39,7 @@ def migrate_backgroundColor(portal):
     ):
         obj = brain.getObject()
         blocks = obj.blocks
-        output += f"Processing {obj.absolute_url()}\n"
+        logger.info(f"Processing {obj.absolute_url()}")
         for block in visit_blocks(obj, blocks):
             if block.get("styles", False) and block["styles"].get(
                 "backgroundColor", False
@@ -40,8 +50,48 @@ def migrate_backgroundColor(portal):
                 del new_block["styles"]["backgroundColor"]
                 block.clear()
                 block.update(new_block)
-                output += f'{obj.absolute_url()} - Updated "backgroundColor" to "backgroundColor:noprefix"\n'
+                logger.info(
+                    f'{obj.absolute_url()} - Updated "backgroundColor" to "backgroundColor:noprefix"'
+                )
+
+        obj.blocks = blocks
+        modified(obj)
+        i += 1
+        if not i % 100:
+            logger.info(i)
+            transaction.commit()
+    transaction.commit()
+    return output
+
+
+def migrate_button_block_width(portal):
+    i = 0
+    output = ""
+    for brain in portal.portal_catalog(
+        object_provides="plone.restapi.behaviors.IBlocks"
+    ):
+        obj = brain.getObject()
+        blocks = obj.blocks
+        logger.info(f"Processing {obj.absolute_url()}")
+        for block in visit_blocks(obj, blocks):
+            if (
+                block.get("@type", False)
+                and block["@type"] == "__button"
+                and block.get("styles", False)
+                and block["styles"].get("buttonAlign", False)
+                and block["styles"]["buttonAlign"] in ["narrow", "wide"]
+            ):
+                new_block = block.copy()
+                new_block["styles"]["blockWidth:noprefix"] = WIDTH_MAP.get(
+                    new_block["styles"]["buttonAlign"], ""
+                )
+                del new_block["styles"]["buttonAlign"]
+                block.clear()
+                block.update(new_block)
+                logger.info(f'{obj.absolute_url()} - Updated "width"')
 
+        obj.blocks = blocks
+        modified(obj)
         i += 1
         if not i % 100:
             logger.info(i)
@@ -53,4 +103,7 @@ def migrate_backgroundColor(portal):
 class MigrateToV3(BrowserView):
     def __call__(self):
         alsoProvides(self.request, IDisableCSRFProtection)
-        return migrate_backgroundColor(self.context)
+        output = ""
+        output += migrate_backgroundColor(self.context) + "\n"
+        output += migrate_button_block_width(self.context) + "\n"
+        return output