MOD-1080: Removed the duplicated "no value" option of the style_template field

Author: chris-adam

.github/workflows/python-package.yml

@@ -1,8 +1,7 @@
-# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# This workflow will install Python dependencies, run tests and lint
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
 name: Push tests
-# run-name: ${{ github.actor }} push tests
 
 on:
   push:
@@ -11,14 +10,6 @@ on:
 jobs:
   test:
     runs-on: ubuntu-24.04
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - python: 3.10.11
-            plone: "6.0"
-          # - python: 3.13.1
-          #   plone: "6.1"
     services:
       libreoffice:
         image: harbor.imio.be/library/libreoffice:7.3
@@ -40,71 +31,22 @@ jobs:
       - name: Set up pyenv and Python
         uses: "gabrielfalcao/pyenv-action@v18"
         with:
-          default: "${{ matrix.python }}"
+          default: "3.13.1"
       - name: Setup Python env
         run: |
           pip install --upgrade pip
-          pip install -r requirements-${{ matrix.plone }}.txt
-      - name: Cache eggs
-        uses: actions/cache@v4
-        env:
-          cache-name: cache-eggs
-        with:
-          path: ~/buildout-cache/eggs
-          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ matrix.python }}-${{ matrix.plone }}
-      - name: buildout
-        run: |
-          sed -ie "s#test.cfg#test-${{matrix.plone}}.cfg#" gha.cfg
-          buildout -c gha.cfg annotate
-          buildout -c gha.cfg
-      - name: test
-        run: |
-          bin/test -t !robot
-  coverage:
-    runs-on: ubuntu-24.04
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - python: 3.13.1
-            plone: "6.1"
-    services:
-      libreoffice:
-        image: harbor.imio.be/library/libreoffice:7.3
-        ports:
-          - 2002:2002
-        volumes:
-          - /tmp:/tmp
-          - /var/tmp:/var/tmp
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Setup Env
-        run: |
-          mkdir -p -m 777 /tmp/appy/
-          sudo add-apt-repository ppa:libreoffice/ppa -y
-          sudo apt update -qq -y
-          sudo apt-get install -qq -y libreoffice libreoffice-script-provider-python
-          mkdir -p buildout-cache/{eggs,downloads}
-      - name: Set up pyenv and Python
-        uses: "gabrielfalcao/pyenv-action@v18"
-        with:
-          default: "${{ matrix.python }}"
-      - name: Setup Python env
-        run: |
-          pip install --upgrade pip
-          pip install -r requirements-${{ matrix.plone }}.txt
+          pip install -r requirements-6.1.txt
           pip install -U coveralls
       - name: Cache eggs
         uses: actions/cache@v4
         env:
           cache-name: cache-eggs
         with:
           path: ~/buildout-cache/eggs
-          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ matrix.python }}-${{ matrix.plone }}
+          key: ${{ runner.os }}-test-${{ env.cache-name }}-3.13.1-6.1
       - name: buildout
         run: |
-          sed -ie "s#test.cfg#test-${{matrix.plone}}.cfg#" gha.cfg
+          buildout -c gha.cfg annotate
           buildout -c gha.cfg
       - name: code-analysis
         run: |

.gitignore

@@ -54,3 +54,9 @@ CACHEDIR.TAG
 temp_auto_push.bat
 temp_interactive_push.bat
 .gitignore
+
+# Buildout / pyenv
+.plone-version
+.plone.versioncheck.tracked.json
+.python-version
+checkversion*.html

CHANGES.rst

@@ -6,6 +6,12 @@ Changelog
 
 - Removed `.` at the end of field title `Templates to merge` and field title `Context variables`.
   [gbastien]
+- Removed the duplicated "no value" option of the `style_template` field.
+  [chris-adam]
+- Dropped Plone 6.0 support: only Plone 6.1 / Python 3.13 is supported.
+  [chris-adam]
+- Reorganized the buildout configuration files and Makefile.
+  [chris-adam]
 
 4.0 (2025-08-26)
 ----------------

Makefile

@@ -1,49 +1,116 @@
 #!/usr/bin/make
-#
-lo_version="7.3"
+# pyenv is a requirement, with the 3.13 python version, and virtualenv installed in it
+# plone parameter must be passed to create environment 'make setup plone=6.1' or after a make cleanall
+# The original Makefile can be found on https://github.com/IMIO/scripts-buildout
 
