Merge tag '1.2.3' of https://github.com/IMIO/imio.helpers into plone61

Tagging 1.2.3

Author: chris-adam

CHANGES.rst

@@ -1,9 +1,102 @@
 Changelog
 =========
 
-1.0.0 (unreleased)
+1.2.3 (2025-03-11)
 ------------------
 
+- Improved `email.validate_email_address` to replace '""' in email.
+  [sgeulette]
+- Added Plone 6.1 version in buildout.
+  [chris-adam]
+
+1.2.2 (2025-02-06)
+------------------
+
+- Added parameters `ask_confirm=false, confirm_msg='are_you_sure'` to
+  JS function `callViewAndReload` so it is possible to have a
+  confirmation dialog to execute the action or not.
+  [gbastien]
+
+1.2.1 (2025-01-20)
+------------------
+
+- Improved `emailer.send_email` to take into account 3.10.12 python bug.
+  [sgeulette]
+- Removed ipython
+  [sgeulette]
+
+1.2.0 (2024-12-19)
+------------------
+
+- Added new parameter to `batching.batch_get_keys`.
+  [sgeulette]
+
+1.1.0 (2024-10-02)
+------------------
+
+- Imported batch_delete_files from imio.pyutils if someone is yet using it from here.
+  [sgeulette]
+- batch is considered finished if no batching.
+  [sgeulette]
+
+1.0.1 (2024-09-18)
+------------------
+
+- Generated universal wheel version.
+  [sgeulette]
+
+1.0.0 (2024-09-16)
+------------------
+
+- Improved `emailer.send_email` to use send in place of securesend (not using queue).
+  [sgeulette]
+- Added `EMPTY_DATETIME` value that corresponds to `01/01/1950 at 12:00`.
+  [gbastien]
+- Improved batching module
+  [sgeulette]
+- Added `batching.can_delete_batch_files`
+  [sgeulette]
+
+1.0.0rc4 (2024-07-08)
+---------------------
+
+- Added "empty" variables to handle empty indexes searches.
+  [sgeulette]
+
+1.0.0rc3 (2024-06-07)
+---------------------
+
+- Added `temp_disable_link` JS helper that will disable a link for 2 seconds
+  and to avoid double clicks.
+  [gbastien]
+
+1.0.0rc2 (2024-04-10)
+---------------------
+
+- Added batching module.
+  [sgeulette]
+- Fixed the way JS function `submitFormHelperOnsuccessDefault` manages
+  returned result when it is a file, now we have a correct `filename`.
+  [gbastien]
+- Added transmogrifier Expression and Condition classes to log expression
+  compilation or interpretation errors.
+  [sgeulette]
+- Removed `content.safe_encode` as already defined in `imio.pyutils`.
+  Import it from `imio.pyutils` in `imio.helpers.content` for temporary backward
+  compatibility, to be removed.
+  [gbastien]
+- Overrided `@@folder_contents` to make it work with `DashboardCollection`.
+  [gbastien]
+- Monkeypatched `plone.app.querystring.registryreader.getVocabularyValues`
+  to keep vocabulary order onloy for Plone4, behavior is correct in Plone5+.
+  Manage every `HAS_PLONE_X` values.
+  [gbastien]
+
+1.0.0rc1 (2024-02-08)
+---------------------
+
+- Made compliant with Plone 4, Plone 5, Plone 6
+  [boulch, laulaz, sgeulette]
 - Require `pathlib2` in `setup.py`, backport `pathlib` for `py2.7`.
   [gbastien]
 - Added `security.setup_app` to be used in run scripts.
@@ -12,11 +105,11 @@ Changelog
   [sgeulette]
 - Added `setup.test_remove_gs_step` to remove a generic setup step.
   [sgeulette]
+- Added `imio.helpers.YesNoForFacetedVocabulary`
+  [sgeulette]
 - Fixed `content.base_getattr` that was not returning the `default` if attribute
   not existing.
   [gbastien]
-- Added Plone 6.1 version in buildout.
-  [chris-adam]
 
 0.80 (2023-12-11)
 -----------------

base.cfg

@@ -27,7 +27,6 @@ eggs +=
     Pillow
 #    Products.PDBDebugMode
 #    collective.profiler
-#    ipdb
     pdbpp
 #    plone.reload
 
@@ -54,6 +53,7 @@ always-checkout = force
 auto-checkout +=
     appy
     collective.behavior.talcondition
+    imio.pyutils
 
 [testenv]
 decorate_acl_methods = true
@@ -65,9 +65,7 @@ eggs = ${test:eggs}
 [instance]
 eggs +=
     ${buildout:eggs}
-    iw.debug
 zcml +=
-    iw.debug
 
 [ploneversioncheck]
 recipe = zc.recipe.egg

checkouts.cfg

