First commit

.gitattributes

@@ -0,0 +1,14 @@
+/.github/ export-ignore
+/tools/ export-ignore
+/tests/ export-ignore
+codecov.yml export-ignore
+.editorconfig export-ignore
+.gitattributes export-ignore
+.gitignore export-ignore
+phpstan.neon export-ignore
+phpstan-dev.neon export-ignore
+phpcs.xml export-ignore
+phpunit.xml export-ignore
+.php_cs.dist export-ignore
+.markdownlintignore export-ignore
+.markdownlintrc export-ignore

.github/dependabot.yml

@@ -0,0 +1,29 @@
+---
+
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+ - package-ecosystem: "github-actions" # See documentation for possible values
+ directory: "/" # Location of package manifests
+ schedule:
+ interval: "weekly"
+ groups:
+ all-actions:
+ patterns: ["*"]
+
+ - package-ecosystem: "composer" # See documentation for possible values
+ directory: "/" # Location of package manifests
+ schedule:
+ interval: "daily"
+ ignore:
+ - dependency-name: "*"
+ update-types: ["version-update:semver-major"]
+ groups:
+ production-dependencies:
+ dependency-type: "production"
+ dev-dependencies:
+ dependency-type: "development"

.github/workflows/autolock-conversations.yml

@@ -0,0 +1,25 @@
+---
+
+name: 'Lock Threads'
+
+on: # yamllint disable-line rule:truthy
+ schedule:
+ - cron: '0 0 * * *'
+ workflow_dispatch:
+
+permissions:
+ issues: write
+ pull-requests: write
+
+concurrency:
+ group: lock
+
+jobs:
+ action:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: dessant/lock-threads@v5
+ with:
+ issue-inactive-days: '90'
+ pr-inactive-days: '90'
+ log-output: true

.github/workflows/documentation.yml

@@ -0,0 +1,35 @@
+---
+
+name: Documentation
+
+on: # yamllint disable-line rule:truthy
+ push:
+ branches: [master, release-*]
+ paths:
+ - '**.md'
+ pull_request:
+ branches: [master, release-*]
+ paths:
+ - '**.md'
+ workflow_dispatch:
+
+jobs:
+ quality:
+ name: Quality checks
+ runs-on: [ubuntu-latest]
+
+ steps:
+ - uses: actions/checkout@v4
+
+ - name: Lint markdown files
+ uses: nosborn/github-action-markdown-cli@v3
+ with:
+ files: .
+ ignore_path: .markdownlintignore
+
+ - name: Perform spell check
+ uses: codespell-project/actions-codespell@v2
+ with:
+ path: '**/*.md'
+ check_filenames: true
+ ignore_words_list: tekst

.github/workflows/php.yml

