Merge branch 'feat-quiqqer-tooling' into 'next-2.x'

Add QUIQQER Tooling

See merge request !33

.gitattributes

+
+# Ignore developer files when exporting
+.gitattributes         export-ignore
+.gitignore             export-ignore
+.gitlab-ci.yml         export-ignore
+.phive                 export-ignore
+captainhook.json       export-ignore
+phpcs.xml.dist         export-ignore
+phpstan-baseline.neon  export-ignore
+phpstan.dist.neon      export-ignore
+phpunit.dist.xml       export-ignore
+tests                  export-ignore
+
+# Explicitly set file type and line endings for PHP files, improves git diff output
+*.php     text eol=lf diff=php
\ No newline at end of file

.gitignore

@@ -2,3 +2,11 @@ tools/
 phpstan.neon
 .phpunit.result.cache
 phpunit.xml
+
+tools/
+
+phpstan.neon
+
+.phpunit.result.cache
+
+phpunit.xml

.gitlab-ci.yml

 include:
-  - project: 'quiqqer/stabilization/semantic-release'
-    file: '/ci-templates/.gitlab-ci.yml'
\ No newline at end of file
+  - component: dev.quiqqer.com/quiqqer/stabilization/ci-cd-components/quiqqer-package-bundle/quiqqer-package-bundle@main
+
+# Remove the entire phpunit-php8.1 block, to allow PHPUnit to run on PHP 8.1 in your pipeline
+phpunit-php8.1:
+  rules:
+    - when: never
+
+# Remove the entire phpunit-php8.2 block, to allow PHPUnit to run on PHP 8.2 in your pipeline
+phpunit-php8.2:
+  rules:
+    - when: never
+
+# Remove the entire phpunit-php8.3 block, to allow PHPUnit to run on PHP 8.3 in your pipeline
+phpunit-php8.3:
+  rules:
+    - when: never
\ No newline at end of file

.phive/phars.xml

 <?xml version="1.0" encoding="UTF-8"?>
 <phive xmlns="https://phar.io/phive">
-  <phar name="phpstan" version="^1.10.67" installed="1.10.67" location="./tools/phpstan" copy="false"/>
+  <phar name="phpstan" version="1.11.8" installed="1.11.8" location="./tools/phpstan" copy="false"/>
+  <phar name="phpunit" version="^10.5.20" installed="10.5.20" location="./tools/phpunit" copy="false"/>
+  <phar name="phpcs" version="^3.10.1" installed="3.10.1" location="./tools/phpcs" copy="false"/>
+  <phar name="phpcbf" version="^3.10.1" installed="3.10.1" location="./tools/phpcbf" copy="false"/>
+  <phar name="captainhook" version="^5.23.3" installed="5.23.3" location="./tools/captainhook" copy="false"/>
 </phive>

CONTRIBUTING.md

