Support PHP 8.3, dropped 7.4 and 8.0

tigitz · tigitz · commit 3b5343de2d06 · 2024-05-04T17:06:00.000+02:00
diff --git a/.github/workflows/php-cs-fixer.yml b/.github/workflows/php-cs-fixer.yml
@@ -13,9 +13,9 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 7.4
+          php-version: 8.3
           coverage: none
-          tools: php-cs-fixer, cs2pr
+          tools: php-cs-fixer:3.54.x, cs2pr
 
       - name: Restore PHP-CS-Fixer cache
         uses: actions/cache@v4
diff --git a/.github/workflows/phpstan.yml b/.github/workflows/phpstan.yml
@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php: [ "7.4", "8.2" ]
+        php: [ "8.1", "8.3" ]
     steps:
       - uses: actions/checkout@v2
 
diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml
@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php: ["7.4", "8.0", "8.1", "8.2"]
+        php: ["8.1", "8.2", "8.3"]
         stability: [--prefer-lowest, --prefer-stable]
     env:
       PHP_VERSION: ${{ matrix.php }}
@@ -46,7 +46,7 @@ jobs:
         
       - name: Run tests
         run: |
-          export WITH_COVERAGE=$(if [[ ("${{ matrix.php }}" = "8.2") && ("${{ matrix.stability }}" = "--prefer-stable") ]]; then echo "true"; else echo "false"; fi)
+          export WITH_COVERAGE=$(if [[ ("${{ matrix.php }}" = "8.3") && ("${{ matrix.stability }}" = "--prefer-stable") ]]; then echo "true"; else echo "false"; fi)
           echo "WITH_COVERAGE=${WITH_COVERAGE}" >> $GITHUB_ENV
           make vendor
           make tests
diff --git a/.php-cs-fixer.php b/.php-cs-fixer.php
@@ -11,6 +11,7 @@
 return (new PhpCsFixer\Config())
     ->setRules([
         '@PSR12' => true,
+        '@PHP81Migration' => true,
         'no_unused_imports' => true,
         'blank_line_before_statement' => true,
         'cast_spaces' => true,
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
@@ -3,7 +3,7 @@ build:
         analysis:
             environment:
                 php:
-                    version: 7.4
+                    version: 8.1
             cache:
                 disabled: false
                 directories:
diff --git a/Makefile b/Makefile
@@ -55,25 +55,22 @@ ti: vendor
 
 vendor:
 	$(COMPOSER) update $(DEPS_STRATEGY)
+	$(EXEC_PHP) composer -d tools/php-cs-fixer update
 
 PHP_CS_FIXER = docker-compose run --rm -T php tools/php-cs-fixer/vendor/bin/php-cs-fixer fix -vv --allow-risky=yes
 
 phpcs:
-	PHP_VERSION=7.4 docker-compose run --rm -T php composer require --working-dir=tools/php-cs-fixer friendsofphp/php-cs-fixer
-	PHP_VERSION=7.4 $(PHP_CS_FIXER) --dry-run
+	PHP_VERSION=8.1 docker-compose run --rm -T php composer require --working-dir=tools/php-cs-fixer friendsofphp/php-cs-fixer
+	PHP_VERSION=8.1 $(PHP_CS_FIXER) --dry-run
 
 phpcbf:
-	PHP_VERSION=7.4 $(PHP_CS_FIXER)
+	PHP_VERSION=8.1 $(PHP_CS_FIXER)
 
 phpstan: vendor
-	$(EXEC_PHP) vendor/bin/phpstan analyse src -c phpstan.$(PHP_VERSION).neon -a vendor/autoload.php
-
-phpstan-all-php-versions:
-	PHP_VERSION=7.4 make phpstan
-	PHP_VERSION=8.2 make phpstan
+	$(EXEC_PHP) vendor/bin/phpstan analyse src -c phpstan.neon -a vendor/autoload.php
 
 phpstan-baseline: vendor
-	$(EXEC_PHP) vendor/bin/phpstan analyse src -c phpstan.$(PHP_VERSION).neon -a vendor/autoload.php --generate-baseline
+	$(EXEC_PHP) vendor/bin/phpstan analyse src -c phpstan.neon -a vendor/autoload.php --generate-baseline
 
 infection: vendor
 	$(EXEC_PHP) vendor/bin/phpunit --coverage-xml=build/coverage/coverage-xml --log-junit=build/coverage/phpunit.junit.xml
diff --git a/composer.json b/composer.json
@@ -21,7 +21,7 @@
         }
     ],
     "require": {
-        "php": "^7.4 | ^8.0",
+        "php": "^8.1",
         "nyholm/psr7": "^1.3",
         "psr/http-client": "^1.0",
         "symfony/process": "^4.4.30 | ^5.0 |^6.0 | ^7.0",
diff --git a/docker/php/Dockerfile b/docker/php/Dockerfile
@@ -1,6 +1,6 @@
 ARG PHP_VERSION
 
-FROM php:${PHP_VERSION}-cli-buster
+FROM php:${PHP_VERSION}-cli-bookworm
 
 ENV XDEBUG_MODE=coverage
 RUN echo "memory_limit=-1" > "$PHP_INI_DIR/conf.d/memory-limit.ini" \
@@ -28,8 +28,8 @@ RUN apt-get update \
      libpspell-dev
 RUN set -eux; \
       case "$PHP_VERSION" in \
-          8.2*) pecl install xdebug-3.2.2;; \
-          *) pecl install xdebug-3.1.1;; \
+          8.1*) pecl install xdebug-3.1.1;; \
+          *) pecl install xdebug-3.3.2;; \
       esac
 RUN docker-php-ext-configure pspell \
 	&& docker-php-ext-enable xdebug \
