fix entity_id, add graphql

mygento · Sep 19, 2024 · be0ecb5 · be0ecb5
1 parent 5fec224
commit be0ecb5
Show file tree

Hide file tree

Showing 62 changed files with 362 additions and 141 deletions.
diff --git a/.jeeves.phpunit_v1.yaml b/.jeeves.phpunit_v1.yaml
@@ -140,9 +140,10 @@ Mygento:
         api: true
         cacheable: true
         readonly: true
+        graphql: true
         cache_tag: samp_poster
         columns:
-          id:
+          entity_id:
             type: int
             pk: true
             unsigned: true

diff --git a/README.md b/README.md
@@ -46,6 +46,7 @@ look in ```.jeeves.phpunit_v1.yaml``` or ```.jeeves.phpunit_v0.yaml```
 | tablename | String | N | %vendor%_%module%_%entity%
 | comment | String | N
 | api | Boolean | N | false
+| graphql | Boolean | N | false
 | cacheable | Boolean | N | false
 | cache_tag | String | N
 | per_store | Boolean | N | false

diff --git a/src/Jeeves/Generators/Crud/Interfaces/Model.php b/src/Jeeves/Generators/Crud/Interfaces/Model.php
@@ -82,7 +82,7 @@ public function genModelInterface(
                 $set->addComment('@return $this');
             }
 
-            if ($this->snakeCaseToCamelCase($name) == 'id') {
+            if (in_array($this->snakeCaseToCamelCase($name), ['id', 'entityId'])) {
                 $param->setNullable(false);
                 $param->setType(null);
 

diff --git a/src/Jeeves/Generators/Crud/Models/Model.php b/src/Jeeves/Generators/Crud/Models/Model.php
@@ -80,8 +80,12 @@ public function genModel(
             $getter->setReturnNullable($generated ? true : !$notNullable);
 
             $setter->setReturnType('self');
-            $setParam->setType($this->convertType($value['type']));
-            $setParam->setNullable(!$notNullable);
+            if ($name === 'entity_id') {
+                $setter->addComment('@param ' . $this->convertType($value['type']) . ' $' . $this->snakeCaseToCamelCase($name));
+            } else {
+                $setParam->setType($this->convertType($value['type']));
+                $setParam->setNullable(!$notNullable);
+            }
 
             if ($this->snakeCaseToCamelCase($name) == 'id') {
                 $setParam->setNullable(false);

diff --git a/src/Jeeves/Generators/Shipping/System.php b/src/Jeeves/Generators/Shipping/System.php
@@ -49,7 +49,7 @@ public function getTitle(): array
                 'sortOrder' => '20',
             ]),
             self::V => [
-                'label' => 'Method Title',
+                'label' => 'Carrier Title',
                 'validate' => 'required-entry',
             ],
         ];

diff --git a/src/Jeeves/Model/Crud.php b/src/Jeeves/Model/Crud.php
@@ -200,6 +200,10 @@ private function generate(Crud\Entity $entity): Crud\Result
             $this->generateAdminUI($entity);
         }
 
+        if ($entity->hasGraphQL()) {
+            $this->generateGraphQL($entity);
+        }
+
         $acl = [new Acl($entity->getEntityAcl(), $entity->getEntityAclTitle())];
         $dbschema = $this->generateDbSchema($entity);
         $events = $this->generateEvents($entity);
@@ -240,6 +244,12 @@ private function generateModels(Crud\Entity $entity)
         $generator->generateModels($entity);
     }
 
+    private function generateGraphQL(Crud\Entity $entity)
+    {
+        $generator = new Crud\GraphQL($this->io);
+        $generator->generateSchema($entity);
+    }
+
     private function generateRepository(Crud\Entity $entity)
     {
         $generator = new Crud\Repository($this->io);

diff --git a/src/Jeeves/Model/Crud/Controllers.php b/src/Jeeves/Model/Crud/Controllers.php
@@ -2,7 +2,7 @@
 
 namespace Mygento\Jeeves\Model\Crud;
 
-use Mygento\Jeeves\Generators\Crud\Controllers  as Generators;
+use Mygento\Jeeves\Generators\Crud\Controllers as Generators;
 use Mygento\Jeeves\IO\IOInterface;
 use Mygento\Jeeves\Model\Generator;
 

diff --git a/src/Jeeves/Model/Crud/Entity.php b/src/Jeeves/Model/Crud/Entity.php
@@ -16,6 +16,7 @@ class Entity extends Generator
     private Module $module;
     private $api;
     private $gui;
+    private bool $graphql = false;
     private bool $readonly = false;
     private bool $withStore = false;
     private $tablename;
@@ -105,6 +106,7 @@ public function setConfig(array $config)
         $this->readonly = $config['readonly'] ?? false;
         $this->withStore = $config['per_store'] ?? false;
         $this->comment = $config['comment'] ?? null;
+        $this->graphql = $config['graphql'] ?? false;
 
         $this->tablename = $config['tablename'] ??
             $this->getConverter()->camelCaseToSnakeCase($this->module->getVendor())
@@ -171,6 +173,11 @@ public function hasApi(): bool
         return $this->api;
     }
 
