Symfony 6 support (#8)

* Symfony 6 support * Symfony 6 support * Symfony 6 support * Symfony 6 support * update tests * Symfony 6 support * update tests to support php versions >=7.1 * GitHub action workflow (#1)
auto1-oss · Mar 18, 2024 · f8ababf · f8ababf
1 parent e08c690
commit f8ababf
Show file tree

Hide file tree

Showing 11 changed files with 94 additions and 53 deletions.
diff --git a/.github/workflows/symfony.yml b/.github/workflows/symfony.yml
@@ -0,0 +1,42 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Symfony
+
+on:
+  push:
+    branches: ['master']
+    tags: ['*']
+  pull_request:
+    branches: ['*']
+
+permissions:
+  contents: read
+
+jobs:
+  symfony-tests:
+    runs-on: ${{ matrix.operating-system }}
+    strategy:
+      matrix:
+        operating-system: [ 'ubuntu-latest' ]
+        php-versions: [ '7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3' ]
+        phpunit-versions: [ 'latest' ]
+    steps:
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+          extensions: mbstring, intl
+          ini-values: post_max_size=256M, max_execution_time=180
+          coverage: xdebug
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Composer update on php ${{ matrix.php }} and symfony
+        run: composer update --prefer-dist --no-progress
+      - name: Execute tests (Unit and Feature tests) via PHPUnit
+        run: vendor/bin/phpunit
+
diff --git a/Service/NameConverter/SkipConvertOnNormalizeNameConverterDecorator.php b/Service/NameConverter/SkipConvertOnNormalizeNameConverterDecorator.php
@@ -29,15 +29,15 @@ public function __construct(NameConverterInterface $nameConverter)
     /**
      * {@inheritdoc}
      */
-    public function normalize($propertyName)
+    public function normalize($propertyName): string
     {
         return $propertyName;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function denormalize($propertyName)
+    public function denormalize($propertyName): string
     {
         return $this->nameConverter->denormalize($propertyName);
     }

diff --git a/Service/Serializer/Encoder/JsonEncoder.php b/Service/Serializer/Encoder/JsonEncoder.php
@@ -9,12 +9,12 @@ class JsonEncoder extends \Symfony\Component\Serializer\Encoder\JsonEncoder
 {
     const FORMAT_JSON_PATCH = 'json-patch';
 
-    public function supportsEncoding($format)
+    public function supportsEncoding($format): bool
     {
         return static::FORMAT_JSON_PATCH === $format || parent::supportsEncoding($format);
     }
 
-    public function supportsDecoding($format)
+    public function supportsDecoding($format): bool
     {
         return static::FORMAT_JSON_PATCH === $format || parent::supportsDecoding($format);
     }

diff --git a/Service/Serializer/Encoder/UrlEncode.php b/Service/Serializer/Encoder/UrlEncode.php
@@ -11,7 +11,7 @@ class UrlEncode implements EncoderInterface
      *
      * {@inheritdoc}
      */
-    public function encode($data, $format, array $context = [])
+    public function encode($data, $format, array $context = []): string
     {
         $data = $this->convertCamelCaseToSnakeCase($data);
         $encoded = http_build_query($data);
@@ -22,7 +22,7 @@ public function encode($data, $format, array $context = [])
     /**
      * {@inheritdoc}
      */
-    public function supportsEncoding($format)
+    public function supportsEncoding($format): bool
     {
         return UrlEncoder::FORMAT === $format;
     }

diff --git a/Service/Serializer/Encoder/UrlEncoder.php b/Service/Serializer/Encoder/UrlEncoder.php
@@ -21,15 +21,15 @@ public function __construct(UrlEncode $encodingImpl = null)
     /**
      * {@inheritdoc}
      */
-    public function encode($data, $format, array $context = array())
+    public function encode($data, $format, array $context = array()): string
     {
         return $this->encodingImpl->encode($data, self::FORMAT, $context);
     }
 
     /**
      * {@inheritdoc}
      */
-    public function supportsEncoding($format)
+    public function supportsEncoding($format): bool
     {
         return self::FORMAT === $format;
     }

diff --git a/Service/Serializer/Encoder/VoidEncoder.php b/Service/Serializer/Encoder/VoidEncoder.php
@@ -14,15 +14,15 @@ class VoidEncoder implements EncoderInterface
     /**
      * {@inheritdoc}
      */
-    public function encode($data, $format, array $context = array())
+    public function encode($data, $format, array $context = array()): string
     {
         return '';
     }
 
     /**
      * {@inheritdoc}
      */
-    public function supportsEncoding($format)
+    public function supportsEncoding($format): bool
     {
         return self::FORMAT === $format;
     }

diff --git a/Tests/Service/Endpoint/EndpointsConfigurationLoaderTest.php b/Tests/Service/Endpoint/EndpointsConfigurationLoaderTest.php
@@ -10,9 +10,9 @@
  */
 class EndpointsConfigurationLoaderTest extends TestCase
 {
-    public function testConstructor()
+    public function testConstructor(): void
     {
         $endpointsConfigurationLoader = new EndpointsConfigurationLoader('configFilePathString');
         self::assertInstanceOf(EndpointsConfigurationLoader::class, $endpointsConfigurationLoader);
     }
-}
+}
diff --git a/Tests/Service/Serializer/Encoder/UrlEncodeTest.php b/Tests/Service/Serializer/Encoder/UrlEncodeTest.php
@@ -13,12 +13,12 @@ class UrlEncodeTest extends TestCase
      */
     private $encode;
 
-    protected function setUp()
+    protected function setUp(): void
     {
         $this->encode = new UrlEncode();
     }
 
-    public function testSupportsEncoding()
+    public function testSupportsEncoding(): void
     {
         $this->assertTrue($this->encode->supportsEncoding(UrlEncoder::FORMAT));
         $this->assertFalse($this->encode->supportsEncoding('foobar'));
@@ -30,7 +30,7 @@ public function testSupportsEncoding()
      * @param array  $toEncode
      * @param string $expected
      */
-    public function testEncode(array $toEncode, string $expected)
+    public function testEncode(array $toEncode, string $expected): void
     {
         $this->assertEquals(
             $expected,
@@ -41,7 +41,7 @@ public function testEncode(array $toEncode, string $expected)
     /**
      * @return array
      */
-    public function encodeProvider()
+    public static function encodeProvider(): array
     {
         return [
             'empty' => [

diff --git a/Tests/Service/Serializer/Encoder/UrlEncoderTest.php b/Tests/Service/Serializer/Encoder/UrlEncoderTest.php
@@ -22,13 +22,13 @@ class UrlEncoderTest extends TestCase
     /**
      * @return void
      */
-    protected function setUp()
+    protected function setUp(): void
     {
         $this->encoder = new UrlEncoder();
         $this->serializer = new Serializer(array(new CustomNormalizer()), array('url' => new UrlEncoder()));
     }
 
-    public function testEncodeSimple()
+    public function testEncodeSimple(): void
     {
         $obj = new \stdClass();
         $obj->foo = 'foo';
@@ -38,7 +38,7 @@ public function testEncodeSimple()
         self::assertEquals($expected, $this->encoder->encode($obj, 'url'));
     }
 
-    public function testEncodeCamelToSnakeCaseNames()
+    public function testEncodeCamelToSnakeCaseNames(): void
     {
         $obj = $this->getObject();
 
@@ -50,15 +50,15 @@ public function testEncodeCamelToSnakeCaseNames()
     /**
      * @return string
      */
-    protected function getUrlSource()
+    protected function getUrlSource(): string
     {
         return 'foo=foo&foo_bar=fooBar';
     }
 
     /**
      * @return \stdClass
      */
-    protected function getObject()
+    protected function getObject(): \stdClass
     {
         $obj = new \stdClass();
         $obj->foo = 'foo';

diff --git a/composer.json b/composer.json
@@ -15,23 +15,22 @@
     ],
     "require": {
         "php": ">=7.1.3",
-        "symfony/serializer" : "~4.2|~5.0",
-        "symfony/monolog-bridge": "~4.0|~5.0",
-        "symfony/dependency-injection": "~4.0|~5.0",
-        "symfony/config": "~4.0|~5.0",
-        "symfony/http-kernel": "~4.0|~5.0",
-        "symfony/property-info": "~4.0|~5.0",
-        "symfony/property-access": "~4.0|~5.0",
-        "symfony/yaml": "~4.0|~5.0",
+        "symfony/serializer": "~4.2|~5.0|~6.0",
+        "symfony/monolog-bridge": "~4.0|~5.0|~6.0",
+        "symfony/dependency-injection": "~4.0|~5.0|~6.0",
+        "symfony/config": "~4.0|~5.0|~6.0",
+        "symfony/http-kernel": "~4.0|~5.0|~6.0",
+        "symfony/property-info": "~4.0|~5.0|~6.0",
+        "symfony/property-access": "~4.0|~5.0|~6.0",
+        "symfony/yaml": "~4.0|~5.0|~6.0",
         "monolog/monolog": "~1.22",
         "fig/http-message-util": "^1.1.2",
         "auto1-oss/service-api-request": "^1.0"
     },
     "require-dev": {
-        "symfony/console": "~3.0|~4.0|~5.0",
-        "phpunit/phpunit": "^5.7",
-        "symfony/phpunit-bridge": "^3.3.8",
-        "phpspec/prophecy": "^1.7.2"
+        "symfony/console": "~3.0|~4.0|~5.0|~6.0",
+        "phpunit/phpunit": "^7.5|^8.0|^9.0",
+        "phpspec/prophecy-phpunit": "^1.1"
     },
     "autoload": {
         "psr-4": { "Auto1\\ServiceAPIComponentsBundle\\": "" }

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -7,26 +7,26 @@
          colors="true"
          bootstrap="vendor/autoload.php"
 >
-    <php>
-        <ini name="error_reporting" value="-1" />
-        <server name="KERNEL_CLASS" value="AppKernel" />
-    </php>
+  <php>
+    <ini name="error_reporting" value="-1" />
+    <server name="KERNEL_CLASS" value="AppKernel" />
+  </php>
 
-    <testsuites>
-        <testsuite name="Auto1 ServiceApiComponentsBundle Test Suite">
-            <directory>./Tests</directory>
-        </testsuite>
-    </testsuites>
+  <testsuites>
+    <testsuite name="Auto1 ServiceApiComponentsBundle Test Suite">
+      <directory>./Tests</directory>
+    </testsuite>
+  </testsuites>
 
-    <filter>
-        <whitelist>
-            <directory>.</directory>
-            <exclude>
-                <directory>./_code_coverage</directory>
-                <directory>./Resources</directory>
-                <directory>./Tests</directory>
-                <directory>./vendor</directory>
-            </exclude>
-        </whitelist>
-    </filter>
+  <filter>
+    <whitelist>
+      <directory>.</directory>
+      <exclude>
+        <directory>./_code_coverage</directory>
+        <directory>./Resources</directory>
+        <directory>./Tests</directory>
+        <directory>./vendor</directory>
+      </exclude>
+    </whitelist>
+  </filter>
 </phpunit>