diff --git a/examples/markdown_remover_text_processor.php b/examples/markdown_remover_text_processor.php
@@ -16,12 +16,12 @@
 );
 
 $mdFormattedString = <<<MD
-# Mispelling Heading
+    # Mispelling Heading
 
-**mispelling bold**
+    **mispelling bold**
 
-* mispelling list item
-MD;
+    * mispelling list item
+    MD;
 
 // using a string
 $misspellingFinder->find($mdFormattedString, ['en_US']);
diff --git a/examples/multisource_mispelling_finder.php b/examples/multisource_mispelling_finder.php
@@ -17,7 +17,7 @@
     new \PhpSpellcheck\Source\MultiSource(
         [
             new \PhpSpellcheck\Source\File(__DIR__ . '/../tests/Fixtures/Text/mispelling1.txt'),
-            new \PhpSpellcheck\Source\Directory(__DIR__ . '/../tests/Fixtures/Text/Directory')
+            new \PhpSpellcheck\Source\Directory(__DIR__ . '/../tests/Fixtures/Text/Directory'),
         ]
     ),
     ['en_US'],
diff --git a/phpstan.8.2.neon b/phpstan.8.2.neon
diff --git a/phpstan.base.neon b/phpstan.base.neon
diff --git a/phpstan.neon b/phpstan.neon
@@ -1,9 +1,23 @@
 includes:
-    - phpstan.base.neon
+    - vendor/phpstan/phpstan-webmozart-assert/extension.neon
+    - vendor/phpstan/phpstan-strict-rules/rules.neon
+    - vendor/thecodingmachine/phpstan-safe-rule/phpstan-safe-rule.neon
+    - vendor/phpstan/phpstan-phpunit/extension.neon
 
 parameters:
+    level: max
+    treatPhpDocTypesAsCertain: false
+
     ignoreErrors:
-        # php 8.1 code
+        # Missing strict comparison
+        - '#^Construct empty\(\) is not allowed. Use more strict comparison.$#'
+
+        # function_exists call
+        -
+            message: "#^Class PhpSpellcheck\\\\t not found\\.$#"
+            count: 1
+            path: src/Text/functions.php
+
         -
             message: "#^Function pspell_config_create is unsafe to use\\. It can return FALSE instead of throwing an exception\\. Please add 'use function Safe\\\\pspell_config_create;' at the beginning of the file to use the variant provided by the 'thecodingmachine/safe' library\\.$#"
             count: 1
@@ -25,32 +39,21 @@ parameters:
             path: src/Spellchecker/PHPPspell.php
 
         -
