Merge branch 'vNext' into php-84-upgrade

knuckleswtf · Jan 18, 2025 · 4674c2d · 4674c2d
2 parents 9ca60a3 + d5e61eb
commit 4674c2d
Show file tree

Hide file tree

Showing 16 changed files with 52 additions and 39 deletions.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -2,7 +2,7 @@ name: Lint
 
 on:
   push:
-    branches: [master]
+    branches: [master, vNext]
   pull_request:
 
 jobs:
@@ -11,7 +11,7 @@ jobs:
     strategy:
       matrix:
         php:
-        - 8.1
+        - 8.3
 
     name: Lint code (PHP ${{ matrix.php }})
 

diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml
@@ -2,7 +2,7 @@ name: Tests
 
 on:
   push:
-    branches: [master, v4]
+    branches: [master, vNext]
   pull_request:
 
 jobs:
@@ -11,11 +11,14 @@ jobs:
     strategy:
       matrix:
         php:
+        - '8.4'
+        - '8.3'
         - '8.2'
         - '8.1'
         deps:
         - highest
         include:
+          - {php: '8.1', deps: lowest}
           - {php: '8.1', deps: dingo}
 
     name: Tests (PHP ${{ matrix.php }} - ${{ matrix.deps }})

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,20 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ### Removed
 
