Merge pull request #30 from MekDrop/add-phpstan

MekDrop · web-flow · commit dd845fda3467 · 2025-06-04T01:11:00.000+03:00
Added phpstan
diff --git a/.github/workflows/on_pull_request.yml b/.github/workflows/on_pull_request.yml
@@ -32,6 +32,8 @@ jobs:
         run: composer validate --strict --no-check-lock
       - name: Install Composer dependencies (with dev)
         run: composer install --no-progress --no-suggest --prefer-dist --optimize-autoloader
+      - name: PHPStan
+        run: composer phpstan
       - name: PHPUnit
         run: composer test
       - name: Install Composer dependencies (without dev)
@@ -67,4 +69,4 @@ jobs:
         run: gh pr merge --auto --squash "$PR_URL"
         env:
           PR_URL: ${{ github.event.pull_request.html_url }}
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}           
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/composer.json b/composer.json
@@ -28,9 +28,11 @@
     "xoops"
   ],
   "scripts": {
-    "test": "phpunit --testdox"
+    "test": "phpunit --testdox",
+    "phpstan": "phpstan analyse"
   },
   "require-dev": {
-    "phpunit/phpunit": "^12"
+    "phpunit/phpunit": "^12",
+    "phpstan/phpstan": "^2.1"
   }
 }
diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,9 @@
+parameters:
+    level: 5
+
+    paths:
+        - src
+        - tests
+
+    excludePaths:
+        - vendor
diff --git a/src/CriteriaCompo.php b/src/CriteriaCompo.php
@@ -76,14 +76,14 @@ public function getBindData(): array
     /**
      * @inheritDoc
      *
-     * @return Traversable<string, CriteriaElement>
+     * @return Traversable<Condition, CriteriaElement>
      *
      * @noinspection MethodShouldBeFinalInspection
      */
     public function getIterator(): Traversable
     {
-        foreach ($this->elements as $item) {
-            yield $item[1] => $item[0];
+        foreach ($this->elements as [$criteriaElement, $condition]) {
+            yield $condition => $criteriaElement;
         }
     }
 
@@ -102,7 +102,7 @@ public function render(bool $withBindVariables = false): ?string
             if ($first) {
                 $first = false;
             } else {
-                $ret .= ' ' . ($join instanceof Condition ? $join->value : $join) . ' ';
+                $ret .= ' ' . $join->value . ' ';
             }
             $ret .= '(' . $element->render($withBindVariables) . ')';
         }
