Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Symfony 7 support ; drop Symfony < 5.4 support and PHP < 8 support #258

Merged
merged 7 commits into from
Jan 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.env.dist export-ignore
.gitattributes export-ignore
.gitignore export-ignore
.php_cs export-ignore
.php-cs-fixer.php export-ignore
.scrutinizer.yml export-ignore
.travis.yml export-ignore
.styleci.yml export-ignore
Expand Down
9 changes: 4 additions & 5 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,15 @@ jobs:
strategy:
matrix:
php-version:
- 7.2
- 7.3
- 7.4
- 8.0
- 8.1
- 8.2
- 8.3
dependencies: [highest]

steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4

- name: Install PHP with extensions
uses: shivammathur/setup-php@v2
Expand All @@ -31,7 +30,7 @@ jobs:
extensions: zip

- name: Install Composer dependencies
uses: ramsey/composer-install@v1
uses: ramsey/composer-install@v2
with:
dependency-versions: ${{ matrix.dependencies }}
composer-options: --prefer-dist
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
/.env

# PHP CS Fixer
/.php_cs.cache
/.php-cs-fixer.cache

# PHPUnit
/build
Expand Down
12 changes: 7 additions & 5 deletions .php_cs → .php-cs-fixer.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,14 @@
->in(__DIR__)
->exclude('vendor');

return Config::create()
$config = new Config();

return $config
->setUsingCache(true)
->setRules([
'@Symfony' => true,
'array_syntax' => ['syntax' => 'short'],
'ordered_imports' => true,
'yoda_style' => false,
'@Symfony' => true,
'array_syntax' => ['syntax' => 'short'],
'ordered_imports' => true,
'yoda_style' => false,
])
->setFinder($finder);
36 changes: 18 additions & 18 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,33 +17,33 @@
}
],
"require": {
"php": "^7.1|^8.0",
"php": "^8.0",
"ext-zip": "*",
"ext-json": "*",
"symfony/asset": "^4.4 || ^5.0 || ^6.0",
"symfony/config": "^4.4 || ^5.0 || ^6.0",
"symfony/dependency-injection": "^4.4 || ^5.0 || ^6.0",
"symfony/expression-language": "^4.4 || ^5.0 || ^6.0",
"symfony/form": "^4.4 || ^5.0 || ^6.0",
"symfony/framework-bundle": "^4.4 || ^5.0 || ^6.0",
"symfony/http-foundation": "^4.4 || ^5.0 || ^6.0",
"symfony/http-kernel": "^4.4 || ^5.0 || ^6.0",
"symfony/options-resolver": "^4.4 || ^5.0 || ^6.0",
"symfony/property-access": "^4.4 || ^5.0 || ^6.0",
"symfony/routing": "^4.4 || ^5.0 || ^6.0",
"symfony/twig-bundle": "^4.4 || ^5.0 || ^6.0",
"symfony/asset": "^5.4 || ^6.0 || ^7.0",

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe also bump the ^6.0 to ^6.3 at least (or even ^6.4), as <6.3 is unmaintained and 6.3 support ends this month... https://symfony.com/releases#symfony-releases-calendar

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Previously the support was still ^5.0 || ^6.0", even if it was unmaintained so I kept the same strategy ; even if I agree with you.

"symfony/config": "^5.4 || ^6.0 || ^7.0",
"symfony/dependency-injection": "^5.4 || ^6.0 || ^7.0",
"symfony/expression-language": "^5.4 || ^6.0 || ^7.0",
"symfony/form": "^5.4 || ^6.0 || ^7.0",
"symfony/framework-bundle": "^5.4 || ^6.0 || ^7.0",
"symfony/http-foundation": "^5.4 || ^6.0 || ^7.0",
"symfony/http-kernel": "^5.4 || ^6.0 || ^7.0",
"symfony/options-resolver": "^5.4 || ^6.0 || ^7.0",
"symfony/property-access": "^5.4 || ^6.0 || ^7.0",
"symfony/routing": "^5.4 || ^6.0 || ^7.0",
"symfony/twig-bundle": "^5.4 || ^6.0 || ^7.0",
"twig/twig": "^2.4 || ^3.0"
},
"conflict": {
"sebastian/environment": "<1.3.4",
"sebastian/exporter": "<2.0.0"
},
"require-dev": {
"friendsofphp/php-cs-fixer": "^2.0",
"matthiasnoback/symfony-dependency-injection-test": "^3.0 || ^4.0",
"symfony/console": "^4.4 || ^5.0 || ^6.0",
"symfony/phpunit-bridge": "^4.4 || ^5.0 || ^6.0",
"symfony/yaml": "^4.4 || ^5.0 || ^6.0"
"friendsofphp/php-cs-fixer": "^3.41",
"matthiasnoback/symfony-dependency-injection-test": "^4.0 || ^5.0",
"symfony/console": "^5.4 || ^6.0 || ^7.0",
"symfony/phpunit-bridge": "^5.4 || ^6.0 || ^7.0",
"symfony/yaml": "^5.4 || ^6.0 || ^7.0"
},
"suggest": {
"egeloen/form-extra-bundle": "Allows to load CKEditor asynchronously"
Expand Down
5 changes: 1 addition & 4 deletions src/Builder/JsonBuilder.php
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,7 @@ public function setValues(array $values, string $pathPrefix = null): self
return $this;
}