+# 4.39.0 (31 December 2024)
+## Added
+- Correctly list required fields for nested objects in OpenAPI spec [#905](https://github.com/knuckleswtf/scribe/pull/905)
+- Cursor pagination support in API responses (`cursorPaginate`/`paginate=cursor`) [#917](https://github.com/knuckleswtf/scribe/pull/917)
+
+## Fixed
+- Fixed type error when attempting to parse Request::validate [#925](https://github.com/knuckleswtf/scribe/pull/925)
+- Don't render empty responses as string "null" in OpenAPI spec [#911](https://github.com/knuckleswtf/scribe/pull/911)
+- Correctly replace `apiDescriptionUrl`for `external_laravel` (Eelements theme) [#906](https://github.com/knuckleswtf/scribe/pull/906)
+- Cast form data values to strings in Postman collection [#926](https://github.com/knuckleswtf/scribe/pull/926)
+
+## Modified
+- Resolve PHP 8.4 deprecations [#929](https://github.com/knuckleswtf/scribe/pull/929)
+
 # 4.38.0 (18 October 2024)
 ## Fixed
 - Elements theme: Fix display of boolean examples [#887](https://github.com/knuckleswtf/scribe/pull/887)

diff --git a/composer.lowest.json b/composer.lowest.json
@@ -16,7 +16,7 @@
         }
     ],
     "require": {
-        "php": ">=8.0",
+        "php": ">=8.1",
         "ext-fileinfo": "*",
         "ext-json": "*",
         "ext-pdo": "*",

diff --git a/config/scribe.php b/config/scribe.php
@@ -106,7 +106,7 @@
         // Options: query, body, basic, bearer, header (for custom header)
         'in' => 'bearer',
 
-        // The name of the auth parameter (eg token, key, apiKey) or header (eg Authorization, Api-Key).
+        // The name of the auth parameter (e.g. token, key, apiKey) or header (e.g. Authorization, Api-Key).
         'name' => 'key',
 
         // The value of the parameter to be used by Scribe to authenticate response calls.
@@ -189,7 +189,7 @@
     'last_updated' => 'Last updated: {date:F j, Y}',
 
     'examples' => [
-        // Set this to any number (eg. 1234) to generate the same example values for parameters on each run,
+        // Set this to any number (e.g. 1234) to generate the same example values for parameters on each run,
         'faker_seed' => null,
 
         // With API resources and transformers, Scribe tries to generate example models to use in your API responses.

diff --git a/src/Attributes/GenericParam.php b/src/Attributes/GenericParam.php
@@ -41,12 +41,10 @@ protected function getEnumValues(): array
             return $this->enum;
         }
 
-        if (function_exists('enum_exists') && enum_exists($this->enum)
-            && method_exists($this->enum, 'tryFrom')
-        ) {
+        if (enum_exists($this->enum) && method_exists($this->enum, 'tryFrom')) {
             return array_map(
             // $case->value only exists on BackedEnums, not UnitEnums
-            // method_exists($enum, 'tryFrom') implies $enum instanceof BackedEnum
+            // method_exists($enum, 'tryFrom') implies the enum is a BackedEnum
             // @phpstan-ignore-next-line
                 fn ($case) => $case->value,
                 $this->enum::cases()

diff --git a/src/Extracting/ParsesValidationRules.php b/src/Extracting/ParsesValidationRules.php
@@ -205,15 +205,15 @@ protected function parseRule($rule, array &$parameterData, bool $independentOnly
             return true;
         }
 
-        if (function_exists('enum_exists') && $rule instanceof \Illuminate\Validation\Rules\Enum) {
+        if ($rule instanceof \Illuminate\Validation\Rules\Enum) {
             $reflection = new \ReflectionClass($rule);
             $property = $reflection->getProperty('type');
             $property->setAccessible(true);
             $type = $property->getValue($rule);
 
             if (enum_exists($type) && method_exists($type, 'tryFrom')) {
                 // $case->value only exists on BackedEnums, not UnitEnums
-                // method_exists($enum, 'tryFrom') implies $enum instanceof BackedEnum
+                // method_exists($enum, 'tryFrom') implies the enum is a BackedEnum
                 // @phpstan-ignore-next-line
                 $cases = array_map(fn ($case) => $case->value, $type::cases());
                 $parameterData['type'] = gettype($cases[0]);

diff --git a/src/Extracting/Shared/ValidationRulesFinders/RequestValidateFacade.php b/src/Extracting/Shared/ValidationRulesFinders/RequestValidateFacade.php
@@ -25,13 +25,14 @@ public static function find(Node $node)
 
         if (
             $expr instanceof Node\Expr\StaticCall
-            && in_array((string) $expr->class, ['Request', \Illuminate\Support\Facades\Request::class])
+            && $expr->class instanceof Node\Name
+            && in_array($expr->class->name, ['Request', \Illuminate\Support\Facades\Request::class])
         ) {
-            if ($expr->name->name == "validate") {
+            if ($expr->name->name === "validate") {
                 return $expr->args[0]->value;
             }
 
-            if ($expr->name->name == "validateWithBag") {
+            if ($expr->name->name === "validateWithBag") {
                 return $expr->args[1]->value;
             }
         }

diff --git a/src/Extracting/Strategies/GetFromInlineValidatorBase.php b/src/Extracting/Strategies/GetFromInlineValidatorBase.php
@@ -84,12 +84,11 @@ public function lookForInlineValidationRules(ClassMethod $methodAst): array
                     }
                     // Try to extract Enum rule
                     else if (
-                        function_exists('enum_exists') &&
                         ($enum = $this->extractEnumClassFromArrayItem($arrayItem)) &&
                         enum_exists($enum) && method_exists($enum, 'tryFrom')
                     ) {
                         // $case->value only exists on BackedEnums, not UnitEnums
-                        // method_exists($enum, 'tryFrom') implies $enum instanceof BackedEnum
+                        // method_exists($enum, 'tryFrom') implies the enum is a BackedEnum
                         // @phpstan-ignore-next-line
                         $rulesList[] = 'in:' . implode(',', array_map(fn ($case) => $case->value, $enum::cases()));
                     }

diff --git a/src/Scribe.php b/src/Scribe.php
@@ -9,7 +9,7 @@
 
 class Scribe
 {
-    public const VERSION = '4.38.0';
+    public const VERSION = '4.39.0';
 
     /**
      * Specify a callback that will be executed just before a response call is made

diff --git a/src/Writing/PostmanCollectionWriter.php b/src/Writing/PostmanCollectionWriter.php
@@ -222,7 +222,7 @@ protected function getFormDataParams(array $paramsKeyValue, ?string $key = null,
             if (!is_array($value)) {
                 $body[] = [
                     'key' => $index,
-                    'value' => $value,
+                    'value' => (string) $value,
                     'type' => 'text',
                     'description' => $paramsFullDetails[$index]->description ?? '',
                 ];

diff --git a/tests/Fixtures/TestController.php b/tests/Fixtures/TestController.php
@@ -704,19 +704,14 @@ public function withEnumRule(Request $request)
         ]);
     }
 
-    /**
-     * Can only run on PHP 8.1
     public function withInjectedEnumAndModel(Category $category, TestUser $user)
     {
         return null;
     }
-     */
 }
 
-/**
 enum Category: string
 {
     case Fruits = 'fruits';
     case People = 'people';
 }
-*/
diff --git a/tests/GenerateDocumentation/OutputTest.php b/tests/GenerateDocumentation/OutputTest.php
@@ -171,6 +171,12 @@ private function generate_with_paths($configName, $intermediateOutputDirectory =
     /** @test */
     public function generated_postman_collection_file_is_correct()
     {
+        if (phpversion() < 8.3) {
+            // See https://github.com/FakerPHP/Faker/issues/694
+            $this->markTestSkipped('Faker seeding changed in PHP 8.3');
+            return;
+        }
+
         RouteFacade::post('/api/withBodyParametersAsArray', [TestController::class, 'withBodyParametersAsArray']);
         RouteFacade::post('/api/withFormDataParams', [TestController::class, 'withFormDataParams']);
         RouteFacade::post('/api/withBodyParameters', [TestController::class, 'withBodyParameters']);
@@ -205,6 +211,12 @@ public function generated_postman_collection_file_is_correct()
     /** @test */
     public function generated_openapi_spec_file_is_correct()
     {
+        if (phpversion() < 8.3) {
+            // See https://github.com/FakerPHP/Faker/issues/694
+            $this->markTestSkipped('Faker seeding changed in PHP 8.3');
+            return;
+        }
+
         RouteFacade::post('/api/withBodyParametersAsArray', [TestController::class, 'withBodyParametersAsArray']);
         RouteFacade::post('/api/withFormDataParams', [TestController::class, 'withFormDataParams']);
         RouteFacade::get('/api/withResponseTag', [TestController::class, 'withResponseTag']);

diff --git a/tests/Strategies/GetFromInlineValidatorTest.php b/tests/Strategies/GetFromInlineValidatorTest.php
@@ -232,10 +232,6 @@ public function respects_query_params_comment()
     /** @test */
     public function can_fetch_inline_enum_rules()
     {
-        if (phpversion() < 8.1) {
-            $this->markTestSkipped('Enums are only supported in PHP 8.1 or later');
-        }
-
         $endpoint = $this->endpoint(function (ExtractedEndpointData $e) {
             $e->method = new \ReflectionMethod(TestController::class, 'withEnumRule');
         });

diff --git a/tests/Strategies/UrlParameters/GetFromLaravelAPITest.php b/tests/Strategies/UrlParameters/GetFromLaravelAPITest.php
@@ -22,24 +22,23 @@ class GetFromLaravelAPITest extends BaseLaravelTest
     /** @test */
     public function can_infer_type_from_model_binding()
     {
-        $endpoint = $this->endpointForRoute("users/{id}", TestController::class, 'withInjectedModel');
-        // Can only run on PHP 8.1
-        // $endpoint = $this->endpointForRoute("categories/{category}/users/{id}/", TestController::class, 'withInjectedEnumAndModel');
+        // $endpoint = $this->endpointForRoute("users/{id}", TestController::class, 'withInjectedModel');
+        $endpoint = $this->endpointForRoute("categories/{category}/users/{id}/", TestController::class, 'withInjectedEnumAndModel');
         $results = $this->fetch($endpoint);
 
         $this->assertArraySubset([
             "name" => "id",
             "description" => "The ID of the user.",
             "required" => true,
             "type" => "integer",
-        ], $results['id']);/*
+        ], $results['id']);
         $this->assertArraySubset([
             "name" => "category",
             "description" => "The category.",
             "required" => true,
             "type" => "string",
             "example" => \Knuckles\Scribe\Tests\Fixtures\Category::cases()[0]->value,
-        ], $results['category']);*/
+        ], $results['category']);
         $this->assertIsInt($results['id']['example']);
     }
 

diff --git a/tests/Unit/ValidationRuleParsingTest.php b/tests/Unit/ValidationRuleParsingTest.php
@@ -45,7 +45,7 @@ public function can_parse_supported_rules(array $ruleset, array $customInfo, arr
         Schema::create('users', function ($table) {
             $table->id();
         });
-        
+
         $results = $this->strategy->parse($ruleset, $customInfo);
 
         $parameterName = array_keys($ruleset)[0];
@@ -57,7 +57,7 @@ public function can_parse_supported_rules(array $ruleset, array $customInfo, arr
 
         // Validate that the generated values actually pass validation (for rules where we can generate some data)
         if (is_string($ruleset[$parameterName]) && str_contains($ruleset[$parameterName], "exists")) return;
-        
+
         $exampleData = [$parameterName => $results[$parameterName]['example']];
         $validator = Validator::make($exampleData, $ruleset);
         try {
@@ -552,10 +552,6 @@ public function can_parse_custom_rule_classes()
     /** @test */
     public function can_parse_enum_rules()
     {
-        if (phpversion() < 8.1) {
-            $this->markTestSkipped('Enums are only supported in PHP 8.1 or later');
-        }
-
         $results = $this->strategy->parse([
             'enum' => [
                 'required',