Merge pull request #72 from MortalFlesh/feature/require-php-8

Require php 8

Author: MortalFlesh

.github/workflows/tests.yaml

@@ -12,10 +12,10 @@ jobs:
 
         strategy:
             matrix:
-                php-version: ['7.4']
+                php-version: ['8.0']
                 dependencies: ['']
                 include:
-                    - { php-version: '7.4', dependencies: '--prefer-lowest --prefer-stable' }
+                    - { php-version: '8.0', dependencies: '--prefer-lowest --prefer-stable' }
 
         name: Unit tests - PHP ${{ matrix.dependencies }}
 
@@ -65,7 +65,7 @@ jobs:
             - name: Setup PHP
               uses: shivammathur/setup-php@v2
               with:
-                  php-version: '7.4'
+                  php-version: '8.0'
                   extensions: mbstring, intl
 
             - name: Install dependencies

CHANGELOG.md

@@ -4,6 +4,9 @@
 <!-- There should always be "Unreleased" section at the beginning. -->
 
 ## Unreleased
+- Require php 8.0
+- [**BC**] Use strong types (even union-types) (_it is considered BC, because some types annotated before were not correct in all places_)
+- Update dependencies
 
 ## 2.2.0 - 2021-04-09
 - Require php 7.4 and update dependencies

composer.json

