feat: add php scoper

.github/workflows/quality-check.yml

@@ -69,7 +69,7 @@ jobs:
           path: vendor
           key: php-${{ hashFiles('composer.lock') }}
       - name: PHPStan PrestaShop ${{ matrix.ps_version }}
-        run: PS_VERSION="${{ matrix.ps_version }}" make phpstan
+        run: PS_VERSION="${{ matrix.ps_version }}" make docker-phpstan
 
   phpunit:
     name: PHP Unit

.gitignore

@@ -16,6 +16,7 @@ composer.phar
 .php_cs
 install.lock
 composer-setup.php
+php-scoper.phar
 
 # Mac OS
 .DS_Store

.zip-contents

@@ -9,3 +9,5 @@ logo.png
 config.xml
 LICENCE
 README.md
+composer.json
+composer.lock

Makefile

@@ -6,35 +6,52 @@ MODULE_NAME = ps_eventbus
 PACKAGE ?= ${MODULE_NAME}-${VERSION}
 PHP_VERSION ?= 8.1
 PS_VERSION ?= 8.1.3
-TESTING_IMAGE ?= prestashop/prestashop-flashlight:${PS_VERSION}-${PHP_VERSION}
+TESTING_IMAGE ?= prestashop/prestashop-flashlight:${PS_VERSION}
 PS_ROOT_DIR ?= $(shell pwd)/prestashop/prestashop-${PS_VERSION}
+PHP_SCOPER_DIR=php-scoper
 export PATH := ./vendor/bin:./tools/vendor/bin:$(PATH)
 
 define replace_version
-sed -i.bak -e "s/\(VERSION = \).*/\1\'${2}\';/" ${1}/${MODULE_NAME}.php
-sed -i.bak -e "s/\($this->version = \).*/\1\'${2}\';/" ${1}/${MODULE_NAME}.php
-sed -i.bak -e "s|\(<version><!\[CDATA\[\)[0-9a-z.-]\{1,\}]]></version>|\1${2}]]></version>|" ${1}/config.xml
-rm -f ${1}/${MODULE_NAME}.php.bak ${1}/config.xml.bak
+	sed -i.bak -e "s/\(VERSION = \).*/\1\'${2}\';/" ${1}/${MODULE_NAME}.php
+	sed -i.bak -e "s/\($this->version = \).*/\1\'${2}\';/" ${1}/${MODULE_NAME}.php
+	sed -i.bak -e "s|\(<version><!\[CDATA\[\)[0-9a-z.-]\{1,\}]]></version>|\1${2}]]></version>|" ${1}/config.xml
+	rm -f ${1}/${MODULE_NAME}.php.bak ${1}/config.xml.bak
+endef
+
+define create_module
+	$(eval TMP_DIR := $(shell mktemp -d))
+	mkdir -p ${TMP_DIR}/tmp;
+	cp -r $(shell cat .zip-contents) ${TMP_DIR}/tmp;
+	VERSION=${PACKAGE} TMP_FOLDER=${TMP_DIR}/tmp php php-scoper.phar add-prefix --output-dir=${TMP_DIR}/${MODULE_NAME} --force
+	$(call replace_version,${TMP_DIR}/${MODULE_NAME},${SEM_VERSION})
+	./tools/vendor/bin/autoindex prestashop:add:index ${TMP_DIR}
+	cp $1 ${TMP_DIR}/${MODULE_NAME}/config/parameters.yml
+	cd ${TMP_DIR}/${MODULE_NAME} && composer dump-autoload
+	SCOPER_FOLDER=${TMP_DIR}/${MODULE_NAME} php php-scoper-fix.php
+
+	echo ${TMP_DIR}
 endef
 
 define zip_it
-$(eval TMP_DIR := $(shell mktemp -d))
-mkdir -p ${TMP_DIR}/${MODULE_NAME};
-cp -r $(shell cat .zip-contents) ${TMP_DIR}/${MODULE_NAME};
-$(call replace_version,${TMP_DIR}/${MODULE_NAME},${SEM_VERSION})
-./tools/vendor/bin/autoindex prestashop:add:index ${TMP_DIR}
-cp $1 ${TMP_DIR}/${MODULE_NAME}/config/parameters.yml;
-cd ${TMP_DIR} && zip -9 -r $2 ./${MODULE_NAME};
-mv ${TMP_DIR}/$2 ./dist;
-rm -rf ${TMP_DIR:-/dev/null};
+	TMP_DIR=$(call create_module,$1)
+	cd ${TMP_DIR} && zip -9 -r $2 ./${MODULE_NAME};
+	mv ${TMP_DIR}/$2 ./dist;
+	rm -rf ${TMP_DIR:-/dev/null};
+endef
+
+define no_zip_it
+	rm -rf ./dist/${MODULE_NAME}
+	TMP_DIR=$(call create_module,$1)
+	mv ${TMP_DIR}/${MODULE_NAME} ./dist;
+	rm -rf ${TMP_DIR:-/dev/null};
 endef
 
 define in_docker
