V3 Work (#48)

Author: dcarbone

.gitattributes

@@ -4,5 +4,4 @@
 /.gitattributes export-ignore
 /phpunit.xml export-ignore
 /README.md export-ignore
-/tools export-ignore
-/docker export-ignore
+/tools export-ignore

.github/copilot-instructions.md

@@ -0,0 +1,36 @@
+# Everywhere within this repository:
+* **Always** use `null|` in favor of `?` for nullable types (e.g. `?string` instead of `string|null`).
+* **Always** use variadic parameters instead of `array` for lists of items (e.g. `string ...$items` instead
+   of `array $items`).
+* **Always** use `self` instead of the class name in method signatures (e.g. 
+   `public function setFoo(string $foo): self` instead of `public function setFoo(string $foo): MyClass`).
+* **Always** always match casing of class properties when defining parameters and methods (e.g. 
+   `public function setFooBar(string $FooBar)` if the class property is `$FooBar`).
+* **Always** define a phpdoc for `array` types that specifies the item type (e.g. 
+   `/** @param string[] $items */` for `array $items`).
+* **Never** edit files using sed, awk, or other shell utilities.
+* **Always** limit yourself to POSIX shell syntax when executing shell scripts.
+* **Always** run phpstan with 512MB of memory when analyzing generated code 
+   (e.g. `phpstan analyze -c phpstan.neon --memory-limit=512M src/`).
+* **Always** specify `: void` for methods that do not return a value (e.g. `public function setFoo(string $foo): void`).
+   * This includes unit test methods (e.g. `public function testFoo(): void`).
+* **Always** use `declare(strict_types=1);` at the top of all PHP files.
+   * Do not do this in PHPUnit test class files, as PHPUnit does not support strict types.
+* **Always** ensure that constructor parameters for enum fields also accept the enum value type 
+   (e.g. `public function __construct(string $foo, string|MyEnum $bar)`).
+  * Write tests for both cases.
+* **Never** leave imports unused in generated code.
+* **Always** used named parameters wherever possible.
+* **Never** bother with docblocks unless they are necessary to specify types that cannot be expressed in code
+   (e.g. `/** @param string[] $items */` for `array $items`).
+* **Never** call `jsonSerialize` directly in generated code from within others, as this is an implementation detail\
+   of the `JsonSerializable` interface.
+   * Instead, simply set the field of the output object to the raw value of the field (e.g. 
+     `$output->foo = $this->foo;` instead of `$output->foo = $this->foo->jsonSerialize();`).
+
+# When generting code for concrete implementations of AbstractType:
+* **Always** ensure that class fields have an associated getter and setter method.
+* **Always** ensure the constructor has parameters for all class fields, and that the constructor parameters are
+   assigned to the class fields.
+* **Always** write unit tests that use both the constructor and the setter methods to set class fields,
+   and that use the getter methods and fields directly to verify that the fields were set correctly.

.github/workflows/tests.yaml

@@ -1,5 +1,21 @@
 name: "Tests"
 
+permissions:
+  actions: none
+  attestations: none
+  checks: none
+  contents: read
+  deployments: none
+  id-token: none
+  issues: none
+  models: none
+  discussions: none
+  packages: none
+  pages: none
+  pull-requests: none
+  security-events: none
+  statuses: none
+
 on:
   pull_request:
     branches:
@@ -8,6 +24,15 @@ on:
       - '**.php'
       - 'composer.json'
       - 'composer.lock'
+      - '.php-cs-fixer.php'
+      - 'phpstan.neon'
+      - 'psalm.xml'
+      - 'tools/php-cs-fixer/composer.json'
+      - 'tools/php-cs-fixer/composer.lock'
+      - 'tools/phpstan/composer.json'
+      - 'tools/phpstan/composer.lock'
+      - 'tools/psalm/composer.json'
+      - 'tools/psalm/composer.lock'
       - 'phpunit.xml'
       - '.github/workflows/tests.yaml'
   push:
@@ -17,23 +42,94 @@ on:
       - '**.php'
       - 'composer.json'
       - 'composer.lock'
+      - '.php-cs-fixer.php'
+      - 'phpstan.neon'
+      - 'psalm.xml'
+      - 'tools/php-cs-fixer/composer.json'
+      - 'tools/php-cs-fixer/composer.lock'
+      - 'tools/phpstan/composer.json'
+      - 'tools/phpstan/composer.lock'
+      - 'tools/psalm/composer.json'
+      - 'tools/psalm/composer.lock'
       - 'phpunit.xml'
       - '.github/workflows/tests.yaml'
 
 env:
   CONSUL_HTTP_ADDR: "127.0.0.1:8500"
-  CONSUL_VERSION: '1.20.5'
+  CONSUL_VERSION: '2.0.1'
 
 jobs:
+  checks:
+    runs-on: ubuntu-22.04
+    name: Checks - PHP 8.3
+    steps:
+      - uses: actions/checkout@v7
+
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.3'
+          extensions: json,dom,simplexml,tokenizer,mbstring
+          ini-values: precision=14,serialize_precision=-1
+          ini-file: 'development'
+
+      - name: 'Install root composer deps'
+        shell: bash -e {0}
+        # language=sh
+        run: |
+          composer install --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
+
+      - name: 'Restore tool vendor cache'
+        id: tool-vendor-cache
+        uses: actions/cache/restore@v6
+        with:
+          path: |
+            tools/php-cs-fixer/vendor
+            tools/phpstan/vendor
+            tools/psalm/vendor
+          key: "tool-vendor-${{ runner.os }}-8.3-${{ hashFiles('tools/php-cs-fixer/composer.lock', 'tools/phpstan/composer.lock', 'tools/psalm/composer.lock') }}"
+
+      - name: 'Install tool composer deps'
+        shell: bash -e {0}
+        # language=sh
+        run: |
+          composer install --working-dir tools/php-cs-fixer --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
+          composer install --working-dir tools/phpstan --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
+          composer install --working-dir tools/psalm --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
+
+      - name: 'Save tool vendor cache'
+        if: steps.tool-vendor-cache.outputs.cache-hit != 'true' && steps.tool-vendor-cache.outputs.cache-hit != true
+        uses: actions/cache/save@v6
+        with:
+          path: |
+            tools/php-cs-fixer/vendor
+            tools/phpstan/vendor
+            tools/psalm/vendor
+          key: "tool-vendor-${{ runner.os }}-8.3-${{ hashFiles('tools/php-cs-fixer/composer.lock', 'tools/phpstan/composer.lock', 'tools/psalm/composer.lock') }}"
+
+      - name: 'Execute php-cs-fixer'
+        # language=bash
+        run: |
+          composer php-cs-fixer -- --dry-run --diff
+
+      - name: 'Execute phpstan'
+        # language=bash
+        run: |
+          composer phpstan
+
+      - name: 'Execute psalm'
+        # language=bash
+        run: |
+          composer psalm
+
   tests:
     runs-on: ubuntu-22.04
     strategy:
       matrix:
         php-version:
-          - '8.1'
           - '8.2'
           - '8.3'
           - '8.4'
+          - '8.5'
 
     name: Tests - PHP ${{ matrix.php-version }}
     steps:
@@ -46,10 +142,10 @@ jobs:
         run: |
           _phpunit_version=
           case "${{ matrix.php-version }}" in
-            8.1) _phpunit_version='10.5' ;;
-            8.2) _phpunit_version='11.1' ;;
-            8.3) _phpunit_version='11.1' ;;
-            8.4) _phpunit_version='11.1' ;;
+            8.2) _phpunit_version='11.5' ;;
+            8.3) _phpunit_version='12.0' ;;
+            8.4) _phpunit_version='12.0' ;;
+            8.5) _phpunit_version='12.0' ;;
             *) echo "Unsupported PHP version: ${{ matrix.php-version }}" && exit 1 ;;
           esac
           echo "phpunit-version=${_phpunit_version}" >> $GITHUB_OUTPUT