diff --git a/src/CriteriaElement.php b/src/CriteriaElement.php
@@ -77,7 +77,7 @@ public function __set(string $name, mixed $value): void
     public function __isset(string $name): bool
     {
         return match ($name) {
-            'order' => $this->getOrder() !== null,
+            'order' => true,
             'sort' => !empty($this->getSort()),
             'limit' => !empty($this->getLimit()),
             'start' => !empty($this->getStart()),
diff --git a/src/CriteriaItem.php b/src/CriteriaItem.php
@@ -219,7 +219,7 @@ public function getBindData(): array
 
     private function isEmptyArrayButNotNullComparison(mixed $value): bool
     {
-        return is_array($value) && empty($value) && in_array($this->operator->value, [
+        return is_array($value) && empty($value) && in_array($this->operator, [
                 ComparisonOperator::IS_NOT_NULL,
                 ComparisonOperator::IS_NULL,
                 ComparisonOperator::BETWEEN,
diff --git a/tests/CriteriaCompoTest.php b/tests/CriteriaCompoTest.php
@@ -8,7 +8,6 @@
 use Imponeer\Database\Criteria\CriteriaItem;
 use Imponeer\Database\Criteria\Enum\Condition;
 use Imponeer\Database\Criteria\Enum\Order;
-use JsonException;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 use Random\RandomException;
@@ -31,14 +30,14 @@ final public static function provideCondition(): array
             foreach ([$condition, ' ' . $condition . ' ', strtolower($condition), ucfirst(strtolower($condition))] as $conditionVar) {
                 // first variant for compo
                 $compo1 = new CriteriaCompo();
-                $compo1->add(new CriteriaItem(sha1(random_int(PHP_INT_MIN, PHP_INT_MAX))));
-                $compo1->add(new CriteriaItem(sha1(random_int(PHP_INT_MIN, PHP_INT_MAX))), $conditionVar);
+                $compo1->add(new CriteriaItem(sha1((string) random_int(PHP_INT_MIN, PHP_INT_MAX))));
+                $compo1->add(new CriteriaItem(sha1((string) random_int(PHP_INT_MIN, PHP_INT_MAX))), $conditionVar);
                 $label = sprintf('Two columns with null values and condition %s', $conditionData->name);
                 $testsVariations[$label] = [$compo1, $conditionVar];
 
                 // 2nd variant for compo
-                $compo2 = new CriteriaCompo(new CriteriaItem(sha1(random_int(PHP_INT_MIN, PHP_INT_MAX))));
-                $compo2->add(new CriteriaItem(sha1(random_int(PHP_INT_MIN, PHP_INT_MAX))), $conditionVar);
+                $compo2 = new CriteriaCompo(new CriteriaItem(sha1((string) random_int(PHP_INT_MIN, PHP_INT_MAX))));
+                $compo2->add(new CriteriaItem(sha1((string) random_int(PHP_INT_MIN, PHP_INT_MAX))), $conditionVar);
                 $label = sprintf("One column with null value and condition %s", $conditionData->name);
                 $testsVariations[$label] = [$compo2, $conditionVar];
 
@@ -146,7 +145,7 @@ final public function testGroupBy(): void
     {
         $criteria = new CriteriaCompo();
         self::assertEmpty($criteria->getGroupBy(), 'Default group by is not empty');
-        $groupBy = sha1(random_int(PHP_INT_MIN, PHP_INT_MAX));
+        $groupBy = sha1((string) random_int(PHP_INT_MIN, PHP_INT_MAX));
         $criteria->setGroupBy($groupBy);
         self::assertNotEmpty($criteria->getGroupBy(), 'Group by was set but value wasn\'t modified');
         self::assertStringStartsWith('GROUP BY', trim($criteria->getGroupBy()), 'Non empty group by doesn\' starts with "GROUP BY"');
@@ -162,7 +161,7 @@ final public function testSortBy(): void
     {
         $criteria = new CriteriaCompo();
         self::assertEmpty($criteria->getSort(), 'Default sort by is not empty');
-        $sort = sha1(random_int(PHP_INT_MIN, PHP_INT_MAX));
+        $sort = sha1((string) random_int(PHP_INT_MIN, PHP_INT_MAX));
         $criteria->setSort($sort);
         self::assertNotEmpty($criteria->getSort(), 'Sort by was set but value wasn\'t modified');
         self::assertStringContainsString($sort, $criteria->getSort(), 'Sort by value doesn\'t exists');
diff --git a/tests/CriteriaItemTest.php b/tests/CriteriaItemTest.php
@@ -24,7 +24,7 @@ class CriteriaItemTest extends TestCase
      */
     final public static function provideComparisonOperators(): array
     {
-        $column = sha1(random_int(PHP_INT_MIN, PHP_INT_MAX));
+        $column = sha1((string) random_int(PHP_INT_MIN, PHP_INT_MAX));
         $specialOperators = [
             ComparisonOperator::BETWEEN->name,
             ComparisonOperator::NOT_BETWEEN->name,
@@ -33,7 +33,7 @@ final public static function provideComparisonOperators(): array
         ];
         $possibleValues = [
             null,  // null value
-            md5(random_int(PHP_INT_MIN, PHP_INT_MAX)),  // random string
+            md5((string) random_int(PHP_INT_MIN, PHP_INT_MAX)),  // random string
             random_int(PHP_INT_MIN, PHP_INT_MAX), // random int
             mt_rand() / mt_getrandmax(), // random float
             true, // true
@@ -142,7 +142,7 @@ final public static function provideOrder(): Generator
     #[DataProvider('provideOrder')]
     final public function testOrder(Order|string $order): void
     {
-        $criteria = new CriteriaItem(sha1(random_int(PHP_INT_MIN, PHP_INT_MAX)));
+        $criteria = new CriteriaItem(sha1((string) random_int(PHP_INT_MIN, PHP_INT_MAX)));
         self::assertSame(Order::ASC->value, $criteria->getOrder()->value, 'Default order is not correct');
         $criteria->setOrder($order);
         self::assertSame(strtoupper(trim($order)), $criteria->getOrder()->value, 'Order ' . $order . ' does\'t sets');
@@ -155,9 +155,9 @@ final public function testOrder(Order|string $order): void
      */
     final public function testGroupBy(): void
     {
-        $criteria = new CriteriaItem(sha1(random_int(PHP_INT_MIN, PHP_INT_MAX)));
+        $criteria = new CriteriaItem(sha1((string) random_int(PHP_INT_MIN, PHP_INT_MAX)));
         self::assertEmpty($criteria->getGroupBy(), 'Default group by is not empty');
-        $groupBy = sha1(random_int(PHP_INT_MIN, PHP_INT_MAX));
+        $groupBy = sha1((string) random_int(PHP_INT_MIN, PHP_INT_MAX));
         $criteria->setGroupBy($groupBy);
         self::assertNotEmpty($criteria->getGroupBy(), 'Group by was set but value wasn\'t modified');
         self::assertStringStartsWith('GROUP BY', trim($criteria->getGroupBy()), 'Non empty group by doesn\' starts with "GROUP BY"');
@@ -170,9 +170,9 @@ final public function testGroupBy(): void
      */
     final public function testSortBy(): void
     {
-        $criteria = new CriteriaItem(sha1(random_int(PHP_INT_MIN, PHP_INT_MAX)));
+        $criteria = new CriteriaItem(sha1((string) random_int(PHP_INT_MIN, PHP_INT_MAX)));
         self::assertEmpty($criteria->getSort(), 'Default sort by is not empty');
-        $sort = sha1(random_int(PHP_INT_MIN, PHP_INT_MAX));
+        $sort = sha1((string) random_int(PHP_INT_MIN, PHP_INT_MAX));
         $criteria->setSort($sort);
         self::assertNotEmpty($criteria->getSort(), 'Sort by was set but value wasn\'t modified');
         self::assertStringContainsString($sort, $criteria->getSort(), 'Sort by value doesn\'t exists');
@@ -184,7 +184,7 @@ final public function testSortBy(): void
      */
     final public function testPartialResults(): void
     {
-        $criteria = new CriteriaItem(sha1(random_int(PHP_INT_MIN, PHP_INT_MAX)));
+        $criteria = new CriteriaItem(sha1((string) random_int(PHP_INT_MIN, PHP_INT_MAX)));
         self::assertSame(0, $criteria->getLimit(), 'Default limit is not 0');
         self::assertSame(0, $criteria->getStart(), 'Default start is not 0');
         $limit = random_int(1, PHP_INT_MAX);

Original file line number	Diff line number	Diff line change
`@@ -28,9 +28,11 @@`
`28`	`28`	`"xoops"`
`29`	`29`	`],`
`30`	`30`	`"scripts": {`
`31`		`- "test": "phpunit --testdox"`
	`31`	`+ "test": "phpunit --testdox",`
	`32`	`+ "phpstan": "phpstan analyse"`
`32`	`33`	`},`
`33`	`34`	`"require-dev": {`
`34`		`- "phpunit/phpunit": "^12"`
	`35`	`+ "phpunit/phpunit": "^12",`
	`36`	`+ "phpstan/phpstan": "^2.1"`
`35`	`37`	`}`
`36`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -76,14 +76,14 @@ public function getBindData(): array`
`76`	`76`	`/**`
`77`	`77`	`* @inheritDoc`
`78`	`78`	`*`
`79`		`- * @return Traversable<string, CriteriaElement>`
	`79`	`+ * @return Traversable<Condition, CriteriaElement>`
`80`	`80`	`*`
`81`	`81`	`* @noinspection MethodShouldBeFinalInspection`
`82`	`82`	`*/`
`83`	`83`	`public function getIterator(): Traversable`
`84`	`84`	`{`
`85`		`- foreach ($this->elements as $item) {`
`86`		`- yield $item[1] => $item[0];`
	`85`	`+ foreach ($this->elements as [$criteriaElement, $condition]) {`
	`86`	`+ yield $condition => $criteriaElement;`
`87`	`87`	`}`
`88`	`88`	`}`
`89`	`89`
`@@ -102,7 +102,7 @@ public function render(bool $withBindVariables = false): ?string`
`102`	`102`	`if ($first) {`
`103`	`103`	`$first = false;`
`104`	`104`	`} else {`
`105`		`- $ret .= ' ' . ($join instanceof Condition ? $join->value : $join) . ' ';`
	`105`	`+ $ret .= ' ' . $join->value . ' ';`
`106`	`106`	`}`
`107`	`107`	`$ret .= '(' . $element->render($withBindVariables) . ')';`
`108`	`108`	`}`
Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ public function __set(string $name, mixed $value): void`
`77`	`77`	`public function __isset(string $name): bool`
`78`	`78`	`{`
`79`	`79`	`return match ($name) {`
`80`		`- 'order' => $this->getOrder() !== null,`
	`80`	`+ 'order' => true,`
`81`	`81`	`'sort' => !empty($this->getSort()),`
`82`	`82`	`'limit' => !empty($this->getLimit()),`
`83`	`83`	`'start' => !empty($this->getStart()),`
Original file line number	Diff line number	Diff line change
`@@ -219,7 +219,7 @@ public function getBindData(): array`
`219`	`219`
`220`	`220`	`private function isEmptyArrayButNotNullComparison(mixed $value): bool`
`221`	`221`	`{`
`222`		`- return is_array($value) && empty($value) && in_array($this->operator->value, [`
	`222`	`+ return is_array($value) && empty($value) && in_array($this->operator, [`
`223`	`223`	`ComparisonOperator::IS_NOT_NULL,`
`224`	`224`	`ComparisonOperator::IS_NULL,`
`225`	`225`	`ComparisonOperator::BETWEEN,`