+# Contributing
+
+This package follows the [QUIQQER contribution guidelines](https://dev.quiqqer.com/quiqqer/stabilization/documentation/-/wikis/home).
\ No newline at end of file

captainhook.json

+{
+    "pre-commit": {
+        "enabled": true,
+        "actions": [
+            {
+                "action": "\\CaptainHook\\App\\Hook\\PHP\\Action\\Linting"
+            },
+            {
+                "action": "composer test"
+            }
+        ]
+    }
+}
\ No newline at end of file

composer.json

 {
-  "name": "quiqqer/bricks",
-  "type": "quiqqer-module",
-  "description": "The brick system allows you to design your website according to your wishes. You can quickly move, create, or remove bricks to different places in the template.",
-  "license": "GPL-3.0+",
-  "authors": [
-    {
-      "name": "Henning Leutz",
-      "email": "leutz@pcsg.de",
-      "homepage": "https://www.pcsg.de",
-      "role": "Developer"
+    "name": "quiqqer/bricks",
+    "type": "quiqqer-module",
+    "description": "The brick system allows you to design your website according to your wishes. You can quickly move, create, or remove bricks to different places in the template.",
+    "license": "GPL-3.0+",
+    "authors": [
+        {
+            "name": "Henning Leutz",
+            "email": "leutz@pcsg.de",
+            "homepage": "https://www.pcsg.de",
+            "role": "Developer"
+        }
+    ],
+    "support": {
+        "email": "support@pcsg.de"
+    },
+    "require": {
+        "php": "^8.1",
+        "quiqqer/core": "^2",
+        "quiqqer/qui": "^1",
+        "quiqqer/utils": "^2",
+        "quiqqer/mobile-detection": "^1",
+        "quiqqer-asset/hammerjs": "^2",
+        "quiqqer-asset/mustache": "*",
+        "ramsey/uuid": "^3|^4",
+        "quiqqer-asset/glidejs-glide": "^3"
+    },
+    "suggest": {
+        "quiqqer/gallery": "Present your photos, products and pictures in elaborate and beautiful galleries."
+    },
+    "autoload": {
+        "psr-4": {
+            "QUI\\Bricks\\": "src/QUI/Bricks"
+        }
+    },
+    "scripts": {
+        "test": [
+            "@dev:lint",
+            "@dev:phpunit"
+        ],
+        "dev:phpunit": "./tools/phpunit",
+        "dev:lint": [
+            "@dev:lint:phpstan",
+            "@dev:lint:style"
+        ],
+        "dev:lint:phpstan": "./tools/phpstan",
+        "dev:lint:style": "./tools/phpcs",
+        "dev:lint:style:fix": "./tools/phpcbf",
+        "dev:init": [
+            "@dev:init:check-requirements",
+            "@dev:init:tools",
+            "@dev:init:git-hooks"
+        ],
+        "dev:init:check-requirements": [
+            "which composer > /dev/null || (echo 'Error: composer has to be globally installed'; exit 1)",
+            "which phive > /dev/null || (echo 'Error: PHIVE has to be globally installed'; exit 1)"
+        ],
+        "dev:init:tools": "phive install --temporary",
+        "dev:init:git-hooks": "./tools/captainhook install --only-enabled --force"
+    },
+    "scripts-aliases": {
+        "test": [
+            "dev:test"
+        ]
+    },
+    "scripts-descriptions": {
+        "test": "Runs linting, static analysis, and unit tests.",
+        "dev:phpunit": "Run PHPUnit test suites",
+        "dev:lint": "Run PHPStan and code style check",
+        "dev:lint:phpstan": "Run PHPStan",
+        "dev:lint:style": "Run code style check (PHP_CodeSniffer)",
+        "dev:lint:style:fix": "Try to fix code style errors automatically",
+        "dev:init": "Initialize the developer tooling (tools and git hooks)",
+        "dev:init:check-requirements": "Check if the necessary requirements are met",
+        "dev:init:tools": "Install all developer tools (requires PHIVE)",
+        "dev:init:git-hooks": "Install all git hooks (may require tools to be installed)"
     }
-  ],
-  "support": {
-    "email": "support@pcsg.de"
-  },
-  "require": {
-    "php": "^8.1",
-    "quiqqer/core": "^2",
-    "quiqqer/qui": "^1",
-    "quiqqer/utils": "^2",
-    "quiqqer/mobile-detection": "^1",
-    "quiqqer-asset/hammerjs": "^2",
-    "quiqqer-asset/mustache": "*",
-    "ramsey/uuid": "^3|^4",
-    "quiqqer-asset/glidejs-glide": "^3"
-  },
-  "suggest": {
-    "quiqqer/gallery": "Present your photos, products and pictures in elaborate and beautiful galleries."
-  },
-  "autoload": {
-    "psr-4": {
-      "QUI\\Bricks\\": "src/QUI/Bricks"
-    }
-  }
-}
+}
\ No newline at end of file

phpstan-baseline.neon

+parameters:
+	ignoreErrors:
+		-
+			message: "#^Property QUI\\\\Bricks\\\\Brick\\:\\:\\$uniqueId \\(string\\) does not accept default value of type false\\.$#"
+			count: 1
+			path: src/QUI/Bricks/Brick.php
+
+		-
+			message: "#^Call to an undefined method QUI\\\\Interfaces\\\\Projects\\\\Media\\\\File\\:\\:getImages\\(\\)\\.$#"
+			count: 1
+			path: src/QUI/Bricks/Controls/Slider/BasicSlider.php
+
+		-
+			message: "#^Call to an undefined method DOMNode\\:\\:getAttribute\\(\\)\\.$#"
+			count: 2
+			path: src/QUI/Bricks/Manager.php
+
+		-
+			message: "#^Method QUI\\\\Bricks\\\\Manager\\:\\:copyBrick\\(\\) should return int but returns string\\|false\\.$#"
+			count: 1
+			path: src/QUI/Bricks/Manager.php
+
+		-
+			message: "#^Method QUI\\\\Bricks\\\\Manager\\:\\:createBrickForProject\\(\\) should return int but returns string\\|false\\.$#"
+			count: 1
+			path: src/QUI/Bricks/Manager.php
+
+		-
+			message: "#^Parameter \\#1 \\$Setting of method QUI\\\\Bricks\\\\Manager\\:\\:parseSettingToBrickArray\\(\\) expects DOMElement, DOMNode given\\.$#"
+			count: 2
+			path: src/QUI/Bricks/Manager.php
+
+		-
+			message: "#^Parameter \\#2 \\$Site of method QUI\\\\Bricks\\\\Manager\\:\\:createUniqueBrickId\\(\\) expects QUI\\\\Projects\\\\Site, QUI\\\\Interfaces\\\\Projects\\\\Site given\\.$#"
+			count: 2
+			path: src/QUI/Bricks/Manager.php
+
+		-
+			message: "#^Parameter \\#2 \\$code of class QUI\\\\Exception constructor expects int, string given\\.$#"
+			count: 1
+			path: src/QUI/Bricks/Manager.php
+
+		-
+			message: "#^Call to an undefined method DOMNode\\:\\:getAttribute\\(\\)\\.$#"
+			count: 7
+			path: src/QUI/Bricks/Utils.php
+
+		-
+			message: "#^Parameter \\#1 \\$Brick of static method QUI\\\\Bricks\\\\Utils\\:\\:parseAreaToArray\\(\\) expects DOMElement, DOMNode given\\.$#"
+			count: 4
+			path: src/QUI/Bricks/Utils.php

phpstan.dist.neon

@@ -2,7 +2,7 @@ includes:
 	- phpstan-baseline.neon
 
 parameters:
-    level: 1
+    level: 5
     paths:
         - src
         - ajax

phpunit.dist.xml

+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="tests/phpunit-bootstrap.php">
+    <testsuites>
+        <testsuite name="Tests">
+            <directory>tests/</directory>
+        </testsuite>
+    </testsuites>
+</phpunit>

src/QUI/Bricks/Manager.php

@@ -259,7 +259,7 @@ public function existsUniqueBrickId(string $uid): bool
                 ],
                 'limit' => 1
             ]);
-        } catch (QUI\DataBase\Exception $Exception) {
+        } catch (QUI\Database\Exception $Exception) {
             QUI\System\Log::addError($Exception->getMessage());
 
             return false;
@@ -1238,7 +1238,7 @@ protected function getInheritedBricks(
                         'area' => $brickArea
                     ]
                 ]);
-            } catch (QUI\DataBase\Exception $Exception) {
+            } catch (QUI\Database\Exception $Exception) {
                 QUI\System\Log::addError($Exception->getMessage());
                 continue;
             }

tests/phpunit-bootstrap.php

+<?php
+
+if (!defined('QUIQQER_SYSTEM')) {
+    define('QUIQQER_SYSTEM', true);
+}
+
+if (!defined('QUIQQER_AJAX')) {
+    define('QUIQQER_AJAX', true);
+}
+
+require_once __DIR__ . '/../../../../bootstrap.php';