-            message: "#^Parameter \\#1 \\$conf of function pspell_config_ignore expects int, int\\|false given\\.$#"
-            count: 1
-            path: src/Spellchecker/PHPPspell.php
-
-        -
-            message: "#^Parameter \\#1 \\$conf of function pspell_config_mode expects int, int\\|false given\\.$#"
+            message: "#^Parameter \\#1 \\$dictionary of function pspell_check expects PSpell\\\\Dictionary, PSpell\\\\Dictionary\\|false given\\.$#"
             count: 1
             path: src/Spellchecker/PHPPspell.php
 
         -
-            message: "#^Parameter \\#1 \\$config of function pspell_new_config expects int, int\\|false given\\.$#"
+            message: "#^Parameter \\#1 \\$dictionary of function pspell_check expects PSpell\\\\Dictionary, int given\\.$#"
             count: 1
             path: src/Spellchecker/PHPPspell.php
 
         -
-            message: "#^Parameter \\#1 \\$pspell of function pspell_check expects int, int\\|false given\\.$#"
+            message: "#^Parameter \\#1 \\$dictionary of function pspell_suggest expects PSpell\\\\Dictionary, PSpell\\\\Dictionary\\|false given\\.$#"
             count: 1
             path: src/Spellchecker/PHPPspell.php
 
         -
-            message: "#^Parameter \\#1 \\$pspell of function pspell_suggest expects int, int\\|false given\\.$#"
+            message: "#^Parameter \\#1 \\$dictionary of function pspell_suggest expects PSpell\\\\Dictionary, int given\\.$#"
             count: 1
             path: src/Spellchecker/PHPPspell.php
