Merge pull request #21 from collective/approved_column

Added "Approved?" column to the categorized elements table

Author: sgeulette

.github/workflows/main.yml

@@ -11,28 +11,43 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v5
       - name: Setup Env
         run: |
           sudo apt-get update -qqy
           sudo apt-get install -y libjpeg8-dev libbz2-dev
           pip install --upgrade pip
           pip install -r requirements.txt
       - name: Set up pyenvi and Python
-        uses: "gabrielfalcao/pyenv-action@v14"
+        uses: "gabrielfalcao/pyenv-action@v18"
         with:
           default: 2.7.18
-          versions: 3.8.16
           command: pyenv -v
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '2.6'
       - name: Set up Env
         run: |
-          sudo apt-get update
-          sudo apt-get install -qqy graphicsmagick poppler-utils libreoffice
-          sudo gem install docsplit
+          sudo apt update -qq -y
+          sudo apt install -qq -y gnupg2
+          gpg2 --keyserver hkp://keyserver.ubuntu.com --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
+          curl -sSL https://get.rvm.io | bash -s stable
+          source $HOME/.rvm/scripts/rvm
+
+          # Puis Ruby 2.7.6 :
+          rvm pkg install openssl
+          rvm install ruby-2.7.6 --with-openssl-dir=$HOME/.rvm/usr
+
+          # Pour voir la version de ruby installée :
+          which ruby
+
+          # Création d'un lien symbolique pour que docsplit puisse utiliser ruby (si pas de ruby système) :
+          sudo ln -s $HOME/.rvm/rubies/ruby-2.7.6/bin/ruby /usr/bin/ruby2.7
+          sudo rm /usr/bin/ruby
+          sudo ln -s ruby2.7 /usr/bin/ruby
+
+          # Enfin, on peut installer les autres dépendances de documentviewer :
+          gem install docsplit
+          echo "$HOME/.rvm/gems/ruby-2.7.6/gems/docsplit-0.7.6/bin" >> $GITHUB_PATH
+          sudo apt install -qq -y graphicsmagick wv poppler-utils libreoffice
+
           pip install -r requirements.txt coverage==5.3.1
       - name: Cache eggs
         uses: actions/cache@v4
@@ -53,18 +68,18 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v5
       - name: Setup Env
         run: |
           sudo apt-get update -qqy
           sudo apt-get install -y libjpeg8-dev libbz2-dev
           pip install --upgrade pip
           pip install -r requirements.txt
       - name: Set up pyenv and Python
-        uses: "gabrielfalcao/pyenv-action@v14"
+        uses: "gabrielfalcao/pyenv-action@v18"
         with:
           default: 2.7.18
-          versions: 3.8.16
+          versions: 3.6.15
           command: pyenv -v
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
@@ -93,14 +108,11 @@ jobs:
       - name: test coverage
         run: |
           bin/coverage run bin/test -t !robot
-      - name: Set up Python 3.6
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.6
       - name: Install Coveralls
         run: |
-          pip3 install -U pip setuptools --no-cache-dir
-          pip3 install -U "coveralls>=3.0.0" coverage==5.3.1 --no-cache-dir
+          pyenv local 3.6
+          pip install -U pip setuptools --no-cache-dir
+          pip install -U "coveralls>=3.0.0" coverage==5.3.1 --no-cache-dir
       - name: Publish to Coveralls
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CHANGES.rst

@@ -6,7 +6,12 @@ Changelog
 
 - Fix invalid jQuery selector for default Title field filling
   [laulaz]
-
+- Added "Approved?" column to the categorized elements table
+  [chris-adam,sgeulette]
+- Added cache on IconClickableColumn action view.
+  [chris-adam]
+- Added page reload possibility
+  [sgeulette]
 
 0.69 (2025-06-23)
 -----------------

README.rst

@@ -21,15 +21,16 @@ This product will let you categorize created content using a category identified
 
 A dexterity behavior can be enabled and will add a field "content category" that will list available categories defined in a configuration.
 
