Introduced PHP 8 support; removed support for PHP 5.6 + 7.0

.github/workflows/coding-standards.yml

@@ -11,9 +11,6 @@ jobs:
     name: "CS Fixer & PHPStan"
     runs-on: "ubuntu-20.04"
 
-    env:
-      SYMFONY_PHPUNIT_VERSION: 7.5
-
     steps:
       - name: "Checkout"
         uses: "actions/checkout@v2"
@@ -30,14 +27,11 @@ jobs:
       - name: "Install dependencies with Composer"
         uses: "ramsey/composer-install@v1"
 
-      - name: "Install PHPStan"
-        run: "composer require phpstan/phpstan phpstan/phpstan-phpunit --dev --no-progress --no-suggest"
+      - name: "Install dev tools"
+        run: "make install-dev-tools"
 
       - name: "Run PHP CS Fixer"
-        run: "php vendor/bin/php-cs-fixer fix --verbose --dry-run --format=checkstyle | cs2pr"
-
-      - name: "Install PHPUnit for PHPStan"
-        run: "php vendor/bin/simple-phpunit install"
+        run: "make run-php-cs-fixer ARGS="--verbose --dry-run --format=checkstyle" | cs2pr"
 
       - name: "Run PHPStan"
-        run: "php vendor/bin/phpstan analyse --no-progress --error-format=checkstyle | cs2pr"
+        run: "make run-phpstan ARGS="--no-progress --error-format=checkstyle" | cs2pr"

.github/workflows/continuous-integration.yml

@@ -14,15 +14,13 @@ jobs:
     name: "PHPUnit (PHP ${{ matrix.php }})"
     runs-on: "ubuntu-20.04"
 
-    env:
-      SYMFONY_PHPUNIT_VERSION: 7.5
-
     strategy:
       matrix:
         php:
           - "7.2"
           - "7.3"
           - "7.4"
+          - "8.0"
 
     steps:
       - name: "Checkout"
@@ -40,11 +38,11 @@ jobs:
       - name: "Install dependencies with Composer"
         uses: "ramsey/composer-install@v1"
 
-      - name: "Remove PHP-CS-Fixer"
-        run: "composer remove friendsofphp/php-cs-fixer --dev --no-progress --no-update"
+      - name: "Install dev tools"
+        run: "make install-dev-tools"
 
       - name: "Run PHPUnit"
-        run: "php vendor/bin/simple-phpunit -v"
+        run: "make run-phpunit"
 
   phpunit-lower-php:
     name: "PHPUnit (PHP ${{ matrix.php }})"
@@ -53,8 +51,6 @@ jobs:
     strategy:
       matrix:
         php:
-          - "5.6"
-          - "7.0"
           - "7.1"
 
     steps:
@@ -73,19 +69,16 @@ jobs:
       - name: "Install dependencies with Composer"
         uses: "ramsey/composer-install@v1"
 
-      - name: "Remove PHP-CS-Fixer"
-        run: "composer remove friendsofphp/php-cs-fixer --dev --no-progress --no-update"
+      - name: "Install dev tools"
+        run: "make install-dev-tools"
 
       - name: "Run PHPUnit"
-        run: "php vendor/bin/simple-phpunit -v"
+        run: "make run-phpunit"
 
   phpunit-coverage:
     name: "PHPUnit coverage (PHP ${{ matrix.php }})"
     runs-on: "ubuntu-20.04"
 
-    env:
-      SYMFONY_PHPUNIT_VERSION: 7.5
-
     strategy:
       matrix:
         php:
@@ -107,16 +100,16 @@ jobs:
       - name: "Install dependencies with Composer"
         uses: "ramsey/composer-install@v1"
 
-      - name: "Run PHPUnit (with coverage)"
-        run: "php vendor/bin/simple-phpunit -v --coverage-clover coverage/clover.xml"
+      - name: "Install dev tools"
+        run: "make install-dev-tools"
+
+      - name: "Run PHPUnit"
+        run: make run-phpunit ARGS="-v --coverage-clover coverage/clover.xml"
 
   phpunit-composerv2:
     name: "PHPUnit Composer v2 (PHP ${{ matrix.php }})"
     runs-on: "ubuntu-20.04"
 
-    env:
-      SYMFONY_PHPUNIT_VERSION: 7.5
-
     strategy:
       matrix:
         php:
@@ -138,8 +131,11 @@ jobs:
       - name: "Install dependencies with Composer"
         uses: "ramsey/composer-install@v1"
 
+      - name: "Install dev tools"
+        run: "make install-dev-tools"
+
       - name: "Run PHPUnit"
-        run: "php vendor/bin/simple-phpunit -v"
+        run: "make run-phpunit"
 
   alt-autoload:
     name: "Tests alternative autoloader (PHP ${{ matrix.php }})"
@@ -175,10 +171,6 @@ jobs:
     name: "PHPUnit lowest deps (PHP ${{ matrix.php }})"
     runs-on: "ubuntu-20.04"
 
-    env:
-      SYMFONY_PHPUNIT_VERSION: 7.5
-      SYMFONY_DEPRECATIONS_HELPER: disabled=1
-
     strategy:
       matrix:
         php:
@@ -202,5 +194,8 @@ jobs:
         with:
           dependency-versions: "lowest"
 
