Plone6 / Py3 support

CHANGES.rst

@@ -2,12 +2,26 @@ Changelog
 =========
 
 
-2.25 (unreleased)
+2.27 (unreleased)
+-----------------
+
+- When `the_object=True`, `attrName` may be a callable.
+  [gbastien]
+
+2.26 (2023-11-27)
+-----------------
+
+- Take into account `VocabularyColumn.ignored_value` in `AbbrColumn`.
+  [gbastien]
+
+2.25 (2023-10-27)
 -----------------
 
 - In `DateColumn.renderCell`, no need to manage a `DateTime` as it is supported
   by `api.portal.get_localized_time`.
   [gbastien]
+- Fix Py3 Errors
+  [fngaha]
 
 2.24 (2023-10-19)
 -----------------

buildout.d/versions.cfg

@@ -1,9 +1,11 @@
 [versions]
 setuptools = 44.1.1
 zc.buildout = 2.13.3
-#python 2 ...
+# python 2 ...
+backports.functools-lru-cache = 1.6.4
 traitlets = 4.3.3
 future = 0.18.2
+six = 1.16.0
 # misc
 plone.formwidget.namedfile = 2.0.6
 

setup.py

@@ -15,7 +15,7 @@ def read(*rnames):
 
 setup(
     name='collective.eeafaceted.z3ctable',
-    version='2.25.dev0',
+    version='2.27.dev0',
     description="Package proposant un type de colonne compatible avec eea.facetednavigation",
     long_description=long_description,
     # Get more from http://pypi.python.org/pypi?%3Aaction=list_classifiers
@@ -25,8 +25,13 @@ def read(*rnames):
         "Framework :: Plone :: 4.3",
         "Framework :: Plone :: 5.0",
         "Framework :: Plone :: 5.1",
+        "Framework :: Plone :: 6.0",
         "License :: OSI Approved :: GNU General Public License (GPL)",
         "Programming Language :: Python :: 2.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
     ],
     keywords='Python Zope Plone',
     author='IMIO',
