add AspectReadOnly

src/DataStore/src/DataStore/Aspect/AspectReadOnly.php

@@ -0,0 +1,56 @@
+<?php
+/**
+ * @copyright Copyright © 2014 Rollun LC (http://rollun.com/)
+ * @license LICENSE.md New BSD License
+ */
+
+namespace rollun\datastore\DataStore\Aspect;
+
+use rollun\datastore\DataStore\DataStoreException;
+use rollun\datastore\DataStore\Traits\NoSupportCreateTrait;
+use rollun\datastore\DataStore\Traits\NoSupportDeleteAllTrait;
+use rollun\datastore\DataStore\Traits\NoSupportDeleteTrait;
+use rollun\datastore\DataStore\Traits\NoSupportUpdateTrait;
+use Xiag\Rql\Parser\Query;
+
+/**
+ * Class AspectReadOnly
+ *
+ * This is wrapper for any type of datastore which disallow all methods except ReadInterface.
+ * It is useful for wrapping datastores from production in local environment.
+ *
+ * @see AspectAbstractFactory
+ * @package rollun\datastore\DataStore\Aspect
+ */
+class AspectReadOnly extends AspectAbstract
+{
+    use NoSupportCreateTrait;
+    use NoSupportDeleteAllTrait;
+    use NoSupportDeleteTrait;
+    use NoSupportUpdateTrait;
+
+    public function multiCreate($records)
+    {
+        throw new DataStoreException("Method don't support.");
+    }
+
+    public function multiUpdate($records)
+    {
+        throw new DataStoreException("Method don't support.");
+    }
+
+    public function queriedUpdate($record, Query $query)
+    {
+        throw new DataStoreException("Method don't support.");
+    }
+
+    public function rewrite($record)
+    {
+        throw new DataStoreException("Method don't support.");
+    }
+
+    public function queriedDelete(Query $query)
+    {
+        throw new DataStoreException("Method don't support.");
+    }
+}

test/unit/DataStore/DataStore/Aspect/AspectReadOnlyTest.php

@@ -0,0 +1,55 @@
+<?php
+/**
+ * @copyright Copyright © 2014 Rollun LC (http://rollun.com/)
+ * @license LICENSE.md New BSD License
+ */
+
+namespace rollun\test\unit\DataStore\DataStore\Aspect;
+
+use PHPUnit\Framework\TestCase;
+use rollun\datastore\DataStore\Aspect\AspectReadOnly;
+use rollun\datastore\DataStore\DataStoreException;
+use rollun\datastore\DataStore\Interfaces\ReadInterface;
+use rollun\datastore\DataStore\Memory;
+use Xiag\Rql\Parser\Query;
+
+class AspectReadOnlyTest extends TestCase
+{
+    public function disallowedMethods(): array
+    {
+        $excluded = [
+            '__construct',
+        ];
+
+        $methods = get_class_methods(AspectReadOnly::class);
+
+        $methods = array_filter($methods, function ($method) use ($excluded) {
+            return !in_array($method, $excluded) && !method_exists(ReadInterface::class, $method);
+        });
+
+        return array_map(function ($method) {
+            return [$method];
+        }, $methods);
+    }
+
+    /**
+     * @dataProvider disallowedMethods
+     */
+    public function testOnlyReadMethodsAreAvailable($method)
+    {
+        $params = [
+            'default' => [[]],
+            'delete' => [1],
+            'queriedUpdate' => [[], new Query()],
+            'queriedDelete' => [new Query()],
+        ];
+
+        $datastore = new Memory();
+
+        $aspect = new AspectReadOnly($datastore);
+
+        $this->expectException(DataStoreException::class);
+
+        $aspect->$method(...($params[$method] ?? $params['default']));
+    }
+}