imio.smartweb.common 1.2.15__tar.gz → 1.2.17__tar.gz

{imio_smartweb_common-1.2.15 → imio_smartweb_common-1.2.17}/CHANGES.rst

@@ -2,6 +2,21 @@ Changelog
 =========
 
 
+1.2.17 (2024-06-06)
+-------------------
+
+- WEB-4113 : Add `TranslatedAjaxSelectFieldWidget` to fix translations of initial
+  values in select2 fields
+  [laulaz]
+
+
+1.2.16 (2024-05-30)
+-------------------
+
+- WEB-4107 : Update resource registries modification time (used as ETag) at Zope startup
+  [laulaz]
+
+
 1.2.15 (2024-05-27)
 -------------------
 

{imio_smartweb_common-1.2.15 → imio_smartweb_common-1.2.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: imio.smartweb.common
-Version: 1.2.15
+Version: 1.2.17
 Summary: Common utilities, vocabularies, taxonomies for imio.smartweb & co products
 Home-page: https://github.com/imio/imio.smartweb.common
 Author: iMio
@@ -161,6 +161,21 @@ Changelog
 =========
 
 
+1.2.17 (2024-06-06)
+-------------------
+
+- WEB-4113 : Add `TranslatedAjaxSelectFieldWidget` to fix translations of initial
+  values in select2 fields
+  [laulaz]
+
+
+1.2.16 (2024-05-30)
+-------------------
+
+- WEB-4107 : Update resource registries modification time (used as ETag) at Zope startup
+  [laulaz]
+
+
 1.2.15 (2024-05-27)
 -------------------
 

{imio_smartweb_common-1.2.15 → imio_smartweb_common-1.2.17}/setup.py

@@ -16,7 +16,7 @@ long_description = "\n\n".join(
 
 setup(
     name="imio.smartweb.common",
-    version="1.2.15",
+    version="1.2.17",
     description="Common utilities, vocabularies, taxonomies for imio.smartweb & co products",
     long_description=long_description,
     # Get more from https://pypi.org/classifiers/

{imio_smartweb_common-1.2.15 → imio_smartweb_common-1.2.17}/src/imio/smartweb/common/behaviors/topics.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
+from imio.smartweb.common.widgets.select import TranslatedAjaxSelectFieldWidget
 from imio.smartweb.locales import SmartwebMessageFactory as _
-from plone.app.z3cform.widget import AjaxSelectFieldWidget
 from plone.autoform import directives
 from plone.autoform.interfaces import IFormFieldProvider
 from plone.supermodel import model
@@ -21,4 +21,4 @@ class ITopics(model.Schema):
         default=[],
         required=False,
     )
-    directives.widget(topics=AjaxSelectFieldWidget)
+    directives.widget(topics=TranslatedAjaxSelectFieldWidget)

{imio_smartweb_common-1.2.15 → imio_smartweb_common-1.2.17}/src/imio/smartweb/common/subscribers.py

@@ -8,10 +8,36 @@ from plone.app.dexterity.behaviors.metadata import IBasic
 from plone.app.textfield.value import IRichTextValue
 from plone.app.textfield.value import RichTextValue
 from plone.dexterity.utils import iterSchemata
+from plone.registry.interfaces import IRegistry
+from Products.CMFPlone.resources.browser.resource import update_resource_registry_mtime
+from zope.component import queryUtility
+from zope.component.hooks import setSite
 from zope.lifecycleevent.interfaces import IAttributes
 from zope.schema import getFields
 
 import DateTime
+import os
+import Zope2
+
+
+def started_zope(event):
+    db = Zope2.DB
+    connection = db.open()
+    zope_app = connection.root().get("Application", None)
+    site_id = os.getenv("SITE_ID", "Plone")
+    try:
+        site = zope_app.unrestrictedTraverse(site_id)
+    except KeyError:
+        # This happens when there is no site (ex: tests setups)
+        return
+    setSite(site)
+    registry = queryUtility(IRegistry)
+    if registry is None:
+        # This happens for example during site creation
+        return
+    # update resource registry time to invalidate its cache at startup
+    # this information is also used as ETag
+    update_resource_registry_mtime()
 
 
 def reindex_breadcrumb(obj, event):

{imio_smartweb_common-1.2.15 → imio_smartweb_common-1.2.17}/src/imio/smartweb/common/subscribers.zcml

@@ -1,6 +1,9 @@
 <configure
     xmlns="http://namespaces.zope.org/zope">
 
+  <subscriber for="zope.processlifetime.IProcessStarting"
+              handler=".subscribers.started_zope"/>
+
   <subscriber for="plone.dexterity.interfaces.IDexterityContent
                    zope.lifecycleevent.interfaces.IObjectAddedEvent"
               handler=".subscribers.added_content" />

imio_smartweb_common-1.2.17/src/imio/smartweb/common/tests/test_widgets.py

@@ -0,0 +1,61 @@
+# -*- coding: utf-8 -*-
+
+from imio.smartweb.common.testing import IMIO_SMARTWEB_COMMON_INTEGRATION_TESTING
+from imio.smartweb.common.widgets.select import TranslatedAjaxSelectWidget
+from plone.api import portal as portal_api
+from zope.publisher.browser import TestRequest
+
+import mock
+import unittest
+
+
+class TestVocabulary(unittest.TestCase):
+    layer = IMIO_SMARTWEB_COMMON_INTEGRATION_TESTING
+
+    def setUp(self):
+        """Custom shared utility setup for tests"""
+        self.request = TestRequest()
+
+    def test_translated_ajax_select(self):
+        portal_api.get_current_language = mock.Mock(return_value="fr")
+        widget = TranslatedAjaxSelectWidget(self.request)
+        widget.update()
+        self.assertEqual(
+            {
+                "name": None,
+                "value": "",
+                "pattern": "select2",
+                "pattern_options": {"separator": ";"},
+            },
+            widget._base_args(),
+        )
+
+        widget.vocabulary = "imio.smartweb.vocabulary.Topics"
+        self.assertEqual(
+            widget._base_args(),
+            {
+                "name": None,
+                "value": "",
+                "pattern": "select2",
+                "pattern_options": {
+                    "vocabularyUrl": "http://nohost/plone/@@getVocabulary?name=imio.smartweb.vocabulary.Topics",
+                    "separator": ";",
+                },
+            },
+        )
+        widget.value = "entertainment"
+        self.assertEqual(
+            widget._base_args(),
+            {
+                "name": None,
+                "value": "entertainment",
+                "pattern": "select2",
+                "pattern_options": {
+                    "vocabularyUrl": "http://nohost/plone/@@getVocabulary?name=imio.smartweb.vocabulary.Topics",
+                    "initialValues": {
+                        "entertainment": "Activités et divertissement",
+                    },
+                    "separator": ";",
+                },
+            },
+        )

imio_smartweb_common-1.2.17/src/imio/smartweb/common/widgets/select.py

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+
+from plone import api
+from plone.app.z3cform.widget import AjaxSelectWidget
+from z3c.form.interfaces import IFieldWidget
+from z3c.form.widget import FieldWidget
+from zope.interface import implementer
+from zope.i18n import translate
+
+
+class TranslatedAjaxSelectWidget(AjaxSelectWidget):
+    """Translated Ajax select widget for z3c.form."""
+
+    def _ajaxselect_options(self):
+        options = super(TranslatedAjaxSelectWidget, self)._ajaxselect_options()
+        current_lang = api.portal.get_current_language()[:2]
+        translated_initial_values = {}
+        for token, value in list(options.get("initialValues", {}).items()):
+            translated_initial_values[token] = translate(
+                value, domain="imio.smartweb", target_language=current_lang
+            )
+        if translated_initial_values:
+            options["initialValues"] = translated_initial_values
+        return options
+
+
+@implementer(IFieldWidget)
+def TranslatedAjaxSelectFieldWidget(field, request, extra=None):
+    if extra is not None:
+        request = extra
+    return FieldWidget(field, TranslatedAjaxSelectWidget(request))

{imio_smartweb_common-1.2.15 → imio_smartweb_common-1.2.17}/src/imio.smartweb.common.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: imio.smartweb.common
-Version: 1.2.15
+Version: 1.2.17
 Summary: Common utilities, vocabularies, taxonomies for imio.smartweb & co products
 Home-page: https://github.com/imio/imio.smartweb.common
 Author: iMio
@@ -161,6 +161,21 @@ Changelog
 =========
 
 
+1.2.17 (2024-06-06)
+-------------------
+
+- WEB-4113 : Add `TranslatedAjaxSelectFieldWidget` to fix translations of initial
+  values in select2 fields
+  [laulaz]
+
+
+1.2.16 (2024-05-30)
+-------------------
+
+- WEB-4107 : Update resource registries modification time (used as ETag) at Zope startup
+  [laulaz]
+
+
 1.2.15 (2024-05-27)
 -------------------
 

{imio_smartweb_common-1.2.15 → imio_smartweb_common-1.2.17}/src/imio.smartweb.common.egg-info/SOURCES.txt

@@ -117,6 +117,7 @@ src/imio/smartweb/common/tests/test_utils.py
 src/imio/smartweb/common/tests/test_viewlets.py
 src/imio/smartweb/common/tests/test_vocabularies.py
 src/imio/smartweb/common/tests/test_vocabulary.py
+src/imio/smartweb/common/tests/test_widgets.py
 src/imio/smartweb/common/tests/resources/image.png
 src/imio/smartweb/common/tests/resources/image_1400x800.png
 src/imio/smartweb/common/tests/resources/image_1800x700.png
@@ -151,4 +152,6 @@ src/imio/smartweb/common/viewlets/configure.zcml
 src/imio/smartweb/common/viewlets/privacy.pt
 src/imio/smartweb/common/viewlets/privacy.py
 src/imio/smartweb/common/viewlets/skip_to_content.pt
-src/imio/smartweb/common/viewlets/skip_to_content.py
+src/imio/smartweb/common/viewlets/skip_to_content.py
+src/imio/smartweb/common/widgets/__init__.py
+src/imio/smartweb/common/widgets/select.py