/**
* @param mixed $value
*/
public function setValue(string $path, $value, bool $escapeValue = true): self
public function setValue(string $path, mixed $value, bool $escapeValue = true): self
{
if (!$escapeValue) {
$placeholder = uniqid('friendsofsymfony', true);
Expand Down
2 changes: 1 addition & 1 deletion src/Config/CKEditorConfiguration.php
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ public function getToolbar(string $name): array

foreach ($this->toolbarConfigs[$name] as $name => $item) {
$items[] = is_string($item) && '@' === substr($item, 0, 1)
? $this->toolbarItems[(substr($item, 1))]
? $this->toolbarItems[substr($item, 1)]
: $item;
}

Expand Down
4 changes: 1 addition & 3 deletions src/Exception/BadProxyUrlException.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,10 @@

namespace FOS\CKEditorBundle\Exception;

use RuntimeException;

/**
* @author Marko Kunic <[email protected]>
*/
final class BadProxyUrlException extends RuntimeException implements FOSCKEditorException
final class BadProxyUrlException extends \RuntimeException implements FOSCKEditorException
{
public static function fromEnvUrl(string $url): self
{
Expand Down
4 changes: 1 addition & 3 deletions src/Exception/ConfigException.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,10 @@

namespace FOS\CKEditorBundle\Exception;

use RuntimeException;

/**
* @author GeLo <[email protected]>
*/
final class ConfigException extends RuntimeException implements FOSCKEditorException
final class ConfigException extends \RuntimeException implements FOSCKEditorException
{
public static function configDoesNotExist(string $name): self
{
Expand Down
4 changes: 1 addition & 3 deletions src/Exception/FOSCKEditorException.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,9 @@

namespace FOS\CKEditorBundle\Exception;

use Throwable;

/**
* @author GeLo <[email protected]>
*/
interface FOSCKEditorException extends Throwable
interface FOSCKEditorException extends \Throwable
{
}
53 changes: 25 additions & 28 deletions src/Installer/CKEditorInstaller.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,49 +21,49 @@
*/
final class CKEditorInstaller
{
const RELEASE_BASIC = 'basic';
public const RELEASE_BASIC = 'basic';

const RELEASE_FULL = 'full';
public const RELEASE_FULL = 'full';

const RELEASE_STANDARD = 'standard';
public const RELEASE_STANDARD = 'standard';

const RELEASE_CUSTOM = 'custom';
public const RELEASE_CUSTOM = 'custom';

const VERSION_LATEST = 'latest';
public const VERSION_LATEST = 'latest';

const CLEAR_DROP = 'drop';
public const CLEAR_DROP = 'drop';

const CLEAR_KEEP = 'keep';
public const CLEAR_KEEP = 'keep';

const CLEAR_SKIP = 'skip';
public const CLEAR_SKIP = 'skip';

const NOTIFY_CLEAR = 'clear';
public const NOTIFY_CLEAR = 'clear';

const NOTIFY_CLEAR_ARCHIVE = 'clear-archive';
public const NOTIFY_CLEAR_ARCHIVE = 'clear-archive';

const NOTIFY_CLEAR_COMPLETE = 'clear-complete';
public const NOTIFY_CLEAR_COMPLETE = 'clear-complete';

const NOTIFY_CLEAR_PROGRESS = 'clear-progress';
public const NOTIFY_CLEAR_PROGRESS = 'clear-progress';

const NOTIFY_CLEAR_QUESTION = 'clear-question';
public const NOTIFY_CLEAR_QUESTION = 'clear-question';

const NOTIFY_CLEAR_SIZE = 'clear-size';
public const NOTIFY_CLEAR_SIZE = 'clear-size';

const NOTIFY_DOWNLOAD = 'download';
public const NOTIFY_DOWNLOAD = 'download';

const NOTIFY_DOWNLOAD_COMPLETE = 'download-complete';
public const NOTIFY_DOWNLOAD_COMPLETE = 'download-complete';

const NOTIFY_DOWNLOAD_PROGRESS = 'download-progress';
public const NOTIFY_DOWNLOAD_PROGRESS = 'download-progress';

const NOTIFY_DOWNLOAD_SIZE = 'download-size';
public const NOTIFY_DOWNLOAD_SIZE = 'download-size';

const NOTIFY_EXTRACT = 'extract';
public const NOTIFY_EXTRACT = 'extract';

const NOTIFY_EXTRACT_COMPLETE = 'extract-complete';
public const NOTIFY_EXTRACT_COMPLETE = 'extract-complete';

const NOTIFY_EXTRACT_PROGRESS = 'extract-progress';
public const NOTIFY_EXTRACT_PROGRESS = 'extract-progress';

const NOTIFY_EXTRACT_SIZE = 'extract-size';
public const NOTIFY_EXTRACT_SIZE = 'extract-size';

/**
* @var string
Expand Down Expand Up @@ -306,16 +306,13 @@ private function extractFile(string $file, string $rewrite, string $origin, arra
}
}

/**
* @param mixed $data
*
* @return mixed
*/
private function notify(callable $notifier = null, string $type, $data = null)
private function notify(callable $notifier = null, string $type = null, mixed $data = null): mixed
{
if (null !== $notifier) {
return $notifier($type, $data);
}

return null;
}

private function createException(string $message): \RuntimeException
Expand Down
1 change: 1 addition & 0 deletions tests/DependencyInjection/FOSCKEditorExtensionTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ public function testHasServiceDefinitionForTwigExtension(): void

/**
* @group legacy
*
* @expectedDeprecation IvoryCKEditorBundle isn't maintained anymore and should be replaced with FOSCKEditorBundle.
*/
public function testIvoryDeprecation(): void
Expand Down
12 changes: 6 additions & 6 deletions tests/Installer/CKEditorInstallerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ public function testInstallWithRelease(): void

public function testInstallWithCustomBuild(): void
{
$this->installer->install($options = ['release' => CKEditorInstaller::RELEASE_CUSTOM, 'custom_build_id' => '459c358ccf2e34f083e3c8847d3af23e']);
$this->installer->install($options = ['release' => CKEditorInstaller::RELEASE_CUSTOM, 'custom_build_id' => 'ffbb0c61721cb8543bfa54315374592d']);

$this->assertInstall($options);
}
Expand All @@ -86,15 +86,15 @@ public function testInstallWithCustomBuildWithInvalidVersion(): void
$this->expectException(\RuntimeException::class);
$this->expectExceptionMessageMatches('/Specifying version for custom build is not supported/');

$this->installer->install($options = ['release' => CKEditorInstaller::RELEASE_CUSTOM, 'custom_build_id' => '459c358ccf2e34f083e3c8847d3af23e', 'version' => '4.11.4']);
$this->installer->install(['release' => CKEditorInstaller::RELEASE_CUSTOM, 'custom_build_id' => 'ffbb0c61721cb8543bfa54315374592d', 'version' => '4.11.4']);
}

public function testInstallWithCustomBuildWithMissingId(): void
{
$this->expectException(\RuntimeException::class);
$this->expectExceptionMessageMatches('/Custom build ID is not specified/');

$this->installer->install($options = ['release' => CKEditorInstaller::RELEASE_CUSTOM]);
$this->installer->install(['release' => CKEditorInstaller::RELEASE_CUSTOM]);
}

public function testInstallWithVersion(): void
Expand Down Expand Up @@ -262,13 +262,13 @@ private function assertRelease(string $release): void

case CKEditorInstaller::RELEASE_BASIC:
$this->assertFileExists($this->path.'/plugins/link');
$this->assertFileNotExists($this->path.'/plugins/image');
$this->assertFileDoesNotExist($this->path.'/plugins/image');

break;

case CKEditorInstaller::RELEASE_STANDARD:
$this->assertFileExists($this->path.'/plugins/image');
$this->assertFileNotExists($this->path.'/plugins/copyformatting');
$this->assertFileDoesNotExist($this->path.'/plugins/copyformatting');

break;
}
Expand All @@ -289,7 +289,7 @@ private function assertVersion(string $version): void
private function assertExcludes(array $excludes): void
{
foreach ($excludes as $exclude) {
$this->assertFileNotExists($this->path.'/'.$exclude);
$this->assertFileDoesNotExist($this->path.'/'.$exclude);
}
}
}
12 changes: 7 additions & 5 deletions tests/Renderer/CKEditorRendererTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -190,14 +190,16 @@ public function testRenderWidgetWithStringContentsCss(string $path, string $asse
*/
public function testRenderWidgetWithArrayContentsCss(array $paths, array $assets, array $urls): void
{
$callMap = [];
foreach (array_keys($paths) as $key) {
$this->packages
->expects($this->at($key))
->method('getUrl')
->with($this->equalTo($paths[$key]))
->will($this->returnValue($assets[$key]));
$callMap[] = [$paths[$key], null, $assets[$key]];
}

$this->packages
->expects($this->exactly(count($paths)))
->method('getUrl')
->willReturnMap($callMap);

$this->assertSame(
'CKEDITOR.replace("foo", {"contentsCss":'.json_encode($urls).'});',
$this->renderer->renderWidget('foo', ['contentsCss' => $paths])
Expand Down