Added code samples testing with Deptrac

Author: mnocon

.github/workflows/build.yaml

@@ -105,6 +105,9 @@ jobs:
             - name: Run PHPStan analysis
               run: composer phpstan
 
+            - name: Deptrac
+              run: composer deptrac
+
     code-samples-inclusion-check:
         name: Check code samples inclusion
         runs-on: ubuntu-latest

.gitignore

@@ -6,3 +6,4 @@ __pycache__/*
 .php-cs-fixer.cache
 composer.lock
 tools/php-cs-fixer/vendor
+.deptrac.cache

README.md

@@ -54,12 +54,31 @@ of the command.
 
 ## Testing the code samples
 
+### PHPStan
 This repository uses PHPStan to test the code samples. To run the tests locally execute the commands below:
 ```bash
 composer update
 composer phpstan
 ```
 
+Regenerate the baseline by running:
+```bash
+composer phpstan -- --generate-baseline
+```
+
+### Deptrac
+
+This repository uses Deptrac to test the code samples. To run the tests locally execute the commands below:
+```bash
+composer update
+composer deptrac
+```
+
+Regenerate the baseline by running:
+```bash
+vendor/bin/deptrac --formatter=baseline
+```
+
 ## Where to View
 
 https://doc.ibexa.co

composer.json

@@ -61,12 +61,20 @@
         "ibexa/solr": "5.0.x-dev",
         "ibexa/version-comparison": "5.0.x-dev",
         "league/oauth2-google": "^4.0",
-        "ibexa/core-search": "~5.0.x-dev"
+        "ibexa/core-search": "~5.0.x-dev",
+        "qossmic/deptrac": "^2.0"
     },
     "scripts": {
         "fix-cs": "php-cs-fixer fix --config=.php-cs-fixer.php -v --show-progress=dots",
         "check-cs": "@fix-cs --dry-run",
-        "phpstan": "phpstan analyse"
+        "phpstan": "phpstan analyse",
+        "deptrac": "deptrac analyse"
+    },
+    "scripts-descriptions": {
+        "fix-cs": "Automatically fixes code style in all files",
+        "check-cs": "Run code style checker for all files",
+        "phpstan": "Run static code analysis",
+        "deptrac": "Run Deptrac architecture testing"
     },
     "config": {
         "allow-plugins": false

deptrac.yaml

@@ -0,0 +1,27 @@
+imports:
+  - deptrac.baseline.yaml
+
+deptrac:
+    paths:
+        - ./code_samples
+    layers:
+        - name: CodeSamples
+          collectors:
+              - type: directory
+                value: code_samples
+        - name: IbexaContracts
+          collectors:
+              - type: classLike
+                value: .*Ibexa\\Contracts\\.*
+        - name: IbexaNotContracts
+          collectors:
+          - type: bool
+            must:
+              - type: classLike
+                value: .*Ibexa\\.*
+            must_not:
+              - type: classLike
+                value: .*Ibexa\\Contracts.*
+    ruleset:
+        CodeSamples:
+          - IbexaContracts