From f31256009c837df23bd55e2d1fb3b8895db8af26 Mon Sep 17 00:00:00 2001
From: Owen Voke <owen.voke@worksome.com>
Date: Fri, 10 Feb 2023 14:07:11 +0000
Subject: [PATCH] feat: add rule for upper-snake case enum cases

---
 config/Sets/standard.php                      |  2 +
 src/Fixes/UpperSnakeCaseNameFixer.php         | 41 +++++++++++++
 ...rSnakeCaseEnumCaseDefinitionInspection.php | 57 +++++++++++++++++++
 .../lower_snake_case_enum_case.graphql.inc    |  7 +++
 .../pascal_case_enum_case.graphql.inc         |  7 +++
 ...pper_snake_case_enum_case.skip.graphql.inc |  4 ++
 ...keCaseEnumCaseDefinitionInspectionTest.php | 19 +++++++
 7 files changed, 137 insertions(+)
 create mode 100644 src/Fixes/UpperSnakeCaseNameFixer.php
 create mode 100644 src/Inspections/UpperSnakeCaseEnumCaseDefinitionInspection.php
 create mode 100644 test-resources/Inspections/UpperSnakeCaseEnumCaseDefinitionInspectionTest/lower_snake_case_enum_case.graphql.inc
 create mode 100644 test-resources/Inspections/UpperSnakeCaseEnumCaseDefinitionInspectionTest/pascal_case_enum_case.graphql.inc
 create mode 100644 test-resources/Inspections/UpperSnakeCaseEnumCaseDefinitionInspectionTest/upper_snake_case_enum_case.skip.graphql.inc
 create mode 100644 tests/Feature/Inspections/UpperSnakeCaseEnumCaseDefinitionInspectionTest.php

diff --git a/config/Sets/standard.php b/config/Sets/standard.php
index 786d095..db52f6e 100644
--- a/config/Sets/standard.php
+++ b/config/Sets/standard.php
@@ -12,6 +12,7 @@
 use Worksome\Graphlint\Inspections\NonNullableInsideListInspection;
 use Worksome\Graphlint\Inspections\NonNullableListInspection;
 use Worksome\Graphlint\Inspections\PascalCaseObjectTypeDefinitionInspection;