+    public function hasGraphQL(): bool
+    {
+        return $this->graphql;
+    }
+
     public function getEntityAcl()
     {
         return $this->getFullname() . '::' . $this->getEntityLowercase();

diff --git a/src/Jeeves/Model/Crud/GraphQL.php b/src/Jeeves/Model/Crud/GraphQL.php
@@ -0,0 +1,86 @@
+<?php
+
+namespace Mygento\Jeeves\Model\Crud;
+
+use Mygento\Jeeves\IO\IOInterface;
+use Mygento\Jeeves\Model\Generator;
+
+class GraphQL extends Generator
+{
+    public function __construct(IOInterface $io)
+    {
+        $this->setIO($io);
+    }
+
+    public function generateSchema(Entity $entity)
+    {
+        $filePath = $entity->getPath() . '/etc/';
+        $columns = $this->getFields($entity);
+        $this->writeFile(
+            $filePath . 'schema.graphqls',
+            implode(PHP_EOL, [
+                'type ' . $entity->getEntityApiName() . ' @doc(description: "' . ($entity->getComment() ?: $entity->getPrintName()) . '") {',
+                implode(
+                    PHP_EOL,
+                    $columns
+                ),
+                '}',
+            ])
+        );
+    }
+
+    private function getFields(Entity $entity)
+    {
+        $result = array_map(
+            function (string $column, array $param) {
+                if (isset($param['pk']) && $param['pk'] === true) {
+                    return null;
+                }
+
+                $nullable = $param['nullable'] ?? true;
+
+                switch ($param['type']) {
+                    case 'boolean':
+                        $nullable = false;
+                        $type = 'Boolean';
+                        break;
+                    case 'blob':
+                    case 'varbinary':
+                        return null;
+                    case 'int':
+                    case 'smallint':
+                    case 'bigint':
+                    case 'tinyint':
+                        $type = 'Int';
+                        break;
+                    case 'price':
+                        $type = 'Money';
+                        break;
+                    case 'real':
+                    case 'decimal':
+                    case 'float':
+                    case 'double':
+                        $type = 'Float';
+                        break;
+                    case 'text':
+                    case 'mediumtext':
+                    case 'longtext':
+                    case 'date':
+                    case 'datetime':
+                    case 'timestamp':
+                    case 'varchar':
+                        $type = 'String';
+                        break;
+                    default:
+                        throw new \Exception('Error column type');
+                }
+
+                return self::TAB . $column . ': ' . $type . (!$nullable ? '!' : '') . ' @doc(description: "' . ($param['comment'] ?? ucfirst($column)) . '")';
+            },
+            array_keys($entity->getColumns()),
+            $entity->getColumns()
+        );
+
+        return array_filter($result);
+    }
+}
diff --git a/src/Jeeves/Model/Shipping.php b/src/Jeeves/Model/Shipping.php
@@ -92,14 +92,14 @@ private function generate(string $carrier, Module $mod): Shipping\Result
         $result->updateCarrierConfigs([
             $carrier => [
                 'active' => 0,
-                'title' => $carrier,
+                'code' => $carrier,
             ],
         ]);
         $result->updateDefaultConfigs([
             $carrier => [
                 'active' => 0,
                 'name' => $carrier,
-                'title' => $carrier,
+                'title' => $this->getConverter()->getEntityPrintName($carrier),
                 'debug' => '0',
                 'test' => '1',
                 'model' => $this->mod->getNamespace() . '\Model\Carrier',

diff --git a/src/Jeeves/Model/Shipping/Configs.php b/src/Jeeves/Model/Shipping/Configs.php
@@ -94,15 +94,15 @@ private function generateAdminConfig(array $entity, string $namespace): array
         $generator = new System();
 
         return [
-            'label' => $this->getConverter()->getEntityPrintName($entity['title']),
+            'label' => $this->getConverter()->getEntityPrintName($entity['code']),
             $generator->getEnabled(),
             $generator->getTitle(),
             $generator->getSort(),
             $generator->getTest(),
             $generator->getDebug(),
             $generator->getAuthGroup(),
             $generator->getOptionsGroup(),
-            $generator->getPackageGroup($entity['title']),
+            $generator->getPackageGroup($entity['code']),
             $generator->getTaxGroup($namespace),
             $generator->getOrderStatusGroup(),
             $generator->getMarkingGroup(),

diff --git a/test/Crud/CrudV1Test.php b/test/Crud/CrudV1Test.php
@@ -57,6 +57,7 @@ public function testCrudV1(string $path)
         $this->checkXml('etc/events.xml');
         $this->checkXml('etc/module.xml');
         $this->checkFile('registration.php');
+        $this->checkFile('etc/schema.graphqls');
     }
 
     private function checkInterfaces()

diff --git a/test/Expectations/Crud/81/v1/Api/Data/PosterInterface.php b/test/Expectations/Crud/81/v1/Api/Data/PosterInterface.php
@@ -10,25 +10,25 @@
 interface PosterInterface extends IdentityInterface
 {
     public const CACHE_TAG = 'samp_poster';
-    public const ID = 'id';
+    public const ENTITY_ID = 'entity_id';
     public const NAME = 'name';
     public const SUBNAME = 'subname';
     public const FAMILY = 'family';
     public const ACTIVE = 'active';
     public const PRODUCT_ID = 'product_id';
 
     /**
-     * Get id
+     * Get entity id
      * @return int|null
      */
-    public function getId(): ?int;
+    public function getEntityId(): ?int;
 
     /**
-     * Set id
-     * @param int $id
+     * Set entity id
+     * @param int $entityId
      * @return $this
      */
-    public function setId($id): self;
+    public function setEntityId($entityId): self;
 
     /**
      * Get name
@@ -89,4 +89,17 @@ public function getProductId(): ?int;
      * @return $this
      */
     public function setProductId(?int $productId): self;
+
+    /**
+     * Get ID
+     * @return int|null
+     */
+    public function getId(): ?int;
+
+    /**
+     * Set ID
+     * @param int $id
+     * @return $this
+     */
+    public function setId($id): self;
 }
diff --git a/test/Expectations/Crud/81/v1/Model/Card/DataProvider.php b/test/Expectations/Crud/81/v1/Model/Card/DataProvider.php
@@ -24,7 +24,7 @@ public function __construct(
         string $requestFieldName,
         array $meta = [],
         array $data = [],
-        PoolInterface $pool = null,
+        ?PoolInterface $pool = null,
     ) {
         parent::__construct($name, $primaryFieldName, $requestFieldName, $meta, $data, $pool);
 

diff --git a/test/Expectations/Crud/81/v1/Model/CartItem/DataProvider.php b/test/Expectations/Crud/81/v1/Model/CartItem/DataProvider.php
@@ -24,7 +24,7 @@ public function __construct(
         string $requestFieldName,
         array $meta = [],
         array $data = [],
-        PoolInterface $pool = null,
+        ?PoolInterface $pool = null,
     ) {
         parent::__construct($name, $primaryFieldName, $requestFieldName, $meta, $data, $pool);
 

diff --git a/test/Expectations/Crud/81/v1/Model/Columns/DataProvider.php b/test/Expectations/Crud/81/v1/Model/Columns/DataProvider.php
@@ -24,7 +24,7 @@ public function __construct(
         string $requestFieldName,
         array $meta = [],
         array $data = [],
-        PoolInterface $pool = null,
+        ?PoolInterface $pool = null,
     ) {
         parent::__construct($name, $primaryFieldName, $requestFieldName, $meta, $data, $pool);
 

diff --git a/test/Expectations/Crud/81/v1/Model/Poster.php b/test/Expectations/Crud/81/v1/Model/Poster.php
@@ -16,20 +16,20 @@ public function getIdentities(): array
     }
 
     /**
-     * Get id
+     * Get entity id
      */
-    public function getId(): ?int
+    public function getEntityId(): ?int
     {
-        return $this->getData(self::ID);
+        return $this->getData(self::ENTITY_ID);
     }
 
     /**
-     * Set id
-     * @param int $id
+     * Set entity id
+     * @param int $entityId
      */
-    public function setId($id): self
+    public function setEntityId($entityId): self
     {
-        return $this->setData(self::ID, $id);
+        return $this->setData(self::ENTITY_ID, $entityId);
     }
 
     /**
@@ -112,6 +112,23 @@ public function setProductId(?int $productId): self
         return $this->setData(self::PRODUCT_ID, $productId);
     }
 
+    /**
+     * Get ID
+     */
+    public function getId(): ?int
+    {
+        return $this->getData(self::ENTITY_ID);
+    }
+
+    /**
+     * Set ID
+     * @param int $id
+     */
+    public function setId($id): self
+    {
+        return $this->setData(self::ENTITY_ID, $id);
+    }
+
     /**
      * @return void
      */

diff --git a/test/Expectations/Crud/81/v1/Model/Poster/DataProvider.php b/test/Expectations/Crud/81/v1/Model/Poster/DataProvider.php
@@ -24,7 +24,7 @@ public function __construct(
         string $requestFieldName,
         array $meta = [],
         array $data = [],
-        PoolInterface $pool = null,
+        ?PoolInterface $pool = null,
     ) {
         parent::__construct($name, $primaryFieldName, $requestFieldName, $meta, $data, $pool);
 

diff --git a/test/Expectations/Crud/81/v1/Model/ResourceModel/Card.php b/test/Expectations/Crud/81/v1/Model/ResourceModel/Card.php
@@ -18,7 +18,7 @@ public function __construct(
         private readonly EntityManager $entityManager,
         private readonly MetadataPool $metadataPool,
         Context $context,
-        string $connectionName = null,
+        ?string $connectionName = null,
     ) {
         parent::__construct($context, $connectionName);
     }