Merge pull request #37 from liip/doctrine-annotations-dependency

Directly add doctrine/annotations dependency

Author: dbu

.github/workflows/ci.yml

@@ -14,9 +14,9 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php-version: ['7.2', '7.3', '7.4', '8.0', '8.1', '8.2']
+        php-version: ['7.4', '8.0', '8.1', '8.2']
         include:
-          - php-version: '7.2'
+          - php-version: '7.4'
             composer-flags: '--prefer-stable --prefer-lowest'
     steps:
       - name: Check out code into the workspace
@@ -25,17 +25,14 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php-version }}
-      - name: Validate composer.json
-        run: composer validate --strict --no-check-lock
+      - name: Remove dev tools to not interfere with dependencies
+        run: composer remove --dev friendsofphp/php-cs-fixer phpstan/phpstan-phpunit phpstan/phpstan
       - name: Composer cache
         uses: actions/cache@v3
         with:
           path: ${{ env.HOME }}/.composer/cache
           key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
       - name: Install dependencies
         run: composer update ${{ matrix.composer-flags }} --prefer-dist --no-interaction
-      - name: PHPStan
-        if: ${{ matrix.php-version == '8.1' }}
-        run: composer phpstan-all
       - name: Run tests
         run: composer phpunit

.github/workflows/static.yml

@@ -0,0 +1,52 @@
+name: Static
+
+on:
+  push:
+    branches:
+      - '*.x'
+    tags:
+      - '[0-9].[0-9]+'
+  pull_request:
+
+jobs:
+  phpstan:
+    name: "PHPStan"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code into the workspace
+        uses: actions/checkout@v3
+      - name: Setup PHP 8.2
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.2
+      - name: Composer cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ env.HOME }}/.composer/cache
+          key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+      - name: Install dependencies
+        run: composer update --prefer-dist --no-interaction
+      - name: PHPStan
+        run: composer phpstan-all
+
+  cs:
+    name: "CS Fixer"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code into the workspace
+        uses: actions/checkout@v3
+      - name: Setup PHP 8.2
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.2
+      - name: Validate composer.json
+        run: composer validate --strict --no-check-lock
+      - name: Composer cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ env.HOME }}/.composer/cache
+          key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+      - name: Install dependencies
+        run: composer update --prefer-dist --no-interaction
+      - name: CS Fixer
+        run: composer cs-fixer

.gitignore

@@ -8,6 +8,6 @@
 ###< phpunit/phpunit ###
 
 ###> friendsofphp/php-cs-fixer ###
-/.php_cs
-/.php_cs.cache
+/.php-cs-fixer.php
+/.php-cs-fixer.cache
 ###< friendsofphp/php-cs-fixer ###

.php_cs.dist .php-cs-fixer.dist.php.php_cs.dist renamed to .php-cs-fixer.dist.php

@@ -2,11 +2,17 @@
 
 declare(strict_types=1);
 
-$finder = PhpCsFixer\Finder::create()
-    ->in(__DIR__)
-;
+$config = new PhpCsFixer\Config();
+
+$config->setFinder(
+    PhpCsFixer\Finder::create()
+        ->in([
+            __DIR__,
+        ])
+        ->notPath('src/ModelParser/JMSParserLegacy.php')
+);
 
-return PhpCsFixer\Config::create()
+$config
     ->setRiskyAllowed(true)
     ->setRules(
         [
@@ -48,7 +54,12 @@
 
             // The convention with phpunit has been to use assertions with the object context.
             'php_unit_test_case_static_method_calls' => false,
+
+            // Not supported in PHP 7
+            'get_class_to_class_keyword' => false,
+            'modernize_strpos' => false,
         ]
     )
-    ->setFinder($finder)
 ;
+
+return $config;

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+# 1.1.0 (unreleased)
+
+* Drop support for PHP 7.2 and PHP 7.3
+* Support doctrine annotations `2.x`
+
 # 1.0.0
 
 No changes since 0.6.1.

composer.json