+use Worksome\Graphlint\Inspections\UpperSnakeCaseEnumCaseDefinitionInspection;
 
 return function (ContainerConfigurator $config): void {
     $services = $config->services();
@@ -25,6 +26,7 @@
         NonNullableListInspection::class,
         PascalCaseObjectTypeDefinitionInspection::class,
         DescriptionRequiredInspection::class,
+        UpperSnakeCaseEnumCaseDefinitionInspection::class,
     ];
 
     foreach ($inspections as $inspection) {
diff --git a/src/Fixes/UpperSnakeCaseNameFixer.php b/src/Fixes/UpperSnakeCaseNameFixer.php
new file mode 100644
index 0000000..9636cac
--- /dev/null
+++ b/src/Fixes/UpperSnakeCaseNameFixer.php
@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Worksome\Graphlint\Fixes;
+
+use GraphQL\Language\AST\NameNode;
+use Illuminate\Support\Str;
+use Worksome\Graphlint\ProblemDescriptor;
+use Worksome\Graphlint\Utils\NodeNameResolver;
+
+class UpperSnakeCaseNameFixer extends Fixer
+{
+    public function __construct(
+        private readonly NodeNameResolver $nodeNameResolver,
+    ) {
+    }
+
+    public function fix(ProblemDescriptor $problemDescriptor): void
+    {
+        $node = $problemDescriptor->getNode();
+
+        if (! $node instanceof NameNode) {
+            return;
+        }
+
+        $name = $this->nodeNameResolver->getName($node);
+
+        if ($name === null) {
+            return;
+        }
+
+        $upperCase = Str::of($name)
+            ->replace('_', ' ')
+            ->title()
+            ->snake()
+            ->upper();
+
+        $node->value = $upperCase->__toString();
+    }
+}
diff --git a/src/Inspections/UpperSnakeCaseEnumCaseDefinitionInspection.php b/src/Inspections/UpperSnakeCaseEnumCaseDefinitionInspection.php
new file mode 100644
index 0000000..b55dc71
--- /dev/null
+++ b/src/Inspections/UpperSnakeCaseEnumCaseDefinitionInspection.php
@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Worksome\Graphlint\Inspections;
+
+use GraphQL\Language\AST\EnumValueDefinitionNode;
+use Illuminate\Support\Str;
+use Worksome\Graphlint\Fixes\UpperSnakeCaseNameFixer;
+use Worksome\Graphlint\InspectionDescription;
+use Worksome\Graphlint\ProblemsHolder;
+use Worksome\Graphlint\Utils\ApolloFederationChecker;
+use Worksome\Graphlint\Utils\NodeNameResolver;
+
+class UpperSnakeCaseEnumCaseDefinitionInspection extends Inspection
+{
+    public function __construct(
+        private readonly NodeNameResolver $nameResolver,
+        private readonly UpperSnakeCaseNameFixer $upperCaseNameFixer,
+        private readonly ApolloFederationChecker $apolloFederationChecker,
+    ) {
+    }
+
+    public function visitEnumValueDefinition(
+        ProblemsHolder $problemsHolder,
+        EnumValueDefinitionNode $enumValueDefinitionNode,
+    ): void {
+        $name = $this->nameResolver->getName($enumValueDefinitionNode);
+
+        if ($name === null) {
+            return;
+        }
+
+        if ($this->apolloFederationChecker->isApolloDefinitionName($enumValueDefinitionNode->name)) {
+            return;
+        }
+
+        $upperCase = Str::of($name)->replace('_', ' ')->title()->snake()->upper()->__toString();
+
+        if ($name === $upperCase) {
+            return;
+        }
+
+        $problemsHolder->registerProblemWithDescription(
+            $enumValueDefinitionNode->name,
+            $this->definition()->getTitle(),
+            $this->upperCaseNameFixer,
+        );
+    }
+
+    public function definition(): InspectionDescription
+    {
+        return new InspectionDescription(
+            "Enum cases must be UPPER_CASE.",
+        );
+    }
+}
diff --git a/test-resources/Inspections/UpperSnakeCaseEnumCaseDefinitionInspectionTest/lower_snake_case_enum_case.graphql.inc b/test-resources/Inspections/UpperSnakeCaseEnumCaseDefinitionInspectionTest/lower_snake_case_enum_case.graphql.inc
new file mode 100644
index 0000000..f08b412
--- /dev/null
+++ b/test-resources/Inspections/UpperSnakeCaseEnumCaseDefinitionInspectionTest/lower_snake_case_enum_case.graphql.inc
@@ -0,0 +1,7 @@
+enum Status {
+  in_progress
+}
+-----
+enum Status {
+  IN_PROGRESS
+}
diff --git a/test-resources/Inspections/UpperSnakeCaseEnumCaseDefinitionInspectionTest/pascal_case_enum_case.graphql.inc b/test-resources/Inspections/UpperSnakeCaseEnumCaseDefinitionInspectionTest/pascal_case_enum_case.graphql.inc
new file mode 100644
index 0000000..98f8d39
--- /dev/null
+++ b/test-resources/Inspections/UpperSnakeCaseEnumCaseDefinitionInspectionTest/pascal_case_enum_case.graphql.inc
@@ -0,0 +1,7 @@
+enum Status {
+  Active
+}
+-----
+enum Status {
+  ACTIVE
+}
diff --git a/test-resources/Inspections/UpperSnakeCaseEnumCaseDefinitionInspectionTest/upper_snake_case_enum_case.skip.graphql.inc b/test-resources/Inspections/UpperSnakeCaseEnumCaseDefinitionInspectionTest/upper_snake_case_enum_case.skip.graphql.inc
new file mode 100644
index 0000000..404e503
--- /dev/null
+++ b/test-resources/Inspections/UpperSnakeCaseEnumCaseDefinitionInspectionTest/upper_snake_case_enum_case.skip.graphql.inc
@@ -0,0 +1,4 @@
+enum Status {
+  ACTIVE
+  IN_PROGRESS
+}
diff --git a/tests/Feature/Inspections/UpperSnakeCaseEnumCaseDefinitionInspectionTest.php b/tests/Feature/Inspections/UpperSnakeCaseEnumCaseDefinitionInspectionTest.php
new file mode 100644
index 0000000..79d338e
--- /dev/null
+++ b/tests/Feature/Inspections/UpperSnakeCaseEnumCaseDefinitionInspectionTest.php
@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Worksome\Graphlint\Tests\Feature\Inspections;
+
+use Symplify\SmartFileSystem\SmartFileInfo;
+use Worksome\Graphlint\Inspections\UpperSnakeCaseEnumCaseDefinitionInspection;
+use function Worksome\Graphlint\Tests\app;
+use function Worksome\Graphlint\Tests\yieldFixtures;
+
+it('can rename type', function (SmartFileInfo $smartFileInfo) {
+    $inspection = app()->get(UpperSnakeCaseEnumCaseDefinitionInspection::class);
+
+    expect($smartFileInfo)
+        ->toPassInspection($inspection);
+})->with(yieldFixtures(
+    __DIR__ . '/../../../test-resources/Inspections/UpperSnakeCaseEnumCaseDefinitionInspectionTest'
+));