@@ -0,0 +1,280 @@
+---
+
+name: CI
+
+on: # yamllint disable-line rule:truthy
+ push:
+ branches: ['**']
+ paths-ignore:
+ - '**.md'
+ pull_request:
+ branches: [master, release-*]
+ paths-ignore:
+ - '**.md'
+ workflow_dispatch:
+
+jobs:
+ linter:
+ name: Linter
+ runs-on: ['ubuntu-latest']
+
+ steps:
+ - uses: actions/checkout@v4
+ with:
+ # super-linter needs the full git history to get the
+ # list of files that changed across commits
+ fetch-depth: 0
+
+ - name: Lint Code Base
+ uses: super-linter/super-linter/slim@v7
+ env:
+ # To report GitHub Actions status checks
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ LINTER_RULES_PATH: 'tools/linters'
+ LOG_LEVEL: NOTICE
+ VALIDATE_ALL_CODEBASE: true
+ VALIDATE_JSON: true
+ VALIDATE_PHP_BUILTIN: true
+ VALIDATE_YAML: true
+ VALIDATE_XML: true
+ VALIDATE_GITHUB_ACTIONS: true
+
+ quality:
+ name: Quality control
+ runs-on: [ubuntu-latest]
+
+ steps:
+ - name: Setup PHP, with composer and extensions
+ id: setup-php
+ # https://github.com/shivammathur/setup-php
+ uses: shivammathur/setup-php@v2
+ with:
+ # Should be the higest supported version, so we can use the newest tools
+ php-version: '8.3'
+ tools: composer, composer-require-checker, composer-unused, phpcs, phpstan
+ extensions: ctype, date, dom, filter, pcre, soap, spl, xml
+ coverage: none
+
+ - name: Setup problem matchers for PHP
+ run: echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+
+ - uses: actions/checkout@v4
+
+ - name: Get composer cache directory
+ run: echo COMPOSER_CACHE="$(composer config cache-files-dir)" >> "$GITHUB_ENV"
+
+ - name: Cache composer dependencies
+ uses: actions/cache@v4
+ with:
+ path: ${{ env.COMPOSER_CACHE }}
+ key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+ restore-keys: ${{ runner.os }}-composer-
+
+ - name: Validate composer.json and composer.lock
+ run: composer validate
+
+ - name: Install Composer dependencies
+ run: composer install --no-progress --prefer-dist --optimize-autoloader
+
+ - name: Check code for hard dependencies missing in composer.json
+ run: composer-require-checker check composer.json
+
+ - name: Check code for unused dependencies in composer.json
+ run: composer-unused
+
+ - name: PHP Code Sniffer
+ run: phpcs
+
+ - name: PHPStan
+ run: |
+ phpstan analyze -c phpstan.neon
+
+ - name: PHPStan (testsuite)
+ run: |
+ phpstan analyze -c phpstan-dev.neon
+
+ security:
+ name: Security checks
+ runs-on: [ubuntu-latest]
+ steps:
+ - name: Setup PHP, with composer and extensions
+ # https://github.com/shivammathur/setup-php
+ uses: shivammathur/setup-php@v2
+ with:
+ # Should be the lowest supported version
+ php-version: '8.1'
+ extensions: ctype, date, dom, filter, pcre, soap, spl, xml
+ tools: composer
+ coverage: none
+
+ - name: Setup problem matchers for PHP
+ run: echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+
+ - uses: actions/checkout@v4
+
+ - name: Get composer cache directory
+ run: echo COMPOSER_CACHE="$(composer config cache-files-dir)" >> "$GITHUB_ENV"
+
+ - name: Cache composer dependencies
+ uses: actions/cache@v4
+ with:
+ path: ${{ env.COMPOSER_CACHE }}
+ key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+ restore-keys: ${{ runner.os }}-composer-
+
+ - name: Install Composer dependencies
+ run: composer install --no-progress --prefer-dist --optimize-autoloader
+
+ - name: Security check for locked dependencies
+ run: composer audit
+
+ - name: Update Composer dependencies
+ run: composer update --no-progress --prefer-dist --optimize-autoloader
+
+ - name: Security check for updated dependencies
+ run: composer audit
+
+ unit-tests-linux:
+ name: "Unit tests, PHP ${{ matrix.php-versions }}, ${{ matrix.operating-system }}"
+ runs-on: ${{ matrix.operating-system }}
+ needs: [linter, quality, security]
+ strategy:
+ fail-fast: false
+ matrix:
+ operating-system: [ubuntu-latest]
+ php-versions: ['8.1', '8.2', '8.3']
+
+ steps:
+ - name: Setup PHP, with composer and extensions
+ # https://github.com/shivammathur/setup-php
+ uses: shivammathur/setup-php@v2
+ with:
+ php-version: ${{ matrix.php-versions }}
+ extensions: ctype, date, dom, filter, pcre, soap, spl, xml
+ tools: composer
+ ini-values: error_reporting=E_ALL
+ coverage: pcov
+
+ - name: Setup problem matchers for PHP
+ run: echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+
+ - name: Setup problem matchers for PHPUnit
+ run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
+
+ - name: Set git to use LF
+ run: |
+ git config --global core.autocrlf false
+ git config --global core.eol lf
+
+ - uses: actions/checkout@v4
+
+ - name: Get composer cache directory
+ run: echo COMPOSER_CACHE="$(composer config cache-files-dir)" >> "$GITHUB_ENV"
+
+ - name: Cache composer dependencies
+ uses: actions/cache@v4
+ with:
+ path: ${{ env.COMPOSER_CACHE }}
+ key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+ restore-keys: ${{ runner.os }}-composer-
+
+ - name: Install Composer dependencies
+ run: composer install --no-progress --prefer-dist --optimize-autoloader
+
+ - name: Run unit tests with coverage
+ if: ${{ matrix.php-versions == '8.3' }}
+ run: vendor/bin/phpunit
+
+ - name: Run unit tests (no coverage)
+ if: ${{ matrix.php-versions != '8.3' }}
+ run: vendor/bin/phpunit --no-coverage
+
+ - name: Save coverage data
+ if: ${{ matrix.php-versions == '8.3' }}
+ uses: actions/upload-artifact@v4
+ with:
+ name: coverage-data
+ path: ${{ github.workspace }}/build
+
+ unit-tests-windows:
+ name: "Unit tests, PHP ${{ matrix.php-versions }}, ${{ matrix.operating-system }}"
+ runs-on: ${{ matrix.operating-system }}
+ needs: [linter, quality, security]
+ strategy:
+ fail-fast: true
+ matrix:
+ operating-system: [windows-latest]
+ php-versions: ['8.1', '8.2', '8.3']
+
+ steps:
+ - name: Setup PHP, with composer and extensions
+ # https://github.com/shivammathur/setup-php
+ uses: shivammathur/setup-php@v2
+ with:
+ php-version: ${{ matrix.php-versions }}
+ extensions: ctype, date, dom, filter, pcre, soap, spl, xml
+ tools: composer
+ ini-values: error_reporting=E_ALL
+ coverage: none
+
+ - name: Setup problem matchers for PHP
+ run: echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+
+ - name: Setup problem matchers for PHPUnit
+ run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
+
+ - name: Set git to use LF
+ run: |
+ git config --global core.autocrlf false
+ git config --global core.eol lf
+
+ - uses: actions/checkout@v4
+
+ - name: Get composer cache directory
+ run: echo COMPOSER_CACHE="$(composer config cache-files-dir)" >> "$env:GITHUB_ENV"
+
+ - name: Cache composer dependencies
+ uses: actions/cache@v4
+ with:
+ path: ${{ env.COMPOSER_CACHE }}
+ key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+ restore-keys: ${{ runner.os }}-composer-
+
+ - name: Install Composer dependencies
+ run: composer install --no-progress --prefer-dist --optimize-autoloader
+
+ - name: Run unit tests
+ run: vendor/bin/phpunit --no-coverage
+
+ coverage:
+ name: Code coverage
+ runs-on: [ubuntu-latest]
+ needs: [unit-tests-linux]
+ steps:
+ - uses: actions/checkout@v4
+
+ - uses: actions/download-artifact@v4
+ with:
+ name: coverage-data
+ path: ${{ github.workspace }}/build
+
+ - name: Codecov
+ uses: codecov/codecov-action@v4
+ with:
+ token: ${{ secrets.CODECOV_TOKEN }}
+ fail_ci_if_error: true
+ verbose: true
+
+ cleanup:
+ name: Cleanup artifacts
+ needs: [unit-tests-linux, coverage]
+ runs-on: [ubuntu-latest]
+ if: |
+ always() &&
+ needs.coverage.result == 'success' ||
+ (needs.unit-tests-linux.result == 'success' && needs.coverage.result == 'skipped')
+
+ steps:
+ - uses: geekyeggo/delete-artifact@v5
+ with:
+ name: coverage-data

.gitignore

@@ -1,6 +1,9 @@
-composer.phar
+/.phpunit.cache/
+/build/
 /vendor/
+.phpunit.result.cache
+composer.phar
+composer.lock
 
 # Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
 # You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
-# composer.lock