-So you first have to define the categories by adding a ContentCategoryConfiguration somewhere.  Then add a CategoryGroup on which some extra features may be activated :
+So you first have to define the categories by adding a ContentCategoryConfiguration somewhere. Then add a CategoryGroup on which some extra features may be activated :
 
 - is content confidential?
 - is content an element to print?
 - is content an element to sign?
+- is content an element to approve?
 
 If activated, these fields will be available on the content using the behavior.
 
-Then into a CategoryGroup, you will be able to add ContentCategory that are characterized by a title and an icon.  These ContentCategory elements will be the terms of a vocabulary used to select a category on a content using the behavior.
+Then into a CategoryGroup, you will be able to add ContentCategory that are characterized by a title and an icon. These ContentCategory elements will be the terms of a vocabulary used to select a category on a content using the behavior.
 
 This package is widely overridable and is made to manage many usecases of iconified categories.
 

src/collective/iconifiedcategory/adapter.py

@@ -47,11 +47,14 @@ def _get_basic_infos(self, category):
             'to_be_printed_activated': self._to_be_printed_activated(category),
             'confidentiality_activated': self._confidentiality_activated(category),
             'signed_activated': self._signed_activated(category),
+            'approved_activated': self._approved_activated(category),
             'publishable_activated': self._publishable_activated(category),
             'to_print': self._to_print,
             'confidential': self._confidential,
             'to_sign': self._to_sign,
             'signed': self._signed,
+            'to_approve': self._to_approve,
+            'approved': self._approved,
             'publishable': self._publishable,
             'show_preview': self._show_preview(category),
         }
@@ -148,6 +151,18 @@ def _to_sign(self):
     def _signed(self):
         return getattr(self.obj, 'signed', False)
 
+    def _approved_activated(self, category):
+        category_group = category.get_category_group()
+        return category_group.approved_activated
+
+    @property
+    def _to_approve(self):
+        return getattr(self.obj, 'to_approve', False)
+
+    @property
+    def _approved(self):
+        return getattr(self.obj, 'approved', False)
+
     def _publishable_activated(self, category):
         category_group = category.get_category_group()
         return category_group.publishable_activated

src/collective/iconifiedcategory/behaviors/iconifiedcategorization.py

@@ -99,6 +99,12 @@ def _content_category_changed_default_values(self, new_value):
            self.context.signed == current_category.signed:
             self.context.to_sign = new_category.to_sign
             self.context.signed = new_category.signed
+        # to_approve
+        if category_group.approved_activated and \
+           self.context.to_approve == current_category.to_approve and \
+           self.context.approved == current_category.approved:
+            self.context.to_approve = new_category.to_approve
+            self.context.approved = new_category.approved
         # publishable
         if category_group.publishable_activated and \
            self.context.publishable == current_category.publishable:
@@ -130,6 +136,13 @@ def to_sign(self):
     def signed(self):
         return getattr(aq_base(self.context), 'signed', False)
 
+    @property
+    def to_approve(self):
+        return getattr(aq_base(self.context), 'to_approve', False)
+
+    def approved(self):
+        return getattr(aq_base(self.context), 'approved', False)
+
     @property
     def publishable(self):
         return getattr(aq_base(self.context), 'publishable', False)

src/collective/iconifiedcategory/browser/actionview.py

@@ -14,6 +14,7 @@
 from collective.iconifiedcategory.interfaces import IIconifiedPrintable
 from plone import api
 from Products.CMFCore.permissions import ModifyPortalContent
+from Products.CMFPlone.utils import base_hasattr
 from Products.Five import BrowserView
 from z3c.json.interfaces import IJSONWriter
 from zope.component import getAdapter
@@ -28,6 +29,7 @@ class BaseView(BrowserView):
     attr_name = ''
     # when updating element, do that limited?
     limited = True