@@ -14,16 +14,17 @@
         "issues": "https://github.com/liip/metadata-parser/issues"
     },
     "require": {
-        "php": "^7.2 || ^8.0",
+        "php": "^7.4 || ^8.0",
         "ext-json": "*",
+        "doctrine/annotations": "^1.13 || ^2.0.1",
         "psr/log": "^1|^2|^3"
     },
     "require-dev": {
         "doctrine/collections": "^1.6",
-        "friendsofphp/php-cs-fixer": "v2.18.7",
+        "friendsofphp/php-cs-fixer": "v3.17.0",
         "jms/serializer": "^2.3 || ^3",
-        "phpstan/phpstan": "^0.12.71",
-        "phpstan/phpstan-phpunit": "^0.12",
+        "phpstan/phpstan": "^1.0",
+        "phpstan/phpstan-phpunit": "^1.0",
         "phpunit/phpunit": "^8.5.15 || ^9.5"
     },
     "suggest": {
@@ -45,7 +46,7 @@
     },
     "scripts": {
         "fix-cs": "vendor/bin/php-cs-fixer fix -v",
-        "cs-fixer": "vendor/bin/php-cs-fixer fix --dry-run --diff --diff-format udiff -v",
+        "cs-fixer": "vendor/bin/php-cs-fixer fix --dry-run --diff -v",
         "phpstan": "vendor/bin/phpstan analyse",
         "phpstan-tests": "vendor/bin/phpstan analyse -c phpstan.tests.neon",
         "phpstan-all": [

src/Annotation/Preferred.php

@@ -11,6 +11,7 @@
  * different versions with JMS serializer, and not specifying any version.
  *
  * @Annotation
+ *
  * @Target({"METHOD", "PROPERTY"})
  */
 final class Preferred

src/Metadata/AbstractPropertyMetadata.php

@@ -42,7 +42,7 @@ abstract class AbstractPropertyMetadata implements \JsonSerializable
     /**
      * @var int|null
      */
-    private $maxDepth = null;
+    private $maxDepth;
 
     /**
      * Hashmap of custom information about this property.
@@ -109,11 +109,11 @@ public function hasCustomInformation(string $key): bool
     /**
      * Get the value stored as custom information, if it exists.
      *
-     * @throws \InvalidArgumentException if no such custom value is available for this property
-     *
      * @return mixed The information in whatever format it has been set
+     *
+     * @throws \InvalidArgumentException if no such custom value is available for this property
      */
-    public function getCustomInformation(string $key)
+    public function getCustomInformation(string $key): mixed
     {
         if (!\array_key_exists($key, $this->customInformation)) {
             throw new \InvalidArgumentException(sprintf('Property %s has no custom information %s', $this->name, $key));
@@ -206,7 +206,7 @@ protected function getMaxDepth(): ?int
         return $this->maxDepth;
     }
 
-    protected function setMaxDepth(?int $maxDepth)
+    protected function setMaxDepth(?int $maxDepth): void
     {
         $this->maxDepth = $maxDepth;
     }

src/Metadata/PropertyAccessor.php

@@ -6,15 +6,9 @@
 
 final class PropertyAccessor implements \JsonSerializable
 {
-    /**
-     * @var string|null
-     */
-    private $getterMethod;
+    private ?string $getterMethod;
 
-    /**
-     * @var string|null
-     */
-    private $setterMethod;
+    private ?string $setterMethod;
 
     public function __construct(?string $getterMethod, ?string $setterMethod)
     {
@@ -29,7 +23,7 @@ public static function none(): self
 
     public function isDefined(): bool
     {
-        return $this->hasGetterMethod() || $this->hasGetterMethod();
+        return $this->hasGetterMethod() || $this->hasSetterMethod();
     }
 
     public function hasGetterMethod(): bool
@@ -54,7 +48,7 @@ public function getSetterMethod(): ?string
 
     public function jsonSerialize(): array
     {
-        return \array_filter([
+        return array_filter([
             'getter_method' => $this->getterMethod,
             'setter_method' => $this->setterMethod,
         ]);

src/Metadata/PropertyMetadata.php

@@ -32,7 +32,7 @@ public function __construct(
         array $groups = [],
         PropertyAccessor $accessor = null,
         array $customInformation = [],
-        ?int $maxDepth = null
+        int $maxDepth = null
     ) {
         parent::__construct($name, $readOnly, $public);
         $this->serializedName = $serializedName;