Improve Twig-sourced code generation and restrict usage

README.md

@@ -381,6 +381,12 @@ enum SearchType: string
     // Returns results matching issues in repositories.
     case IssueAdvanced = 'ISSUE_ADVANCED';
 
+    // Returns results matching issues using hybrid (lexical + semantic) search.
+    case IssueHybrid = 'ISSUE_HYBRID';
+
+    // Returns results matching issues using semantic search.
+    case IssueSemantic = 'ISSUE_SEMANTIC';
+
     // Returns results matching repositories.
     case Repository = 'REPOSITORY';
 

composer.json

@@ -7,7 +7,7 @@
         "php": "^8.4",
         "composer-runtime-api": "^2.0",
         "nikic/php-parser": "^5.6",
-        "phpstan/phpstan": "^2.1",
+        "phpstan/phpstan": "^2.1.18",
         "ruudk/code-generator": "^0.4.4",
         "symfony/console": "^7.4 || ^8.0",
         "symfony/filesystem": "^7.4 || ^8.0",

examples/Generated/Enum/SearchType.php

@@ -20,6 +20,12 @@ enum SearchType: string
     // Returns results matching issues in repositories.
     case IssueAdvanced = 'ISSUE_ADVANCED';
 
+    // Returns results matching issues using hybrid (lexical + semantic) search.
+    case IssueHybrid = 'ISSUE_HYBRID';
+
+    // Returns results matching issues using semantic search.
+    case IssueSemantic = 'ISSUE_SEMANTIC';
+
     // Returns results matching repositories.
     case Repository = 'REPOSITORY';
 

lefthook.yaml

@@ -32,6 +32,8 @@ pre-commit:
 
     php-cs-fixer:
       glob: "*.php"
+      exclude:
+        - "**/Generated/**"
       run: vendor/bin/php-cs-fixer fix --config .php-cs-fixer.php -- {staged_files}
       stage_fixed: true
 

phpstan.php

@@ -61,6 +61,14 @@
                     __DIR__ . '/tests/*/Generated/*',
                 ],
             ],
