Improved validation for collection key options (#15)

* improve Collection 'keyOptions' attribute validation

* refactor 'KeyType' class

* fix exception attribute type

* drop support for PHP 8.2

Author: lucassouzavieira

.github/workflows/php.yml

@@ -24,7 +24,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-versions: ["8.2", "8.3", "8.4"]
+        php-versions: ["8.3", "8.4"]
 
     steps:
       - name: Setup PHP

composer.json

@@ -19,7 +19,7 @@
     }
   ],
   "require": {
-    "php": ">=8.2",
+    "php": ">=8.3",
     "ext-json": "*",
     "guzzlehttp/guzzle": "^7.10",
     "symfony/service-contracts": "^3.6",

composer.lock

@@ -136,8 +136,7 @@ class Collection implements JsonSerializable
         'type' => 2,
         'keyOptions' => [
             'allowUserKeys' => true,
-            'type' => 'traditional',
-            'lastValue' => 0
+            'type' => KeyType::TRADITIONAL,
         ],
     ];
 
@@ -214,7 +213,7 @@ public function __set(string $name, $value)
      * @return CursorInterface|bool Cursor if collection exists on database. False otherwise.
      * @throws GuzzleException|InvalidParameterException|CursorException
      */
-    public function all()
+    public function all(): bool|CollectionCursor
     {
         if (!$this->isNew()) {
             return new CollectionCursor($this);
@@ -272,7 +271,7 @@ public function getName(): string
      *
      * @return string|null String if collection exists on database. Null if not.
      */
-    public function getId()
+    public function getId(): ?string
     {
         return ($this->attributes['objectId'] === null) ? $this->attributes['id'] : $this->attributes['objectId'];
     }

src/Collection/Collection.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace ArangoDB\Collection;
+
+/**
+ * Groups the available key generations for new collections
+ *
+ * @package ArangoDB\Collection
+ * @author Lucas S. Vieira
+ */
+class KeyType
+{
+    public const string TRADITIONAL = 'traditional';
+    public const string AUTOINCREMENT = 'autoincrement';
+    public const string PADDED = 'padded';
+    public const string UUID = 'uuid';
+}

src/Collection/KeyType.php

@@ -25,7 +25,7 @@ class CollectionCursor extends Cursor
      *
      * @var Collection
      */
-    protected $collection;
+    protected Collection $collection;
 
     /**
      * CollectionCursor constructor.

src/Cursor/CollectionCursor.php

@@ -71,7 +71,7 @@ public function last()
     /**
      * Get a value by its key
      *
-     * @param int|string $key Key to verify on list.
+     * @param int|string $key KeyType to verify on list.
      * @return mixed
      */
     public function get($key)
@@ -96,7 +96,7 @@ public function push($value): void
     /**
      * Put a object into list on given key
      *
-     * @param string|integer $key Key for manage the value.
+     * @param string|integer $key KeyType for manage the value.
      * @param mixed $value Value to add.
      */
     public function put($key, $value): void

src/DataStructures/ArrayList.php

@@ -44,7 +44,7 @@ public function push($value): void;
     /**
      * Put a object into list on given key
      *
-     * @param string|integer $key Key for manage the value.
+     * @param string|integer $key KeyType for manage the value.
      * @param mixed $value Value to add.
      */
     public function put($key, $value): void;

src/DataStructures/Contracts/ListInterface.php

@@ -59,7 +59,7 @@ public function rules(): array
      *
      * @return \Closure
      */
-    private function validateParamsCallback()
+    private function validateParamsCallback(): \Closure
     {
         return function (array $params) {
             $validator = Rules::isPrimitive();

src/Validation/Admin/Task/TaskValidator.php

@@ -4,8 +4,10 @@
 
 namespace ArangoDB\Validation\Collection;
 
+use ArangoDB\Collection\KeyType;
 use ArangoDB\Validation\Validator;
 use ArangoDB\Validation\Rules\Rules;
+use ArangoDB\Validation\Exceptions\InvalidKeyOptionException;
 
 /**
  * Validate the collection options values. <br>
@@ -48,7 +50,33 @@ public function rules(): array
             'numberOfShards' => Rules::equalsOrGreaterThan(1),
             'isSystem' => Rules::boolean(),
             'type' => Rules::in([2, 3]),
-            'keyOptions' => Rules::arr(),
+            'keyOptions' => Rules::callbackValidation(self::validateKeyOptions()),
         ];
     }
+
+    /**
+     * Validate key options for collection creation
+     *
+     * @return \Closure
+     */
+    private static function validateKeyOptions(): \Closure
+    {
+        /**
+         * 'offset' and 'increment' options are only allowed when used with type 'autoincrement'
+         *
+         * @return bool
+         * @throws InvalidKeyOptionException
+         */
+        return function (array $keyOptions) {
+            if (array_key_exists('offset', $keyOptions) && $keyOptions['type'] != KeyType::AUTOINCREMENT) {
+                throw new InvalidKeyOptionException("offset", $keyOptions['type']);
+            }
+
+            if (array_key_exists('increment', $keyOptions) && $keyOptions['type'] != KeyType::AUTOINCREMENT) {
+                throw new InvalidKeyOptionException("increment", $keyOptions['type']);
+            }
+
+            return true;
+        };
+    }
 }