@@ -10,7 +10,7 @@
 
 setup(
     name='imio.helpers',
-    version='1.0.0.dev0',
+    version='1.2.3',
     description="Various helper methods for development.",
     long_description=long_description,
     # Get more from http://pypi.python.org/pypi?%3Aaction=list_classifiers
@@ -46,7 +46,7 @@
         'collective.fingerpointing',
         'collective.monkeypatcher',
         'future>=0.18.2',
-        'imio.pyutils>=1.0.0a0',
+        'imio.pyutils>=1.1.1',
         'natsort',
         "pathlib2;python_version<'3'",
         'plone.api>1.9.1',
@@ -62,7 +62,6 @@
         'test': [
             'collective.behavior.talcondition',
             'collective.MockMailHost',
-            'ipdb',
             'plone.app.dexterity',
             'plone.app.testing',
         ],
@@ -78,4 +77,5 @@
     [z3c.autoinclude.plugin]
     target = plone
     """,
+    options={"bdist_wheel": {"universal": True}},
 )

setup.py

@@ -19,3 +19,4 @@ cedricmessiant_push = [email protected]:cedricmessiant
 [sources]
 appy = git ${remotes:imio}/appy.git pushurl=${remotes:imio_push}/appy.git
 collective.behavior.talcondition = git ${remotes:collective}/collective.behavior.talcondition.git pushurl=${remotes:collective_push}/collective.behavior.talcondition.git
+imio.pyutils = git ${remotes:imio}/imio.pyutils.git pushurl=${remotes:imio_push}/imio.pyutils.git

sources.cfg

@@ -1,5 +1,7 @@
 # -*- coding: utf-8 -*-
 
+from datetime import date
+from datetime import datetime
 from imio.helpers.cache import get_cachekey_volatile
 from plone import api
 from plone.memoize import ram as pmram
@@ -13,36 +15,49 @@
 import os
 
 
-_ = MessageFactory('imio.helpers')
-logger = logging.getLogger('imio.helpers')
+_ = MessageFactory("imio.helpers")
+logger = logging.getLogger("imio.helpers")
 
+HAS_PLONE_4 = api.env.plone_version().startswith("4")
+HAS_PLONE_5 = api.env.plone_version().startswith("5")
+HAS_PLONE_5_1 = api.env.plone_version() > "5.1"
+HAS_PLONE_5_2 = api.env.plone_version() > "5.2"
 HAS_PLONE_5_AND_MORE = int(api.env.plone_version()[0]) >= 5
 PLONE_MAJOR_VERSION = int(api.env.plone_version()[0])
 
+EMPTY_TITLE = "No value"
+EMPTY_STRING = "__empty_string__"
+EMPTY_DATE = date(1950, 1, 1)
+EMPTY_DATETIME = datetime(1950, 1, 1, 12, 0)
+
 
 def GroupsTool__getGroupsForPrincipal_cachekey(method, self, principal):
     req = getRequest()
     if req is None:
         raise pmram.DontCache
-    date = get_cachekey_volatile('_users_groups_value')
+    date = get_cachekey_volatile("_users_groups_value")
     return date, principal and principal.getId()
 
 
 def GroupAwareRoleManager__getRolesForPrincipal_cachekey(method, self, principal, request=None):
     req = request or getRequest()
     # if req is None:
     #     raise pmram.DontCache
-    date = get_cachekey_volatile('_users_groups_value')
-    return (date, principal and principal.getId(), repr(req), req and (req.get('__ignore_direct_roles__', False),
-            req.get('__ignore_group_roles__', False)) or (None, None))
+    date = get_cachekey_volatile("_users_groups_value")
+    return (
+        date,
+        principal and principal.getId(),
+        repr(req),
+        req and (req.get("__ignore_direct_roles__", False), req.get("__ignore_group_roles__", False)) or (None, None),
+    )
 
 
 def PluggableAuthService__getGroupsForPrincipal_cachekey(method, self, principal, request=None, **kwargs):
     req = request or getRequest()
     if req is None:
         raise pmram.DontCache
     try:
-        date = get_cachekey_volatile('_users_groups_value')
+        date = get_cachekey_volatile("_users_groups_value")
     except api.portal.CannotGetPortalError:
         raise pmram.DontCache
     return date, principal and principal.getId()
@@ -53,18 +68,18 @@ def PluggableAuthService__findUser_cachekey(method, self, plugins, user_id, name
     if req is None:
         raise pmram.DontCache
     try:
-        date = get_cachekey_volatile('_users_groups_value')
+        date = get_cachekey_volatile("_users_groups_value")
     except api.portal.CannotGetPortalError:
         raise pmram.DontCache
-    return date, repr(plugins), user_id, name, str(req and req._debug or '')
+    return date, repr(plugins), user_id, name, str(req and req._debug or "")
 
 
 def PluggableAuthService__verifyUser_cachekey(method, self, plugins, user_id=None, login=None):
     req = getRequest()
     if req is None:
         raise pmram.DontCache
 
-    date = get_cachekey_volatile('_users_groups_value')
+    date = get_cachekey_volatile("_users_groups_value")
     return date, repr(plugins), user_id, login
 
 
@@ -73,12 +88,12 @@ def GroupsTool_getGroupById_cachekey(method, self, group_id):
     if req is None:
         raise pmram.DontCache
 
-    date = get_cachekey_volatile('_users_groups_value')
+    date = get_cachekey_volatile("_users_groups_value")
     return date, group_id
 
 
-if os.getenv('decorate_acl_methods', 'Nope') in ('True', 'true'):
-    logger.info('DECORATING various acl related methods with cache')
+if os.getenv("decorate_acl_methods", "Nope") in ("True", "true"):
+    logger.info("DECORATING various acl related methods with cache")
     decorator = pmram.cache(GroupsTool__getGroupsForPrincipal_cachekey)
     GroupsTool.getGroupsForPrincipal = decorator(GroupsTool.getGroupsForPrincipal)
     decorator = pmram.cache(GroupAwareRoleManager__getRolesForPrincipal_cachekey)