@@ -4,10 +4,10 @@
     "description": "Parser/builder for filters from API query parameters.",
     "license": "MIT",
     "require": {
-        "php": "^7.4",
+        "php": "^8.0",
         "ext-mbstring": "*",
         "beberlei/assert": "^3.0",
-        "mf/collections-php": "^5.0"
+        "mf/collections-php": "^6.0"
     },
     "require-dev": {
         "doctrine/orm": "^2.7",

ecs.php

@@ -3,6 +3,8 @@
 declare(strict_types=1);
 
 use Lmc\CodingStandard\Sniffs\Naming\ClassNameSuffixByParentSniff;
+use PHP_CodeSniffer\Standards\Squiz\Sniffs\WhiteSpace\OperatorSpacingSniff;
+use PhpCsFixer\Fixer\Operator\BinaryOperatorSpacesFixer;
 use PhpCsFixer\Fixer\Phpdoc\NoSuperfluousPhpdocTagsFixer;
 use PhpCsFixer\Fixer\PhpUnit\PhpUnitTestAnnotationFixer;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
@@ -13,7 +15,11 @@
 
     $parameters->set(
         Option::SKIP,
-        ['SlevomatCodingStandard\Sniffs\Exceptions\ReferenceThrowableOnlySniff.ReferencedGeneralException' => ['tests/Exception/*.php']]
+        [
+            'SlevomatCodingStandard\Sniffs\Exceptions\ReferenceThrowableOnlySniff.ReferencedGeneralException' => ['tests/Exception/*.php'],
+            OperatorSpacingSniff::class => null,
+            BinaryOperatorSpacesFixer::class => null,
+        ]
     );
 
     $containerConfigurator->import(__DIR__ . '/vendor/lmc/coding-standard/ecs.php');

src/ApiFilter.php

@@ -279,7 +279,7 @@ public function registerFunction(string $functionName, array $parameters, callab
      * @throws ApiFilterExceptionInterface
      * @return mixed of type <U> - the output of the registered function
      */
-    public function executeFunction(string $functionName, array $queryParameters, $filterable)
+    public function executeFunction(string $functionName, array $queryParameters, mixed $filterable): mixed
     {
         $filters = $this->parser->parse($queryParameters);
         $this->applicator->setFilters($filters);
@@ -311,7 +311,7 @@ public function executeFunction(string $functionName, array $queryParameters, $f
      * @throws ApiFilterExceptionInterface
      * @return ITuple (<U>, array) where <U> is the output of the registered function and array contains prepared values
      */
-    public function applyFunction(string $functionName, array $queryParameters, $filterable): ITuple
+    public function applyFunction(string $functionName, array $queryParameters, mixed $filterable): ITuple
     {
         try {
             $filters = $this->parser->parse($queryParameters);

src/Assertion.php

@@ -12,12 +12,12 @@ class Assertion extends BaseAssertion
 
     /**
      * Assert that value is instance of ITuple or string value containing a Tuple.
-     *
-     * @param mixed $value
-     * @param string|callable|null $message
      */
-    public static function isTuple($value, $message = null, ?string $propertyPath = null): bool
-    {
+    public static function isTuple(
+        mixed $value,
+        string|callable|null $message = null,
+        ?string $propertyPath = null
+    ): bool {
         if (self::isTupleValue($value)) {
             return true;
         }
@@ -30,8 +30,7 @@ public static function isTuple($value, $message = null, ?string $propertyPath =
         throw static::createException($value, $message, 0, $propertyPath);
     }
 
-    /** @param mixed $value */
-    private static function isTupleValue($value): bool
+    private static function isTupleValue(mixed $value): bool
     {
         return $value instanceof ITuple || (is_string($value) && mb_substr($value, 0, 1) === '(');
     }

src/Entity/Filterable.php

@@ -6,22 +6,18 @@
 
 class Filterable
 {
-    /** @var mixed */
-    private $value;
-
     /** @param mixed $value This must be supported by any applicator */
-    public function __construct($value)
+    public function __construct(private mixed $value)
     {
         Assertion::notIsInstanceOf(
             $value,
             self::class,
             'Filterable must not contain another Filterable. Extract a value from Filterable or use it directly.'
         );
-        $this->value = $value;
     }
 
     /** @return mixed This must be supported by any applicator */
-    public function getValue()
+    public function getValue(): mixed
     {
         return $this->value;
     }

src/Entity/ParameterDefinition.php

@@ -8,11 +8,6 @@
 
 class ParameterDefinition
 {
-    private string $name;
-    private string $filter;
-    private string $column;
-    private ?Value $defaultValue;
-
     /**
      * Shortcut for creating parameter with just a name and a default value
      * Otherwise you would need to pass null as filter and column, or create default values for yourself
@@ -50,15 +45,13 @@ public static function fromArray(array $parameters): self
     }
 
     public function __construct(
-        string $name,
-        ?string $filter = Filter::EQUALS,
-        ?string $column = null,
-        ?Value $defaultValue = null
+        private string $name,
+        private ?string $filter = Filter::EQUALS,
+        private ?string $column = null,
+        private ?Value $defaultValue = null
     ) {
-        $this->name = $name;
         $this->filter = $filter ?? Filter::EQUALS;
         $this->column = $column ?? $name;
-        $this->defaultValue = $defaultValue;
     }
 
     public function getName(): string

src/Entity/Value.php

@@ -6,22 +6,16 @@
 
 class Value
 {
-    /** @var mixed */
-    private $value;
-
-    /** @param mixed $value */
-    public function __construct($value)
+    public function __construct(private mixed $value)
     {
         Assertion::notIsInstanceOf(
             $value,
             self::class,
             'Value must not contain another Value. Extract a value from Value or use it directly.'
         );
-        $this->value = $value;
     }
 
-    /** @return mixed */
-    public function getValue()
+    public function getValue(): mixed
     {
         return $this->value;
     }

src/Exception/InvalidArgumentException.php

@@ -6,35 +6,23 @@
 
 class InvalidArgumentException extends \InvalidArgumentException implements ApiFilterExceptionInterface, AssertionFailedException
 {
-    private ?string $propertyPath;
-    /** @var mixed */
-    private $value;
-    private array $constraints;
-
-    /**
-     * @param mixed $value
-     */
     public function __construct(
         string $message,
         int $code = null,
-        ?string $propertyPath = null,
-        $value = null,
-        array $constraints = null,
+        private ?string $propertyPath = null,
+        private mixed $value = null,
+        private array $constraints = [],
         \Throwable $previous = null
     ) {
         parent::__construct($message, (int) $code, $previous);
-        $this->propertyPath = $propertyPath;
-        $this->value = $value;
-        $this->constraints = $constraints ?? [];
     }
 
     public function getPropertyPath(): ?string
     {
         return $this->propertyPath;
     }
 
-    /** @return mixed */
-    public function getValue()
+    public function getValue(): mixed
     {
         return $this->value;
     }