Merge pull request #72 from utopia-php/feat-check-attribute-method

Add checkAttribute method

Author: eldadfux

src/Database/Database.php

@@ -472,6 +472,40 @@ public function createAttribute(string $collection, string $id, string $type, in
         return $this->adapter->createAttribute($collection->getId(), $id, $type, $size, $signed, $array);
     }
 
+    /**
+     * Checks if attribute can be added to collection.
+     * Used to check attribute limits without asking the database
+     * Returns true if attribute can be added to collection, throws exception otherwise
+     *
+     * @param Document $collection
+     * @param Document $attribute
+     *
+     * @throws LimitException
+     * @return bool
+     */
+    public function checkAttribute(Document $collection, Document $attribute): bool
+    {
+        $collection = clone $collection;
+
+        $collection->setAttribute('attributes', $attribute, Document::SET_TYPE_APPEND);
+
+        if ($this->adapter->getAttributeLimit() > 0 &&
+            $this->adapter->getAttributeCount($collection) > $this->adapter->getAttributeLimit())
+        {
+            throw new LimitException('Column limit reached. Cannot create new attribute.');
+            return false;
+        }
+
+        if ($this->adapter->getRowLimit() > 0 &&
+            $this->adapter->getAttributeWidth($collection) >= $this->adapter->getRowLimit())
+        {
+            throw new LimitException('Row width limit reached. Cannot create new attribute.');
+            return false;
+        }
+
+        return true;
+    }
+
     /**
      * Delete Attribute
      * 

tests/Database/Base.php

@@ -1295,6 +1295,35 @@ public function testExceptionAttributeLimit()
         $this->assertEquals(1,1);
     }
 
+    /**
+     * @depends testExceptionAttributeLimit
+     */
+    public function testCheckAttributeCountLimit()
+    {
+        if (static::getAdapterName() === 'mariadb' || static::getAdapterName() === 'mysql') {
+            $collection = static::getDatabase()->getCollection('attributeLimit');
+
+            // create same attribute in testExceptionAttributeLimit
+            $attribute = new Document([
+                    '$id' => 'breaking',
+                    'type' => Database::VAR_INTEGER,
+                    'size' => 0,
+                    'required' => true,
+                    'default' => null,
+                    'signed' => true,
+                    'array' => false,
+                    'filters' => [],
+            ]);
+
+            $this->expectException(LimitException::class);
+            $this->assertEquals(false, static::getDatabase()->checkAttribute($collection, $attribute));
+        }
+
+        // Default assertion for other adapters
+        $this->assertEquals(1,1);
+
+    }
+
     /**
      * Using phpunit dataProviders to check that all these combinations of types/sizes throw exceptions
      * https://phpunit.de/manual/3.7/en/writing-tests-for-phpunit.html#writing-tests-for-phpunit.data-providers
@@ -1393,6 +1422,35 @@ public function testExceptionWidthLimit($key, $stringSize, $stringCount, $intCou
         $this->assertEquals(1,1);
     }
 
+    /**
+     * @dataProvider rowWidthExceedsMaximum
+     * @depends testExceptionWidthLimit
+     */
+    public function testCheckAttributeWidthLimit($key, $stringSize, $stringCount, $intCount, $floatCount, $boolCount)
+    {
+        if (static::getAdapterRowLimit() > 0) {
+            $collection = static::getDatabase()->getCollection("widthLimit{$key}");
+
+            // create same attribute in testExceptionWidthLimit
+            $attribute = new Document([
+                    '$id' => 'breaking',
+                    'type' => Database::VAR_STRING,
+                    'size' => 100,
+                    'required' => true,
+                    'default' => null,
+                    'signed' => true,
+                    'array' => false,
+                    'filters' => [],
+            ]);
+
+            $this->expectException(LimitException::class);
+            $this->assertEquals(false, static::getDatabase()->checkAttribute($collection, $attribute));
+        }
+
+        // Default assertion for other adapters
+        $this->assertEquals(1,1);
+    }
+
     public function testExceptionIndexLimit()
     {
         static::getDatabase()->createCollection('indexLimit');