Disable _all_ filter option

.github/workflows/main.yml

@@ -3,7 +3,6 @@ name: CI
 on:
   push:
     branches-ignore:
-      - "master"
       - "releases/**"
 
 jobs:
@@ -12,18 +11,52 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        plone-version: 
+        plone-version:
           - '5.0'
           - '5.1'
           - '5.2'
-        python-version: ['2.7']
-        include:
-          - plone-version: 5.2
+        python-version: ['2.7', '3.6', '3.7', '3.8']
+        layer:
+          - Portlet_AjaxDisabled
+          - Portlet_AjaxEnabled
+          - Tile
+          - unit
+        coverage: ['no_coverage', 'coverage']
+        exclude:
+          - plone-version: 5.0
+            layer: Tile # standardtiles 2.3.2 does support using the request to query. embed might still be possible
+          - plone-version: 5.0
+            layer: Portlet_AjaxEnabled  # passes but meaningless as it skips all the tests
+          # Only 5.2+ runs on py3
+          - plone-version: 5.0
             python-version: 3.6
-          - plone-version: 5.2
+          - plone-version: 5.0
             python-version: 3.7
-          - plone-version: 5.2
+          - plone-version: 5.0
             python-version: 3.8
+          - plone-version: 5.1
+            python-version: 3.6
+          - plone-version: 5.1
+            python-version: 3.7
+          - plone-version: 5.1
+            python-version: 3.8
+          # Save some time by not running all the robot tests
+          - python-version: 3.6
+            layer: Portlet_AjaxDisabled
+          - python-version: 3.7
+            layer: Portlet_AjaxDisabled
+          - python-version: 3.6
+            layer: Tile
+          - python-version: 3.7
+            layer: Tile
+          # save some time only running coverage on the 5.2 tests
+          - plone-version: 5.0
+            coverage: coverage
+          - plone-version: 5.1
+            coverage: coverage
+          - plone-version: 5.2
+            coverage: no_coverage
+
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python
@@ -35,24 +68,25 @@ jobs:
           sudo apt-get update -y
           # sudo apt-get install -y build-essentials
           sudo apt-get install -y libxml2-dev libxslt-dev python-dev
-          # sudo apt-get install py-pip  
+          # sudo apt-get install py-pip
           pip install \
             virtualenv wheel
       - uses: nanasess/setup-chromedriver@master
         # with:
         #   # Optional: do not specify to match Chrome's version
-        #   chromedriver-version: '77.0.3865.40'            
+        #   chromedriver-version: '77.0.3865.40'
       - name: Cache multiple paths
         uses: actions/cache@v2
         with:
           path: |
             ~/buildout-cache
             ~/extends
             ~/.cache/pip
-          # key: ${{ runner.os }}-buildout-${{ hashFiles('**/*.cfg') }}-${{ matrix.plone-version }}-${{ matrix.python-version }}
-          key: ${{ runner.os }}-buildout-${{ matrix.plone-version }}-${{ matrix.python-version }}
+          key: ${{ runner.os }}-${{ matrix.python-version }}-${{ matrix.plone-version }}-${{ hashFiles('**/*.cfg') }}
           restore-keys: |
-            ${{ runner.os }}-buildout-
+            ${{ runner.os }}-${{ matrix.python-version }}-${{ matrix.plone-version }}-
+            ${{ runner.os }}-${{ matrix.python-version }}-
+            ${{ runner.os }}-
       - name: setup buildout cache
         run: |
             mkdir -p ~/buildout-cache/{eggs,downloads}
@@ -69,44 +103,66 @@ jobs:
           bin/buildout -t 10 -Nc test-${{ matrix.plone-version }}.x.cfg
           bin/pip install zest.pocompile
           bin/pocompile src
-      - name: test
+      - name: test robot
+        if: ${{ matrix.coverage != 'coverage' && matrix.layer != 'unit' }}
         run: |
             export DISPLAY=:99.0
             chromedriver --url-base=/wd/hub &
             sudo Xvfb -ac :99 -screen 0 1280x1024x24 > /dev/null 2>&1 & # optional
             sleep 3