-
-        # preg_match_all can be null in php >8
-        -
-            message: "#^Casting to int something that's already int\\.$#"
-            count: 1
-            path: src/Utils/LineAndOffset.php
diff --git a/src/Exception/ProcessHasErrorOutputException.php b/src/Exception/ProcessHasErrorOutputException.php
@@ -9,15 +9,15 @@ class ProcessHasErrorOutputException extends \RuntimeException implements Except
     public function __construct(string $errorOutput, string $parsedText, string $command)
     {
         $exceptionTemplateMessage = <<<'MSG'
-Process has generated the following output errors:
+            Process has generated the following output errors:
 
-%s
+            %s
 
-With command: "%s"
+            With command: "%s"
 
-For text:
-"%s"
-MSG;
+            For text:
+            "%s"
+            MSG;
 
         parent::__construct(
             \Safe\sprintf(
diff --git a/src/MisspellingHandler/MisspellingHandlerInterface.php b/src/MisspellingHandler/MisspellingHandlerInterface.php
@@ -10,8 +10,6 @@ interface MisspellingHandlerInterface
 {
     /**
      * @param MisspellingInterface[] $misspellings
-     *
-     * @return mixed|void
      */
-    public function handle(iterable $misspellings);
+    public function handle(iterable $misspellings): mixed;
 }
diff --git a/tests/Exception/ProcessHasErrorOutputExceptionTest.php b/tests/Exception/ProcessHasErrorOutputExceptionTest.php
@@ -11,15 +11,15 @@ public function testException(): void
     {
         $exception = new ProcessHasErrorOutputException('error output', 'testt', 'ispell --encoding=utf-8 -a');
         $this->assertSame(<<<MESSAGE
-Process has generated the following output errors:
+            Process has generated the following output errors:
 
-error output
+            error output
 
-With command: "ispell --encoding=utf-8 -a"
+            With command: "ispell --encoding=utf-8 -a"
 
-For text:
-"testt"
-MESSAGE
+            For text:
+            "testt"
+            MESSAGE
             , $exception->getMessage());
     }
 }
diff --git a/tests/Fixtures/Hunspell/check.txt b/tests/Fixtures/Hunspell/check.txt
@@ -1,13 +1,15 @@
-@(#) International Ispell Version 3.2.06 (but really Hunspell 1.7.0)
-& Tigr 6 1: Ti gr, Ti-gr, Tiger, Trig, Tier, Tigris
+@(#) International Ispell Version 3.2.06 (but really Hunspell 1.7.1)
+& Tigr 7 1: Tigre, Ti gr, Ti-gr, Tiger, Trig, Tier, Tigris
 # страх 22
 
 & theforests 6 4: the forests, the-forests, therefore, afforests, forests, forefathers
 
 & imortal 4 6: mortal, immortal, i mortal, immoral
-& eey 9 22: ea, eye, eel, hey, bey, fey, eek, key, Key
+& eey 12 22: ea, eye, eel, ley, dey, gey, fey, hey, bey, eek, key, Key
 
 & CCould 2 1: C Could, Could
+& symmetry? 2 26: symmetry, symmetric
 
 
-& mispell 10 2: mi spell, mi-spell, misspell, Ispell, misspells, misplay, spell, misapply, Aspell, dispel
+& mispell 4 2: misspell, mi spell, mi-spell, spell
+
diff --git a/tests/Spellchecker/HunspellTest.php b/tests/Spellchecker/HunspellTest.php
@@ -107,11 +107,11 @@ private function assertWorkingSpellcheckENText($binaries, string $textInput, arr
         $this->assertSame(21, $misspellings[1]->getOffset());
         $this->assertSame(1, $misspellings[1]->getLineNumber());
 
-        $this->assertSame(['ctx'], $misspellings[6]->getContext());
-        $this->assertSame('mispell', $misspellings[6]->getWord());
-        $this->assertSame(1, $misspellings[6]->getOffset());
-        $this->assertSame(6, $misspellings[6]->getLineNumber());
-        $this->assertNotEmpty($misspellings[6]->getSuggestions());
+        $this->assertSame(['ctx'], $misspellings[7]->getContext());
+        $this->assertSame('mispell', $misspellings[7]->getWord());
+        $this->assertSame(1, $misspellings[7]->getOffset());
+        $this->assertSame(6, $misspellings[7]->getLineNumber());
+        $this->assertNotEmpty($misspellings[7]->getSuggestions());
     }
 
     /**
diff --git a/tests/TextProcessor/MarkdownRemoverTest.php b/tests/TextProcessor/MarkdownRemoverTest.php
@@ -211,16 +211,16 @@ public function testShouldStripOrderedListLeadersKeepingIndentation(): void
     public function testShouldStripCodeBlocks(): void
     {
         $string = <<<CODE
-```js
-test
-```
-CODE;
+            ```js
+            test
+            ```
+            CODE;
 
         $expected = <<<CODE
 
-test
+            test
 
-CODE;
+            CODE;
 
         $this->assertSame($expected, (new MarkdownRemover())->process(t($string))->getContent());
     }
diff --git a/tests/TextTest.php b/tests/TextTest.php
diff --git a/tests/Utils/IspellParserTest.php b/tests/Utils/IspellParserTest.php
diff --git a/tests/Utils/LineAndOffsetTest.php b/tests/Utils/LineAndOffsetTest.php
diff --git a/tests/bootstrap.php b/tests/bootstrap.php
diff --git a/tools/php-cs-fixer/composer.json b/tools/php-cs-fixer/composer.json

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`	`}`
`22`	`22`	`],`
`23`	`23`	`"require": {`
`24`		`- "php": "^7.4 \| ^8.0",`
	`24`	`+ "php": "^8.1",`
`25`	`25`	`"nyholm/psr7": "^1.3",`
`26`	`26`	`"psr/http-client": "^1.0",`
`27`	`27`	`"symfony/process": "^4.4.30 \| ^5.0 \|^6.0 \| ^7.0",`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`new \PhpSpellcheck\Source\MultiSource(`
`18`	`18`	`[`
`19`	`19`	`new \PhpSpellcheck\Source\File(__DIR__ . '/../tests/Fixtures/Text/mispelling1.txt'),`
`20`		`- new \PhpSpellcheck\Source\Directory(__DIR__ . '/../tests/Fixtures/Text/Directory')`
	`20`	`+ new \PhpSpellcheck\Source\Directory(__DIR__ . '/../tests/Fixtures/Text/Directory'),`
`21`	`21`	`]`
`22`	`22`	`),`
`23`	`23`	`['en_US'],`