+      - name: "Install dev tools"
+        run: "make install-dev-tools"
+
       - name: "Run PHPUnit"
-        run: "php vendor/bin/simple-phpunit -v"
+        run: "make run-phpunit"

.gitignore

@@ -3,7 +3,9 @@
 /vendor/*
 /xdebug/*
 /composer.phar
+/dev-tools/vendor
 /composer
 debug*
 composer.lock
 /.php_cs.cache
+/.phpunit.result.cache

.scrutinizer.yml

@@ -5,7 +5,7 @@ build:
                 override:
                     - php-scrutinizer-run
                     -
-                        command: SYMFONY_PHPUNIT_VERSION=7.5 php vendor/bin/simple-phpunit --coverage-clover coverage/clover.xml
+                        command: make install-dev-tools && make run-phpunit ARGS="--coverage-clover coverage/clover.xml"
                         coverage:
                             file: coverage/clover.xml
                             format: clover

DEVELOPER.md

@@ -0,0 +1,40 @@
+# Developers
+
+## .editorconfig
+
+Please make sure your editor uses our `.editorconfig` file. It contains rules about our coding styles.
+
+## Development Tools and Tests
+
+Our test related files are located in `tests` folder.
+Tests are written using PHPUnit.
+
+To install (and update) development tools like PHPUnit or PHP-CS-Fixer run:
+
+> make install-dev-tools
+
+Development tools are getting installed in `dev-tools/vendor`.
+Please check `dev-tools/composer.json` for more information about versions etc.
+To run a tool manually you use `dev-tools/vendor/bin`, for instance:
+
+> dev-tools/vendor/bin/php-cs-fixer fix --verbose --dry-run
+
+Below are a few shortcuts to improve your developer experience.
+
+### PHPUnit
+
+To run all tests run:
+
+> make run-phpunit
+
+### PHP-CS-Fixer
+
+To check coding styles run:
+
+> make run-php-cs-fixer
+
+### PHPStan
+
+To run a static code analysis use:
+
+> make run-phpstan

Makefile

@@ -0,0 +1,11 @@
+install-dev-tools:
+	composer update --working-dir=dev-tools
+
+run-php-cs-fixer:
+	dev-tools/vendor/bin/php-cs-fixer fix $(ARGS)
+
+run-phpstan:
+	dev-tools/vendor/bin/phpstan/phpstan/phpstan analyze $(ARGS)
+
+run-phpunit:
+	dev-tools/vendor/bin/phpunit $(ARGS)

README.md

@@ -42,6 +42,8 @@ As a result, users must expect BC breaks when using the master version.
 
 Original PDF References files can be downloaded from this url: http://www.adobe.com/devnet/pdf/pdf_reference_archive.html
 
+**For developers**: Please read [DEVELOPER.md](DEVELOPER.md) for more information about local development of the PDFParser library.
+
 ## Installation
 
 ### Using Composer

composer.json

@@ -15,14 +15,10 @@
     },
     "homepage": "https://www.pdfparser.org",
     "require": {
-        "php": ">=5.6",
+        "php": ">=7.1",
         "symfony/polyfill-mbstring": "^1.18",
         "ext-zlib": "*"
     },
-    "require-dev": {
-        "friendsofphp/php-cs-fixer": "^2.16",
-        "symfony/phpunit-bridge": "^5.2"
-    },
     "autoload": {
         "psr-0": {
             "Smalot\\PdfParser\\": "src/"

dev-tools/composer.json

@@ -0,0 +1,9 @@
+{
+    "description": "This file provides development-only dependencies.",
+    "require-dev": {
+        "friendsofphp/php-cs-fixer": "^2.16",
+        "phpstan/phpstan": "^0.12.81",
+        "phpstan/phpstan-phpunit": "^0.12.18",
+        "phpunit/phpunit": ">=7.5"
+    }
+}

phpstan.neon

@@ -1,6 +1,6 @@
 includes:
-    - vendor/phpstan/phpstan-phpunit/extension.neon
-    - vendor/phpstan/phpstan-phpunit/rules.neon
+    - dev-tools/vendor/phpstan/phpstan-phpunit/extension.neon
+    - dev-tools/vendor/phpstan/phpstan-phpunit/rules.neon
 
 parameters:
     level: 3
@@ -9,4 +9,4 @@ parameters:
         - tests
 
     bootstrapFiles:
-        - vendor/bin/.phpunit/phpunit-7.5-0/vendor/autoload.php
+        - vendor/autoload.php

src/Smalot/PdfParser/Element/ElementXRef.php

@@ -56,6 +56,24 @@ public function getObject()
      */
     public function equals($value)
     {
+        /**
+         * In case $value is a number and $this->value is a string like 5_0
+         *
+         * Without this if-clause code like:
+         *
+         *      $element = new ElementXRef('5_0');
+         *      $this->assertTrue($element->equals(5));
+         *
+         * would fail (= 5_0 and 5 are not equal in PHP 8.0+).
+         */
+        if (
+            true === is_numeric($value)
+            && true === \is_string($this->getContent())
+            && 1 === preg_match('/[0-9]+\_[0-9]+/', $this->getContent(), $matches)
+        ) {
+            return (float) ($this->getContent()) == $value;
+        }
+
         $id = ($value instanceof self) ? $value->getId() : $value;
 
         return $this->getId() == $id;