-            bin/test --all 
+            bin/test --all  --layer ${{ matrix.layer }} --list-tests            
+            bin/test --all  --layer ${{ matrix.layer }}
+      - name: test unit
+        if: ${{ matrix.coverage != 'coverage' && matrix.layer == 'unit' }}
+        run: |
+            bin/test --unit --list-tests            
+            bin/test --unit
+      - name: createcoverage
+        if: ${{ matrix.coverage == 'coverage' && matrix.layer != 'unit' }}
+        run: |
+            export DISPLAY=:99.0
+            chromedriver --url-base=/wd/hub &
+            sudo Xvfb -ac :99 -screen 0 1280x1024x24 > /dev/null 2>&1 & # optional
+            sleep 3
+            bin/test --all  --layer ${{ matrix.layer }} --list-tests            
+            bin/createcoverage -t '--all --layer ${{ matrix.layer }}'
+            bin/coverage json -i
+      - name: createcoverage
+        if: ${{ matrix.coverage == 'coverage' && matrix.layer == 'unit' }}
+        run: |
+            bin/test --unit --list-tests            
+            bin/createcoverage -t '--unit'
+            bin/coverage json -i
+      - name: Coveralls
+        if: ${{ matrix.coverage == 'coverage' }}
+        uses: AndreMiras/coveralls-python-action@develop
+        with:
+          parallel: true
+          flag-name: ${{ matrix.plone-version }}-${{ matrix.python-version }}-${{ matrix.layer }}
       - name: code-analysis
-        run: echo "${{ matrix.plone-version }}" | grep 5.1 || bin/code-analysis  
+        if: always()
+        run: echo "${{ matrix.plone-version }}" | grep 5.1 || bin/code-analysis
+      - name: black
+        if: ${{ matrix.python-version == '3.8' }}
+        run: |
+          pip install black
+          black --check src
       - name: Artifact Robot Test Report
         if: failure()
         uses: actions/upload-artifact@v1
         with:
-          name: test_results
+          name: test_results-${{ matrix.python-version }}-${{ matrix.plone-version }}-${{ matrix.layer }}
           path: ./parts/test
       - uses: actions/setup-python@v2
         if: failure()
         with:
-          python-version: 2.7            
+          python-version: 2.7
       - name: Robottest report
+        continue-on-error: true
         if: failure()
         run: |
             pip2.7 install popt || pip2.7 install --user  popt
             grep  --include=output.xml -Rl  FAIL parts/test | xargs --no-run-if-empty -n 1 popt
-      - name: createcoverage
-        run: |
-            export DISPLAY=:99.0
-            chromedriver --url-base=/wd/hub &
-            sudo Xvfb -ac :99 -screen 0 1280x1024x24 > /dev/null 2>&1 & # optional
-            sleep 3
-            bin/createcoverage -t '--all'
-            # bin/createcoverage
-            bin/coverage json -i
-      - name: Coveralls
-        uses: AndreMiras/coveralls-python-action@develop
-        with:
-          parallel: true
-          flag-name: ${{ matrix.plone-version }}-${{ matrix.python-version }}     
 
   coveralls_finish:
     needs: build

CHANGES.rst

@@ -1,7 +1,31 @@
 Changelog
 =========
 
-3.6 (unreleased)
+4.0 (unreleased)
+
+Breaking Change:
+
+- Add idx parameter to display_modifier call, so that we can use the index name to resolve the correct translated taxonomy titles in collective.taxonomy. This means that the display_modifier method in the groupby_modifier adapters needs to expect this parameter too!
+  [MrTango]
+
+Bug Fixes:
+
+- Fix edge cases where "All" wasn't translated.
+  [agitator]
+
+- Ensure a `GroupByCriteria`'s `sort_key_function` function `lower()` call gets a string.
+  [jensens]
+
+- Fixed searches for only non-alphanumeric characters causing an exception to be displayed.
+  [JeffersonBledsoe]
+
+Other:
+
+- Code-Style Black and Isort
+  [jensens]
+
+
+3.5.1 (2021-05-26)
 ----------------
 
 - Updated de and ch-de translations
@@ -11,7 +35,7 @@ Changelog
 3.5 (2021-05-26)
 ----------------
 
-- Use collection from context as default. `target_collection` is now used to select an alternative collection as result source. 
+- Use collection from context as default. `target_collection` is now used to select an alternative collection as result source.
   This allows to copy and paste preconfigured collections for reuse without reconfiguring each filter element.
   [agitator]
 

README.rst

@@ -13,11 +13,11 @@ collective.collectionfilter
    :target: https://github.com/collective/collective.collectionfilter/actions
 
 
-Faceted navigation filter for collection results.
+Faceted navigation filter for collection or contentlisting tiles.
 
-This Plone 5 addon allows you to filter collections results for additional catalog metadata.
+This Plone 5 addon allows you to filter listing results for fields which are indexed in the catalog 
+(Plones internal search tool).
 For example, you can add a subject filter, but also a filter for authors or portal types.
-This can also be used to build tag clouds.
 
 The filter types can be extended (see: ``collective.collectionfilter.vocabularies``).
 
@@ -35,27 +35,42 @@ There are three portlets/tiles available for filtering:
     a list of indexes where the user can sort the filtered result listing
 
 
-Filter Results with portlets
+Filter Results of Collections
 ----------------------------
 
-Add as many of the filter portlets above to any context you want (most likely the source collection)
-and assign a collection with results to it.
+Add as many filter/search portlets directly to a collection.
 
