Merge pull request #11 from zfegg/develop

Fix register filter in validator.
zfegg · Aug 4, 2021 · 5bb39bb · 5bb39bb
2 parents 2c9a7d6 + beba21b
commit 5bb39bb
Show file tree

Hide file tree

Showing 10 changed files with 141 additions and 30 deletions.
diff --git a/composer.json b/composer.json
@@ -1,6 +1,6 @@
 {
     "name": "zfegg/content-validation",
-    "description": "Content validation for PSR-15 middleware or laminas-mvc",
+    "description": "Content validation for PSR-15 middleware",
     "keywords": [
         "validation",
         "middleware",

diff --git a/src/Factory/ValidatorFactory.php b/src/Factory/ValidatorFactory.php
@@ -6,6 +6,8 @@
 
 use Opis\JsonSchema\Validator;
 use Psr\Container\ContainerInterface;
+use Zfegg\ContentValidation\Opis\Filter\DoctrineRecordExistsFilter;
+use Zfegg\ContentValidation\Opis\Filter\RecordExistsFilter;
 use Zfegg\ContentValidation\Opis\RemoveAdditionalPropertiesParser;
 use Zfegg\ContentValidation\Opis\TypeCastParser;
 
@@ -20,6 +22,18 @@ public function __invoke(ContainerInterface $container): Validator
             ->prependKeyword(new RemoveAdditionalPropertiesParser())
         ;
 
+        $types = ['string', 'integer', 'number'];
+        $parser->getFilterResolver()->registerMultipleTypes(
+            'db-exists',
+            new RecordExistsFilter($container),
+            $types
+        );
+        $parser->getFilterResolver()->registerMultipleTypes(
+            'orm-exists',
+            new DoctrineRecordExistsFilter($container),
+            $types
+        );
+
         return $validator;
     }
 }
diff --git a/src/Opis/Filter/DoctrineRecordExistsFilter.php b/src/Opis/Filter/DoctrineRecordExistsFilter.php
@@ -8,30 +8,38 @@
 use Opis\JsonSchema\Filter;
 use Opis\JsonSchema\Schema;
 use Opis\JsonSchema\ValidationContext;
