Initial set up

.editorconfig

@@ -0,0 +1,23 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 4
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.json]
+indent_size = 2
+
+[*.yml]
+indent_size = 2
+
+[*.yaml]
+indent_size = 2
+
+[Makefile]
+indent_style = tab
+
+[*.neon]
+indent_style = tab

.gitattributes

@@ -0,0 +1,13 @@
+# Ignoring files for distribution archieves
+.github/ export-ignore
+etc/ export-ignore
+tests/ export-ignore
+var/ export-ignore
+.devcontainer.json export-ignore
+.editorconfig export-ignore
+.gitattributes export-ignore
+.gitignore export-ignore
+CONTRIBUTING.md export-ignore
+infection.json.dist export-ignore
+Makefile export-ignore
+README.md export-ignore

.github/CODEOWNERS

@@ -0,0 +1 @@
+*       @WyriHaximus

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: WyriHaximus

.github/boring-cyborg.yml

@@ -0,0 +1,60 @@
+labelPRBasedOnFilePath:
+  "Documentation 📚":
+    - README.md
+    - CONTRIBUTING.md
+  "Dependencies 📦":
+    - Dockerfile*
+    - composer.*
+    - package.json
+    - package-lock.json
+    - yarn.lock
+  "Docker 🐳":
+    - Dockerfile*
+    - .docker/**/*
+  "Image 🖼":
+    - "**/*.gif"
+    - "**/*.jpg"
+    - "**/*.jpeg"
+    - "**/*.png"
+    - "**/*.webp"
+  "CSS 👩‍🎨":
+    - "**/*.css"
+  "HTML 👷‍♀️":
+    - "**/*.htm"
+    - "**/*.html"
+  "NEON 🦹‍♂️":
+    - "**/*.neon"
+  "MarkDown 📝":
+    - "**/*.md"
+  "YAML 🍄":
+    - "**/*.yml"
+    - "**/*.yaml"
+  "JSON 👨‍💼":
+    - "**/*.json"
+  "Go 🐹":
+    - "**/*.go"
+  "JavaScript 🦏":
+    - "**/*.js"
+    - package.json
+    - package-lock.json
+    - yarn.lock
+  "PHP 🐘":
+    - "**/*.php"
+    - composer.*
+  "Configuration ⚙":
+    - .github/*
+  "CI 🚧":
+    - .github/workflows/*
+    - .scrutinizer.yml
+  "Templates 🌲":
+    - "**/*.twig"
+    - "**/*.tpl"
+  "Helm ☸":
+    - .helm/**/*
+  "Tests 🧪":
+    - tests/**/*
+  "Source 🔮":
+    - src/**/*
+
+labelerFlags:
+  labelOnPRUpdates: true

.github/renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "github>WyriHaximus/renovate-config:php-package"
+  ]
+}

.github/settings.yml

@@ -0,0 +1,115 @@
+repository:
+    private: false
+    has_issues: true
+    has_wiki: false
+    has_downloads: true
+    default_branch: master
+    allow_squash_merge: false
+    allow_merge_commit: true
+    allow_rebase_merge: false
+
+# Labels: define labels for Issues and Pull Requests
+labels:
+    - name: "Dependencies 📦"
+      color: 0025ff
+      description: "Pull requests that update a dependency file"
+    - name: "Image 🖼"
+      color: 00ffff
+    - name: "HTML 👷‍♀️"
+      color: ffffff
+    - name: "CSS 👩‍🎨"
+      color: b3b3b3
+    - name: "JavaScript 🦏"
+      color: ffff00
+    - name: "Go 🐹"
+      color: 00ADD8
+    - name: "JSON 👨‍💼"
+      color: 00ADD8
+    - name: "NEON 🦹‍♂️"
+      color: CE3262
+    - name: "MarkDown 📝"
+      color: 000000
+    - name: "YAML 🍄"
+      color: ff1aff
+    - name: "Templates 🌲"
+      color: 009933
+    - name: "Helm ☸"
+      color: 091C84
+    - name: "Tests 🧪"
+      color: ffe6e6
+    - name: "Source 🔮"
+      color: e6ffe6
+    - name: "Configuration ⚙"
+      color: b3b3cc
+    - name: "PHP 🐘"
+      color: 8892BF
+      description: "Hypertext Pre Processor"
+    - name: "Docker 🐳"
+      color: 0db7ed
+      description: "Pull requests that relate to Docker"
+    - name: "CI 🚧"
+      color: ffff00
+    - name: "Feature 🏗"
+      color: 66ff99
+    - name: "Documentation 📚"
+      color: 6666ff
+    - name: "Security 🕵️‍♀️"
+      color: ff0000
+    - name: "Hacktoberfest 🎃"
+      color: 152347
+    - name: "Bug 🐞"
+      color: d73a4a
+      description: "Something isn't working"
+      oldname: bug
+    - name: "Duplicate ♊"
+      color: cfd3d7
+      description: "This issue or pull request already exists"
+      oldname: duplicate
+    - name: "Enhancement ✨"
+      color: a2eeef
+      description: "New feature or request"
+      oldname: enhancement
+    - name: "Good First Issue"
+      color: 7057ff
+      description: "Good for newcomers"
+      oldname: "good first issue"
+    - name: "Help Wanted"
+      color: 008672
+      description: "Extra attention is needed"
+      oldname: "help wanted"
+    - name: Invalid
+      color: e4e669
+      description: "This doesn't seem right"
+      oldname: invalid
+    - name: "Question ❓"
+      color: d876e3
+      description: "Further information is requested"
+      oldname: question
+    - name: "Will not be fixed 🛑"
+      color: ffffff
+      description: "This will not be worked on"
+      oldname: wontfix
+    - name: "Sponsor Request ❤️"
+      color: fedbf0
+      description: "Issue/PR opened by sponsor"
+
+branches:
+    - name: master
+      protection:
+          required_pull_request_reviews:
+              required_approving_review_count: 1
+              dismiss_stale_reviews: true
+              require_code_owner_reviews: true
+          # Required. Require status checks to pass before merging. Set to null to disable
+          required_status_checks:
+              # Required. Require branches to be up to date before merging.
+              strict: true
+              # Required. The list of status checks to require in order to merge into this branch
+              contexts: []
+          # Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.
+          enforce_admins: true
+          # Required. Restrict who can push to this branch. Team and user restrictions are only available for organization-owned repositories. Set to null to disable.
+          restrictions:
+              apps: []
+              users: []
+              teams: []

