Merge pull request #112 from plone/7.x-fix-searchabletext-indexer

Fix disabled SearchableText indexer [7.x]

Author: mauritsvanrees

.github/workflows/tests.yml

@@ -13,19 +13,18 @@ jobs:
       fail-fast: false
       matrix:
         python:
-          - "3.8"
-          - "3.9"
           - "3.10"
-          - "3.11"
+          - "3.13"
         plone:
           - "6.0-latest"
+          - "6.1-latest"
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v6
 
       - name: Setup Plone ${{ matrix.plone }} with Python ${{ matrix.python }}
         id: setup
-        uses: plone/setup-plone@v1.0.0
+        uses: plone/setup-plone@v3.0.0
         with:
           python-version: ${{ matrix.python }}
           plone-version: ${{ matrix.plone }}

.gitignore

@@ -25,6 +25,7 @@ src/
 /instance/
 /.make-sentinels/
 /*-mxdev.txt
+/.mxdev_cache
 /reports/
 /sources/
 /venv/

CHANGES.rst

@@ -4,7 +4,8 @@ Changelog
 7.0.2 (unreleased)
 ------------------
 
-- Nothing changed yet.
+- Fix ``IDynamicTextIndexExtender`` adapter registration and remove obsolete ``collective.textindexer`` checks.
+  [petschki]
 
 
 7.0.1 (2023-11-16)

Makefile

@@ -47,19 +47,7 @@ INSTANCE_FOLDER=instance
 PIP_PARAMS= --pre
 
 ##############################################################################
-# targets and prerequisites
-# target has to be one file, otherwise step gets executes for each file separate
-PREPARE_PREREQUISITES=${PIP_REQUIREMENTS_IN_FILE} ${CONSTRAINTS_IN} sources.ini ${ADDONBASE}setup.cfg
-PREPARE_TARGET=requirements-mxdev.txt
-INSTALL_PREREQUSISTES=${PREPARE_TARGET}
-INSTALL_TARGET=.installed.txt
-INSTANCE_PREREQUISITES=${INSTALL_TARGET} ${INSTANCE_YAML}
-INSTANCE_TARGET=${INSTANCE_FOLDER}/etc/zope.ini ${INSTANCE_FOLDER}/etc/zope.conf ${INSTANCE_FOLDER}/etc/site.zcml
-TEST_PREREQUISITES=${INSTALL_TARGET}
-RUN_PREREQUISITES=${INSTANCE_TARGET}
-
-##############################################################################
-# CONVINIENCE
+# CONVENIENCE
 
 # install and run
 .PHONY: all # full install, test and run
@@ -123,7 +111,7 @@ ifeq (, $(shell which $(PYTHON) ))
 endif
 
 # version ok?
-PYTHON_VERSION_MIN=3.7
+PYTHON_VERSION_MIN=3.9
 PYTHON_VERSION_OK=$(shell $(PYTHON) -c 'import sys; print(int(sys.version_info[0:2] >= tuple(map(int, "$(PYTHON_VERSION_MIN)".split(".")))))' )
 
 ifeq ($(PYTHON_VERSION_OK),0)

README.rst

@@ -143,3 +143,19 @@ To make use of the page site layout, use the following:
 
 See ``rendering.rst`` for detailed examples of how the processing is applied,
 and ``esi.rst`` for details about how Edge Side Includes can be supported.
+
+
+Indexing
+========
+
+``plone.app.blocks`` provides a ``IDynamicTextIndexExtender`` adapter that extracts text from the blocks/tiles rendered within the content layout.
+This indexer adapter is only active when **both** of the following behaviors are enabled on the content type:
+
+``plone.layoutaware``
+    Enables the layout-aware content support (see above).
+
+``plone.textindexer``
+    Enables the extensible text indexing provided by ``plone.app.dexterity``.
+
+If either behavior is missing, the ``SearchableText`` index will **not** include text from the rendered blocks.
+Make sure both behaviors are activated in the FTI (Factory Type Information) of your content type, for example via GenericSetup or the Dexterity control panel.

plone/app/blocks/__init__.py

@@ -1,4 +1,3 @@
 from zope.i18nmessageid import MessageFactory
 
-
 PloneMessageFactory = MessageFactory("plone")

plone/app/blocks/configure.zcml

@@ -215,24 +215,9 @@
              zope.lifecycleevent.interfaces.IObjectModifiedEvent"
         handler=".subscribers.onLayoutEdited" />
 
-    <meta:provides feature="textindexer"
-       zcml:condition="installed plone.app.dexterity.textindexer"
-    />
-
-    <meta:provides feature="textindexer"
-       zcml:condition="installed collective.dexteritytextindexer"
-    />
-
-    <adapter
-        name="SearchableText"
-        factory=".indexing.LayoutSearchableText"
-        zcml:condition="not-have textindexer"
-        />
-
     <adapter
         name="content"
         factory=".indexing.LayoutSearchableTextIndexExtender"
-        zcml:condition="installed collective.dexteritytextindexer"
         />
 
     <adapter factory=".linkintegrity.BlocksDXGeneral" />

plone/app/blocks/indexing.py

@@ -2,38 +2,16 @@
 from plone.app.blocks.layoutbehavior import ILayoutAware
 from plone.app.blocks.layoutbehavior import ILayoutBehaviorAdaptable
 from plone.app.contenttypes import indexers
+from plone.app.dexterity.textindexer.interfaces import IDynamicTextIndexExtender
 from plone.base.utils import safe_text
-from plone.indexer.decorator import indexer
 from plone.tiles.data import ANNOTATIONS_KEY_PREFIX
 from zope.annotation.interfaces import IAnnotations
 from zope.component import adapter
 from zope.interface import implementer
 
-
-HAS_DEXTERITYTEXTINDEXER = False
-
-try:
-    from collective.dexteritytextindexer.interfaces import (  # noqa
-        IDynamicTextIndexExtender,
-    )
-
-    HAS_DEXTERITYTEXTINDEXER = True
-except ImportError:
-    pass
-
-try:
-    from plone.app.dexterity.textindexer.interfaces import (  # noqa
-        IDynamicTextIndexExtender,
-    )
-
-    HAS_DEXTERITYTEXTINDEXER = True
-except ImportError:
-    pass
-
 concat = indexers._unicode_save_string_concat
 
 
-@indexer(ILayoutBehaviorAdaptable)
 def LayoutSearchableText(obj):
     text = [obj.id]
     try:
@@ -77,13 +55,11 @@ def LayoutSearchableText(obj):
     return concat(*set(text))
 
 
-if HAS_DEXTERITYTEXTINDEXER:
-
-    @implementer(IDynamicTextIndexExtender)
-    @adapter(ILayoutBehaviorAdaptable)
-    class LayoutSearchableTextIndexExtender:
-        def __init__(self, context):
-            self.context = context
+@implementer(IDynamicTextIndexExtender)
+@adapter(ILayoutBehaviorAdaptable)
+class LayoutSearchableTextIndexExtender:
+    def __init__(self, context):
+        self.context = context
 
-        def __call__(self):
-            return LayoutSearchableText(self.context)()
+    def __call__(self):
+        return LayoutSearchableText(self.context)

plone/app/blocks/interfaces.py

@@ -4,7 +4,6 @@
 from zope.interface import Attribute
 from zope.interface import Interface
 
-
 SITE_LAYOUT_RESOURCE_NAME = "sitelayout"
 CONTENT_LAYOUT_RESOURCE_NAME = "contentlayout"
 

plone/app/blocks/layoutbehavior.py

@@ -37,7 +37,6 @@
 import json
 import logging
 
-
 logger = logging.getLogger("plone.app.blocks")