inferring params from calls to request object

dedoc · Apr 7, 2024 · 8cdff9c · 8cdff9c
1 parent 80fa442
commit 8cdff9c
Show file tree

Hide file tree

Showing 15 changed files with 337 additions and 6 deletions.
diff --git a/src/Infer/Analyzer/MethodAnalyzer.php b/src/Infer/Analyzer/MethodAnalyzer.php
@@ -5,6 +5,7 @@
 use Dedoc\Scramble\Infer\Context;
 use Dedoc\Scramble\Infer\Definition\ClassDefinition;
 use Dedoc\Scramble\Infer\Definition\FunctionLikeDefinition;
+use Dedoc\Scramble\Infer\Handler\IndexBuildingHandler;
 use Dedoc\Scramble\Infer\Reflector\ClassReflector;
 use Dedoc\Scramble\Infer\Scope\Index;
 use Dedoc\Scramble\Infer\Scope\NodeTypesResolver;
@@ -25,11 +26,12 @@ public function __construct(
     ) {
     }
 
-    public function analyze(FunctionLikeDefinition $methodDefinition)
+    public function analyze(FunctionLikeDefinition $methodDefinition, array $indexBuilders = [])
     {
         $this->traverseClassMethod(
             [$this->getClassReflector()->getMethod($methodDefinition->type->name)->getAstNode()],
             $methodDefinition,
+            $indexBuilders,
         );
 
         $methodDefinition = $this->index
@@ -46,7 +48,7 @@ private function getClassReflector(): ClassReflector
         return ClassReflector::make($this->classDefinition->name);
     }
 
-    private function traverseClassMethod(array $nodes, FunctionLikeDefinition $methodDefinition)
+    private function traverseClassMethod(array $nodes, FunctionLikeDefinition $methodDefinition, array $indexBuilders = [])
     {
         $traverser = new NodeTraverser;
 
@@ -57,6 +59,7 @@ private function traverseClassMethod(array $nodes, FunctionLikeDefinition $metho
             $nameResolver,
             new Scope($this->index, new NodeTypesResolver(), new ScopeContext($this->classDefinition), $nameResolver),
             Context::getInstance()->extensionsBroker->extensions,
+            [new IndexBuildingHandler($indexBuilders)],
         ));
 
         $node = (new NodeFinder())

diff --git a/src/Infer/Definition/ClassDefinition.php b/src/Infer/Definition/ClassDefinition.php
@@ -43,7 +43,7 @@ public function isChildOf(string $className)
         return $this->isInstanceOf($className) && $this->name !== $className;
     }
 
-    public function getMethodDefinition(string $name, Scope $scope = new GlobalScope)
+    public function getMethodDefinition(string $name, Scope $scope = new GlobalScope, array $indexBuilders = [])
     {
         if (! array_key_exists($name, $this->methods)) {
             return null;
@@ -55,7 +55,7 @@ public function getMethodDefinition(string $name, Scope $scope = new GlobalScope
             $this->methods[$name] = (new MethodAnalyzer(
                 $scope->index,
                 $this
-            ))->analyze($methodDefinition);
+            ))->analyze($methodDefinition, $indexBuilders);
         }
 
         $methodScope = new Scope(

diff --git a/src/Infer/Handler/IndexBuildingHandler.php b/src/Infer/Handler/IndexBuildingHandler.php
@@ -0,0 +1,25 @@
+<?php
+
+namespace Dedoc\Scramble\Infer\Handler;
+
+use Dedoc\Scramble\Infer\Scope\Scope;
+use PhpParser\Node;
+
+class IndexBuildingHandler
+{
+    public function __construct(
+        private array $indexBuilders,
+    ){}
+
+    public function shouldHandle($node)
+    {
+        return true;
+    }
+
+    public function leave(Node $node, Scope $scope)
+    {
+        foreach ($this->indexBuilders as $indexBuilder) {
+            $indexBuilder->afterAnalyzedNode($scope, $node);
+        }
+    }
+}
diff --git a/src/Infer/SimpleTypeGetters/ScalarTypeGetter.php b/src/Infer/SimpleTypeGetters/ScalarTypeGetter.php
@@ -2,6 +2,7 @@
 
 namespace Dedoc\Scramble\Infer\SimpleTypeGetters;
 
+use Dedoc\Scramble\Support\Type\Literal\LiteralFloatType;
 use Dedoc\Scramble\Support\Type\Literal\LiteralIntegerType;
 use Dedoc\Scramble\Support\Type\Literal\LiteralStringType;
 use Dedoc\Scramble\Support\Type\Type;
@@ -20,6 +21,10 @@ public function __invoke(Node\Scalar $node): Type
             return new LiteralIntegerType($node->value);
         }
 