@@ -41,8 +46,7 @@ def read(*rnames):
     install_requires=[
         'Plone',
         'collective.excelexport',
-        'eea.facetednavigation<16.0',
-        'imio.helpers',
+        'eea.facetednavigation>=16.0',
         'plone.api>=1.3.0',
         'plone.formwidget.namedfile>=2.0.2',
         'setuptools',

src/collective/eeafaceted/z3ctable/browser/configure.zcml

@@ -33,6 +33,7 @@
       permission="zope2.View"
       />
 
+    <include package="eea.facetednavigation" file="permissions.zcml" />
     <browser:page
       for="eea.facetednavigation.interfaces.IFacetedNavigable"
       name="default_collection_widgets.xml"

src/collective/eeafaceted/z3ctable/browser/views.py

@@ -11,7 +11,7 @@
 from z3c.table.table import SequenceTable
 from zope.component import getAdapters
 from zope.component import queryMultiAdapter
-from zope.interface import implements
+from zope.interface import implementer
 
 import html
 import logging
@@ -112,15 +112,14 @@ def renderCell(self, item, column, colspan=0):
         return renderedCell
 
 
+@implementer(IFacetedTable)
 class FacetedTableView(BrowserView, ExtendedCSSTable):
 
-    implements(IFacetedTable)
-
     # workaround so z3c.table does not manage batching
     startBatchingAt = 9999
     cssClassEven = u'odd'
     cssClassOdd = u'even'
-    cssClasses = {'table': 'faceted-table-results listing nosort'}
+    cssClasses = {'table': 'faceted-table-results table table-striped table-bordered nosort'}
     ignoreColumnWeight = False  # when set to True, keep columns ordered as returned by '_getViewFields'
     table_id = 'faceted_table'
     row_id_prefix = 'row_'
@@ -141,7 +140,7 @@ def render_table(self, batch):
         self.update(batch)
         try:
             return self.render()
-        except Exception, exc:
+        except Exception as exc:
             # in case an error occured, catch it or it freezes the web page
             # because faceted JS disable page and error raised does not unlock
             traceback.print_exc(None)

src/collective/eeafaceted/z3ctable/columns.py

@@ -2,10 +2,10 @@
 
 from collective.eeafaceted.z3ctable import _
 from collective.eeafaceted.z3ctable.interfaces import IFacetedColumn
+from collective.eeafaceted.z3ctable.utils import base_getattr
+from collective.eeafaceted.z3ctable.utils import get_user_fullname
 from collective.excelexport.exportables.dexterityfields import get_exportable_for_fieldname
 from datetime import date
-from imio.helpers.content import base_getattr
-from imio.helpers.content import get_user_fullname
 from plone import api
 from Products.CMFPlone.utils import base_hasattr
 from Products.CMFPlone.utils import safe_unicode
@@ -18,7 +18,7 @@
 from zope.component import getMultiAdapter
 from zope.component import queryUtility
 from zope.i18n import translate
-from zope.interface import implements
+from zope.interface import implementer
 from zope.schema.interfaces import IVocabularyFactory
 
 import html
@@ -38,6 +38,8 @@
     api.env.get_distribution('collective.z3cform.datagridfield')
     from collective.z3cform.datagridfield.datagridfield import DataGridField
     HAS_Z3CFORM_DATAGRIDFIELD = True
+except ImportError:
+    HAS_Z3CFORM_DATAGRIDFIELD = False
 except pkg_resources.DistributionNotFound:
     HAS_Z3CFORM_DATAGRIDFIELD = False
 
@@ -46,10 +48,9 @@
 EMPTY_DATE = date(1950, 1, 1)
 
 
+@implementer(IFacetedColumn)
 class BaseColumn(column.GetAttrColumn):
 
-    implements(IFacetedColumn)
-
     sort_index = None
     # as we use setUpColumns, weight is 1 for every columns
     weight = 1
@@ -69,7 +70,10 @@ class BaseColumn(column.GetAttrColumn):
     def getValue(self, item):
         """ """
         if self.the_object:
-            return safe_unicode(base_getattr(self._getObject(item), self.attrName))
+            attr = safe_unicode(base_getattr(self._getObject(item), self.attrName))
+            if callable(attr):
+                return attr()
+            return attr
         else:
             return super(BaseColumn, self).getValue(item)
 
@@ -275,8 +279,7 @@ def renderCell(self, item):
         value = self.getValue(item)
         if not value or value == self.ignored_value:
             return u'-'
-        value = get_user_fullname(value)
-        return safe_unicode(value)
+        return safe_unicode(get_user_fullname(value))
 
 
 class DateColumn(BaseColumn):
@@ -409,7 +412,7 @@ class AbbrColumn(VocabularyColumn):
 
     def renderCell(self, item):
         value = self.getValue(item)
-        if not value:
+        if not value or value == self.ignored_value:
             return u'-'
 
         # caching when several same values in same column

src/collective/eeafaceted/z3ctable/configure.zcml

@@ -12,9 +12,7 @@
     <five:registerPackage package="." initialize=".initialize" />
 
     <!-- Include configuration for dependencies listed in setup.py -->
-    <includeDependencies package="." />
     <include zcml:condition="installed imio.actionspanel" package="imio.actionspanel"/>
-    <include package="imio.helpers"/>
     <include zcml:condition="installed imio.prettylink" package="imio.prettylink"/>
 
     <!-- Include sub-packages that use their own configure.zcml files. -->

src/collective/eeafaceted/z3ctable/profiles.zcml

@@ -2,25 +2,37 @@
     xmlns="http://namespaces.zope.org/zope"
     xmlns:zcml="http://namespaces.zope.org/zcml"
     xmlns:genericsetup="http://namespaces.zope.org/genericsetup"
-    xmlns:five="http://namespaces.zope.org/five"
     i18n_domain="collective.eeafaceted.collectionwidget">
 
     <genericsetup:registerProfile
-        zcml:condition="have plone-5"
+        zcml:condition="have plone-60"
         name="default"
-        directory="profiles/plone5"
+        directory="profiles/plone6"
         title="collective.eeafaceted.z3ctable"
         description="Extension profile for collective.eeafaceted.z3ctable."
         provides="Products.GenericSetup.interfaces.EXTENSION" />
-
-    <genericsetup:registerProfile
-        zcml:condition="not-have plone-5"
-        name="default"
-        directory="profiles/plone4"
-        title="collective.eeafaceted.z3ctable"
-        description="Extension profile for collective.eeafaceted.z3ctable."
-        provides="Products.GenericSetup.interfaces.EXTENSION" />
-
+
+    <configure zcml:condition="not-have plone-60">
+        <genericsetup:registerProfile
+            zcml:condition="have plone-5"
+            name="default"
+            directory="profiles/plone5"
+            title="collective.eeafaceted.z3ctable"
+            description="Extension profile for collective.eeafaceted.z3ctable."
+            provides="Products.GenericSetup.interfaces.EXTENSION" />
+    </configure>
+
+    <configure zcml:condition="not-have plone-60">
+        <configure zcml:condition="not-have plone-5">
+            <genericsetup:registerProfile
+                name="default"
+                directory="profiles/plone4"
+                title="collective.eeafaceted.z3ctable"
+                description="Extension profile for collective.eeafaceted.z3ctable."
+                provides="Products.GenericSetup.interfaces.EXTENSION" />
+        </configure>
+    </configure>
+
     <genericsetup:registerProfile
         name="universal"
         directory="profiles/common"
@@ -55,5 +67,5 @@
             description=""
             import_steps="jsregistry" />
     </genericsetup:upgradeSteps>
-  
+
 </configure>

src/collective/eeafaceted/z3ctable/profiles/common/metadata.xml

@@ -3,6 +3,5 @@
   <version>3</version>
   <dependencies>
     <dependency>profile-eea.facetednavigation:default</dependency>
-    <dependency>profile-imio.helpers:default</dependency>
   </dependencies>
 </metadata>

src/collective/eeafaceted/z3ctable/profiles/plone6/metadata.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0"?>
+<metadata>
+  <version>3</version>
+  <dependencies>
+    <dependency>profile-collective.eeafaceted.z3ctable:universal</dependency>
+  </dependencies>
+</metadata>

src/collective/eeafaceted/z3ctable/profiles/plone6/registry.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0"?>
+<registry>
+
+  <records interface="Products.CMFPlone.interfaces.IBundleRegistry"
+           prefix="plone.bundles/faceted-vars-z3ctable">
+    <value key="enabled">True</value>
+    <value key="jscompilation">collective_eeafaceted_z3ctable_js_variables.js</value>
+    <value key="load_defer">False</value>
+    <value key="load_async">False</value>
+  </records>
+
+  <records interface="Products.CMFPlone.interfaces.IBundleRegistry"
+           prefix="plone.bundles/faceted-z3ctable">
+    <value key="enabled">True</value>
+    <value key="jscompilation">++resource++collective.eeafaceted.z3ctable/collective.eeafaceted.z3ctable.js</value>
+    <value key="load_defer">False</value>
+    <value key="load_async">False</value>
+  </records>
+</registry>

src/collective/eeafaceted/z3ctable/tests/test_columns.py

@@ -11,6 +11,7 @@
 from collective.eeafaceted.z3ctable.columns import DateColumn
 from collective.eeafaceted.z3ctable.columns import DxWidgetRenderColumn
 from collective.eeafaceted.z3ctable.columns import ElementNumberColumn
+from collective.eeafaceted.z3ctable.columns import EMPTY_STRING
 from collective.eeafaceted.z3ctable.columns import I18nColumn
 from collective.eeafaceted.z3ctable.columns import IconsColumn
 from collective.eeafaceted.z3ctable.columns import MemberIdColumn
@@ -395,6 +396,12 @@ def test_AbbrColumn(self):
                          u"<abbr title='Full existing value 1'>Existing v\xe9lue 1, </abbr>"
                          u"<abbr title='unexisting_key'>unexisting_key, </abbr>"
                          u"<abbr title='Full existing value 2'>Existing v\xe9lue 2</abbr>")
