Skip to content

Commit 46cb27f

Browse files
tigitztigitz
authored
Support 8.1 and symfony from 6 to the latest LTS 4.4 (#36)
1 parent f5ce104 commit 46cb27f

File tree

9 files changed

+147
-47
lines changed

9 files changed

+147
-47
lines changed

‎.github/dependabot.yml

-8
This file was deleted.

‎.github/workflows/phpstan.yml

+4-1
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,16 @@ jobs:
1010
phpstan:
1111
name: phpstan
1212
runs-on: ubuntu-latest
13+
strategy:
14+
matrix:
15+
php: [ "7.4", "8.1" ]
1316
steps:
1417
- uses: actions/checkout@v2
1518

1619
- name: Setup PHP
1720
uses: shivammathur/setup-php@v2
1821
with:
19-
php-version: '7.4'
22+
php-version: ${{ matrix.php }}
2023
extensions: dom, curl, libxml, mbstring, zip, pspell, intl, iconv
2124
coverage: none
2225

‎.github/workflows/run-tests.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ jobs:
77
runs-on: ubuntu-latest
88
strategy:
99
matrix:
10-
php: ["7.4", "8.0"]
10+
php: ["7.4", "8.0", "8.1"]
1111
stability: [--prefer-lowest, --prefer-stable]
1212
env:
1313
PHP_VERSION: ${{ matrix.php }}
@@ -46,7 +46,7 @@ jobs:
4646

4747
- name: Run tests
4848
run: |
49-
export WITH_COVERAGE=$(if [[ ("${{ matrix.php }}" = "8.0") && ("${{ matrix.stability }}" = "--prefer-stable") ]]; then echo "true"; else echo "false"; fi)
49+
export WITH_COVERAGE=$(if [[ ("${{ matrix.php }}" = "8.1") && ("${{ matrix.stability }}" = "--prefer-stable") ]]; then echo "true"; else echo "false"; fi)
5050
echo "WITH_COVERAGE=${WITH_COVERAGE}" >> $GITHUB_ENV
5151
make vendor
5252
make tests

‎Makefile

+8-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
DOCKER_COMPOSE ?= docker-compose
22
EXEC_PHP = $(DOCKER_COMPOSE) run --rm -T php
3-
PHP_VERSION ?= 8.0
3+
PHP_VERSION ?= 8.1
44
DEPS_STRATEGY ?= --prefer-stable
55
COMPOSER = $(EXEC_PHP) composer
66
WITH_COVERAGE ?= "FALSE"
@@ -63,11 +63,17 @@ phpcs:
6363
PHP_VERSION=7.4 $(PHP_CS_FIXER) --dry-run
6464

6565
phpcbf:
66-
$(PHP_CS_FIXER)
66+
PHP_VERSION=7.4 $(PHP_CS_FIXER)
6767

6868
phpstan: vendor
6969
$(EXEC_PHP) vendor/bin/phpstan analyse src -c phpstan.neon -a vendor/autoload.php
7070

71+
phpstan: vendor
72+
$(EXEC_PHP) vendor/bin/phpstan analyse src -c phpstan.neon -a vendor/autoload.php
73+
74+
phpstan-baseline: vendor
75+
$(EXEC_PHP) vendor/bin/phpstan analyse src -c phpstan.neon -a vendor/autoload.php --generate-baseline
76+
7177
infection: vendor
7278
$(EXEC_PHP) vendor/bin/phpunit --coverage-xml=build/coverage/coverage-xml --log-junit=build/coverage/phpunit.junit.xml
7379
$(EXEC_PHP) php infection.phar --threads=4 --coverage=build/coverage --min-covered-msi=74

‎composer.json

+8-8
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@
2121
}
2222
],
2323
"require": {
24-
"php": "^7.4|^8.0",
24+
"php": "^7.4 | ^8.0",
2525
"nyholm/psr7": "^1.3",
2626
"psr/http-client": "^1.0",
27-
"symfony/process": "^3.3|^4.0|^5.0",
28-
"thecodingmachine/safe": "^1.0",
27+
"symfony/process": "^4.4.30 | ^5.0 |^6.0",
28+
"thecodingmachine/safe": "^1.0 | ^2.0",
2929
"webmozart/assert": "^1.3"
3030
},
3131
"require-dev": {
@@ -39,13 +39,13 @@
3939
"phpstan/phpstan-phpunit": "^1.0.0",
4040
"phpunit/phpunit": "^9.5",
4141
"pixelrobin/php-feather": "^1.0",
42-
"symfony/filesystem": "^4.2 || ^5.0",
43-
"symfony/finder": "^4.2 || ^5.0",
44-
"symfony/http-client": "^5.0",
45-
"thecodingmachine/phpstan-safe-rule": "v1.1.0"
42+
"symfony/filesystem": "^4.4 || ^5.0 || ^6.0",
43+
"symfony/finder": "^4.4 || ^5.0 || ^6.0",
44+
"symfony/http-client": "^5.0 || ^6.0",
45+
"thecodingmachine/phpstan-safe-rule": "^1.1"
4646
},
4747
"suggest": {
48-
"symfony/http-client": "A PSR-18 Client implementation to use spellcheckers relying on http api endpoints"
48+
"symfony/http-client": "A PSR-18 Client implementation to use spellcheckers that relies on HTTP APIs"
4949
},
5050
"autoload": {
5151
"psr-4": {

‎docker-compose.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ version: '3.4'
22

33
services:
44
php:
5-
image: tigitz/phpspellchecker:${PHP_VERSION:-8.0}
5+
image: tigitz/phpspellchecker:${PHP_VERSION:-8.1}
66
build:
77
context: docker/php
88
args:
9-
PHP_VERSION: ${PHP_VERSION:-8.0}
9+
PHP_VERSION: ${PHP_VERSION:-8.1}
1010
volumes:
1111
- .:/usr/src/myapp
1212
- ./cache:/root/composer/cache

‎phpstan.neon

+57-8
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,68 @@ includes:
66

77
parameters:
88
level: max
9-
reportUnmatchedIgnoredErrors: true
9+
10+
# Some errors ignored are specific to a php version so they're reported as unmatched when phpstan is ran with a
11+
# different php version
12+
reportUnmatchedIgnoredErrors: false
13+
1014
treatPhpDocTypesAsCertain: false
1115
ignoreErrors:
12-
# yeah OK Process is technically and iterable type...
16+
# Missing strict comparison
17+
- '#^Construct empty\(\) is not allowed. Use more strict comparison.$#'
18+
19+
# thecodingmachine/safe and thecodingmachine/phpstan-safe-rule don't support 8.1 Pspell
1320
-
14-
message: "#no value type specified in iterable type Symfony\\\\Component\\\\Process\\\\Process#"
15-
path: %currentWorkingDirectory%
21+
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\\.$#"
22+
count: 1
23+
path: src/Spellchecker/PHPPspell.php
1624

17-
# It's checked by Assert:count(1)
1825
-
19-
message: "#^Parameter \\#1 \\$language of function Safe\\\\pspell_config_create expects string, string\\|false given\\.$#"
26+
message: "#^Function pspell_config_ignore is unsafe to use\\. It can return FALSE instead of throwing an exception\\. Please add 'use function Safe\\\\pspell_config_ignore;' at the beginning of the file to use the variant provided by the 'thecodingmachine/safe' library\\.$#"
2027
count: 1
2128
path: src/Spellchecker/PHPPspell.php
2229

23-
# Missing strict comparison
24-
- '#^Construct empty\(\) is not allowed. Use more strict comparison.$#'
30+
-
31+
message: "#^Function pspell_config_mode is unsafe to use\\. It can return FALSE instead of throwing an exception\\. Please add 'use function Safe\\\\pspell_config_mode;' at the beginning of the file to use the variant provided by the 'thecodingmachine/safe' library\\.$#"
32+
count: 1
33+
path: src/Spellchecker/PHPPspell.php
34+
35+
-
36+
message: "#^Function pspell_new_config is unsafe to use\\. It can return FALSE instead of throwing an exception\\. Please add 'use function Safe\\\\pspell_new_config;' at the beginning of the file to use the variant provided by the 'thecodingmachine/safe' library\\.$#"
37+
count: 1
38+
path: src/Spellchecker/PHPPspell.php
39+
40+
-
41+
message: "#^Parameter \\#1 \\$dictionary of function pspell_check expects int, int\\|false given\\.$#"
42+
count: 1
43+
path: src/Spellchecker/PHPPspell.php
44+
45+
-
46+
message: "#^Parameter \\#1 \\$dictionary of function pspell_suggest expects int, int\\|false given\\.$#"
47+
count: 1
48+
path: src/Spellchecker/PHPPspell.php
49+
50+
-
51+
message: "#^Parameter \\#1 \\$conf of function pspell_config_ignore expects int, int\\|false given\\.$#"
52+
count: 1
53+
path: src/Spellchecker/PHPPspell.php
54+
55+
-
56+
message: "#^Parameter \\#1 \\$conf of function pspell_config_mode expects int, int\\|false given\\.$#"
57+
count: 1
58+
path: src/Spellchecker/PHPPspell.php
59+
60+
-
61+
message: "#^Parameter \\#1 \\$config of function pspell_new_config expects int, int\\|false given\\.$#"
62+
count: 1
63+
path: src/Spellchecker/PHPPspell.php
64+
65+
-
66+
message: "#^Parameter \\#1 \\$pspell of function pspell_check expects int, int\\|false given\\.$#"
67+
count: 1
68+
path: src/Spellchecker/PHPPspell.php
69+
70+
-
71+
message: "#^Parameter \\#1 \\$pspell of function pspell_suggest expects int, int\\|false given\\.$#"
72+
count: 1
73+
path: src/Spellchecker/PHPPspell.php

‎src/Spellchecker/PHPPspell.php

+66-9
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
use PhpSpellcheck\Exception\RuntimeException;
88
use PhpSpellcheck\Misspelling;
9+
use PhpSpellcheck\MisspellingInterface;
910
use Webmozart\Assert\Assert;
1011

1112
class PHPPspell implements SpellcheckerInterface
@@ -29,9 +30,9 @@ class PHPPspell implements SpellcheckerInterface
2930
* @see http://php.net/manual/en/function.pspell-config-mode.php
3031
* @see http://php.net/manual/en/function.pspell-config-ignore.php
3132
*
32-
* @param int $mode the mode parameter is the mode in which the spellchecker will work
33+
* @param int|null $mode the mode parameter is the mode in which the spellchecker will work
3334
* @param int $numberOfCharactersLowerLimit Words less than n characters will be skipped
34-
* @param Aspell|null $aspell Aspell spellchecker that pspell extension is using underneath. Used to help retrieving supported languages
35+
* @param Aspell|null $aspell Aspell spellchecker that pspell extension is using underneath. Used to help retrieve supported languages
3536
*/
3637
public function __construct(
3738
?int $mode = null,
@@ -60,9 +61,36 @@ public function check(
6061
string $text,
6162
array $languages,
6263
array $context
64+
): iterable {
65+
if (PHP_VERSION_ID < 80100) {
66+
return $this->checkBefore81($text, $languages, $context);
67+
}
68+
69+
return $this->checkAfter81($text, $languages, $context);
70+
}
71+
72+
/**
73+
* {@inheritdoc}
74+
*/
75+
public function getSupportedLanguages(): iterable
76+
{
77+
return $this->aspell->getSupportedLanguages();
78+
}
79+
80+
/**
81+
* @param array<mixed> $context
82+
* @param array<string> $languages
83+
*
84+
* @return iterable<MisspellingInterface>
85+
*/
86+
private function checkBefore81(
87+
string $text,
88+
array $languages,
89+
array $context
6390
): iterable {
6491
Assert::count($languages, 1, 'PHPPspell spellchecker doesn\'t support multi-language check');
6592

93+
$chosenLanguage = current($languages);
6694
$pspellConfig = \Safe\pspell_config_create(current($languages));
6795
\Safe\pspell_config_mode($pspellConfig, $this->mode);
6896
\Safe\pspell_config_ignore($pspellConfig, $this->numberOfCharactersLowerLimit);
@@ -73,13 +101,12 @@ public function check(
73101
/** @var string $line */
74102
foreach ($lines as $lineNumber => $line) {
75103
$words = explode(' ', \Safe\preg_replace("/(?!['’-])(\p{P}|\+|--)/u", '', $line));
76-
foreach ($words as $key => $word) {
104+
foreach ($words as $word) {
77105
if (!pspell_check($dictionary, $word)) {
78106
$suggestions = pspell_suggest($dictionary, $word);
79-
80107
Assert::isArray(
81108
$suggestions,
82-
\Safe\sprintf('pspell_suggest method failed with dictionary "%s" and word "%s"', $dictionary, $word)
109+
\Safe\sprintf('pspell_suggest method failed with language "%s" and word "%s"', $chosenLanguage, $word)
83110
);
84111

85112
yield new Misspelling($word, 0, $lineNumber + 1, $suggestions, $context);
@@ -89,10 +116,40 @@ public function check(
89116
}
90117

91118
/**
92-
* {@inheritdoc}
119+
* @param array<mixed> $context
120+
* @param array<string> $languages
121+
*
122+
* @return iterable<MisspellingInterface>
93123
*/
94-
public function getSupportedLanguages(): iterable
95-
{
96-
return $this->aspell->getSupportedLanguages();
124+
private function checkAfter81(
125+
string $text,
126+
array $languages,
127+
array $context
128+
): iterable {
129+
Assert::count($languages, 1, 'PHPPspell spellchecker doesn\'t support multi-language check');
130+
131+
$chosenLanguage = current($languages);
132+
$pspellConfig = pspell_config_create($chosenLanguage);
133+
pspell_config_mode($pspellConfig, $this->mode);
134+
pspell_config_ignore($pspellConfig, $this->numberOfCharactersLowerLimit);
135+
$dictionary = pspell_new_config($pspellConfig);
136+
137+
$lines = explode(PHP_EOL, $text);
138+
139+
/** @var string $line */
140+
foreach ($lines as $lineNumber => $line) {
141+
$words = explode(' ', \Safe\preg_replace("/(?!['’-])(\p{P}|\+|--)/u", '', $line));
142+
foreach ($words as $word) {
143+
if (!pspell_check($dictionary, $word)) {
144+
$suggestions = pspell_suggest($dictionary, $word);
145+
Assert::isArray(
146+
$suggestions,
147+
\Safe\sprintf('pspell_suggest method failed with language "%s" and word "%s"', $chosenLanguage, $word)
148+
);
149+
150+
yield new Misspelling($word, 0, $lineNumber + 1, $suggestions, $context);
151+
}
152+
}
153+
}
97154
}
98155
}

‎src/Utils/ProcessRunner.php

-7
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,6 @@ class ProcessRunner
1616
*/
1717
public static function run(Process $process, $timeout = null, callable $callback = null, array $env = []): Process
1818
{
19-
if (method_exists($process, 'inheritEnvironmentVariables')) {
20-
// Symfony 3.2+
21-
$process->inheritEnvironmentVariables(true);
22-
} else {
23-
// Symfony < 3.2
24-
$process->setEnv(['LANG' => getenv('LANG')]);
25-
}
2619
$process->setTimeout($timeout);
2720

2821
try {

0 commit comments

Comments
 (0)