+use Psr\Container\ContainerInterface;
 
 class DoctrineRecordExistsFilter implements Filter
 {
+    private ContainerInterface $container;
+    private string $defaultId;
 
-    private EntityManagerInterface $em;
-
-    public function __construct(EntityManagerInterface $em)
+    public function __construct(ContainerInterface $container, string $defaultId = EntityManagerInterface::class)
     {
-        $this->em = $em;
+        $this->container = $container;
+        $this->defaultId = $defaultId;
     }
 
     public function validate(ValidationContext $context, Schema $schema, array $args = []): bool
     {
-        $criteria = $args['criteria'] ?? [];
-        $exists = $args['exists'] ?? false;
-
-        if (isset($args['field'])) {
-            $rs = $this->em->getRepository($args['entity'])->findOneBy(
-                [$args['field'] => $context->currentData()] + $criteria
-            );
+        /** @var EntityManagerInterface $em */
+        $em = $this->container->get($args['db'] ?? $this->defaultId);
+
+        if (isset($args['dql'])) {
+            $dql = $args['dql'];
+        } elseif (isset($args['entity'])) {
+            $field = isset($args['field']) ? 'o.' . $args['field'] : 'o';
+            $dql = sprintf('SELECT COUNT(o) FROM %s o WHERE %s=?1', $args['entity'], $field);
         } else {
-            $rs = $this->em->find($args['entity'], $context->currentData());
+            throw new \InvalidArgumentException('Invalid args.');
         }
 
-        return ((bool) $rs) == $exists;
+        $exists = $args['exists'] ?? false;
+        $query = $em->createQuery($dql);
+        $query->setParameter(1, $context->currentData());
+        $row = $query->getSingleScalarResult();
+
+        return $row == $exists;
     }
 }
diff --git a/src/Opis/Filter/RecordExistsFilter.php b/src/Opis/Filter/RecordExistsFilter.php
@@ -8,19 +8,24 @@
 use Opis\JsonSchema\Schema;
 use Opis\JsonSchema\ValidationContext;
 use PDO;
+use Psr\Container\ContainerInterface;
 
 class RecordExistsFilter implements Filter
 {
 
-    private PDO $db;
+    private ContainerInterface $container;
+    private string $defaultId;
 
-    public function __construct(PDO $db)
+    public function __construct(ContainerInterface $container, string $defaultId = 'db')
     {
-        $this->db = $db;
+        $this->container = $container;
+        $this->defaultId = $defaultId;
     }
 
     public function validate(ValidationContext $context, Schema $schema, array $args = []): bool
     {
+        $db = $this->container->get($args['db'] ?? $this->defaultId);
+
         if (isset($args['sql'])) {
             $sql = $args['sql'];
         } elseif (isset($args['table']) && isset($args['field'])) {
@@ -30,7 +35,7 @@ public function validate(ValidationContext $context, Schema $schema, array $args
         }
 
         $exists = $args['exists'] ?? false;
-        $sth = $this->db->prepare($sql);
+        $sth = $db->prepare($sql);
         $sth->execute([$context->currentData()]);
         $row = $sth->fetch(PDO::FETCH_NUM);
 

diff --git a/test/Opis/Filter/DoctrineRecordExistsFilterTest.php b/test/Opis/Filter/DoctrineRecordExistsFilterTest.php
@@ -5,16 +5,23 @@
 namespace ZfeggTest\ContentValidation\Opis\Filter;
 
 use Doctrine\ORM\EntityManager;
+use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Tools\Setup;
 use Opis\JsonSchema\Schema;
 use Opis\JsonSchema\SchemaLoader;
 use Opis\JsonSchema\ValidationContext;
+use Opis\JsonSchema\Validator;
 use PHPUnit\Framework\TestCase;
 use Zfegg\ContentValidation\Opis\Filter\DoctrineRecordExistsFilter;
 use ZfeggTest\ContentValidation\Entity\Foo;
+use ZfeggTest\ContentValidation\SetupTrait;
 
 class DoctrineRecordExistsFilterTest extends TestCase
 {
+    use SetupTrait {
+        setUp as setUpContainer;
+    }
+
     const SQL = <<<SQL
 create table foo
 (
@@ -27,31 +34,45 @@ class DoctrineRecordExistsFilterTest extends TestCase
 
     protected function setUp(): void
     {
+        $this->setUpContainer();
         $isDevMode = true;
         $config = Setup::createAnnotationMetadataConfiguration([__DIR__ . "/../../Entity"], $isDevMode);
         $em = EntityManager::create(['url' => 'sqlite:///:memory:',], $config);
         $em->getConnection()->prepare(self::SQL)->executeStatement();
-
-        $this->em = $em;
+        $em->getConnection()->prepare('INSERT INTO foo VALUES(NULL, "exists","123")')->executeStatement();
+        $this->container->setService(EntityManagerInterface::class, $em);
     }
 
     public function testValidate(): void
     {
-        $filter = new DoctrineRecordExistsFilter($this->em);
+        $filter = new DoctrineRecordExistsFilter($this->container);
+        $entity = Foo::class;
 
         $context = new ValidationContext('test', new SchemaLoader());
         $schema = $this->createMock(Schema::class);
-        $rs = $filter->validate($context, $schema, ['entity' => Foo::class]);
+        $rs = $filter->validate($context, $schema, ['entity' => $entity]);
         $this->assertTrue($rs);
 
-        $rs = $filter->validate($context, $schema, ['entity' => Foo::class, 'exists' => true]);
+        $rs = $filter->validate($context, $schema, ['entity' => $entity, 'exists' => true]);
         $this->assertFalse($rs);
 
         $rs = $filter->validate(
             $context,
             $schema,
-            ['entity' => Foo::class, 'field' => 'key', 'criteria' => ['value' => 123]]
+            ['dql' => "SELECT COUNT(o) FROM {$entity} o WHERE o.key=?1"]
         );
         $this->assertTrue($rs);
     }
+
+    public function testInValidator(): void
+    {
+        $validator = $this->container->get(Validator::class);
+        $data = <<<'JSON'
+{"key": "exists"}
+JSON;
+        $data = json_decode($data);
+        $result = $validator->validate($data, 'test:test/test-doctrine-filter.json');
+
+        $this->assertTrue($result->isValid());
+    }
 }
diff --git a/test/Opis/Filter/RecordExistsFilterTest.php b/test/Opis/Filter/RecordExistsFilterTest.php
@@ -7,11 +7,17 @@
 use Opis\JsonSchema\Schema;
 use Opis\JsonSchema\SchemaLoader;
 use Opis\JsonSchema\ValidationContext;
+use Opis\JsonSchema\Validator;
 use Zfegg\ContentValidation\Opis\Filter\RecordExistsFilter;
 use PHPUnit\Framework\TestCase;
+use ZfeggTest\ContentValidation\SetupTrait;
 
 class RecordExistsFilterTest extends TestCase
 {
+    use SetupTrait {
+        setUp as setUpContainer;
+    }
+
     const SQL = <<<SQL
 create table foo
 (
@@ -24,14 +30,16 @@ class RecordExistsFilterTest extends TestCase
 
     protected function setUp(): void
     {
+        $this->setUpContainer();
         $db = new \PDO('sqlite::memory:');
         $db->query(self::SQL);
-        $this->db = $db;
+        $db->query('INSERT INTO foo VALUES(NULL, "exists","123")');
+        $this->container->setService('db', $db);
     }
 
     public function testValidate(): void
     {
-        $filter = new RecordExistsFilter($this->db);
+        $filter = new RecordExistsFilter($this->container);
 
         $context = new ValidationContext('test', new SchemaLoader());
         $schema = $this->createMock(Schema::class);
@@ -44,4 +52,17 @@ public function testValidate(): void
         $rs = $filter->validate($context, $schema, ['table' => 'foo', 'field' => 'key']);
         $this->assertTrue($rs);
     }
+
+
+    public function testInValidator(): void
+    {
+        $validator = $this->container->get(Validator::class);
+        $data = <<<'JSON'
+{"key": "exists"}
+JSON;
+        $data = json_decode($data);
+        $result = $validator->validate($data, 'test:test/test-db-filter.json');
+
+        $this->assertTrue($result->isValid());
+    }
 }
diff --git a/test/SetupTrait.php b/test/SetupTrait.php
@@ -6,14 +6,13 @@
 
 use Laminas\ServiceManager\ServiceManager;
 use Opis\JsonSchema\Validator;
-use Psr\Container\ContainerInterface;
 use Zfegg\ContentValidation\ConfigProvider;
 use Zfegg\ContentValidation\ContentValidationMiddleware;
 
 trait SetupTrait
 {
 
-    private ContainerInterface $container;
+    private ServiceManager $container;
 
     public function setUp(): void
     {

diff --git a/test/test-db-filter.json b/test/test-db-filter.json
@@ -0,0 +1,22 @@
+{
+  "type": "object",
+  "properties": {
+    "key": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 64,
+      "$filters": [
+        {
+          "$func": "db-exists",
+          "$vars": {
+            "table": "foo",
+            "field": "key",
+            "exists": true
+          }
+        }
+      ]
+    }
+  },
+  "required": ["key"],
+  "additionalProperties": false
+}
diff --git a/test/test-doctrine-filter.json b/test/test-doctrine-filter.json
@@ -0,0 +1,22 @@
+{
+  "type": "object",
+  "properties": {
+    "key": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 64,
+      "$filters": [
+        {
+          "$func": "orm-exists",
+          "$vars": {
+            "entity": "ZfeggTest\\ContentValidation\\Entity\\Foo",
+            "field": "key",
+            "exists": true
+          }
+        }
+      ]
+    }
+  },
+  "required": ["key"],
+  "additionalProperties": false
+}
diff --git a/test/test.json b/test/test.json
@@ -5,8 +5,7 @@
     "name": {
       "type": "string",
       "minLength": 1,
-      "maxLength": 64,
-      "pattern": "^[a-zA-Z0-9\\-]+(\\s[a-zA-Z0-9\\-]+)*$"
+      "maxLength": 64
     },
     "age": {
       "type": "integer",