Merge branch 'main' into bugfix/parenthesisInExpressions

Author: grebaldi

.editorconfig

@@ -18,3 +18,11 @@ indent_size = 2
 [*.json]
 indent_style = space
 indent_size = 2
+
+[*.xml]
+indent_style = space
+indent_size = 2
+
+[*.yml]
+indent_style = space
+indent_size = 2

.github/actions/setup-php/action.yml

@@ -0,0 +1,27 @@
+name: 'Set up PHP'
+description: 'Set up PHP and composer incl. caches'
+inputs:
+  php-version:
+    description: 'The version of PHP to set up'
+    required: true
+runs:
+  using: "composite"
+  steps:
+
+    - uses: shivammathur/setup-php@v2
+      with:
+        php-version: ${{ inputs.php-version }}
+        coverage: xdebug
+
+    - id: composer-cache
+      run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+      shell: bash
+
+    - uses: actions/cache@v2
+      with:
+        path: ${{ steps.composer-cache.outputs.dir }}
+        key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
+        restore-keys: ${{ runner.os }}-composer-
+
+    - run: composer install
+      shell: bash

.github/workflows/qa.yml

@@ -0,0 +1,44 @@
+name: QA
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [ main, '[0-9]+.[0-9]' ]
+  pull_request:
+
+permissions:
+  contents: read
+
+# This allows a subsequently queued workflow run to interrupt previous runs
+concurrency:
+  group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
+  cancel-in-progress: true
+
+jobs:
+  static-analysis:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./.github/actions/setup-php
+        with:
+          php-version: '8.1'
+
+      - name: Static Code Analysis with phpstan
+        run: ./scripts/analyse
+        shell: bash
+
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php-version: ['8.1', '8.2']
+        testsuite: ['unit', 'integration']
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./.github/actions/setup-php
+        with:
+          php-version: ${{ matrix.php-version }}
+
+      - name: Testsuite "${{ matrix.testsuite }}" with phpunit
+        run: |
+          ./scripts/test --testsuite ${{ matrix.testsuite }}

.gitignore

@@ -5,4 +5,6 @@ example.md
 Header.md
 simple.md
 test.php
-error.afx
+error.afx
+composer.lock
+.phpunit.result.cache

Makefile

@@ -1 +1,40 @@
 # Nothing to see here yet
+
+## Development
+
+For common automated development tasks, the repository contains several scripts which can be run via composer, like:
+
+```sh
+composer {script-name}
+```
+
+or, alternatively, directly via:
+
+```sh
+./scripts/{script-name}
+```
+
+| script-name | description |
+|-|-|
+| `analyse` | Run static code analysis with [phpstan](https://phpstan.org/) |
+| `test` | Run tests with [phpunit](https://phpunit.de/) |
+
+### Running tests
+
+There's a test suite for unit tests and another one for integration tests. By default both test suites are run entirely. In order to just run one of them, you need to add the `--testsuite` parameter to the script call, e.g.:
+
+```sh
+composer test -- --testsuite unit
+composer test -- --testsuite integration
+```
+
+or alternatively:
+
+```sh
+./scripts/test --testsuite unit
+./scripts/test --testsuite integration
+```
+
+## License
+
+see [LICENSE](./LICENSE)

README.md

@@ -2,12 +2,10 @@
     "name": "packagefactory/componentengine",
     "type": "library",
     "license": "GPL-3.0-or-later",
-    "authors": [
-        {
-            "name": "Wilhelm Behncke",
-            "email": "[email protected]"
-        }
-    ],
+    "scripts": {
+      "analyse": "./scripts/analyse",
+      "test": "./scripts/test"
+    },
     "require": {
         "php": ">=8.1"
     },
@@ -22,9 +20,8 @@
         }
     },
     "require-dev": {
-        "phpunit/phpunit": "^9.5",
-        "spatie/phpunit-snapshot-assertions": "^4.2",
-        "phpstan/phpstan": "^1.5",
-        "phpunit/php-code-coverage": "^9.2"
+        "phpunit/phpunit": "^10.2",
+        "phpstan/phpstan": "^1.10",
+        "phpunit/php-code-coverage": "^10.1"
     }
 }