@@ -59,6 +155,7 @@ jobs:
           php-version: ${{ matrix.php-version }}
           extensions: json
           ini-values: precision=14,serialize_precision=-1
+          ini-file: 'development'
 
       - name: 'Install jq'
         uses: dcarbone/install-jq-action@v4
@@ -85,7 +182,7 @@ jobs:
         uses: actions/cache@v6
         with:
           path: ${{ steps.composer-cache.outputs.dir }}
-          key: "composer-${{ runner.os }}-${{ matrix.php-version }}-${{ steps.vars.outputs.phpunit-version }}-${{ hashFiles('composer.lock') }}"
+          key: "composer-${{ runner.os }}-${{ matrix.php-version }}-${{ steps.vars.outputs.phpunit-version }}-${{ hashFiles('composer.json') }}"
 
       - name: 'Install composer deps'
         shell: bash -e {0}
@@ -99,7 +196,7 @@ jobs:
         uses: actions/cache/save@v6
         with:
           path: ${{ steps.composer-cache.outputs.dir }}
-          key: "composer-${{ runner.os }}-${{ matrix.php-version }}-${{ steps.vars.outputs.phpunit-version }}-${{ hashFiles('composer.lock') }}"
+          key: "composer-${{ runner.os }}-${{ matrix.php-version }}-${{ steps.vars.outputs.phpunit-version }}-${{ hashFiles('composer.json') }}"
 
       - name: 'Restore consul ${{ env.CONSUL_VERSION }}'
         id: consul-cache