-args = $(filter-out $@,$(MAKECMDGOALS))
+SHELL=/bin/bash
+plones=6.1
+lo_version=7.3
+b_o=
+old_plone=$(shell [ -e .plone-version ] && cat .plone-version)
+
+ifeq (, $(shell which pyenv))
+  $(error "pyenv command not found! Aborting")
+endif
+
+ifndef plone
+ifeq (,$(filter setup,$(MAKECMDGOALS)))
+  plone=$(old_plone)
+endif
+endif
+
+ifneq ($(wildcard bin/instance),)
+    b_o=-N
+endif
+
+ifndef python
+ifeq ($(plone),6.1)
+  python=3.13
+endif
+endif
 
 all: run
-py:=3.9
 
-.PHONY: bootstrap buildout run test cleanall startlibreoffice stoplibreoffice
-bootstrap:
-	virtualenv -p python$(py) .
-	bin/pip install -r requirements.txt
+.PHONY: help
+help:
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n\nTargets:\n"} /^[a-zA-Z_-]+:.*?##/ { printf "  \033[36m%-18s\033[0m %s\n", $$1, $$2 }' $(MAKEFILE_LIST)
 
-buildout:
-	if ! test -f bin/buildout;then make bootstrap;fi
-	bin/buildout -Nt 5
+.python-version:  ## Setups pyenv version
+	@pyenv local `pyenv versions |grep "  $(python)" |tail -1 |xargs`
+	@echo "Local pyenv version is `cat .python-version`"
+	@ if [[ `pyenv which virtualenv` != `pyenv prefix`* ]] ; then echo "You need to install virtualenv in `cat .python-version` pyenv python (pip install virtualenv)"; exit 1; fi
 
-run:
-	if ! test -f bin/instance;then make buildout;fi
+bin/buildout: .python-version  ## Setups environment
+	virtualenv .
+	./bin/pip install --upgrade pip
+	./bin/pip install -r requirements-$(plone).txt
+	@echo "$(plone)" > .plone-version
+
+.PHONY: setup
+setup: oneof-plone backup cleanall bin/buildout restore  ## Setups environment for the given plone= version
+
+.PHONY: buildout
+buildout: oneof-plone bin/buildout  ## Runs setup and buildout
+	bin/buildout -t 5 -c test-$(plone).cfg ${b_o}
+
+.PHONY: run
+run: buildout  ## Starts the instance in foreground
 	mkdir -p var/tmp
-	make startlibreoffice
+	$(MAKE) startlibreoffice
 	bin/instance fg
 
-test:
-	if ! test -f bin/test;then make buildout;fi
-	make startlibreoffice
+.PHONY: test
+test: oneof-plone bin/buildout  ## Runs the tests without robot
+	# can be run by example with: make test opt='-t "settings"'
+	$(MAKE) startlibreoffice
 	rm -fr htmlcov
 	bin/translation-manage -c
-	if test -z "$(args)" ;then bin/test;else bin/test -t $(args);fi
-	make stoplibreoffice
-
-cleanall:
-	rm -fr bin develop-eggs devel htmlcov include .installed.cfg lib .mr.developer.cfg parts downloads eggs local
-
-startlibreoffice:
-	make stoplibreoffice
-	docker run -p 2002:2002\
- 			   -d \
- 			   --rm \
- 			   --pull always \
- 			   --name="oo_server" \
- 			   -v /tmp:/tmp \
- 			   -v /var/tmp:/var/tmp \
- 			   harbor.imio.be/library/libreoffice:$(lo_version)
+	bin/test -t \!robot ${opt}
+	$(MAKE) stoplibreoffice
+
+.PHONY: cleanall
+cleanall:  ## Cleans all installed buildout files
+	rm -fr bin include lib local share develop-eggs downloads eggs parts htmlcov .installed.cfg .mr.developer.cfg .python-version pyvenv.cfg
+
+.PHONY: backup
+backup:  ## Backups db files
+	@if [ '$(old_plone)' != '' ] && [ -f var/filestorage/Data.fs ]; then mv var/filestorage/Data.fs var/filestorage/Data.fs.$(old_plone); mv var/blobstorage var/blobstorage.$(old_plone); fi
+
+.PHONY: restore
+restore:  ## Restores db files
+	@if [ '$(plone)' != '' ] && [ -f var/filestorage/Data.fs.$(plone) ]; then mv var/filestorage/Data.fs.$(plone) var/filestorage/Data.fs; mv var/blobstorage.$(plone) var/blobstorage; fi
+
+.PHONY: which-python
+which-python: oneof-plone  ## Displays versions information
+	@echo "current plone = $(old_plone)"
+	@echo "current python = `cat .python-version`"
+	@echo "plone var = $(plone)"
+	@echo "python var = $(python)"
+
+.PHONY: vcr
+vcr:  ## Shows requirements in checkversion-r.html
+	@bin/versioncheck -rbo checkversion-r-$(plone).html test-$(plone).cfg
+
+.PHONY: vcn
+vcn:  ## Shows newer packages in checkversion-n.html
+	@bin/versioncheck -npbo checkversion-n-$(plone).html test-$(plone).cfg
+
+.PHONY: startlibreoffice
+startlibreoffice:  ## Starts the LibreOffice server container
+	$(MAKE) stoplibreoffice
+	docker run -p 2002:2002 -d --rm --pull always --name="oo_server" \
+		-v /tmp:/tmp -v /var/tmp:/var/tmp \
+		harbor.imio.be/library/libreoffice:$(lo_version)
 	docker ps
 
-stoplibreoffice:
+.PHONY: stoplibreoffice
+stoplibreoffice:  ## Stops the LibreOffice server container
 	if docker ps | grep oo_server;then docker stop oo_server;fi
+
+.PHONY: guard-%
+guard-%:
+	@ if [ "${${*}}" = "" ]; then echo "You must give a value for variable '$*' : like $*=xxx"; exit 1; fi
+
+.PHONY: oneof-%
+oneof-%:
+	@ if ! echo "${${*}s}" | tr " " '\n' |grep -Fqx "${${*}}"; then echo "Invalid '$*' parameter ('${${*}}') : must be one of '${${*}s}'"; exit 1; fi

base.cfg

@@ -2,21 +2,33 @@
 package-name = collective.documentgenerator
 package-extras = [test]
 
+extends =
+    https://raw.github.com/collective/buildout.plonetest/master/qa.cfg
+    checkouts.cfg
+
 show-picked-versions = true
 allow-picked-versions = true
 
 develop = .
 
-eggs +=
-    Pillow
-
 extensions +=
     mr.developer
+    plone.versioncheck
 
-always-checkout = force
-sources = sources
+parts +=
+    instance
+    omelette
+    translation
+    test
+    robot
+    createcoverage
+    ploneversioncheck
 
-sources-dir = devel
+eggs +=
+    Pillow
+    plone.reload
+    Products.PDBDebugMode
+    ipdb
 
 [debug]
 eggs =
@@ -25,3 +37,81 @@ eggs =
     profilehooks
 zcml =
     iw.debug
+
+[instance]
+eggs +=
+    ${debug:eggs}
+zcml +=
+    ${debug:zcml}
+
+environment-vars =
+  PYTHON_EGG_CACHE ${buildout:directory}/python-eggs
+  zope_i18n_compile_mo_files true
+  PYTHON_UNO /usr/bin/python3
+  CUSTOM_TMP /tmp/appy
+  ACTIVE_BIGBANG True
+  PLONE_EXTENSION_IDS plonetheme.barceloneta:default,plone.app.caching:default,collective.documentgenerator:demo
+
+[omelette]
+recipe = collective.recipe.omelette
+eggs = ${test:eggs}
+
+[translation]
+recipe = infrae.i18nextract
+packages = ${buildout:package-name}
+output = ${buildout:directory}/src/collective/documentgenerator/locales
+output-package = ${buildout:package-name}
+domain = ${buildout:package-name}
+
+[test]
+recipe = zc.recipe.testrunner
+eggs =
+    ${buildout:eggs}
+    ${buildout:package-name} ${buildout:package-extras}
+    ${debug:eggs}
+zcml =
+    ${debug:zcml}
+defaults = ['-s', '${buildout:package-name}', '--auto-color', '--auto-progress']
+environment = testenv
+
+[testenv]
+zope_i18n_compile_mo_files = true
+OO_PORT = 2002
+PYTHON_UNO = /usr/bin/python3
+CUSTOM_TMP = /tmp/appy
+USE_STREAM = False
+
+[robot]
+recipe = zc.recipe.egg
+eggs =
+    Pillow
+    ${test:eggs}
+    plone.app.robotframework[reload]
+
+[ploneversioncheck]
+recipe = zc.recipe.egg
+eggs = plone.versioncheck
+
+[code-analysis]
+flake8-max-complexity = 50
+flake8-ignore = E501, W503, W504, E203, Q000, C812
+directory = ${buildout:directory}/src/collective/documentgenerator
+flake8-extensions =
+    flake8-isort
+
+[coverage]
+recipe = zc.recipe.egg
+eggs = coverage
+
+[test-coverage]
+recipe = collective.recipe.template
+input = inline:
+    #!/bin/bash
+    export TZ=UTC
+    ${buildout:directory}/bin/coverage run bin/test $*
+    ${buildout:directory}/bin/coverage html
+    ${buildout:directory}/bin/coverage report -m --fail-under=90
+    # Fail (exit status 1) if coverage returns exit status 2 (this happens
+    # when test coverage is below 100%.
+output = ${buildout:directory}/bin/test-coverage
+mode = 755