Allow reflection-docblock v6 & fix mixin generation in Windows

.github/workflows/packagist-deploy.yml

@@ -2,7 +2,7 @@ name: Packagist Deploy
 
 on:
   release:
-    types: [created]
+    types: [ created ]
 
 jobs:
   build:
@@ -13,8 +13,8 @@ jobs:
       packages: write
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - uses: mnavarrocarter/packagist-update@v1.0.0
         with:
           username: "GautierDele"
-          api_token: ${{ secrets.PACKAGIST_TOKEN }}
+          api_token: ${{ secrets.PACKAGIST_TOKEN }}

.github/workflows/tests.yml

@@ -14,13 +14,13 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-version: [ '8.3', '8.4', '8.5' ]
+        php-version: [ "8.3", "8.4", "8.5" ]
 
     name: Tests on PHP ${{ matrix.php-version }}
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
@@ -33,7 +33,7 @@ jobs:
 
       - name: Cache Composer packages
         id: composer-cache
-        uses: actions/cache@v4
+        uses: actions/cache@v5
         with:
           path: vendor
           key: ${{ runner.os }}-php-${{ matrix.php-version }}-${{ hashFiles('**/composer.lock') }}
@@ -42,7 +42,7 @@ jobs:
 
       - name: Install dependencies
         if: steps.composer-cache.outputs.cache-hit != 'true'
-        run: composer i --prefer-dist --no-progress
+        run: composer i --no-progress
 
       - name: Run test suite
-        run: vendor/bin/phpunit
+        run: vendor/bin/phpunit

.gitignore

@@ -1,4 +1,6 @@
 /vendor
 composer.lock
 .phpunit*
-.idea
+.idea
+faker_mixin.php
+packages.php

README.md

@@ -19,7 +19,7 @@ You'll be able to generate fake data for your applications, making your test env
 Here is a quick look at what you can do:
 
 ```php
-$faker = new Xefi\Faker\Faker();
+$faker = new \Xefi\Faker\Faker();
 
 $faker->name() // John Doe
 $faker->name() // Charles Brown

composer.json

@@ -19,11 +19,11 @@
   ],
   "require": {
     "php": ">=8.3 <8.6",
-    "phpdocumentor/reflection-docblock": "^5.6",
+    "phpdocumentor/reflection-docblock": "^5.6|^6.0",
     "psr/container": "^2.0"
   },
   "require-dev": {
-    "phpunit/phpunit": "^11"
+    "phpunit/phpunit": "^12.5.23"
   },
   "autoload": {
     "psr-4": {
@@ -35,9 +35,6 @@
       "Xefi\\Faker\\Tests\\": "tests/"
     }
   },
-  "config": {
-    "sort-packages": true
-  },
   "extra": {
     "faker": {
       "providers": [
@@ -47,13 +44,27 @@
   },
   "scripts": {
     "post-install-cmd": [
-      "composer run generate-mixin"
+      "@composer run generate-mixin"
     ],
     "post-update-cmd": [
-      "composer run generate-mixin"
+      "@composer run generate-mixin"
     ],
     "generate-mixin": [
-      "php -r 'require \"vendor/autoload.php\"; (new Xefi\\Faker\\Container\\Container());'"
+      "@php scripts/generate-mixin.php"
+    ],
+    "test": [
+      "@php vendor/bin/phpunit --colors=always"
     ]
-  }
+  },
+  "scripts-descriptions": {
+    "test": "Run the PHPUnit tests.",
+    "generate-mixin": "Generates the IDE mixin during package installation to enable autocompletion support."
+  },
+  "config": {
+    "optimize-autoloader": true,
+    "preferred-install": "dist",
+    "sort-packages": true
+  },
+  "minimum-stability": "stable",
+  "prefer-stable": true
 }

scripts/generate-mixin.php

@@ -0,0 +1,16 @@
+<?php
+
+/**
+ * Script to generate the IDE mixin for Xefi/Faker.
+ *
+ * This file is executed during Composer install/update via the "generate-mixin" script.
+ * It bootstraps the autoloader and instantiates the Xefi\Faker\Container\Container,
+ * which produces the mixin file used by supported IDEs to enable autocompletion.
+ *
+ * Running this ensures that developers get proper type hints and code completion
+ * when working with xefi/faker-php in their projects.
+ */
+
+require __DIR__.'/../vendor/autoload.php';
+
+new \Xefi\Faker\Container\Container();

tests/Unit/Extensions/GeographicalExtensionTest.php

@@ -1,8 +1,6 @@
 <?php
 
-namespace Extensions;
-
-use Xefi\Faker\Tests\Unit\Extensions\TestCase;
+namespace Xefi\Faker\Tests\Unit\Extensions;
 
 final class GeographicalExtensionTest extends TestCase
 {

tests/Unit/LocaleTest.php

@@ -1,5 +1,7 @@
 <?php
 
+namespace Xefi\Faker\Tests\Unit;
+
 class LocaleTest extends \Xefi\Faker\Tests\Unit\TestCase
 {
     protected function setUp(): void
@@ -39,7 +41,7 @@ public function testCallingDefaultExtension()
 
     public function testUsingDefaultLocale()
     {
-        $faker = new Xefi\Faker\Faker('fr_FR');
+        $faker = new \Xefi\Faker\Faker('fr_FR');
         $this->assertEquals(
             'fr_FR',
             $faker->returnLocale()
@@ -68,7 +70,7 @@ public function testUsingDefaultLocale()
 
     public function testResettingLocale()
     {
-        $faker = new Xefi\Faker\Faker('fr_FR');
+        $faker = new \Xefi\Faker\Faker('fr_FR');
         $this->assertEquals(
             'fr_FR',
             $faker->returnLocale()
@@ -87,7 +89,7 @@ public function testResettingLocale()
 
     public function testUsingNotExistingLocaleFallingBackToNullLocale()
     {
-        $faker = new Xefi\Faker\Faker('not-existing-locale');
+        $faker = new \Xefi\Faker\Faker('not-existing-locale');
         $this->assertEquals(
             'default',
             $faker->returnLocale()
@@ -108,7 +110,7 @@ public function testUsingNotExistingLocaleWithoutNullLocale()
         $this->expectException(\Xefi\Faker\Exceptions\NoExtensionLocaleFound::class);
         $this->expectExceptionMessage('Locale \'not-existing-locale\' and \'default\' for method \'returnLocale\' was not found');
 
-        $faker = new Xefi\Faker\Faker('not-existing-locale');
+        $faker = new \Xefi\Faker\Faker('not-existing-locale');
         $faker->returnLocale();
     }
 }

tests/Unit/PackageManifestTest.php

@@ -2,8 +2,9 @@
 
 declare(strict_types=1);
 
+namespace Xefi\Faker\Tests\Unit;
+
 use Xefi\Faker\Manifests\PackageManifest;
-use Xefi\Faker\Tests\Unit\TestCase;
 
 final class PackageManifestTest extends TestCase
 {

tests/Unit/ProviderRepositoryTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-use Xefi\Faker\Tests\Unit\TestCase;
+namespace Xefi\Faker\Tests\Unit;
 
 final class ProviderRepositoryTest extends TestCase
 {

tests/Unit/Strategies/ValidStrategyTest.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Strategies;
+namespace Xefi\Faker\Tests\Unit\Strategies;
 
 use Xefi\Faker\Faker;
 use Xefi\Faker\Strategies\ValidStrategy;