-docker run \
---env _PS_ROOT_DIR_=/var/www/html \
---workdir /var/www/html/modules/${MODULE_NAME} \
---volume $(shell pwd):/var/www/html/modules/${MODULE_NAME}:rw \
---entrypoint $1 ${TESTING_IMAGE} $2
+	docker run \
+	--env _PS_ROOT_DIR_=/var/www/html \
+	--workdir /var/www/html/modules/${MODULE_NAME} \
+	--volume $(shell pwd):/var/www/html/modules/${MODULE_NAME}:rw \
+	--entrypoint $1 ${TESTING_IMAGE} $2
 endef
 
 # target: default                                              - Calling build by default
@@ -45,8 +62,8 @@ default: build
 help:
 	@egrep "^#" Makefile
 
-# target: clean 
-.PHONY: clean                                               - Clean up the repository
+# target: clean                                                - Clean up the repository
+.PHONY: clean                                               
 clean:
 	git -c core.excludesfile=/dev/null clean -X -d -f
 
@@ -63,19 +80,24 @@ dist:
 
 # target: zip-e2e                                              - Bundle a local E2E integrable zip
 .PHONY: zip-e2e
-zip-e2e: vendor tools/vendor dist
+zip-e2e: php-scoper.phar vendor tools/vendor dist
 	@$(call zip_it,./config/parameters.yml,${PACKAGE}_e2e.zip)
 
 # target: zip-inte                                             - Bundle an integration zip
 .PHONY: zip-inte
-zip-inte: vendor tools/vendor dist
+zip-inte: php-scoper.phar vendor tools/vendor dist
 	@$(call zip_it,.config.inte.yml,${PACKAGE}_integration.zip)
 
 # target: zip-prod                                             - Bundle a production zip
 .PHONY: zip-prod
-zip-prod: vendor tools/vendor dist
+zip-prod: php-scoper.phar vendor tools/vendor dist
 	@$(call zip_it,.config.prod.yml,${PACKAGE}.zip)
 
+# target: zip-unzipped                                          - Bundle a production module, but without zip step (only to check sources)
+.PHONY: zip-unzipped
+zip-unzipped: php-scoper.phar vendor tools/vendor dist
+	@$(call no_zip_it,.config.prod.yml)
+
 # target: build                                                - Setup PHP & Node.js locally
 .PHONY: build
 build: vendor tools/vendor
@@ -181,14 +203,17 @@ phpstan-baseline: prestashop/prestashop-${PS_VERSION} phpstan
 .PHONY: docker-test
 docker-test: docker-lint docker-phpstan docker-phpunit
 
+php-scoper.phar:
+	@php -r "copy('https://github.com/humbug/php-scoper/releases/latest/download/php-scoper.phar', 'php-scoper.phar');";
+
 define COMMENT
-Fixme: add "allure-framework/allure-phpunit" in composer.json to solve this.
-Currently failing to resolve devDeps:
-  - allure-framework/allure-phpunit v2.1.0 requires phpunit/phpunit ^9 -> found phpunit/phpunit[9.0.0, ..., 9.6.4] but it conflicts with your root composer.json require (^10.0.14).
-allure:
-	./node_modules/.bin/allure serve build/allure-results/
-
-allure-report:
-	./node_modules/.bin/allure generate build/allure-results/
+	Fixme: add "allure-framework/allure-phpunit" in composer.json to solve this.
+	Currently failing to resolve devDeps:
+	- allure-framework/allure-phpunit v2.1.0 requires phpunit/phpunit ^9 -> found phpunit/phpunit[9.0.0, ..., 9.6.4] but it conflicts with your root composer.json require (^10.0.14).
+	allure:
+		./node_modules/.bin/allure serve build/allure-results/
+
+	allure-report:
+		./node_modules/.bin/allure generate build/allure-results/
 endef
 

composer.json

@@ -38,14 +38,13 @@
     "ext-json": "*",
     "monolog/monolog": "^1.27",
     "prestashop/module-lib-service-container": "^2.0",
-    "prestashop/module-lib-guzzle-adapter": "v0.6",
-    "prestashop/prestashop-accounts-installer": "^1.0.0",
     "sentry/sentry": "^1.11.0",
     "php-http/message": "<1.15.0",
     "psr/http-message": "<1.1",
     "symfony/config": "^3.4",
     "symfony/dependency-injection": "^3.4",
     "symfony/yaml": "^3.4",
-    "prestashop/module-lib-mbo-installer": "^0.1.0"
+    "prestashop/module-lib-mbo-installer": "^0.1.0",
+    "guzzlehttp/guzzle": "^6.5"
   }
 }