Merge pull request #214 from ergebnis/feature/synchronize

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

.github/SECURITY.md

@@ -0,0 +1,17 @@
+# Security Policy
+
+## Supported Versions
+
+The following versions of `ergebnis/json-pointer` have active support:
+
+- `^3.2.0`
+
+## Unsupported Versions
+
+The following versions of `ergebnis/json-pointer` have reached their end of life:
+
+- `<3.2.0`
+
+## Reporting a Vulnerability
+
+If you believe that you have found a security vulnerability, please send an email to `[email protected]`. Ensure to include all details required to understand the severity of the issue.

.github/settings.yml

@@ -82,6 +82,7 @@ repository:
   has_pages: false
   has_projects: false
   has_wiki: false
+  is_template: false
   name: "json-pointer"
   private: false
 

.github/workflows/integrate.yaml

@@ -30,7 +30,7 @@ jobs:
         uses: "shivammathur/[email protected]"
         with:
           coverage: "xdebug"
-          extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
+          extensions: "none, ctype, curl, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
           php-version: "${{ matrix.php-version }}"
 
       - name: "Set up problem matchers for PHP"
@@ -39,6 +39,9 @@ jobs:
       - name: "Set up problem matchers for phpunit/phpunit"
         run: "echo \"::add-matcher::${{ runner.tool_cache }}/phpunit.json\""
 
+      - name: "Validate composer.json and composer.lock"
+        run: "composer validate --ansi --strict"
+
       - name: "Determine composer cache directory"
         uses: "ergebnis/.github/actions/composer/[email protected]"
 
@@ -93,7 +96,7 @@ jobs:
         uses: "shivammathur/[email protected]"
         with:
           coverage: "none"
-          extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
+          extensions: "none, ctype, curl, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
           php-version: "${{ matrix.php-version }}"
 
       - name: "Set up problem matchers for PHP"
@@ -121,7 +124,7 @@ jobs:
         run: "composer normalize --ansi --dry-run"
 
       - name: "Create cache directory for friendsofphp/php-cs-fixer"
-        run: "mkdir -p .build/php-cs-fixer"
+        run: "mkdir -p .build/php-cs-fixer/"
 
       - name: "Cache cache directory for friendsofphp/php-cs-fixer"
         uses: "actions/[email protected]"
@@ -156,13 +159,16 @@ jobs:
         uses: "shivammathur/[email protected]"
         with:
           coverage: "none"
-          extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
+          extensions: "none, ctype, curl, 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 --strict"
+
       - name: "Determine composer cache directory"
         uses: "ergebnis/.github/actions/composer/[email protected]"
 
@@ -207,12 +213,15 @@ jobs:
         uses: "shivammathur/[email protected]"
         with:
           coverage: "xdebug"
-          extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
+          extensions: "none, ctype, curl, dom, 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: "Validate composer.json and composer.lock"
+        run: "composer validate --ansi --strict"
+
       - name: "Determine composer cache directory"
         uses: "ergebnis/.github/actions/composer/[email protected]"
 
@@ -254,12 +263,15 @@ jobs:
         uses: "shivammathur/[email protected]"
         with:
           coverage: "none"
-          extensions: "none, ctype, dom, intl, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
+          extensions: "none, ctype, curl, dom, 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: "Validate composer.json and composer.lock"
+        run: "composer validate --ansi --strict"
+
       - name: "Determine composer cache directory"
         uses: "ergebnis/.github/actions/composer/[email protected]"
 
@@ -276,7 +288,7 @@ jobs:
           dependencies: "${{ matrix.dependencies }}"
 
       - name: "Create cache directory for rector/rector"
-        run: "mkdir -p .build/rector"
+        run: "mkdir -p .build/rector/"
 
       - name: "Cache cache directory for rector/rector"
         uses: "actions/[email protected]"
@@ -311,7 +323,7 @@ jobs:
         uses: "shivammathur/[email protected]"
         with:
           coverage: "none"
-          extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
+          extensions: "none, ctype, curl, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
           php-version: "${{ matrix.php-version }}"
 
       - name: "Set up problem matchers for PHP"
@@ -320,6 +332,21 @@ jobs:
       - name: "Validate composer.json and composer.lock"
         run: "composer validate --ansi --strict"
 
+      - 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: "Check installed packages for security vulnerability advisories"
         run: "composer audit --ansi"
 
@@ -350,6 +377,9 @@ jobs:
       - 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 --strict"
+
       - name: "Determine composer cache directory"
         uses: "ergebnis/.github/actions/composer/[email protected]"
 
@@ -366,7 +396,7 @@ jobs:
           dependencies: "${{ matrix.dependencies }}"
 
       - name: "Create cache directory for vimeo/psalm"
-        run: "mkdir -p .build/psalm"
+        run: "mkdir -p .build/psalm/"
 
       - name: "Run vimeo/psalm"
         run: "vendor/bin/psalm --config=psalm.xml --output-format=github --shepherd --show-info=false --stats --threads=4"
@@ -395,7 +425,7 @@ jobs:
         uses: "shivammathur/[email protected]"
         with:
           coverage: "none"