+        if ($node instanceof Node\Scalar\DNumber) {
+            return new LiteralFloatType($node->value);
+        }
+
         return new UnknownType('Cannot get type from scalar');
     }
 }
diff --git a/src/Infer/TypeInferer.php b/src/Infer/TypeInferer.php
@@ -37,6 +37,7 @@ public function __construct(
         private FileNameResolver $nameResolver,
         private ?Scope $scope = null,
         array $extensions = [],
+        array $handlers = [],
     ) {
         $this->handlers = [
             new FunctionLikeHandler(),
@@ -56,6 +57,7 @@ public function __construct(
                 fn ($ext) => $ext instanceof ExpressionExceptionExtension,
             ))),
             new PhpDocHandler(),
+            ...$handlers,
         ];
     }
 

diff --git a/src/Support/Generator/Parameter.php b/src/Support/Generator/Parameter.php
@@ -8,6 +8,7 @@ class Parameter
 
     /**
      * Possible values are "query", "header", "path" or "cookie".
+     * @var "query"|"header"|"path"|"cookie".
      */
     public string $in;
 
@@ -18,6 +19,9 @@ class Parameter
     /** @var array|scalar|null|MissingExample */
     public $example;
 
+    /** @var array|scalar|null|MissingExample */
+    public $default;
+
     public bool $deprecated = false;
 
     public bool $allowEmptyValue = false;
@@ -28,7 +32,9 @@ public function __construct(string $name, string $in)
     {
         $this->name = $name;
         $this->in = $in;
+
         $this->example = new MissingExample;
+        $this->default = new MissingExample;
 
         if ($this->in === 'path') {
             $this->required = true;
@@ -55,7 +61,11 @@ public function toArray(): array
             $result['schema'] = $this->schema->toArray();
         }
 
-        return array_merge($result, $this->example instanceof MissingExample ? [] : ['example' => $this->example]);
+        return array_merge(
+            $result,
+            $this->example instanceof MissingExample ? [] : ['example' => $this->example],
+            $this->default instanceof MissingExample ? [] : ['default' => $this->default],
+        );
     }
 
     public function required(bool $required)
@@ -79,6 +89,13 @@ public function setSchema(?Schema $schema): self
         return $this;
     }
 
+    public function default($default)
+    {
+        $this->default = $default;
+
+        return $this;
+    }
+
     public function description(string $description)
     {
         $this->description = $description;

diff --git a/src/Support/Generator/Schema.php b/src/Support/Generator/Schema.php
@@ -46,6 +46,7 @@ public static function createFromParameters(array $parameters)
 
                 $paramType->setDescription($parameter->description);
                 $paramType->example($parameter->example);
+                $paramType->default($parameter->default);
 
                 $type->addProperty($parameter->name, $paramType);
             })

diff --git a/src/Support/Generator/Types/Type.php b/src/Support/Generator/Types/Type.php
@@ -18,6 +18,9 @@ abstract class Type
     /** @var array|scalar|null|MissingExample */
     public $example;
 
+    /** @var array|scalar|null|MissingExample */
+    public $default;
+
     /** @var array<array|scalar|null|MissingExample> */
     public $examples = [];
 
@@ -29,6 +32,7 @@ public function __construct(string $type)
     {
         $this->type = $type;
         $this->example = new MissingExample;
+        $this->default = new MissingExample;
     }
 
     public function nullable(bool $nullable)
@@ -53,6 +57,7 @@ public function addProperties(Type $fromType)
         $this->enum = $fromType->enum;
         $this->description = $fromType->description;
         $this->example = $fromType->example;
+        $this->default = $fromType->default;
 
         return $this;
     }
@@ -67,6 +72,7 @@ public function toArray()
                 'enum' => count($this->enum) ? $this->enum : null,
             ]),
             $this->example instanceof MissingExample ? [] : ['example' => $this->example],
+            $this->default instanceof MissingExample ? [] : ['default' => $this->default],
             count(
                 $examples = collect($this->examples)
                     ->reject(fn ($example) => $example instanceof MissingExample)
@@ -100,6 +106,16 @@ public function example($example)
         return $this;
     }
 
+    /**
+     * @param  array|scalar|null|MissingExample  $default
+     */
+    public function default($default)
+    {
+        $this->default = $default;
+
+        return $this;
+    }
+
     /**
      * @param  array<array|scalar|null|MissingExample>  $examples
      */

diff --git a/src/Support/IndexBuilders/Bag.php b/src/Support/IndexBuilders/Bag.php
@@ -0,0 +1,17 @@
+<?php
+
+namespace Dedoc\Scramble\Support\IndexBuilders;
+
+class Bag
+{
+    public function __construct(
+        public array $data = []
+    ) {}
+
+    public function set(string $key, $value)
+    {
+        $this->data[$key] = $value;
+
+        return $this;
+    }
+}