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

Add QUIQQER Tooling

See merge request !2

.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

+
+tools/
+
+phpstan.neon
+
+.phpunit.result.cache
+
+phpunit.xml

.gitlab-ci.yml

+include:
+  - component: dev.quiqqer.com/quiqqer/stabilization/ci-cd-components/quiqqer-package-bundle/quiqqer-package-bundle@2
+    inputs:
+      quiqqer-major-version: 1
+
+# 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.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

LICENSE

+GPL-3.0+
\ 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\/interview",
-  "type": "quiqqer-plugin",
-  "description": "Extension for blog and news plugin. This plugin adds some new attributes and provides new bricks.",
-  "license": "GPL-3.0+",
-  "authors": [
-    {
-      "name": "Michael Danielczok",
-      "email": "michael@pcsg.de",
-      "homepage": "http:\/\/www.pcsg.de",
-      "role": "Developer"
+    "name": "quiqqer/interview",
+    "type": "quiqqer-plugin",
+    "description": "Extension for blog and news plugin. This plugin adds some new attributes and provides new bricks.",
+    "license": "GPL-3.0+",
+    "authors": [
+        {
+            "name": "Michael Danielczok",
+            "email": "michael@pcsg.de",
+            "homepage": "http://www.pcsg.de",
+            "role": "Developer"
+        },
+        {
+            "name": "Dominik Chrzanowski",
+            "email": "dominik.chrzanowski@gmail.com",
+            "role": "Developer"
+        }
+    ],
+    "support": {
+        "email": "support@pcsg.de"
     },
-    {
-      "name": "Dominik Chrzanowski",
-      "email": "dominik.chrzanowski@gmail.com",
-      "role": "Developer"
-    }
-  ],
-  "support": {
-    "email": "support@pcsg.de"
-  },
-  "require": {
-    "quiqqer\/quiqqer": ">=1.6|dev-master|dev-dev"
-  },
-  "suggest": {
-    "quiqqer\/blog": "Create your own online diary. With the provided page types, managing and creating your own blog is no longer a problem.",
-    "quiqqer\/news": "News functionality for the QUIQQER system."
-  },
-  "autoload": {
-    "psr-4": {
-      "QUI\\Interview\\": "src\/QUI\/Interview"
+    "require": {
+        "quiqqer/quiqqer": ">=1.6|dev-master|dev-dev"
+    },
+    "suggest": {
+        "quiqqer/blog": "Create your own online diary. With the provided page types, managing and creating your own blog is no longer a problem.",
+        "quiqqer/news": "News functionality for the QUIQQER system."
+    },
+    "autoload": {
+        "psr-4": {
+            "QUI\\Interview\\": "src/QUI/Interview"
+        }
+    },
+    "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)"
     }
-  }
-}
+}
\ No newline at end of file

phpcs.xml.dist

+<?xml version="1.0"?>
+<ruleset>
+    <!-- Use PSR-12 ruleset -->
+    <rule ref="PSR12"/>
+
+    <!-- Only scan *.php files -->
+    <arg name="extensions" value="php"/>
+
+    <!-- Ignore warnings -->
+    <arg name="warning-severity" value="0"/>
+
+    <!-- Process 64 (or number of CPU cores) files in parallel -->
+    <arg name="parallel" value="64"/>
+
+    <!-- Output relative file paths, by setting the current folder as the basepath -->
+    <arg name="basepath" value="."/>
+
+    <!-- Show colored output -->
+    <arg name="colors"/>
+
+    <!-- Scan everything in the current folder -->
+    <file>.</file>
+</ruleset>

phpstan-baseline.neon

+parameters:
+	ignoreErrors:
+		-
+			message: "#^Parameter \\#2 \\$val of method QUI\\\\QDOM\\:\\:setAttribute\\(\\) expects array\\|bool\\|object\\|string, int given\\.$#"
+			count: 1
+			path: src/QUI/Interview/Controls/IntervieweeData.php

phpstan.dist.neon

+includes:
+	- phpstan-baseline.neon
+
+parameters:
+    level: 5
+    paths:
+        - src
+    bootstrapFiles:
+        - tests/phpstan-bootstrap.php
+    tipsOfTheDay: false

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/Interview/Controls/IntervieweeData.php

@@ -31,7 +31,7 @@ public function __construct($attributes = [])
             'template' => 'largeImageTop' // template
         ]);
 
-        $this->addCSSFile(dirname(__FILE__).'/IntervieweeData.css');
+        $this->addCSSFile(dirname(__FILE__) . '/IntervieweeData.css');
 
         parent::__construct($attributes);
 
@@ -48,8 +48,10 @@ public function getBody()
         $Engine = QUI::getTemplateManager()->getEngine();
         $Site   = $this->getSite();
 
-        if ($Site->getAttribute("type") !== 'quiqqer/blog:blog/entry' &&
-            $Site->getAttribute("type") !== 'quiqqer/news:news/entry') {
+        if (
+            $Site->getAttribute("type") !== 'quiqqer/blog:blog/entry' &&
+            $Site->getAttribute("type") !== 'quiqqer/news:news/entry'
+        ) {
             return '';
         }
 
@@ -82,9 +84,9 @@ public function getBody()
             'description'    => $intervieweeData['description']
         ]);
 
-        $Engine->assign('controlTemplate', $Engine->fetch(dirname(__FILE__).$html));
+        $Engine->assign('controlTemplate', $Engine->fetch(dirname(__FILE__) . $html));
 
-        return $Engine->fetch(dirname(__FILE__).'/IntervieweeData.html');
+        return $Engine->fetch(dirname(__FILE__) . '/IntervieweeData.html');
     }
 
     /**

tests/phpstan-bootstrap.php

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

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';