-          extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
+          extensions: "none, ctype, curl, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
           php-version: "${{ matrix.php-version }}"
 
       - name: "Set up problem matchers for PHP"
@@ -404,6 +434,9 @@ jobs:
       - name: "Set up problem matchers for phpunit/phpunit"
         run: "echo \"::add-matcher::${{ runner.tool_cache }}/phpunit.json\""
 
+      - name: "Validate composer.json and composer.lock"
+        run: "composer validate --ansi --strict"
+
       - name: "Determine composer cache directory"
         uses: "ergebnis/.github/actions/composer/[email protected]"
 

.github/workflows/renew.yaml

@@ -30,7 +30,7 @@ jobs:
         uses: "shivammathur/[email protected]"
         with:
           coverage: "none"
-          extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
+          extensions: "none, ctype, curl, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
           php-version: "${{ matrix.php-version }}"
 
       - name: "Set up problem matchers for PHP"

.gitignore

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

.php-cs-fixer.php

@@ -34,11 +34,10 @@
     ->exclude([
         '.build/',
         '.github/',
-        '.notes/',
+        '.note/',
     ])
     ->ignoreDotFiles(false)
-    ->in(__DIR__)
-    ->name('.php-cs-fixer.php');
+    ->in(__DIR__);
 
 $config->setCacheFile(__DIR__ . '/.build/php-cs-fixer/.php-cs-fixer.cache');
 

.yamllint.yaml

@@ -2,7 +2,7 @@ extends: "default"
 
 ignore: |
   .build/
-  .notes/
+  .note/
   vendor/
 
 rules:

README.md

@@ -322,6 +322,10 @@ Please have a look at [`CONTRIBUTING.md`](.github/CONTRIBUTING.md).
 
 Please have a look at [`CODE_OF_CONDUCT.md`](https://github.com/ergebnis/.github/blob/main/CODE_OF_CONDUCT.md).
 
+## Security Policy
+
+Please have a look at [`SECURITY.md`](.github/SECURITY.md).
+
 ## License
 
 This package is licensed using the MIT License.

composer.json

@@ -27,6 +27,7 @@
     "ergebnis/data-provider": "^2.0.0",
     "ergebnis/license": "^2.1.0",
     "ergebnis/php-cs-fixer-config": "^5.10.0",
+    "ergebnis/phpunit-slow-test-detector": "^2.3.0",
     "fakerphp/faker": "^1.23.0",
     "infection/infection": "~0.27.0",
     "phpunit/phpunit": "^10.2.3",

psalm-baseline.xml

@@ -1,8 +1,23 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="5.9.0@8b9ad1eb9e8b7d3101f949291da2b9f7767cd163">
+<files psalm-version="5.13.1@086b94371304750d1c673315321a55d15fc59015">
   <file src="src/JsonPointer.php">
     <MixedPropertyTypeCoercion>
       <code>$referenceTokens</code>
     </MixedPropertyTypeCoercion>
   </file>
+  <file src="test/Unit/JsonPointerTest.php">
+    <PossiblyUnusedMethod>
+      <code>provideInvalidJsonStringValue</code>
+      <code>provideInvalidUriFragmentIdentifierStringValue</code>
+      <code>provideJsonPointerReferenceTokenAndExpectedJsonPointer</code>
+      <code>provideJsonStringValueUriFragmentIdentifierStringValueAndReferenceTokens</code>
+    </PossiblyUnusedMethod>
+  </file>
+  <file src="test/Unit/ReferenceTokenTest.php">
+    <PossiblyUnusedMethod>
+      <code>provideInvalidJsonStringValue</code>
+      <code>provideInvalidUriFragmentIdentifierStringValue</code>
+      <code>provideValueJsonStringValueAndUriFragmentIdentifierStringValue</code>
+    </PossiblyUnusedMethod>
+  </file>
 </files>

rector.php

@@ -13,6 +13,7 @@
 
 use Rector\Config;
 use Rector\Core;
+use Rector\Php81;
 use Rector\PHPUnit;
 
 return static function (Config\RectorConfig $rectorConfig): void {
@@ -27,7 +28,11 @@
 
     $rectorConfig->phpVersion(Core\ValueObject\PhpVersion::PHP_81);
 
+    $rectorConfig->rules([
+        Php81\Rector\Property\ReadOnlyPropertyRector::class,
+    ]);
+
     $rectorConfig->sets([
-        PHPUnit\Set\PHPUnitSetList::PHPUNIT_90,
+        PHPUnit\Set\PHPUnitSetList::PHPUNIT_100,
     ]);
 };

src/JsonPointer.php

@@ -23,7 +23,7 @@ final class JsonPointer
     /**
      * @var array<int, ReferenceToken>
      */
-    private array $referenceTokens;
+    private readonly array $referenceTokens;
 
     private function __construct(ReferenceToken ...$referenceTokens)
     {

src/ReferenceToken.php

@@ -20,7 +20,7 @@
  */
 final class ReferenceToken
 {
-    private function __construct(private string $value)
+    private function __construct(private readonly string $value)
     {
     }