+    permission = ModifyPortalContent
 
     def _translate(self, msgid):
         return translate(
@@ -67,9 +69,11 @@ def get_values(self):
                 for k, v in self.attribute_mapping.items()}
 
     def _may_set_values(self, values, ):
-        res = bool(api.user.has_permission(ModifyPortalContent, obj=self.context))
+        res = bool(api.user.has_permission(self.permission, obj=self.context))
         if res:
             # is this functionnality enabled?
+            if not base_hasattr(self.context, "content_category"):
+                return False
             self.category = utils.get_category_object(self.context, self.context.content_category)
             category_group = self.category.get_category_group()
             res = getattr(category_group, self.category_group_attr_name, True)
@@ -101,6 +105,7 @@ def set_values(self, values):
                 old_values,
                 values,
             ))
+            self.context.reindexObject(idxs=list(self.attribute_mapping.keys()))
         return status, msg
 
     def _get_status(self, values):
@@ -186,6 +191,45 @@ def set_values(self, values):
         return status, utils.signed_message(self.context)
 
 
+class ApprovedChangeView(BaseView):
+    attribute_mapping = {
+        'approved': 'iconified-value',
+        'to_approve': 'iconified-value',
+    }
+    category_group_attr_name = 'approved_activated'
+    attr_name = 'to_approve'
+
+    def _get_next_values(self, old_values):
+        """ """
+        values = {}
+        if old_values['to_approve'] is False:
+            values['to_approve'] = True
+            values['approved'] = False
+            status = 0
+        elif old_values['to_approve'] is True and old_values['approved'] is False:
+            values['to_approve'] = True
+            values['approved'] = True
+            status = 1
+        else:
+            values['to_approve'] = False
+            values['approved'] = False
+            status = -1
+        return status, values
+
+    def set_values(self, values):
+        """
+        Value are setting 'to_approve' and 'approved' attributes with following
+        possibility depending on allowed ones :
+           - False/False;
+           - True/False;
+           - True/True.
+        """
+        old_values = self.get_current_values()
+        status, values = self._get_next_values(old_values)
+        super(ApprovedChangeView, self).set_values(values)
+        return status, utils.approved_message(self.context)
+
+
 class PublishableChangeView(BaseView):
     attribute_mapping = {
         'publishable': 'iconified-value',

src/collective/iconifiedcategory/browser/configure.zcml

@@ -143,6 +143,14 @@
     permission="zope2.View"
     />
 
+  <browser:page
+    name="iconified-approved"
+    for="*"
+    layer="collective.iconifiedcategory.interfaces.ICollectiveIconifiedCategoryLayer"
+    class=".actionview.ApprovedChangeView"
+    permission="zope2.View"
+    />
+
   <browser:page
     name="iconified-publishable"
     for="*"
@@ -250,6 +258,15 @@
     factory=".tabview.SignedColumn"
     />
 
+  <adapter
+    name="approved-column"
+    for="zope.interface.Interface
+         zope.interface.Interface
+         collective.iconifiedcategory.interfaces.ICategorizedApproved"
+    provides="z3c.table.interfaces.IColumn"
+    factory=".tabview.ApprovedColumn"
+    />
+
   <adapter
     name="publishable-column"
     for="zope.interface.Interface

src/collective/iconifiedcategory/browser/contentview.py

@@ -24,6 +24,8 @@ class FormMixin(object):
         'to_print': 'to_be_printed_activated',
         'to_sign': 'signed_activated',
         'signed': 'signed_activated',
+        'to_approve': 'approved_activated',
+        'approved': 'approved_activated',
     }
 
     @property
@@ -64,6 +66,8 @@ class BaseView(DefaultView):
         'to_print': 'to_be_printed_activated',
         'to_sign': 'signed_activated',
         'signed': 'signed_activated',
+        'to_approve': 'approved_activated',
+        'approved': 'approved_activated',
     }
 
     def updateWidgets(self):