@@ -135,4 +232,4 @@ jobs:
       - name: 'Execute tests'
         # language=bash
         run: |
-          ./vendor/bin/phpunit -c phpunit.xml
+          ./vendor/bin/phpunit -c phpunit.xml --display-deprecations

.gitignore

@@ -1,7 +1,9 @@
+.idea/
+.junie/
+.php-cs-fixer.cache
+.php_cs.cache
+.phpunit.result.cache
 /composer.phar
-/vendor/
-/.idea
-/*.iml
-/consul.log
-/.phpunit.result.cache
-.php_cs.cache
+vendor/
+*.iml
+consul.log

…php-cs-fixer/php-consul-api-rules.php_cs .php-cs-fixer.phptools/php-cs-fixer/php-consul-api-rules.php_cs renamed to .php-cs-fixer.php tools/php-cs-fixer/php-consul-api-rules.php_cs renamed to .php-cs-fixer.php

@@ -1,28 +1,35 @@
-<?php declare(strict_types=1);
+<?php
 
-require_once __DIR__ . '/../../vendor/autoload.php';
+declare(strict_types=1);
+
+require_once __DIR__ . '/tools/php-cs-fixer/vendor/autoload.php';
 
 use AdamWojs\PhpCsFixerPhpdocForceFQCN\Fixer\Phpdoc\ForceFQCNFixer;
 use PhpCsFixer\Config;
-use PhpCsFixer\RuleSet\Sets\PSR12RiskySet;
-use PhpCsFixer\RuleSet\Sets\PSR12Set;
+use PhpCsFixer\Finder;
 
 $config = new Config('php-consul-api');
 
 $config
     ->setUsingCache(false)
-    ->setRiskyAllowed(true)
+//    ->setRiskyAllowed(true)
     ->setLineEnding("\n")
     ->setIndent('    ')
     ->registerCustomFixers(
-        [
+        fixers: [
             new ForceFQCNFixer(),
         ]
     )
+    ->setFinder(
+        Finder::create()
+            ->in(__DIR__ . '/src')
+            ->name('*.php')
+    )
     ->setRules(
-        (new PSR12Set())->getRules() +
-        (new PSR12RiskySet())->getRules() +
         [
+            '@PSR12' => true,
+//            'PSR12Risky',
+
             // custom rules
 
             'AdamWojs/phpdoc_force_fqcn_fixer' => true,