+        # ignored_value
+        self.assertEqual(column.ignored_value, EMPTY_STRING)
+        self.eea_folder.setTitle(EMPTY_STRING)
+        self.eea_folder.reindexObject(idxs=['Title', ])
+        brain = self.portal.portal_catalog(UID=self.eea_folder.UID())[0]
+        self.assertEqual(column.renderCell(brain), u'-')
 
     def test_TheObjectVocabularyColumn(self):
         """VocabularyColumn where we awake object to get attrName attribute."""
@@ -407,6 +414,11 @@ def test_TheObjectVocabularyColumn(self):
         column.vocabulary = "collective.eeafaceted.z3ctable.testingvocabulary"
         column.full_vocabulary = "collective.eeafaceted.z3ctable.testingfullvocabulary"
         self.assertEqual(column.renderCell(brain), u"Existing v\xe9lue 1")
+        # if a callable is defined, it is called
+        self.eea_folder.setTitle([u'existing_key1', u'existing_key2'])
+        self.eea_folder.reindexObject()
+        column.attrName = 'Title'
+        self.assertEqual(column.renderCell(brain), u'Existing v\xe9lue 1, Existing v\xe9lue 2')
         # will raise if attrName does not exist
         column.attrName = "unknown"
         self.assertEqual(column.renderCell(brain), u'-')

src/collective/eeafaceted/z3ctable/tests/vocabularies.py

@@ -1,14 +1,14 @@
 # encoding: utf-8
 
 from plone.memoize.instance import memoize
-from zope.interface import implements
+from zope.interface import implementer
 from zope.schema.interfaces import IVocabularyFactory
 from zope.schema.vocabulary import SimpleTerm
 from zope.schema.vocabulary import SimpleVocabulary
 
 
+@implementer(IVocabularyFactory)
 class TestingVocabulary(object):
-    implements(IVocabularyFactory)
 
     @memoize
     def __call__(self, context):
@@ -23,8 +23,8 @@ def __call__(self, context):
 TestingVocabularyFactory = TestingVocabulary()
 
 
+@implementer(IVocabularyFactory)
 class TestingFullVocabulary(object):
-    implements(IVocabularyFactory)
 
     @memoize
     def __call__(self, context):