Merge pull request #204 from ergebnis/feature/synchronize

Enhancement: Synchronize with `ergebnis/php-package-template`

Author: localheinz

.editorconfig

@@ -10,6 +10,9 @@ trim_trailing_whitespace = true
 [*.json]
 indent_size = 2
 
+[*.md]
+indent_size = 2
+
 [*.neon]
 indent_style = tab
 

.gitattributes

@@ -4,8 +4,11 @@
 /.editorconfig                  export-ignore
 /.gitattributes                 export-ignore
 /.gitignore                     export-ignore
-/.php_cs                        export-ignore
+/.php-cs-fixer.php              export-ignore
+/.yamllint.yaml                 export-ignore
 /composer-require-checker.json  export-ignore
+/composer.lock                  export-ignore
 /Makefile                       export-ignore
 /psalm-baseline.xml             export-ignore
 /psalm.xml                      export-ignore
+/rector.php                     export-ignore

.github/CODEOWNERS

@@ -1 +1,3 @@
+# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners#codeowners-file-size
+
 * @ergebnis-bot @localheinz

.github/CONTRIBUTING.md

@@ -20,7 +20,7 @@ We are using [`yamllint`](https://github.com/adrienverge/yamllint) to enforce co
 If you do not have `yamllint` installed yet, run
 
 ```sh
-$ brew install yamllint
+brew install yamllint
 ```
 
 to install `yamllint`.
@@ -30,7 +30,7 @@ We are using [`friendsofphp/php-cs-fixer`](https://github.com/FriendsOfPHP/PHP-C
 Run
 
 ```sh
-$ make coding-standards
+make coding-standards
 ```
 
 to automatically fix coding standard violations.
@@ -42,19 +42,43 @@ We are using [`maglnet/composer-require-checker`](https://github.com/maglnet/Com
 Run
 
 ```sh
-$ make dependency-analysis
+make dependency-analysis
 ```
 
 to run a dependency analysis.
 
+## Refactoring
+
+We are using [`rector/rector`](https://github.com/rectorphp/rector) to automatically refactor code.
+
+Run
+
+```sh
+make refactoring
+```
+
+to automatically refactor code.
+
+## Security Analysis
+
+We are using [`composer`](https://github.com/composer/composer) to run a security analysis.
+
+Run
+
+```sh
+make security-analysis
+```
+
+to run a security analysis.
+
 ## Static Code Analysis
 
 We are using [`vimeo/psalm`](https://github.com/vimeo/psalm) to statically analyze the code.
 
 Run
 
 ```sh
-$ make static-code-analysis
+make static-code-analysis
 ```
 
 to run a static code analysis.
@@ -64,7 +88,7 @@ We are also using the baseline feature of [`vimeo/psalm`](https://psalm.dev/docs
 Run
 
 ```sh
-$ make static-code-analysis-baseline
+make static-code-analysis-baseline
 ```
 
 to regenerate the baseline in [`../psalm-baseline.xml`](../psalm-baseline.xml).
@@ -78,7 +102,7 @@ We are using [`phpunit/phpunit`](https://github.com/sebastianbergmann/phpunit) t
 Run
 
 ```sh
-$ make tests
+make tests
 ```
 
 to run all the tests.
@@ -88,7 +112,7 @@ to run all the tests.
 Run
 
 ```sh
-$ make
+make
 ```
 
 to enforce coding standards, run a static code analysis, and run tests!
@@ -98,7 +122,7 @@ to enforce coding standards, run a static code analysis, and run tests!
 :bulb: Run
 
 ```sh
-$ make help
+make help
 ```
 
 to display a list of available targets with corresponding descriptions.

.github/settings.yml

@@ -13,14 +13,19 @@ branches:
         require_code_owner_reviews: true
         required_approving_review_count: 1
       required_status_checks:
-        contexts:
-          - "Code Coverage (8.1, locked)"
-          - "Coding Standards (8.1, locked)"
-          - "Dependency Analysis (8.1, locked)"
-          - "Security Analysis (8.1, locked)"
-          - "Static Code Analysis (8.1, locked)"
-          - "Tests (8.1, locked)"
-          - "Tests (8.2, locked)"
+        checks:
+          - context: "Code Coverage (8.1, locked)"
+          - context: "Coding Standards (8.1, locked)"
+          - context: "Dependency Analysis (8.1, locked)"
+          - context: "Refactoring (8.1, locked)"
+          - context: "Security Analysis (8.1, locked)"
+          - context: "Static Code Analysis (8.1, locked)"
+          - context: "Tests (8.1, highest)"
+          - context: "Tests (8.1, locked)"
+          - context: "Tests (8.1, lowest)"
+          - context: "Tests (8.2, highest)"
+          - context: "Tests (8.2, locked)"
+          - context: "Tests (8.2, lowest)"
         strict: false
       restrictions:
 
@@ -72,6 +77,8 @@ repository:
   default_branch: "main"
   delete_branch_on_merge: true
   description: ":eyeglasses: Provides an extension for detecting slow tests in phpunit/phpunit."
+  enable_automated_security_fixes: true
+  enable_vulnerability_alerts: true
   has_downloads: true
   has_issues: true
   has_pages: false

.github/workflows/integrate.yaml

@@ -83,7 +83,7 @@ jobs:
         uses: "actions/[email protected]"
 
       - name: "Lint YAML files"
-        uses: "ibiqlik/[email protected]"
+        uses: "ibiqlik/[email protected].1"
         with:
           config_file: ".yamllint.yaml"
           file_or_dir: "."
@@ -95,12 +95,13 @@ jobs:
           coverage: "none"
           extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
           php-version: "${{ matrix.php-version }}"
+          tools: "phive"
 
       - name: "Set up problem matchers for PHP"
         run: "echo \"::add-matcher::${{ runner.tool_cache }}/php.json\""
 
       - name: "Validate composer.json and composer.lock"
-        run: "composer validate --ansi"
+        run: "composer validate --ansi --strict"
 
       - name: "Determine composer cache directory"
         uses: "ergebnis/.github/actions/composer/[email protected]"
@@ -127,8 +128,15 @@ jobs:
         uses: "actions/[email protected]"
         with:
           path: ".build/php-cs-fixer"
-          key: "php-${{ matrix.php-version }}-php-cs-fixer-${{ github.sha }}"
-          restore-keys: "php-${{ matrix.php-version }}-php-cs-fixer-"
+          key: "php-${{ matrix.php-version }}-php-cs-fixer-${{ github.ref_name }}"
+          restore-keys: |
+            php-${{ matrix.php-version }}-php-cs-fixer-main
+            php-${{ matrix.php-version }}-php-cs-fixer-
+
+      - name: "Install dependencies with phive"
+        uses: "ergebnis/.github/actions/phive/[email protected]"
+        with:
+          trust-gpg-keys: "0x033E5F8D801A2F8D,0xE82B2FB314E9906E"
 
       - name: "Run friendsofphp/php-cs-fixer"
         run: ".phive/php-cs-fixer fix --ansi --config=.php-cs-fixer.php --diff --dry-run --verbose"
@@ -156,6 +164,7 @@ jobs:
           coverage: "none"
           extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
           php-version: "${{ matrix.php-version }}"
+          tools: "phive"
 
       - name: "Set up problem matchers for PHP"
         run: "echo \"::add-matcher::${{ runner.tool_cache }}/php.json\""
@@ -175,9 +184,71 @@ jobs:
         with:
           dependencies: "${{ matrix.dependencies }}"
 
+      - name: "Install dependencies with phive"
+        uses: "ergebnis/.github/actions/phive/[email protected]"
+        with:
+          trust-gpg-keys: "0x033E5F8D801A2F8D,0xE82B2FB314E9906E"
+
       - name: "Run maglnet/composer-require-checker"
         run: ".phive/composer-require-checker check --config-file=$(pwd)/composer-require-checker.json"
 
+  refactoring:
+    name: "Refactoring"
+
+    runs-on: "ubuntu-latest"
+
+    strategy:
+      matrix:
+        php-version:
+          - "8.1"
+
+        dependencies:
+          - "locked"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/[email protected]"
+
+      - name: "Set up PHP"
+        uses: "shivammathur/[email protected]"
+        with:
+          coverage: "none"
+          extensions: "none, ctype, dom, intl, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
+          php-version: "${{ matrix.php-version }}"
+
+      - name: "Set up problem matchers for PHP"
+        run: "echo \"::add-matcher::${{ runner.tool_cache }}/php.json\""
+
+      - name: "Determine composer cache directory"
+        uses: "ergebnis/.github/actions/composer/[email protected]"
+
+      - name: "Cache dependencies installed with composer"
+        uses: "actions/[email protected]"
+        with:
+          path: "${{ env.COMPOSER_CACHE_DIR }}"
+          key: "php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-${{ hashFiles('composer.lock') }}"
+          restore-keys: "php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-"
+
+      - name: "Install ${{ matrix.dependencies }} dependencies with composer"
+        uses: "ergebnis/.github/actions/composer/[email protected]"
+        with:
+          dependencies: "${{ matrix.dependencies }}"
+
+      - name: "Create cache directory for rector/rector"
+        run: "mkdir -p .build/rector"
+
+      - name: "Cache cache directory for rector/rector"
+        uses: "actions/[email protected]"
+        with:
+          path: ".build/rector"
+          key: "php-${{ matrix.php-version }}-rector-${{ github.ref_name }}"
+          restore-keys: |
+            php-${{ matrix.php-version }}-rector-main
+            php-${{ matrix.php-version }}-rector-
+
+      - name: "Run automated refactoring with rector/rector"
+        run: "vendor/bin/rector --ansi --config=rector.php --dry-run"
+
   security-analysis:
     name: "Security Analysis"
 
@@ -206,7 +277,7 @@ jobs:
         run: "echo \"::add-matcher::${{ runner.tool_cache }}/php.json\""
 
       - name: "Validate composer.json and composer.lock"
-        run: "composer validate --ansi"
+        run: "composer validate --ansi --strict"
 
       - name: "Check installed packages for security vulnerability advisories"
         run: "composer audit --ansi"
@@ -234,6 +305,7 @@ jobs:
           coverage: "none"
           extensions: "none, ctype, curl, dom, json, mbstring, pcntl, phar, posix, simplexml, tokenizer, xml, xmlwriter"
           php-version: "${{ matrix.php-version }}"
+          tools: "phive"
 
       - name: "Set up problem matchers for PHP"
         run: "echo \"::add-matcher::${{ runner.tool_cache }}/php.json\""
@@ -257,7 +329,7 @@ jobs:
         run: "mkdir -p .build/psalm"
 
       - name: "Run vimeo/psalm"
-        run: ".phive/psalm --config=psalm.xml --output-format=github --shepherd --show-info=false --stats --threads=4"
+        run: "vendor/bin/psalm --config=psalm.xml --output-format=github --shepherd --show-info=false --stats --threads=4"
 
   tests:
     name: "Tests"
@@ -271,7 +343,9 @@ jobs:
           - "8.2"
 
         dependencies:
+          - "lowest"
           - "locked"
+          - "highest"
 
     steps:
       - name: "Checkout"

.github/workflows/renew.yaml

@@ -32,12 +32,13 @@ jobs:
           coverage: "none"
           extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
           php-version: "${{ matrix.php-version }}"
+          tools: "phive"
 
       - name: "Set up problem matchers for PHP"
         run: "echo \"::add-matcher::${{ runner.tool_cache }}/php.json\""
 
       - name: "Validate composer.json and composer.lock"
-        run: "composer validate --ansi"
+        run: "composer validate --ansi --strict"
 
       - name: "Determine composer cache directory"
         uses: "ergebnis/.github/actions/composer/[email protected]"
@@ -61,8 +62,15 @@ jobs:
         uses: "actions/[email protected]"
         with:
           path: ".build/php-cs-fixer"
-          key: "php-${{ matrix.php-version }}-php-cs-fixer-${{ github.sha }}"
-          restore-keys: "php-${{ matrix.php-version }}-php-cs-fixer-"
+          key: "php-${{ matrix.php-version }}-php-cs-fixer-${{ github.ref_name }}"
+          restore-keys: |
+            php-${{ matrix.php-version }}-php-cs-fixer-main
+            php-${{ matrix.php-version }}-php-cs-fixer-
+
+      - name: "Install dependencies with phive"
+        uses: "ergebnis/.github/actions/phive/[email protected]"
+        with:
+          trust-gpg-keys: "0x033E5F8D801A2F8D,0xE82B2FB314E9906E"
 
       - name: "Run friendsofphp/php-cs-fixer"
         run: ".phive/php-cs-fixer fix --ansi --config=.php-cs-fixer.php --diff --verbose"

.gitignore

@@ -1,3 +1,5 @@
 /.build/
 /.notes/
+/.phive/
 /vendor/
+!/.phive/phars.xml

.phive/composer-require-checker

@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phive xmlns="https://phar.io/phive">
-  <phar name="composer-require-checker" version="^4.5.0" installed="4.5.0" location="./.phive/composer-require-checker" copy="true"/>
-  <phar name="php-cs-fixer" version="^3.14.3" installed="3.14.3" location="./.phive/php-cs-fixer" copy="true"/>
-  <phar name="psalm" version="^5.6.0" installed="5.6.0" location="./.phive/psalm" copy="true"/>
+  <phar name="composer-require-checker" version="^4.5.0" installed="4.5.0" location="./.phive/composer-require-checker" copy="false"/>
+  <phar name="php-cs-fixer" version="^3.14.3" installed="3.14.3" location="./.phive/php-cs-fixer" copy="false"/>
 </phive>