+            [
+                'identifiers' => [
+                    'shipmonk.deadMethod',
+                ],
+                'paths' => [
+                    __DIR__ . '/tests/PHPStan/Fixtures/*',
+                ],
+            ],
             [
                 'identifiers' => [
                     'shipmonk.deadConstant',

src/Generator/DataClassGenerator.php

@@ -12,7 +12,8 @@
 use Ruudk\GraphQLCodeGenerator\Config\Config;
 use Ruudk\GraphQLCodeGenerator\GraphQL\AST\Printer;
 use Ruudk\GraphQLCodeGenerator\Planner\Plan\DataClassPlan;
-use Ruudk\GraphQLCodeGenerator\Planner\Source\FileSource;
+use Ruudk\GraphQLCodeGenerator\Planner\Source\GraphQLFileSource;
+use Ruudk\GraphQLCodeGenerator\Planner\Source\TwigFileSource;
 use Ruudk\GraphQLCodeGenerator\Type\FragmentObjectType;
 use Ruudk\GraphQLCodeGenerator\Type\IndexByCollectionType;
 use Ruudk\GraphQLCodeGenerator\Type\StringLiteralType;
@@ -86,12 +87,20 @@ public function generate(DataClassPlan $plan) : string
 
             if ($this->config->addGeneratedAttribute) {
                 yield from $generator->dumpAttribute(Generated::class, function () use ($generator, $plan) {
-                    if ($plan->source instanceof FileSource) {
+                    if ($plan->source instanceof GraphQLFileSource) {
                         yield sprintf('source: %s', var_export($plan->source->relativeFilePath, true));
 
                         return;
                     }
 
+                    if ($plan->source instanceof TwigFileSource) {
+                        yield sprintf('source: %s', var_export($plan->source->relativeFilePath, true));
+                        yield 'restricted: true';
+                        yield 'restrictInstantiation: true';
+
+                        return;
+                    }
+
                     yield sprintf('source: %s', $generator->dumpClassReference($plan->source->class));
                     yield 'restricted: true';
                     yield 'restrictInstantiation: true';

src/Generator/OperationClassGenerator.php

@@ -8,7 +8,7 @@
 use Ruudk\CodeGenerator\CodeGenerator;
 use Ruudk\GraphQLCodeGenerator\Attribute\Generated;
 use Ruudk\GraphQLCodeGenerator\Planner\Plan\OperationClassPlan;
-use Ruudk\GraphQLCodeGenerator\Planner\Source\FileSource;
+use Ruudk\GraphQLCodeGenerator\Planner\Source\GraphQLFileSource;
 use Ruudk\GraphQLCodeGenerator\Type\TypeDumper;
 use Symfony\Component\TypeInfo\Type as SymfonyType;
 use Symfony\Component\TypeInfo\TypeIdentifier;
@@ -36,7 +36,7 @@ public function generate(OperationClassPlan $plan) : string
 
             if ($this->config->addGeneratedAttribute) {
                 yield from $generator->dumpAttribute(Generated::class, function () use ($generator, $plan) {
-                    if ($plan->source instanceof FileSource) {
+                    if ($plan->source instanceof GraphQLFileSource) {
                         yield sprintf('source: %s', var_export($plan->source->relativeFilePath, true));
 
                         return;

src/GraphQL/DocumentNodeWithSource.php

@@ -7,14 +7,15 @@
 use GraphQL\Language\AST\DocumentNode;
 use GraphQL\Language\AST\FragmentDefinitionNode;
 use GraphQL\Language\AST\NodeList;
-use Ruudk\GraphQLCodeGenerator\Planner\Source\FileSource;
+use Ruudk\GraphQLCodeGenerator\Planner\Source\GraphQLFileSource;
 use Ruudk\GraphQLCodeGenerator\Planner\Source\InlineSource;
+use Ruudk\GraphQLCodeGenerator\Planner\Source\TwigFileSource;
 
 final class DocumentNodeWithSource extends DocumentNode
 {
-    public FileSource | InlineSource $source;
+    public GraphQLFileSource | InlineSource | TwigFileSource $source;
 
-    public static function create(DocumentNode $documentNode, FileSource | InlineSource $source) : self
+    public static function create(DocumentNode $documentNode, GraphQLFileSource | InlineSource | TwigFileSource $source) : self
     {
         $definitions = [];
         foreach ($documentNode->definitions as $definition) {

src/GraphQL/FragmentDefinitionNodeWithSource.php

@@ -5,14 +5,15 @@
 namespace Ruudk\GraphQLCodeGenerator\GraphQL;
 
 use GraphQL\Language\AST\FragmentDefinitionNode;
-use Ruudk\GraphQLCodeGenerator\Planner\Source\FileSource;
+use Ruudk\GraphQLCodeGenerator\Planner\Source\GraphQLFileSource;
 use Ruudk\GraphQLCodeGenerator\Planner\Source\InlineSource;
+use Ruudk\GraphQLCodeGenerator\Planner\Source\TwigFileSource;
 
 final class FragmentDefinitionNodeWithSource extends FragmentDefinitionNode
 {
-    public FileSource | InlineSource $source;
+    public GraphQLFileSource | InlineSource | TwigFileSource $source;
 
-    public static function create(FragmentDefinitionNode $fragmentNode, FileSource | InlineSource $source) : self
+    public static function create(FragmentDefinitionNode $fragmentNode, GraphQLFileSource | InlineSource | TwigFileSource $source) : self
     {
         return new self([
             'name' => $fragmentNode->name,

src/PHP/Visitor/OperationFinder.php

@@ -42,6 +42,10 @@ public function enterNode(Node $node) : null
             return null;
         }
 
+        if ($this->className === null) {
+            return null;
+        }
+
         foreach ($node->params as $param) {
             if ( ! $param->var instanceof Node\Expr\Variable) {
                 continue;

src/Planner.php

@@ -76,8 +76,9 @@
 use Ruudk\GraphQLCodeGenerator\Planner\Plan\OperationClassPlan;
 use Ruudk\GraphQLCodeGenerator\Planner\PlannerResult;
 use Ruudk\GraphQLCodeGenerator\Planner\SelectionSetPlanner;
-use Ruudk\GraphQLCodeGenerator\Planner\Source\FileSource;
+use Ruudk\GraphQLCodeGenerator\Planner\Source\GraphQLFileSource;
 use Ruudk\GraphQLCodeGenerator\Planner\Source\InlineSource;
+use Ruudk\GraphQLCodeGenerator\Planner\Source\TwigFileSource;
 use Ruudk\GraphQLCodeGenerator\Twig\GraphQLExtension;
 use Ruudk\GraphQLCodeGenerator\Twig\GraphQLNodeFinder;
 use Ruudk\GraphQLCodeGenerator\Type\TypeHelper;
@@ -252,7 +253,7 @@ public function plan() : PlannerResult
 
             $operations[$file->getPathname()][] = DocumentNodeWithSource::create(
                 $document,
-                new FileSource(Path::makeRelative($file->getPathname(), $this->config->projectDir)),
+                new GraphQLFileSource(Path::makeRelative($file->getPathname(), $this->config->projectDir)),
             );
         }
 
@@ -344,7 +345,7 @@ public function plan() : PlannerResult
 
                     $operations[$file->getPathname()][] = DocumentNodeWithSource::create(
                         $document,
-                        new FileSource(Path::makeRelative($file->getPathname(), $this->config->projectDir)),
+                        new TwigFileSource(Path::makeRelative($file->getPathname(), $this->config->projectDir)),
                     );
                 }
             }
@@ -615,14 +616,20 @@ private function planOperation(DocumentNodeWithSource $document, string $path, P
 
         Assert::notNull($operation->name, 'Expected operation to have a name');
 
+        if ($document->source instanceof TwigFileSource) {
+            throw new Exception('Twig templates may only contain fragment definitions');
+        }
+
+        $source = $document->source;
+
         $operationName = $operation->name->value;
         $operationNamespaceName = $operationName;
 
-        if ($document->source instanceof InlineSource) {
+        if ($source instanceof InlineSource) {
             $operationNamespaceName = sprintf(
                 '%s%s',
                 $operationName,
-                $document->source->hash,
+                $source->hash,
             );
         }
 
@@ -650,7 +657,7 @@ private function planOperation(DocumentNodeWithSource $document, string $path, P
 
         // Plan the data class and its nested classes
         $planResult = $planner->plan(
-            $document->source,
+            $source,
             $operation->selectionSet,
             $rootType,
             $operationDir . '/Data',
@@ -660,7 +667,7 @@ private function planOperation(DocumentNodeWithSource $document, string $path, P
 
         // Create the data class plan
         $dataClassPlan = new DataClassPlan(
-            $document->source,
+            $source,
             $operationDir . '/Data.php',
             $fqcn,
             $rootType,
@@ -684,7 +691,7 @@ private function planOperation(DocumentNodeWithSource $document, string $path, P
             $operationType,
             $operationDefinition,
             $variables,
-            $document->source,
+            $source,
         );
 
         // Create the error class plan

src/Planner/Plan/DataClassPlan.php

@@ -9,8 +9,9 @@
 use GraphQL\Language\AST\OperationDefinitionNode;
 use GraphQL\Type\Definition\NamedType;
 use GraphQL\Type\Definition\Type;
-use Ruudk\GraphQLCodeGenerator\Planner\Source\FileSource;
+use Ruudk\GraphQLCodeGenerator\Planner\Source\GraphQLFileSource;
 use Ruudk\GraphQLCodeGenerator\Planner\Source\InlineSource;
+use Ruudk\GraphQLCodeGenerator\Planner\Source\TwigFileSource;
 use Symfony\Component\TypeInfo\Type as SymfonyType;
 
 final readonly class DataClassPlan
@@ -20,7 +21,7 @@
      * @param array<string, list<string>> $inlineFragmentRequiredFields
      */
     public function __construct(
-        public FileSource | InlineSource $source,
+        public GraphQLFileSource | InlineSource | TwigFileSource $source,
         public string $path,
         public string $fqcn,
         public NamedType & Type $parentType,

src/Planner/Plan/OperationClassPlan.php

@@ -4,7 +4,7 @@
 
 namespace Ruudk\GraphQLCodeGenerator\Planner\Plan;
 
-use Ruudk\GraphQLCodeGenerator\Planner\Source\FileSource;
+use Ruudk\GraphQLCodeGenerator\Planner\Source\GraphQLFileSource;
 use Ruudk\GraphQLCodeGenerator\Planner\Source\InlineSource;
 use Symfony\Component\TypeInfo\Type as SymfonyType;
 
@@ -21,6 +21,6 @@ public function __construct(
         public string $operationType,
         public string $operationDefinition,
         public array $variables,
-        public FileSource | InlineSource $source,
+        public GraphQLFileSource | InlineSource $source,
     ) {}
 }