Using the new abstract database table storage class in dkan_datastore… (

#243) * Using the new abstract database table storage class in dkan_datastore database table storage class. * Fixing complexity issues. * Fix tests. * Fix cypress tests.
GetDKAN · Oct 31, 2019 · ab415d3 · ab415d3
1 parent 88dcbb2
commit ab415d3
Show file tree

Hide file tree

Showing 8 changed files with 222 additions and 174 deletions.
diff --git a/cypress/fixtures/electionDistricts.json b/cypress/fixtures/electionDistricts.json
@@ -1,6 +1,7 @@
 {
   "uuid": "c9e2d352-e24c-4051-9158-f48127aa5692",
   "properties" : [
+    "record_number",
     "lon",
     "lat",
     "unit_type",

diff --git a/cypress/integration/03_datastore.spec.js b/cypress/integration/03_datastore.spec.js
@@ -127,7 +127,7 @@ context('Datastore API', () => {
       expect(response.status).eql(200);
       expect(response.body.columns).eql(expected_columns);
       expect(response.body.numOfRows).eql(2);
-      expect(response.body.numOfColumns).eql(5);
+      expect(response.body.numOfColumns).eql(6);
     });
 
     // Delete.

diff --git a/modules/custom/dkan_common/src/Storage/AbstractDatabaseTable.php b/modules/custom/dkan_common/src/Storage/AbstractDatabaseTable.php
@@ -2,17 +2,19 @@
 
 namespace Drupal\dkan_common\Storage;
 
+use Contracts\RemoverInterface;
+use Contracts\RetrieverInterface;
 use Dkan\Datastore\Storage\StorageInterface;
 use Dkan\Datastore\Storage\Database\SqlStorageTrait;
 use Drupal\Core\Database\Connection;
-use Drupal\Core\Database\Query\Select;
 use Drupal\dkan_datastore\Storage\Query;
 
 /**
  * AbstractDatabaseTable class.
  */
-abstract class AbstractDatabaseTable implements StorageInterface {
+abstract class AbstractDatabaseTable implements StorageInterface, RetrieverInterface, RemoverInterface {
   use SqlStorageTrait;
+  use QueryToQueryHelperTrait;
 
   protected $connection;
 
@@ -30,7 +32,7 @@ abstract protected function getTableName();
    * Transform the string data given into what should be use by the insert
    * query.
    */
-  abstract protected function prepareData(string $data): array;
+  abstract protected function prepareData(string $data, string $id = NULL): array;
 
   /**
    * Get the primary key used in the table.
@@ -51,6 +53,23 @@ public function __construct(Connection $connection) {
     }
   }
 
+  /**
+   * Inherited.
+   *
+   * @inheritDoc
+   */
+  public function retrieve(string $id) {
+    $this->setTable();
+
+    $result = $this->connection->select($this->getTableName(), 't')
+      ->fields('t', array_keys($this->getSchema()['fields']))
+      ->condition($this->primaryKey(), $id)
+      ->execute()
+      ->fetch();
+
+    return $result;
+  }
+
   /**
    * Inherited.
    *
@@ -79,16 +98,52 @@ public function retrieveAll(): array {
    */
   public function store($data, string $id = NULL): string {
     $this->setTable();
-    $data = $this->prepareData($data);
 
-    $q = $this->connection->insert($this->getTableName());
-    $q->fields(array_keys($this->schema['fields']));
-    $q->values($data);
-    $id = $q->execute();
+    $existing = $this->retrieve($id);
+
+    $data = $this->prepareData($data, $id);
+
+    if (!$existing) {
+      $q = $this->connection->insert($this->getTableName());
+      $q->fields($this->getNonSerialFields());
+      $q->values($data);
+      $id = $q->execute();
+    }
+    else {
+      $q = $this->connection->update($this->getTableName());
+      $q->fields($data)
+        ->condition($this->primaryKey(), $id)
+        ->execute();
+    }
 
     return "{$id}";
   }
 
+  /**
+   * Private.
+   */
+  private function getNonSerialFields() {
+    $fields = [];
+    foreach ($this->schema['fields'] as $field => $info) {
+      if ($info['type'] != 'serial') {
+        $fields[] = $field;
+      }
+    }
+    return $fields;
+  }
+
+  /**
+   * Inherited.
+   *
+   * @inheritDoc
+   */
+  public function remove(string $id) {
+    $tableName = $this->getTableName();
+    $this->connection->delete($tableName)
+      ->condition($this->primaryKey(), $id)
+      ->execute();
+  }
+
   /**
    * Count rows in table.
    */
@@ -136,45 +191,6 @@ private function setTable() {
     }
   }
 
-  /**
-   * Private.
-   */
-  private function setQueryConditions(Select $db_query, Query $query) {
-    foreach ($query->conditions as $property => $value) {
-      $db_query->condition($property, $value, "LIKE");
-    }
-  }
-
-  /**
-   * Private.
-   */
-  private function setQueryOrderBy(Select $db_query, Query $query) {
-    foreach ($query->sort['ASC'] as $property) {
-      $db_query->orderBy($property);
-    }
-
-    foreach ($query->sort['DESC'] as $property) {
-      $db_query->orderBy($property, 'DESC');
-    }
-  }
-
-  /**
-   * Private.
-   */
-  private function setQueryLimitAndOffset(Select $db_query, Query $query) {
-    if ($query->limit) {
-      if ($query->offset) {
-        $db_query->range($query->offset, $query->limit);
-      }
-      else {
-        $db_query->range(0, $query->limit);
-      }
-    }
-    elseif ($query->offset) {
-      $db_query->range($query->limit);
-    }
-  }
-
   /**
    * Destroy.
    *

diff --git a/modules/custom/dkan_common/src/Storage/QueryToQueryHelperTrait.php b/modules/custom/dkan_common/src/Storage/QueryToQueryHelperTrait.php
@@ -0,0 +1,54 @@
+<?php
+
+namespace Drupal\dkan_common\Storage;
+
+use Drupal\Core\Database\Query\Select;
+use Drupal\dkan_datastore\Storage\Query;
+
+/**
+ * Class QueryToQueryHelperTrait.
+ *
+ * Given a Query object, setup a Drupal's select query.
+ */
+trait QueryToQueryHelperTrait {
+
+  /**
+   * Private.
+   */
+  private function setQueryConditions(Select $db_query, Query $query) {
+    foreach ($query->conditions as $property => $value) {
+      $db_query->condition($property, $value, "LIKE");
+    }
+  }
+
+  /**
+   * Private.
+   */
+  private function setQueryOrderBy(Select $db_query, Query $query) {
+    foreach ($query->sort['ASC'] as $property) {
+      $db_query->orderBy($property);
+    }
+
+    foreach ($query->sort['DESC'] as $property) {
+      $db_query->orderBy($property, 'DESC');
+    }
+  }
+
+  /**
+   * Private.
+   */
+  private function setQueryLimitAndOffset(Select $db_query, Query $query) {
+    if ($query->limit) {
+      if ($query->offset) {
+        $db_query->range($query->offset, $query->limit);
+      }
+      else {
+        $db_query->range(0, $query->limit);
+      }
+    }
+    elseif ($query->offset) {
+      $db_query->range($query->limit);
+    }
+  }
+
+}
diff --git a/modules/custom/dkan_datastore/src/Storage/DatabaseTable.php b/modules/custom/dkan_datastore/src/Storage/DatabaseTable.php
@@ -80,7 +80,7 @@ protected function getTableName() {
   /**
    * Protected.
    */
-  protected function prepareData(string $data): array {
+  protected function prepareData(string $data, string $id = NULL): array {
     return json_decode($data);
   }
 
@@ -91,4 +91,24 @@ protected function primaryKey() {
     return "record_number";
   }
 
+  /**
+   * Overriden.
+   */
+  public function setSchema($schema) {
+    $fields = $schema['fields'];
+    $new_field = [
+      $this->primaryKey() =>
+      [
+        'type' => 'serial',
+        'unsigned' => TRUE,
+        'not null' => TRUE,
+      ],
+    ];
+    $fields = array_merge($new_field, $fields);
+
+    $schema['fields'] = $fields;
+    $schema['primary key'] = [$this->primaryKey()];
+    parent::setSchema($schema);
+  }
+
 }