chore: require PHP 8.2, adopt Mago for quality checks, and refactor codebase

Author: nicolaasuni

.github/workflows/check.yml

@@ -23,7 +23,7 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                php-version: ["8.1", "8.2", "8.3", "8.4", "8.5"]
+                php-version: ["8.2", "8.3", "8.4", "8.5"]
                 experimental: [false]
                 os: [ubuntu-latest]
                 coverage-extension: [pcov]
@@ -46,6 +46,8 @@ jobs:
                   path: ~/.composer/cache/
                   key: composer-cache
             - name: Install dependencies
+              env:
+                GH_TOKEN: ${{ github.token }}
               run: make deps
             - name: Run all tests
               run: make qa

CONTRIBUTING.md

@@ -40,7 +40,7 @@ Please follow the [Security Policy](SECURITY.md) and report them privately.
 
 ### Requirements
 
-- PHP **≥ 8.1**
+- PHP **≥ 8.2**
 - [Composer](https://getcomposer.org/) v2
 - `make`, `git`
 - Optional: `rpmbuild` (RPM packaging), `dpkg-buildpackage` (DEB packaging)
@@ -120,8 +120,8 @@ The `Makefile` exposes all common development tasks:
 |---------|-------------|
 | `make qa` | Run linting, static analysis, tests, and reports |
 | `make test` | Run PHPUnit with code coverage |
-| `make lint` | Check coding standards (PHPCS, PHPMD, PHPStan) |
-| `make codefix` | Auto-fix coding standard violations (PHPCBF) |
+| `make lint` | Check coding standards |
+| `make format` | Auto-format the code |
 | `make buildall` | Install dependencies, fix style, run QA, and build packages |
 | `make clean` | Remove `vendor/` and `target/` directories |
 | `make server` | Start the built-in PHP development server for the examples |
@@ -133,8 +133,8 @@ Run `make help` to see the full list of available targets.
 ## Coding Standards
 
 - The codebase follows **PSR-12** for formatting.
-- Run `make codefix` to auto-fix style violations before committing.
-- Run `make lint` to catch remaining issues (PHPCS, PHPMD, PHPStan).
+- Run `make format` to auto-format the code.
+- Run `make lint` to catch remaining issues.
 - All source files live under `src/`, all tests under `test/`.
 - Use strict types and explicit visibility on all class members.
 - Avoid introducing new external dependencies without prior discussion.

Makefile

@@ -92,9 +92,6 @@ COMPOSER=$(PHP) -d "apc.enable_cli=0" $(shell which composer)
 # phpDocumentor executable file
 PHPDOC=$(shell which phpDocumentor)
 
-# phpstan version
-PHPSTANVER=2.1.40
-
 # --- MAKE TARGETS ---
 
 # Display general help about this command
@@ -120,7 +117,7 @@ x: buildall
 
 ## Full build and test sequence
 .PHONY: buildall
-buildall: deps codefix qa bz2 rpm deb
+buildall: deps format qa bz2 rpm deb
 
 ## Package the library in a compressed bz2 archive
 .PHONY: bz2
@@ -134,11 +131,6 @@ bz2:
 clean:
 	rm -rf ./vendor $(TARGETDIR)
 
-## Fix code style violations
-.PHONY: codefix
-codefix:
-	./vendor/bin/phpcbf --ignore="\./vendor/" --standard=psr12 src test
-
 ## Build a DEB package for Debian-like Linux distributions
 .PHONY: deb
 deb:
@@ -171,8 +163,7 @@ endif
 deps: ensuretarget
 	rm -rf ./vendor/*
 	($(COMPOSER) install -vvv --no-interaction)
-	curl --silent --show-error --fail --location --output ./vendor/phpstan.phar https://github.com/phpstan/phpstan/releases/download/${PHPSTANVER}/phpstan.phar \
-	&& chmod +x ./vendor/phpstan.phar
+	curl --proto '=https' --tlsv1.2 --silent --show-error --fail --location https://carthage.software/mago.sh | bash -s -- --install-dir=./vendor/bin
 
 ## Generate source code documentation
 .PHONY: doc
@@ -209,13 +200,18 @@ ifneq ($(strip $(CONFIGPATH)),)
 	find $(PATHINSTCFG) -type f -exec chmod 644 {} \;
 endif
 
-## Test source code for coding standard violations
+## Format the source code
+.PHONY: format
+format:
+	./vendor/bin/mago fmt src test
+
+## Analyze and Lint the source code
 .PHONY: lint
 lint:
-	./vendor/bin/phpcs --standard=phpcs.xml
-	./vendor/bin/phpmd src text codesize,unusedcode,naming,design --exclude */vendor/*
-	./vendor/bin/phpmd test text unusedcode,naming,design --exclude */vendor/*
-	php -r 'exit((int)version_compare(PHP_MAJOR_VERSION, "7", ">"));' || ./vendor/phpstan.phar analyse
+	./vendor/bin/mago --config ./mago.src.toml analyze src
+	./vendor/bin/mago --config ./mago.test.toml analyze test
+	./vendor/bin/mago --config ./mago.src.toml lint src
+	./vendor/bin/mago --config ./mago.test.toml lint test
 
 ## Run all tests and reports
 .PHONY: qa

README.md

@@ -46,7 +46,7 @@ The parser is designed for tooling scenarios such as content inspection, metadat
 
 ## Requirements
 
-- PHP 8.1 or later
+- PHP 8.2 or later
 - Extension: `pcre`
 - Composer
 

VERSION

@@ -1 +1 @@
-3.1.2
+3.2.0

composer.json

@@ -1,63 +1,63 @@
 {
-  "name": "tecnickcom/tc-lib-pdf-parser",
-  "description": "PHP library to parse PDF documents",
-  "type": "library",
-  "homepage": "https://tcpdf.org",
-  "license": "LGPL-3.0-or-later",
-  "keywords": [
-    "tc-lib-pdf-parser",
-    "PDF",
-    "parser",
-    "document"
-  ],
-  "authors": [
-    {
-      "name": "Nicola Asuni",
-      "email": "info@tecnick.com",
-      "role": "lead"
+    "name": "tecnickcom/tc-lib-pdf-parser",
+    "description": "PHP library to parse PDF documents",
+    "type": "library",
+    "homepage": "https://tcpdf.org",
+    "license": "LGPL-3.0-or-later",
+    "keywords": [
+        "tc-lib-pdf-parser",
+        "PDF",
+        "parser",
+        "document"
+    ],
+    "authors": [
+        {
+            "name": "Nicola Asuni",
+            "email": "info@tecnick.com",
+            "role": "lead"
+        }
+    ],
+    "funding": [
+        {
+            "type": "github",
+            "url": "https://github.com/sponsors/tecnickcom"
+        }
+    ],
+    "require": {
+        "php": ">=8.2",
+        "ext-pcre": "*",
+        "tecnickcom/tc-lib-pdf-filter": "^2.2"
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true,
+    "config": {
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        }
+    },
+    "require-dev": {
+        "pdepend/pdepend": "^2.16",
+        "phpunit/phpunit": "^13.1 || ^12.5 || ^11.5",
+        "phpcompatibility/php-compatibility": "^10.0.0@dev"
+    },
+    "autoload": {
+        "psr-4": {
+            "Com\\Tecnick\\Pdf\\Parser\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Test\\": "test"
+        }
+    },
+    "support": {
+        "issues": "https://github.com/tecnickcom/tc-lib-pdf-parser/issues",
+        "source": "https://github.com/tecnickcom/tc-lib-pdf-parser"
+    },
+    "scripts": {
+        "test": "XDEBUG_MODE=coverage ./vendor/bin/phpunit --stderr test",
+        "cs-check": "./vendor/bin/mago --config ./mago.src.toml lint src && ./vendor/bin/mago --config ./mago.test.toml lint test",
+        "cs-fix": "./vendor/bin/mago fmt src test",
+        "analyse": "./vendor/bin/mago --config ./mago.src.toml analyze src && ./vendor/bin/mago --config ./mago.test.toml analyze test"
     }
-  ],
-  "funding": [
-    {
-      "type": "github",
-      "url": "https://github.com/sponsors/tecnickcom"
-    }
-  ],
-  "require": {
-    "php": ">=8.1",
-    "ext-pcre": "*",
-    "tecnickcom/tc-lib-pdf-filter": "^2.1"
-  },
-  "minimum-stability": "dev",
-  "prefer-stable": true,
-  "config": {
-    "allow-plugins": {
-      "dealerdirect/phpcodesniffer-composer-installer": true
-    }
-  },
-  "require-dev": {
-    "pdepend/pdepend": "^2.16",
-    "phpmd/phpmd": "^2.15",
-    "phpunit/phpunit": "^13.1 || ^12.5 || ^11.5 || ^10.5",
-    "squizlabs/php_codesniffer": "^4.0",
-    "phpcompatibility/php-compatibility": "^10.0.0@dev"
-  },
-  "autoload": {
-    "psr-4": {
-      "Com\\Tecnick\\Pdf\\Parser\\": "src"
-    }
-  },
-  "autoload-dev": {
-    "psr-4": { "Test\\": "test" }
-  },
-  "support": {
-    "issues": "https://github.com/tecnickcom/tc-lib-pdf-parser/issues",
-    "source": "https://github.com/tecnickcom/tc-lib-pdf-parser"
-  },
-  "scripts": {
-    "test": "XDEBUG_MODE=coverage ./vendor/bin/phpunit --stderr test",
-    "cs-check": "./vendor/bin/phpcs --standard=phpcs.xml",
-    "cs-fix": "./vendor/bin/phpcbf --ignore=\"./vendor/\" --standard=psr12 src test",
-    "analyse": "./vendor/phpstan.phar analyse"
-  }
 }

mago.src.toml

@@ -0,0 +1,60 @@
+#:schema https://mago.carthage.software/1.26.0/schema.json
+version = "1"
+php-version = "8.2.0"
+
+[source]
+workspace = "."
+paths = ["src"]
+includes = ["vendor"]
+excludes = []
+
+[source.glob]
+literal-separator = true
+
+[formatter]
+print-width = 120
+tab-width = 4
+use-tabs = false
+
+[linter]
+integrations = []
+
+[linter.rules]
+ambiguous-function-call = { enabled = false }
+literal-named-argument = { enabled = false }
+cyclomatic-complexity = { enabled = false }
+excessive-parameter-list = { enabled = true }
+halstead = { enabled = true, effort-threshold = 12000, difficulty-threshold = 80 }
+identity-comparison = { enabled = true }
+kan-defect = { enabled = false }
+no-boolean-flag-parameter = { enabled = false }
+no-else-clause = { enabled = false }
+no-empty = { enabled = true }
+too-many-methods = { enabled = false }
+no-isset = { enabled = true, allow-array-checks = true }
+
+[analyzer]
+plugins = []
+ignore = [
+	{ code = "string-member-selector", in = ["src/Process/RawObject.php"] },
+	{ code = "imprecise-type", in = ["src/Process/RawObject.php"] },
+]
+find-unused-definitions = true
+find-unused-expressions = true
+analyze-dead-code = true
+memoize-properties = true
+check-throws = true
+unchecked-exceptions = [
+	"Error",
+	"LogicException",
+	"ReflectionException",
+]
+unchecked-exception-classes = []
+check-missing-override = true
+find-unused-parameters = true
+strict-list-index-checks = true
+strict-array-index-existence = true
+allow-array-truthy-operand = false
+no-boolean-literal-comparison = true
+check-missing-type-hints = true
+register-super-globals = true

mago.test.toml

@@ -0,0 +1,66 @@
+#:schema https://mago.carthage.software/1.26.0/schema.json
+version = "1"
+php-version = "8.2.0"
+
+[source]
+workspace = "."
+paths = ["src", "test"]
+includes = ["vendor"]
+excludes = []
+
+[source.glob]
+literal-separator = true
+
+[formatter]
+print-width = 120
+tab-width = 4
+use-tabs = false
+
+[linter]
+integrations = ["phpunit"]
+
+[linter.rules]
+ambiguous-function-call = { enabled = false }
+literal-named-argument = { enabled = false }
+assertion-style = { enabled = false }
+cyclomatic-complexity = { enabled = false }
+excessive-parameter-list = { enabled = false }
+halstead = { enabled = false, effort-threshold = 7000 }
+identity-comparison = { enabled = false }
+kan-defect = { enabled = false }
+no-boolean-flag-parameter = { enabled = false }
+no-else-clause = { enabled = false }
+no-empty = { enabled = false }
+no-empty-catch-clause = { enabled = false }
+no-isset = { enabled = false }
+readable-literal = { enabled = false }
+str-contains = { enabled = false }
+strict-assertions = { enabled = false }
+strict-behavior = { enabled = false }
+strict-types = { enabled = false }
+too-many-methods = { enabled = false }
+
+[analyzer]
+plugins = []
+find-unused-definitions = true
+find-unused-expressions = true
+analyze-dead-code = true
+memoize-properties = true
+check-throws = true
+unchecked-exceptions = [
+	"Error",
+	"LogicException",
+	"ReflectionException",
+	"PHPUnit\\Framework\\Exception",
+	"PHPUnit\\Framework\\ExpectationFailedException",
+	"PHPUnit\\Framework\\UnknownClassOrInterfaceException",
+]
+unchecked-exception-classes = []
+check-missing-override = true
+find-unused-parameters = true
+strict-list-index-checks = true
+strict-array-index-existence = true
+allow-array-truthy-operand = false
+no-boolean-literal-comparison = true
+check-missing-type-hints = true
+register-super-globals = true