Products.urban 2.7.8__tar.gz → 2.7.9__tar.gz

{Products.urban-2.7.8 → Products.urban-2.7.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Products.urban
-Version: 2.7.8
+Version: 2.7.9
 Summary: Urban Certificate Management
 Home-page: http://www.communesplone.org/les-outils/applications-metier/gestion-des-permis-durbanisme
 Author: Simon Delcourt
@@ -52,6 +52,25 @@ Changelog
 
 .. towncrier release notes start
 
+2.7.9 (2024-04-07)
+------------------
+
+Bug fixes:
+
+
+- Avoid an error if a vocabulary term was removed
+  [mpeeters] (SUP-36403,SUP-36406)
+- Fix logic on some methods to exclude invalid vocabulary entries
+  [mpeeters] (URB-3002)
+
+
+Internal:
+
+
+- Add tests for new vocabulary logic (start and end validity)
+  [mpeeters] (URB-3002)
+
+
 2.7.8 (2024-04-02)
 ------------------
 

{Products.urban-2.7.8 → Products.urban-2.7.9}/docs/CHANGES.rst

@@ -8,6 +8,25 @@ Changelog
 
 .. towncrier release notes start
 
+2.7.9 (2024-04-07)
+------------------
+
+Bug fixes:
+
+
+- Avoid an error if a vocabulary term was removed
+  [mpeeters] (SUP-36403,SUP-36406)
+- Fix logic on some methods to exclude invalid vocabulary entries
+  [mpeeters] (URB-3002)
+
+
+Internal:
+
+
+- Add tests for new vocabulary logic (start and end validity)
+  [mpeeters] (URB-3002)
+
+
 2.7.8 (2024-04-02)
 ------------------
 

{Products.urban-2.7.8 → Products.urban-2.7.9}/setup.py

@@ -1,7 +1,7 @@
 from setuptools import setup, find_packages
 import os
 
-version = "2.7.8"
+version = "2.7.9"
 
 setup(
     name="Products.urban",

{Products.urban-2.7.8 → Products.urban-2.7.9}/src/Products/urban/UrbanVocabularyTerm.py

@@ -161,7 +161,7 @@ class UrbanVocabulary(object):
         value_to_use="title",
         sort_on="getObjPositionInParent",
         inUrbanConfig=True,
-        allowedStates=["enabled"],
+        allowedStates=["enabled", "disabled"],
         with_empty_value=False,
         datagridfield_key="street",
         _filter=None,
@@ -178,8 +178,12 @@ class UrbanVocabulary(object):
         self._filter = _filter
 
     def _validate_term(self, term, deposit_date):
-        if "startValidity" not in term or "endValidity" not in term:
-            return True
+        if isinstance(term, dict):
+            if "startValidity" not in term or "endValidity" not in term:
+                return True
+        else:
+            if not hasattr(term, "startValidity") or not hasattr(term, "endValidity"):
+                return True
         if term["startValidity"] is None and term["endValidity"] is None:
             return True
         if term["startValidity"] and term["endValidity"]:
@@ -192,6 +196,17 @@ class UrbanVocabulary(object):
         if term["endValidity"]:
             return deposit_date <= term["endValidity"]
 
+    def _get_deposit_date(self, context):
+        deposit_date = None
+        if hasattr(context, "get_first_deposit_date"):
+            deposit_date = context.get_first_deposit_date()
+        if hasattr(context, "get_first_deposit_date") and not deposit_date:
+            deposit_date = context.creation_date
+        if not deposit_date:
+            # by default we use the current date
+            deposit_date = DateTime(*datetime.now().date().timetuple()[0:3])
+        return deposit_date
+
     def get_raw_voc(self, context, licence_type="", _filter=None):
         portal_urban = api.portal.get_tool("portal_urban")
         raw_voc = portal_urban.get_vocabulary(
@@ -201,12 +216,7 @@ class UrbanVocabulary(object):
             name=self.path,
         )
 
-        deposit_date = None
-        if hasattr(context, "get_first_deposit_date"):
-            deposit_date = context.get_first_deposit_date()
-        if not deposit_date:
-            # by default we use the current date
-            deposit_date = DateTime(*datetime.now().date().timetuple()[0:3])
+        deposit_date = self._get_deposit_date(context)
         voc = [
             v
             for v in raw_voc
@@ -243,22 +253,21 @@ class UrbanVocabulary(object):
         return DisplayList(result)
 
     def getDisplayListForTemplate(self, content_instance):
+        """Return a DisplayList object with vocabulary terms"""
         portal_urban = api.portal.get_tool("portal_urban")
-        result = DisplayList(
-            portal_urban.listVocabulary(
-                self.path,
-                content_instance,
-                vocType=self.vocType,
-                id_to_use=self.id_to_use,
-                value_to_use=self.value_to_use,
-                sort_on=self.sort_on,
-                inUrbanConfig=self.inUrbanConfig,
-                allowedStates=self.allowedStates,
-                with_empty_value=self.with_empty_value,
-                with_numbering=False,
-            )
+        voc_terms = portal_urban.listVocabulary(
+            self.path,
+            content_instance,
+            vocType=self.vocType,
+            id_to_use=self.id_to_use,
+            value_to_use=self.value_to_use,
+            sort_on=self.sort_on,
+            inUrbanConfig=self.inUrbanConfig,
+            allowedStates=self.allowedStates,
+            with_empty_value=self.with_empty_value,
+            with_numbering=False,
         )
-        return result
+        return DisplayList(voc_terms)
 
     def getObjectsSet(self, content_instance, values):
         if isinstance(values, str):
@@ -274,6 +283,7 @@ class UrbanVocabulary(object):
         return result
 
     def getAllVocTerms(self, content_instance):
+        """Return a dict with vocabulary terms"""
         portal_urban = api.portal.get_tool("portal_urban")
         voc_terms = portal_urban.listVocabularyObjects(
             self.path,
@@ -285,9 +295,15 @@ class UrbanVocabulary(object):
             allowedStates=self.allowedStates,
             with_empty_value=self.with_empty_value,
         )
-        return voc_terms
+        deposit_date = self._get_deposit_date(content_instance)
+        filtered_terms = {
+            k: v for k, v in voc_terms.items()
+            if self._validate_term(v, deposit_date)
+        }
+        return filtered_terms
 
     def listAllVocTerms(self, content_instance):
+        """Return a list of vocabulary terms"""
         portal_urban = api.portal.get_tool("portal_urban")
         voc_brains = portal_urban.listVocabularyBrains(
             self.path,
@@ -298,7 +314,12 @@ class UrbanVocabulary(object):
             allowedStates=self.allowedStates,
         )
         voc_terms = [brain.getObject() for brain in voc_brains]
-        return voc_terms
+        deposit_date = self._get_deposit_date(content_instance)
+        filtered_terms = [
+            v for v in voc_terms
+            if self._validate_term(v, deposit_date)
+        ]
+        return filtered_terms
 
 
 ##/code-section module-footer

{Products.urban-2.7.8 → Products.urban-2.7.9}/src/Products/urban/profiles/testsWithConfig/config_default_values.py

@@ -284,6 +284,15 @@ default_values = {
             "UrbanVocabularyTerm",
             ["UrbanCertificateOne", "UrbanCertificateTwo", "NotaryLetter"],
             {"id": "type-1", "title": u"Type 1: zone à forte pression foncière"},
+            {
+                "id": "type-2",
+                "title": u"Type 2: zone de requalification des noyaux d'habitat",
+            },
+            {
+                "id": "type-3",
+                "title": u"Type 3: zons de développement global de quartier",
+            },
+            {"id": "type-4", "title": u"Type 4: zones de cités sociales à requalifier"},
         ],
         "investigationarticles": [
             "UrbanVocabularyTerm",

{Products.urban-2.7.8 → Products.urban-2.7.9}/src/Products/urban/profiles/testsWithConfig/data.py

@@ -11,7 +11,7 @@ dashboardTemplates = DASHBOARD_TEMPLATES
 
 default_texts = {
     "claimsTextDefaultValue": """
-    <p>Je réclame le port obligatoire de la mini jupe à l'unif</p>
+    <p>Je réclame le port obligatoire de lunette de soleil à l'intérieur</p>
     """
 }
 
@@ -325,6 +325,18 @@ EventConfigs = {
             ],
         },
     ),
+    "urbancertificateone": (
+        {
+            "id": "depot-de-la-demande",
+            "title": "Dépôt de la demande",
+            "activatedFields": ("receivedDocumentReference",),
+            "deadLineDelay": 15,
+            "isKeyEvent": True,
+            "keyDates": ("eventDate",),
+            "podTemplates": (),
+            "eventType": ("Products.urban.interfaces.IDepositEvent",),
+        },
+    ),
     "urbancertificatetwo": (
         {
             "id": "config-opinion-request",

{Products.urban-2.7.8 → Products.urban-2.7.9}/src/Products/urban/tests/test_UrbanVocabularyTerm.py

@@ -1,24 +1,50 @@
 # -*- coding: utf-8 -*-
-import unittest2 as unittest
-from zope.i18n import translate
-from plone.app.testing import login
+from DateTime import DateTime
+from Products.urban.UrbanVocabularyTerm import UrbanVocabulary
 from Products.urban.testing import URBAN_TESTS_CONFIG_FUNCTIONAL
+from datetime import datetime
+from plone import api
+from plone.app.testing import login
+from zope.event import notify
+from zope.i18n import translate
+from zope.lifecycleevent import ObjectModifiedEvent
+
+import unittest2 as unittest
 
 
 class TestUrbanVocabularyTerm(unittest.TestCase):
 
     layer = URBAN_TESTS_CONFIG_FUNCTIONAL
 
+    # self.portal_urban.urbancertificateone.basement.values()[0].__dict__
+
     def setUp(self):
         portal = self.layer["portal"]
         self.portal_urban = portal.portal_urban
         urban = portal.urban
         self.urbancertificateones = urban.urbancertificateones
-        LICENCE_ID = "licence1"
         default_user = self.layer.default_user
         login(portal, default_user)
-        self.urbancertificateones.invokeFactory("UrbanCertificateOne", LICENCE_ID)
-        self.certificate = getattr(self.urbancertificateones, LICENCE_ID)
+        event_config = self.portal_urban.urbancertificateone.eventconfigs["depot-de-la-demande"]
+
+        self.certificate = api.content.create(
+            type="UrbanCertificateOne",
+            container=self.urbancertificateones,
+            id="licence1",
+        )
+        self.certificate.creation_date = DateTime(2024, 3, 30)
+        event = self.certificate.createUrbanEvent(event_config)
+        event.setEventDate(datetime(2024, 3, 31))
+
+        self.certificate_2 = api.content.create(
+            type="UrbanCertificateOne",
+            container=self.urbancertificateones,
+            id="licence2",
+        )
+        self.certificate_2.creation_date = DateTime(2024, 4, 1)
+        event = self.certificate_2.createUrbanEvent(event_config)
+        event.setEventDate(datetime(2024, 4, 1))
+
         # set language to 'fr' as we do some translations above
         ltool = portal.portal_languages
         defaultLanguage = "fr"
@@ -29,6 +55,20 @@ class TestUrbanVocabularyTerm(unittest.TestCase):
         # this needs to be done in tests for the language to be taken into account...
         ltool.setLanguageBindings()
 
+        # Set validity dates
+        self._zip_3 = self.portal_urban.urbancertificateone.zip.values()[2]
+        self._zip_3.setEndValidity(DateTime(2024, 3, 31))
+        self._zip_4 = self.portal_urban.urbancertificateone.zip.values()[3]
+        self._zip_4.setStartValidity(DateTime(2024, 4, 1))
+        notify(ObjectModifiedEvent(self._zip_4))
+
+    def tearDown(self):
+        api.content.delete(self.certificate)
+        api.content.delete(self.certificate_2)
+        self._zip_3.setEndValidity(None)
+        self._zip_4.setEndValidity(None)
+        notify(ObjectModifiedEvent(self._zip_4))
+
     def testGetRenderedDescription(self):
         """
         Test that rendered description works
@@ -75,3 +115,59 @@ class TestUrbanVocabularyTerm(unittest.TestCase):
         self.assertEqual(
             uvt.getRenderedDescription(self.certificate, renderToNull=True), expected
         )
+
+    def test_get_raw_voc_creation(self):
+        """Ensure that values are correctly returned based on creation date"""
+        vocabulary = UrbanVocabulary("zip")
+        terms = vocabulary.get_raw_voc(
+            self.urbancertificateones,
+            licence_type="UrbanCertificateOne",
+        )
+        self.assertEqual(3, len(terms))
+        self.assertEqual(["type-1", "type-2", "type-4"], [t["id"] for t in terms])
+
+    def test_get_raw_voc_deposit(self):
+        """Ensure that values are correctly returned based on deposit date"""
+        vocabulary = UrbanVocabulary("zip")
+
+        terms = vocabulary.get_raw_voc(self.certificate)
+        self.assertEqual(3, len(terms))
+        self.assertEqual(["type-1", "type-2", "type-3"], [t["id"] for t in terms])
+
+        terms = vocabulary.get_raw_voc(self.certificate_2)
+        self.assertEqual(3, len(terms))
+        self.assertEqual(["type-1", "type-2", "type-4"], [t["id"] for t in terms])
+
+    def test_getDisplayListForTemplate_deposit(self):
+        """Ensure that values are correctly returned based on deposit date"""
+        # XXX Not working ATM but maybe this function need to be removed
+        vocabulary = UrbanVocabulary("zip")
+        display_list = vocabulary.getDisplayListForTemplate(self.certificate)
+        self.assertEqual(3, len(display_list))
+        self.assertEqual(["type-1", "type-2", "type-3"], display_list.keys())
+
+        display_list = vocabulary.getDisplayListForTemplate(self.certificate_2)
+        self.assertEqual(3, len(display_list))
+        self.assertEqual(["type-1", "type-2", "type-4"], display_list.keys())
+
+    def test_getAllVocTerms_deposit(self):
+        """Ensure that values are correctly returned based on deposit date"""
+        vocabulary = UrbanVocabulary("zip")
+        terms = vocabulary.getAllVocTerms(self.certificate)
+        self.assertEqual(3, len(terms))
+        self.assertEqual(["type-1", "type-2", "type-3"], sorted(terms.keys()))
+
+        terms = vocabulary.getAllVocTerms(self.certificate_2)
+        self.assertEqual(3, len(terms))
+        self.assertEqual(["type-1", "type-2", "type-4"], sorted(terms.keys()))
+
+    def test_listAllVocTerms_deposit(self):
+        """Ensure that values are correctly returned based on deposit date"""
+        vocabulary = UrbanVocabulary("zip")
+        terms = vocabulary.listAllVocTerms(self.certificate)
+        self.assertEqual(3, len(terms))
+        self.assertEqual(["type-1", "type-2", "type-3"], [t.id for t in terms])
+
+        terms = vocabulary.listAllVocTerms(self.certificate_2)
+        self.assertEqual(3, len(terms))
+        self.assertEqual(["type-1", "type-2", "type-4"], [t.id for t in terms])

{Products.urban-2.7.8 → Products.urban-2.7.9}/src/Products/urban/widget/select2widget.py

@@ -18,11 +18,18 @@ logger = logging.getLogger("urban debug")
 
 def resolve_vocabulary(context, field, values):
     if type(field.vocabulary) == UrbanVocabulary:
-        result = [
-            field.vocabulary.getAllVocTerms(context)[value].title
-            for value in values
-            if value
-        ]
+        terms = field.vocabulary.getAllVocTerms(context)
+        missing_values = [v for v in values if v and v not in terms]
+        result = [terms[v].title for v in values if v and v not in missing_values]
+        if len(missing_values) > 0:
+            logger.info(
+                "{0}: Missing vocabulary values '{2}' for field '{1}'".format(
+                    context.absolute_url(),
+                    field.__name__,
+                    ", ".join(missing_values),
+                )
+            )
+        result += missing_values
     elif type(field.vocabulary) == str:
         display_list = getattr(context, field.vocabulary)()
         if type(display_list) == list:
@@ -35,7 +42,7 @@ def resolve_vocabulary(context, field, values):
         vocabulary_factory = field.vocabulary_factory
         factory = getUtility(IVocabularyFactory, vocabulary_factory)
         vocabulary = factory(context)
-        missing_values = [v for v in values if v not in vocabulary.by_token if v]
+        missing_values = [v for v in values if v and v not in vocabulary.by_token]
         result = [
             vocabulary.by_token[v].title
             for v in values

{Products.urban-2.7.8 → Products.urban-2.7.9}/src/Products.urban.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Products.urban
-Version: 2.7.8
+Version: 2.7.9
 Summary: Urban Certificate Management
 Home-page: http://www.communesplone.org/les-outils/applications-metier/gestion-des-permis-durbanisme
 Author: Simon Delcourt
@@ -52,6 +52,25 @@ Changelog
 
 .. towncrier release notes start
 
+2.7.9 (2024-04-07)
+------------------
+
+Bug fixes:
+
+
+- Avoid an error if a vocabulary term was removed
+  [mpeeters] (SUP-36403,SUP-36406)
+- Fix logic on some methods to exclude invalid vocabulary entries
+  [mpeeters] (URB-3002)
+
+
+Internal:
+
+
+- Add tests for new vocabulary logic (start and end validity)
+  [mpeeters] (URB-3002)
+
+
 2.7.8 (2024-04-02)
 ------------------