Merge pull request #31 from MekDrop/add-phpcs

Added phpcs

Author: MekDrop

.github/workflows/on_pull_request.yml

@@ -34,6 +34,8 @@ jobs:
         run: composer install --no-progress --no-suggest --prefer-dist --optimize-autoloader
       - name: PHPStan
         run: composer phpstan
+      - name: PHPCS
+        run: composer phpcs
       - name: PHPUnit
         run: composer test
       - name: Install Composer dependencies (without dev)

composer.json

@@ -29,10 +29,14 @@
   ],
   "scripts": {
     "test": "phpunit --testdox",
-    "phpstan": "phpstan analyse"
+    "phpstan": "phpstan analyse",
+    "phpcs": "vendor/bin/phpcs",
+    "phpcbf": "vendor/bin/phpcbf"
   },
   "require-dev": {
     "phpunit/phpunit": "^12",
-    "phpstan/phpstan": "^2.1"
+    "phpstan/phpstan": "^2.1",
+    "squizlabs/php_codesniffer": "^3.13",
+    "fakerphp/faker": "^1.24"
   }
 }

phpcs.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<ruleset name="Project Rules">
+    <description>Project coding standard using PSR-12.</description>
+    <rule ref="PSR12"/>
+    <file>src</file>
+    <file>tests</file>
+</ruleset>
+

src/CriteriaCompo.php

@@ -117,4 +117,4 @@ public function __toString(): string
     {
         return $this->render() . 'A';
     }
-}
+}

src/CriteriaElement.php

@@ -18,7 +18,11 @@
  */
 abstract class CriteriaElement implements Stringable
 {
-    use GroupByTrait, OrderByTrait, PartialResultsTrait, RenderingTrait, SortByTrait;
+    use GroupByTrait;
+    use OrderByTrait;
+    use PartialResultsTrait;
+    use RenderingTrait;
+    use SortByTrait;
 
     /**
      * Gets data for rendered query for binding
@@ -85,4 +89,4 @@ public function __isset(string $name): bool
             default => false,
         };
     }
-}
+}

src/CriteriaItem.php

@@ -16,7 +16,6 @@
  */
 class CriteriaItem extends CriteriaElement
 {
-
     protected ?string $prefix = null;
     protected ?string $function = null;
     protected null|string|int $column = null;
@@ -39,19 +38,18 @@ class CriteriaItem extends CriteriaElement
      * @param string|null $function
      */
     public function __construct(
-        string|int                $column,
-        mixed                     $value = null,
+        string|int $column,
+        mixed $value = null,
         ComparisonOperator|string $operator = '=',
-        ?string                   $prefix = null,
-        ?string                   $function = null
-    )
-    {
+        ?string $prefix = null,
+        ?string $function = null
+    ) {
         parent::__construct();
 
         $this->prefix = $prefix;
         $this->function = $function;
         $this->column = $column;
-        $this->operator = $operator instanceof ComparisonOperator ? $operator : ComparisonOperator::from(strtoupper(trim($operator)));
+        $this->operator = ComparisonOperator::resolve($operator);
 
         if (is_string($value) && str_starts_with($value, '(')) {
             $this->data[] = $value;
@@ -140,9 +138,17 @@ public function render(bool $withBindVariables = false): ?string
                 break;
             default:
                 if ($withBindVariables) {
-                    $clause .= sprintf(" %s %s", $this->operator->value, $this->prepareRenderedValue(current($this->data)));
+                    $clause .= sprintf(
+                        " %s %s",
+                        $this->operator->value,
+                        $this->prepareRenderedValue(current($this->data))
+                    );
                 } else {
-                    $clause .= sprintf(" %s :%s", $this->operator->value, key($this->data));
+                    $clause .= sprintf(
+                        " %s :%s",
+                        $this->operator->value,
+                        key($this->data)
+                    );
                 }
         }
 
@@ -172,7 +178,7 @@ protected function prepareRenderedValue(null|bool|object|string|float|array $val
         }
 
         if (is_object($value)) {
-            if ((interface_exists(Stringable::class) && ($value instanceof Stringable)) || method_exists($value, '__toString')) {
+            if ($value instanceof Stringable) {
                 return $this->addSlashes((string)$value);
             }
 
@@ -234,4 +240,4 @@ public function __toString(): string
     {
         return $this->render();
     }
-}
+}

src/Enum/ComparisonOperator.php

@@ -9,7 +9,6 @@
  */
 enum ComparisonOperator: string
 {
-
     /**
      * NULL value test
      */
@@ -99,4 +98,13 @@ enum ComparisonOperator: string
      * Whether string matches regular expression
      */
     case RLIKE = 'RLIKE';
-}
+
+    public static function resolve(string|ComparisonOperator $operator): ComparisonOperator
+    {
+        if (is_string($operator)) {
+            return self::from(strtoupper(trim($operator)));
+        }
+
+        return $operator;
+    }
+}

src/Enum/Condition.php

@@ -9,7 +9,6 @@
  */
 enum Condition: string
 {
-
     /**
      * Use AND
      */
@@ -24,5 +23,4 @@ enum Condition: string
      * Use XOR
      */
     case XOR = 'XOR';
-
-}
+}

src/Enum/Order.php

@@ -2,15 +2,13 @@
 
 namespace Imponeer\Database\Criteria\Enum;
 
-
 /**
  * Defines how to order results
  *
  * @package Imponeer\Database\Criteria\Enum
  */
 enum Order: string
 {
-
     /**
      * Sort in ASC mode
      */
@@ -20,5 +18,4 @@ enum Order: string
      * Sort in DESC mode
      */
     case DESC = 'DESC';
-
-}
+}

src/Helpers/UniqueBindParam.php

@@ -12,7 +12,7 @@ final class UniqueBindParam
     /**
      * Last generated bind suffix ID
      */
-    static private int $lastGeneratedBindSuffixId = 0;
+    private static int $lastGeneratedBindSuffixId = 0;
 
     /**
      * UniqueBindParam constructor.
@@ -30,5 +30,4 @@ public static function generate(string $column): string
     {
         return 'col_' . $column . '_' . (++self::$lastGeneratedBindSuffixId);
     }
-
-}
+}