-When you select values from the filter the results are loaded asynchronously inside the container
-with the selector defined in the field ``Content Selector``. Make sure the selector exists on the
-source collection template and on the target page which shows the filtered results.
+When you select values from the filter the results are loaded asynchronously onto the page (no page refresh).
+Unless you turn off ajax loading in the registery or are using Plone 5.0. If you are using special theme or view template
+you can customize ``Content Selector`` and/or ```View Template``` to ensure ajax loading works correctly.
+Make sure the selector exists on the source collection template and on the target page which shows the filtered results.
+
+It is also possible to use filter portlets that aren't directly on a collection by specifying a target collection.
+To use ajax loading you will need to ensure your content selector is visible on the page. If not using ajax loading selecting a filter
+option will redirect you to the collection.
 
 
 Mosaic Integration
 ------------------
 
+Use the package extra to install the required dependencies::
+
+    [buildout]
+    ...
+    eggs +=
+        collective.collectionfilter[mosaic]
+    ...
+
 The three tiles can be added within the Mosaic editor multiple times. Just select them in the ``Insert`` menu
 and assign a collection to it. To show the results of the collection simply add a
-``Existing Content`` tile which links to the same collection your filter tiles are assigned with.
+``Content Listing`` tile. 
+
+It's possible to use multiple content listings and multiple filters on the same page by specifying additional unique classes in
+the listing tiles settings and then adding these classes to the ``Content Selector`` setting of the filter tile.
+
+If you want to use filter tiles with a collection then add a content listing tile with the setting to use the query from the context.
+It is also possible to use the ``Embed content`` tile if there is a unique selector on your collection view.
 
-TODO: right now the collection needs a default_view template, which wraps the result list with a unique selector
-inside the ``#content-core`` container. so the collectionfilter can load the filtered result correctly from
-the collection into the container inside the existing content tile.
 
 
 Geolocation filter support
@@ -129,12 +144,12 @@ Write an adapter::
     @implementer(IGroupByModifier)
     @adapter(IGroupByCriteria)
     def groupby_modifier(groupby):
-        groupby._groupby['Subject']['display_modifier'] = lambda x: x.upper()
+        groupby._groupby['Subject']['display_modifier'] = lambda x, idx: x.upper()
         groupby._groupby['Subject']['sort_key_function'] = subjectsort
         groupby._groupby['my_new_index'] = {
             'index': 'my_new_index',
             'metadata': 'my_new_index_metadata_colum',
-            'display_modifier': lambda it: u'this is awesome: {0}'.format(it)
+            'display_modifier': lambda it, idx: u'this is awesome: {0}'.format(it)
         }
 
 Register the adapter::

base.cfg

@@ -1,14 +1,21 @@
 [buildout]
-extensions = mr.developer
+# extensions = mr.developer
 versions = versions
 
+[code-analysis]
+directory = ${buildout:directory}/src/collective/collectionfilter
+flake8-ignore = E501,E241,W503
+
 [versions]
 collective.collectionfilter =
 collective.geolocationbehavior = >=1.6.0
 plone.formwidget.geolocation = >=2.2.0
 plone.patternslib = >=1.1.0
+plone.app.standardtiles = >= 2.4.0
+plone.batching = >=1.1.7
 
 # plone.app.standardtiles = 2.3.1 # fix https://github.com/plone/plone.app.standardtiles/issues/111
+pycodestyle =
 
 # Robot Testing (see buildout.coredev[5.2]/versions.cfg)
 plone.app.robotframework = 1.5.4
@@ -22,5 +29,25 @@ robotframework-selenium2screenshots = 0.8.1
 robotsuite = 2.2.1
 selenium = 3.141.0
 
-[code-analysis]
-directory= ${buildout:directory}/src/collective/collectionfilter
+[versions:python27]
+# to get codeanalysis working
+build = 0.1
+coverage = 5.5
+
+# Required by:
+# build==0.1.0
+packaging = 20.8
+contextlib2 = 0.6.0.post1
+
+# Required by:
+# build==0.1.0
+typing = 3.7.4.3
+
+
+flake8 = 3.9.2
+configparser = <5.0.0
+
+flake8-pep3101 = 0.6
+flake8-commas = 0.1.6
+flake8-isort = 1.3
+flake8-deprecated = 1.0

buildout.cfg

@@ -63,3 +63,7 @@ eggs =
 scripts =
    plone-compile-resources
 #   zopepy
+
+
+[instance]
+eggs+= plone.staticresources

setup.py

@@ -52,6 +52,10 @@ def read(*rnames):
         "plone.app.contenttypes",
     ],
     extras_require={
+        "mosaic": [
+            "plone.app.mosaic >= 2.2.3",
+            "plone.app.standardtiles >= 2.4.0",
+        ],
         "geolocation": [
             # support for latitude/longitude catalog index
             "collective.geolocationbehavior >= 1.6.0",