.github/workflows/ci.yml

@@ -0,0 +1,17 @@
+name: Continuous Integration
+on:
+  push:
+    branches:
+      - 'main'
+      - 'master'
+      - 'refs/heads/v[0-9]+.[0-9]+.[0-9]+'
+  pull_request:
+## This workflow needs the `pull-request` permissions to work for the package diffing
+## Refs: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#permissions
+permissions:
+  pull-requests: write
+  contents: read
+jobs:
+  ci:
+    name: Continuous Integration
+    uses: WyriHaximus/github-workflows/.github/workflows/package.yaml@main

.github/workflows/release-managment.yaml

@@ -0,0 +1,23 @@
+name: Release Management
+on:
+  pull_request:
+    types:
+      - opened
+      - labeled
+      - unlabeled
+      - synchronize
+      - reopened
+  milestone:
+    types:
+      - closed
+permissions:
+  contents: write
+  issues: write
+  pull-requests: write
+jobs:
+  release-managment:
+    name: Create Release
+    uses: WyriHaximus/github-workflows/.github/workflows/package-release-managment.yaml@main
+    with:
+      milestone: ${{ github.event.milestone.title }}
+      description: ${{ github.event.milestone.title }}

.gitignore

@@ -0,0 +1,4 @@
+var/*
+!var/.gitkeep
+vendor/
+etc/qa/.phpunit.result.cache

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Cees-Jan Kiewiet
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,89 @@
+# set all to phony
+SHELL=bash
+
+.PHONY: *
+
+COMPOSER_SHOW_EXTENSION_LIST=$(shell composer show -t | grep -o "\-\-\(ext-\).\+" | sort | uniq | cut -d- -f4- | tr -d '\n' | grep . | sed  '/^$$/d' | xargs | sed -e 's/ /, /g' | tr -cd '[:alnum:],' | sed 's/.$$//')
+SLIM_DOCKER_IMAGE=$(shell php -r 'echo count(array_intersect(["gd", "vips"], explode(",", "${COMPOSER_SHOW_EXTENSION_LIST}"))) > 0 ? "" : "-slim";')
+COMPOSER_CACHE_DIR=$(shell composer config --global cache-dir -q || echo ${HOME}/.composer-php/cache)
+PHP_VERSION:=$(shell docker run --rm -v "`pwd`:`pwd`" jess/jq jq -r -c '.config.platform.php' "`pwd`/composer.json" | php -r "echo str_replace('|', '.', explode('.', implode('|', explode('.', stream_get_contents(STDIN), 2)), 2)[0]);")
+COMPOSER_CONTAINER_CACHE_DIR=$(shell docker run --rm -it "ghcr.io/wyrihaximusnet/php:${PHP_VERSION}-nts-alpine${SLIM_DOCKER_IMAGE}-dev" composer config --global cache-dir -q || echo ${HOME}/.composer-php/cache)
+
+ifneq ("$(wildcard /.you-are-in-a-wyrihaximus.net-php-docker-image)","")
+    IN_DOCKER=TRUE
+else
+    IN_DOCKER=FALSE
+endif
+
+ifeq ("$(IN_DOCKER)","TRUE")
+	DOCKER_RUN:=
+else
+	DOCKER_RUN:=docker run --rm -it \
+		-v "`pwd`:`pwd`" \
+		-v "${COMPOSER_CACHE_DIR}:${COMPOSER_CONTAINER_CACHE_DIR}" \
+		-w "`pwd`" \
+		"ghcr.io/wyrihaximusnet/php:${PHP_VERSION}-zts-alpine${SLIM_DOCKER_IMAGE}-dev"
+endif
+
+ifneq (,$(findstring icrosoft,$(shell cat /proc/version)))
+    THREADS=1
+else
+    THREADS=$(shell nproc)
+endif
+
+all: ## Runs everything ###
+	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | grep -v "###" | awk 'BEGIN {FS = ":.*?## "}; {printf "%s\n", $$1}' | xargs --open-tty $(MAKE)
+
+syntax-php: ## Lint PHP syntax
+	$(DOCKER_RUN) vendor/bin/parallel-lint --exclude vendor .
+
+cs-fix: ## Fix any automatically fixable code style issues
+	$(DOCKER_RUN) vendor/bin/phpcbf --parallel=$(THREADS) --cache=./var/.phpcs.cache.json --standard=./etc/qa/phpcs.xml || $(DOCKER_RUN) vendor/bin/phpcbf --parallel=$(THREADS) --cache=./var/.phpcs.cache.json --standard=./etc/qa/phpcs.xml || $(DOCKER_RUN) vendor/bin/phpcbf --parallel=$(THREADS) --cache=./var/.phpcs.cache.json --standard=./etc/qa/phpcs.xml -vvvv
+
+cs: ## Check the code for code style issues
+	$(DOCKER_RUN) vendor/bin/phpcs --parallel=$(THREADS) --cache=./var/.phpcs.cache.json --standard=./etc/qa/phpcs.xml
+
+stan: ## Run static analysis (PHPStan)
+	$(DOCKER_RUN) vendor/bin/phpstan analyse src tests --ansi -c ./etc/qa/phpstan.neon
+
+psalm: ## Run static analysis (Psalm)
+	$(DOCKER_RUN) vendor/bin/psalm --threads=$(THREADS) --shepherd --stats --config=./etc/qa/psalm.xml
+
+unit-testing: ## Run tests
+	$(DOCKER_RUN) vendor/bin/phpunit --colors=always -c ./etc/qa/phpunit.xml --coverage-text --coverage-html ./var/tests-unit-coverage-html --coverage-clover ./var/tests-unit-clover-coverage.xml
+	$(DOCKER_RUN) test -n "$(COVERALLS_REPO_TOKEN)" && test -n "$(COVERALLS_RUN_LOCALLY)" && test -f ./var/tests-unit-clover-coverage.xml && vendor/bin/php-coveralls -v --coverage_clover ./build/logs/clover.xml --json_path ./var/tests-unit-clover-coverage-upload.json || true
+
+unit-testing-raw: ## Run tests ###
+	php vendor/phpunit/phpunit/phpunit --colors=always -c ./etc/qa/phpunit.xml --coverage-text --coverage-html ./var/tests-unit-coverage-html --coverage-clover ./var/tests-unit-clover-coverage.xml
+	test -n "$(COVERALLS_REPO_TOKEN)" && test -n "$(COVERALLS_RUN_LOCALLY)" && test -f ./var/tests-unit-clover-coverage.xml && ./vendor/bin/php-coveralls -v --coverage_clover ./build/logs/clover.xml --json_path ./var/tests-unit-clover-coverage-upload.json || true
+
+mutation-testing: ## Run mutation testing
+	$(DOCKER_RUN) vendor/bin/roave-infection-static-analysis-plugin --ansi --log-verbosity=all --threads=$(THREADS) --psalm-config etc/qa/psalm.xml || (cat ./var/infection.log && false)
+
+mutation-testing-raw: ## Run mutation testing ###
+	php vendor/roave/infection-static-analysis-plugin/bin/roave-infection-static-analysis-plugin --ansi --log-verbosity=all --threads=$(THREADS) --psalm-config etc/qa/psalm.xml || (cat ./var/infection.log && false)
+
+composer-require-checker: ## Ensure we require every package used in this package directly
+	$(DOCKER_RUN) vendor/bin/composer-require-checker --ignore-parse-errors --ansi -vvv --config-file=./etc/qa/composer-require-checker.json
+
+composer-unused: ## Ensure we don't require any package we don't use in this package directly
+	$(DOCKER_RUN) vendor/bin/composer-unused --ansi
+
+composer-install: ## Install dependencies
+	$(DOCKER_RUN) composer install --no-progress --ansi --no-interaction --prefer-dist -o
+
+backward-compatibility-check: ## Check code for backwards incompatible changes
+	$(MAKE) backward-compatibility-check-raw || true
+
+backward-compatibility-check-raw: ## Check code for backwards incompatible changes, doesn't ignore the failure ###
+	$(DOCKER_RUN) vendor/bin/roave-backward-compatibility-check
+
+shell: ## Provides Shell access in the expected environment ###
+	$(DOCKER_RUN) ash
+
+task-list-ci: ## CI: Generate a JSON array of jobs to run, matches the commands run when running `make (|all)` ###
+	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | grep -v "###" | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "%s\n", $$1}' | jq --raw-input --slurp -c 'split("\n")| .[0:-1]'
+
+help: ## Show this help ###
+	@printf "\033[33mUsage:\033[0m\n  make [target]\n\n\033[33mTargets:\033[0m\n"
+	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[32m%-32s\033[0m %s\n", $$1, $$2}' | tr -d '#'